@bedrockio/model 0.4.1 → 0.4.2

package/dist/cjs/validation.js

@@ -83,6 +83,7 @@ function applyValidation(schema, definition) {
       model: this,
       appendSchema,
       allowInclude,
+      allowEmpty: true,
       stripDeleted: true,
       stripTimestamps: true,
       allowDefaultTags: true,
@@ -286,6 +287,10 @@ function getSchemaForTypedef(typedef, options = {}) {
     // Unsetting only allowed for primitive types.
     if (allowUnset(typedef, options)) {
       schema = _yada.default.allow(null, '', schema);
+    } else if (allowEmpty(typedef, options)) {
+      schema = schema.options({
+        allowEmpty: true
+      });
     }
   }
   if (isRequired(typedef, options)) {
@@ -400,6 +405,9 @@ function isRequired(typedef, options) {
 function allowUnset(typedef, options) {
   return options.allowUnset && !typedef.required;
 }
+function allowEmpty(typedef, options) {
+  return options.allowEmpty && typedef.type === 'String';
+}
 function isExcludedField(field, options) {
   if ((0, _utils.isSchemaTypedef)(field)) {
     if (options.requireWriteAccess) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {
@@ -30,7 +30,7 @@
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@bedrockio/yada": "^1.0.40",
+    "@bedrockio/yada": "^1.1.2",
     "mongoose": "^7.6.13"
   },
   "devDependencies": {
@@ -38,7 +38,7 @@
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@bedrockio/prettier-config": "^1.0.2",
-    "@bedrockio/yada": "^1.0.40",
+    "@bedrockio/yada": "^1.1.2",
     "@shelf/jest-mongodb": "^4.3.2",
     "eslint": "^8.33.0",
     "eslint-plugin-bedrock": "^1.0.26",

package/src/validation.js

@@ -95,6 +95,7 @@ export function applyValidation(schema, definition) {
         model: this,
         appendSchema,
         allowInclude,
+        allowEmpty: true,
         stripDeleted: true,
         stripTimestamps: true,
         allowDefaultTags: true,
@@ -301,6 +302,10 @@ function getSchemaForTypedef(typedef, options = {}) {
     // Unsetting only allowed for primitive types.
     if (allowUnset(typedef, options)) {
       schema = yd.allow(null, '', schema);
+    } else if (allowEmpty(typedef, options)) {
+      schema = schema.options({
+        allowEmpty: true,
+      });
     }
   }
 
@@ -459,6 +464,10 @@ function allowUnset(typedef, options) {
   return options.allowUnset && !typedef.required;
 }
 
+function allowEmpty(typedef, options) {
+  return options.allowEmpty && typedef.type === 'String';
+}
+
 function isExcludedField(field, options) {
   if (isSchemaTypedef(field)) {
     if (options.requireWriteAccess) {

package/types/include.d.ts

@@ -14,7 +14,7 @@ export const INCLUDE_FIELD_SCHEMA: {
     meta: {};
     required(): any;
     default(arg: any): any;
-    custom(...args: import("@bedrockio/yada/types/Schema").CustomSignature): any;
+    custom(fn: Function): any;
     strip(strip: any): any;
     allow(...set: any[]): any;
     reject(...set: any[]): any;

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":"AAqBA;;;;;;;GAOG;AACH,yCAJW,MAAM,YACN,SAAS,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAwChC;AAED,iEAsBC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.js"],"names":[],"mappings":"AAqBA;;;;;;;GAOG;AACH,yCAJW,MAAM,YACN,SAAS,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAwChC;AAED,iEAsBC"}

package/types/search.d.ts

@@ -11,7 +11,7 @@ export function searchValidation(options?: {}): {
     meta: {};
     required(): any;
     default(arg: any): any;
-    custom(...args: import("@bedrockio/yada/types/Schema").CustomSignature): any;
+    custom(fn: Function): any;
     strip(strip: any): any;
     allow(...set: any[]): any;
     reject(...set: any[]): any;

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;
@@ -72,7 +73,7 @@ export const OBJECT_ID_SCHEMA: {
     assertions: any[];
     meta: {};
     default(arg: any): any;
-    custom(...args: import("@bedrockio/yada/types/Schema").CustomSignature): any;
+    custom(fn: Function): any;
     strip(strip: any): any;
     allow(...set: any[]): any;
     reject(...set: any[]): 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,oEA8FC;AAsBD,wEA2BC;AAmSD;;;EAEC;AAED;;;EAOC;AAjgBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAkFA,kDAEC;AAED,oEA+FC;AAsBD,wEA2BC;AA2SD;;;EAEC;AAED;;;EAOC;AA1gBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}