@bedrockio/yada 1.0.28 → 1.0.30

package/.prettierrc.cjs

@@ -0,0 +1 @@
+module.exports = require('@bedrockio/prettier-config');

package/README.md

@@ -527,6 +527,13 @@ console.log(await schema.validate()); // "hi!"
 console.log(await schema.validate('hello!')); // "hello!"
 ```
 
+Note that the argument passed to default may also be a function:
+
+```js
+const schema = yd.string().default(Date.now);
+console.log(await schema.validate()); // Returns current timestamp
+```
+
 ### Strip
 
 The `strip` method serves as a way to conditionally exclude fields when the

package/dist/cjs/Schema.js

@@ -39,12 +39,13 @@ class Schema {
    * Sets the schema default. [Link](https://github.com/bedrockio/yada#default)
    * @returns {this}
    */
-  default(value) {
+  default(arg) {
+    const getDefaultValue = typeof arg === 'function' ? arg : () => arg;
     return this.clone({
-      default: value
+      default: arg
     }).assert('default', val => {
       if (val === undefined) {
-        return value;
+        return getDefaultValue();
       }
     });
   }

package/dist/cjs/object.js

@@ -7,7 +7,9 @@ exports.default = _default;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
 var _utils = require("./utils");
-var _Schema = _interopRequireDefault(require("./Schema"));
+var _Schema = _interopRequireWildcard(require("./Schema"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const BASE_ASSERTIONS = ['type', 'transform', 'field'];
 
@@ -59,6 +61,9 @@ class ObjectSchema extends _TypeSchema.default {
       }
     });
     for (let [key, schema] of Object.entries(this.getFields())) {
+      if (!(0, _Schema.isSchema)(schema)) {
+        throw new Error(`Key "${key}" must be a schema`);
+      }
       this.assert('field', async (obj, options) => {
         if (obj) {
           const {

package/dist/cjs/string.js

@@ -26,6 +26,21 @@ class StringSchema extends _TypeSchema.default {
     });
   }
 
+  /**
+   * @returns {this}
+   */
+  required() {
+    return this.clone({
+      required: true
+    }).assert('required', val => {
+      if (val == null) {
+        throw new _errors.LocalizedError('Value is required.');
+      } else if (val === '') {
+        throw new _errors.LocalizedError('String may not be empty.');
+      }
+    });
+  }
+
   /**
    * @param {number} length
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "description": "Validation library inspired by Joi.",
   "scripts": {
     "test": "jest",
@@ -27,7 +27,7 @@
     "babel-plugin-add-module-exports": "^1.0.4",
     "eslint": "^8.26.0",
     "eslint-plugin-bedrock": "^1.0.24",
-    "jest": "^29.2.2",
+    "jest": "^29.6.2",
     "prettier": "^2.7.1",
     "prettier-eslint": "^15.0.1",
     "typescript": "^4.9.5"

package/src/Schema.js

@@ -37,10 +37,11 @@ export default class Schema {
    * Sets the schema default. [Link](https://github.com/bedrockio/yada#default)
    * @returns {this}
    */
-  default(value) {
-    return this.clone({ default: value }).assert('default', (val) => {
+  default(arg) {
+    const getDefaultValue = typeof arg === 'function' ? arg : () => arg;
+    return this.clone({ default: arg }).assert('default', (val) => {
       if (val === undefined) {
-        return value;
+        return getDefaultValue();
       }
     });
   }

package/src/object.js

@@ -1,7 +1,7 @@
 import TypeSchema from './TypeSchema';
 import { FieldError, LocalizedError } from './errors';
 import { pick, omit } from './utils';
-import Schema from './Schema';
+import Schema, { isSchema } from './Schema';
 
 const BASE_ASSERTIONS = ['type', 'transform', 'field'];
 
@@ -49,6 +49,9 @@ class ObjectSchema extends TypeSchema {
       }
     });
     for (let [key, schema] of Object.entries(this.getFields())) {
+      if (!isSchema(schema)) {
+        throw new Error(`Key "${key}" must be a schema`);
+      }
       this.assert('field', async (obj, options) => {
         if (obj) {
           const { path = [] } = options;

package/src/string.js

@@ -30,6 +30,19 @@ class StringSchema extends TypeSchema {
     });
   }
 
+  /**
+   * @returns {this}
+   */
+  required() {
+    return this.clone({ required: true }).assert('required', (val) => {
+      if (val == null) {
+        throw new LocalizedError('Value is required.');
+      } else if (val === '') {
+        throw new LocalizedError('String may not be empty.');
+      }
+    });
+  }
+
   /**
    * @param {number} length
    */

package/types/Schema.d.ts

@@ -14,7 +14,7 @@ export default class Schema {
      * Sets the schema default. [Link](https://github.com/bedrockio/yada#default)
      * @returns {this}
      */
-    default(value: any): this;
+    default(arg: any): this;
     /**
      * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
      * @param {CustomSignature} args

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAsVA,4CAEC;AA5UD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,gBAHW,eAAe,GACb,IAAI,CAmBhB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,gBAFa,IAAI,CAShB;IAED;;OAEG;IACH,+BAFa,IAAI,CAMhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED,iDAqCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAUC;IAED,kBAEC;IAED,4BAMC;IAID;;OAEG;IACH,kCAFa,IAAI,CAmChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BAvUY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAuVA,4CAEC;AA7UD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,gBAHW,eAAe,GACb,IAAI,CAmBhB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,gBAFa,IAAI,CAShB;IAED;;OAEG;IACH,+BAFa,IAAI,CAMhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED,iDAqCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAUC;IAED,kBAEC;IAED,4BAMC;IAID;;OAEG;IACH,kCAFa,IAAI,CAmChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BAxUY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAwMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AA1MD;;GAEG;AAEH;IAUE;;OAEG;IACH,cAkEC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;CAcF"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AA2MA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AA7MD;;GAEG;AAEH;IAUE;;OAEG;IACH,cAqEC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;CAcF"}

package/types/string.d.ts

@@ -4,6 +4,10 @@
 export default function _default(): StringSchema;
 declare class StringSchema extends TypeSchema {
     constructor();
+    /**
+     * @returns {this}
+     */
+    required(): this;
     /**
      * @param {number} length
      */

package/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAgYA;;GAEG;AACH,iDAEC;AAnXD;IACE,cAWC;IAED;;OAEG;IACH,eAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED,qBAIC;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,WAFW,MAAM,gBAahB;IAED,sBAMC;IAED,sBAMC;IAED,oBAMC;IAED,oBAMC;IAED,qBAMC;IAED,sBAMC;IAED;;;OAGG;IACH;QAF6B,OAAO,GAAzB,OAAO;qBAQjB;IAED,2BAMC;IAED,mBAMC;IAED,wBAMC;IAED,uBAMC;IAED,oBAMC;IAED,qBAOC;IAED,uBAMC;IAED;;OAEG;IACH,oBAFW,MAAM,gBAQhB;IAED;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA+BhB;IAED;;;;;;;;;;;OAWG;IACH;QAV6B,gBAAgB,GAAlC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,4BAA4B,GAA9C,OAAO;QACW,eAAe,GAAjC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,eAAe,GAAjC,OAAO;QACY,SAAS,GAA5B,MAAM,EAAE;qBAQlB;IAED;;;;;;;;OAQG;IACH;QAP6B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;qBAQjB;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAQ3B;IAED,oBAMC;IAED,oBAMC;IAED,sBAMC;IAED,sBAMC;CAcF"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AA6YA;;GAEG;AACH,iDAEC;AAhYD;IACE,cAWC;IAED;;OAEG;IACH,YAFa,IAAI,CAUhB;IAED;;OAEG;IACH,eAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED,qBAIC;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,WAFW,MAAM,gBAahB;IAED,sBAMC;IAED,sBAMC;IAED,oBAMC;IAED,oBAMC;IAED,qBAMC;IAED,sBAMC;IAED;;;OAGG;IACH;QAF6B,OAAO,GAAzB,OAAO;qBAQjB;IAED,2BAMC;IAED,mBAMC;IAED,wBAMC;IAED,uBAMC;IAED,oBAMC;IAED,qBAOC;IAED,uBAMC;IAED;;OAEG;IACH,oBAFW,MAAM,gBAQhB;IAED;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA+BhB;IAED;;;;;;;;;;;OAWG;IACH;QAV6B,gBAAgB,GAAlC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,4BAA4B,GAA9C,OAAO;QACW,eAAe,GAAjC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,eAAe,GAAjC,OAAO;QACY,SAAS,GAA5B,MAAM,EAAE;qBAQlB;IAED;;;;;;;;OAQG;IACH;QAP6B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;qBAQjB;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAQ3B;IAED,oBAMC;IAED,oBAMC;IAED,sBAMC;IAED,sBAMC;CAcF"}