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

package/lib/packlets/converters/jsonConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonConverter.js","sourceRoot":"","sources":["../../../src/packlets/converters/jsonConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAA4F;AAC5F,wCAMoB;AACpB,kCAAyE;AAEzE,sCAAyF;AA8GzF;;;;;;;;GAQG;AACH,SAAgB,gCAAgC,CAC9C,OAAwC;;IAExC,MAAM,QAAQ,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,MAAK,SAAS,CAAC;IAC7C,MAAM,QAAQ,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,MAAK,SAAS,CAAC;IAC7C,MAAM,QAAQ,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC,YAAY,CAAC,EAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,2BAAiB,CAAC;IAChG,MAAM,YAAY,GAAG,QAAQ,KAAK,SAAS,CAAC;IAC5C,MAAM,YAAY,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,mCAAI,QAAQ,CAAC;IAC3D,MAAM,iBAAiB,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,mCAAI,YAAY,CAAC;IAEvE,MAAM,OAAO,GAA0B;QACrC,iBAAiB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,iBAAiB,mCAAI,QAAQ;QACzD,gBAAgB,EAAE,YAAY;QAC9B,mBAAmB,EAAE,iBAAiB;QACtC,0BAA0B,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,0BAA0B,mCAAI,iBAAiB;QACpF,0BAA0B,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,0BAA0B,mCAAI,CAAC,YAAY,IAAI,YAAY,CAAC;QACjG,aAAa,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,mCAAI,QAAQ;QACjD,qBAAqB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,qBAAqB,mCAAI,OAAO;QAChE,sBAAsB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,mCAAI,OAAO;QAClE,wBAAwB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,wBAAwB,mCAAI,QAAQ;QACvE,UAAU,EAAE,QAAQ;KACrB,CAAC;IACF,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;QACjB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;KAC7B;IACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;QACjB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;KAC7B;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AA7BD,4EA6BC;AAED;;;;;;GAMG;AACH,SAAgB,2BAA2B,CACzC,OAAwC;IAExC,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;QACjB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;KAC7B;IACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;QACjB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;KAC7B;IACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC,YAAY,CAAC,EAAE;QACzC,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;KACzC;IACD,OAAO,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAClF,CAAC;AAdD,kEAcC;AAED;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CAAC,OAAwC;IAC/E,MAAM,gBAAgB,GAAG,gCAAgC,CAAC,OAAO,CAAC,CAAC;IACnE,MAAM,OAAO,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG;QACjB,qBAAqB,EAAE,gBAAgB,CAAC,qBAAqB;QAC7D,sBAAsB,EAAE,gBAAgB,CAAC,sBAAsB;QAC/D,wBAAwB,EAAE,gBAAgB,CAAC,wBAAwB;KACpE,CAAC;IACF,MAAM,aAAa,GAAuB,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;IAElE,MAAM,KAAK,GAAsB,EAAE,CAAC;IACpC,IAAI,gBAAgB,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,iBAAiB,EAAE;QAC3E,MAAM,eAAe,mCAChB,aAAa,KAChB,gBAAgB,EAAE,gBAAgB,CAAC,gBAAgB,EACnD,iBAAiB,EAAE,gBAAgB,CAAC,iBAAiB,GACtD,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,IAAI,oBAAW,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC,CAAC;KACtE;IACD,IAAI,gBAAgB,CAAC,mBAAmB,IAAI,gBAAgB,CAAC,0BAA0B,EAAE;QACvF,MAAM,kBAAkB,mCACnB,aAAa,KAChB,0BAA0B,EAAE,gBAAgB,CAAC,0BAA0B,GACxE,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,IAAI,oBAAW,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,CAAC,CAAC;KAC3E;IACD,IAAI,gBAAgB,CAAC,0BAA0B,EAAE;QAC/C,KAAK,CAAC,IAAI,CAAC,IAAI,oBAAW,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC,CAAC;KACrE;IACD,IAAI,gBAAgB,CAAC,aAAa,EAAE;QAClC,KAAK,CAAC,IAAI,CAAC,IAAI,oBAAW,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAAC;KACpE;IAED,OAAO,mBAAU,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC;AAlCD,4DAkCC;AAED;;;;GAIG;AACH,MAAa,mBAAoB,SAAQ,qBAAU,CAAC,aAAsC;IAGxF;;;OAGG;IACH,YAAmB,MAAkB;QACnC,KAAK,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAkB;QAC/C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YACrB,IAAI,CAAC,IAAA,mBAAY,EAAC,EAAE,CAAC,EAAE;gBACrB,OAAO,IAAA,eAAI,EAAC,mBAAmB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;aACvE;YACD,OAAO,IAAA,kBAAO,EAAC,EAAE,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;gBAChD,OAAO,IAAA,eAAI,EAAC,mBAAmB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;aACtE;YACD,OAAO,IAAA,kBAAO,EAAC,EAAE,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAES,QAAQ,CAAC,IAAa,EAAE,OAAsB;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAiB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAjDD,kDAiDC;AAED;;;;GAIG;AACH,MAAa,aAAc,SAAQ,mBAAmB;IACpD;;;;;OAKG;IACH,YAAmB,OAAwC;QACzD,MAAM,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3D,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAAwC;QAC3D,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;AAtBD,sCAsBC;AAWD;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,mBAAmB;IAa7D;;;;;OAKG;IACH,YAAmB,OAAgD;QACjE,OAAO,mCAAQ,OAAO,GAAK,sBAAsB,CAAC,eAAe,CAAE,CAAC;QACpE,MAAM,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3D,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAgD;QACnE,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;;AAjCH,wDAkCC;AAjCC;;;GAGG;AACoB,sCAAe,GAAmC;IACvE,gBAAgB,EAAE,IAAI;IACtB,iBAAiB,EAAE,IAAI;IACvB,0BAA0B,EAAE,IAAI;IAChC,mBAAmB,EAAE,KAAK;IAC1B,0BAA0B,EAAE,KAAK;CAClC,CAAC;AA+BJ;;;;;GAKG;AACH,MAAa,wBAAyB,SAAQ,mBAAmB;IAW/D;;;;;OAKG;IACH,YAAmB,OAAkD;QACnE,OAAO,mCAAQ,OAAO,GAAK,wBAAwB,CAAC,kBAAkB,CAAE,CAAC;QACzE,MAAM,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3D,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAkD;QACrE,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;;AA/BH,4DAgCC;AA/BC;;;GAGG;AACoB,2CAAkB,mCACpC,sBAAsB,CAAC,eAAe,KACzC,mBAAmB,EAAE,IAAI,EACzB,0BAA0B,EAAE,IAAI,IAChC;AA+BJ;;;;;GAKG;AACH,MAAa,iBAAkB,SAAQ,mBAAmB;IAUxD;;;;;OAKG;IACH,YAAmB,OAA2C;QAC5D,OAAO,mCAAQ,OAAO,GAAK,iBAAiB,CAAC,WAAW,CAAE,CAAC;QAC3D,MAAM,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3D,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAA2C;QAC9D,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7D,CAAC;;AA9BH,8CA+BC;AA9BC;;;GAGG;AACoB,6BAAW,mCAC7B,wBAAwB,CAAC,kBAAkB,KAC9C,aAAa,EAAE,IAAI,IACnB","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 { Conversion, Converter, Result, captureResult, fail, succeed } from '@fgv/ts-utils';\nimport {\n  IJsonContext,\n  IJsonReferenceMap,\n  TemplateVars,\n  TemplateVarsExtendFunction,\n  defaultExtendVars\n} from '../context';\nimport { JsonArray, JsonObject, JsonValue, isJsonObject } from '../json';\n\nimport { EditorRules, IJsonEditorOptions, IJsonEditorRule, JsonEditor } from '../editor';\n\n/**\n * Conversion options for {@link JsonConverter | JsonConverter}.\n * @public\n */\nexport interface IJsonConverterOptions {\n  /**\n   * If `true` and if template variables are available,\n   * then string property values will be rendered using\n   * mustache and those variable values. Otherwise string\n   * properties are copied without modification.\n   *\n   * Defaults to `true` if vars are supplied with options,\n   * `false` otherwise.\n   */\n  useValueTemplates: boolean;\n\n  /**\n   * If `true` and if template variables are available,\n   * then property names will be rendered using\n   * mustache and those variable values. Otherwise\n   * property names are copied without modification.\n   *\n   * Defaults to `true` if vars are supplied with options,\n   * `false` otherwise.\n   */\n  useNameTemplates: boolean;\n\n  /**\n   * If `true` and if template variables are available,\n   * then string property names will be considered for\n   * conditionals.\n   *\n   * Default is to match {@link IJsonConverterOptions.useNameTemplates | useNameTemplates}.\n   */\n  useConditionalNames: boolean;\n\n  /**\n   * If `true` (default) then properties with unconditional names\n   * (which start with !) are flattened.\n   */\n  flattenUnconditionalValues: boolean;\n\n  /**\n   * If `true` and if both template variables and a\n   * context derivation function is available, then properties\n   * which match the multi-value name pattern will be expanded.\n   * Default matches {@link IJsonConverterOptions.useNameTemplates | useNameTemplates}.\n   *\n   * Default is `true` unless {@link IJsonConverterOptions.extendVars | extendVars} is\n   * explicitly set to `undefined`.\n   */\n  useMultiValueTemplateNames: boolean;\n\n  /**\n   * The variables (mustache view) used to render templated string names\n   * and properties.  See the mustache documentation for details of mustache\n   * syntax and the template view.\n   */\n  vars?: TemplateVars;\n\n  /**\n   * Method used to extend variables for children of an array node during\n   * expansion. Default is to use a built-in extension function unless\n   * {@link IJsonConverterOptions.extendVars | extendVars} is explicitly set to undefined.\n   */\n  extendVars?: TemplateVarsExtendFunction;\n\n  /**\n   * If `true` and if a {@link IJsonReferenceMap | references map} is supplied\n   * in {@link IJsonConverterOptions.refs | refs}, then references in the source\n   * object will be replaced with the corresponding value from the reference map.\n   *\n   * Default is `true` if {@link IJsonConverterOptions.refs | refs} are present in options,\n   * `false` otherwise.\n   */\n  useReferences: boolean;\n\n  /**\n   * An optional {@link IJsonReferenceMap | reference map} used to insert any references\n   * in the converted JSON.\n   */\n  refs?: IJsonReferenceMap;\n\n  /**\n   * If {@link IJsonConverterOptions.onInvalidPropertyName | onInvalidPropertyName} is `'error'`\n   * (default) then any property name that is invalid after template rendering causes an error\n   * and stops conversion.  If {@link IJsonConverterOptions.onInvalidPropertyName | onInvalidPropertyName}\n   * is `'ignore'`, then names which are invalid after template rendering are passed through unchanged.\n   */\n  onInvalidPropertyName: 'error' | 'ignore';\n\n  /**\n   * If {@link IJsonConverterOptions.onInvalidPropertyValue | onInvalidPropertyValue} is `'error'`\n   * (default) then any illegal property value causes an error and stops conversion.  If\n   * {@link IJsonConverterOptions.onInvalidPropertyValue | onInvalidPropertyValue} is `'ignore'` then\n   * any invalid property values are silently ignored.\n   */\n  onInvalidPropertyValue: 'error' | 'ignore';\n\n  /**\n   * If {@link IJsonConverterOptions.onUndefinedPropertyValue | onUndefinedPropertyValue} is `'error'`,\n   * then any property with value `undefined` will cause an error and stop conversion.  If\n   * {@link IJsonConverterOptions.onUndefinedPropertyValue | onUndefinedPropertyValue} is `'ignore'` (default)\n   * then any property with value `undefined` is silently ignored.\n   */\n  onUndefinedPropertyValue: 'error' | 'ignore';\n}\n\n/**\n * Merges an optionally supplied partial set of {@link IJsonConverterOptions | options} with\n * the default converter options and taking all dynamic rules into account (e.g. template usage enabled\n * if variables are supplied and disabled if not),  producing a fully-resolved set of\n * {@link IJsonConverterOptions | IJsonConverterOptions}.\n * @param partial - An optional partial {@link IJsonConverterOptions | IJsonConverterOptions}\n * to be merged.\n * @public\n */\nexport function mergeDefaultJsonConverterOptions(\n  partial?: Partial<IJsonConverterOptions>\n): IJsonConverterOptions {\n  const haveVars = partial?.vars !== undefined;\n  const haveRefs = partial?.refs !== undefined;\n  const extender = partial?.hasOwnProperty('extendVars') ? partial.extendVars : defaultExtendVars;\n  const haveExtender = extender !== undefined;\n  const namesDefault = partial?.useNameTemplates ?? haveVars;\n  const conditionsDefault = partial?.useConditionalNames ?? namesDefault;\n\n  const options: IJsonConverterOptions = {\n    useValueTemplates: partial?.useValueTemplates ?? haveVars,\n    useNameTemplates: namesDefault,\n    useConditionalNames: conditionsDefault,\n    flattenUnconditionalValues: partial?.flattenUnconditionalValues ?? conditionsDefault,\n    useMultiValueTemplateNames: partial?.useMultiValueTemplateNames ?? (haveExtender && namesDefault),\n    useReferences: partial?.useReferences ?? haveRefs,\n    onInvalidPropertyName: partial?.onInvalidPropertyName ?? 'error',\n    onInvalidPropertyValue: partial?.onInvalidPropertyValue ?? 'error',\n    onUndefinedPropertyValue: partial?.onUndefinedPropertyValue ?? 'ignore',\n    extendVars: extender\n  };\n  if (partial?.vars) {\n    options.vars = partial.vars;\n  }\n  if (partial?.refs) {\n    options.refs = partial.refs;\n  }\n  return options;\n}\n\n/**\n * Creates a new {@link IJsonContext | JSON context} using values supplied in an optional partial\n * {@link IJsonConverterOptions | converter options}.\n * @param partial - Optional partial {@link IJsonConverterOptions | IJsonConverterOptions} used to\n * populate the context.\n * @public\n */\nexport function contextFromConverterOptions(\n  partial?: Partial<IJsonConverterOptions>\n): IJsonContext | undefined {\n  const context: IJsonContext = {};\n  if (partial?.vars) {\n    context.vars = partial.vars;\n  }\n  if (partial?.refs) {\n    context.refs = partial.refs;\n  }\n  if (partial?.hasOwnProperty('extendVars')) {\n    context.extendVars = partial.extendVars;\n  }\n  return context.vars || context.refs || context.extendVars ? context : undefined;\n}\n\n/**\n * Creates a new {@link Editor.JsonEditor | JsonEditor} from an optionally supplied partial\n * {@link IJsonConverterOptions | JSON converter options}.\n * Expands supplied options with default values and constructs an editor with\n * matching configuration and defined rules.\n * @param partial - Optional partial {@link IJsonConverterOptions | IJsonConverterOptions}\n * used to create the editor.\n * @public\n */\nexport function converterOptionsToEditor(partial?: Partial<IJsonConverterOptions>): Result<JsonEditor> {\n  const converterOptions = mergeDefaultJsonConverterOptions(partial);\n  const context = contextFromConverterOptions(partial);\n  const validation = {\n    onInvalidPropertyName: converterOptions.onInvalidPropertyName,\n    onInvalidPropertyValue: converterOptions.onInvalidPropertyValue,\n    onUndefinedPropertyValue: converterOptions.onUndefinedPropertyValue\n  };\n  const editorOptions: IJsonEditorOptions = { context, validation };\n\n  const rules: IJsonEditorRule[] = [];\n  if (converterOptions.useNameTemplates || converterOptions.useValueTemplates) {\n    const templateOptions = {\n      ...editorOptions,\n      useNameTemplates: converterOptions.useNameTemplates,\n      useValueTemplates: converterOptions.useValueTemplates\n    };\n    rules.push(new EditorRules.TemplatedJsonEditorRule(templateOptions));\n  }\n  if (converterOptions.useConditionalNames || converterOptions.flattenUnconditionalValues) {\n    const conditionalOptions = {\n      ...editorOptions,\n      flattenUnconditionalValues: converterOptions.flattenUnconditionalValues\n    };\n    rules.push(new EditorRules.ConditionalJsonEditorRule(conditionalOptions));\n  }\n  if (converterOptions.useMultiValueTemplateNames) {\n    rules.push(new EditorRules.MultiValueJsonEditorRule(editorOptions));\n  }\n  if (converterOptions.useReferences) {\n    rules.push(new EditorRules.ReferenceJsonEditorRule(editorOptions));\n  }\n\n  return JsonEditor.create(editorOptions, rules);\n}\n\n/**\n * A thin wrapper to allow an arbitrary {@link Editor.JsonEditor | JsonEditor} to be used via the\n * \\@fgv/ts-utils `Converter` pattern.\n * @public\n */\nexport class JsonEditorConverter extends Conversion.BaseConverter<JsonValue, IJsonContext> {\n  public readonly editor: JsonEditor;\n\n  /**\n   * Constructs a new {@link Editor.JsonEditor | JsonEditor}Converter which uses the supplied editor\n   * @param editor -\n   */\n  public constructor(editor: JsonEditor) {\n    super((from, __self, context) => this._convert(from, context), editor.options.context);\n    this.editor = editor;\n  }\n\n  /**\n   * Constructs a new {@link Editor.JsonEditor | JsonEditor}Converter which uses the supplied editor\n   * @param editor -\n   */\n  public static createWithEditor(editor: JsonEditor): Result<JsonEditorConverter> {\n    return captureResult(() => new JsonEditorConverter(editor));\n  }\n\n  /**\n   * Gets a derived converter which fails if the resulting converted\n   * {@link JsonValue | JsonValue} is not a {@link JsonObject | JsonObject}.\n   */\n  public object(): Converter<JsonObject, IJsonContext> {\n    return this.map((jv) => {\n      if (!isJsonObject(jv)) {\n        return fail(`Cannot convert \"${JSON.stringify(jv)}\" to JSON object.`);\n      }\n      return succeed(jv);\n    });\n  }\n\n  /**\n   * Gets a derived converter which fails if the resulting converted\n   * {@link JsonValue | JsonValue} is not a {@link JsonArray | JsonArray}.\n   */\n  public array(): Converter<JsonArray, IJsonContext> {\n    return this.map((jv) => {\n      if (!Array.isArray(jv) || typeof jv !== 'object') {\n        return fail(`Cannot convert \"${JSON.stringify(jv)}\" to JSON array.`);\n      }\n      return succeed(jv);\n    });\n  }\n\n  protected _convert(from: unknown, context?: IJsonContext): Result<JsonValue> {\n    return this.editor.clone(from as JsonValue, context);\n  }\n}\n\n/**\n * An \\@fgv/ts-utils `Converter` from `unknown` to type-safe JSON, optionally\n * rendering any string property names or values using mustache with a supplied view.\n * @public\n */\nexport class JsonConverter extends JsonEditorConverter {\n  /**\n   * Constructs a new {@link JsonConverter | JsonConverter} with\n   * supplied or default options.\n   * @param options - Optional partial {@link IJsonConverterOptions | options}\n   * to configure the converter.\n   */\n  public constructor(options?: Partial<IJsonConverterOptions>) {\n    const editor = converterOptionsToEditor(options).orThrow();\n    super(editor);\n  }\n\n  /**\n   * Creates a new {@link JsonConverter | JsonConverter}.\n   * @param options - Optional partial {@link IJsonConverterOptions | options}\n   * to configure the converter.\n   * @returns `Success` with a new {@link JsonConverter | JsonConverter}, or `Failure`\n   * with an informative message if an error occurs.\n   */\n  public static create(options?: Partial<IJsonConverterOptions>): Result<JsonConverter> {\n    return captureResult(() => new JsonConverter(options));\n  }\n}\n\n/**\n * Initialization options for a {@link TemplatedJsonConverter | TemplatedJsonConverter}.\n * @public\n */\nexport type TemplatedJsonConverterOptions = Omit<\n  IJsonConverterOptions,\n  'useNameTemplates' | 'useValueTemplates' | 'useMultiValueTemplateNames'\n>;\n\n/**\n * An \\@fgv/ts-utils `Converter` from `unknown` to type-safe JSON\n * with mustache template rendering and multi-value property name rules enabled\n * regardless of initial context.\n * @public\n */\nexport class TemplatedJsonConverter extends JsonEditorConverter {\n  /**\n   * Default {@link IJsonConverterOptions | JSON converter options}\n   * to enable templated conversion.\n   */\n  public static readonly templateOptions: Partial<IJsonConverterOptions> = {\n    useNameTemplates: true,\n    useValueTemplates: true,\n    useMultiValueTemplateNames: true,\n    useConditionalNames: false,\n    flattenUnconditionalValues: false\n  };\n\n  /**\n   * Constructs a new {@link TemplatedJsonConverter | TemplatedJsonConverter} with\n   * supplied or default options.\n   * @param options - Optional partial {@link TemplatedJsonConverterOptions | options}\n   * to configure the converter.\n   */\n  public constructor(options?: Partial<TemplatedJsonConverterOptions>) {\n    options = { ...options, ...TemplatedJsonConverter.templateOptions };\n    const editor = converterOptionsToEditor(options).orThrow();\n    super(editor);\n  }\n\n  /**\n   * Constructs a new {@link TemplatedJsonConverter | TemplatedJsonConverter} with\n   * supplied or default options.\n   * @param options - Optional partial {@link TemplatedJsonConverterOptions | options}\n   * to configure the converter.\n   */\n  public static create(options?: Partial<TemplatedJsonConverterOptions>): Result<JsonConverter> {\n    return captureResult(() => new TemplatedJsonConverter(options));\n  }\n}\n\n/**\n * Options for a {@link ConditionalJsonConverter | ConditionalJsonConverter}.\n * @public\n */\nexport type ConditionalJsonConverterOptions = Omit<TemplatedJsonConverterOptions, 'useConditionalNames'>;\n\n/**\n * An \\@fgv/ts-utils `Converter` from `unknown` to type-safe JSON with mustache\n * template rendering, multi-value property name and conditional property\n * name rules enabled regardless of initial context.\n * @public\n */\nexport class ConditionalJsonConverter extends JsonEditorConverter {\n  /**\n   * Default {@link IJsonConverterOptions | JSON converter options}\n   * to enable conditional conversion.\n   */\n  public static readonly conditionalOptions: Partial<IJsonConverterOptions> = {\n    ...TemplatedJsonConverter.templateOptions,\n    useConditionalNames: true,\n    flattenUnconditionalValues: true\n  };\n\n  /**\n   * Constructs a new {@link ConditionalJsonConverter | ConditionalJsonConverter} with supplied or\n   * default options.\n   * @param options - Optional partial {@link ConditionalJsonConverterOptions | configuration or context}\n   * for the converter.\n   */\n  public constructor(options?: Partial<ConditionalJsonConverterOptions>) {\n    options = { ...options, ...ConditionalJsonConverter.conditionalOptions };\n    const editor = converterOptionsToEditor(options).orThrow();\n    super(editor);\n  }\n\n  /**\n   * Constructs a new {@link ConditionalJsonConverter | ConditionalJsonConverter} with supplied or\n   * default options.\n   * @param options - Optional partial {@link ConditionalJsonConverterOptions | configuration or context}\n   * for the converter.\n   */\n  public static create(options?: Partial<ConditionalJsonConverterOptions>): Result<JsonConverter> {\n    return captureResult(() => new ConditionalJsonConverter(options));\n  }\n}\n\n/**\n * Initialization options for a {@link RichJsonConverter | RichJsonConverter}.\n * @public\n */\nexport type RichJsonConverterOptions = Omit<ConditionalJsonConverterOptions, 'useReferences'>;\n\n/**\n * A \\@fgv/ts-utils `Converter` from `unknown` to type-safe JSON with mustache\n * template rendering, multi-value property name, conditional property\n * name, and external reference rules enabled regardless of initial context.\n * @public\n */\nexport class RichJsonConverter extends JsonEditorConverter {\n  /**\n   * Default {@link IJsonConverterOptions | JSON converter options}\n   * to enable rich conversion.\n   */\n  public static readonly richOptions: Partial<IJsonConverterOptions> = {\n    ...ConditionalJsonConverter.conditionalOptions,\n    useReferences: true\n  };\n\n  /**\n   * Constructs a new {@link RichJsonConverter | RichJsonConverter} with supplied or\n   * default options.\n   * @param options - Optional partial {@link RichJsonConverterOptions | configuration or context}\n   * for the converter.\n   */\n  public constructor(options?: Partial<RichJsonConverterOptions>) {\n    options = { ...options, ...RichJsonConverter.richOptions };\n    const editor = converterOptionsToEditor(options).orThrow();\n    super(editor);\n  }\n\n  /**\n   * Constructs a new {@link RichJsonConverter | RichJsonConverter} with supplied or\n   * default options\n   * @param options - Optional partial {@link RichJsonConverterOptions | configuration or context}\n   * for the converter.\n   */\n  public static create(options?: Partial<RichJsonConverterOptions>): Result<JsonConverter> {\n    return captureResult(() => new RichJsonConverter(options));\n  }\n}\n"]}

