@bedrockio/yada 1.6.1 → 1.7.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.7.0
+
+- Partial revert of 1.6.0. Dot syntax expanding no longer default but enabled.
+- Expanding flat syntax is now `expandFlatKeys`.
+- Flat syntax can also now be allowed without being expanded with
+  `allowFlatKeys`.
+- Checks on flat key syntax (array, object presence, etc).
+
 ## 1.6.1
 
 - Fixed empty string not allowed when enum provided.

package/README.md

@@ -230,6 +230,10 @@ const schema = yd.string().options({
 });
 ```
 
+### String Schema Options
+
+- `allowEmpty` - Allows empty strings.
+
 ### Number
 
 Numbers have a handful of useful valiadtions:
@@ -431,6 +435,13 @@ const newSchema = yd.object({
 });
 ```
 
+### Object Schema Options
+
+- `stripEmpty` - Removes properties that are empty strings.
+- `stripUnknown` - Removes properties not in the schema.
+- `allowFlatKeys` - Allows "flat" keys like `profile.name`.
+- `expendFlatKeys` - Expands "flat" keys into nested objects.
+
 ## Date
 
 Dates are similar to the basic types with the exception that in addition to date
@@ -777,12 +788,11 @@ await schema
 
 #### Options:
 
-- `stripUnknown` - Strips unknown fields on object schemas which otherwise would
-  throw an error.
 - `cast` - Casts input to its associated type. For strings and numbers this
   performs a simple type coercion. For booleans `"true"` or `"1"` will be
   considered `true` and `"false"` or `"0"` will be considered `false`. This
   option is useful to convert query strings.
+- [Object Schema Options](#object-schema-options)
 
 ## Error Messages
 

package/dist/cjs/object.js

@@ -12,6 +12,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 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; }
 const APPEND_ASSERTION_TYPES = ['required', 'type', 'custom'];
+const INTEGER_REG = /^\d+$/;
 
 /**
  * @typedef {{ [key: string]: Schema } | {}} SchemaMap
@@ -30,19 +31,15 @@ class ObjectSchema extends _TypeSchema.default {
     });
     this.transform((obj, options) => {
       const {
-        fields,
         stripUnknown,
-        stripEmpty,
-        preserveKeys
+        stripEmpty
       } = options;
       if (obj) {
         const result = {};
-        if (!preserveKeys) {
-          obj = expandKeys(obj);
-        }
+        obj = expandFlatSyntax(obj, options);
         for (let key of Object.keys(obj)) {
           const value = obj[key];
-          const isUnknown = !!fields && !(key in fields);
+          const isUnknown = !isKnownKey(key, this, options);
           if (value === '' && stripEmpty || isUnknown && stripUnknown) {
             continue;
           } else if (isUnknown) {
@@ -262,12 +259,14 @@ class ObjectSchema extends _TypeSchema.default {
   /**
    * `stripEmpty` - Removes properties that are empty strings.
    * `stripUnknown` - Removes properties not in the schema.
-   * `preserveKeys` - Prevents expansion of "flat" keys using dot syntax.
+   * `allowFlatKeys` - Allows "flat" keys like `profile.name`.
+   * `expendFlatKeys` - Expands "flat" keys into nested objects.
    *
    * @param {Object} [options]
    * @param {boolean} [options.stripEmpty]
    * @param {boolean} [options.stripUnknown]
-   * @param {boolean} [options.preserveKeys]
+   * @param {boolean} [options.allowFlatKeys]
+   * @param {boolean} [options.expandFlatKeys]
    */
   options(options) {
     return super.options(options);
@@ -297,7 +296,10 @@ class ObjectSchema extends _TypeSchema.default {
     };
   }
 }
