@fgv/ts-json 3.0.1-alpha.6 → 4.0.0

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

@@ -4,7 +4,7 @@ import { IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReaso
 import { JsonEditorRuleBase } from '../jsonEditorRule';
 import { JsonEditorState } from '../jsonEditorState';
 /**
- * Configuration options for the {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule}.
+ * Configuration options for the {@link EditorRules.TemplatedJsonEditorRule | Templated JSON editor rule}.
  * @public
  */
 export interface ITemplatedJsonRuleOptions extends Partial<IJsonEditorOptions> {
@@ -18,34 +18,34 @@ export interface ITemplatedJsonRuleOptions extends Partial<IJsonEditorOptions> {
     useValueTemplates?: boolean;
 }
 /**
- * The {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule} applies mustache rendering as
+ * The {@link EditorRules.TemplatedJsonEditorRule | Templated JSON editor rule} applies mustache rendering as
  * appropriate to any keys or values in the object being edited.
  * @public
  */
 export declare class TemplatedJsonEditorRule extends JsonEditorRuleBase {
     /**
-     * Fully-resolved {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options} for this rule.
+     * Fully-resolved {@link EditorRules.ITemplatedJsonRuleOptions | configuration options} for this rule.
      * @public
      */
     protected _options?: ITemplatedJsonRuleOptions;
     /**
-     * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
-     * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}
+     * Creates a new {@link EditorRules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
+     * @param options - Optional {@link EditorRules.ITemplatedJsonRuleOptions | configuration options}
      * for this rule.
      */
     constructor(options?: ITemplatedJsonRuleOptions);
     /**
-     * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
-     * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}
+     * Creates a new {@link EditorRules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
+     * @param options - Optional {@link EditorRules.ITemplatedJsonRuleOptions | configuration options}
      * for this rule.
      */
     static create(options?: ITemplatedJsonRuleOptions): Result<TemplatedJsonEditorRule>;
     /**
      * Evaluates a property name for template rendering.
      * @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 detail `'edited'` and an {@link JsonObject | object} to
+     * @param value - The `JsonValue` of the property to be considered.
+     * @param state - The {@link JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with detail `'edited'` and an `JsonObject` to
      * be flattened and merged if the key contained a template. Returns `Failure` with detail `'error'`
      * if an error occurred or with detail `'inapplicable'` if the property key does not contain
      * a template or if name rendering is disabled.
@@ -53,17 +53,17 @@ export declare class TemplatedJsonEditorRule extends JsonEditorRuleBase {
     editProperty(key: string, value: JsonValue, state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
     /**
      * Evaluates a property, array or literal value for template rendering.
-     * @param value - The {@link JsonValue | value} to be edited.
-     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @param value - The `JsonValue` to be edited.
+     * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'edited'` if the value contained a template and was edited.
      * Returns `Failure` with `'ignore'` if the rendered value should be ignored, with `'error'` if
      * an error occurs, or with `'inapplicable'` if the value was not a string with a template.
      */
     editValue(value: JsonValue, state: JsonEditorState): DetailedResult<JsonValue, JsonEditFailureReason>;
     /**
-     * Renders a single template string for a supplied {@link Editor.JsonEditorState | editor state}.
+     * Renders a single template string for a supplied {@link JsonEditorState | editor state}.
      * @param template - The mustache template to be rendered.
-     * @param state - The {@link Editor.JsonEditorState | editor state} used to render the template.
+     * @param state - The {@link JsonEditorState | editor state} used to render the template.
      * @returns `Success` if the template is rendered.  Returns `Failure` with detail `'error'` if the
      * template could not be rendered (e.g. due to syntax errors) or with detail `'inapplicable'` if the
      * string is not a template.

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

@@ -29,14 +29,14 @@ const ts_utils_1 = require("@fgv/ts-utils");
 const jsonEditorRule_1 = require("../jsonEditorRule");
 const mustache_1 = __importDefault(require("mustache"));
 /**
- * The {@link Editor.Rules.TemplatedJsonEditorRule | Templated JSON editor rule} applies mustache rendering as
+ * The {@link EditorRules.TemplatedJsonEditorRule | Templated JSON editor rule} applies mustache rendering as
  * appropriate to any keys or values in the object being edited.
  * @public
  */
 class TemplatedJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     /**
-     * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
-     * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}
+     * Creates a new {@link EditorRules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
+     * @param options - Optional {@link EditorRules.ITemplatedJsonRuleOptions | configuration options}
      * for this rule.
      */
     constructor(options) {
@@ -44,8 +44,8 @@ class TemplatedJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
         this._options = options;
     }
     /**
-     * Creates a new {@link Editor.Rules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
-     * @param options - Optional {@link Editor.Rules.ITemplatedJsonRuleOptions | configuration options}
+     * Creates a new {@link EditorRules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.
+     * @param options - Optional {@link EditorRules.ITemplatedJsonRuleOptions | configuration options}
      * for this rule.
      */
     static create(options) {
@@ -54,9 +54,9 @@ class TemplatedJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     /**
      * Evaluates a property name for template rendering.
      * @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 detail `'edited'` and an {@link JsonObject | object} to
+     * @param value - The `JsonValue` of the property to be considered.
+     * @param state - The {@link JsonEditorState | editor state} for the object being edited.
+     * @returns `Success` with detail `'edited'` and an `JsonObject` to
      * be flattened and merged if the key contained a template. Returns `Failure` with detail `'error'`
      * if an error occurred or with detail `'inapplicable'` if the property key does not contain
      * a template or if name rendering is disabled.
@@ -84,8 +84,8 @@ class TemplatedJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     }
     /**
      * Evaluates a property, array or literal value for template rendering.
-     * @param value - The {@link JsonValue | value} to be edited.
-     * @param state - The {@link Editor.JsonEditorState | editor state} for the object being edited.
+     * @param value - The `JsonValue` to be edited.
+     * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'edited'` if the value contained a template and was edited.
      * Returns `Failure` with `'ignore'` if the rendered value should be ignored, with `'error'` if
      * an error occurs, or with `'inapplicable'` if the value was not a string with a template.
@@ -106,9 +106,9 @@ class TemplatedJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
         return (0, ts_utils_1.failWithDetail)('inapplicable', 'inapplicable');
     }
     /**
-     * Renders a single template string for a supplied {@link Editor.JsonEditorState | editor state}.
+     * Renders a single template string for a supplied {@link JsonEditorState | editor state}.
      * @param template - The mustache template to be rendered.
-     * @param state - The {@link Editor.JsonEditorState | editor state} used to render the template.
+     * @param state - The {@link JsonEditorState | editor state} used to render the template.
      * @returns `Success` if the template is rendered.  Returns `Failure` with detail `'error'` if the
      * template could not be rendered (e.g. due to syntax errors) or with detail `'inapplicable'` if the
      * string is not a template.

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;;;;;;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"]}
+{"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 EditorRules.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 EditorRules.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 EditorRules.ITemplatedJsonRuleOptions | configuration options} for this rule.\n   * @public\n   */\n  protected _options?: ITemplatedJsonRuleOptions;\n\n  /**\n   * Creates a new {@link EditorRules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.\n   * @param options - Optional {@link EditorRules.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 EditorRules.TemplatedJsonEditorRule | TemplatedJsonEditorRule}.\n   * @param options - Optional {@link EditorRules.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 `JsonValue` of the property to be considered.\n   * @param state - The {@link JsonEditorState | editor state} for the object being edited.\n   * @returns `Success` with detail `'edited'` and an `JsonObject` 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 `JsonValue` to be edited.\n   * @param state - The {@link 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 JsonEditorState | editor state}.\n   * @param template - The mustache template to be rendered.\n   * @param state - The {@link 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,6 +1,6 @@
 {
 	"name": "@fgv/ts-json",
-	"version": "3.0.1-alpha.6",
+	"version": "4.0.0",
 	"description": "Typescript utilities for working with JSON",
 	"main": "lib/index.js",
 	"types": "dist/ts-json.d.ts",
@@ -16,13 +16,13 @@
 	"homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json#readme",
 	"sideEffects": false,
 	"devDependencies": {
-		"@fgv/ts-utils": "3.0.1-alpha.6",
-		"@fgv/ts-utils-jest": "3.0.1-alpha.6",
+		"@fgv/ts-utils": "4.0.0",
+		"@fgv/ts-utils-jest": "4.0.0",
 		"@types/jest": "^29.5.12",
 		"@types/mustache": "^4.2.5",
-		"@types/node": "^20.11.24",
-		"@typescript-eslint/eslint-plugin": "^7.1.0",
-		"@typescript-eslint/parser": "^7.1.0",
+		"@types/node": "^20.12.11",
+		"@typescript-eslint/eslint-plugin": "^7.9.0",
+		"@typescript-eslint/parser": "^7.9.0",
 		"eslint": "^8.57.0",
 		"eslint-config-standard": "^17.1.0",
 		"eslint-plugin-import": "^2.29.1",
@@ -31,21 +31,21 @@
 		"jest": "^29.7.0",
 		"jest-extended": "^4.0.2",
 		"mustache": "^4.2.0",
-		"rimraf": "^5.0.5",
+		"rimraf": "^5.0.7",
 		"ts-jest": "^29.1.2",
 		"ts-node": "^10.9.2",
-		"typescript": "^5.3.3",
+		"typescript": "^5.4.5",
 		"eslint-plugin-n": "^16.6.2",
-		"@rushstack/heft-node-rig": "~2.4.21",
-		"@rushstack/heft": "~0.65.8",
+		"@rushstack/heft-node-rig": "~2.6.3",
+		"@rushstack/heft": "~0.66.6",
 		"heft-jest": "~1.0.2",
 		"@types/heft-jest": "1.0.6",
-		"@microsoft/api-documenter": "^7.23.34",
-		"@fgv/ts-json-base": "3.0.1-alpha.6"
+		"@microsoft/api-documenter": "^7.24.5",
+		"@fgv/ts-json-base": "4.0.0"
 	},
 	"peerDependencies": {
-		"@fgv/ts-utils": "3.0.1-alpha.6",
-		"@fgv/ts-json-base": "3.0.1-alpha.6",
+		"@fgv/ts-utils": "4.0.0",
+		"@fgv/ts-json-base": "4.0.0",
 		"mustache": "^4.2.0"
 	},
 	"scripts": {