@bedrockio/yada 1.5.2 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.6.0
+
+- Make `expandDotSyntax` option default and rename inverse option to
+  `preserveKeys`.
+
 ## 1.5.2
 
 - Removed boolean requried fields for further schema adherence.

package/dist/cjs/object.js

@@ -33,12 +33,12 @@ class ObjectSchema extends _TypeSchema.default {
         fields,
         stripUnknown,
         stripEmpty,
-        expandDotSyntax
+        preserveKeys
       } = options;
       if (obj) {
         const result = {};
-        if (expandDotSyntax) {
-          obj = expandDotProperties(obj);
+        if (!preserveKeys) {
+          obj = expandKeys(obj);
         }
         for (let key of Object.keys(obj)) {
           const value = obj[key];
@@ -259,6 +259,20 @@ class ObjectSchema extends _TypeSchema.default {
     return schema;
   }
 
+  /**
+   * `stripEmpty` - Removes properties that are empty strings.
+   * `stripUnknown` - Removes properties not in the schema.
+   * `preserveKeys` - Prevents expansion of "flat" keys using dot syntax.
+   *
+   * @param {Object} [options]
+   * @param {boolean} [options.stripEmpty]
+   * @param {boolean} [options.stripUnknown]
+   * @param {boolean} [options.preserveKeys]
+   */
+  options(options) {
+    return super.options(options);
+  }
+
   // Private
 
   toJSON(extra) {
@@ -283,23 +297,14 @@ class ObjectSchema extends _TypeSchema.default {
     };
   }
 }
-function expandDotProperties(obj) {
-  const result = {};
-  for (let [key, val] of Object.entries(obj || {})) {
-    const split = key.split('.');
-    if (split.length > 1) {
-      let node = result;
-      for (let i = 0; i < split.length; i++) {
-        const token = split[i];
-        if (i === split.length - 1) {
-          node[token] = val;
-        } else {
-          node[token] = {};
-        }
-        node = node[token];
-      }
-    } else {
-      result[key] = val;
+function expandKeys(obj) {
+  const result = {
+    ...obj
+  };
+  for (let [key, value] of Object.entries(result)) {
+    if (key.includes('.')) {
+      delete result[key];
+      (0, _lodash.set)(result, key, value);
     }
   }
   return result;

package/package.json

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

package/src/object.js

@@ -23,11 +23,11 @@ class ObjectSchema extends TypeSchema {
       }
     });
     this.transform((obj, options) => {
-      const { fields, stripUnknown, stripEmpty, expandDotSyntax } = options;
+      const { fields, stripUnknown, stripEmpty, preserveKeys } = options;
       if (obj) {
         const result = {};
-        if (expandDotSyntax) {
-          obj = expandDotProperties(obj);
+        if (!preserveKeys) {
+          obj = expandKeys(obj);
         }
         for (let key of Object.keys(obj)) {
           const value = obj[key];
@@ -250,6 +250,20 @@ class ObjectSchema extends TypeSchema {
     return schema;
   }
 
+  /**
+   * `stripEmpty` - Removes properties that are empty strings.
+   * `stripUnknown` - Removes properties not in the schema.
+   * `preserveKeys` - Prevents expansion of "flat" keys using dot syntax.
+   *
+   * @param {Object} [options]
+   * @param {boolean} [options.stripEmpty]
+   * @param {boolean} [options.stripUnknown]
+   * @param {boolean} [options.preserveKeys]
+   */
+  options(options) {
+    return super.options(options);
+  }
+
   // Private
 
   toJSON(extra) {
@@ -274,23 +288,12 @@ class ObjectSchema extends TypeSchema {
   }
 }
 
-function expandDotProperties(obj) {
-  const result = {};
-  for (let [key, val] of Object.entries(obj || {})) {
-    const split = key.split('.');
-    if (split.length > 1) {
-      let node = result;
-      for (let i = 0; i < split.length; i++) {
-        const token = split[i];
-        if (i === split.length - 1) {
-          node[token] = val;
-        } else {
-          node[token] = {};
-        }
-        node = node[token];
-      }
-    } else {
-      result[key] = val;
+function expandKeys(obj) {
+  const result = { ...obj };
+  for (let [key, value] of Object.entries(result)) {
+    if (key.includes('.')) {
+      delete result[key];
+      set(result, key, value);
     }
   }
   return result;

package/types/object.d.ts

@@ -71,6 +71,21 @@ declare class ObjectSchema extends TypeSchema {
      * @param {SchemaMap|Schema} arg Object or schema to append.
      */
     append(arg: SchemaMap | Schema): ObjectSchema;
+    /**
+     * `stripEmpty` - Removes properties that are empty strings.
+     * `stripUnknown` - Removes properties not in the schema.
+     * `preserveKeys` - Prevents expansion of "flat" keys using dot syntax.
+     *
+     * @param {Object} [options]
+     * @param {boolean} [options.stripEmpty]
+     * @param {boolean} [options.stripUnknown]
+     * @param {boolean} [options.preserveKeys]
+     */
+    options(options?: {
+        stripEmpty?: boolean;
+        stripUnknown?: boolean;
+        preserveKeys?: boolean;
+    }): this;
 }
 import Schema from './Schema';
 import TypeSchema from './TypeSchema';

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AA4TA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBA9TY;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;CAwBF;mBA9QgC,UAAU;uBAFpB,cAAc"}
+{"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;mBA5RgC,UAAU;uBAFpB,cAAc"}