lucid-extension-sdk 0.0.356 → 0.0.357

package/core/guards.d.ts

@@ -7,4 +7,4 @@ export type DestructureGuardedTypeObj<Obj extends {
 }>;
 export type Validator<TO extends FROM, FROM = unknown> = (p1: FROM) => p1 is TO;
 export type ValidatorWithTracking<TO extends FROM, FROM = unknown> = (p1: FROM, p2?: Map<number, unknown[]>, p3?: number) => p1 is TO;
-export type Pruner = (p1: unknown, p2?: Map<number, unknown[]>, p3?: number) => unknown;
+export type Pruner = (p1: unknown, p2?: Map<number, unknown[]>, p3?: number, key?: string | undefined) => unknown;

package/core/pruners/pruners.d.ts

@@ -1,8 +1,8 @@
 import { Pruner } from '../guards';
 /**
  * Creates a pruner function that will remove object fields that are invalid.
- * If a sub-pruner is provided, then the object values themselves will be pruned rather
- * than set to undefined.
+ * If a sub-pruner is provided for a field, then the object field values will be pruned.
+ * If no pruner is provided for field, nothing happens to that field.
  *
  * @returns A pruner function that takes data and invalid fields. If data is not an
  * object, it will return the data as is instead of pruning.
@@ -19,3 +19,4 @@ export declare function objectPruner(subPruners: {
  * array, it will return the data as is instead of pruning.
  */
 export declare function arrayPruner(subPruner?: Pruner | undefined): Pruner;
+export declare function pruneObjectField(): Pruner;

package/core/pruners/pruners.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayPruner = exports.objectPruner = void 0;
+exports.pruneObjectField = exports.arrayPruner = exports.objectPruner = void 0;
 const checks_1 = require("../checks");
 /**
  * Creates a pruner function that will remove object fields that are invalid.
- * If a sub-pruner is provided, then the object values themselves will be pruned rather
- * than set to undefined.
+ * If a sub-pruner is provided for a field, then the object field values will be pruned.
+ * If no pruner is provided for field, nothing happens to that field.
  *
  * @returns A pruner function that takes data and invalid fields. If data is not an
  * object, it will return the data as is instead of pruning.
@@ -15,20 +15,11 @@ function objectPruner(subPruners) {
         if ((0, checks_1.isArray)(data) || !(0, checks_1.isObjectUnsafe)(data)) {
             return data;
         }
-        if (Object.keys(subPruners).length > 0) {
-            Object.entries(subPruners).forEach(([key, pruner]) => {
-                data[key] = pruner(data[key], invalidFields, level + 1);
-            });
-        }
-        else {
-            Object.keys(data).forEach((key) => {
-                var _a;
-                if ((_a = invalidFields === null || invalidFields === void 0 ? void 0 : invalidFields.get(level)) === null || _a === void 0 ? void 0 : _a.includes(key)) {
-                    data[key] = undefined;
-                }
-            });
-        }
-        return data;
+        const dataToBePruned = Object.assign({}, data);
+        Object.entries(subPruners).forEach(([key, pruner]) => {
+            dataToBePruned[key] = pruner(dataToBePruned[key], invalidFields, level + 1, key);
+        });
+        return dataToBePruned;
     };
 }
 exports.objectPruner = objectPruner;
@@ -46,7 +37,19 @@ function arrayPruner(subPruner) {
             return data;
         }
         if (subPruner) {
-            return data.map((item) => subPruner(item, invalidElements, level + 1));
+            return data.reduce((acc, item) => {
+                var _a;
+                const prunedItem = subPruner(item, invalidElements, level + 1);
+                /* Here we are relying on the fact that the pruner will return the same object reference, if it is not
+                   pruned, but will return a new object reference, if it is pruned. This is a bit of a hack but
+                    TODO EI 50 we're overhauling how this works in future
+                */
+                if (prunedItem === item && ((_a = invalidElements === null || invalidElements === void 0 ? void 0 : invalidElements.get(level)) === null || _a === void 0 ? void 0 : _a.includes(item))) {
+                    return acc;
+                }
+                acc.push(prunedItem);
+                return acc;
+            }, []);
         }
         else {
             return data.filter((item) => { var _a; return !((_a = invalidElements === null || invalidElements === void 0 ? void 0 : invalidElements.get(level)) === null || _a === void 0 ? void 0 : _a.includes(item)); });
@@ -54,3 +57,24 @@ function arrayPruner(subPruner) {
     };
 }
 exports.arrayPruner = arrayPruner;