-function expandKeys(obj) {
+function expandFlatSyntax(obj, options) {
+  if (!options.expandFlatKeys) {
+    return obj;
+  }
   const result = {
     ...obj
   };
@@ -309,6 +311,66 @@ function expandKeys(obj) {
   }
   return result;
 }
+function isKnownKey(key, schema, options) {
+  const {
+    fields
+  } = schema.meta;
+  const {
+    allowFlatKeys
+  } = options;
+  if (!fields) {
+    // No fields defined -> all keys are "known".
+    return true;
+  } else if (key in fields) {
+    // Exact match -> key is known.
+    return true;
+  } else if (allowFlatKeys && key.includes('.')) {
+    // Flat syntax "foo.bar".
+    const [base, ...rest] = key.split('.');
+    let subschema = fields[base];
+    if (!subschema) {
+      return false;
+    }
+    const {
+      type,
+      schemas
+    } = subschema.meta;
+    let subkey;
+    if (type === 'array') {
+      // If the subschema is an array then take the first of
+      // its defined schemas as we can safely assume that an
+      // array of objects will be defined as a single element
+      // or multiple schemas will only set the base property.
+      // Test that the element key is valid and take any
+      // further properties as the subkey. Examples:
+      // - profiles.0.name (array of objects)
+      // - profiles.0 (array of stringsmk)
+      const [index, ...other] = rest;
+      if (!INTEGER_REG.test(index)) {
+        return false;
+      }
+      subschema = schemas[0];
+      subkey = other.join('.');
+    } else if (type === 'object') {
+      // If the subschema is an object then simply take any
+      // further properties as the subkey. Example:
+      // - profile.name
+      subkey = rest.join('.');
+    } else {
+      // If the subschema is anything else then disallow it
+      // further properties as the subkey. Example:
+      // - profile.name
+      return false;
+    }
+    if (subschema.meta.type === 'object') {
+      return isKnownKey(subkey, subschema, options);
+    } else {
+      return !subkey;
+    }
+  } else {
+    return false;
+  }
+}
 function mergeFields(aFields, bFields) {
   if (!aFields || !bFields) {
     return aFields || bFields;

package/dist/cjs/utils.js

@@ -8,7 +8,7 @@ function canAllowEmptyString(options) {
   const {
     type,
     required,
-    allowEmpty
+    allowEmpty = true
   } = options;
-  return type === 'string' && !required && allowEmpty !== false;
+  return type === 'string' && !required && allowEmpty;
 }

package/package.json

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

package/src/object.js

@@ -6,6 +6,8 @@ import { FieldError, LocalizedError } from './errors';
 
 const APPEND_ASSERTION_TYPES = ['required', 'type', 'custom'];
 
+const INTEGER_REG = /^\d+$/;
+
 /**
  * @typedef {{ [key: string]: Schema } | {}} SchemaMap
  */
@@ -23,15 +25,15 @@ class ObjectSchema extends TypeSchema {
       }
     });
     this.transform((obj, options) => {
-      const { fields, stripUnknown, stripEmpty, preserveKeys } = options;
+      const { stripUnknown, stripEmpty } = options;
       if (obj) {
         const result = {};
-        if (!preserveKeys) {
-          obj = expandKeys(obj);
-        }
+
+        obj = expandFlatSyntax(obj, options);
+
         for (let key of Object.keys(obj)) {
           const value = obj[key];
-          const isUnknown = !!fields && !(key in fields);
+          const isUnknown = !isKnownKey(key, this, options);
 
           if ((value === '' && stripEmpty) || (isUnknown && stripUnknown)) {
             continue;
@@ -253,12 +255,14 @@ class ObjectSchema extends TypeSchema {
   /**
    * `stripEmpty` - Removes properties that are empty strings.
    * `stripUnknown` - Removes properties not in the schema.
-   * `preserveKeys` - Prevents expansion of "flat" keys using dot syntax.
+   * `allowFlatKeys` - Allows "flat" keys like `profile.name`.
+   * `expendFlatKeys` - Expands "flat" keys into nested objects.
    *
    * @param {Object} [options]
    * @param {boolean} [options.stripEmpty]
    * @param {boolean} [options.stripUnknown]
-   * @param {boolean} [options.preserveKeys]
+   * @param {boolean} [options.allowFlatKeys]
+   * @param {boolean} [options.expandFlatKeys]
    */
   options(options) {
     return super.options(options);
@@ -288,7 +292,11 @@ class ObjectSchema extends TypeSchema {
   }
 }
 
-function expandKeys(obj) {
+function expandFlatSyntax(obj, options) {
+  if (!options.expandFlatKeys) {
+    return obj;
+  }
+
   const result = { ...obj };
   for (let [key, value] of Object.entries(result)) {
     if (key.includes('.')) {
@@ -299,6 +307,65 @@ function expandKeys(obj) {
   return result;
 }
 
+function isKnownKey(key, schema, options) {
+  const { fields } = schema.meta;
+  const { allowFlatKeys } = options;
+  if (!fields) {
+    // No fields defined -> all keys are "known".
+    return true;
+  } else if (key in fields) {
+    // Exact match -> key is known.
+    return true;
+  } else if (allowFlatKeys && key.includes('.')) {
+    // Flat syntax "foo.bar".
+    const [base, ...rest] = key.split('.');
+    let subschema = fields[base];
+
+    if (!subschema) {
+      return false;
+    }
+
+    const { type, schemas } = subschema.meta;
+
+    let subkey;
+
+    if (type === 'array') {
+      // If the subschema is an array then take the first of
+      // its defined schemas as we can safely assume that an
+      // array of objects will be defined as a single element
+      // or multiple schemas will only set the base property.
+      // Test that the element key is valid and take any
+      // further properties as the subkey. Examples:
+      // - profiles.0.name (array of objects)
+      // - profiles.0 (array of stringsmk)
+      const [index, ...other] = rest;
+      if (!INTEGER_REG.test(index)) {
+        return false;
+      }
+      subschema = schemas[0];
+      subkey = other.join('.');
+    } else if (type === 'object') {
+      // If the subschema is an object then simply take any
+      // further properties as the subkey. Example:
+      // - profile.name
+      subkey = rest.join('.');
+    } else {
+      // If the subschema is anything else then disallow it
+      // further properties as the subkey. Example:
+      // - profile.name
+      return false;
+    }
+
+    if (subschema.meta.type === 'object') {
+      return isKnownKey(subkey, subschema, options);
+    } else {
+      return !subkey;
+    }
+  } else {
+    return false;
+  }
+}
+
 function mergeFields(aFields, bFields) {
   if (!aFields || !bFields) {
     return aFields || bFields;

package/src/utils.js

@@ -1,4 +1,4 @@
 export function canAllowEmptyString(options) {
-  const { type, required, allowEmpty } = options;
-  return type === 'string' && !required && allowEmpty !== false;
+  const { type, required, allowEmpty = true } = options;
+  return type === 'string' && !required && allowEmpty;
 }

package/types/object.d.ts

@@ -74,17 +74,20 @@ declare class ObjectSchema extends TypeSchema {
     /**
      * `stripEmpty` - Removes properties that are empty strings.
      * `stripUnknown` - Removes properties not in the schema.
-     * `preserveKeys` - Prevents expansion of "flat" keys using dot syntax.
+     * `allowFlatKeys` - Allows "flat" keys like `profile.name`.
+     * `expendFlatKeys` - Expands "flat" keys into nested objects.
      *
      * @param {Object} [options]
      * @param {boolean} [options.stripEmpty]
      * @param {boolean} [options.stripUnknown]
-     * @param {boolean} [options.preserveKeys]
+     * @param {boolean} [options.allowFlatKeys]
+     * @param {boolean} [options.expandFlatKeys]
      */
     options(options?: {
         stripEmpty?: boolean;
         stripUnknown?: boolean;
-        preserveKeys?: boolean;
+        allowFlatKeys?: boolean;
+        expandFlatKeys?: boolean;
     }): this;
 }
 import Schema from './Schema';

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AA+TA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBAjUY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IACE,uBAGC;IAED,cA8EC;IAED;;;;;;OAMG;IACH,WAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAsB9B;IAED;;;;;;OAMG;IACH,cAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAY9B;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;;;;OAOG;IACH,mBAHc,MAAM,EAAA,gBAmBnB;IAED;;;;;;OAMG;IACH,cAEC;IAED;;;;;;;;;OASG;IACH,YAFW,SAAS,GAAC,MAAM,gBA+B1B;IAED;;;;;;;;;OASG;IACH,kBAJG;QAA0B,UAAU,GAA5B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;KAAwB,QAIzC;CAwBF;mBA9RgC,UAAU;uBACpB,cAAc"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAkYA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBAlYY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IACE,uBAGC;IAED,cA8EC;IAED;;;;;;OAMG;IACH,WAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAsB9B;IAED;;;;;;OAMG;IACH,cAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAY9B;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;;;;OAOG;IACH,mBAHc,MAAM,EAAA,gBAmBnB;IAED;;;;;;OAMG;IACH,cAEC;IAED;;;;;;;;;OASG;IACH,YAFW,SAAS,GAAC,MAAM,gBA+B1B;IAED;;;;;;;;;;;OAWG;IACH,kBALG;QAA0B,UAAU,GAA5B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,aAAa,GAA/B,OAAO;QACW,cAAc,GAAhC,OAAO;KAA0B,QAI3C;CAwBF;mBAlSgC,UAAU;uBACpB,cAAc"}

package/types/utils.d.ts

@@ -1,2 +1,2 @@
-export function canAllowEmptyString(options: any): boolean;
+export function canAllowEmptyString(options: any): any;
 //# sourceMappingURL=utils.d.ts.map

package/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAAA,2DAGC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAAA,uDAGC"}