@fgv/ts-json 2.1.0 → 2.1.1-alpha.1

package/lib/packlets/editor/jsonReferenceMap.js

@@ -23,7 +23,7 @@
 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 ts_json_base_1 = require("@fgv/ts-json-base");
 const jsonEditor_1 = require("./jsonEditor");
 /**
  * Policy object responsible for validating or correcting
@@ -214,7 +214,7 @@ class SimpleJsonMapBase {
      */
     getJsonObject(key, context) {
         return this.getJsonValue(key, context).onSuccess((jv) => {
-            if (!(0, json_1.isJsonObject)(jv)) {
+            if (!(0, ts_json_base_1.isJsonObject)(jv)) {
                 return (0, ts_utils_1.failWithDetail)(`${key}: not an object`, 'error');
             }
             return (0, ts_utils_1.succeedWithDetail)(jv);

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

@@ -1 +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,oBAAoB;QACpB,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    /* c8 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      /* c8 ignore next 3 - 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"]}
+{"version":3,"file":"jsonReferenceMap.js","sourceRoot":"","sources":["../../../src/packlets/editor/jsonReferenceMap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAUuB;AAEvB,oDAAwE;AAExE,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,oBAAoB;QACpB,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,CAAC;YAC5B,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;QACtB,CAAC;aAAM,IAAI,SAAS,IAAI,qBAAqB,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;YACvE,OAAO,IAAA,kBAAO,EAAC,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC;QACzC,CAAC;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,CAAC;YACzB,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAa,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,CAAC,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,CAAC;YACpC,OAAO,IAAA,sBAAW,EAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;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,2BAAY,EAAC,EAAE,CAAC,EAAE,CAAC;gBACtB,OAAO,IAAA,yBAAc,EAAC,GAAG,GAAG,iBAAiB,EAAE,OAAO,CAAC,CAAC;YAC1D,CAAC;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,CAAC;YACX,OAAO,IAAA,yBAAc,EAAC,GAAG,GAAG,wBAAwB,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;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,CAAC;YAClB,MAAM,MAAM,GAAG,uBAAU,CAAC,MAAM,EAAE,CAAC;YACnC,uDAAuD;YACvD,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,OAAO,IAAA,yBAAc,EAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjD,CAAC;YACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;QAC9B,CAAC;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,CAAC;YACtC,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,CAAC;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 { JsonObject, JsonValue, isJsonObject } from '@fgv/ts-json-base';\nimport { IJsonContext, IJsonReferenceMap, JsonReferenceMapFailureReason } from '../context';\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    /* c8 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      /* c8 ignore next 3 - 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

@@ -1,5 +1,5 @@
+import { JsonObject, JsonValue } from '@fgv/ts-json-base';
 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';

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

@@ -1 +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"}
+{"version":3,"file":"conditional.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/conditional.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAgB,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoD,MAAM,eAAe,CAAC;AACzG,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

@@ -22,8 +22,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConditionalJsonEditorRule = void 0;
+const ts_json_base_1 = require("@fgv/ts-json-base");
 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
@@ -68,7 +68,7 @@ class ConditionalJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     editProperty(key, value, state) {
         var _a;
         const result = this._tryParseCondition(key, state).onSuccess((deferred) => {
-            if ((0, json_1.isJsonObject)(value)) {
+            if ((0, ts_json_base_1.isJsonObject)(value)) {
                 const rtrn = Object.assign(Object.assign({}, deferred), { value });
                 return (0, ts_utils_1.succeedWithDetail)(rtrn, 'deferred');
             }
@@ -93,7 +93,7 @@ class ConditionalJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
                 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');
+        return (0, ts_utils_1.succeedWithDetail)(toMerge.map((o) => o.value).filter(ts_json_base_1.isJsonObject), 'edited');
     }
     /**
      * Determines if a given property key is conditional. Derived classes can override this

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

@@ -1 +1 @@
-{"version":3,"file":"conditional.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/conditional.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAyG;AACzG,qCAAiE;AAEjE,sDAAuD;AAkCvD;;;;;;;;;;GAUG;AACH,MAAa,yBAA0B,SAAQ,mCAAkB;IAQ/D;;;;OAIG;IACH,YAAmB,OAAqC;QACtD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,OAAqC;QACxD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;;QAEtB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACxE,IAAI,IAAA,mBAAY,EAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,IAAI,mCAAwC,QAAQ,KAAE,KAAK,GAAE,CAAC;gBACpE,OAAO,IAAA,4BAAiB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;aAC5C;YACD,OAAO,IAAA,yBAAc,EACnB,GAAG,GAAG,mCAAmC,EACzC,OAAO,CACR,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE;YACnD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;SAC/F;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,kBAAkB,CACvB,SAAuB,EACvB,OAAwB;QAExB,IAAI,OAAO,GAAG,SAAS,CAAC;QACxB,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,KAAK,SAAS,EAAE;gBAChE,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,eAAe,CAAC,CAAC;aAC/F;SACF;QACD,OAAO,IAAA,4BAAiB,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;OAWG;IACO,kBAAkB,CAC1B,GAAW,EACX,KAAsB;;QAEtB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACvB,gCAAgC;YAChC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAE/B,IAAI,GAAG,KAAK,UAAU,EAAE;gBACtB,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;aAChE;YAED,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACzD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC9D,OAAO,IAAA,yBAAc,EAAC,aAAa,GAAG,iBAAiB,EAAE,QAAQ,CAAC,CAAC;iBACpE;gBACD,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;aAC9D;iBAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;oBAChC,OAAO,IAAA,yBAAc,EAAC,aAAa,GAAG,iBAAiB,EAAE,QAAQ,CAAC,CAAC;iBACpE;gBACD,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;aAC9D;YACD,MAAM,OAAO,GAAG,6BAA6B,GAAG,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;SACxF;aAAM,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,0BAA0B,MAAK,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACrF,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,UAAU,CAAC,CAAC;SACtE;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACO,QAAQ,CAAC,IAAY,EAAE,KAAa,EAAE,QAAgB;QAC9D,QAAQ,QAAQ,EAAE;YAChB,KAAK,GAAG;gBACN,OAAO,IAAI,KAAK,KAAK,CAAC;YACxB,KAAK,GAAG;gBACN,OAAO,IAAI,GAAG,KAAK,CAAC;YACtB,KAAK,GAAG;gBACN,OAAO,IAAI,GAAG,KAAK,CAAC;YACtB,KAAK,IAAI;gBACP,OAAO,IAAI,IAAI,KAAK,CAAC;YACvB,KAAK,IAAI;gBACP,OAAO,IAAI,IAAI,KAAK,CAAC;YACvB,KAAK,IAAI;gBACP,OAAO,IAAI,KAAK,KAAK,CAAC;SACzB;QACD,oCAAoC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAvJD,8DAuJC","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 { DetailedResult, Result, captureResult, failWithDetail, succeedWithDetail } from '@fgv/ts-utils';\nimport { JsonObject, JsonValue, isJsonObject } from '../../json';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\n/**\n * Returned by {@link Editor.Rules.ConditionalJsonEditorRule._tryParseCondition | ConditionalJsonEditorRule._tryParseCondition}\n * to indicate whether a successful match was due to a matching condition or a default value.\n * @public\n */\nexport interface IConditionalJsonKeyResult extends JsonObject {\n  matchType: 'default' | 'match' | 'unconditional';\n}\n\n/**\n * On a successful match, the {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}\n * stores a {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject} describing the\n * matching result, to be resolved at finalization time.\n * @public\n */\nexport interface IConditionalJsonDeferredObject extends IConditionalJsonKeyResult {\n  value: JsonValue;\n}\n\n/**\n * Configuration options for the {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.\n * @public\n */\nexport interface IConditionalJsonRuleOptions extends Partial<IJsonEditorOptions> {\n  /**\n   * If true (default) then properties with unconditional names\n   * (which start with !) are flattened.\n   */\n  flattenUnconditionalValues?: boolean;\n}\n\n/**\n * The {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule} evaluates\n * properties with conditional keys, omitting non-matching keys and merging keys that match,\n * or default keys only if no other keys match.\n *\n * The default syntax for a conditional key is:\n *    \"?value1=value2\" - matches if value1 and value2 are the same, is ignored otherwise.\n *    \"?value\" - matches if value is a non-empty, non-whitespace string. Is ignored otherwise.\n *    \"?default\" - matches only if no other conditional blocks in the same object were matched.\n * @public\n */\nexport class ConditionalJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Stored fully-resolved {@link Editor.Rules.IConditionalJsonRuleOptions | options} for this\n   * rule.\n   * @public\n   */\n  protected _options?: IConditionalJsonRuleOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}\n   * used for this rule.\n   */\n  public constructor(options?: IConditionalJsonRuleOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}\n   * used for this rule.\n   */\n  public static create(options?: IConditionalJsonRuleOptions): Result<ConditionalJsonEditorRule> {\n    return captureResult(() => new ConditionalJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property for conditional application.\n   * @param key - The key of the property to be considered\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns Returns `Success` with detail `'deferred'` and a\n   * {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject}.\n   * for a matching, default or unconditional key. Returns `Failure` with detail `'ignore'` for\n   * a non-matching conditional, or with detail `'error'` if an error occurs. Otherwise\n   * fails with detail `'inapplicable'`.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    const result = this._tryParseCondition(key, state).onSuccess((deferred) => {\n      if (isJsonObject(value)) {\n        const rtrn: IConditionalJsonDeferredObject = { ...deferred, value };\n        return succeedWithDetail(rtrn, 'deferred');\n      }\n      return failWithDetail<JsonObject, JsonPropertyEditFailureReason>(\n        `${key}: conditional body must be object`,\n        'error'\n      );\n    });\n\n    if (result.isFailure() && result.detail === 'error') {\n      return state.failValidation('invalidPropertyName', result.message, this._options?.validation);\n    }\n\n    return result;\n  }\n\n  /**\n   * Finalizes any deferred conditional properties. If the only deferred property is\n   * default, that property is emitted. Otherwise all matching properties are emitted.\n   * @param finalized - The deferred properties to be considered for merge.\n   * @param __state - The {@link Editor.JsonEditorState | editor state} for the object\n   * being edited.\n   */\n  public finalizeProperties(\n    finalized: JsonObject[],\n    __state: JsonEditorState\n  ): DetailedResult<JsonObject[], JsonEditFailureReason> {\n    let toMerge = finalized;\n    if (finalized.length > 1) {\n      if (finalized.find((o) => o.matchType === 'match') !== undefined) {\n        toMerge = finalized.filter((o) => o.matchType === 'match' || o.matchType === 'unconditional');\n      }\n    }\n    return succeedWithDetail(toMerge.map((o) => o.value).filter(isJsonObject), 'edited');\n  }\n\n  /**\n   * Determines if a given property key is conditional. Derived classes can override this\n   * method to use a different format for conditional properties.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'deferred'` and a\n   * {@link Editor.Rules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the\n   * match for a default or matching conditional property.  Returns `Failure` with detail `'ignore'`\n   * for a non-matching conditional property. Fails with detail `'error'` if an error occurs\n   * or with detail `'inapplicable'` if the key does not represent a conditional property.\n   * @public\n   */\n  protected _tryParseCondition(\n    key: string,\n    state: JsonEditorState\n  ): DetailedResult<IConditionalJsonKeyResult, JsonPropertyEditFailureReason> {\n    if (key.startsWith('?')) {\n      // ignore everything after any #\n      key = key.split('#')[0].trim();\n\n      if (key === '?default') {\n        return succeedWithDetail({ matchType: 'default' }, 'deferred');\n      }\n\n      const parts = key.substring(1).split(/(=|>=|<=|>|<|!=)/);\n      if (parts.length === 3) {\n        if (!this._compare(parts[0].trim(), parts[2].trim(), parts[1])) {\n          return failWithDetail(`Condition ${key} does not match`, 'ignore');\n        }\n        return succeedWithDetail({ matchType: 'match' }, 'deferred');\n      } else if (parts.length === 1) {\n        if (parts[0].trim().length === 0) {\n          return failWithDetail(`Condition ${key} does not match`, 'ignore');\n        }\n        return succeedWithDetail({ matchType: 'match' }, 'deferred');\n      }\n      const message = `Malformed condition token ${key}`;\n      return state.failValidation('invalidPropertyName', message, this._options?.validation);\n    } else if (this._options?.flattenUnconditionalValues !== false && key.startsWith('!')) {\n      return succeedWithDetail({ matchType: 'unconditional' }, 'deferred');\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Compares two strings using a supplied operator.\n   * @param left - The first string to be compared.\n   * @param right - The second string to be compared.\n   * @param operator - The operator to be applied.\n   * @returns `true` if the condition is met, `false` otherwise.\n   * @internal\n   */\n  protected _compare(left: string, right: string, operator: string): boolean {\n    switch (operator) {\n      case '=':\n        return left === right;\n      case '>':\n        return left > right;\n      case '<':\n        return left < right;\n      case '>=':\n        return left >= right;\n      case '<=':\n        return left <= right;\n      case '!=':\n        return left !== right;\n    }\n    /* c8 ignore next 2 - unreachable */\n    return false;\n  }\n}\n"]}
+{"version":3,"file":"conditional.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/conditional.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,oDAAwE;AACxE,4CAAyG;AAEzG,sDAAuD;AAkCvD;;;;;;;;;;GAUG;AACH,MAAa,yBAA0B,SAAQ,mCAAkB;IAQ/D;;;;OAIG;IACH,YAAmB,OAAqC;QACtD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,OAAqC;QACxD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;;QAEtB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACxE,IAAI,IAAA,2BAAY,EAAC,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,mCAAwC,QAAQ,KAAE,KAAK,GAAE,CAAC;gBACpE,OAAO,IAAA,4BAAiB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,IAAA,yBAAc,EACnB,GAAG,GAAG,mCAAmC,EACzC,OAAO,CACR,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;QAChG,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,kBAAkB,CACvB,SAAuB,EACvB,OAAwB;QAExB,IAAI,OAAO,GAAG,SAAS,CAAC;QACxB,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;gBACjE,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,eAAe,CAAC,CAAC;YAChG,CAAC;QACH,CAAC;QACD,OAAO,IAAA,4BAAiB,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,2BAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;OAWG;IACO,kBAAkB,CAC1B,GAAW,EACX,KAAsB;;QAEtB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,gCAAgC;YAChC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAE/B,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;gBACvB,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;YACjE,CAAC;YAED,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACzD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC/D,OAAO,IAAA,yBAAc,EAAC,aAAa,GAAG,iBAAiB,EAAE,QAAQ,CAAC,CAAC;gBACrE,CAAC;gBACD,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;YAC/D,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,IAAA,yBAAc,EAAC,aAAa,GAAG,iBAAiB,EAAE,QAAQ,CAAC,CAAC;gBACrE,CAAC;gBACD,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;YAC/D,CAAC;YACD,MAAM,OAAO,GAAG,6BAA6B,GAAG,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;QACzF,CAAC;aAAM,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,0BAA0B,MAAK,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACtF,OAAO,IAAA,4BAAiB,EAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,UAAU,CAAC,CAAC;QACvE,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACO,QAAQ,CAAC,IAAY,EAAE,KAAa,EAAE,QAAgB;QAC9D,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,GAAG;gBACN,OAAO,IAAI,KAAK,KAAK,CAAC;YACxB,KAAK,GAAG;gBACN,OAAO,IAAI,GAAG,KAAK,CAAC;YACtB,KAAK,GAAG;gBACN,OAAO,IAAI,GAAG,KAAK,CAAC;YACtB,KAAK,IAAI;gBACP,OAAO,IAAI,IAAI,KAAK,CAAC;YACvB,KAAK,IAAI;gBACP,OAAO,IAAI,IAAI,KAAK,CAAC;YACvB,KAAK,IAAI;gBACP,OAAO,IAAI,KAAK,KAAK,CAAC;QAC1B,CAAC;QACD,oCAAoC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAvJD,8DAuJC","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 { JsonObject, JsonValue, isJsonObject } from '@fgv/ts-json-base';\nimport { DetailedResult, Result, captureResult, failWithDetail, succeedWithDetail } from '@fgv/ts-utils';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\n/**\n * Returned by {@link Editor.Rules.ConditionalJsonEditorRule._tryParseCondition | ConditionalJsonEditorRule._tryParseCondition}\n * to indicate whether a successful match was due to a matching condition or a default value.\n * @public\n */\nexport interface IConditionalJsonKeyResult extends JsonObject {\n  matchType: 'default' | 'match' | 'unconditional';\n}\n\n/**\n * On a successful match, the {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}\n * stores a {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject} describing the\n * matching result, to be resolved at finalization time.\n * @public\n */\nexport interface IConditionalJsonDeferredObject extends IConditionalJsonKeyResult {\n  value: JsonValue;\n}\n\n/**\n * Configuration options for the {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.\n * @public\n */\nexport interface IConditionalJsonRuleOptions extends Partial<IJsonEditorOptions> {\n  /**\n   * If true (default) then properties with unconditional names\n   * (which start with !) are flattened.\n   */\n  flattenUnconditionalValues?: boolean;\n}\n\n/**\n * The {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule} evaluates\n * properties with conditional keys, omitting non-matching keys and merging keys that match,\n * or default keys only if no other keys match.\n *\n * The default syntax for a conditional key is:\n *    \"?value1=value2\" - matches if value1 and value2 are the same, is ignored otherwise.\n *    \"?value\" - matches if value is a non-empty, non-whitespace string. Is ignored otherwise.\n *    \"?default\" - matches only if no other conditional blocks in the same object were matched.\n * @public\n */\nexport class ConditionalJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Stored fully-resolved {@link Editor.Rules.IConditionalJsonRuleOptions | options} for this\n   * rule.\n   * @public\n   */\n  protected _options?: IConditionalJsonRuleOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}\n   * used for this rule.\n   */\n  public constructor(options?: IConditionalJsonRuleOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.ConditionalJsonEditorRule | ConditionalJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.IConditionalJsonRuleOptions | configuration options}\n   * used for this rule.\n   */\n  public static create(options?: IConditionalJsonRuleOptions): Result<ConditionalJsonEditorRule> {\n    return captureResult(() => new ConditionalJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property for conditional application.\n   * @param key - The key of the property to be considered\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns Returns `Success` with detail `'deferred'` and a\n   * {@link Editor.Rules.IConditionalJsonDeferredObject | IConditionalJsonDeferredObject}.\n   * for a matching, default or unconditional key. Returns `Failure` with detail `'ignore'` for\n   * a non-matching conditional, or with detail `'error'` if an error occurs. Otherwise\n   * fails with detail `'inapplicable'`.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    const result = this._tryParseCondition(key, state).onSuccess((deferred) => {\n      if (isJsonObject(value)) {\n        const rtrn: IConditionalJsonDeferredObject = { ...deferred, value };\n        return succeedWithDetail(rtrn, 'deferred');\n      }\n      return failWithDetail<JsonObject, JsonPropertyEditFailureReason>(\n        `${key}: conditional body must be object`,\n        'error'\n      );\n    });\n\n    if (result.isFailure() && result.detail === 'error') {\n      return state.failValidation('invalidPropertyName', result.message, this._options?.validation);\n    }\n\n    return result;\n  }\n\n  /**\n   * Finalizes any deferred conditional properties. If the only deferred property is\n   * default, that property is emitted. Otherwise all matching properties are emitted.\n   * @param finalized - The deferred properties to be considered for merge.\n   * @param __state - The {@link Editor.JsonEditorState | editor state} for the object\n   * being edited.\n   */\n  public finalizeProperties(\n    finalized: JsonObject[],\n    __state: JsonEditorState\n  ): DetailedResult<JsonObject[], JsonEditFailureReason> {\n    let toMerge = finalized;\n    if (finalized.length > 1) {\n      if (finalized.find((o) => o.matchType === 'match') !== undefined) {\n        toMerge = finalized.filter((o) => o.matchType === 'match' || o.matchType === 'unconditional');\n      }\n    }\n    return succeedWithDetail(toMerge.map((o) => o.value).filter(isJsonObject), 'edited');\n  }\n\n  /**\n   * Determines if a given property key is conditional. Derived classes can override this\n   * method to use a different format for conditional properties.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'deferred'` and a\n   * {@link Editor.Rules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the\n   * match for a default or matching conditional property.  Returns `Failure` with detail `'ignore'`\n   * for a non-matching conditional property. Fails with detail `'error'` if an error occurs\n   * or with detail `'inapplicable'` if the key does not represent a conditional property.\n   * @public\n   */\n  protected _tryParseCondition(\n    key: string,\n    state: JsonEditorState\n  ): DetailedResult<IConditionalJsonKeyResult, JsonPropertyEditFailureReason> {\n    if (key.startsWith('?')) {\n      // ignore everything after any #\n      key = key.split('#')[0].trim();\n\n      if (key === '?default') {\n        return succeedWithDetail({ matchType: 'default' }, 'deferred');\n      }\n\n      const parts = key.substring(1).split(/(=|>=|<=|>|<|!=)/);\n      if (parts.length === 3) {\n        if (!this._compare(parts[0].trim(), parts[2].trim(), parts[1])) {\n          return failWithDetail(`Condition ${key} does not match`, 'ignore');\n        }\n        return succeedWithDetail({ matchType: 'match' }, 'deferred');\n      } else if (parts.length === 1) {\n        if (parts[0].trim().length === 0) {\n          return failWithDetail(`Condition ${key} does not match`, 'ignore');\n        }\n        return succeedWithDetail({ matchType: 'match' }, 'deferred');\n      }\n      const message = `Malformed condition token ${key}`;\n      return state.failValidation('invalidPropertyName', message, this._options?.validation);\n    } else if (this._options?.flattenUnconditionalValues !== false && key.startsWith('!')) {\n      return succeedWithDetail({ matchType: 'unconditional' }, 'deferred');\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Compares two strings using a supplied operator.\n   * @param left - The first string to be compared.\n   * @param right - The second string to be compared.\n   * @param operator - The operator to be applied.\n   * @returns `true` if the condition is met, `false` otherwise.\n   * @internal\n   */\n  protected _compare(left: string, right: string, operator: string): boolean {\n    switch (operator) {\n      case '=':\n        return left === right;\n      case '>':\n        return left > right;\n      case '<':\n        return left < right;\n      case '>=':\n        return left >= right;\n      case '<=':\n        return left <= right;\n      case '!=':\n        return left !== right;\n    }\n    /* c8 ignore next 2 - unreachable */\n    return false;\n  }\n}\n"]}

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

@@ -1,6 +1,6 @@
+import { JsonObject, JsonValue } from '@fgv/ts-json-base';
 import { DetailedResult, Result } from '@fgv/ts-utils';
 import { IJsonContext, VariableValue } from '../../context';
-import { JsonObject, JsonValue } from '../../json';
 import { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';
 import { JsonEditorRuleBase } from '../jsonEditorRule';
 import { JsonEditorState } from '../jsonEditorState';

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

@@ -1 +1 @@
-{"version":3,"file":"multivalue.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/multivalue.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,cAAc,EACd,MAAM,EAMP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAErG,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAElC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,wBAAyB,SAAQ,kBAAkB;IAC9D;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAExC;;;OAGG;gBACgB,OAAO,CAAC,EAAE,kBAAkB;IAK/C;;;OAGG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC,wBAAwB,CAAC;IAIpF;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IA+B5D;;;;;;;OAOG;IACH,SAAS,CAAC,cAAc,CACtB,KAAK,EAAE,eAAe,EACtB,GAAG,MAAM,EAAE,aAAa,EAAE,GACzB,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC;IAInC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,SAAS,CACjB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,wBAAwB,EAAE,qBAAqB,CAAC;CA2BnE"}
+{"version":3,"file":"multivalue.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/multivalue.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EACL,cAAc,EACd,MAAM,EAMP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAErG,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAElC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,wBAAyB,SAAQ,kBAAkB;IAC9D;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAExC;;;OAGG;gBACgB,OAAO,CAAC,EAAE,kBAAkB;IAK/C;;;OAGG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC,wBAAwB,CAAC;IAIpF;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IA+B5D;;;;;;;OAOG;IACH,SAAS,CAAC,cAAc,CACtB,KAAK,EAAE,eAAe,EACtB,GAAG,MAAM,EAAE,aAAa,EAAE,GACzB,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC;IAInC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,SAAS,CACjB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,wBAAwB,EAAE,qBAAqB,CAAC;CA2BnE"}

package/lib/packlets/editor/rules/multivalue.js.map

@@ -1 +1 @@
-{"version":3,"file":"multivalue.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/multivalue.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAQuB;AAKvB,sDAAuD;AAiCvD;;;;;;;;;;;GAWG;AACH,MAAa,wBAAyB,SAAQ,mCAAkB;IAQ9D;;;OAGG;IACH,YAAmB,OAA4B;QAC7C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,OAA4B;QAC/C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;QAEtB,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5D,OAAO,IAAA,qBAAU,EACf,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;gBAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;oBAChF,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;wBACzD,IAAI,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;wBAClB,OAAO,IAAA,4BAAiB,EAAC,MAAM,CAAC,CAAC;oBACnC,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,EACF,IAAI,CACL;iBACE,SAAS,CAAC,GAAG,EAAE;gBACd,IAAI,KAAK,CAAC,OAAO,EAAE;oBACjB,MAAM,SAAS,GAAe,EAAE,CAAC;oBACjC,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBACpE,OAAO,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;iBAC3B;gBACD,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC,CAAC;iBACD,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE;YACnD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;SACpE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACO,cAAc,CACtB,KAAsB,EACtB,GAAG,MAAuB;;QAE1B,OAAO,KAAK,CAAC,aAAa,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACO,SAAS,CACjB,KAAa,EACb,KAAsB;;QAEtB,IAAI,KAAK,GAAa,EAAE,CAAC;QACzB,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAC1B,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACxC,OAAO,GAAG,IAAI,CAAC;SAChB;aAAM,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAChC,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,KAAK,CAAC;SACjB;aAAM;YACL,OAAO,IAAA,yBAAc,EAAC,KAAK,EAAE,cAAc,CAAC,CAAC;SAC9C;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,MAAM,OAAO,GAAG,mCAAmC,KAAK,EAAE,CAAC;YAC3D,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;SACxF;QAED,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC3B,OAAO,IAAA,yBAAc,EAAC,qBAAqB,EAAE,cAAc,CAAC,CAAC;SAC9D;QAED,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,IAAA,4BAAiB,EAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AA7HD,4DA6HC","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  allSucceed,\n  captureResult,\n  failWithDetail,\n  succeed,\n  succeedWithDetail\n} from '@fgv/ts-utils';\nimport { IJsonContext, VariableValue } from '../../context';\nimport { JsonObject, JsonValue } from '../../json';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\n\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\n/**\n * Represents the parts of a multi-value property key.\n * @public\n */\nexport interface IMultiValuePropertyParts {\n  /**\n   * The original matched token.\n   */\n  readonly token: string;\n\n  /**\n   * The name of the variable used to project each possible\n   * property value into the child values or objects being\n   * resolved.\n   */\n  readonly propertyVariable: string;\n\n  /**\n   * The set of property values to be expanded.\n   */\n  readonly propertyValues: string[];\n\n  /**\n   * If `true`, the resolved values are added as an array\n   * with the name of the {@link Editor.Rules.IMultiValuePropertyParts.propertyVariable | propertyVariable}.\n   * If false, values are added as individual properties with names that correspond the value.\n   */\n  readonly asArray: boolean;\n}\n\n/**\n * The {@link Editor.Rules.MultiValueJsonEditorRule | Multi-Value JSON editor rule}\n * expands matching keys multiple times, projecting the value into the template\n * context for any child objects rendered by the rule.\n *\n * The default syntax for a multi-value key is:\n *  \"[[var]]=value1,value2,value3\"\n * Where \"var\" is the name of the variable that will be passed to\n * child template resolution, and \"value1,value2,value3\" is a\n * comma-separated list of values to be expanded.\n * @public\n */\nexport class MultiValueJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Stored fully-resolved {@link Editor.IJsonEditorOptions | editor options}\n   * for this rule.\n   * @public\n   */\n  protected _options?: IJsonEditorOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.\n   */\n  public constructor(options?: IJsonEditorOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.\n   */\n  public static create(options?: IJsonEditorOptions): Result<MultiValueJsonEditorRule> {\n    return captureResult(() => new MultiValueJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property for multi-value expansion.\n   * @param key - The key of the property to be considered\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with an object containing the fully-resolved child values to be merged for\n   * matching multi-value property. Returns `Failure` with detail `'error'` if an error occurs or\n   * with detail `'inapplicable'` if the property key is not a conditional property.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    const json: JsonObject = {};\n    const result = this._tryParse(key, state).onSuccess((parts) => {\n      return allSucceed(\n        parts.propertyValues.map((pv) => {\n          return this._deriveContext(state, [parts.propertyVariable, pv]).onSuccess((ctx) => {\n            return state.editor.clone(value, ctx).onSuccess((cloned) => {\n              json[pv] = cloned;\n              return succeedWithDetail(cloned);\n            });\n          });\n        }),\n        json\n      )\n        .onSuccess(() => {\n          if (parts.asArray) {\n            const arrayRtrn: JsonObject = {};\n            arrayRtrn[parts.propertyVariable] = Array.from(Object.values(json));\n            return succeed(arrayRtrn);\n          }\n          return succeed(json);\n        })\n        .withFailureDetail('error');\n    });\n\n    if (result.isFailure() && result.detail === 'error') {\n      return state.failValidation('invalidPropertyName', result.message);\n    }\n    return result;\n  }\n\n  /**\n   * Extends the {@link IJsonContext | current context} with a supplied state and values.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @param values - An array of {@link VariableValue | VariableValue} to be added to the\n   * context.\n   * @returns The extended {@link IJsonContext | context}.\n   * @public\n   */\n  protected _deriveContext(\n    state: JsonEditorState,\n    ...values: VariableValue[]\n  ): Result<IJsonContext | undefined> {\n    return state.extendContext(this._options?.context, { vars: values });\n  }\n\n  /**\n   * Determines if a given property key is multi-value. Derived classes can override this\n   * method to use a different format for multi-value properties.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'deferred'` and an\n   * {@link Editor.Rules.IMultiValuePropertyParts | IMultiValuePropertyParts}\n   * describing the match for matching multi-value property.  Returns `Failure` with detail `'error'` if an error occurs\n   * or with detail `'inapplicable'` if the key does not represent a multi-value property.\n   * @public\n   */\n  protected _tryParse(\n    token: string,\n    state: JsonEditorState\n  ): DetailedResult<IMultiValuePropertyParts, JsonEditFailureReason> {\n    let parts: string[] = [];\n    let asArray = false;\n\n    if (token.startsWith('[[')) {\n      parts = token.substring(2).split(']]=');\n      asArray = true;\n    } else if (token.startsWith('*')) {\n      parts = token.substring(1).split('=');\n      asArray = false;\n    } else {\n      return failWithDetail(token, 'inapplicable');\n    }\n\n    if (parts.length !== 2) {\n      const message = `Malformed multi-value property: ${token}`;\n      return state.failValidation('invalidPropertyName', message, this._options?.validation);\n    }\n\n    if (parts[1].includes('{{')) {\n      return failWithDetail('unresolved template', 'inapplicable');\n    }\n\n    const propertyVariable = parts[0];\n    const propertyValues = parts[1].split(',');\n    return succeedWithDetail({ token, propertyVariable, propertyValues, asArray });\n  }\n}\n"]}
+{"version":3,"file":"multivalue.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/multivalue.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAGH,4CAQuB;AAIvB,sDAAuD;AAiCvD;;;;;;;;;;;GAWG;AACH,MAAa,wBAAyB,SAAQ,mCAAkB;IAQ9D;;;OAGG;IACH,YAAmB,OAA4B;QAC7C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,OAA4B;QAC/C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;QAEtB,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5D,OAAO,IAAA,qBAAU,EACf,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;gBAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;oBAChF,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;wBACzD,IAAI,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;wBAClB,OAAO,IAAA,4BAAiB,EAAC,MAAM,CAAC,CAAC;oBACnC,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,EACF,IAAI,CACL;iBACE,SAAS,CAAC,GAAG,EAAE;gBACd,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBAClB,MAAM,SAAS,GAAe,EAAE,CAAC;oBACjC,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBACpE,OAAO,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;gBAC5B,CAAC;gBACD,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC,CAAC;iBACD,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACO,cAAc,CACtB,KAAsB,EACtB,GAAG,MAAuB;;QAE1B,OAAO,KAAK,CAAC,aAAa,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACO,SAAS,CACjB,KAAa,EACb,KAAsB;;QAEtB,IAAI,KAAK,GAAa,EAAE,CAAC;QACzB,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACxC,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,KAAK,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,IAAA,yBAAc,EAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,mCAAmC,KAAK,EAAE,CAAC;YAC3D,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;QACzF,CAAC;QAED,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAA,yBAAc,EAAC,qBAAqB,EAAE,cAAc,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,IAAA,4BAAiB,EAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AA7HD,4DA6HC","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 { JsonObject, JsonValue } from '@fgv/ts-json-base';\nimport {\n  DetailedResult,\n  Result,\n  allSucceed,\n  captureResult,\n  failWithDetail,\n  succeed,\n  succeedWithDetail\n} from '@fgv/ts-utils';\nimport { IJsonContext, VariableValue } from '../../context';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\n\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\n/**\n * Represents the parts of a multi-value property key.\n * @public\n */\nexport interface IMultiValuePropertyParts {\n  /**\n   * The original matched token.\n   */\n  readonly token: string;\n\n  /**\n   * The name of the variable used to project each possible\n   * property value into the child values or objects being\n   * resolved.\n   */\n  readonly propertyVariable: string;\n\n  /**\n   * The set of property values to be expanded.\n   */\n  readonly propertyValues: string[];\n\n  /**\n   * If `true`, the resolved values are added as an array\n   * with the name of the {@link Editor.Rules.IMultiValuePropertyParts.propertyVariable | propertyVariable}.\n   * If false, values are added as individual properties with names that correspond the value.\n   */\n  readonly asArray: boolean;\n}\n\n/**\n * The {@link Editor.Rules.MultiValueJsonEditorRule | Multi-Value JSON editor rule}\n * expands matching keys multiple times, projecting the value into the template\n * context for any child objects rendered by the rule.\n *\n * The default syntax for a multi-value key is:\n *  \"[[var]]=value1,value2,value3\"\n * Where \"var\" is the name of the variable that will be passed to\n * child template resolution, and \"value1,value2,value3\" is a\n * comma-separated list of values to be expanded.\n * @public\n */\nexport class MultiValueJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Stored fully-resolved {@link Editor.IJsonEditorOptions | editor options}\n   * for this rule.\n   * @public\n   */\n  protected _options?: IJsonEditorOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.\n   */\n  public constructor(options?: IJsonEditorOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.\n   */\n  public static create(options?: IJsonEditorOptions): Result<MultiValueJsonEditorRule> {\n    return captureResult(() => new MultiValueJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property for multi-value expansion.\n   * @param key - The key of the property to be considered\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with an object containing the fully-resolved child values to be merged for\n   * matching multi-value property. Returns `Failure` with detail `'error'` if an error occurs or\n   * with detail `'inapplicable'` if the property key is not a conditional property.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    const json: JsonObject = {};\n    const result = this._tryParse(key, state).onSuccess((parts) => {\n      return allSucceed(\n        parts.propertyValues.map((pv) => {\n          return this._deriveContext(state, [parts.propertyVariable, pv]).onSuccess((ctx) => {\n            return state.editor.clone(value, ctx).onSuccess((cloned) => {\n              json[pv] = cloned;\n              return succeedWithDetail(cloned);\n            });\n          });\n        }),\n        json\n      )\n        .onSuccess(() => {\n          if (parts.asArray) {\n            const arrayRtrn: JsonObject = {};\n            arrayRtrn[parts.propertyVariable] = Array.from(Object.values(json));\n            return succeed(arrayRtrn);\n          }\n          return succeed(json);\n        })\n        .withFailureDetail('error');\n    });\n\n    if (result.isFailure() && result.detail === 'error') {\n      return state.failValidation('invalidPropertyName', result.message);\n    }\n    return result;\n  }\n\n  /**\n   * Extends the {@link IJsonContext | current context} with a supplied state and values.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @param values - An array of {@link VariableValue | VariableValue} to be added to the\n   * context.\n   * @returns The extended {@link IJsonContext | context}.\n   * @public\n   */\n  protected _deriveContext(\n    state: JsonEditorState,\n    ...values: VariableValue[]\n  ): Result<IJsonContext | undefined> {\n    return state.extendContext(this._options?.context, { vars: values });\n  }\n\n  /**\n   * Determines if a given property key is multi-value. Derived classes can override this\n   * method to use a different format for multi-value properties.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'deferred'` and an\n   * {@link Editor.Rules.IMultiValuePropertyParts | IMultiValuePropertyParts}\n   * describing the match for matching multi-value property.  Returns `Failure` with detail `'error'` if an error occurs\n   * or with detail `'inapplicable'` if the key does not represent a multi-value property.\n   * @public\n   */\n  protected _tryParse(\n    token: string,\n    state: JsonEditorState\n  ): DetailedResult<IMultiValuePropertyParts, JsonEditFailureReason> {\n    let parts: string[] = [];\n    let asArray = false;\n\n    if (token.startsWith('[[')) {\n      parts = token.substring(2).split(']]=');\n      asArray = true;\n    } else if (token.startsWith('*')) {\n      parts = token.substring(1).split('=');\n      asArray = false;\n    } else {\n      return failWithDetail(token, 'inapplicable');\n    }\n\n    if (parts.length !== 2) {\n      const message = `Malformed multi-value property: ${token}`;\n      return state.failValidation('invalidPropertyName', message, this._options?.validation);\n    }\n\n    if (parts[1].includes('{{')) {\n      return failWithDetail('unresolved template', 'inapplicable');\n    }\n\n    const propertyVariable = parts[0];\n    const propertyValues = parts[1].split(',');\n    return succeedWithDetail({ token, propertyVariable, propertyValues, asArray });\n  }\n}\n"]}

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

@@ -1,6 +1,6 @@
+import { JsonObject, JsonValue } from '@fgv/ts-json-base';
 import { DetailedResult, Result } from '@fgv/ts-utils';
 import { IJsonContext } from '../../context';
-import { JsonObject, JsonValue } from '../../json';
 import { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';
 import { JsonEditorRuleBase } from '../jsonEditorRule';
 import { JsonEditorState } from '../jsonEditorState';

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

@@ -1 +1 @@
-{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/references.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,cAAc,EACd,MAAM,EAKP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAgC,MAAM,YAAY,CAAC;AACjF,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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;IAC7D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAExC;;;OAGG;gBACgB,OAAO,CAAC,EAAE,kBAAkB;IAK/C;;;OAGG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IAyC5D;;;;OAIG;IACI,SAAS,CACd,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAiBnD;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,SAAS,GAAG,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC;CASxG"}
+{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/references.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAgC,MAAM,mBAAmB,CAAC;AACxF,OAAO,EACL,cAAc,EACd,MAAM,EAKP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;IAC7D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAExC;;;OAGG;gBACgB,OAAO,CAAC,EAAE,kBAAkB;IAK/C;;;OAGG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IAyC5D;;;;OAIG;IACI,SAAS,CACd,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAiBnD;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,SAAS,GAAG,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC;CASxG"}

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

@@ -22,8 +22,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferenceJsonEditorRule = void 0;
+const ts_json_base_1 = require("@fgv/ts-json-base");
 const ts_utils_1 = require("@fgv/ts-utils");
-const json_1 = require("../../json");
 const jsonEditorRule_1 = require("../jsonEditorRule");
 /**
  * The {@link Editor.Rules.ReferenceJsonEditorRule | Reference JSON editor rule} replaces property
@@ -95,7 +95,7 @@ class ReferenceJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
                     if (typeof value !== 'string' || value === 'default') {
                         return (0, ts_utils_1.succeedWithDetail)(objResult.value, 'edited');
                     }
-                    const pickResult = (0, json_1.pickJsonObject)(objResult.value, value);
+                    const pickResult = (0, ts_json_base_1.pickJsonObject)(objResult.value, value);
                     if (pickResult.isFailure()) {
                         const message = `${key}: ${pickResult.message}`;
                         return state.failValidation('invalidPropertyName', message, validation);
@@ -146,7 +146,7 @@ class ReferenceJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     _extendContext(state, supplied) {
         var _a;
         const add = {};
-        if ((0, json_1.isJsonObject)(supplied)) {
+        if ((0, ts_json_base_1.isJsonObject)(supplied)) {
             add.vars = Object.entries(supplied);
         }
         else if (typeof supplied !== 'string') {

package/lib/packlets/editor/rules/references.js.map

@@ -1 +1 @@
-{"version":3,"file":"references.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/references.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAOuB;AAEvB,qCAAiF;AAEjF,sDAAuD;AAGvD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,uBAAwB,SAAQ,mCAAkB;IAO7D;;;OAGG;IACH,YAAmB,OAA4B;QAC7C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,OAA4B;QAC/C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;;QAEtB,sBAAsB;QACtB,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC;QAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;QACnD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC,GAAG,CAAC,EAAE;YAClB,6DAA6D;YAC7D,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE;gBAC3B,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;aAC3B;iBAAM;gBACL,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBACjD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;aACzE;YAED,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxD,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE;gBAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC/D,kDAAkD;gBAClD,oBAAoB;gBACpB,IAAI,SAAS,CAAC,SAAS,EAAE,EAAE;oBACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS,EAAE;wBACpD,OAAO,IAAA,4BAAiB,EAAoC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;qBACxF;oBACD,MAAM,UAAU,GAAG,IAAA,qBAAc,EAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBAC1D,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE;wBAC1B,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;wBAChD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;qBACzE;oBACD,OAAO,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;iBACxC;qBAAM,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE;oBACzC,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;oBAC/C,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;iBACzE;aACF;iBAAM;gBACL,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;gBACnD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;aACzE;SACF;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,SAAS,CACd,KAAgB,EAChB,KAAsB;;QAEtB,oBAAoB;QACpB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACrC,oBAAoB;YACpB,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;YACzD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACjD,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;gBACtB,OAAO,IAAA,4BAAiB,EAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;aAClD;iBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE;gBACpC,OAAO,KAAK,CAAC,cAAc,CAAC,sBAAsB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;aAChG;SACF;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACO,cAAc,CAAC,KAAsB,EAAE,QAAmB;;QAClE,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,IAAI,IAAA,mBAAY,EAAC,QAAQ,CAAC,EAAE;YAC1B,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SACrC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YACvC,OAAO,IAAA,eAAI,EAAC,sCAAsC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SAChF;QACD,OAAO,KAAK,CAAC,aAAa,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1D,CAAC;CACF;AAvHD,0DAuHC","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  succeedWithDetail\n} from '@fgv/ts-utils';\nimport { IJsonContext } from '../../context';\nimport { JsonObject, JsonValue, isJsonObject, pickJsonObject } from '../../json';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\n/**\n * The {@link Editor.Rules.ReferenceJsonEditorRule | Reference JSON editor rule} replaces property\n * keys or values that match some known object with a copy of that referenced object, formatted\n * according to the current context.\n *\n * A property key is matched if it matches any known referenced value.\n * - If the value of the matched key is `'default'`, then the entire object is formatted\n *   with the current context, flattened and merged into the current object.\n * - If the value of the matched key is some other string, then the entire\n *   object is formatted with the current context, and the child of the resulting\n *   object at the specified path is flattened and merged into the current object.\n * - If the value of the matched key is an object, then the entire object is\n *   formatted with the current context extended to include any properties of\n *   that object, flattened, and merged into the current object.\n * - It is an error if the referenced value is not an object.\n *\n * Any property, array or literal value is matched if it matches any known\n * value reference. The referenced value is replaced by the referenced\n * value, formatted using the current editor context.\n * @public\n */\nexport class ReferenceJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Stored fully-resolved {@link Editor.IJsonEditorOptions | editor options} for this rule.\n   * @public\n   */\n  protected _options?: IJsonEditorOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.\n   */\n  public constructor(options?: IJsonEditorOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.\n   */\n  public static create(options?: IJsonEditorOptions): Result<ReferenceJsonEditorRule> {\n    return captureResult(() => new ReferenceJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property for reference expansion.\n   * @param key - The key of the property to be considered.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns If the reference is successful, returns `Success` with a {@link JsonObject | JsonObject}\n   * to be flattened and merged into the current object. Returns `Failure` with detail `'inapplicable'`\n   * for non-reference keys or with detail `'error'` if an error occurs.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    /* c8 ignore next 2 */\n    const validation = this._options?.validation;\n    const refs = state.getRefs(this._options?.context);\n    if (refs?.has(key)) {\n      // need to apply any rules to the value before we evaluate it\n      const cloneResult = state.editor.clone(value, state.context);\n      if (cloneResult.isSuccess()) {\n        value = cloneResult.value;\n      } else {\n        const message = `${key}: ${cloneResult.message}`;\n        return state.failValidation('invalidPropertyName', message, validation);\n      }\n\n      const contextResult = this._extendContext(state, value);\n      if (contextResult.isSuccess()) {\n        const objResult = refs.getJsonObject(key, contextResult.value);\n        // guarded by the has above so should never happen\n        /* c8 ignore else */\n        if (objResult.isSuccess()) {\n          if (typeof value !== 'string' || value === 'default') {\n            return succeedWithDetail<JsonObject, JsonEditFailureReason>(objResult.value, 'edited');\n          }\n          const pickResult = pickJsonObject(objResult.value, value);\n          if (pickResult.isFailure()) {\n            const message = `${key}: ${pickResult.message}`;\n            return state.failValidation('invalidPropertyName', message, validation);\n          }\n          return pickResult.withDetail('edited');\n        } else if (objResult.detail !== 'unknown') {\n          const message = `${key}: ${objResult.message}`;\n          return state.failValidation('invalidPropertyName', message, validation);\n        }\n      } else {\n        const message = `${key}: ${contextResult.message}`;\n        return state.failValidation('invalidPropertyName', message, validation);\n      }\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Evaluates a property, array or literal value for reference replacement.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   */\n  public editValue(\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonValue, JsonEditFailureReason> {\n    /* c8 ignore next */\n    const refs = state.getRefs(this._options?.context);\n\n    if (refs && typeof value === 'string') {\n      /* c8 ignore next */\n      const context = state.getContext(this._options?.context);\n      const result = refs.getJsonValue(value, context);\n      if (result.isSuccess()) {\n        return succeedWithDetail(result.value, 'edited');\n      } else if (result.detail === 'error') {\n        return state.failValidation('invalidPropertyValue', result.message, this._options?.validation);\n      }\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Gets the template variables to use given the value of some property whose name matched a\n   * resource plus the base template context.\n   * @param state - The {@link Editor.JsonEditorState | editor state} to be extended.\n   * @param supplied - The string or object supplied in the source json.\n   * @internal\n   */\n  protected _extendContext(state: JsonEditorState, supplied: JsonValue): Result<IJsonContext | undefined> {\n    const add: Record<string, unknown> = {};\n    if (isJsonObject(supplied)) {\n      add.vars = Object.entries(supplied);\n    } else if (typeof supplied !== 'string') {\n      return fail(`Invalid template path or context: \"${JSON.stringify(supplied)}\"`);\n    }\n    return state.extendContext(this._options?.context, add);\n  }\n}\n"]}
+{"version":3,"file":"references.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/references.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,oDAAwF;AACxF,4CAOuB;AAGvB,sDAAuD;AAGvD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,uBAAwB,SAAQ,mCAAkB;IAO7D;;;OAGG;IACH,YAAmB,OAA4B;QAC7C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,OAA4B;QAC/C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;;QAEtB,sBAAsB;QACtB,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC;QAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;QACnD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,6DAA6D;YAC7D,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC5B,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBACjD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1E,CAAC;YAED,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxD,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC/D,kDAAkD;gBAClD,oBAAoB;gBACpB,IAAI,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;wBACrD,OAAO,IAAA,4BAAiB,EAAoC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;oBACzF,CAAC;oBACD,MAAM,UAAU,GAAG,IAAA,6BAAc,EAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBAC1D,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC3B,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;wBAChD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;oBAC1E,CAAC;oBACD,OAAO,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC1C,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;oBAC/C,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;gBAC1E,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;gBACnD,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,SAAS,CACd,KAAgB,EAChB,KAAsB;;QAEtB,oBAAoB;QACpB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACtC,oBAAoB;YACpB,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;YACzD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACjD,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,OAAO,IAAA,4BAAiB,EAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACnD,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBACrC,OAAO,KAAK,CAAC,cAAc,CAAC,sBAAsB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;YACjG,CAAC;QACH,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACO,cAAc,CAAC,KAAsB,EAAE,QAAmB;;QAClE,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,IAAI,IAAA,2BAAY,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,IAAA,eAAI,EAAC,sCAAsC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,KAAK,CAAC,aAAa,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1D,CAAC;CACF;AAvHD,0DAuHC","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 { JsonObject, JsonValue, isJsonObject, pickJsonObject } from '@fgv/ts-json-base';\nimport {\n  DetailedResult,\n  Result,\n  captureResult,\n  fail,\n  failWithDetail,\n  succeedWithDetail\n} from '@fgv/ts-utils';\nimport { IJsonContext } from '../../context';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\n/**\n * The {@link Editor.Rules.ReferenceJsonEditorRule | Reference JSON editor rule} replaces property\n * keys or values that match some known object with a copy of that referenced object, formatted\n * according to the current context.\n *\n * A property key is matched if it matches any known referenced value.\n * - If the value of the matched key is `'default'`, then the entire object is formatted\n *   with the current context, flattened and merged into the current object.\n * - If the value of the matched key is some other string, then the entire\n *   object is formatted with the current context, and the child of the resulting\n *   object at the specified path is flattened and merged into the current object.\n * - If the value of the matched key is an object, then the entire object is\n *   formatted with the current context extended to include any properties of\n *   that object, flattened, and merged into the current object.\n * - It is an error if the referenced value is not an object.\n *\n * Any property, array or literal value is matched if it matches any known\n * value reference. The referenced value is replaced by the referenced\n * value, formatted using the current editor context.\n * @public\n */\nexport class ReferenceJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Stored fully-resolved {@link Editor.IJsonEditorOptions | editor options} for this rule.\n   * @public\n   */\n  protected _options?: IJsonEditorOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.\n   */\n  public constructor(options?: IJsonEditorOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.\n   * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.\n   */\n  public static create(options?: IJsonEditorOptions): Result<ReferenceJsonEditorRule> {\n    return captureResult(() => new ReferenceJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property for reference expansion.\n   * @param key - The key of the property to be considered.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns If the reference is successful, returns `Success` with a {@link JsonObject | JsonObject}\n   * to be flattened and merged into the current object. Returns `Failure` with detail `'inapplicable'`\n   * for non-reference keys or with detail `'error'` if an error occurs.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    /* c8 ignore next 2 */\n    const validation = this._options?.validation;\n    const refs = state.getRefs(this._options?.context);\n    if (refs?.has(key)) {\n      // need to apply any rules to the value before we evaluate it\n      const cloneResult = state.editor.clone(value, state.context);\n      if (cloneResult.isSuccess()) {\n        value = cloneResult.value;\n      } else {\n        const message = `${key}: ${cloneResult.message}`;\n        return state.failValidation('invalidPropertyName', message, validation);\n      }\n\n      const contextResult = this._extendContext(state, value);\n      if (contextResult.isSuccess()) {\n        const objResult = refs.getJsonObject(key, contextResult.value);\n        // guarded by the has above so should never happen\n        /* c8 ignore else */\n        if (objResult.isSuccess()) {\n          if (typeof value !== 'string' || value === 'default') {\n            return succeedWithDetail<JsonObject, JsonEditFailureReason>(objResult.value, 'edited');\n          }\n          const pickResult = pickJsonObject(objResult.value, value);\n          if (pickResult.isFailure()) {\n            const message = `${key}: ${pickResult.message}`;\n            return state.failValidation('invalidPropertyName', message, validation);\n          }\n          return pickResult.withDetail('edited');\n        } else if (objResult.detail !== 'unknown') {\n          const message = `${key}: ${objResult.message}`;\n          return state.failValidation('invalidPropertyName', message, validation);\n        }\n      } else {\n        const message = `${key}: ${contextResult.message}`;\n        return state.failValidation('invalidPropertyName', message, validation);\n      }\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Evaluates a property, array or literal value for reference replacement.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   */\n  public editValue(\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonValue, JsonEditFailureReason> {\n    /* c8 ignore next */\n    const refs = state.getRefs(this._options?.context);\n\n    if (refs && typeof value === 'string') {\n      /* c8 ignore next */\n      const context = state.getContext(this._options?.context);\n      const result = refs.getJsonValue(value, context);\n      if (result.isSuccess()) {\n        return succeedWithDetail(result.value, 'edited');\n      } else if (result.detail === 'error') {\n        return state.failValidation('invalidPropertyValue', result.message, this._options?.validation);\n      }\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Gets the template variables to use given the value of some property whose name matched a\n   * resource plus the base template context.\n   * @param state - The {@link Editor.JsonEditorState | editor state} to be extended.\n   * @param supplied - The string or object supplied in the source json.\n   * @internal\n   */\n  protected _extendContext(state: JsonEditorState, supplied: JsonValue): Result<IJsonContext | undefined> {\n    const add: Record<string, unknown> = {};\n    if (isJsonObject(supplied)) {\n      add.vars = Object.entries(supplied);\n    } else if (typeof supplied !== 'string') {\n      return fail(`Invalid template path or context: \"${JSON.stringify(supplied)}\"`);\n    }\n    return state.extendContext(this._options?.context, add);\n  }\n}\n"]}

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

@@ -1,5 +1,5 @@
+import { JsonObject, JsonValue } from '@fgv/ts-json-base';
 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';

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

@@ -1 +1 @@
-{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/templates.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoD,MAAM,eAAe,CAAC;AACzG,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACnD,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;AAIrD;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,OAAO,CAAC,kBAAkB,CAAC;IAC5E;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;IAC7D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IAE/C;;;;OAIG;gBACgB,OAAO,CAAC,EAAE,yBAAyB;IAKtD;;;;OAIG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;;OASG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IAwB5D;;;;;;;OAOG;IACI,SAAS,CACd,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAgBnD;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,cAAc,CAAC,MAAM,EAAE,qBAAqB,CAAC;CAO3G"}
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/templates.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoD,MAAM,eAAe,CAAC;AACzG,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;AAIrD;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,OAAO,CAAC,kBAAkB,CAAC;IAC5E;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;IAC7D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IAE/C;;;;OAIG;gBACgB,OAAO,CAAC,EAAE,yBAAyB;IAKtD;;;;OAIG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;;OASG;IACI,YAAY,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IAwB5D;;;;;;;OAOG;IACI,SAAS,CACd,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAgBnD;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,cAAc,CAAC,MAAM,EAAE,qBAAqB,CAAC;CAO3G"}

package/lib/packlets/editor/rules/templates.js.map

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/templates.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;AAEH,4CAAyG;AAGzG,sDAAuD;AAGvD,wDAAgC;AAiBhC;;;;GAIG;AACH,MAAa,uBAAwB,SAAQ,mCAAkB;IAO7D;;;;OAIG;IACH,YAAmB,OAAmC;QACpD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,OAAmC;QACtD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;;QAEtB,oBAAoB;QACpB,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC;QAE7C,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,gBAAgB,MAAK,KAAK,EAAE;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC3D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBACrB,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,aAAa,GAAG,uBAAuB,CAAC,CAAC;iBAC7F;gBAED,MAAM,IAAI,GAAe,EAAE,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;gBACrB,OAAO,IAAA,4BAAiB,EAAoC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE;gBACnD,MAAM,OAAO,GAAG,sBAAsB,GAAG,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC/D,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;aACzE;YACD,OAAO,MAAM,CAAC;SACf;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CACd,KAAgB,EAChB,KAAsB;;QAEtB,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,iBAAiB,MAAK,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACnG,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACrE,OAAO,IAAA,4BAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;YAEH,IAAI,YAAY,CAAC,SAAS,EAAE,IAAI,YAAY,CAAC,MAAM,KAAK,OAAO,EAAE;gBAC/D,MAAM,OAAO,GAAG,wBAAwB,YAAY,CAAC,OAAO,EAAE,CAAC;gBAC/D,oBAAoB;gBACpB,OAAO,KAAK,CAAC,cAAc,CAAC,sBAAsB,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;aACzF;YACD,OAAO,YAAY,CAAC;SACrB;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO,CAAC,QAAgB,EAAE,KAAsB;;QACxD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;QACnD,IAAI,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACnC,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,kBAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC3F;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;CACF;AA3GD,0DA2GC","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 { DetailedResult, Result, captureResult, failWithDetail, succeedWithDetail } from '@fgv/ts-utils';\nimport { JsonObject, JsonValue } from '../../json';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\nimport Mustache from 'mustache';\n\n/**\n * Configuration options for the {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule}.\n * @public\n */\nexport interface ITemplatedJsonRuleOptions extends Partial<IJsonEditorOptions> {\n  /**\n   * If `true` (default) then templates in property names are rendered\n   */\n  useNameTemplates?: boolean;\n  /**\n   * If `true` (default) then templates in property values are rendered\n   */\n  useValueTemplates?: boolean;\n}\n\n/**\n * The {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule} applies mustache rendering as\n * appropriate to any keys or values in the object being edited.\n * @public\n */\nexport class TemplatedJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Fully-resolved {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options} for this rule.\n   * @public\n   */\n  protected _options?: ITemplatedJsonRuleOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}\n   * for this rule.\n   */\n  public constructor(options?: ITemplatedJsonRuleOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}\n   * for this rule.\n   */\n  public static create(options?: ITemplatedJsonRuleOptions): Result<TemplatedJsonEditorRule> {\n    return captureResult(() => new TemplatedJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property name for template rendering.\n   * @param key - The key of the property to be considered.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'edited'` and an {@link JsonObject | object} to\n   * be flattened and merged if the key contained a template. Returns `Failure` with detail `'error'`\n   * if an error occurred or with detail `'inapplicable'` if the property key does not contain\n   * a template or if name rendering is disabled.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    /* c8 ignore next */\n    const validation = this._options?.validation;\n\n    if (this._options?.useNameTemplates !== false) {\n      const result = this._render(key, state).onSuccess((newKey) => {\n        if (newKey.length < 1) {\n          return state.failValidation('invalidPropertyName', `Template \"${key}\" renders empty name.`);\n        }\n\n        const rtrn: JsonObject = {};\n        rtrn[newKey] = value;\n        return succeedWithDetail<JsonObject, JsonEditFailureReason>(rtrn, 'edited');\n      });\n\n      if (result.isFailure() && result.detail === 'error') {\n        const message = `Cannot render name ${key}: ${result.message}`;\n        return state.failValidation('invalidPropertyName', message, validation);\n      }\n      return result;\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Evaluates a property, array or literal value for template rendering.\n   * @param value - The {@link JsonValue | value} to be edited.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'edited'` if the value contained a template and was edited.\n   * Returns `Failure` with `'ignore'` if the rendered value should be ignored, with `'error'` if\n   * an error occurs, or with `'inapplicable'` if the value was not a string with a template.\n   */\n  public editValue(\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonValue, JsonEditFailureReason> {\n    if (this._options?.useValueTemplates !== false && typeof value === 'string' && value.includes('{{')) {\n      const renderResult = this._render(value, state).onSuccess((newValue) => {\n        return succeedWithDetail(newValue, 'edited');\n      });\n\n      if (renderResult.isFailure() && renderResult.detail === 'error') {\n        const message = `Cannot render value: ${renderResult.message}`;\n        /* c8 ignore next */\n        return state.failValidation('invalidPropertyValue', message, this._options?.validation);\n      }\n      return renderResult;\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Renders a single template string for a supplied {@link Editor.JsonEditorState | editor state}.\n   * @param template - The mustache template to be rendered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} used to render the template.\n   * @returns `Success` if the template is rendered.  Returns `Failure` with detail `'error'` if the\n   * template could not be rendered (e.g. due to syntax errors) or with detail `'inapplicable'` if the\n   * string is not a template.\n   * @internal\n   */\n  protected _render(template: string, state: JsonEditorState): DetailedResult<string, JsonEditFailureReason> {\n    const vars = state.getVars(this._options?.context);\n    if (vars && template.includes('{{')) {\n      return captureResult(() => Mustache.render(template, vars)).withDetail('error', 'edited');\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n}\n"]}
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/templates.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;AAGH,4CAAyG;AAEzG,sDAAuD;AAGvD,wDAAgC;AAiBhC;;;;GAIG;AACH,MAAa,uBAAwB,SAAQ,mCAAkB;IAO7D;;;;OAIG;IACH,YAAmB,OAAmC;QACpD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,OAAmC;QACtD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACI,YAAY,CACjB,GAAW,EACX,KAAgB,EAChB,KAAsB;;QAEtB,oBAAoB;QACpB,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC;QAE7C,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC3D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,aAAa,GAAG,uBAAuB,CAAC,CAAC;gBAC9F,CAAC;gBAED,MAAM,IAAI,GAAe,EAAE,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;gBACrB,OAAO,IAAA,4BAAiB,EAAoC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBACpD,MAAM,OAAO,GAAG,sBAAsB,GAAG,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC/D,OAAO,KAAK,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1E,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CACd,KAAgB,EAChB,KAAsB;;QAEtB,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,iBAAiB,MAAK,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpG,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACrE,OAAO,IAAA,4BAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;YAEH,IAAI,YAAY,CAAC,SAAS,EAAE,IAAI,YAAY,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,wBAAwB,YAAY,CAAC,OAAO,EAAE,CAAC;gBAC/D,oBAAoB;gBACpB,OAAO,KAAK,CAAC,cAAc,CAAC,sBAAsB,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC,CAAC;YAC1F,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO,CAAC,QAAgB,EAAE,KAAsB;;QACxD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC;QACnD,IAAI,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,kBAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5F,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;CACF;AA3GD,0DA2GC","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 { JsonObject, JsonValue } from '@fgv/ts-json-base';\nimport { DetailedResult, Result, captureResult, failWithDetail, succeedWithDetail } from '@fgv/ts-utils';\nimport { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from '../common';\nimport { JsonEditorRuleBase } from '../jsonEditorRule';\nimport { JsonEditorState } from '../jsonEditorState';\n\nimport Mustache from 'mustache';\n\n/**\n * Configuration options for the {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule}.\n * @public\n */\nexport interface ITemplatedJsonRuleOptions extends Partial<IJsonEditorOptions> {\n  /**\n   * If `true` (default) then templates in property names are rendered\n   */\n  useNameTemplates?: boolean;\n  /**\n   * If `true` (default) then templates in property values are rendered\n   */\n  useValueTemplates?: boolean;\n}\n\n/**\n * The {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule} applies mustache rendering as\n * appropriate to any keys or values in the object being edited.\n * @public\n */\nexport class TemplatedJsonEditorRule extends JsonEditorRuleBase {\n  /**\n   * Fully-resolved {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options} for this rule.\n   * @public\n   */\n  protected _options?: ITemplatedJsonRuleOptions;\n\n  /**\n   * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}\n   * for this rule.\n   */\n  public constructor(options?: ITemplatedJsonRuleOptions) {\n    super();\n    this._options = options;\n  }\n\n  /**\n   * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.\n   * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}\n   * for this rule.\n   */\n  public static create(options?: ITemplatedJsonRuleOptions): Result<TemplatedJsonEditorRule> {\n    return captureResult(() => new TemplatedJsonEditorRule(options));\n  }\n\n  /**\n   * Evaluates a property name for template rendering.\n   * @param key - The key of the property to be considered.\n   * @param value - The {@link JsonValue | value} of the property to be considered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'edited'` and an {@link JsonObject | object} to\n   * be flattened and merged if the key contained a template. Returns `Failure` with detail `'error'`\n   * if an error occurred or with detail `'inapplicable'` if the property key does not contain\n   * a template or if name rendering is disabled.\n   */\n  public editProperty(\n    key: string,\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonObject, JsonPropertyEditFailureReason> {\n    /* c8 ignore next */\n    const validation = this._options?.validation;\n\n    if (this._options?.useNameTemplates !== false) {\n      const result = this._render(key, state).onSuccess((newKey) => {\n        if (newKey.length < 1) {\n          return state.failValidation('invalidPropertyName', `Template \"${key}\" renders empty name.`);\n        }\n\n        const rtrn: JsonObject = {};\n        rtrn[newKey] = value;\n        return succeedWithDetail<JsonObject, JsonEditFailureReason>(rtrn, 'edited');\n      });\n\n      if (result.isFailure() && result.detail === 'error') {\n        const message = `Cannot render name ${key}: ${result.message}`;\n        return state.failValidation('invalidPropertyName', message, validation);\n      }\n      return result;\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Evaluates a property, array or literal value for template rendering.\n   * @param value - The {@link JsonValue | value} to be edited.\n   * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'edited'` if the value contained a template and was edited.\n   * Returns `Failure` with `'ignore'` if the rendered value should be ignored, with `'error'` if\n   * an error occurs, or with `'inapplicable'` if the value was not a string with a template.\n   */\n  public editValue(\n    value: JsonValue,\n    state: JsonEditorState\n  ): DetailedResult<JsonValue, JsonEditFailureReason> {\n    if (this._options?.useValueTemplates !== false && typeof value === 'string' && value.includes('{{')) {\n      const renderResult = this._render(value, state).onSuccess((newValue) => {\n        return succeedWithDetail(newValue, 'edited');\n      });\n\n      if (renderResult.isFailure() && renderResult.detail === 'error') {\n        const message = `Cannot render value: ${renderResult.message}`;\n        /* c8 ignore next */\n        return state.failValidation('invalidPropertyValue', message, this._options?.validation);\n      }\n      return renderResult;\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n\n  /**\n   * Renders a single template string for a supplied {@link Editor.JsonEditorState | editor state}.\n   * @param template - The mustache template to be rendered.\n   * @param state - The {@link Editor.JsonEditorState | editor state} used to render the template.\n   * @returns `Success` if the template is rendered.  Returns `Failure` with detail `'error'` if the\n   * template could not be rendered (e.g. due to syntax errors) or with detail `'inapplicable'` if the\n   * string is not a template.\n   * @internal\n   */\n  protected _render(template: string, state: JsonEditorState): DetailedResult<string, JsonEditFailureReason> {\n    const vars = state.getVars(this._options?.context);\n    if (vars && template.includes('{{')) {\n      return captureResult(() => Mustache.render(template, vars)).withDetail('error', 'edited');\n    }\n    return failWithDetail('inapplicable', 'inapplicable');\n  }\n}\n"]}

package/package.json

@@ -1,30 +1,31 @@
 {
 	"name": "@fgv/ts-json",
-	"version": "2.1.0",
+	"version": "2.1.1-alpha.1",
 	"description": "Typescript utilities for working with JSON",
 	"main": "lib/index.js",
 	"types": "dist/ts-json.d.ts",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/ErikFortune/fgv.git"
-	},
 	"keywords": [
 		"typescript",
 		"json"
 	],
 	"author": "Erik Fortune",
 	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/ErikFortune/fgv/issues"
+	},
+	"homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json#readme",
+	"sideEffects": false,
 	"devDependencies": {
-		"@fgv/ts-utils": "2.1.0",
-		"@fgv/ts-utils-jest": "2.1.0",
-		"@types/jest": "^29.5.7",
-		"@types/mustache": "^4.2.4",
-		"@types/node": "^20.8.9",
-		"@typescript-eslint/eslint-plugin": "^6.9.1",
-		"@typescript-eslint/parser": "^6.9.1",
-		"eslint": "^8.52.0",
+		"@fgv/ts-utils": "2.1.1-alpha.1",
+		"@fgv/ts-utils-jest": "2.1.1-alpha.1",
+		"@types/jest": "^29.5.11",
+		"@types/mustache": "^4.2.5",
+		"@types/node": "^20.11.5",
+		"@typescript-eslint/eslint-plugin": "^6.19.0",
+		"@typescript-eslint/parser": "^6.19.0",
+		"eslint": "^8.56.0",
 		"eslint-config-standard": "^17.1.0",
-		"eslint-plugin-import": "^2.29.0",
+		"eslint-plugin-import": "^2.29.1",
 		"eslint-plugin-node": "^11.1.0",
 		"eslint-plugin-promise": "^6.1.1",
 		"jest": "^29.7.0",
@@ -32,17 +33,19 @@
 		"mustache": "^4.2.0",
 		"rimraf": "^5.0.5",
 		"ts-jest": "^29.1.1",
-		"ts-node": "^10.9.1",
-		"typescript": "^5.2.2",
-		"eslint-plugin-n": "^16.2.0",
-		"@rushstack/heft-node-rig": "~2.3.8",
-		"@rushstack/heft": "~0.63.0",
+		"ts-node": "^10.9.2",
+		"typescript": "^5.3.3",
+		"eslint-plugin-n": "^16.6.2",
+		"@rushstack/heft-node-rig": "~2.4.0",
+		"@rushstack/heft": "~0.64.0",
 		"heft-jest": "~1.0.2",
-		"@types/heft-jest": "1.0.5",
-		"@microsoft/api-documenter": "^7.23.10"
+		"@types/heft-jest": "1.0.6",
+		"@microsoft/api-documenter": "^7.23.17",
+		"@fgv/ts-json-base": "2.1.1-alpha.1"
 	},
 	"peerDependencies": {
-		"@fgv/ts-utils": "^2.1.0",
+		"@fgv/ts-utils": "2.1.1-alpha.1",
+		"@fgv/ts-json-base": "2.1.1-alpha.1",
 		"mustache": "^4.2.0"
 	},
 	"scripts": {