@bedrockio/model 0.2.2 → 0.2.4

package/dist/cjs/validation.js

@@ -145,7 +145,8 @@ function applyValidation(schema, definition) {
   });
   schema.static('getBaseSchema', function getBaseSchema() {
     return getSchemaFromMongoose(schema, {
-      stripDeleted: true
+      stripDeleted: true,
+      requireReadAccess: true
     });
   });
 }
@@ -375,13 +376,13 @@ function isRequired(typedef, options) {
 }
 function isExcludedField(field, options) {
   if ((0, _utils.isSchemaTypedef)(field)) {
-    const {
-      requireWriteAccess
-    } = options;
-    return requireWriteAccess && field.writeAccess === 'none';
-  } else {
-    return false;
+    if (options.requireWriteAccess) {
+      return field.writeAccess === 'none';
+    } else if (options.requireReadAccess) {
+      return field.readAccess === 'none' || field.readAccess === 'self';
+    }
   }
+  return false;
 }
 function validateReadAccess(schema, allowed, options) {
   return validateAccess('read', schema, allowed, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {

package/src/validation.js

@@ -163,6 +163,7 @@ export function applyValidation(schema, definition) {
   schema.static('getBaseSchema', function getBaseSchema() {
     return getSchemaFromMongoose(schema, {
       stripDeleted: true,
+      requireReadAccess: true,
     });
   });
 }
@@ -430,11 +431,13 @@ function isRequired(typedef, options) {
 
 function isExcludedField(field, options) {
   if (isSchemaTypedef(field)) {
-    const { requireWriteAccess } = options;
-    return requireWriteAccess && field.writeAccess === 'none';
-  } else {
-    return false;
+    if (options.requireWriteAccess) {
+      return field.writeAccess === 'none';
+    } else if (options.requireReadAccess) {
+      return field.readAccess === 'none' || field.readAccess === 'self';
+    }
   }
+  return false;
 }
 
 function validateReadAccess(schema, allowed, 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, {
+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;
@@ -16,8 +18,9 @@ export function createSchema(definition: object, options?: mongoose.SchemaOption
         max?: number;
         autoIndexId?: boolean;
     };
-    collation?: import("mongoose/node_modules/mongodb").CollationOptions;
-    timeseries?: import("mongoose/node_modules/mongodb").TimeSeriesCollectionOptions;
+    collation?: mongoose.mongo.CollationOptions;
+    collectionOptions?: mongoose.mongo.CreateCollectionOptions;
+    timeseries?: mongoose.mongo.TimeSeriesCollectionOptions;
     expireAfterSeconds?: number;
     expires?: string | number;
     collection?: string;
@@ -29,7 +32,7 @@ export function createSchema(definition: object, options?: mongoose.SchemaOption
     optimisticConcurrency?: boolean;
     pluginTags?: string[];
     read?: string;
-    writeConcern?: import("mongoose/node_modules/mongodb").WriteConcern;
+    writeConcern?: mongoose.mongo.WriteConcern;
     safe?: boolean | {
         w?: string | number;
         wtimeout?: number;
@@ -42,14 +45,15 @@ export function createSchema(definition: object, options?: mongoose.SchemaOption
         getters: boolean;
         versionKey: boolean;
         transform: (doc: any, ret: any, options: any) => void;
-    } | mongoose.ToObjectOptions;
+    } | mongoose.ToObjectOptions<any>;
     toObject: {
         getters: boolean;
         versionKey: boolean;
         transform: (doc: any, ret: any, options: any) => void;
-    } | mongoose.ToObjectOptions;
+    } | mongoose.ToObjectOptions<any>;
     typeKey?: string;
     validateBeforeSave?: boolean;
+    validateModifiedOnly?: boolean;
     versionKey?: string | boolean;
     selectPopulatedPaths?: boolean;
     skipVersioning?: {
@@ -57,14 +61,16 @@ export function createSchema(definition: object, options?: mongoose.SchemaOption
     };
     storeSubdocValidationError?: boolean;
     timestamps: boolean | mongoose.SchemaTimestampsConfig;
-    supressReservedKeysWarning?: boolean;
-    statics?: any;
+    suppressReservedKeysWarning?: boolean;
+    statics?: {
+        [x: string]: any;
+    };
     methods?: any;
     query?: any;
     castNonArrays?: boolean;
     virtuals?: mongoose.SchemaOptionsVirtualsPropertyType<any, any, any>;
     overwriteModels?: boolean;
-}, any>;
+}, any, any>;
 export function normalizeAttributes(arg: any, path?: any[]): any;
 import mongoose from "mongoose";
 //# sourceMappingURL=schema.d.ts.map

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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAuChC;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/testing.d.ts

@@ -5,7 +5,7 @@
  * [Link](https://github.com/bedrockio/model#testing)
  * @returns mongoose.Model
  */
-export function createTestModel(...args: any[]): mongoose.Model<any, unknown, unknown, unknown, any>;
+export function createTestModel(...args: any[]): mongoose.Model<any, unknown, unknown, unknown, any, any>;
 export function getTestModelName(): string;
 import mongoose from "mongoose";
 //# sourceMappingURL=testing.d.ts.map

package/types/testing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.js"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,qGAiBC;AAED,2CAEC"}
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.js"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,0GAiBC;AAED,2CAEC"}

package/types/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEAkFC;AAsBD,wEAkBC;AAwRD;;;EAEC;AAED;;;EAOC;AAheD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEAmFC;AAsBD,wEAkBC;AA0RD;;;EAEC;AAED;;;EAOC;AAneD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}