lucid-extension-sdk 0.0.340 → 0.0.341

package/core/checks.d.ts

@@ -117,6 +117,13 @@ export declare function isArray(val: unknown): val is unknown[];
  * @return Whether variable is an array of the given type.
  */
 export declare function isTypedArray<T>(typeGuard: (a: unknown) => a is T): (val: unknown) => val is T[];
+/**
+ * Returns true if the specified value is a map.
+ *
+ * @param val Variable to test.
+ * @return Whether variable is a map.
+ */
+export declare function isMap(val: unknown): val is Map<unknown, unknown>;
 export type Tuple<T, N extends number> = N extends N ? (number extends N ? T[] : TupleOfHelper<T, N, []>) : never;
 type TupleOfHelper<T, N extends number, R extends unknown[]> = R['length'] extends N ? R : TupleOfHelper<T, N, [T, ...R]>;
 export declare function isExactLength<T, N extends number>(arr: readonly T[], exactLength: N): arr is Tuple<T, N>;

package/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isPair = exports.isAtLeastLength = exports.isExactLength = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObjectUnsafer = exports.isObjectUnsafe = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
+exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isPair = exports.isAtLeastLength = exports.isExactLength = exports.isMap = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObjectUnsafer = exports.isObjectUnsafe = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
 /**
  * Returns true if the specified value is not undefined.
  *
@@ -177,6 +177,16 @@ function isTypedArray(typeGuard) {
     };
 }
 exports.isTypedArray = isTypedArray;
+/**
+ * Returns true if the specified value is a map.
+ *
+ * @param val Variable to test.
+ * @return Whether variable is a map.
+ */
+function isMap(val) {
+    return val instanceof Map;
+}
+exports.isMap = isMap;
 function isExactLength(arr, exactLength) {
     return arr.length === exactLength;
 }

package/core/guards.d.ts

@@ -6,4 +6,5 @@ export type DestructureGuardedTypeObj<Obj extends {
     [key in keyof Obj]: GuardToType<Obj[key]>;
 }>;
 export type Validator<TO extends FROM, FROM = unknown> = (p1: FROM) => p1 is TO;
-export type ValidatorWithList<TO extends FROM, FROM = unknown> = (p1: FROM, p2: unknown[]) => 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;

package/core/pruners/pruners.d.ts

@@ -0,0 +1,21 @@
+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.
+ *
+ * @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.
+ */
+export declare function objectPruner(subPruners: {
+    [key: string]: Pruner;
+}): Pruner;
+/**
+ * Creates a pruner function that will remove array elements that are invalid.
+ * If a sub-pruner is provided, then the elements themselves will be pruned rather
+ * than removed from the list.
+ *
+ * @returns A pruner function that takes data and invalid fields. If data is not an
+ * array, it will return the data as is instead of pruning.
+ */
+export declare function arrayPruner(subPruner?: Pruner | undefined): Pruner;

package/core/pruners/pruners.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ *
+ * @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.
+ */
+function objectPruner(subPruners) {
+    return (data, invalidFields, level = 0) => {
+        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;
+    };
+}
+exports.objectPruner = objectPruner;
+/**
+ * Creates a pruner function that will remove array elements that are invalid.
+ * If a sub-pruner is provided, then the elements themselves will be pruned rather
+ * than removed from the list.
+ *
+ * @returns A pruner function that takes data and invalid fields. If data is not an
+ * array, it will return the data as is instead of pruning.
+ */
+function arrayPruner(subPruner) {
+    return (data, invalidElements, level = 0) => {
+        if (!(0, checks_1.isArray)(data)) {
+            return data;
+        }
+        if (subPruner) {
+            return data.map((item) => subPruner(item, invalidElements, level + 1));
+        }
+        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)); });
+        }
+    };
+}
+exports.arrayPruner = arrayPruner;

package/core/validators/validators.d.ts

@@ -29,11 +29,10 @@ export declare function rangeValidator(min: number, max: number): (x: unknown) =
  */
 export declare function arrayValidator<T>(subValidator: (p1: unknown) => p1 is T): (p1: unknown) => p1 is T[];
 /**
- * valid if at least one item in the array is valid.
- * @param subValidator
- * @returns
+ * This validator functions the same as {@link arrayValidator}, with the option of passing in a map
+ * which will track all of the elements that were found to be invalid.
  */
