@fgv/ts-json 1.9.5 → 2.0.1-alpha.0

package/lib/packlets/editor/jsonReferenceMap.js

@@ -0,0 +1,324 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrefixedJsonMap = exports.SimpleJsonMap = exports.SimpleJsonMapBase = exports.PrefixKeyPolicy = exports.ReferenceMapKeyPolicy = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const json_1 = require("../json");
+const jsonEditor_1 = require("./jsonEditor");
+/**
+ * Policy object responsible for validating or correcting
+ * keys in a {@link IJsonReferenceMap | reference map}.
+ * @public
+ */
+class ReferenceMapKeyPolicy {
+    /**
+     * Constructs a new {@link ReferenceMapKeyPolicy | ReferenceMapKeyPolicy}.
+     * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options}
+     * used to construct the {@link ReferenceMapKeyPolicy}.
+     * @param isValid - An optional predicate to test a supplied key for validity.
+     */
+    constructor(options, isValid) {
+        this._defaultOptions = options;
+        this._isValid = isValid !== null && isValid !== void 0 ? isValid : ReferenceMapKeyPolicy.defaultKeyPredicate;
+    }
+    /**
+     * The static default key name validation predicate rejects keys that contain
+     * mustache templates or which start with the default conditional prefix
+     * `'?'`.
+     * @param key - The key to test.
+     * @returns `true` if the key is valid, `false` otherwise.
+     */
+    static defaultKeyPredicate(key) {
+        return key.length > 0 && !key.includes('{{') && !key.startsWith('?');
+    }
+    /**
+     * Determines if a supplied key and item are valid according to the current policy.
+     * @param key - The key to be tested.
+     * @param item - The item to be tested.
+     * @returns `true` if the key and value are valid, `false` otherwise.
+     */
+    isValid(key, item) {
+        return this._isValid(key, item);
+    }
+    /**
+     * Determines if a supplied key and item are valid according to the current policy.
+     * @param key - The key to be tested.
+     * @param item - The item to be tested.
+     * @returns `Success` with the key if valid, `Failure` with an error message if invalid.
+     */
+    validate(key, item, __options) {
+        return this.isValid(key, item) ? (0, ts_utils_1.succeed)(key) : (0, ts_utils_1.fail)(`${key}: invalid key`);
+    }
+    /**
+     * Validates an array of entries using the validation rules for this policy.
+     * @param items - The array of entries to be validated.
+     * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control
+     * validation.
+     * @returns `Success` with an array of validated entries, or `Failure` with an error message
+     * if validation fails.
+     */
+    validateItems(items, options) {
+        return (0, ts_utils_1.mapResults)(items.map((item) => {
+            return this.validate(...item, options).onSuccess((valid) => {
+                return (0, ts_utils_1.succeed)([valid, item[1]]);
+            });
+        }));
+    }
+    /**
+     * Validates a `Map\<string, T\>` using the validation rules for this policy.
+     * @param items - The `Map\<string, T\>` to be validated.
+     * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control
+     * validation.
+     * @returns `Success` with a new `Map\<string, T\>`, or `Failure` with an error message
+     * if validation fails.
+     */
+    validateMap(map, options) {
+        return this.validateItems(Array.from(map.entries()), options).onSuccess((valid) => {
+            return (0, ts_utils_1.captureResult)(() => new Map(valid));
+        });
+    }
+}
+exports.ReferenceMapKeyPolicy = ReferenceMapKeyPolicy;
+/**
+ * A {@link PrefixKeyPolicy | PrefixKeyPolicy} enforces that all keys start with a supplied
+ * prefix, optionally adding the prefix as necessary.
+ * @public
+ */
+class PrefixKeyPolicy extends ReferenceMapKeyPolicy {
+    /**
+     * Constructs a new {@link PrefixKeyPolicy | PrefixKeyPolicy}.
+     * @param prefix - The string prefix to be enforced or applied.
+     * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to
+     * configure the policy.
+     */
+    constructor(prefix, options) {
+        super(options);
+        this.prefix = prefix;
+    }
+    /**
+     * Determines if a key is valid according to policy.
+     * @param key - The key to be tested.
+     * @param __item - The item to be tested.
+     * @returns `true` if the key starts with the expected prefix, `false` otherwise.
+     */
+    isValid(key, __item) {
+        return (key.startsWith(this.prefix) && key !== this.prefix && ReferenceMapKeyPolicy.defaultKeyPredicate(key));
+    }
+    /**
+     * Determines if a key is valid according to policy, optionally coercing to a valid value by
+     * adding the required prefix.
+     * @param key - The key to be tested.
+     * @param item - The item which corresponds to the key.
+     * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to guide
+     * validation.
+     * @returns `Success` with a valid key name if the supplied key is valid or if `makeValid` is set
+     * in the policy options. Returns `Failure` with an error message if an error occurs.
+     */
+    validate(key, item, options) {
+        var _a;
+        // istanbul ignore next
+        const makeValid = ((_a = (options !== null && options !== void 0 ? options : this._defaultOptions)) === null || _a === void 0 ? void 0 : _a.makeValid) === true;
+        if (this.isValid(key, item)) {
+            return (0, ts_utils_1.succeed)(key);
+        }
+        else if (makeValid && ReferenceMapKeyPolicy.defaultKeyPredicate(key)) {
+            return (0, ts_utils_1.succeed)(`${this.prefix}${key}`);
+        }
+        return (0, ts_utils_1.fail)(`${key}: invalid key`);
+    }
+}
+exports.PrefixKeyPolicy = PrefixKeyPolicy;
+/**
+ * Abstract base class with common functionality for simple
+ * {@link IJsonReferenceMap | reference map} implementations.
+ * {@link JsonValue | json values}.
+ * @public
+ */
+class SimpleJsonMapBase {
+    /**
+     * Constructs a new {@link SimpleJsonMap | SimpleJsonMap}.
+     * @param values - Initial values for the map.
+     * @param context - An optional {@link IJsonContext | IJsonContext} used for any conversions
+     * involving items in this map.
+     * @param keyPolicy - The {@link ReferenceMapKeyPolicy | key policy} to use for this map.
+     * @internal
+     */
+    constructor(values, context, keyPolicy) {
+        values = SimpleJsonMapBase._toMap(values).orThrow();
+        this._keyPolicy = keyPolicy !== null && keyPolicy !== void 0 ? keyPolicy : new ReferenceMapKeyPolicy();
+        this._values = this._keyPolicy.validateMap(values).orThrow();
+        this._context = context;
+    }
+    /**
+     * Returns a `Map\<string, T\>` derived from a supplied {@link MapOrRecord | MapOrRecord}
+     * @param values - The {@link MapOrRecord | MapOrRecord} to be returned as a map.
+     * @returns `Success` with the corresponding `Map\<string, T\>` or `Failure` with a
+     * message if an error occurs.
+     * @internal
+     */
+    static _toMap(values) {
+        if (values === undefined) {
+            return (0, ts_utils_1.captureResult)(() => new Map());
+        }
+        else if (!(values instanceof Map)) {
+            return (0, ts_utils_1.recordToMap)(values, (__k, v) => (0, ts_utils_1.succeed)(v));
+        }
+        return (0, ts_utils_1.succeed)(values);
+    }
+    /**
+     * Determine if a key might be valid for this map but does not determine if key actually
+     * exists. Allows key range to be constrained.
+     * @param key - key to be tested
+     * @returns `true` if the key is in the valid range, `false` otherwise.
+     */
+    keyIsInRange(key) {
+        return this._keyPolicy.isValid(key);
+    }
+    /**
+     * Determines if an entry with the specified key actually exists in the map.
+     * @param key - key to be tested
+     * @returns `true` if an object with the specified key exists, `false` otherwise.
+     */
+    has(key) {
+        return this._values.has(key);
+    }
+    /**
+     * Gets a {@link JsonObject | JSON object} specified by key.
+     * @param key - key of the object to be retrieved
+     * @param context - optional {@link IJsonContext | JSON context} used to format the
+     * returned object.
+     * @returns {@link ts-utils#Success | `Success`} with the formatted object if successful.
+     * {@link ts-utils#Failure | `Failure`} with detail 'unknown' if no such object exists,
+     * or {@link ts-utils#Failure | `Failure`} with detail 'error' if the object was found
+     * but could not be formatted.
+     */
+    getJsonObject(key, context) {
+        return this.getJsonValue(key, context).onSuccess((jv) => {
+            if (!(0, json_1.isJsonObject)(jv)) {
+                return (0, ts_utils_1.failWithDetail)(`${key}: not an object`, 'error');
+            }
+            return (0, ts_utils_1.succeedWithDetail)(jv);
+        });
+    }
+}
+exports.SimpleJsonMapBase = SimpleJsonMapBase;
+/**
+ * A {@link SimpleJsonMap | SimpleJsonMap } presents a view of a simple map
+ * of {@link JsonValue | JSON values}.
+ * @public
+ */
+class SimpleJsonMap extends SimpleJsonMapBase {
+    /**
+     * Constructs a new {@link SimpleJsonMap | SimpleJsonMap} from the supplied objects
+     * @param values - A string-keyed `Map` or `Record` of the {@link JsonValue | JSON values}
+     * to be returned.
+     * @param context - Optional {@link IJsonContext | IJsonContext} used to format returned values.
+     * @param options - Optional {@link ISimpleJsonMapOptions | ISimpleJsonMapOptions} for initialization.
+     * @public
+     */
+    constructor(values, context, options) {
+        super(values, context, options === null || options === void 0 ? void 0 : options.keyPolicy);
+        this._editor = options === null || options === void 0 ? void 0 : options.editor;
+    }
+    /**
+     * Creates a new {@link SimpleJsonMap | SimpleJsonMap} from the supplied objects
+     * @param values - A string-keyed `Map` or `Record` of the {@link JsonValue | JSON values}
+     * to be returned.
+     * @param context - Optional {@link IJsonContext | IJsonContext} used to format returned values.
+     * @param options - Optional {@link ISimpleJsonMapOptions | ISimpleJsonMapOptions} for initialization.
+     * @returns `Success` with a {@link SimpleJsonMap | SimpleJsonMap} or `Failure` with a message if
+     * an error occurs.
+     */
+    static createSimple(values, context, options) {
+        return (0, ts_utils_1.captureResult)(() => new SimpleJsonMap(values, context, options));
+    }
+    /**
+     * Gets a {@link JsonValue | JSON value} specified by key.
+     * @param key - key of the value to be retrieved
+     * @param context - Optional {@link IJsonContext | JSON context} used to format the value
+     * @returns Success with the formatted object if successful. Failure with detail 'unknown'
+     * if no such object exists, or failure with detail 'error' if the object was found but
+     * could not be formatted.
+     */
+    getJsonValue(key, context) {
+        context = context !== null && context !== void 0 ? context : this._context;
+        const value = this._values.get(key);
+        if (!value) {
+            return (0, ts_utils_1.failWithDetail)(`${key}: JSON value not found`, 'unknown');
+        }
+        return this._clone(value, context);
+    }
+    /**
+     * @internal
+     */
+    _clone(value, context) {
+        if (!this._editor) {
+            const result = jsonEditor_1.JsonEditor.create();
+            // istanbul ignore next: nearly impossible to reproduce
+            if (result.isFailure()) {
+                return (0, ts_utils_1.failWithDetail)(result.message, 'error');
+            }
+            this._editor = result.value;
+        }
+        return this._editor.clone(value, context).withFailureDetail('error');
+    }
+}
+exports.SimpleJsonMap = SimpleJsonMap;
+/**
+ * A {@link PrefixedJsonMap | PrefixedJsonMap} enforces a supplied prefix for all contained values,
+ * optionally adding the prefix as necessary (default `true`).
+ * @public
+ */
+class PrefixedJsonMap extends SimpleJsonMap {
+    /**
+     * Constructs a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values
+     * @param prefix - A string prefix to be enforced for and added to key names as necessary
+     * @param values - A string-keyed Map or Record of the {@link JsonValue | JsonValue} to be returned
+     * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values
+     * @param editor - Optional {@link Editor.JsonEditor | JsonEditor} used to format returned values
+     * @public
+     */
+    constructor(values, context, options) {
+        super(values, context, options);
+    }
+    static createPrefixed(prefixOptions, values, context, editor) {
+        return (0, ts_utils_1.captureResult)(() => new PrefixedJsonMap(values, context, { keyPolicy: this._toPolicy(prefixOptions), editor }));
+    }
+    /**
+     * Constructs a new {@link PrefixKeyPolicy | PrefixKeyPolicy} from a supplied prefix
+     * or set of {@link IKeyPrefixOptions | prefix options}.
+     * @param prefixOptions - The prefix or {@link IKeyPrefixOptions | prefix options} or options
+     * for the new policy.
+     * @returns A new {@link ReferenceMapKeyPolicy | ReferenceMapKeyPolicy} which enforces the
+     * supplied prefix or options.
+     * @internal
+     */
+    static _toPolicy(prefixOptions) {
+        if (typeof prefixOptions === 'string') {
+            return new PrefixKeyPolicy(prefixOptions, { makeValid: true });
+        }
+        return new PrefixKeyPolicy(prefixOptions.prefix, { makeValid: prefixOptions.addPrefix !== false });
+    }
+}
+exports.PrefixedJsonMap = PrefixedJsonMap;
+//# sourceMappingURL=jsonReferenceMap.js.map

