mongoose 7.6.0 → 7.6.1

package/lib/query.js

@@ -1680,7 +1680,7 @@ Query.prototype.setOptions = function(options, overwrite) {
 
 const printRawResultDeprecationWarning = util.deprecate(
   function printRawResultDeprecationWarning() {},
-  'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: false` as a replacement for `rawResult: true`.'
+  'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: true` as a replacement for `rawResult: true`.'
 );
 
 /*!

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.6.0",
+  "version": "7.6.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,7 +19,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^5.4.0",
+    "bson": "^5.5.0",
     "kareem": "2.5.1",
     "mongodb": "5.9.0",
     "mpath": "0.9.0",
@@ -39,7 +39,6 @@
     "axios": "1.1.3",
     "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
-    "bluebird": "3.7.2",
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.12",
@@ -130,14 +129,6 @@
   },
   "homepage": "https://mongoosejs.com",
   "browser": "./dist/browser.umd.js",
-  "mocha": {
-    "extension": [
-      "test.js"
-    ],
-    "watch-files": [
-      "test/**/*.js"
-    ]
-  },
   "config": {
     "mongodbMemoryServer": {
       "disablePostinstall": true

package/types/models.d.ts

@@ -32,7 +32,9 @@ declare module 'mongoose' {
     PopulateOption,
     SessionOption {
     limit?: number;
+    // @deprecated, use includeResultMetadata instead
     rawResult?: boolean;
+    includeResultMetadata?: boolean;
     ordered?: boolean;
     lean?: boolean;
     throwOnValidationError?: boolean;

package/types/query.d.ts

@@ -124,9 +124,14 @@ declare module 'mongoose' {
     overwriteDiscriminatorKey?: boolean;
     projection?: ProjectionType<DocType>;
     /**
+     * @deprecated use includeResultMetadata instead.
      * if true, returns the raw result from the MongoDB driver
      */
     rawResult?: boolean;
+    /**
+     * if ture, includes meta data for the result from the MongoDB driver
+     */
+    includeResultMetadata?: boolean;
     readPreference?: string | mongodb.ReadPreferenceMode;
     /**
      * An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.

package/.eslintrc.js

@@ -1,236 +0,0 @@
-'use strict';
-
-module.exports = {
-  extends: [
-    'eslint:recommended'
-  ],
-  ignorePatterns: [
-    'tools',
-    'dist',
-    'website.js',
-    'test/files/*',
-    'benchmarks',
-    '*.min.js',
-    '**/docs/js/native.js',
-    '!.*',
-    'node_modules',
-    '.git'
-  ],
-  overrides: [
-    {
-      files: [
-        '**/*.{ts,tsx}',
-        '**/*.md/*.ts',
-        '**/*.md/*.typescript'
-      ],
-      extends: [
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended'
-      ],
-      plugins: [
-        '@typescript-eslint'
-      ],
-      rules: {
-        '@typescript-eslint/triple-slash-reference': 'off',
-        '@typescript-eslint/no-non-null-assertion': 'off',
-        '@typescript-eslint/no-empty-function': 'off',
-        'spaced-comment': [
-          'error',
-          'always',
-          {
-            block: {
-              markers: [
-                '!'
-              ],
-              balanced: true
-            },
-            markers: [
-              '/'
-            ]
-          }
-        ],
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/ban-types': 'off',
-        '@typescript-eslint/no-unused-vars': 'off',
-        '@typescript-eslint/explicit-module-boundary-types': 'off',
-        '@typescript-eslint/indent': [
-          'warn',
-          2,
-          {
-            SwitchCase: 1,
-            ignoredNodes: ['TSTypeParameterInstantiation']
-          }
-        ],
-        '@typescript-eslint/prefer-optional-chain': 'error',
-        '@typescript-eslint/brace-style': 'error',
-        '@typescript-eslint/no-dupe-class-members': 'error',
-        '@typescript-eslint/no-redeclare': 'error',
-        '@typescript-eslint/type-annotation-spacing': 'error',
-        '@typescript-eslint/object-curly-spacing': [
-          'error',
-          'always'
-        ],
-        '@typescript-eslint/semi': 'error',
-        '@typescript-eslint/space-before-function-paren': [
-          'error',
-          'never'
-        ],
-        '@typescript-eslint/space-infix-ops': 'off'
-      }
-    },
-    {
-      files: [
-        '**/docs/js/**/*.js'
-      ],
-      env: {
-        node: false,
-        browser: true
-      }
-    }
-    // // eslint-plugin-markdown has been disabled because of out-standing issues, see https://github.com/eslint/eslint-plugin-markdown/issues/214
-    // {
-    //   files: ['**/*.md'],
-    //   processor: 'markdown/markdown'
-    // },
-    // {
-    //   files: ['**/*.md/*.js', '**/*.md/*.javascript', '**/*.md/*.ts', '**/*.md/*.typescript'],
-    //   parserOptions: {
-    //     ecmaFeatures: {
-    //       impliedStrict: true
-    //     },
-    //     sourceType: 'module', // required to allow "import" statements
-    //     ecmaVersion: 'latest' // required to allow top-level await
-    //   },
-    //   rules: {
-    //     'no-undef': 'off',
-    //     'no-unused-expressions': 'off',
-    //     'no-unused-vars': 'off',
-    //     'no-redeclare': 'off',
-    //     '@typescript-eslint/no-redeclare': 'off'
-    //   }
-    // }
-  ],
-  plugins: [
-    'mocha-no-only'
-    // 'markdown'
-  ],
-  parserOptions: {
-    ecmaVersion: 2020
-  },
-  env: {
-    node: true,
-    es6: true,
-    es2020: true
-  },
-  rules: {
-    'comma-style': 'error',
-    indent: [
-      'error',
-      2,
-      {
-        SwitchCase: 1,
-        VariableDeclarator: 2
-      }
-    ],
-    'keyword-spacing': 'error',
-    'no-whitespace-before-property': 'error',
-    'no-buffer-constructor': 'warn',
-    'no-console': 'off',
-    'no-constant-condition': 'off',
-    'no-multi-spaces': 'error',
-    'func-call-spacing': 'error',
-    'no-trailing-spaces': 'error',
-    'no-undef': 'error',
-    'no-unneeded-ternary': 'error',
-    'no-const-assign': 'error',
-    'no-useless-rename': 'error',
-    'no-dupe-keys': 'error',
-    'space-in-parens': [
-      'error',
-      'never'
-    ],
-    'spaced-comment': [
-      'error',
-      'always',
-      {
-        block: {
-          markers: [
-            '!'
-          ],
-          balanced: true
-        }
-      }
-    ],
-    'key-spacing': [
-      'error',
-      {
-        beforeColon: false,
-        afterColon: true
-      }
-    ],
-    'comma-spacing': [
-      'error',
-      {
-        before: false,
-        after: true
-      }
-    ],
-    'array-bracket-spacing': 1,
-    'arrow-spacing': [
-      'error',
-      {
-        before: true,
-        after: true
-      }
-    ],
-    'object-curly-spacing': [
-      'error',
-      'always'
-    ],
-    'comma-dangle': [
-      'error',
-      'never'
-    ],
-    'no-unreachable': 'error',
-    quotes: [
-      'error',
-      'single'
-    ],
-    'quote-props': [
-      'error',
-      'as-needed'
-    ],
-    semi: 'error',
-    'no-extra-semi': 'error',
-    'semi-spacing': 'error',
-    'no-spaced-func': 'error',
-    'no-throw-literal': 'error',
-    'space-before-blocks': 'error',
-    'space-before-function-paren': [
-      'error',
-      'never'
-    ],
-    'space-infix-ops': 'error',
-    'space-unary-ops': 'error',
-    'no-var': 'warn',
-    'prefer-const': 'warn',
-    strict: [
-      'error',
-      'global'
-    ],
-    'no-restricted-globals': [
-      'error',
-      {
-        name: 'context',
-        message: 'Don\'t use Mocha\'s global context'
-      }
-    ],
-    'no-prototype-builtins': 'off',
-    'mocha-no-only/mocha-no-only': [
-      'error'
-    ],
-    'no-empty': 'off',
-    'eol-last': 'warn',
-    'no-multiple-empty-lines': ['warn', { max: 2 }]
-  }
-};

package/.markdownlint-cli2.cjs

@@ -1,69 +0,0 @@
-'use strict';
-// this file is named ".cjs" instead of ".js" because markdownlint-cli2 only looks for ".cjs" or ".mjs"
-
-// use aliases instead of "MD000" naming
-
-module.exports = {
-  ignores: [
-    // the following are ignored because they are just redirects
-    'History.md',
-    'SECURITY.md',
-    'migrating_to_5.md', // this does not affect "docs/migrating_to_5.md"
-
-    // ignored for now, but should be changes later
-    '.github/PULL_REQUEST_TEMPLATE.md',
-
-    // ignore changelog because it uses different heading style than other documents and older versions use different formatting
-    'CHANGELOG.md',
-
-    // exclude node_modules because it isnt excluded by default
-    'node_modules'
-  ]
-};
-
-module.exports.config = {
-  // disable default rules
-  default: false,
-
-  // alt-text for images
-  accessibility: true,
-  // consistent blank lines
-  blank_lines: true,
-  // consistent unordered lists
-  bullet: { style: 'asterisk' },
-  // consistent and read-able code
-  code: true,
-  // consistent emphasis characters
-  emphasis: { style: 'asterisk' },
-  // ensure consistent header usage
-  headers: { style: 'atx' },
-  // ensure consistent "hr" usage
-  hr: { style: '---' },
-  // disable disalloing html tags, because
-  // mongoose currently uses html tags directly for heading ID's and style
-  html: false,
-  // consistent indentation
-  indentation: true,
-  // consistent links and good links
-  links: true,
-  // enabled by "links"
-  // mongoose currently does not wrap plain links in "<>"
-  'no-bare-urls': false,
-  // consistent ordered lists
-  ol: true,
-  // consistent whitespace usage
-  whitespace: true
-
-  // atx: undefined, // covered by "headers"
-  // atx_closed: undefined, // covered by "headers"
-  // blockquote: true, // covered by "whitespace"
-  // hard_tab: undefined, // covered by "whitespace"
-  // headings: undefined, // covered by "headers"
-  // images: true, // covered by "accessibility" and "links"
-  // language: undefined, // covered by "code"
-  // line_length: undefined, // mongoose currently uses a mix of max-line-length and relying on editor auto-wrap
-  // spaces: undefined, // covered by "atx", "atx_closed", "headers"
-  // spelling: undefined, // mongoose currently only uses short-form language specifiers and so does not need this
-  // ul: undefined, // covered by "whitespace" and "bullet"
-  // url: undefined, // covered by "links"
-};

package/.mocharc.yml

@@ -1,4 +0,0 @@
-reporter: spec # better to identify failing / slow tests than "dot"
-ui: bdd # explicitly setting, even though it is mocha default
-require:
-  - test/mocha-fixtures.js

package/lgtm.yml

@@ -1,12 +0,0 @@
-path_classifiers:
-  src:
-    - lib
-  types:
-    - types
-  test:
-    - test
-  docs:
-    - docs
-queries:
-  - exclude: "*"
-  - include: lib

package/scripts/build-browser.js

@@ -1,18 +0,0 @@
-'use strict';
-
-const config = require('../webpack.config.js');
-const webpack = require('webpack');
-
-const compiler = webpack(config);
-
-console.log('Starting browser build...');
-compiler.run((err, stats) => {
-  if (err) {
-    console.err(stats.toString());
-    console.err('Browser build unsuccessful.');
-    process.exit(1);
-  }
-  console.log(stats.toString());
-  console.log('Browser build successful.');
-  process.exit(0);
-});

package/scripts/create-tarball.js

@@ -1,7 +0,0 @@
-'use strict';
-
-const { execSync } = require('child_process');
-const { name, version } = require('../package.json');
-
-execSync('npm pack');
-execSync(`mv ${name}-${version}.tgz ${name}.tgz`);

package/scripts/generateSearch.js

@@ -1,161 +0,0 @@
-'use strict';
-
-let config;
-try {
-  config = require('../.config.js');
-} finally {
-  if (!config || !config.uri) {
-    console.error('No Config or config.URI given, please create a .config.js file with those values in the root of the repository');
-    process.exit(-1);
-  }
-}
-const cheerio = require('cheerio');
-const docsFilemap = require('../docs/source');
-const fs = require('fs');
-const pug = require('pug');
-const mongoose = require('../');
-let { version } = require('../package.json');
-
-const { marked: markdown } = require('marked');
-const highlight = require('highlight.js');
-markdown.setOptions({
-  highlight: function(code) {
-    return highlight.highlight(code, { language: 'JavaScript' }).value;
-  }
-});
-
-// 5.13.5 -> 5.x, 6.8.2 -> 6.x, etc.
-version = version.slice(0, version.indexOf('.')) + '.x';
-
-const contentSchema = new mongoose.Schema({
-  title: { type: String, required: true },
-  body: { type: String, required: true },
-  url: { type: String, required: true },
-  version: { type: String, required: true, default: version },
-  versionNumber: { type: Number, required: true, default: version.replace(/\.x$/, '') }
-});
-contentSchema.index({ title: 'text', body: 'text' });
-const Content = mongoose.model('Content', contentSchema, 'Content');
-
-const contents = [];
-
-for (const [filename, file] of Object.entries(docsFilemap.fileMap)) {
-  if (file.api) {
-    for (const prop of file.props) {
-      const content = new Content({
-        title: `API: ${prop.name}`,
-        body: prop.description,
-        url: `${filename}#${prop.anchorId}`
-      });
-      const err = content.validateSync();
-      if (err != null) {
-        console.error(content);
-        throw err;
-      }
-      contents.push(content);
-    }
-  } else if (file.markdown) {
-    let text = fs.readFileSync(filename, 'utf8');
-    text = markdown.parse(text);
-
-    const content = new Content({
-      title: file.title,
-      body: text,
-      url: filename.replace('.md', '.html').replace(/^docs/, '')
-    });
-
-    content.validateSync();
-
-    const $ = cheerio.load(text);
-
-    contents.push(content);
-
-    // Break up individual h3's into separate content for more fine grained search
-    $('h3').each((index, el) => {
-      el = $(el);
-      const title = el.text();
-      const html = el.nextUntil('h3').html();
-      const content = new Content({
-        title: `${file.title}: ${title}`,
-        body: html,
-        url: `${filename.replace('.md', '.html').replace(/^docs/, '')}#${el.prop('id')}`
-      });
-
-      content.validateSync();
-      contents.push(content);
-    });
-  } else if (file.guide) {
-    let text = fs.readFileSync(filename, 'utf8');
-    text = text.substr(text.indexOf('block content') + 'block content\n'.length);
-    text = pug.render(`div\n${text}`, { filters: { markdown }, filename });
-
-    const content = new Content({
-      title: file.title,
-      body: text,
-      url: filename.replace('.pug', '.html').replace(/^docs/, '')
-    });
-
-    content.validateSync();
-
-    const $ = cheerio.load(text);
-
-    contents.push(content);
-
-    // Break up individual h3's into separate content for more fine grained search
-    $('h3').each((index, el) => {
-      el = $(el);
-      const title = el.text();
-      const html = el.nextUntil('h3').html();
-      const content = new Content({
-        title: `${file.title}: ${title}`,
-        body: html,
-        url: `${filename.replace('.pug', '.html').replace(/^docs/, '')}#${el.prop('id')}`
-      });
-
-      content.validateSync();
-      contents.push(content);
-    });
-  }
-}
-
-run().catch(async error => {
-  console.error(error.stack);
-
-  // ensure the script exists in case of error
-  await mongoose.disconnect();
-});
-
-async function run() {
-  await mongoose.connect(config.uri, { dbName: 'mongoose', serverSelectionTimeoutMS: 5000 });
-
-  // wait for the index to be created
-  await Content.init();
-
-  await Content.deleteMany({ version });
-  let count = 0;
-  for (const content of contents) {
-    if (version === '7.x') {
-      let url = content.url.startsWith('/') ? content.url : `/${content.url}`;
-      if (!url.startsWith('/docs')) {
-        url = '/docs' + url;
-      }
-      content.url = url;
-    } else {
-      const url = content.url.startsWith('/') ? content.url : `/${content.url}`;
-      content.url = `/docs/${version}/docs${url}`;
-    }
-    console.log(`${++count} / ${contents.length}`);
-    await content.save();
-  }
-
-  const results = await Content.
-    find({ $text: { $search: 'validate' }, version }, { score: { $meta: 'textScore' } }).
-    sort({ score: { $meta: 'textScore' } }).
-    limit(10);
-
-  console.log(results.map(res => res.url));
-
-  console.log(`Added ${contents.length} Content`);
-
-  process.exit(0);
-}

package/scripts/loadSponsorData.js

@@ -1,115 +0,0 @@
-'use strict';
-
-let config;
-try {
-  config = require('../.config.js');
-} finally {
-  if (!config || !config.uri) {
-    console.error('No Config or config.URI given, please create a .config.js file with those values in the root of the repository');
-    process.exit(-1);
-  }
-}
-const axios = require('axios');
-const fs = require('fs');
-const mongoose = require('../');
-
-run().catch(err => {
-  console.error(err);
-  process.exit(-1);
-});
-
-// only "." because fs resolves relative to the CWD instead of relative to __dirname
-const docsDir = './docs';
-
-async function run() {
-  await mongoose.connect(config.uri);
-
-  const Subscriber = mongoose.model('Subscriber', mongoose.Schema({
-    companyName: String,
-    description: String,
-    url: String,
-    logo: String
-  }), 'Subscriber');
-
-  const Job = mongoose.model('Job', mongoose.Schema({
-    logo: String,
-    company: String,
-    title: String,
-    location: {
-      type: String,
-      required: true
-    },
-    description: {
-      type: String,
-      required: true
-    },
-    url: {
-      type: String,
-      required: true
-    }
-  }), 'Job');
-
-  const OpenCollectiveSponsor = mongoose.model('OpenCollectiveSponsor', mongoose.Schema({
-    openCollectiveId: {
-      type: Number,
-      required: true
-    },
-    website: {
-      type: String,
-      required: true
-    },
-    image: {
-      type: String,
-      required: true
-    },
-    alt: {
-      type: String
-    }
-  }), 'OpenCollectiveSponsor');
-
-  try {
-    fs.mkdirSync(`${docsDir}/data`);
-  } catch (err) {}
-
-  const subscribers = await Subscriber.
-    find({ companyName: { $exists: true }, description: { $exists: true }, logo: { $exists: true } }).
-    sort({ createdAt: 1 }).
-    select({ companyName: 1, description: 1, url: 1, logo: 1 });
-  fs.writeFileSync(`${docsDir}/data/sponsors.json`, JSON.stringify(subscribers, null, '  '));
-
-  const jobs = await Job.find().select({ logo: 1, company: 1, title: 1, location: 1, description: 1, url: 1 });
-  fs.writeFileSync(`${docsDir}/data/jobs.json`, JSON.stringify(jobs, null, '  '));
-
-  const opencollectiveSponsors = await axios.get('https://opencollective.com/mongoose/members.json').
-    then(res => res.data).
-    then(sponsors => {
-      return sponsors.filter(result => result.tier == 'sponsor' && result.isActive);
-    }).
-    catch(() => null);
-
-  for (const sponsor of opencollectiveSponsors) {
-    const override = await OpenCollectiveSponsor.findOne({ openCollectiveId: sponsor['MemberId'] });
-    if (override == null) {
-      continue;
-    }
-
-    sponsor.website = override.website;
-    sponsor.image = override.image;
-    if (override.alt != null) {
-      sponsor.alt = override.alt;
-    }
-  }
-
-  const additionalSponsors = await OpenCollectiveSponsor.find({}).
-    then(docs => docs.filter(doc => doc.openCollectiveId == null));
-  for (const sponsor of additionalSponsors) {
-    opencollectiveSponsors.push(sponsor);
-  }
-
-  if (opencollectiveSponsors != null) {
-    fs.writeFileSync(`${docsDir}/data/opencollective.json`, JSON.stringify(opencollectiveSponsors, null, '  '));
-  }
-
-  console.log('Done');
-  process.exit(0);
-}

package/scripts/tsc-diagnostics-check.js

@@ -1,15 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-
-const stdin = fs.readFileSync(0).toString('utf8');
-const maxInstantiations = isNaN(process.argv[2]) ? 120000 : parseInt(process.argv[2], 10);
-
-console.log(stdin);
-
-const numInstantiations = parseInt(stdin.match(/Instantiations:\s+(\d+)/)[1], 10);
-if (numInstantiations > maxInstantiations) {
-  throw new Error(`Instantiations ${numInstantiations} > max ${maxInstantiations}`);
-}
-
-process.exit(0);

package/tools/auth.js

@@ -1,31 +0,0 @@
-'use strict';
-
-const Server = require('mongodb-topology-manager').Server;
-const mongodb = require('mongodb');
-
-run().catch(error => {
-  console.error(error);
-  process.exit(-1);
-});
-
-async function run() {
-  // Create new instance
-  const server = new Server('mongod', {
-    auth: null,
-    dbpath: '/data/db/27017'
-  });
-
-  // Purge the directory
-  await server.purge();
-
-  // Start process
-  await server.start();
-
-  const db = await mongodb.MongoClient.connect('mongodb://127.0.0.1:27017/admin');
-
-  await db.addUser('passwordIsTaco', 'taco', {
-    roles: ['dbOwner']
-  });
-
-  console.log('done');
-}

package/tools/repl.js

@@ -1,35 +0,0 @@
-'use strict';
-
-run().catch(error => {
-  console.error(error);
-  process.exit(-1);
-});
-
-async function run() {
-  const ReplSet = require('mongodb-memory-server').MongoMemoryReplSet;
-
-  // Create new instance
-  const replSet = new ReplSet({
-    binary: {
-      version: process.argv[2]
-    },
-    instanceOpts: [
-      // Set the expiry job in MongoDB to run every second
-      {
-        port: 27017,
-        args: ['--setParameter', 'ttlMonitorSleepSecs=1']
-      }
-    ],
-    dbName: 'mongoose_test',
-    replSet: {
-      name: 'rs0',
-      count: 2,
-      storageEngine: 'wiredTiger'
-    }
-  });
-
-  await replSet.start();
-  await replSet.waitUntilRunning();
-  console.log('MongoDB-ReplicaSet is now running.');
-  console.log(replSet.getUri('mongoose_test'));
-}

package/tools/sharded.js

@@ -1,46 +0,0 @@
-'use strict';
-
-run().catch(error => {
-  console.error(error);
-  process.exit(-1);
-});
-
-
-async function run() {
-  const Sharded = require('mongodb-topology-manager').Sharded;
-
-  // Create new instance
-  const topology = new Sharded({
-    mongod: 'mongod',
-    mongos: 'mongos'
-  });
-
-  await topology.addShard([{
-    options: {
-      bind_ip: '127.0.0.1', port: 31000, dbpath: '/data/db/31000', shardsvr: null
-    }
-  }], { replSet: 'rs1' });
-
-  await topology.addConfigurationServers([{
-    options: {
-      bind_ip: '127.0.0.1', port: 35000, dbpath: '/data/db/35000'
-    }
-  }], { replSet: 'rs0' });
-
-  await topology.addProxies([{
-    bind_ip: '127.0.0.1', port: 51000, configdb: '127.0.0.1:35000'
-  }], {
-    binary: 'mongos'
-  });
-
-  console.log('Start...');
-  // Start up topology
-  await topology.start();
-
-  console.log('Started');
-
-  // Shard db
-  await topology.enableSharding('test');
-
-  console.log('done');
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "strict": true,
-    "strictNullChecks": true,
-    "paths": {
-      "mongoose" : ["./types/index.d.ts"]
-    }
-  }
-}