@bedrockio/model 0.1.31 → 0.1.32

package/dist/cjs/validation.js

@@ -85,6 +85,7 @@ function applyValidation(schema, definition) {
       allowInclude,
       stripDeleted: true,
       stripTimestamps: true,
+      allowDefaultTags: true,
       allowExpandedRefs: true,
       requireWriteAccess: true,
       ...(hasUnique && {
@@ -267,12 +268,15 @@ function getSchemaForTypedef(typedef, options = {}) {
   if (isRequired(typedef, options)) {
     schema = schema.required();
   }
-  if (typedef.default) {
-    // Note that adding a default in the validation is
-    // technically unnecessary as this will be handled
-    // at the model level, however passing this on will
-    // enrich OpenAPI documentation.
-    schema = schema.default(typedef.default);
+  if (typedef.default && options.allowDefaultTags) {
+    // Tag the default value to allow OpenAPI description
+    // of the field but do not actually set the default as it will
+    // be handled on the schema level. The tags are being appended
+    // for the create validation only as a convenience to describe
+    // the default value on creation in OpenApi.
+    schema = schema.tag({
+      default: typedef.default
+    });
   }
   if (typedef.validate?.schema) {
     schema = schema.append(typedef.validate.schema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.1.31",
+  "version": "0.1.32",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {
@@ -29,7 +29,7 @@
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@bedrockio/yada": "^1.0.32",
+    "@bedrockio/yada": "^1.0.33",
     "mongoose": ">=6.9.0"
   },
   "devDependencies": {
@@ -37,7 +37,7 @@
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@bedrockio/prettier-config": "^1.0.2",
-    "@bedrockio/yada": "^1.0.32",
+    "@bedrockio/yada": "^1.0.33",
     "@shelf/jest-mongodb": "^4.1.6",
     "babel-plugin-import-replacement": "^1.0.1",
     "eslint": "^8.33.0",

package/src/validation.js

@@ -96,6 +96,7 @@ export function applyValidation(schema, definition) {
         allowInclude,
         stripDeleted: true,
         stripTimestamps: true,
+        allowDefaultTags: true,
         allowExpandedRefs: true,
         requireWriteAccess: true,
         ...(hasUnique && {
@@ -279,13 +280,18 @@ function getSchemaForTypedef(typedef, options = {}) {
   if (isRequired(typedef, options)) {
     schema = schema.required();
   }
-  if (typedef.default) {
-    // Note that adding a default in the validation is
-    // technically unnecessary as this will be handled
-    // at the model level, however passing this on will
-    // enrich OpenAPI documentation.
-    schema = schema.default(typedef.default);
+
+  if (typedef.default && options.allowDefaultTags) {
+    // Tag the default value to allow OpenAPI description
+    // of the field but do not actually set the default as it will
+    // be handled on the schema level. The tags are being appended
+    // for the create validation only as a convenience to describe
+    // the default value on creation in OpenApi.
+    schema = schema.tag({
+      default: typedef.default,
+    });
   }
+
   if (typedef.validate?.schema) {
     schema = schema.append(typedef.validate.schema);
   } else if (typeof typedef.validate === 'function') {
@@ -304,6 +310,7 @@ function getSchemaForTypedef(typedef, options = {}) {
   if (typedef.max != null || typedef.maxLength != null) {
     schema = schema.max(typedef.max ?? typedef.maxLength);
   }
+
   if (options.allowSearch) {
     schema = getSearchSchema(schema, type);
   }

package/types/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEAiFC;AAsBD,wEAkBC;AAiRD;;;EAEC;AAED;;;EAOC;AAxdD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEAkFC;AAsBD,wEAkBC;AAuRD;;;EAEC;AAED;;;EAOC;AA/dD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}