@bedrockio/model 0.2.19 → 0.2.21

package/dist/cjs/include.js

@@ -181,6 +181,12 @@ function nodeToPopulates(node) {
     populate
   };
 }
+
+// Null serves as a flag that the key terminates
+// the branch and this is a leaf node. Using null
+// here as it's simple and serializes to JSON for
+// easy inspection.
+const LEAF_NODE = null;
 function pathsToNode(paths, modelName) {
   const node = {};
   for (let str of paths) {
@@ -228,7 +234,7 @@ function setNodePath(node, options) {
         // -user.name - Implies population of "user" but exclude "user.name",
         //  so continue traversing into object when part is "user".
         if (isExact && exclude) {
-          node['-' + key] = null;
+          node['-' + key] = LEAF_NODE;
         } else if (field.ref) {
           node[key] ||= {};
           setNodePath(node[key], {
@@ -239,7 +245,7 @@ function setNodePath(node, options) {
           });
           halt = true;
         } else if ((0, _utils.isSchemaTypedef)(field)) {
-          node[key] = null;
+          node[key] = LEAF_NODE;
         }
       } else if (type === 'virtual') {
         const virtual = schema.virtual(key);

package/dist/cjs/schema.js

@@ -227,13 +227,13 @@ function applyScopeExtension(typedef, definition) {
         ...options
       };
     } else {
-      val = attributesToMongoose({
+      val = {
         type: 'Object',
         attributes: val,
         ...options
-      });
+      };
     }
-    definition[key] = val;
+    definition[key] = attributesToMongoose(val);
   }
 }
 

package/dist/cjs/validation.js

@@ -105,13 +105,13 @@ function applyValidation(schema, definition) {
       model: this,
       appendSchema,
       allowInclude,
+      allowUnset: true,
       skipRequired: true,
       stripUnknown: true,
       stripDeleted: true,
       stripTimestamps: true,
       allowExpandedRefs: true,
       requireWriteAccess: true,
-      allowNullForPrimitives: true,
       ...(hasUnique && {
         assertUniqueOptions: {
           schema,
@@ -270,8 +270,8 @@ function getSchemaForTypedef(typedef, options = {}) {
   }
   if (isRequired(typedef, options)) {
     schema = schema.required();
-  } else if (allowsNull(typedef, options)) {
-    schema = _yada.default.allow(null, schema);
+  } else if (allowUnset(typedef, options)) {
+    schema = _yada.default.allow(null, '', schema);
   }
   if (typedef.default && options.allowDefaultTags) {
     // Tag the default value to allow OpenAPI description
@@ -379,15 +379,8 @@ function getSearchSchema(schema, type) {
 function isRequired(typedef, options) {
   return typedef.required && !typedef.default && !options.skipRequired;
 }
-function allowsNull(typedef, options) {
-  if (!options.allowNullForPrimitives) {
-    return false;
-  }
-  return !typedef.required && isPrimitiveTypedef(typedef);
-}
-const PRIMITIVE_TYPES = ['String', 'Number', 'Boolean'];
-function isPrimitiveTypedef(typedef) {
-  return PRIMITIVE_TYPES.includes(typedef.type);
+function allowUnset(typedef, options) {
+  return options.allowUnset && !typedef.required;
 }
 function isExcludedField(field, options) {
   if ((0, _utils.isSchemaTypedef)(field)) {

package/jest-mongodb-config.cjs

@@ -0,0 +1,14 @@
+// Note this file MUST be a CJS module as it will be required
+// by @shelf/jest-mongodb. Note also that the binary version
+// does not match the mongodb driver version.
+
+module.exports = {
+  mongodbMemoryServerOptions: {
+    binary: {
+      version: '6.0.2',
+      skipMD5: true,
+    },
+    autoStart: false,
+    instance: {},
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.2.19",
+  "version": "0.2.21",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {
@@ -30,7 +30,7 @@
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@bedrockio/yada": "^1.0.39",
+    "@bedrockio/yada": "^1.0.40",
     "mongoose": "^7.6.4"
   },
   "devDependencies": {
@@ -38,13 +38,13 @@
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@bedrockio/prettier-config": "^1.0.2",
-    "@bedrockio/yada": "^1.0.39",
-    "@shelf/jest-mongodb": "^4.1.7",
+    "@bedrockio/yada": "^1.0.40",
+    "@shelf/jest-mongodb": "^4.2.0",
     "eslint": "^8.33.0",
     "eslint-plugin-bedrock": "^1.0.26",
     "jest": "^29.4.1",
     "jest-environment-node": "^29.4.1",
-    "mongodb": "^6.2.0",
+    "mongodb": "^6.5.0",
     "mongoose": "^7.6.4",
     "prettier-eslint": "^15.0.1",
     "typescript": "^4.9.5"

package/src/include.js

@@ -170,6 +170,12 @@ function nodeToPopulates(node) {
   };
 }
 
+// Null serves as a flag that the key terminates
+// the branch and this is a leaf node. Using null
+// here as it's simple and serializes to JSON for
+// easy inspection.
+const LEAF_NODE = null;
+
 function pathsToNode(paths, modelName) {
   const node = {};
   for (let str of paths) {
@@ -214,7 +220,7 @@ function setNodePath(node, options) {
         // -user.name - Implies population of "user" but exclude "user.name",
         //  so continue traversing into object when part is "user".
         if (isExact && exclude) {
-          node['-' + key] = null;
+          node['-' + key] = LEAF_NODE;
         } else if (field.ref) {
           node[key] ||= {};
           setNodePath(node[key], {
@@ -225,7 +231,7 @@ function setNodePath(node, options) {
           });
           halt = true;
         } else if (isSchemaTypedef(field)) {
-          node[key] = null;
+          node[key] = LEAF_NODE;
         }
       } else if (type === 'virtual') {
         const virtual = schema.virtual(key);

package/src/schema.js

@@ -236,13 +236,13 @@ function applyScopeExtension(typedef, definition) {
         ...options,
       };
     } else {
-      val = attributesToMongoose({
+      val = {
         type: 'Object',
         attributes: val,
         ...options,
-      });
+      };
     }
-    definition[key] = val;
+    definition[key] = attributesToMongoose(val);
   }
 }
 

package/src/validation.js

@@ -118,13 +118,13 @@ export function applyValidation(schema, definition) {
         model: this,
         appendSchema,
         allowInclude,
+        allowUnset: true,
         skipRequired: true,
         stripUnknown: true,
         stripDeleted: true,
         stripTimestamps: true,
         allowExpandedRefs: true,
         requireWriteAccess: true,
-        allowNullForPrimitives: true,
         ...(hasUnique && {
           assertUniqueOptions: {
             schema,
@@ -283,8 +283,8 @@ function getSchemaForTypedef(typedef, options = {}) {
 
   if (isRequired(typedef, options)) {
     schema = schema.required();
-  } else if (allowsNull(typedef, options)) {
-    schema = yd.allow(null, schema);
+  } else if (allowUnset(typedef, options)) {
+    schema = yd.allow(null, '', schema);
   }
 
   if (typedef.default && options.allowDefaultTags) {
@@ -434,17 +434,8 @@ function isRequired(typedef, options) {
   return typedef.required && !typedef.default && !options.skipRequired;
 }
 
-function allowsNull(typedef, options) {
-  if (!options.allowNullForPrimitives) {
-    return false;
-  }
-  return !typedef.required && isPrimitiveTypedef(typedef);
-}
-
-const PRIMITIVE_TYPES = ['String', 'Number', 'Boolean'];
-
-function isPrimitiveTypedef(typedef) {
-  return PRIMITIVE_TYPES.includes(typedef.type);
+function allowUnset(typedef, options) {
+  return options.allowUnset && !typedef.required;
 }
 
 function isExcludedField(field, options) {

package/types/load.d.ts

@@ -4,7 +4,73 @@
  * @param {string} name
  * @returns mongoose.Model
  */
-export function loadModel(definition: object, name: string): any;
+export function loadModel(definition: object, name: string): mongoose.Model<any, any, any, any, any, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, any, any, any, {
+    [x: string]: any;
+}, {
+    autoIndex?: boolean;
+    autoCreate?: boolean;
+    bufferCommands?: boolean;
+    bufferTimeoutMS?: number;
+    capped?: number | boolean | {
+        size?: number;
+        max?: number;
+        autoIndexId?: boolean;
+    };
+    collation?: mongoose.mongo.CollationOptions;
+    collectionOptions?: mongoose.mongo.CreateCollectionOptions;
+    timeseries?: mongoose.mongo.TimeSeriesCollectionOptions;
+    expireAfterSeconds?: number;
+    expires?: string | number;
+    collection?: string;
+    discriminatorKey?: string;
+    excludeIndexes?: boolean;
+    id?: boolean;
+    _id?: boolean;
+    minimize?: boolean;
+    optimisticConcurrency?: boolean;
+    pluginTags?: string[];
+    read?: string;
+    writeConcern?: mongoose.mongo.WriteConcern;
+    safe?: boolean | {
+        w?: string | number;
+        wtimeout?: number;
+        j?: boolean;
+    };
+    shardKey?: Record<string, unknown>;
+    strict?: boolean | "throw";
+    strictQuery?: boolean | "throw";
+    toJSON: {
+        getters: boolean;
+        versionKey: boolean;
+        transform: (doc: any, ret: any, options: any) => void;
+    } | mongoose.ToObjectOptions<any>;
+    toObject: {
+        getters: boolean;
+        versionKey: boolean;
+        transform: (doc: any, ret: any, options: any) => void;
+    } | mongoose.ToObjectOptions<any>;
+    typeKey?: string;
+    validateBeforeSave?: boolean;
+    validateModifiedOnly?: boolean;
+    versionKey?: string | boolean;
+    selectPopulatedPaths?: boolean;
+    skipVersioning?: {
+        [key: string]: boolean;
+    };
+    storeSubdocValidationError?: boolean;
+    timestamps: boolean | mongoose.SchemaTimestampsConfig;
+    suppressReservedKeysWarning?: boolean;
+    statics?: {
+        [x: string]: any;
+    };
+    methods?: any;
+    query?: any;
+    castNonArrays?: boolean;
+    virtuals?: mongoose.SchemaOptionsVirtualsPropertyType<any, any, any>;
+    overwriteModels?: boolean;
+}, any, any>> & {
+    [x: string]: any;
+};
 /**
  * Loads all model definitions in the given directory.
  * Returns the full loaded model set.

package/types/load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../src/load.js"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,sCAJW,MAAM,QACN,MAAM,OAahB;AAED;;;;GAIG;AACH,sCAFW,MAAM,mBAkBhB"}
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../src/load.js"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,sCAJW,MAAM,QACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAahB;AAED;;;;GAIG;AACH,sCAFW,MAAM,mBAkBhB"}

package/types/schema.d.ts

@@ -6,7 +6,9 @@
  * @param {mongoose.SchemaOptions} options
  * @returns mongoose.Schema
  */
-export function createSchema(definition: object, options?: mongoose.SchemaOptions): mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, any, any, any, any, {
+export function createSchema(definition: object, options?: mongoose.SchemaOptions): mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, any, any, any, {
+    [x: string]: any;
+}, {
     autoIndex?: boolean;
     autoCreate?: boolean;
     bufferCommands?: boolean;
@@ -60,8 +62,10 @@ export function createSchema(definition: object, options?: mongoose.SchemaOption
     storeSubdocValidationError?: boolean;
     timestamps: boolean | mongoose.SchemaTimestampsConfig;
     suppressReservedKeysWarning?: boolean;
-    statics?: mongoose.AddThisParameter<any, mongoose.Model<any, {}, {}, {}, any, any>>;
-    methods?: mongoose.AddThisParameter<any, any> & mongoose.AnyObject;
+    statics?: {
+        [x: string]: any;
+    };
+    methods?: any;
     query?: any;
     castNonArrays?: boolean;
     virtuals?: mongoose.SchemaOptionsVirtualsPropertyType<any, any, any>;

package/types/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.js"],"names":[],"mappings":"AAoBA;;;;;;;GAOG;AACH,yCAJW,MAAM,YACN,SAAS,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAuChC;AAED,iEAsBC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.js"],"names":[],"mappings":"AAoBA;;;;;;;GAOG;AACH,yCAJW,MAAM,YACN,SAAS,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAuChC;AAED,iEAsBC"}

package/types/validation.d.ts

@@ -11,6 +11,7 @@ export function getTupleValidator(types: any): {
 };
 export const OBJECT_ID_SCHEMA: {
     required(): any;
+    allowEmpty(): any;
     length(length: number): any;
     min(length: number): any;
     max(length: number): any;

package/types/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAkFA,kDAEC;AAED,oEAqFC;AAsBD,wEAkBC;AAySD;;;EAEC;AAED;;;EAOC;AArfD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAkFA,kDAEC;AAED,oEAqFC;AAsBD,wEAkBC;AAgSD;;;EAEC;AAED;;;EAOC;AA5eD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}

package/jest-mongodb-config.js

@@ -1,12 +0,0 @@
-const { devDependencies } = require('./package.json');
-
-module.exports = {
-  mongodbMemoryServerOptions: {
-    binary: {
-      version: devDependencies.mongodb,
-      skipMD5: true,
-    },
-    autoStart: false,
-    instance: {},
-  },
-};