package/lib/packlets/editor/common.d.ts

@@ -0,0 +1,67 @@
+import { DetailedResult } from '@fgv/ts-utils';
+import { IJsonContext } from '../context';
+import { JsonValue } from '../json';
+/**
+ * Possible `DetailedResult` details for various editor operations.
+ * @public
+ */
+export type JsonEditFailureReason = 'ignore' | 'inapplicable' | 'edited' | 'error';
+/**
+ * Possible `DetailedResult` details for property edit operations.
+ * @public
+ */
+export type JsonPropertyEditFailureReason = JsonEditFailureReason | 'deferred';
+/**
+ * Possible validation rules for a {@link Editor.JsonEditor | JsonEditor}.
+ * @public
+ */
+export type JsonEditorValidationRules = 'invalidPropertyName' | 'invalidPropertyValue' | 'undefinedPropertyValue';
+/**
+ * Validation options for a {@link Editor.JsonEditor | JsonEditor}.
+ * @public
+ */
+export interface IJsonEditorValidationOptions {
+    /**
+     * If `onInvalidPropertyName` is `'error'` (default) then any property name
+     * that is invalid after template rendering causes an error and stops
+     * conversion.  If `onInvalidPropertyName` is `'ignore'`, then names which
+     * are invalid after template rendering are passed through unchanged.
+     */
+    onInvalidPropertyName: 'error' | 'ignore';
+    /**
+     * If `onInvalidPropertyValue` is `'error'` (default) then any illegal
+     * property value other than `undefined` causes an error and stops
+     * conversion.  If `onInvalidPropertyValue` is `'ignore'` then any
+     * invalid property values are silently ignored.
+     */
+    onInvalidPropertyValue: 'error' | 'ignore';
+    /**
+     * If `onUndefinedPropertyValue` is `'error'`, then any property with
+     * value `undefined` will cause an error and stop conversion.  If
+     * `onUndefinedPropertyValue` is `'ignore'` (default) then any
+     * property with value `undefined` is silently ignored.
+     */
+    onUndefinedPropertyValue: 'error' | 'ignore';
+}
+/**
+ * Initialization options for a {@link Editor.JsonEditor | JsonEditor}.
+ * @public
+ */
+export interface IJsonEditorOptions {
+    context?: IJsonContext;
+    validation: IJsonEditorValidationOptions;
+}
+/**
+ * A specialized JSON editor which does a deep clone of a supplied {@link JsonValue | JsonValue}.
+ * @public
+ */
+export interface IJsonCloneEditor {
+    /**
+     * Returns a deep clone of a supplied {@link JsonValue | JsonValue}.
+     * @param src - The {@link JsonValue | JsonValue} to be cloned.
+     * @param context - An optional {@link IJsonContext | JSON context} used for clone
+     * conversion operations.
+     */
+    clone(src: JsonValue, context?: IJsonContext): DetailedResult<JsonValue, JsonEditFailureReason>;
+}
+//# sourceMappingURL=common.d.ts.map

