@bedrockio/yada 1.1.2 → 1.1.3

package/README.md

@@ -25,6 +25,7 @@ Concepts
   - [custom](#custom)
   - [default](#default)
   - [strip](#strip)
+  - [nullable](#nullable)
   - [message](#message)
 - [Validation Options](#validation-options)
 - [Error Messages](#error-messages)
@@ -553,6 +554,29 @@ const schema = yd.object({
 Arguments are identical to those passed to [custom](#custom). The field will be
 stripped out if the function returns a truthy value.
 
+### Nullable
+
+The `nullable` field allows `null` to be passed for any value:
+
+```js
+const schema = yd.string().nullable();
+await schema.validate(null); // Allowed
+```
+
+This is the equivalent of:
+
+```js
+schema = yd.allow(schema, null);
+```
+
+However it has two advantages. First it will correctly describe its
+[OpenApi](#openapi) schema as `nullable`. It will also return the same type
+schema, allowing chaining:
+
+```js
+const schema = yd.string().nullable().trim();
+```
+
 ### Message
 
 The `message` method allows adding a custom message to schema or field. Note

package/dist/cjs/Schema.js

@@ -86,6 +86,16 @@ class Schema {
     return this.assertEnum(set, false);
   }
 
+  /**
+   * Allow null. [Link](https://github.com/bedrockio/yada#nullable)
+   * @returns {this}
+   */
+  nullable() {
+    return this.clone({
+      nullable: true
+    });
+  }
+
   /**
    * @returns {this}
    */
@@ -133,7 +143,9 @@ class Schema {
       original: value
     };
     for (let assertion of this.assertions) {
-      if (!assertion.required && value === undefined) {
+      if (value === undefined && !assertion.required) {
+        break;
+      } else if (value === null && options.nullable) {
         break;
       }
       try {
@@ -199,6 +211,7 @@ class Schema {
       ...tags,
       ...this.getAnyType(),
       ...this.getDefault(),
+      ...this.getNullable(),
       ...this.enumToOpenApi(),
       ...this.expandExtra(extra)
     };
@@ -226,8 +239,15 @@ class Schema {
       };
     }
   }
-  inspect() {
-    return JSON.stringify(this.toOpenApi(), null, 2);
+  getNullable() {
+    const {
+      nullable
+    } = this.meta;
+    if (nullable) {
+      return {
+        nullable: true
+      };
+    }
   }
   expandExtra(extra = {}) {
     const {
@@ -239,6 +259,9 @@ class Schema {
     }
     return rest;
   }
+  inspect() {
+    return JSON.stringify(this.toOpenApi(), null, 2);
+  }
 
   // Private
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Validation library inspired by Joi.",
   "scripts": {
     "test": "jest",

package/src/Schema.js

@@ -82,6 +82,14 @@ export default class Schema {
     return this.assertEnum(set, false);
   }
 
+  /**
+   * Allow null. [Link](https://github.com/bedrockio/yada#nullable)
+   * @returns {this}
+   */
+  nullable() {
+    return this.clone({ nullable: true });
+  }
+
   /**
    * @returns {this}
    */
@@ -128,9 +136,12 @@ export default class Schema {
     };
 
     for (let assertion of this.assertions) {
-      if (!assertion.required && value === undefined) {
+      if (value === undefined && !assertion.required) {
+        break;
+      } else if (value === null && options.nullable) {
         break;
       }
+
       try {
         const result = await this.runAssertion(assertion, value, options);
         if (result !== undefined) {
@@ -189,6 +200,7 @@ export default class Schema {
       ...tags,
       ...this.getAnyType(),
       ...this.getDefault(),
+      ...this.getNullable(),
       ...this.enumToOpenApi(),
       ...this.expandExtra(extra),
     };
@@ -214,8 +226,13 @@ export default class Schema {
     }
   }
 
-  inspect() {
-    return JSON.stringify(this.toOpenApi(), null, 2);
+  getNullable() {
+    const { nullable } = this.meta;
+    if (nullable) {
+      return {
+        nullable: true,
+      };
+    }
   }
 
   expandExtra(extra = {}) {
@@ -226,6 +243,10 @@ export default class Schema {
     return rest;
   }
 
+  inspect() {
+    return JSON.stringify(this.toOpenApi(), null, 2);
+  }
+
   // Private
 
   /**

package/types/Schema.d.ts

@@ -34,6 +34,11 @@ export default class Schema {
      * @returns {this}
      */
     reject(...set: any[]): this;
+    /**
+     * Allow null. [Link](https://github.com/bedrockio/yada#nullable)
+     * @returns {this}
+     */
+    nullable(): this;
     /**
      * @returns {this}
      */
@@ -69,8 +74,11 @@ export default class Schema {
     } | {
         default: any;
     };
-    inspect(): string;
+    getNullable(): {
+        nullable: boolean;
+    };
     expandExtra(extra?: {}): {};
+    inspect(): string;
     /**
      * @returns {this}
      */

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA2WA,4CAEC;AAhWD;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,sBAFa,IAAI,CAShB;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,iDA0CC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAWC;IAED;;MAOC;IAED;;;;MASC;IAED,kBAEC;IAED,4BAMC;IAID;;OAEG;IACH,kCAFa,IAAI,CAiDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAGC;IAED;;;;;;;;MAoCC;CACF"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAgYA,4CAEC;AArXD;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,sBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,YAFa,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,iDA6CC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAYC;IAED;;MAOC;IAED;;;;MASC;IAED;;MAOC;IAED,4BAMC;IAED,kBAEC;IAID;;OAEG;IACH,kCAFa,IAAI,CAiDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAGC;IAED;;;;;;;;MAoCC;CACF"}