TypeScript is not inferring types correctly when models imported from NPM package

[akashshyam]

Hey guys!

This is my first time defining and using Models as a separate private NPM package.

This is what I'm exporting:

export const CompanyProfile = mongoose.model<ICompanyProfile>('CompanyProfile', companyProfileSchema);

When I import this after installing the package:

import { Schema } from "mongoose";
import {
  CompanyProfile,
  IIncomeStatement,
} from "monkstreet-models";

export const calculateRevenueForCompany = async (
  companyId: Schema.Types.ObjectId
) => {
  try {
    const company = await CompanyProfile.findById(companyId).populate<{
      incomeStatements: IIncomeStatement[];
    }>("incomeStatements");

Here, TypeScript infers company as any. Whereas if I create a similar example in the models file, then:

export const CompanyProfile = mongoose.model<ICompanyProfile>('CompanyProfile', companyProfileSchema);

(async () => {
  const company = await CompanyProfile.findById('avx').populate<{
    incomeStatements: IIncomeStatement[];
  }>('incomeStatements');
})();

Here, company is inferred as:

const company: Omit<mongoose.Document<unknown, {}, ICompanyProfile> & ICompanyProfile & {
    _id: mongoose.Types.ObjectId;
}, "incomeStatements"> & {
    ...;
}

Is this expected behaviour? Or am I doing something wrong?

Just for context, here are my Schema and model definitions:

const companyProfileSchema = new Schema<ICompanyProfile>(
  {...},
  {
    toJSON: { virtuals: true },
    toObject: { virtuals: true },
  }
);

companyProfileSchema.index({ companyName: 'text', symbol: 'text' });

export const CompanyProfile = mongoose.model<ICompanyProfile>('CompanyProfile', companyProfileSchema);

And my typescript.config:

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES2020",
    "declaration": true,
    "outDir": "./dist"
  },
  "include": ["src/**/*"]
}

I appreciate any help 😊

[vkarpov15]

How are you listing mongoose as a dep in your private npm package vs your main project?