package/lib/packlets/editor/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/packlets/editor/common.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,cAAc,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,qBAAqB,GAAG,UAAU,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GACjC,qBAAqB,GACrB,sBAAsB,GACtB,wBAAwB,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;;OAKG;IACH,qBAAqB,EAAE,OAAO,GAAG,QAAQ,CAAC;IAE1C;;;;;OAKG;IACH,sBAAsB,EAAE,OAAO,GAAG,QAAQ,CAAC;IAE3C;;;;;OAKG;IACH,wBAAwB,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;CACjG"}

package/lib/packlets/editor/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/packlets/editor/common.ts"],"names":[],"mappings":"","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 */\nimport { DetailedResult } from '@fgv/ts-utils';\nimport { IJsonContext } from '../context';\nimport { JsonValue } from '../json';\n\n/**\n * Possible `DetailedResult` details for various editor operations.\n * @public\n */\nexport type JsonEditFailureReason = 'ignore' | 'inapplicable' | 'edited' | 'error';\n\n/**\n * Possible `DetailedResult` details for property edit operations.\n * @public\n */\nexport type JsonPropertyEditFailureReason = JsonEditFailureReason | 'deferred';\n\n/**\n * Possible validation rules for a {@link Editor.JsonEditor | JsonEditor}.\n * @public\n */\nexport type JsonEditorValidationRules =\n  | 'invalidPropertyName'\n  | 'invalidPropertyValue'\n  | 'undefinedPropertyValue';\n\n/**\n * Validation options for a {@link Editor.JsonEditor | JsonEditor}.\n * @public\n */\nexport interface IJsonEditorValidationOptions {\n  /**\n   * If `onInvalidPropertyName` is `'error'` (default) then any property name\n   * that is invalid after template rendering causes an error and stops\n   * conversion.  If `onInvalidPropertyName` is `'ignore'`, then names which\n   * are invalid after template rendering are passed through unchanged.\n   */\n  onInvalidPropertyName: 'error' | 'ignore';\n\n  /**\n   * If `onInvalidPropertyValue` is `'error'` (default) then any illegal\n   * property value other than `undefined` causes an error and stops\n   * conversion.  If `onInvalidPropertyValue` is `'ignore'` then any\n   * invalid property values are silently ignored.\n   */\n  onInvalidPropertyValue: 'error' | 'ignore';\n\n  /**\n   * If `onUndefinedPropertyValue` is `'error'`, then any property with\n   * value `undefined` will cause an error and stop conversion.  If\n   * `onUndefinedPropertyValue` is `'ignore'` (default) then any\n   * property with value `undefined` is silently ignored.\n   */\n  onUndefinedPropertyValue: 'error' | 'ignore';\n}\n\n/**\n * Initialization options for a {@link Editor.JsonEditor | JsonEditor}.\n * @public\n */\nexport interface IJsonEditorOptions {\n  context?: IJsonContext;\n  validation: IJsonEditorValidationOptions;\n}\n\n/**\n * A specialized JSON editor which does a deep clone of a supplied {@link JsonValue | JsonValue}.\n * @public\n */\nexport interface IJsonCloneEditor {\n  /**\n   * Returns a deep clone of a supplied {@link JsonValue | JsonValue}.\n   * @param src - The {@link JsonValue | JsonValue} to be cloned.\n   * @param context - An optional {@link IJsonContext | JSON context} used for clone\n   * conversion operations.\n   */\n  clone(src: JsonValue, context?: IJsonContext): DetailedResult<JsonValue, JsonEditFailureReason>;\n}\n"]}

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

