@depup/mongoose 9.1.3-depup.0

package/types/mongooseoptions.d.ts

@@ -0,0 +1,228 @@
+declare module 'mongoose' {
+  import stream = require('stream');
+
+  interface MongooseOptions {
+    /**
+     * Set to `true` to set `allowDiskUse` to true to all aggregation operations by default.
+     *
+     * @default false
+     */
+    allowDiskUse?: boolean;
+    /**
+     * Set to `false` to skip applying global plugins to child schemas.
+     *
+     * @default true
+     */
+    applyPluginsToChildSchemas?: boolean;
+
+    /**
+     * Set to `true` to apply global plugins to discriminator schemas.
+     * This typically isn't necessary because plugins are applied to the base schema and
+     * discriminators copy all middleware, methods, statics, and properties from the base schema.
+     *
+     * @default false
+     */
+    applyPluginsToDiscriminators?: boolean;
+
+    /**
+     * autoCreate is `true` by default unless readPreference is secondary or secondaryPreferred,
+     * which means Mongoose will attempt to create every model's underlying collection before
+     * creating indexes. If readPreference is secondary or secondaryPreferred, Mongoose will
+     * default to false for both autoCreate and autoIndex because both createCollection() and
+     * createIndex() will fail when connected to a secondary.
+     */
+    autoCreate?: boolean;
+
+    /**
+     * Set to `false` to disable automatic index creation for all models associated with this Mongoose instance.
+     *
+     * @default true
+     */
+    autoIndex?: boolean;
+
+    /**
+     * enable/disable mongoose's buffering mechanism for all connections and models.
+     *
+     * @default true
+     */
+    bufferCommands?: boolean;
+
+    /**
+     * If bufferCommands is on, this option sets the maximum amount of time Mongoose
+     * buffering will wait before throwing an error.
+     * If not specified, Mongoose will use 10000 (10 seconds).
+     *
+     * @default 10000
+     */
+    bufferTimeoutMS?: number;
+
+    /**
+     * Set to `true` to `clone()` all schemas before compiling into a model.
+     *
+     * @default false
+     */
+    cloneSchemas?: boolean;
+
+    /**
+     * Set to `false` to disable the creation of the initial default connection.
+     *
+     * @default true
+     */
+    createInitialConnection?: boolean;
+
+    /**
+     * If `true`, prints the operations mongoose sends to MongoDB to the console.
+     * If a writable stream is passed, it will log to that stream, without colorization.
+     * If a callback function is passed, it will receive the collection name, the method
+     * name, then all arguments passed to the method. For example, if you wanted to
+     * replicate the default logging, you could output from the callback
+     * `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
+     *
+     * @default false
+     */
+    debug?:
+    | boolean
+    | { color?: boolean; shell?: boolean; }
+    | stream.Writable
+    | ((collectionName: string, methodName: string, ...methodArgs: any[]) => void);
+
+    /**
+     * If `true`, adds a `id` virtual to all schemas unless overwritten on a per-schema basis.
+     * @defaultValue true
+     */
+    id?: boolean;
+
+    /**
+     * If `false`, it will change the `createdAt` field to be [`immutable: false`](https://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-immutable)
+     * which means you can update the `createdAt`.
+     *
+     * @default true
+     */
+    'timestamps.createdAt.immutable'?: boolean
+
+    /** If set, attaches [maxTimeMS](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/) to every query */
+    maxTimeMS?: number;
+
+    /**
+     * Mongoose adds a getter to MongoDB ObjectId's called `_id` that
+     * returns `this` for convenience with populate. Set this to false to remove the getter.
+     *
+     * @default true
+     */
+    objectIdGetter?: boolean;
+
+    /**
+     * Set to `true` to default to overwriting models with the same name when calling
+     * `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
+     *
+     * @default false
+     */
+    overwriteModels?: boolean;
+
+    /**
+     * If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`,
+     * `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to
+     * setting the `new` option to `true` for `findOneAndX()` calls by default. Read our
+     * `findOneAndUpdate()` [tutorial](https://mongoosejs.com/docs/tutorials/findoneandupdate.html)
+     * for more information.
+     *
+     * @default true
+     */
+    returnOriginal?: boolean;
+
+    /**
+     * Set to true to enable [update validators](
+     * https://mongoosejs.com/docs/validation.html#update-validators
+     * ) for all validators by default.
+     *
+     * @default false
+     */
+    runValidators?: boolean;
+
+    /**
+     * Sanitizes query filters against [query selector injection attacks](
+     * https://thecodebarbarian.com/2014/09/04/defending-against-query-selector-injection-attacks.html
+     * ) by wrapping any nested objects that have a property whose name starts with $ in a $eq.
+     */
+    sanitizeFilter?: boolean;
+
+    sanitizeProjection?: boolean;
+
+    /**
+     * Set to false to opt out of Mongoose adding all fields that you `populate()`
+     * to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
+     *
+     * @default true
+     */
+    selectPopulatedPaths?: boolean;
+
+    /**
+     * Mongoose also sets defaults on update() and findOneAndUpdate() when the upsert option is
+     * set by adding your schema's defaults to a MongoDB $setOnInsert operator. You can disable
+     * this behavior by setting the setDefaultsOnInsert option to false.
+     *
+     * @default true
+     */
+    setDefaultsOnInsert?: boolean;
+
+    /**
+     * Sets the default strict mode for schemas.
+     * May be `false`, `true`, or `'throw'`.
+     *
+     * @default true
+     */
+    strict?: boolean | 'throw';
+
+    /**
+     * Set to `false` to allow populating paths that aren't in the schema.
+     *
+     * @default true
+     */
+    strictPopulate?: boolean;
+
+    /**
+     * Sets the default [strictQuery](https://mongoosejs.com/docs/guide.html#strictQuery) mode for schemas.
+     * May be `false`, `true`, or `'throw'`.
+     *
+     * @default false
+     */
+    strictQuery?: boolean | 'throw';
+
+    /**
+     * Overwrites default objects to `toJSON()`, for determining how Mongoose
+     * documents get serialized by `JSON.stringify()`
+     *
+     * @default { transform: true, flattenDecimals: true }
+     */
+    toJSON?: ToObjectOptions;
+
+    /**
+     * Overwrites default objects to `toObject()`
+     *
+     * @default { transform: true, flattenDecimals: true }
+     */
+    toObject?: ToObjectOptions;
+
+    /**
+     * Set to true to make Mongoose use Node.js' built-in AsyncLocalStorage (Node >= 16.0.0)
+     * to set `session` option on all operations within a `connection.transaction(fn)` call
+     * by default. Defaults to false.
+     */
+    transactionAsyncLocalStorage?: boolean;
+
+    /**
+     * If `true`, convert any aliases in filter, projection, update, and distinct
+     * to their database property names. Defaults to false.
+     */
+    translateAliases?: boolean;
+
+    /**
+     * If `true`, allows passing update pipelines (arrays) to update operations by default
+     * without explicitly setting `updatePipeline: true` in each query. This is the global
+     * default for the `updatePipeline` query option.
+     *
+     * @default false
+     */
+    updatePipeline?: boolean;
+  }
+}

