Merge pull request #12649 from Automattic/vkarpov15/gh-12420

fix(types): make array paths optional in inferred type of array default returns undefined
Automattic · Nov 2, 2022 · 64f6ff4 · 64f6ff4
2 parents f9501d2 + 1f6864f
commit 64f6ff4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/test/types/schema.test.ts b/test/types/schema.test.ts
@@ -412,6 +412,7 @@ export function autoTypedSchema() {
     array5: any[];
     array6: string[];
     array7?: string[];
+    array8?: string[];
     decimal1?: Types.Decimal128;
     decimal2?: Types.Decimal128;
     decimal3?: Types.Decimal128;
@@ -458,6 +459,7 @@ export function autoTypedSchema() {
     array5: [],
     array6: { type: [String] },
     array7: { type: [String], default: undefined },
+    array8: { type: [String], default: () => undefined },
     decimal1: Schema.Types.Decimal128,
     decimal2: 'Decimal128',
     decimal3: 'decimal128'

diff --git a/types/inferschematype.d.ts b/types/inferschematype.d.ts
@@ -60,6 +60,12 @@ declare module 'mongoose' {
       : unknown;
 }
 
+type IsPathDefaultUndefined<PathType> = PathType extends { default: undefined } ?
+  true :
+  PathType extends { default: (...args: any[]) => undefined } ?
+    true :
+    false;
+
 /**
  * @summary Checks if a document path is required or optional.
  * @param {P} P Document path.
@@ -69,7 +75,7 @@ type IsPathRequired<P, TypeKey extends TypeKeyBaseType = DefaultTypeKey> =
   P extends { required: true | [true, string | undefined] } | ArrayConstructor | any[]
     ? true
     : P extends (Record<TypeKey, ArrayConstructor | any[]>)
-      ? P extends { default: undefined }
+      ? IsPathDefaultUndefined<P> extends true
         ? false
         : true
       : P extends (Record<TypeKey, any>)