package/lib/packlets/editor/jsonReferenceMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonReferenceMap.js","sourceRoot":"","sources":["../../../src/packlets/editor/jsonReferenceMap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAUuB;AAGvB,kCAA8D;AAC9D,6CAA0C;AAc1C;;;;GAIG;AACH,MAAa,qBAAqB;IAWhC;;;;;OAKG;IACH,YACE,OAA+C,EAC/C,OAA4C;QAE5C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,qBAAqB,CAAC,mBAAmB,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,GAAW;QAC3C,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,GAAW,EAAE,IAAQ;QAClC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,GAAW,EAAE,IAAQ,EAAE,SAAiD;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,eAAI,EAAC,GAAG,GAAG,eAAe,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAClB,KAAoB,EACpB,OAA+C;QAE/C,OAAO,IAAA,qBAAU,EACf,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,OAAO,IAAA,kBAAO,EAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,WAAW,CAChB,GAAmB,EACnB,OAA+C;QAE/C,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAChF,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7FD,sDA6FC;AAED;;;;GAIG;AACH,MAAa,eAAmB,SAAQ,qBAAwB;IAM9D;;;;;OAKG;IACH,YAAmB,MAAc,EAAE,OAA+C;QAChF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,GAAW,EAAE,MAAU;QACpC,OAAO,CACL,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,IAAI,qBAAqB,CAAC,mBAAmB,CAAC,GAAG,CAAC,CACrG,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,QAAQ,CAAC,GAAW,EAAE,IAAQ,EAAE,OAA+C;;QACpF,uBAAuB;QACvB,MAAM,SAAS,GAAG,CAAA,MAAA,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,eAAe,CAAC,0CAAE,SAAS,MAAK,IAAI,CAAC;QACxE,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE;YAC3B,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;SACrB;aAAM,IAAI,SAAS,IAAI,qBAAqB,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE;YACtE,OAAO,IAAA,kBAAO,EAAC,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC;SACxC;QACD,OAAO,IAAA,eAAI,EAAC,GAAG,GAAG,eAAe,CAAC,CAAC;IACrC,CAAC;CACF;AAjDD,0CAiDC;AAQD;;;;;GAKG;AACH,MAAsB,iBAAiB;IAoBrC;;;;;;;OAOG;IACH,YACE,MAAuB,EACvB,OAAsB,EACtB,SAAoC;QAEpC,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,qBAAqB,EAAE,CAAC;QAC3D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;QAC7D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACO,MAAM,CAAC,MAAM,CAAI,MAAuB;QAChD,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAa,CAAC,CAAC;SAClD;aAAM,IAAI,CAAC,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE;YACnC,OAAO,IAAA,sBAAW,EAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC,CAAC;SACpD;QACD,OAAO,IAAA,kBAAO,EAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACI,aAAa,CAClB,GAAW,EACX,OAAsB;QAEtB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE;YACtD,IAAI,CAAC,IAAA,mBAAY,EAAC,EAAE,CAAC,EAAE;gBACrB,OAAO,IAAA,yBAAc,EAAC,GAAG,GAAG,iBAAiB,EAAE,OAAO,CAAC,CAAC;aACzD;YACD,OAAO,IAAA,4BAAiB,EAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;CAeF;AA7GD,8CA6GC;AAWD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,iBAA4B;IAM7D;;;;;;;OAOG;IACH,YACE,MAA+B,EAC/B,OAAsB,EACtB,OAA+B;QAE/B,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,YAAY,CACxB,MAA+B,EAC/B,OAAsB,EACtB,OAA+B;QAE/B,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CACjB,GAAW,EACX,OAAsB;QAEtB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,QAAQ,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,IAAA,yBAAc,EAAC,GAAG,GAAG,wBAAwB,EAAE,SAAS,CAAC,CAAC;SAClE;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,MAAM,CACd,KAAgB,EAChB,OAAsB;QAEtB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,MAAM,GAAG,uBAAU,CAAC,MAAM,EAAE,CAAC;YACnC,uDAAuD;YACvD,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;gBACtB,OAAO,IAAA,yBAAc,EAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aAChD;YACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AA7ED,sCA6EC;AAkBD;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,aAAa;IAChD;;;;;;;OAOG;IACH,YACE,MAA+B,EAC/B,OAAsB,EACtB,OAA+B;QAE/B,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAgCM,MAAM,CAAC,cAAc,CAC1B,aAAyC,EACzC,MAA+B,EAC/B,OAAsB,EACtB,MAAmB;QAEnB,OAAO,IAAA,wBAAa,EAClB,GAAG,EAAE,CAAC,IAAI,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CACjG,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,SAAS,CAAC,aAAyC;QAClE,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;SAChE;QACD,OAAO,IAAI,eAAe,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,aAAa,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AAzED,0CAyEC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n  DetailedResult,\n  Result,\n  captureResult,\n  fail,\n  failWithDetail,\n  mapResults,\n  recordToMap,\n  succeed,\n  succeedWithDetail\n} from '@fgv/ts-utils';\n\nimport { IJsonContext, IJsonReferenceMap, JsonReferenceMapFailureReason } from '../context';\nimport { JsonObject, JsonValue, isJsonObject } from '../json';\nimport { JsonEditor } from './jsonEditor';\n\n/**\n * Options for creating a {@link ReferenceMapKeyPolicy | ReferenceMapKeyPolicy} object.\n * @public\n */\nexport interface IReferenceMapKeyPolicyValidateOptions {\n  /**\n   * If `true`, the validator coerces keys to some valid value.\n   * If `false`, invalid keys cause an error.\n   */\n  makeValid?: boolean;\n}\n\n/**\n * Policy object responsible for validating or correcting\n * keys in a {@link IJsonReferenceMap | reference map}.\n * @public\n */\nexport class ReferenceMapKeyPolicy<T> {\n  /**\n   * @internal\n   */\n  protected readonly _defaultOptions?: IReferenceMapKeyPolicyValidateOptions;\n\n  /**\n   * @internal\n   */\n  protected readonly _isValid: (key: string, item?: T) => boolean;\n\n  /**\n   * Constructs a new {@link ReferenceMapKeyPolicy | ReferenceMapKeyPolicy}.\n   * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options}\n   * used to construct the {@link ReferenceMapKeyPolicy}.\n   * @param isValid - An optional predicate to test a supplied key for validity.\n   */\n  public constructor(\n    options?: IReferenceMapKeyPolicyValidateOptions,\n    isValid?: (key: string, item?: T) => boolean\n  ) {\n    this._defaultOptions = options;\n    this._isValid = isValid ?? ReferenceMapKeyPolicy.defaultKeyPredicate;\n  }\n\n  /**\n   * The static default key name validation predicate rejects keys that contain\n   * mustache templates or which start with the default conditional prefix\n   * `'?'`.\n   * @param key - The key to test.\n   * @returns `true` if the key is valid, `false` otherwise.\n   */\n  public static defaultKeyPredicate(key: string): boolean {\n    return key.length > 0 && !key.includes('{{') && !key.startsWith('?');\n  }\n\n  /**\n   * Determines if a supplied key and item are valid according to the current policy.\n   * @param key - The key to be tested.\n   * @param item - The item to be tested.\n   * @returns `true` if the key and value are valid, `false` otherwise.\n   */\n  public isValid(key: string, item?: T): boolean {\n    return this._isValid(key, item);\n  }\n\n  /**\n   * Determines if a supplied key and item are valid according to the current policy.\n   * @param key - The key to be tested.\n   * @param item - The item to be tested.\n   * @returns `Success` with the key if valid, `Failure` with an error message if invalid.\n   */\n  public validate(key: string, item?: T, __options?: IReferenceMapKeyPolicyValidateOptions): Result<string> {\n    return this.isValid(key, item) ? succeed(key) : fail(`${key}: invalid key`);\n  }\n\n  /**\n   * Validates an array of entries using the validation rules for this policy.\n   * @param items - The array of entries to be validated.\n   * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control\n   * validation.\n   * @returns `Success` with an array of validated entries, or `Failure` with an error message\n   * if validation fails.\n   */\n  public validateItems(\n    items: [string, T][],\n    options?: IReferenceMapKeyPolicyValidateOptions\n  ): Result<[string, T][]> {\n    return mapResults(\n      items.map((item) => {\n        return this.validate(...item, options).onSuccess((valid) => {\n          return succeed([valid, item[1]]);\n        });\n      })\n    );\n  }\n\n  /**\n   * Validates a `Map\\<string, T\\>` using the validation rules for this policy.\n   * @param items - The `Map\\<string, T\\>` to be validated.\n   * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control\n   * validation.\n   * @returns `Success` with a new `Map\\<string, T\\>`, or `Failure` with an error message\n   * if validation fails.\n   */\n  public validateMap(\n    map: Map<string, T>,\n    options?: IReferenceMapKeyPolicyValidateOptions\n  ): Result<Map<string, T>> {\n    return this.validateItems(Array.from(map.entries()), options).onSuccess((valid) => {\n      return captureResult(() => new Map(valid));\n    });\n  }\n}\n\n/**\n * A {@link PrefixKeyPolicy | PrefixKeyPolicy} enforces that all keys start with a supplied\n * prefix, optionally adding the prefix as necessary.\n * @public\n */\nexport class PrefixKeyPolicy<T> extends ReferenceMapKeyPolicy<T> {\n  /**\n   * The string prefix to be enforced by this policy.\n   */\n  public readonly prefix: string;\n\n  /**\n   * Constructs a new {@link PrefixKeyPolicy | PrefixKeyPolicy}.\n   * @param prefix - The string prefix to be enforced or applied.\n   * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to\n   * configure the policy.\n   */\n  public constructor(prefix: string, options?: IReferenceMapKeyPolicyValidateOptions) {\n    super(options);\n    this.prefix = prefix;\n  }\n\n  /**\n   * Determines if a key is valid according to policy.\n   * @param key - The key to be tested.\n   * @param __item - The item to be tested.\n   * @returns `true` if the key starts with the expected prefix, `false` otherwise.\n   */\n  public isValid(key: string, __item?: T): boolean {\n    return (\n      key.startsWith(this.prefix) && key !== this.prefix && ReferenceMapKeyPolicy.defaultKeyPredicate(key)\n    );\n  }\n\n  /**\n   * Determines if a key is valid according to policy, optionally coercing to a valid value by\n   * adding the required prefix.\n   * @param key - The key to be tested.\n   * @param item - The item which corresponds to the key.\n   * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to guide\n   * validation.\n   * @returns `Success` with a valid key name if the supplied key is valid or if `makeValid` is set\n   * in the policy options. Returns `Failure` with an error message if an error occurs.\n   */\n  public validate(key: string, item?: T, options?: IReferenceMapKeyPolicyValidateOptions): Result<string> {\n    // istanbul ignore next\n    const makeValid = (options ?? this._defaultOptions)?.makeValid === true;\n    if (this.isValid(key, item)) {\n      return succeed(key);\n    } else if (makeValid && ReferenceMapKeyPolicy.defaultKeyPredicate(key)) {\n      return succeed(`${this.prefix}${key}`);\n    }\n    return fail(`${key}: invalid key`);\n  }\n}\n\n/**\n * Type representing either a `Map\\<string, T\\>` or a `Record\\<string, T\\>`.\n * @public\n */\nexport type MapOrRecord<T> = Map<string, T> | Record<string, T>;\n\n/**\n * Abstract base class with common functionality for simple\n * {@link IJsonReferenceMap | reference map} implementations.\n * {@link JsonValue | json values}.\n * @public\n */\nexport abstract class SimpleJsonMapBase<T> implements IJsonReferenceMap {\n  /**\n   * The {@link ReferenceMapKeyPolicy | key policy} in effect for this map.\n   * @internal\n   */\n  protected readonly _keyPolicy: ReferenceMapKeyPolicy<T>;\n\n  /**\n   * A map containing keys and values already present in this map.\n   * @internal\n   */\n  protected readonly _values: Map<string, T>;\n\n  /**\n   * An optional {@link IJsonContext | IJsonContext} used for any conversions\n   * involving items in this map.\n   * @internal\n   */\n  protected readonly _context?: IJsonContext;\n\n  /**\n   * Constructs a new {@link SimpleJsonMap | SimpleJsonMap}.\n   * @param values - Initial values for the map.\n   * @param context - An optional {@link IJsonContext | IJsonContext} used for any conversions\n   * involving items in this map.\n   * @param keyPolicy - The {@link ReferenceMapKeyPolicy | key policy} to use for this map.\n   * @internal\n   */\n  protected constructor(\n    values?: MapOrRecord<T>,\n    context?: IJsonContext,\n    keyPolicy?: ReferenceMapKeyPolicy<T>\n  ) {\n    values = SimpleJsonMapBase._toMap(values).orThrow();\n    this._keyPolicy = keyPolicy ?? new ReferenceMapKeyPolicy();\n    this._values = this._keyPolicy.validateMap(values).orThrow();\n    this._context = context;\n  }\n\n  /**\n   * Returns a `Map\\<string, T\\>` derived from a supplied {@link MapOrRecord | MapOrRecord}\n   * @param values - The {@link MapOrRecord | MapOrRecord} to be returned as a map.\n   * @returns `Success` with the corresponding `Map\\<string, T\\>` or `Failure` with a\n   * message if an error occurs.\n   * @internal\n   */\n  protected static _toMap<T>(values?: MapOrRecord<T>): Result<Map<string, T>> {\n    if (values === undefined) {\n      return captureResult(() => new Map<string, T>());\n    } else if (!(values instanceof Map)) {\n      return recordToMap(values, (__k, v) => succeed(v));\n    }\n    return succeed(values);\n  }\n\n  /**\n   * Determine if a key might be valid for this map but does not determine if key actually\n   * exists. Allows key range to be constrained.\n   * @param key - key to be tested\n   * @returns `true` if the key is in the valid range, `false` otherwise.\n   */\n  public keyIsInRange(key: string): boolean {\n    return this._keyPolicy.isValid(key);\n  }\n\n  /**\n   * Determines if an entry with the specified key actually exists in the map.\n   * @param key - key to be tested\n   * @returns `true` if an object with the specified key exists, `false` otherwise.\n   */\n  public has(key: string): boolean {\n    return this._values.has(key);\n  }\n\n  /**\n   * Gets a {@link JsonObject | JSON object} specified by key.\n   * @param key - key of the object to be retrieved\n   * @param context - optional {@link IJsonContext | JSON context} used to format the\n   * returned object.\n   * @returns {@link ts-utils#Success | `Success`} with the formatted object if successful.\n   * {@link ts-utils#Failure | `Failure`} with detail 'unknown' if no such object exists,\n   * or {@link ts-utils#Failure | `Failure`} with detail 'error' if the object was found\n   * but could not be formatted.\n   */\n  public getJsonObject(\n    key: string,\n    context?: IJsonContext\n  ): DetailedResult<JsonObject, JsonReferenceMapFailureReason> {\n    return this.getJsonValue(key, context).onSuccess((jv) => {\n      if (!isJsonObject(jv)) {\n        return failWithDetail(`${key}: not an object`, 'error');\n      }\n      return succeedWithDetail(jv);\n    });\n  }\n\n  /**\n   * Gets a {@link JsonValue | JSON value} specified by key.\n   * @param key - key of the value to be retrieved\n   * @param context - Optional {@link IJsonContext | JSON context} used to format the value\n   * @returns Success with the formatted object if successful. Failure with detail 'unknown'\n   * if no such object exists, or failure with detail 'error' if the object was found but\n   * could not be formatted.\n   */\n  // eslint-disable-next-line no-use-before-define\n  public abstract getJsonValue(\n    key: string,\n    context?: IJsonContext\n  ): DetailedResult<JsonValue, JsonReferenceMapFailureReason>;\n}\n\n/**\n * Initialization options for a {@link SimpleJsonMap | SimpleJsonMap}.\n * @public\n */\nexport interface ISimpleJsonMapOptions {\n  keyPolicy?: ReferenceMapKeyPolicy<JsonValue>;\n  editor?: JsonEditor;\n}\n\n/**\n * A {@link SimpleJsonMap | SimpleJsonMap } presents a view of a simple map\n * of {@link JsonValue | JSON values}.\n * @public\n */\nexport class SimpleJsonMap extends SimpleJsonMapBase<JsonValue> {\n  /**\n   * @internal\n   */\n  protected _editor?: JsonEditor;\n\n  /**\n   * Constructs a new {@link SimpleJsonMap | SimpleJsonMap} from the supplied objects\n   * @param values - A string-keyed `Map` or `Record` of the {@link JsonValue | JSON values}\n   * to be returned.\n   * @param context - Optional {@link IJsonContext | IJsonContext} used to format returned values.\n   * @param options - Optional {@link ISimpleJsonMapOptions | ISimpleJsonMapOptions} for initialization.\n   * @public\n   */\n  protected constructor(\n    values?: MapOrRecord<JsonValue>,\n    context?: IJsonContext,\n    options?: ISimpleJsonMapOptions\n  ) {\n    super(values, context, options?.keyPolicy);\n    this._editor = options?.editor;\n  }\n\n  /**\n   * Creates a new {@link SimpleJsonMap | SimpleJsonMap} from the supplied objects\n   * @param values - A string-keyed `Map` or `Record` of the {@link JsonValue | JSON values}\n   * to be returned.\n   * @param context - Optional {@link IJsonContext | IJsonContext} used to format returned values.\n   * @param options - Optional {@link ISimpleJsonMapOptions | ISimpleJsonMapOptions} for initialization.\n   * @returns `Success` with a {@link SimpleJsonMap | SimpleJsonMap} or `Failure` with a message if\n   * an error occurs.\n   */\n  public static createSimple(\n    values?: MapOrRecord<JsonValue>,\n    context?: IJsonContext,\n    options?: ISimpleJsonMapOptions\n  ): Result<SimpleJsonMap> {\n    return captureResult(() => new SimpleJsonMap(values, context, options));\n  }\n\n  /**\n   * Gets a {@link JsonValue | JSON value} specified by key.\n   * @param key - key of the value to be retrieved\n   * @param context - Optional {@link IJsonContext | JSON context} used to format the value\n   * @returns Success with the formatted object if successful. Failure with detail 'unknown'\n   * if no such object exists, or failure with detail 'error' if the object was found but\n   * could not be formatted.\n   */\n  public getJsonValue(\n    key: string,\n    context?: IJsonContext\n  ): DetailedResult<JsonValue, JsonReferenceMapFailureReason> {\n    context = context ?? this._context;\n    const value = this._values.get(key);\n    if (!value) {\n      return failWithDetail(`${key}: JSON value not found`, 'unknown');\n    }\n    return this._clone(value, context);\n  }\n\n  /**\n   * @internal\n   */\n  protected _clone(\n    value: JsonValue,\n    context?: IJsonContext\n  ): DetailedResult<JsonValue, JsonReferenceMapFailureReason> {\n    if (!this._editor) {\n      const result = JsonEditor.create();\n      // istanbul ignore next: nearly impossible to reproduce\n      if (result.isFailure()) {\n        return failWithDetail(result.message, 'error');\n      }\n      this._editor = result.value;\n    }\n    return this._editor.clone(value, context).withFailureDetail('error');\n  }\n}\n\n/**\n * Initialization options for a {@link PrefixedJsonMap | PrefixedJsonMap}\n * @public\n */\nexport interface IKeyPrefixOptions {\n  /**\n   * Indicates whether the prefix should be added automatically as needed (default true)\n   */\n  addPrefix?: boolean;\n\n  /**\n   * The prefix to be enforced\n   */\n  prefix: string;\n}\n\n/**\n * A {@link PrefixedJsonMap | PrefixedJsonMap} enforces a supplied prefix for all contained values,\n * optionally adding the prefix as necessary (default `true`).\n * @public\n */\nexport class PrefixedJsonMap extends SimpleJsonMap {\n  /**\n   * Constructs a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values\n   * @param prefix - A string prefix to be enforced for and added to key names as necessary\n   * @param values - A string-keyed Map or Record of the {@link JsonValue | JsonValue} to be returned\n   * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values\n   * @param editor - Optional {@link Editor.JsonEditor | JsonEditor} used to format returned values\n   * @public\n   */\n  protected constructor(\n    values?: MapOrRecord<JsonValue>,\n    context?: IJsonContext,\n    options?: ISimpleJsonMapOptions\n  ) {\n    super(values, context, options);\n  }\n\n  /**\n   * Creates a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values\n   * @param prefix - A string prefix to be enforced for and added to key names as necessary\n   * @param values - A string-keyed Map or Record of the {@link JsonValue | JsonValue} to be returned\n   * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values\n   * @param editor - Optional {@link Editor.JsonEditor | JsonEditor} used to format returned values\n   * @returns `Success` with a {@link PrefixedJsonMap | PrefixedJsonMap} or `Failure` with a message\n   * if an error occurs.\n   */\n  public static createPrefixed(\n    prefix: string,\n    values?: MapOrRecord<JsonValue>,\n    context?: IJsonContext,\n    editor?: JsonEditor\n  ): Result<PrefixedJsonMap>;\n\n  /**\n   * Creates a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values\n   * @param prefixOptions - A KeyPrefixOptions indicating the prefix to enforce and whether that prefix should\n   * be added automatically if necessary (default true)\n   * @param values - A string-keyed Map or record of the {@link JsonValue | JsonValue} to be returned\n   * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values\n   * @param editor - Optional {@link Editor.JsonEditor | JsonEditor} used to format returned values\n   */\n  public static createPrefixed(\n    prefixOptions: IKeyPrefixOptions,\n    values?: MapOrRecord<JsonValue>,\n    context?: IJsonContext,\n    editor?: JsonEditor\n  ): Result<PrefixedJsonMap>;\n  public static createPrefixed(\n    prefixOptions: string | IKeyPrefixOptions,\n    values?: MapOrRecord<JsonValue>,\n    context?: IJsonContext,\n    editor?: JsonEditor\n  ): Result<PrefixedJsonMap> {\n    return captureResult(\n      () => new PrefixedJsonMap(values, context, { keyPolicy: this._toPolicy(prefixOptions), editor })\n    );\n  }\n\n  /**\n   * Constructs a new {@link PrefixKeyPolicy | PrefixKeyPolicy} from a supplied prefix\n   * or set of {@link IKeyPrefixOptions | prefix options}.\n   * @param prefixOptions - The prefix or {@link IKeyPrefixOptions | prefix options} or options\n   * for the new policy.\n   * @returns A new {@link ReferenceMapKeyPolicy | ReferenceMapKeyPolicy} which enforces the\n   * supplied prefix or options.\n   * @internal\n   */\n  protected static _toPolicy(prefixOptions: string | IKeyPrefixOptions): ReferenceMapKeyPolicy<JsonValue> {\n    if (typeof prefixOptions === 'string') {\n      return new PrefixKeyPolicy(prefixOptions, { makeValid: true });\n    }\n    return new PrefixKeyPolicy(prefixOptions.prefix, { makeValid: prefixOptions.addPrefix !== false });\n  }\n}\n"]}

package/lib/packlets/editor/rules/conditional.d.ts

@@ -0,0 +1,107 @@
+import { DetailedResult, Result } from '@fgv/ts-utils';
+import { JsonObject, JsonValue } from '../../json';
+import { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';
+import { JsonEditorRuleBase } from '../jsonEditorRule';
+import { JsonEditorState } from '../jsonEditorState';
+/**
+ * Returned by {@link Editor.Rules.ConditionalJsonEditorRule._tryParseCondition | ConditionalJsonEditorRule._tryParseCondition}
+ * to indicate whether a successful match was due to a matching condition or a default value.
+ * @public
+ */
+export interface IConditionalJsonKeyResult extends JsonObject {
+    matchType: 'default' | 'match' | 'unconditional';
+}
+/**
+ * On a successful match, the {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}
+ * stores a {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject} describing the
+ * matching result, to be resolved at finalization time.
+ * @public
+ */
+export interface IConditionalJsonDeferredObject extends IConditionalJsonKeyResult {
+    value: JsonValue;
+}
+/**
+ * Configuration options for the {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.
+ * @public
+ */
+export interface IConditionalJsonRuleOptions extends Partial<IJsonEditorOptions> {
+    /**
+     * If true (default) then properties with unconditional names
+     * (which start with !) are flattened.
+     */
+    flattenUnconditionalValues?: boolean;
+}
+/**
+ * The {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule} evaluates
+ * properties with conditional keys, omitting non-matching keys and merging keys that match,
+ * or default keys only if no other keys match.
+ *
+ * The default syntax for a conditional key is:
+ *    "?value1=value2" - matches if value1 and value2 are the same, is ignored otherwise.
+ *    "?value" - matches if value is a non-empty, non-whitespace string. Is ignored otherwise.
+ *    "?default" - matches only if no other conditional blocks in the same object were matched.
+ * @public
+ */
+export declare class ConditionalJsonEditorRule extends JsonEditorRuleBase {
+    /**
+     * Stored fully-resolved {@link Editor.Rules.IConditionalJsonRuleOptions | options} for this
+     * rule.
+     * @public
+     */
+    protected _options?: IConditionalJsonRuleOptions;
+    /**
+     * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.
+     * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}
+     * used for this rule.
+     */
+    constructor(options?: IConditionalJsonRuleOptions);
+    /**
+     * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.
+     * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}
+     * used for this rule.
+     */
+    static create(options?: IConditionalJsonRuleOptions): Result<ConditionalJsonEditorRule>;
+    /**
+     * Evaluates a property for conditional application.
+     * @param key - The key of the property to be considered
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns Returns `Success` with detail `'deferred'` and a
+     * {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject}.
+     * for a matching, default or unconditional key. Returns `Failure` with detail `'ignore'` for
+     * a non-matching conditional, or with detail `'error'` if an error occurs. Otherwise
+     * fails with detail `'inapplicable'`.
+     */
+    editProperty(key: string, value: JsonValue, state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
+    /**
+     * Finalizes any deferred conditional properties. If the only deferred property is
+     * default, that property is emitted. Otherwise all matching properties are emitted.
+     * @param finalized - The deferred properties to be considered for merge.
+     * @param __state - The {@link Editor.JsonEditorState | editor state} for the object
+     * being edited.
+     */
+    finalizeProperties(finalized: JsonObject[], __state: JsonEditorState): DetailedResult<JsonObject[], JsonEditFailureReason>;
+    /**
+     * Determines if a given property key is conditional. Derived classes can override this
+     * method to use a different format for conditional properties.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with detail `'deferred'` and a
+     * {@link Editor.Rules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the
+     * match for a default or matching conditional property.  Returns `Failure` with detail `'ignore'`
+     * for a non-matching conditional property. Fails with detail `'error'` if an error occurs
+     * or with detail `'inapplicable'` if the key does not represent a conditional property.
+     * @public
+     */
+    protected _tryParseCondition(key: string, state: JsonEditorState): DetailedResult<IConditionalJsonKeyResult, JsonPropertyEditFailureReason>;
+    /**
+     * Compares two strings using a supplied operator.
+     * @param left - The first string to be compared.
+     * @param right - The second string to be compared.
+     * @param operator - The operator to be applied.
+     * @returns `true` if the condition is met, `false` otherwise.
+     * @internal
+     */
+    protected _compare(left: string, right: string, operator: string): boolean;
+}
+//# sourceMappingURL=conditional.d.ts.map

package/lib/packlets/editor/rules/conditional.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditional.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/conditional.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoD,MAAM,eAAe,CAAC;AACzG,OAAO,EAAE,UAAU,EAAE,SAAS,EAAgB,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AACrG,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,UAAU;IAC3D,SAAS,EAAE,SAAS,GAAG,OAAO,GAAG,eAAe,CAAC;CAClD;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA+B,SAAQ,yBAAyB;IAC/E,KAAK,EAAE,SAAS,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,OAAO,CAAC,kBAAkB,CAAC;IAC9E;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;;;;;;;GAUG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEjD;;;;OAIG;gBACgB,OAAO,CAAC,EAAE,2BAA2B;IAKxD;;;;OAIG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,MAAM,CAAC,yBAAyB,CAAC;IAI9F;;;;;;;;;;OAUG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IAmB5D;;;;;;OAMG;IACI,kBAAkB,CACvB,SAAS,EAAE,UAAU,EAAE,EACvB,OAAO,EAAE,eAAe,GACvB,cAAc,CAAC,UAAU,EAAE,EAAE,qBAAqB,CAAC;IAUtD;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,kBAAkB,CAC1B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,yBAAyB,EAAE,6BAA6B,CAAC;IA6B3E;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;CAkB3E"}

package/lib/packlets/editor/rules/conditional.js

@@ -0,0 +1,167 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConditionalJsonEditorRule = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const json_1 = require("../../json");
+const jsonEditorRule_1 = require("../jsonEditorRule");
+/**
+ * The {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule} evaluates
+ * properties with conditional keys, omitting non-matching keys and merging keys that match,
+ * or default keys only if no other keys match.
+ *
+ * The default syntax for a conditional key is:
+ *    "?value1=value2" - matches if value1 and value2 are the same, is ignored otherwise.
+ *    "?value" - matches if value is a non-empty, non-whitespace string. Is ignored otherwise.
+ *    "?default" - matches only if no other conditional blocks in the same object were matched.
+ * @public
+ */
+class ConditionalJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
+    /**
+     * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.
+     * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}
+     * used for this rule.
+     */
+    constructor(options) {
+        super();
+        this._options = options;
+    }
+    /**
+     * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.
+     * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}
+     * used for this rule.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new ConditionalJsonEditorRule(options));
+    }
+    /**
+     * Evaluates a property for conditional application.
+     * @param key - The key of the property to be considered
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns Returns `Success` with detail `'deferred'` and a
+     * {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject}.
+     * for a matching, default or unconditional key. Returns `Failure` with detail `'ignore'` for
+     * a non-matching conditional, or with detail `'error'` if an error occurs. Otherwise
+     * fails with detail `'inapplicable'`.
+     */
+    editProperty(key, value, state) {
+        var _a;
+        const result = this._tryParseCondition(key, state).onSuccess((deferred) => {
+            if ((0, json_1.isJsonObject)(value)) {
+                const rtrn = Object.assign(Object.assign({}, deferred), { value });
+                return (0, ts_utils_1.succeedWithDetail)(rtrn, 'deferred');
+            }
+            return (0, ts_utils_1.failWithDetail)(`${key}: conditional body must be object`, 'error');
+        });
+        if (result.isFailure() && result.detail === 'error') {
+            return state.failValidation('invalidPropertyName', result.message, (_a = this._options) === null || _a === void 0 ? void 0 : _a.validation);
+        }
+        return result;
+    }
+    /**
+     * Finalizes any deferred conditional properties. If the only deferred property is
+     * default, that property is emitted. Otherwise all matching properties are emitted.
+     * @param finalized - The deferred properties to be considered for merge.
+     * @param __state - The {@link Editor.JsonEditorState | editor state} for the object
+     * being edited.
+     */
+    finalizeProperties(finalized, __state) {
+        let toMerge = finalized;
+        if (finalized.length > 1) {
+            if (finalized.find((o) => o.matchType === 'match') !== undefined) {
+                toMerge = finalized.filter((o) => o.matchType === 'match' || o.matchType === 'unconditional');
+            }
+        }
+        return (0, ts_utils_1.succeedWithDetail)(toMerge.map((o) => o.value).filter(json_1.isJsonObject), 'edited');
+    }
+    /**
+     * Determines if a given property key is conditional. Derived classes can override this
+     * method to use a different format for conditional properties.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with detail `'deferred'` and a
+     * {@link Editor.Rules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the
+     * match for a default or matching conditional property.  Returns `Failure` with detail `'ignore'`
+     * for a non-matching conditional property. Fails with detail `'error'` if an error occurs
+     * or with detail `'inapplicable'` if the key does not represent a conditional property.
+     * @public
+     */
+    _tryParseCondition(key, state) {
+        var _a, _b;
+        if (key.startsWith('?')) {
+            // ignore everything after any #
+            key = key.split('#')[0].trim();
+            if (key === '?default') {
+                return (0, ts_utils_1.succeedWithDetail)({ matchType: 'default' }, 'deferred');
+            }
+            const parts = key.substring(1).split(/(=|>=|<=|>|<|!=)/);
+            if (parts.length === 3) {
+                if (!this._compare(parts[0].trim(), parts[2].trim(), parts[1])) {
+                    return (0, ts_utils_1.failWithDetail)(`Condition ${key} does not match`, 'ignore');
+                }
+                return (0, ts_utils_1.succeedWithDetail)({ matchType: 'match' }, 'deferred');
+            }
+            else if (parts.length === 1) {
+                if (parts[0].trim().length === 0) {
+                    return (0, ts_utils_1.failWithDetail)(`Condition ${key} does not match`, 'ignore');
+                }
+                return (0, ts_utils_1.succeedWithDetail)({ matchType: 'match' }, 'deferred');
+            }
+            const message = `Malformed condition token ${key}`;
+            return state.failValidation('invalidPropertyName', message, (_a = this._options) === null || _a === void 0 ? void 0 : _a.validation);
+        }
+        else if (((_b = this._options) === null || _b === void 0 ? void 0 : _b.flattenUnconditionalValues) !== false && key.startsWith('!')) {
+            return (0, ts_utils_1.succeedWithDetail)({ matchType: 'unconditional' }, 'deferred');
+        }
+        return (0, ts_utils_1.failWithDetail)('inapplicable', 'inapplicable');
+    }
+    /**
+     * Compares two strings using a supplied operator.
+     * @param left - The first string to be compared.
+     * @param right - The second string to be compared.
+     * @param operator - The operator to be applied.
+     * @returns `true` if the condition is met, `false` otherwise.
+     * @internal
+     */
+    _compare(left, right, operator) {
+        switch (operator) {
+            case '=':
+                return left === right;
+            case '>':
+                return left > right;
+            case '<':
+                return left < right;
+            case '>=':
+                return left >= right;
+            case '<=':
+                return left <= right;
+            case '!=':
+                return left !== right;
+        }
+        // istanbul ignore next: unreachable
+        return false;
+    }
+}
+exports.ConditionalJsonEditorRule = ConditionalJsonEditorRule;
+//# sourceMappingURL=conditional.js.map