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

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

@@ -0,0 +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    // istanbul ignore next: unreachable\n    return false;\n  }\n}\n"]}

package/{jsonEditor → lib/packlets/editor}/rules/index.d.ts

@@ -2,3 +2,4 @@ export * from './conditional';
 export * from './multivalue';
 export * from './references';
 export * from './templates';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/index.ts"],"names":[],"mappings":"AAqBA,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}

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

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+__exportStar(require("./conditional"), exports);
+__exportStar(require("./multivalue"), exports);
+__exportStar(require("./references"), exports);
+__exportStar(require("./templates"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/packlets/editor/rules/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,gDAA8B;AAC9B,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B","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 */\nexport * from './conditional';\nexport * from './multivalue';\nexport * from './references';\nexport * from './templates';\n"]}

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

@@ -0,0 +1,94 @@
+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';
+/**
+ * Represents the parts of a multi-value property key.
+ * @public
+ */
+export interface IMultiValuePropertyParts {
+    /**
+     * The original matched token.
+     */
+    readonly token: string;
+    /**
+     * The name of the variable used to project each possible
+     * property value into the child values or objects being
+     * resolved.
+     */
+    readonly propertyVariable: string;
+    /**
+     * The set of property values to be expanded.
+     */
+    readonly propertyValues: string[];
+    /**
+     * If `true`, the resolved values are added as an array
+     * with the name of the {@link Editor.Rules.IMultiValuePropertyParts.propertyVariable | propertyVariable}.
+     * If false, values are added as individual properties with names that correspond the value.
+     */
+    readonly asArray: boolean;
+}
+/**
+ * The {@link Editor.Rules.MultiValueJsonEditorRule | Multi-Value JSON editor rule}
+ * expands matching keys multiple times, projecting the value into the template
+ * context for any child objects rendered by the rule.
+ *
+ * The default syntax for a multi-value key is:
+ *  "[[var]]=value1,value2,value3"
+ * Where "var" is the name of the variable that will be passed to
+ * child template resolution, and "value1,value2,value3" is a
+ * comma-separated list of values to be expanded.
+ * @public
+ */
+export declare class MultiValueJsonEditorRule extends JsonEditorRuleBase {
+    /**
+     * Stored fully-resolved {@link Editor.IJsonEditorOptions | editor options}
+     * for this rule.
+     * @public
+     */
+    protected _options?: IJsonEditorOptions;
+    /**
+     * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.
+     */
+    constructor(options?: IJsonEditorOptions);
+    /**
+     * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.
+     */
+    static create(options?: IJsonEditorOptions): Result<MultiValueJsonEditorRule>;
+    /**
+     * Evaluates a property for multi-value expansion.
+     * @param key - The key of the property to be considered
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with an object containing the fully-resolved child values to be merged for
+     * matching multi-value property. Returns `Failure` with detail `'error'` if an error occurs or
+     * with detail `'inapplicable'` if the property key is not a conditional property.
+     */
+    editProperty(key: string, value: JsonValue, state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
+    /**
+     * Extends the {@link IJsonContext | current context} with a supplied state and values.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @param values - An array of {@link VariableValue | VariableValue} to be added to the
+     * context.
+     * @returns The extended {@link IJsonContext | context}.
+     * @public
+     */
+    protected _deriveContext(state: JsonEditorState, ...values: VariableValue[]): Result<IJsonContext | undefined>;
+    /**
+     * Determines if a given property key is multi-value. Derived classes can override this
+     * method to use a different format for multi-value properties.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with detail `'deferred'` and an
+     * {@link Editor.Rules.IMultiValuePropertyParts | IMultiValuePropertyParts}
+     * describing the match for matching multi-value property.  Returns `Failure` with detail `'error'` if an error occurs
+     * or with detail `'inapplicable'` if the key does not represent a multi-value property.
+     * @public
+     */
+    protected _tryParse(token: string, state: JsonEditorState): DetailedResult<IMultiValuePropertyParts, JsonEditFailureReason>;
+}
+//# sourceMappingURL=multivalue.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,141 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiValueJsonEditorRule = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const jsonEditorRule_1 = require("../jsonEditorRule");
+/**
+ * The {@link Editor.Rules.MultiValueJsonEditorRule | Multi-Value JSON editor rule}
+ * expands matching keys multiple times, projecting the value into the template
+ * context for any child objects rendered by the rule.
+ *
+ * The default syntax for a multi-value key is:
+ *  "[[var]]=value1,value2,value3"
+ * Where "var" is the name of the variable that will be passed to
+ * child template resolution, and "value1,value2,value3" is a
+ * comma-separated list of values to be expanded.
+ * @public
+ */
+class MultiValueJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
+    /**
+     * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.
+     */
+    constructor(options) {
+        super();
+        this._options = options;
+    }
+    /**
+     * Creates a new {@link Editor.Rules.MultiValueJsonEditorRule | MultiValueJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options}.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new MultiValueJsonEditorRule(options));
+    }
+    /**
+     * Evaluates a property for multi-value expansion.
+     * @param key - The key of the property to be considered
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with an object containing the fully-resolved child values to be merged for
+     * matching multi-value property. Returns `Failure` with detail `'error'` if an error occurs or
+     * with detail `'inapplicable'` if the property key is not a conditional property.
+     */
+    editProperty(key, value, state) {
+        const json = {};
+        const result = this._tryParse(key, state).onSuccess((parts) => {
+            return (0, ts_utils_1.allSucceed)(parts.propertyValues.map((pv) => {
+                return this._deriveContext(state, [parts.propertyVariable, pv]).onSuccess((ctx) => {
+                    return state.editor.clone(value, ctx).onSuccess((cloned) => {
+                        json[pv] = cloned;
+                        return (0, ts_utils_1.succeedWithDetail)(cloned);
+                    });
+                });
+            }), json)
+                .onSuccess(() => {
+                if (parts.asArray) {
+                    const arrayRtrn = {};
+                    arrayRtrn[parts.propertyVariable] = Array.from(Object.values(json));
+                    return (0, ts_utils_1.succeed)(arrayRtrn);
+                }
+                return (0, ts_utils_1.succeed)(json);
+            })
+                .withFailureDetail('error');
+        });
+        if (result.isFailure() && result.detail === 'error') {
+            return state.failValidation('invalidPropertyName', result.message);
+        }
+        return result;
+    }
+    /**
+     * Extends the {@link IJsonContext | current context} with a supplied state and values.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @param values - An array of {@link VariableValue | VariableValue} to be added to the
+     * context.
+     * @returns The extended {@link IJsonContext | context}.
+     * @public
+     */
+    _deriveContext(state, ...values) {
+        var _a;
+        return state.extendContext((_a = this._options) === null || _a === void 0 ? void 0 : _a.context, { vars: values });
+    }
+    /**
+     * Determines if a given property key is multi-value. Derived classes can override this
+     * method to use a different format for multi-value properties.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with detail `'deferred'` and an
+     * {@link Editor.Rules.IMultiValuePropertyParts | IMultiValuePropertyParts}
+     * describing the match for matching multi-value property.  Returns `Failure` with detail `'error'` if an error occurs
+     * or with detail `'inapplicable'` if the key does not represent a multi-value property.
+     * @public
+     */
+    _tryParse(token, state) {
+        var _a;
+        let parts = [];
+        let asArray = false;
+        if (token.startsWith('[[')) {
+            parts = token.substring(2).split(']]=');
+            asArray = true;
+        }
+        else if (token.startsWith('*')) {
+            parts = token.substring(1).split('=');
+            asArray = false;
+        }
+        else {
+            return (0, ts_utils_1.failWithDetail)(token, 'inapplicable');
+        }
+        if (parts.length !== 2) {
+            const message = `Malformed multi-value property: ${token}`;
+            return state.failValidation('invalidPropertyName', message, (_a = this._options) === null || _a === void 0 ? void 0 : _a.validation);
+        }
+        if (parts[1].includes('{{')) {
+            return (0, ts_utils_1.failWithDetail)('unresolved template', 'inapplicable');
+        }
+        const propertyVariable = parts[0];
+        const propertyValues = parts[1].split(',');
+        return (0, ts_utils_1.succeedWithDetail)({ token, propertyVariable, propertyValues, asArray });
+    }
+}
+exports.MultiValueJsonEditorRule = MultiValueJsonEditorRule;
+//# sourceMappingURL=multivalue.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,69 @@
+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';
+/**
+ * The {@link Editor.Rules.ReferenceJsonEditorRule | Reference JSON editor rule} replaces property
+ * keys or values that match some known object with a copy of that referenced object, formatted
+ * according to the current context.
+ *
+ * A property key is matched if it matches any known referenced value.
+ * - If the value of the matched key is `'default'`, then the entire object is formatted
+ *   with the current context, flattened and merged into the current object.
+ * - If the value of the matched key is some other string, then the entire
+ *   object is formatted with the current context, and the child of the resulting
+ *   object at the specified path is flattened and merged into the current object.
+ * - If the value of the matched key is an object, then the entire object is
+ *   formatted with the current context extended to include any properties of
+ *   that object, flattened, and merged into the current object.
+ * - It is an error if the referenced value is not an object.
+ *
+ * Any property, array or literal value is matched if it matches any known
+ * value reference. The referenced value is replaced by the referenced
+ * value, formatted using the current editor context.
+ * @public
+ */
+export declare class ReferenceJsonEditorRule extends JsonEditorRuleBase {
+    /**
+     * Stored fully-resolved {@link Editor.IJsonEditorOptions | editor options} for this rule.
+     * @public
+     */
+    protected _options?: IJsonEditorOptions;
+    /**
+     * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.
+     */
+    constructor(options?: IJsonEditorOptions);
+    /**
+     * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.
+     */
+    static create(options?: IJsonEditorOptions): Result<ReferenceJsonEditorRule>;
+    /**
+     * Evaluates a property for reference expansion.
+     * @param key - The key of the property to be considered.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns If the reference is successful, returns `Success` with a {@link JsonObject | JsonObject}
+     * to be flattened and merged into the current object. Returns `Failure` with detail `'inapplicable'`
+     * for non-reference keys or with detail `'error'` if an error occurs.
+     */
+    editProperty(key: string, value: JsonValue, state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
+    /**
+     * Evaluates a property, array or literal value for reference replacement.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     */
+    editValue(value: JsonValue, state: JsonEditorState): DetailedResult<JsonValue, JsonEditFailureReason>;
+    /**
+     * Gets the template variables to use given the value of some property whose name matched a
+     * resource plus the base template context.
+     * @param state - The {@link Editor.JsonEditorState | editor state} to be extended.
+     * @param supplied - The string or object supplied in the source json.
+     * @internal
+     */
+    protected _extendContext(state: JsonEditorState, supplied: JsonValue): Result<IJsonContext | undefined>;
+}
+//# sourceMappingURL=references.d.ts.map

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

@@ -0,0 +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;IA0C5D;;;;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

@@ -0,0 +1,160 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceJsonEditorRule = void 0;
+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
+ * keys or values that match some known object with a copy of that referenced object, formatted
+ * according to the current context.
+ *
+ * A property key is matched if it matches any known referenced value.
+ * - If the value of the matched key is `'default'`, then the entire object is formatted
+ *   with the current context, flattened and merged into the current object.
+ * - If the value of the matched key is some other string, then the entire
+ *   object is formatted with the current context, and the child of the resulting
+ *   object at the specified path is flattened and merged into the current object.
+ * - If the value of the matched key is an object, then the entire object is
+ *   formatted with the current context extended to include any properties of
+ *   that object, flattened, and merged into the current object.
+ * - It is an error if the referenced value is not an object.
+ *
+ * Any property, array or literal value is matched if it matches any known
+ * value reference. The referenced value is replaced by the referenced
+ * value, formatted using the current editor context.
+ * @public
+ */
+class ReferenceJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
+    /**
+     * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.
+     */
+    constructor(options) {
+        super();
+        this._options = options;
+    }
+    /**
+     * Creates a new {@link Editor.Rules.ReferenceJsonEditorRule | ReferenceJsonEditorRule}.
+     * @param options - Optional {@link Editor.IJsonEditorOptions | configuration options} for this rule.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new ReferenceJsonEditorRule(options));
+    }
+    /**
+     * Evaluates a property for reference expansion.
+     * @param key - The key of the property to be considered.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @returns If the reference is successful, returns `Success` with a {@link JsonObject | JsonObject}
+     * to be flattened and merged into the current object. Returns `Failure` with detail `'inapplicable'`
+     * for non-reference keys or with detail `'error'` if an error occurs.
+     */
+    editProperty(key, value, state) {
+        var _a, _b;
+        // istanbul ignore next
+        const validation = (_a = this._options) === null || _a === void 0 ? void 0 : _a.validation;
+        // istanbul ignore next
+        const refs = state.getRefs((_b = this._options) === null || _b === void 0 ? void 0 : _b.context);
+        if (refs === null || refs === void 0 ? void 0 : refs.has(key)) {
+            // need to apply any rules to the value before we evaluate it
+            const cloneResult = state.editor.clone(value, state.context);
+            if (cloneResult.isSuccess()) {
+                value = cloneResult.value;
+            }
+            else {
+                const message = `${key}: ${cloneResult.message}`;
+                return state.failValidation('invalidPropertyName', message, validation);
+            }
+            const contextResult = this._extendContext(state, value);
+            if (contextResult.isSuccess()) {
+                const objResult = refs.getJsonObject(key, contextResult.value);
+                // guarded by the has above so should never happen
+                // istanbul ignore else
+                if (objResult.isSuccess()) {
+                    if (typeof value !== 'string' || value === 'default') {
+                        return (0, ts_utils_1.succeedWithDetail)(objResult.value, 'edited');
+                    }
+                    const pickResult = (0, json_1.pickJsonObject)(objResult.value, value);
+                    if (pickResult.isFailure()) {
+                        const message = `${key}: ${pickResult.message}`;
+                        return state.failValidation('invalidPropertyName', message, validation);
+                    }
+                    return pickResult.withDetail('edited');
+                }
+                else if (objResult.detail !== 'unknown') {
+                    const message = `${key}: ${objResult.message}`;
+                    return state.failValidation('invalidPropertyName', message, validation);
+                }
+            }
+            else {
+                const message = `${key}: ${contextResult.message}`;
+                return state.failValidation('invalidPropertyName', message, validation);
+            }
+        }
+        return (0, ts_utils_1.failWithDetail)('inapplicable', 'inapplicable');
+    }
+    /**
+     * Evaluates a property, array or literal value for reference replacement.
+     * @param value - The {@link JsonValue | value} of the property to be considered.
+     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     */
+    editValue(value, state) {
+        var _a, _b, _c;
+        // istanbul ignore next
+        const refs = state.getRefs((_a = this._options) === null || _a === void 0 ? void 0 : _a.context);
+        if (refs && typeof value === 'string') {
+            // istanbul ignore next
+            const context = state.getContext((_b = this._options) === null || _b === void 0 ? void 0 : _b.context);
+            const result = refs.getJsonValue(value, context);
+            if (result.isSuccess()) {
+                return (0, ts_utils_1.succeedWithDetail)(result.value, 'edited');
+            }
+            else if (result.detail === 'error') {
+                return state.failValidation('invalidPropertyValue', result.message, (_c = this._options) === null || _c === void 0 ? void 0 : _c.validation);
+            }
+        }
+        return (0, ts_utils_1.failWithDetail)('inapplicable', 'inapplicable');
+    }
+    /**
+     * Gets the template variables to use given the value of some property whose name matched a
+     * resource plus the base template context.
+     * @param state - The {@link Editor.JsonEditorState | editor state} to be extended.
+     * @param supplied - The string or object supplied in the source json.
+     * @internal
+     */
+    _extendContext(state, supplied) {
+        var _a;
+        const add = {};
+        if ((0, json_1.isJsonObject)(supplied)) {
+            add.vars = Object.entries(supplied);
+        }
+        else if (typeof supplied !== 'string') {
+            return (0, ts_utils_1.fail)(`Invalid template path or context: "${JSON.stringify(supplied)}"`);
+        }
+        return state.extendContext((_a = this._options) === null || _a === void 0 ? void 0 : _a.context, add);
+    }
+}
+exports.ReferenceJsonEditorRule = ReferenceJsonEditorRule;
+//# sourceMappingURL=references.js.map

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

@@ -0,0 +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,uBAAuB;QACvB,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,CAAC;QAC7C,uBAAuB;QACvB,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,uBAAuB;gBACvB,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,uBAAuB;QACvB,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,uBAAuB;YACvB,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;AAxHD,0DAwHC","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    // istanbul ignore next\n    const validation = this._options?.validation;\n    // istanbul ignore next\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        // istanbul 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    // istanbul ignore next\n    const refs = state.getRefs(this._options?.context);\n\n    if (refs && typeof value === 'string') {\n      // istanbul 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"]}