package/types/pipelinestage.d.ts

@@ -0,0 +1,333 @@
+declare module 'mongoose' {
+  /**
+     * [Stages reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/#aggregation-pipeline-stages)
+     */
+  export type PipelineStage =
+    | PipelineStage.AddFields
+    | PipelineStage.Bucket
+    | PipelineStage.BucketAuto
+    | PipelineStage.CollStats
+    | PipelineStage.Count
+    | PipelineStage.Densify
+    | PipelineStage.Documents
+    | PipelineStage.Facet
+    | PipelineStage.Fill
+    | PipelineStage.GeoNear
+    | PipelineStage.GraphLookup
+    | PipelineStage.Group
+    | PipelineStage.IndexStats
+    | PipelineStage.Limit
+    | PipelineStage.ListSessions
+    | PipelineStage.Lookup
+    | PipelineStage.Match
+    | PipelineStage.Merge
+    | PipelineStage.Out
+    | PipelineStage.PlanCacheStats
+    | PipelineStage.Project
+    | PipelineStage.Redact
+    | PipelineStage.ReplaceRoot
+    | PipelineStage.ReplaceWith
+    | PipelineStage.Sample
+    | PipelineStage.Search
+    | PipelineStage.SearchMeta
+    | PipelineStage.Set
+    | PipelineStage.SetWindowFields
+    | PipelineStage.Skip
+    | PipelineStage.Sort
+    | PipelineStage.SortByCount
+    | PipelineStage.UnionWith
+    | PipelineStage.Unset
+    | PipelineStage.Unwind
+    | PipelineStage.VectorSearch;
+
+  export namespace PipelineStage {
+    export interface AddFields {
+      /** [`$addFields` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/addFields/) */
+      $addFields: Record<string, AnyExpression>
+    }
+
+    export interface Bucket {
+      /** [`$bucket` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/bucket/) */
+      $bucket: {
+        groupBy: Expression;
+        boundaries: any[];
+        default?: any
+        output?: Record<string, AccumulatorOperator>
+      }
+    }
+
+    export interface BucketAuto {
+      /** [`$bucketAuto` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/bucketAuto/) */
+      $bucketAuto: {
+        groupBy: Expression | Record<string, Expression>;
+        buckets: number;
+        output?: Record<string, AccumulatorOperator>;
+        granularity?: 'R5' | 'R10' | 'R20' | 'R40' | 'R80' | '1-2-5' | 'E6' | 'E12' | 'E24' | 'E48' | 'E96' | 'E192' | 'POWERSOF2';
+      }
+    }
+
+    export interface CollStats {
+      /** [`$collStats` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/) */
+      $collStats: {
+        latencyStats?: { histograms?: boolean };
+        storageStats?: { scale?: number };
+        count?: Record<string | number | symbol, never>;
+        queryExecStats?: Record<string | number | symbol, never>;
+      }
+    }
+
+    export interface Count {
+      /** [`$count` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/count/) */
+      $count: string;
+    }
+
+    export interface Densify{
+      /** [`$densify` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/densify/) */
+      $densify: {
+        field: string,
+        partitionByFields?: string[],
+        range: {
+          step: number,
+          unit?: 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year',
+          bounds: number[] | globalThis.Date[] | 'full' | 'partition'
+        }
+      }
+    }
+
+    export interface Documents {
+      /** [`$documents` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/documents/) */
+      $documents: Record<string, Expression>[]
+    }
+
+    export interface Fill {
+      /** [`$fill` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/fill/) */
+      $fill: {
+        partitionBy?: Expression,
+        partitionByFields?: string[],
+        sortBy?: Record<string, 1 | -1>,
+        output: Record<string, { value: Expression } | { method: 'linear' | 'locf' }>
+      }
+    }
+
+    export interface Facet {
+      /** [`$facet` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/facet/) */
+      $facet: Record<string, FacetPipelineStage[]>;
+    }
+
+    export type FacetPipelineStage = Exclude<PipelineStage, PipelineStage.CollStats | PipelineStage.Facet | PipelineStage.GeoNear | PipelineStage.IndexStats | PipelineStage.Out | PipelineStage.Merge | PipelineStage.PlanCacheStats>;
+
+    export interface GeoNear {
+      /** [`$geoNear` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/geoNear/) */
+      $geoNear: {
+        near: { type: 'Point'; coordinates: [number, number] } | [number, number];
+        distanceField: string;
+        distanceMultiplier?: number;
+        includeLocs?: string;
+        key?: string;
+        maxDistance?: number;
+        minDistance?: number;
+        query?: AnyObject;
+        spherical?: boolean;
+        /**
+         * Deprecated. Use only with MondoDB below 4.2 (removed in 4.2)
+         * @deprecated
+         */
+        num?: number;
+      }
+    }
+
+    export interface GraphLookup {
+      /** [`$graphLookup` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/graphLookup/) */
+      $graphLookup: {
+        from: string;
+        startWith: any
+        connectFromField: string;
+        connectToField: string;
+        as: string;
+        maxDepth?: number;
+        depthField?: string;
+        restrictSearchWithMatch?: AnyObject;
+      }
+    }
+
+    export interface Group {
+      /** [`$group` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/group) */
+      $group: { _id: any } | { [key: string]: AccumulatorOperator }
+    }
+
+    export interface IndexStats {
+      /** [`$indexStats` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/indexStats/) */
+      $indexStats: Record<string | number | symbol, never>;
+    }
+
+    export interface Limit {
+      /** [`$limit` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/limit/) */
+      $limit: number
+    }
+
+    export interface ListSessions {
+      /** [`$listSessions` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/listSessions/) */
+      $listSessions: { users?: { user: string; db: string }[] } | { allUsers?: true }
+    }
+
+    export interface Lookup {
+      /** [`$lookup` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/lookup/) */
+      $lookup: {
+        from: string
+        as: string
+        localField?: string
+        foreignField?: string
+        let?: Record<string, any>
+        pipeline?: Exclude<PipelineStage, PipelineStage.Merge | PipelineStage.Out>[]
+      }
+    }
+
+    export interface Match {
+      /** [`$match` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match/) */
+      $match: QueryFilter<any>;
+    }
+
+    export interface Merge {
+      /** [`$merge` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/merge/) */
+      $merge: {
+        into: string | { db: string; coll: string }
+        on?: string | string[]
+        let?: Record<string, Expression>
+        whenMatched?: 'replace' | 'keepExisting' | 'merge' | 'fail' | Extract<PipelineStage, PipelineStage.AddFields | PipelineStage.Set | PipelineStage.Project | PipelineStage.Unset | PipelineStage.ReplaceRoot | PipelineStage.ReplaceWith>[]
+        whenNotMatched?: 'insert' | 'discard' | 'fail'
+      }
+    }
+
+    export interface Out {
+      /** [`$out` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/out/) */
+      $out: string | { db: string; coll: string }
+    }
+
+    export interface PlanCacheStats {
+      /** [`$planCacheStats` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/planCacheStats/) */
+      $planCacheStats: Record<string | number | symbol, never>
+    }
+
+    export interface Project {
+      /** [`$project` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) */
+      $project: { [field: string]: AnyExpression | Expression | Project['$project'] }
+    }
+
+    export interface Redact {
+      /** [`$redact` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/redact/) */
+      $redact: Expression;
+    }
+
+    export interface ReplaceRoot {
+      /** [`$replaceRoot` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceRoot/) */
+      $replaceRoot: { newRoot: AnyExpression }
+    }
+
+    export interface ReplaceWith {
+      /** [`$replaceWith` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceWith/) */
+      $replaceWith: ObjectExpressionOperator | { [field: string]: Expression } | `$${string}`;
+    }
+
+    export interface Sample {
+      /** [`$sample` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sample/) */
+      $sample: { size: number }
+    }
+
+    export interface Search {
+      /** [`$search` reference](https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/) */
+      $search: {
+        index?: string;
+        highlight?: {
+          /** [`highlightPath` reference](https://docs.atlas.mongodb.com/atlas-search/path-construction/#multiple-field-search) */
+          path: string | string[] | { value: string, multi: string };
+          maxCharsToExamine?: number;
+          maxNumPassages?: number;
+        };
+        [operator: string]: any;
+      }
+    }
+
+    export interface SearchMeta {
+      /** [`$searchMeta` reference](https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/#mongodb-pipeline-pipe.-searchMeta) */
+      $searchMeta: {
+        index?: string;
+        highlight?: {
+          /** [`highlightPath` reference](https://docs.atlas.mongodb.com/atlas-search/path-construction/#multiple-field-search) */
+          path: string | string[] | { value: string, multi: string };
+          maxCharsToExamine?: number;
+          maxNumPassages?: number;
+        };
+        [operator: string]: any;
+      }
+    }
+
+    export interface Set {
+      /** [`$set` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/set/) */
+      $set: Record<string, AnyExpression | any>
+    }
+
+    export interface SetWindowFields {
+      /** [`$setWindowFields` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/setWindowFields/) */
+      $setWindowFields: {
+        partitionBy?: any
+        sortBy?: Record<string, 1 | -1>
+        output: Record<
+        string,
+        WindowOperator & {
+          window?: {
+            documents?: [string | number, string | number]
+            range?: [string | number, string | number]
+            unit?: 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond'
+          }
+        }
+        >
+      }
+    }
+
+    export interface Skip {
+      /** [`$skip` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/skip/) */
+      $skip: number
+    }
+
+    export interface Sort {
+      /** [`$sort` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sort/) */
+      $sort: Record<string, 1 | -1 | Expression.Meta>
+    }
+
+    export interface SortByCount {
+      /** [`$sortByCount` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sortByCount/) */
+      $sortByCount: Expression;
+    }
+
+    export interface UnionWith {
+      /** [`$unionWith` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith/) */
+      $unionWith:
+      | string
+      | { coll: string; pipeline?: Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>[] }
+      | { coll?: string; pipeline: Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>[] }
+    }
+
+    export interface Unset {
+      /** [`$unset` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unset/) */
+      $unset: string | string[]
+    }
+
+    export interface Unwind {
+      /** [`$unwind` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unwind/) */
+      $unwind: string | { path: string; includeArrayIndex?: string; preserveNullAndEmptyArrays?: boolean }
+    }
+    export interface VectorSearch {
+      /** [`$vectorSearch` reference](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/) */
+      $vectorSearch: {
+        exact?: boolean;
+        index: string,
+        path: string,
+        queryVector: number[],
+        numCandidates?: number,
+        limit: number,
+        filter?: Expression,
+      }
+    }
+
+  }
+}