@@ -0,0 +1,8 @@
+import * as EditorRules from './rules';
+export * from './common';
+export { JsonEditor } from './jsonEditor';
+export { IJsonEditorRule } from './jsonEditorRule';
+export { JsonEditorState } from './jsonEditorState';
+export { IReferenceMapKeyPolicyValidateOptions, PrefixedJsonMap, ReferenceMapKeyPolicy, SimpleJsonMap } from './jsonReferenceMap';
+export { EditorRules };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/editor/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,WAAW,MAAM,SAAS,CAAC;AAEvC,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACL,qCAAqC,EACrC,eAAe,EACf,qBAAqB,EACrB,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/{jsonEditor → lib/packlets/editor}/index.js

@@ -36,9 +36,6 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-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);
-};
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
@@ -46,11 +43,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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 });
-exports.Rules = void 0;
+exports.EditorRules = exports.SimpleJsonMap = exports.ReferenceMapKeyPolicy = exports.PrefixedJsonMap = exports.JsonEditorState = exports.JsonEditor = void 0;
+const EditorRules = __importStar(require("./rules"));
+exports.EditorRules = EditorRules;
 __exportStar(require("./common"), exports);
-__exportStar(require("./jsonEditorRule"), exports);
-__exportStar(require("./jsonEditor"), exports);
-__exportStar(require("./jsonEditorState"), exports);
-exports.Rules = __importStar(require("./rules"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvanNvbkVkaXRvci9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUVILDJDQUF5QjtBQUN6QixtREFBaUM7QUFDakMsK0NBQTZCO0FBQzdCLG9EQUFrQztBQUNsQyxpREFBaUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IChjKSAyMDIzIEVyaWsgRm9ydHVuZVxuICpcbiAqIFBlcm1pc3Npb24gaXMgaGVyZWJ5IGdyYW50ZWQsIGZyZWUgb2YgY2hhcmdlLCB0byBhbnkgcGVyc29uIG9idGFpbmluZyBhIGNvcHlcbiAqIG9mIHRoaXMgc29mdHdhcmUgYW5kIGFzc29jaWF0ZWQgZG9jdW1lbnRhdGlvbiBmaWxlcyAodGhlIFwiU29mdHdhcmVcIiksIHRvIGRlYWxcbiAqIGluIHRoZSBTb2Z0d2FyZSB3aXRob3V0IHJlc3RyaWN0aW9uLCBpbmNsdWRpbmcgd2l0aG91dCBsaW1pdGF0aW9uIHRoZSByaWdodHNcbiAqIHRvIHVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwgcHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGxcbiAqIGNvcGllcyBvZiB0aGUgU29mdHdhcmUsIGFuZCB0byBwZXJtaXQgcGVyc29ucyB0byB3aG9tIHRoZSBTb2Z0d2FyZSBpc1xuICogZnVybmlzaGVkIHRvIGRvIHNvLCBzdWJqZWN0IHRvIHRoZSBmb2xsb3dpbmcgY29uZGl0aW9uczpcbiAqXG4gKiBUaGUgYWJvdmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGljZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGxcbiAqIGNvcGllcyBvciBzdWJzdGFudGlhbCBwb3J0aW9ucyBvZiB0aGUgU29mdHdhcmUuXG4gKlxuICogVEhFIFNPRlRXQVJFIElTIFBST1ZJREVEIFwiQVMgSVNcIiwgV0lUSE9VVCBXQVJSQU5UWSBPRiBBTlkgS0lORCwgRVhQUkVTUyBPUlxuICogSU1QTElFRCwgSU5DTFVESU5HIEJVVCBOT1QgTElNSVRFRCBUTyBUSEUgV0FSUkFOVElFUyBPRiBNRVJDSEFOVEFCSUxJVFksXG4gKiBGSVRORVNTIEZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklOR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEVcbiAqIEFVVEhPUlMgT1IgQ09QWVJJR0hUIEhPTERFUlMgQkUgTElBQkxFIEZPUiBBTlkgQ0xBSU0sIERBTUFHRVMgT1IgT1RIRVJcbiAqIExJQUJJTElUWSwgV0hFVEhFUiBJTiBBTiBBQ1RJT04gT0YgQ09OVFJBQ1QsIFRPUlQgT1IgT1RIRVJXSVNFLCBBUklTSU5HIEZST00sXG4gKiBPVVQgT0YgT1IgSU4gQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBUSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRVxuICogU09GVFdBUkUuXG4gKi9cblxuZXhwb3J0ICogZnJvbSAnLi9jb21tb24nO1xuZXhwb3J0ICogZnJvbSAnLi9qc29uRWRpdG9yUnVsZSc7XG5leHBvcnQgKiBmcm9tICcuL2pzb25FZGl0b3InO1xuZXhwb3J0ICogZnJvbSAnLi9qc29uRWRpdG9yU3RhdGUnO1xuZXhwb3J0ICogYXMgUnVsZXMgZnJvbSAnLi9ydWxlcyc7XG4iXX0=
+var jsonEditor_1 = require("./jsonEditor");
+Object.defineProperty(exports, "JsonEditor", { enumerable: true, get: function () { return jsonEditor_1.JsonEditor; } });
+var jsonEditorState_1 = require("./jsonEditorState");
+Object.defineProperty(exports, "JsonEditorState", { enumerable: true, get: function () { return jsonEditorState_1.JsonEditorState; } });
+var jsonReferenceMap_1 = require("./jsonReferenceMap");
+Object.defineProperty(exports, "PrefixedJsonMap", { enumerable: true, get: function () { return jsonReferenceMap_1.PrefixedJsonMap; } });
+Object.defineProperty(exports, "ReferenceMapKeyPolicy", { enumerable: true, get: function () { return jsonReferenceMap_1.ReferenceMapKeyPolicy; } });
+Object.defineProperty(exports, "SimpleJsonMap", { enumerable: true, get: function () { return jsonReferenceMap_1.SimpleJsonMap; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/editor/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,qDAAuC;AAY9B,kCAAW;AAVpB,2CAAyB;AACzB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AAEnB,qDAAoD;AAA3C,kHAAA,eAAe,OAAA;AACxB,uDAK4B;AAH1B,mHAAA,eAAe,OAAA;AACf,yHAAA,qBAAqB,OAAA;AACrB,iHAAA,aAAa,OAAA","sourcesContent":["/*\n * Copyright (c) 2023 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 * as EditorRules from './rules';\n\nexport * from './common';\nexport { JsonEditor } from './jsonEditor';\nexport { IJsonEditorRule } from './jsonEditorRule';\nexport { JsonEditorState } from './jsonEditorState';\nexport {\n  IReferenceMapKeyPolicyValidateOptions,\n  PrefixedJsonMap,\n  ReferenceMapKeyPolicy,\n  SimpleJsonMap\n} from './jsonReferenceMap';\nexport { EditorRules };\n"]}

package/lib/packlets/editor/jsonEditor.d.ts

@@ -0,0 +1,155 @@
+import { DetailedResult, Result } from '@fgv/ts-utils';
+import { IJsonContext } from '../context';
+import { JsonArray, JsonObject, JsonValue } from '../json';
+import { IJsonCloneEditor, IJsonEditorOptions, JsonEditFailureReason, JsonPropertyEditFailureReason } from './common';
+import { IJsonEditorRule } from './jsonEditorRule';
+import { JsonEditorState } from './jsonEditorState';
+/**
+ * A {@link JsonEditor | JsonEditor} can be used to edit JSON objects in place or to
+ * clone any JSON value, applying a default context and optional set of editor rules that
+ * were supplied at initialization.
+ * @public
+ */
+export declare class JsonEditor implements IJsonCloneEditor {
+    /**
+     * Default singleton {@link Editor.JsonEditor | JsonEditor}.
+     * @internal
+     */
+    protected static _default?: JsonEditor;
+    /**
+     * Full set of {@link Editor.IJsonEditorOptions | editor options} in effect for this editor.
+     */
+    options: IJsonEditorOptions;
+    /**
+     * The set of {@link Editor.IJsonEditorRule | editor rules} applied by this editor.
+     * @internal
+     */
+    protected _rules: IJsonEditorRule[];
+    /**
+     * Protected constructor for {@link Editor.JsonEditor | JsonEditor} and derived classes.
+     * External consumers should instantiate via the {@link Editor.JsonEditor.create | create static method}.
+     * @param options - Optional partial {@link Editor.IJsonEditorOptions | editor options} for the
+     * constructed editor.
+     * @param rules - Any {@link Editor.IJsonEditorRule | editor rules} to be applied by the editor.
+     * @internal
+     */
+    protected constructor(options?: Partial<IJsonEditorOptions>, rules?: IJsonEditorRule[]);
+    /**
+     * Default singleton {@link Editor.JsonEditor | JsonEditor} for simple use. Applies all rules
+     * but with no default context.
+     */
+    static get default(): JsonEditor;
+    /**
+     * Constructs a new {@link Editor.JsonEditor | JsonEditor}.
+     * @param options - Optional partial {@link Editor.IJsonEditorOptions | editor options} for the
+     * constructed editor.
+     * @param rules - Optional set of {@link Editor.IJsonEditorRule | editor rules} to be applied by the editor.
+     * @readonly A new {@link Editor.JsonEditor | JsonEditor}.
+     */
+    static create(options?: Partial<IJsonEditorOptions>, rules?: IJsonEditorRule[]): Result<JsonEditor>;
+    /**
+     * Gets the default set of rules to be applied for a given set of options.
+     * By default, all available rules (templates, conditionals, multi-value and references)
+     * are applied.
+     * @param options - Optional partial {@link Editor.IJsonEditorOptions | editor options} for
+     * all rules.
+     * @returns Default {@link Editor.IJsonEditorRule | editor rules} with any supplied options
+     * applied.
+     */
+    static getDefaultRules(options?: IJsonEditorOptions): Result<IJsonEditorRule[]>;
+    /**
+     * @internal
+     */
+    protected static _getDefaultOptions(options?: Partial<IJsonEditorOptions>): Result<IJsonEditorOptions>;
+    /**
+     * Merges a supplied source object into a supplied target, updating the target object.
+     * @param target - The target {@link JsonObject | object} to be updated
+     * @param src - The source {@link JsonObject | object} to be merged
+     * @param runtimeContext - An optional {@link IJsonContext | IJsonContext} supplying variables
+     * and references.
+     * @returns `Success` with the original source {@link JsonObject | object} if merge was successful.
+     * Returns `Failure` with details if an error occurs.
+     */
+    mergeObjectInPlace(target: JsonObject, src: JsonObject, runtimeContext?: IJsonContext): Result<JsonObject>;
+    /**
+     * Merges multiple supplied source objects into a supplied target, updating the target
+     * object and using the default context supplied at creation time.
+     * @param target - The target {@link JsonObject | object} to be updated
+     * @param srcObjects - {@link JsonObject | Objects} to be merged into the target object, in the order
+     * supplied.
+     * @returns `Success` with the original source {@link JsonObject | object} if merge was successful.
+     * Returns `Failure` with details if an error occurs.
+     */
+    mergeObjectsInPlace(target: JsonObject, srcObjects: JsonObject[]): Result<JsonObject>;
+    /**
+     * Merges multiple supplied source objects into a supplied target, updating the target
+     * object and using an optional {@link IJsonContext | context} supplied in the call.
+     * @param context - An optional {@link IJsonContext | IJsonContext} supplying variables and
+     * references.
+     * @param base - The base {@link JsonObject | object} to be updated
+     * @param srcObjects - Objects to be merged into the target object, in the order supplied.
+     * @returns `Success` with the original source {@link JsonObject | object} if merge was successful.
+     * Returns `Failure` with details if an error occurs.
+     */
+    mergeObjectsInPlaceWithContext(context: IJsonContext | undefined, base: JsonObject, srcObjects: JsonObject[]): Result<JsonObject>;
+    /**
+     * Deep clones a supplied {@link JsonValue | JSON value}, applying all editor rules and a default
+     * or optionally supplied context
+     * @param src - The {@link JsonValue | JsonValue} to be cloned.
+     * @param context - An optional {@link IJsonContext | JSON context} supplying variables and references.
+     */
+    clone(src: JsonValue, context?: IJsonContext): DetailedResult<JsonValue, JsonEditFailureReason>;
+    /**
+     *
+     * @param target -
+     * @param src -
+     * @param state -
+     * @returns
+     * @internal
+     */
+    protected _mergeObjectInPlace(target: JsonObject, src: JsonObject, state: JsonEditorState): Result<JsonObject>;
+    /**
+     *
+     * @param src -
+     * @param context -
+     * @returns
+     * @internal
+     */
+    protected _cloneArray(src: JsonArray, context?: IJsonContext): DetailedResult<JsonArray, JsonEditFailureReason>;
+    /**
+     *
+     * @param target -
+     * @param key -
+     * @param newValue -
+     * @param state -
+     * @returns
+     * @internal
+     */
+    protected _mergeClonedProperty(target: JsonObject, key: string, newValue: JsonValue, state: JsonEditorState): DetailedResult<JsonValue, JsonEditFailureReason>;
+    /**
+     *
+     * @param key -
+     * @param value -
+     * @param state -
+     * @returns
+     * @internal
+     */
+    protected _editProperty(key: string, value: JsonValue, state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
+    /**
+     *
+     * @param value -
+     * @param state -
+     * @returns
+     * @internal
+     */
+    protected _editValue(value: JsonValue, state: JsonEditorState): DetailedResult<JsonValue, JsonEditFailureReason>;
+    /**
+     *
+     * @param target -
+     * @param state -
+     * @returns
+     * @internal
+     */
+    protected _finalizeAndMerge(target: JsonObject, state: JsonEditorState): DetailedResult<JsonObject, JsonEditFailureReason>;
+}
+//# sourceMappingURL=jsonEditor.d.ts.map

package/lib/packlets/editor/jsonEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonEditor.d.ts","sourceRoot":"","sources":["../../../src/packlets/editor/jsonEditor.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,cAAc,EACd,MAAM,EAQP,MAAM,eAAe,CAAC;AAQvB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAA8C,MAAM,SAAS,CAAC;AACvG,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAElB,qBAAqB,EACrB,6BAA6B,EAC9B,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,gBAAgB;IACjD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAEvC;;OAEG;IACI,OAAO,EAAE,kBAAkB,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC;IAEpC;;;;;;;OAOG;IACH,SAAS,aAAa,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,EAAE,eAAe,EAAE;IAKtF;;;OAGG;IACH,WAAkB,OAAO,IAAI,UAAU,CAMtC;IAED;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;IAI1G;;;;;;;;OAQG;WACW,eAAe,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;IAStF;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,MAAM,CAAC,kBAAkB,CAAC;IAatG;;;;;;;;OAQG;IACI,kBAAkB,CACvB,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,UAAU,EACf,cAAc,CAAC,EAAE,YAAY,GAC5B,MAAM,CAAC,UAAU,CAAC;IAOrB;;;;;;;;OAQG;IACI,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;IAI5F;;;;;;;;;OASG;IACI,8BAA8B,CACnC,OAAO,EAAE,YAAY,GAAG,SAAS,EACjC,IAAI,EAAE,UAAU,EAChB,UAAU,EAAE,UAAU,EAAE,GACvB,MAAM,CAAC,UAAU,CAAC;IAUrB;;;;;OAKG;IACI,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IA6BtG;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAC3B,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,eAAe,GACrB,MAAM,CAAC,UAAU,CAAC;IA+BrB;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,CACnB,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,YAAY,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAYnD;;;;;;;;OAQG;IACH,SAAS,CAAC,oBAAoB,CAC5B,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAgCnD;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,CACrB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC;IAU5D;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,CAClB,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAUnD;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,eAAe,GACrB,cAAc,CAAC,UAAU,EAAE,qBAAqB,CAAC;CAoBrD"}