when i try to use this plugin, it just gives this error when i do a .find( ) query, with the error in the title. i was just trying to use it with the basic provided example, adding just a .connect( ) to connect to a DB. WHY?

`const mongoose = require('mongoose');
const atlasPlugin = require('mongoose-atlas-search');

const Schema = mongoose.Schema;

const UserSchema = new Schema(
{
name: String,
email: String,
languagel: String,
},
{collection: 'movies'}
);
UserSchema.set('validateBeforeSave', false);

const UserModel = mongoose.model('User', UserSchema);

//atlasPlugin.initialize();
atlasPlugin.initialize({
model: UserModel,
overwriteFind: false,
addFields: {
id: '$_id'
},
searchFunction: query => {
return {
'wildcard': {
'query': ${query}*,
'path': '_id',
'allowAnalyzedField': true
}
}
}

});
mongoose.connect("<DB_Connection>").then(async()=>{
console.log(await UserModel.find().exec());
});`
changing the searchKey value, or removing it. making overwriteFind true or false, didnt help.

1. The Atlas API
2. Terraform

Please update the NPM package description. There are also other improvements that have happened over the past two years. I've forked the repo and starred the project so I can be helpful and loop in our team.

I have added the plugin to my model:

const PersonModel = mongoose.model<IPersonDB>('Person', PersonSchema);

atlasPlugin.initialize({
  model: PersonModel,
  overwriteFind: true,
  searchKey: 'search',
  addFields: {
    id: '$_id'
  },
  searchFunction: query => {
    return {
      'wildcard': {
        'query': `${query}*`,
        'path': '_id',
        'allowAnalyzedField': true
      }
    };
  }
});

I am now trying to adjust a query that I previously had:

    const searchTerm = 'mysearch term';
    const query: Record<string, any> = {
       deleted: { $ne: true },
    };

    query.$text = {
      $search: filter.query,
      $caseSensitive: false,
      $diacriticSensitive: false,
      $language: 'french'
    };
    return {
      entries: await Person.find(query).limit(limit).skip(offset).lean(),
      total: await Person.find(query).countDocuments()
    };

to:

    const searchTerm = 'mysearch term';
    const query: Record<string, any> = {
       deleted: { $ne: true },
    };

    query.search = searchTerm;

    return {
      entries: await Person.find(query).limit(limit).skip(offset).lean(),
      total: await Person.find(query).countDocuments()
    };```

While dropping the `lean()` call seems to resolve the first part, I am not sure how to get the total document count when using the plugin?

Error: default query param is required!

Documentation is REQUIRED
Configured Plugins As per Doc :
//atlasPlugin.initialize();
atlasPlugin.initialize({
model: ProfileModel,
overwriteFind: false,
searchKey: 'default',
addFields: {
id: '$_id',
fullname: '$_fullname',
email: '$_email',
countryData: '$_countryData',
mobile: '$_mobile'
},
searchFunction: query => {
return {
'wildcard': {
'query': ${query}*,
'allowAnalyzedField': true
}
}
}
});

Creating Query Like Below :
ProfileModel.search({
query: search
}, function(errSearch, search) {
});

Please provide more documentation for the same

getting this error :
Error: default query param is required!
at Function.model.search (/server/platforms/mybusiness platform/node_modules/mongoose-atlas-search/dist/index.js:22:27)