+/*
+ * Creates a pruner function to be passed in with the object pruner that will remove the field if it is invalid.
+ */
+function pruneObjectField() {
+    return (data, invalidFields, level = 0, key = undefined) => {
+        var _a;
+        // When this is called as a part of objectPruner, level will be atleast 1
+        if ((0, checks_1.isArray)(data) || (0, checks_1.isObjectUnsafe)(data) || level <= 0) {
+            return data;
+        }
+        const invalidFieldAtCurrentLevel = (_a = invalidFields === null || invalidFields === void 0 ? void 0 : invalidFields.get(level - 1)) === null || _a === void 0 ? void 0 : _a.filter(checks_1.isArray);
+        if (!(0, checks_1.isDef)(invalidFieldAtCurrentLevel)) {
+            return data;
+        }
+        if (invalidFieldAtCurrentLevel.some((value) => value[0] === key && value[1] === data)) {
+            return undefined;
+        }
+        return data;
+    };
+}
+exports.pruneObjectField = pruneObjectField;

package/core/validators/validators.d.ts

@@ -1,5 +1,5 @@
 import { isNumber, isString } from '../checks';
-import { DestructureGuardedTypeObj, GuardToType, Validator } from '../guards';
+import { DestructureGuardedTypeObj, GuardToType, Validator, ValidatorWithTracking } from '../guards';
 /*********************************************************************************
  * Validator generators:  These functions construct new composite validators
  *from elemental validators.
@@ -104,6 +104,11 @@ export declare function strictObjectValidator<T extends {
 export declare function recordValidator<K extends string, V>(keyList: K[], valueValidator: Validator<V>): (x: unknown) => x is Record<K, V>;
 export declare function typedRecordValidator<K extends string | number | symbol, V>(keyValidator: Validator<K>, valueValidator: Validator<V>): (x: unknown) => x is Record<K, V>;
 export declare function objectOfValidator<T>(subValidator: Validator<T>): (x: unknown) => x is Record<any, T>;
+/**
+ * This validator functions the same as {@link objectOfValidator}, with the option of passing in a map
+ * which will track all of the fields that were found to be invalid.
+ */
+export declare function objectOfValidatorWithInvalidFieldTracking<T>(subValidator: ValidatorWithTracking<T>): (subject: unknown, invalidFields?: Map<number, unknown[]>, level?: number) => subject is Record<any, T>;
 /**
  * Create a validator which allows the target to be either null or satisfy the
  * sub-validator.

package/core/validators/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isFalse = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullableValidatorWithInvalidElementTracking = exports.nullable = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithInvalidFieldTracking = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithInvalidElementTracking = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
+exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isFalse = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullableValidatorWithInvalidElementTracking = exports.nullable = exports.objectOfValidatorWithInvalidFieldTracking = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithInvalidFieldTracking = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithInvalidElementTracking = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
 const checks_1 = require("../checks");
 /*********************************************************************************
  * Validator generators:  These functions construct new composite validators
@@ -173,6 +173,7 @@ exports.objectValidator = objectValidator;
  */
 function objectValidatorWithInvalidFieldTracking(validatorStructure) {
     return (subject, invalidFields, level = 0) => {
+        var _a;
         if ((0, checks_1.isArray)(subject) || !(0, checks_1.isObjectUnsafe)(subject)) {
             return false;
         }
@@ -186,7 +187,8 @@ function objectValidatorWithInvalidFieldTracking(validatorStructure) {
                 }
             });
             if ((0, checks_1.isMap)(invalidFields)) {
-                invalidFields.set(level, invalidList);
+                const prevInvalidList = (_a = invalidFields.get(level)) !== null && _a !== void 0 ? _a : [];
+                invalidFields.set(level, prevInvalidList.concat(invalidList));
             }
             return valid;
         }
@@ -257,6 +259,32 @@ function objectOfValidator(subValidator) {
     };
 }
 exports.objectOfValidator = objectOfValidator;
+/**
+ * This validator functions the same as {@link objectOfValidator}, with the option of passing in a map
+ * which will track all of the fields that were found to be invalid.
+ */
+function objectOfValidatorWithInvalidFieldTracking(subValidator) {
+    return (subject, invalidFields, level = 0) => {
+        var _a;
+        if ((0, checks_1.isArray)(subject) || !(0, checks_1.isObjectUnsafe)(subject)) {
+            return false;
+        }
+        let valid = true;
+        const invalidList = [];
+        Object.entries(subject).forEach(([key, val]) => {
+            if (!subValidator(val, invalidFields, level + 1)) {
+                invalidList.push([key, val]);
+                valid = false;
+            }
+        });
+        if ((0, checks_1.isMap)(invalidFields)) {
+            const prevInvalidList = (_a = invalidFields.get(level)) !== null && _a !== void 0 ? _a : [];
+            invalidFields.set(level, prevInvalidList.concat(invalidList));
+        }
+        return valid;
+    };
+}
+exports.objectOfValidatorWithInvalidFieldTracking = objectOfValidatorWithInvalidFieldTracking;
 /**
  * Create a validator which allows the target to be either null or satisfy the
  * sub-validator.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.356",
+    "version": "0.0.357",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",