Merge pull request #12818 from hasezoey/addDefaultOptionsST

fix(schematypes): add property "defaultOptions"

test/types/schemaTypeOptions.test.ts

@@ -53,3 +53,22 @@ function index() {
   expectError<SchemaTypeOptions<string>['index']>(-2); // test invalid number
   expectError<SchemaTypeOptions<string>['index']>(new Date()); // test invalid type
 }
+
+function defaultOptions() {
+  // property "defaultOptions" may not be defined on the base "SchemaType", but is explicitly defined on all mongoose provided Schema.Types
+  // https://github.com/Automattic/mongoose/blob/5528a6428bb08091c03d868e249c2e5a30144a71/lib/schematype.js#L55
+  expectType<Record<string, any> | undefined>(new SchemaType('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.String('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Boolean('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Array('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Buffer('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Date('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Decimal128('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.DocumentArray('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Map('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Mixed('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Number('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.ObjectId('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.Subdocument('none').defaultOptions);
+  expectType<Record<string, any>>(new Schema.Types.UUID('none').defaultOptions);
+}

types/schematypes.d.ts

@@ -278,6 +278,9 @@ declare module 'mongoose' {
 
     /** Adds validator(s) for this document path. */
     validate(obj: RegExp | ((this: DocType, value: any, validatorProperties?: Validator) => any), errorMsg?: string, type?: string): this;
+
+    /** Default options for this SchemaType */
+    defaultOptions?: Record<string, any>;
   }
 
   namespace Schema {
@@ -294,6 +297,9 @@ declare module 'mongoose' {
         /** The schematype embedded in this array */
         caster?: SchemaType;
 
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
+
         /**
          * Adds an enum validator if this is an array of strings or numbers. Equivalent to
          * `SchemaString.prototype.enum()` or `SchemaNumber.prototype.enum()`
@@ -310,6 +316,9 @@ declare module 'mongoose' {
 
         /** Configure which values get casted to `false`. */
         static convertToFalse: Set<any>;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Buffer extends SchemaType {
@@ -321,6 +330,9 @@ declare module 'mongoose' {
          * for this buffer. You can find a [list of allowed subtypes here](http://api.mongodb.com/python/current/api/bson/binary.html).
          */
         subtype(subtype: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 128): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Date extends SchemaType {
@@ -335,11 +347,17 @@ declare module 'mongoose' {
 
         /** Sets a minimum date validator. */
         min(value: NativeDate, message: string): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Decimal128 extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Decimal128';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class DocumentArray extends SchemaType implements AcceptsDiscriminator {
@@ -356,16 +374,25 @@ declare module 'mongoose' {
 
         /** The constructor used for subdocuments in this array */
         caster?: typeof Types.Subdocument;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Map extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Map';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Mixed extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Mixed';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Number extends SchemaType {
@@ -380,6 +407,9 @@ declare module 'mongoose' {
 
         /** Sets a minimum number validator. */
         min(value: number, message: string): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class ObjectId extends SchemaType {
@@ -388,6 +418,9 @@ declare module 'mongoose' {
 
         /** Adds an auto-generated ObjectId default if turnOn is true. */
         auto(turnOn: boolean): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Subdocument extends SchemaType implements AcceptsDiscriminator {
@@ -397,6 +430,9 @@ declare module 'mongoose' {
         /** The document's schema */
         schema: Schema;
 
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
+
         discriminator<T, U>(name: string | number, schema: Schema<T, U>, value?: string): U;
         discriminator<D>(name: string | number, schema: Schema, value?: string): Model<D>;
       }
@@ -425,11 +461,17 @@ declare module 'mongoose' {
 
         /** Adds an uppercase [setter](http://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-set). */
         uppercase(shouldApply?: boolean): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class UUID extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'UUID';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
     }
   }