package/types/populate.d.ts

@@ -0,0 +1,53 @@
+declare module 'mongoose' {
+
+  /**
+   * Reference another Model
+   */
+  type PopulatedDoc<
+    PopulatedType,
+    RawId extends RefType = (PopulatedType extends { _id?: RefType; } ? NonNullable<PopulatedType['_id']> : Types.ObjectId) | undefined
+  > = PopulatedType | RawId;
+
+  interface PopulateOptions {
+    /** space delimited path(s) to populate */
+    path: string;
+    /** fields to select */
+    select?: any;
+    /** query conditions to match */
+    match?: any;
+    /** optional model to use for population */
+    model?: string | Model<any>;
+    /** optional query options like sort, limit, etc */
+    options?: QueryOptions;
+    /** correct limit on populated array */
+    perDocumentLimit?: number;
+    /** optional boolean, set to `false` to allow populating paths that aren't in the schema */
+    strictPopulate?: boolean;
+    /** deep populate */
+    populate?: string | PopulateOptions | (string | PopulateOptions)[];
+    /**
+     * If true Mongoose will always set `path` to a document, or `null` if no document was found.
+     * If false Mongoose will always set `path` to an array, which will be empty if no documents are found.
+     * Inferred from schema by default.
+     */
+    justOne?: boolean;
+    /** transform function to call on every populated doc */
+    transform?: (doc: any, id: any) => any;
+    /** Overwrite the schema-level local field to populate on if this is a populated virtual. */
+    localField?: string;
+    /** Overwrite the schema-level foreign field to populate on if this is a populated virtual. */
+    foreignField?: string;
+    /** Set to `false` to prevent Mongoose from repopulating paths that are already populated */
+    forceRepopulate?: boolean;
+    /**
+     * Set to `true` to execute any populate queries one at a time, as opposed to in parallel.
+     * We recommend setting this option to `true` if using transactions, especially if also populating multiple paths or paths with multiple models.
+     * MongoDB server does **not** support multiple operations in parallel on a single transaction.
+     */
+    ordered?: boolean;
+  }
+
+  interface PopulateOption {
+    populate?: string | string[] | PopulateOptions | PopulateOptions[];
+  }
+}