-export declare function arrayValidatorWithList<T>(subValidator: (p1: unknown, invalidItems?: unknown[]) => p1 is T): (p1: unknown, invalidItems?: unknown[]) => p1 is T[];
+export declare function arrayValidatorWithInvalidElementTracking<T>(subValidator: (p1: unknown, invalidElements?: Map<number, unknown[]>, level?: number) => p1 is T): (subject: unknown, invalidElements?: Map<number, unknown[]>, level?: number) => subject is T[];
 /**
  * Creates a validator for a fixed width array where each entry
  * in the array can have a separate validator
@@ -76,12 +75,12 @@ export declare function objectValidator<T extends {
     [key: string]: (p1: unknown) => p1 is unknown;
 }>(validatorStructure: T): (subject: unknown) => subject is DestructureGuardedTypeObj<T>;
 /**
- * This validator functions the same as {@link objectValidator}, with the option of passing in a list
- * which will return all of the fields that were found to be invalid.
+ * This validator functions the same as {@link objectValidator}, with the option of passing in a map
+ * which will track all of the fields that were found to be invalid.
  */
-export declare function objectValidatorWithList<T extends {
-    [key: string]: (p1: unknown, invalidFields?: unknown[]) => p1 is unknown;
-}>(validatorStructure: T): (subject: unknown, invalidFields?: unknown[]) => subject is DestructureGuardedTypeObj<T>;
+export declare function objectValidatorWithInvalidFieldTracking<T extends {
+    [key: string]: (p1: unknown, invalidFields?: Map<number, unknown[]>, level?: number) => p1 is unknown;
+}>(validatorStructure: T): (subject: unknown, invalidFields?: Map<number, unknown[]>, level?: number) => subject is DestructureGuardedTypeObj<T>;
 /**
  * Creates a validator which tests if the target is an object
  * and if the structure of the object matches the structure of the passed-in

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.nullable = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithList = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithList = 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.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;
 const checks_1 = require("../checks");
 /*********************************************************************************
  * Validator generators:  These functions construct new composite validators
@@ -65,19 +65,27 @@ function arrayValidator(subValidator) {
 }
 exports.arrayValidator = arrayValidator;
 /**
- * valid if at least one item in the array is valid.
- * @param subValidator
- * @returns
+ * This validator functions the same as {@link arrayValidator}, with the option of passing in a map
+ * which will track all of the elements that were found to be invalid.
  */
-function arrayValidatorWithList(subValidator) {
-    return (x, invalidItems) => {
-        if (!(0, checks_1.isArray)(x)) {
+function arrayValidatorWithInvalidElementTracking(subValidator) {
+    return (subject, invalidElements, level = 0) => {
+        if (!(0, checks_1.isArray)(subject)) {
             return false;
         }
-        return x.some((item) => subValidator(item, invalidItems));
+        let valid = true;
+        const invalidList = [];
+        subject.forEach((item) => {
+            if (!subValidator(item, invalidElements, level + 1)) {
+                invalidList.push(item);
+                valid = false;
+            }
+        });
+        invalidElements === null || invalidElements === void 0 ? void 0 : invalidElements.set(level, invalidList);
+        return valid;
     };
 }
-exports.arrayValidatorWithList = arrayValidatorWithList;
+exports.arrayValidatorWithInvalidElementTracking = arrayValidatorWithInvalidElementTracking;
 /**
  * Creates a validator for a fixed width array where each entry
  * in the array can have a separate validator
@@ -160,29 +168,31 @@ function objectValidator(validatorStructure) {
 }
 exports.objectValidator = objectValidator;
 /**
- * This validator functions the same as {@link objectValidator}, with the option of passing in a list
- * which will return all of the fields that were found to be invalid.
+ * This validator functions the same as {@link objectValidator}, with the option of passing in a map
+ * which will track all of the fields that were found to be invalid.
  */
-function objectValidatorWithList(validatorStructure) {
-    return (subject, invalidFields) => {
+function objectValidatorWithInvalidFieldTracking(validatorStructure) {
+    return (subject, invalidFields, level = 0) => {
         if ((0, checks_1.isArray)(subject) || !(0, checks_1.isObjectUnsafe)(subject)) {
             return false;
         }
         else {
             let valid = true;
+            const invalidList = [];
             Object.entries(validatorStructure).forEach(([key, validator]) => {
-                if (!validator(subject[key], invalidFields)) {
-                    if (invalidFields && Array.isArray(invalidFields)) {
-                        invalidFields.push(key);
-                    }
+                if (!validator(subject[key], invalidFields, level + 1)) {
+                    invalidList.push([key, subject[key]]);
                     valid = false;
                 }
             });
+            if ((0, checks_1.isMap)(invalidFields)) {
+                invalidFields.set(level, invalidList);
+            }
             return valid;
         }
     };
 }
-exports.objectValidatorWithList = objectValidatorWithList;
+exports.objectValidatorWithInvalidFieldTracking = objectValidatorWithInvalidFieldTracking;
 /**
  * Creates a validator which tests if the target is an object
  * and if the structure of the object matches the structure of the passed-in

package/package.json

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