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

package/{jsonEditor → lib/packlets/converters}/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,14 @@ 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;
-__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=
+exports.File = exports.Converters = void 0;
+const Converters = __importStar(require("./converters"));
+exports.Converters = Converters;
+const File = __importStar(require("./file"));
+exports.File = File;
+__exportStar(require("./jsonConverter"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/converters/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,yDAA2C;AAIlC,gCAAU;AAHnB,6CAA+B;AAGV,oBAAI;AADzB,kDAAgC","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 Converters from './converters';\nimport * as File from './file';\n\nexport * from './jsonConverter';\nexport { Converters, File };\n"]}

package/lib/packlets/converters/jsonConverter.d.ts

@@ -0,0 +1,276 @@
+import { Conversion, Converter, Result } from '@fgv/ts-utils';
+import { IJsonContext, IJsonReferenceMap, TemplateVars, TemplateVarsExtendFunction } from '../context';
+import { JsonArray, JsonObject, JsonValue } from '../json';
+import { JsonEditor } from '../editor';
+/**
+ * Conversion options for {@link JsonConverter | JsonConverter}.
+ * @public
+ */
+export interface IJsonConverterOptions {
+    /**
+     * If `true` and if template variables are available,
+     * then string property values will be rendered using
+     * mustache and those variable values. Otherwise string
+     * properties are copied without modification.
+     *
+     * Defaults to `true` if vars are supplied with options,
+     * `false` otherwise.
+     */
+    useValueTemplates: boolean;
+    /**
+     * If `true` and if template variables are available,
+     * then property names will be rendered using
+     * mustache and those variable values. Otherwise
+     * property names are copied without modification.
+     *
+     * Defaults to `true` if vars are supplied with options,
+     * `false` otherwise.
+     */
+    useNameTemplates: boolean;
+    /**
+     * If `true` and if template variables are available,
+     * then string property names will be considered for
+     * conditionals.
+     *
+     * Default is to match {@link IJsonConverterOptions.useNameTemplates | useNameTemplates}.
+     */
+    useConditionalNames: boolean;
+    /**
+     * If `true` (default) then properties with unconditional names
+     * (which start with !) are flattened.
+     */
+    flattenUnconditionalValues: boolean;
+    /**
+     * If `true` and if both template variables and a
+     * context derivation function is available, then properties
+     * which match the multi-value name pattern will be expanded.
+     * Default matches {@link IJsonConverterOptions.useNameTemplates | useNameTemplates}.
+     *
+     * Default is `true` unless {@link IJsonConverterOptions.extendVars | extendVars} is
+     * explicitly set to `undefined`.
+     */
+    useMultiValueTemplateNames: boolean;
+    /**
+     * The variables (mustache view) used to render templated string names
+     * and properties.  See the mustache documentation for details of mustache
+     * syntax and the template view.
+     */
+    vars?: TemplateVars;
+    /**
+     * Method used to extend variables for children of an array node during
+     * expansion. Default is to use a built-in extension function unless
+     * {@link IJsonConverterOptions.extendVars | extendVars} is explicitly set to undefined.
+     */
+    extendVars?: TemplateVarsExtendFunction;
+    /**
+     * If `true` and if a {@link IJsonReferenceMap | references map} is supplied
+     * in {@link IJsonConverterOptions.refs | refs}, then references in the source
+     * object will be replaced with the corresponding value from the reference map.
+     *
+     * Default is `true` if {@link IJsonConverterOptions.refs | refs} are present in options,
+     * `false` otherwise.
+     */
+    useReferences: boolean;
+    /**
+     * An optional {@link IJsonReferenceMap | reference map} used to insert any references
+     * in the converted JSON.
+     */
+    refs?: IJsonReferenceMap;
+    /**
+     * If {@link IJsonConverterOptions.onInvalidPropertyName | onInvalidPropertyName} is `'error'`
+     * (default) then any property name that is invalid after template rendering causes an error
+     * and stops conversion.  If {@link IJsonConverterOptions.onInvalidPropertyName | onInvalidPropertyName}
+     * is `'ignore'`, then names which are invalid after template rendering are passed through unchanged.
+     */
+    onInvalidPropertyName: 'error' | 'ignore';
+    /**
+     * If {@link IJsonConverterOptions.onInvalidPropertyValue | onInvalidPropertyValue} is `'error'`
+     * (default) then any illegal property value causes an error and stops conversion.  If
+     * {@link IJsonConverterOptions.onInvalidPropertyValue | onInvalidPropertyValue} is `'ignore'` then
+     * any invalid property values are silently ignored.
+     */
+    onInvalidPropertyValue: 'error' | 'ignore';
+    /**
+     * If {@link IJsonConverterOptions.onUndefinedPropertyValue | onUndefinedPropertyValue} is `'error'`,
+     * then any property with value `undefined` will cause an error and stop conversion.  If
+     * {@link IJsonConverterOptions.onUndefinedPropertyValue | onUndefinedPropertyValue} is `'ignore'` (default)
+     * then any property with value `undefined` is silently ignored.
+     */
+    onUndefinedPropertyValue: 'error' | 'ignore';
+}
+/**
+ * Merges an optionally supplied partial set of {@link IJsonConverterOptions | options} with
+ * the default converter options and taking all dynamic rules into account (e.g. template usage enabled
+ * if variables are supplied and disabled if not),  producing a fully-resolved set of
+ * {@link IJsonConverterOptions | IJsonConverterOptions}.
+ * @param partial - An optional partial {@link IJsonConverterOptions | IJsonConverterOptions}
+ * to be merged.
+ * @public
+ */
+export declare function mergeDefaultJsonConverterOptions(partial?: Partial<IJsonConverterOptions>): IJsonConverterOptions;
+/**
+ * Creates a new {@link IJsonContext | JSON context} using values supplied in an optional partial
+ * {@link IJsonConverterOptions | converter options}.
+ * @param partial - Optional partial {@link IJsonConverterOptions | IJsonConverterOptions} used to
+ * populate the context.
+ * @public
+ */
+export declare function contextFromConverterOptions(partial?: Partial<IJsonConverterOptions>): IJsonContext | undefined;
+/**
+ * Creates a new {@link Editor.JsonEditor | JsonEditor} from an optionally supplied partial
+ * {@link IJsonConverterOptions | JSON converter options}.
+ * Expands supplied options with default values and constructs an editor with
+ * matching configuration and defined rules.
+ * @param partial - Optional partial {@link IJsonConverterOptions | IJsonConverterOptions}
+ * used to create the editor.
+ * @public
+ */
+export declare function converterOptionsToEditor(partial?: Partial<IJsonConverterOptions>): Result<JsonEditor>;
+/**
+ * A thin wrapper to allow an arbitrary {@link Editor.JsonEditor | JsonEditor} to be used via the
+ * \@fgv/ts-utils `Converter` pattern.
+ * @public
+ */
+export declare class JsonEditorConverter extends Conversion.BaseConverter<JsonValue, IJsonContext> {
+    readonly editor: JsonEditor;
+    /**
+     * Constructs a new {@link Editor.JsonEditor | JsonEditor}Converter which uses the supplied editor
+     * @param editor -
+     */
+    constructor(editor: JsonEditor);
+    /**
+     * Constructs a new {@link Editor.JsonEditor | JsonEditor}Converter which uses the supplied editor
+     * @param editor -
+     */
+    static createWithEditor(editor: JsonEditor): Result<JsonEditorConverter>;
+    /**
+     * Gets a derived converter which fails if the resulting converted
+     * {@link JsonValue | JsonValue} is not a {@link JsonObject | JsonObject}.
+     */
+    object(): Converter<JsonObject, IJsonContext>;
+    /**
+     * Gets a derived converter which fails if the resulting converted
+     * {@link JsonValue | JsonValue} is not a {@link JsonArray | JsonArray}.
+     */
+    array(): Converter<JsonArray, IJsonContext>;
+    protected _convert(from: unknown, context?: IJsonContext): Result<JsonValue>;
+}
+/**
+ * An \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON, optionally
+ * rendering any string property names or values using mustache with a supplied view.
+ * @public
+ */
+export declare class JsonConverter extends JsonEditorConverter {
+    /**
+     * Constructs a new {@link JsonConverter | JsonConverter} with
+     * supplied or default options.
+     * @param options - Optional partial {@link IJsonConverterOptions | options}
+     * to configure the converter.
+     */
+    constructor(options?: Partial<IJsonConverterOptions>);
+    /**
+     * Creates a new {@link JsonConverter | JsonConverter}.
+     * @param options - Optional partial {@link IJsonConverterOptions | options}
+     * to configure the converter.
+     * @returns `Success` with a new {@link JsonConverter | JsonConverter}, or `Failure`
+     * with an informative message if an error occurs.
+     */
+    static create(options?: Partial<IJsonConverterOptions>): Result<JsonConverter>;
+}
+/**
+ * Initialization options for a {@link TemplatedJsonConverter | TemplatedJsonConverter}.
+ * @public
+ */
+export type TemplatedJsonConverterOptions = Omit<IJsonConverterOptions, 'useNameTemplates' | 'useValueTemplates' | 'useMultiValueTemplateNames'>;
+/**
+ * An \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON
+ * with mustache template rendering and multi-value property name rules enabled
+ * regardless of initial context.
+ * @public
+ */
+export declare class TemplatedJsonConverter extends JsonEditorConverter {
+    /**
+     * Default {@link IJsonConverterOptions | JSON converter options}
+     * to enable templated conversion.
+     */
+    static readonly templateOptions: Partial<IJsonConverterOptions>;
+    /**
+     * Constructs a new {@link TemplatedJsonConverter | TemplatedJsonConverter} with
+     * supplied or default options.
+     * @param options - Optional partial {@link TemplatedJsonConverterOptions | options}
+     * to configure the converter.
+     */
+    constructor(options?: Partial<TemplatedJsonConverterOptions>);
+    /**
+     * Constructs a new {@link TemplatedJsonConverter | TemplatedJsonConverter} with
+     * supplied or default options.
+     * @param options - Optional partial {@link TemplatedJsonConverterOptions | options}
+     * to configure the converter.
+     */
+    static create(options?: Partial<TemplatedJsonConverterOptions>): Result<JsonConverter>;
+}
+/**
+ * Options for a {@link ConditionalJsonConverter | ConditionalJsonConverter}.
+ * @public
+ */
+export type ConditionalJsonConverterOptions = Omit<TemplatedJsonConverterOptions, 'useConditionalNames'>;
+/**
+ * An \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON with mustache
+ * template rendering, multi-value property name and conditional property
+ * name rules enabled regardless of initial context.
+ * @public
+ */
+export declare class ConditionalJsonConverter extends JsonEditorConverter {
+    /**
+     * Default {@link IJsonConverterOptions | JSON converter options}
+     * to enable conditional conversion.
+     */
+    static readonly conditionalOptions: Partial<IJsonConverterOptions>;
+    /**
+     * Constructs a new {@link ConditionalJsonConverter | ConditionalJsonConverter} with supplied or
+     * default options.
+     * @param options - Optional partial {@link ConditionalJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    constructor(options?: Partial<ConditionalJsonConverterOptions>);
+    /**
+     * Constructs a new {@link ConditionalJsonConverter | ConditionalJsonConverter} with supplied or
+     * default options.
+     * @param options - Optional partial {@link ConditionalJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    static create(options?: Partial<ConditionalJsonConverterOptions>): Result<JsonConverter>;
+}
+/**
+ * Initialization options for a {@link RichJsonConverter | RichJsonConverter}.
+ * @public
+ */
+export type RichJsonConverterOptions = Omit<ConditionalJsonConverterOptions, 'useReferences'>;
+/**
+ * A \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON with mustache
+ * template rendering, multi-value property name, conditional property
+ * name, and external reference rules enabled regardless of initial context.
+ * @public
+ */
+export declare class RichJsonConverter extends JsonEditorConverter {
+    /**
+     * Default {@link IJsonConverterOptions | JSON converter options}
+     * to enable rich conversion.
+     */
+    static readonly richOptions: Partial<IJsonConverterOptions>;
+    /**
+     * Constructs a new {@link RichJsonConverter | RichJsonConverter} with supplied or
+     * default options.
+     * @param options - Optional partial {@link RichJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    constructor(options?: Partial<RichJsonConverterOptions>);
+    /**
+     * Constructs a new {@link RichJsonConverter | RichJsonConverter} with supplied or
+     * default options
+     * @param options - Optional partial {@link RichJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    static create(options?: Partial<RichJsonConverterOptions>): Result<JsonConverter>;
+}
+//# sourceMappingURL=jsonConverter.d.ts.map

package/lib/packlets/converters/jsonConverter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/jsonConverter.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAgC,MAAM,eAAe,CAAC;AAC5F,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,0BAA0B,EAE3B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAgB,MAAM,SAAS,CAAC;AAEzE,OAAO,EAAoD,UAAU,EAAE,MAAM,WAAW,CAAC;AAEzF;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;OAQG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;;;;;;OAQG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;;;OAMG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;;;;;;;OAQG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;;;OAIG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC;IAExC;;;;;;;OAOG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;IAEzB;;;;;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;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACvC,qBAAqB,CA2BvB;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACvC,YAAY,GAAG,SAAS,CAY1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAkCrG;AAED;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,UAAU,CAAC,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC;IACxF,SAAgB,MAAM,EAAE,UAAU,CAAC;IAEnC;;;OAGG;gBACgB,MAAM,EAAE,UAAU;IAKrC;;;OAGG;WACW,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,mBAAmB,CAAC;IAI/E;;;OAGG;IACI,MAAM,IAAI,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC;IASpD;;;OAGG;IACI,KAAK,IAAI,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC;IASlD,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC;CAG7E;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,mBAAmB;IACpD;;;;;OAKG;gBACgB,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAK3D;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC;CAGtF;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAC9C,qBAAqB,EACrB,kBAAkB,GAAG,mBAAmB,GAAG,4BAA4B,CACxE,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,sBAAuB,SAAQ,mBAAmB;IAC7D;;;OAGG;IACH,gBAAuB,eAAe,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAMpE;IAEF;;;;;OAKG;gBACgB,OAAO,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC;IAMnE;;;;;OAKG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC;CAG9F;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAAC,6BAA6B,EAAE,qBAAqB,CAAC,CAAC;AAEzG;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,mBAAmB;IAC/D;;;OAGG;IACH,gBAAuB,kBAAkB,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAIvE;IAEF;;;;;OAKG;gBACgB,OAAO,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC;IAMrE;;;;;OAKG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC;CAGhG;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,+BAA+B,EAAE,eAAe,CAAC,CAAC;AAE9F;;;;;GAKG;AACH,qBAAa,iBAAkB,SAAQ,mBAAmB;IACxD;;;OAGG;IACH,gBAAuB,WAAW,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAGhE;IAEF;;;;;OAKG;gBACgB,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC;IAM9D;;;;;OAKG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC;CAGzF"}

package/lib/packlets/converters/jsonConverter.js

@@ -0,0 +1,310 @@
+"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.RichJsonConverter = exports.ConditionalJsonConverter = exports.TemplatedJsonConverter = exports.JsonConverter = exports.JsonEditorConverter = exports.converterOptionsToEditor = exports.contextFromConverterOptions = exports.mergeDefaultJsonConverterOptions = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const context_1 = require("../context");
+const json_1 = require("../json");
+const editor_1 = require("../editor");
+/**
+ * Merges an optionally supplied partial set of {@link IJsonConverterOptions | options} with
+ * the default converter options and taking all dynamic rules into account (e.g. template usage enabled
+ * if variables are supplied and disabled if not),  producing a fully-resolved set of
+ * {@link IJsonConverterOptions | IJsonConverterOptions}.
+ * @param partial - An optional partial {@link IJsonConverterOptions | IJsonConverterOptions}
+ * to be merged.
+ * @public
+ */
+function mergeDefaultJsonConverterOptions(partial) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    const haveVars = (partial === null || partial === void 0 ? void 0 : partial.vars) !== undefined;
+    const haveRefs = (partial === null || partial === void 0 ? void 0 : partial.refs) !== undefined;
+    const extender = (partial === null || partial === void 0 ? void 0 : partial.hasOwnProperty('extendVars')) ? partial.extendVars : context_1.defaultExtendVars;
+    const haveExtender = extender !== undefined;
+    const namesDefault = (_a = partial === null || partial === void 0 ? void 0 : partial.useNameTemplates) !== null && _a !== void 0 ? _a : haveVars;
+    const conditionsDefault = (_b = partial === null || partial === void 0 ? void 0 : partial.useConditionalNames) !== null && _b !== void 0 ? _b : namesDefault;
+    const options = {
+        useValueTemplates: (_c = partial === null || partial === void 0 ? void 0 : partial.useValueTemplates) !== null && _c !== void 0 ? _c : haveVars,
+        useNameTemplates: namesDefault,
+        useConditionalNames: conditionsDefault,
+        flattenUnconditionalValues: (_d = partial === null || partial === void 0 ? void 0 : partial.flattenUnconditionalValues) !== null && _d !== void 0 ? _d : conditionsDefault,
+        useMultiValueTemplateNames: (_e = partial === null || partial === void 0 ? void 0 : partial.useMultiValueTemplateNames) !== null && _e !== void 0 ? _e : (haveExtender && namesDefault),
+        useReferences: (_f = partial === null || partial === void 0 ? void 0 : partial.useReferences) !== null && _f !== void 0 ? _f : haveRefs,
+        onInvalidPropertyName: (_g = partial === null || partial === void 0 ? void 0 : partial.onInvalidPropertyName) !== null && _g !== void 0 ? _g : 'error',
+        onInvalidPropertyValue: (_h = partial === null || partial === void 0 ? void 0 : partial.onInvalidPropertyValue) !== null && _h !== void 0 ? _h : 'error',
+        onUndefinedPropertyValue: (_j = partial === null || partial === void 0 ? void 0 : partial.onUndefinedPropertyValue) !== null && _j !== void 0 ? _j : 'ignore',
+        extendVars: extender
+    };
+    if (partial === null || partial === void 0 ? void 0 : partial.vars) {
+        options.vars = partial.vars;
+    }
+    if (partial === null || partial === void 0 ? void 0 : partial.refs) {
+        options.refs = partial.refs;
+    }
+    return options;
+}
+exports.mergeDefaultJsonConverterOptions = mergeDefaultJsonConverterOptions;
+/**
+ * Creates a new {@link IJsonContext | JSON context} using values supplied in an optional partial
+ * {@link IJsonConverterOptions | converter options}.
+ * @param partial - Optional partial {@link IJsonConverterOptions | IJsonConverterOptions} used to
+ * populate the context.
+ * @public
+ */
+function contextFromConverterOptions(partial) {
+    const context = {};
+    if (partial === null || partial === void 0 ? void 0 : partial.vars) {
+        context.vars = partial.vars;
+    }
+    if (partial === null || partial === void 0 ? void 0 : partial.refs) {
+        context.refs = partial.refs;
+    }
+    if (partial === null || partial === void 0 ? void 0 : partial.hasOwnProperty('extendVars')) {
+        context.extendVars = partial.extendVars;
+    }
+    return context.vars || context.refs || context.extendVars ? context : undefined;
+}
+exports.contextFromConverterOptions = contextFromConverterOptions;
+/**
+ * Creates a new {@link Editor.JsonEditor | JsonEditor} from an optionally supplied partial
+ * {@link IJsonConverterOptions | JSON converter options}.
+ * Expands supplied options with default values and constructs an editor with
+ * matching configuration and defined rules.
+ * @param partial - Optional partial {@link IJsonConverterOptions | IJsonConverterOptions}
+ * used to create the editor.
+ * @public
+ */
+function converterOptionsToEditor(partial) {
+    const converterOptions = mergeDefaultJsonConverterOptions(partial);
+    const context = contextFromConverterOptions(partial);
+    const validation = {
+        onInvalidPropertyName: converterOptions.onInvalidPropertyName,
+        onInvalidPropertyValue: converterOptions.onInvalidPropertyValue,
+        onUndefinedPropertyValue: converterOptions.onUndefinedPropertyValue
+    };
+    const editorOptions = { context, validation };
+    const rules = [];
+    if (converterOptions.useNameTemplates || converterOptions.useValueTemplates) {
+        const templateOptions = Object.assign(Object.assign({}, editorOptions), { useNameTemplates: converterOptions.useNameTemplates, useValueTemplates: converterOptions.useValueTemplates });
+        rules.push(new editor_1.EditorRules.TemplatedJsonEditorRule(templateOptions));
+    }
+    if (converterOptions.useConditionalNames || converterOptions.flattenUnconditionalValues) {
+        const conditionalOptions = Object.assign(Object.assign({}, editorOptions), { flattenUnconditionalValues: converterOptions.flattenUnconditionalValues });
+        rules.push(new editor_1.EditorRules.ConditionalJsonEditorRule(conditionalOptions));
+    }
+    if (converterOptions.useMultiValueTemplateNames) {
+        rules.push(new editor_1.EditorRules.MultiValueJsonEditorRule(editorOptions));
+    }
+    if (converterOptions.useReferences) {
+        rules.push(new editor_1.EditorRules.ReferenceJsonEditorRule(editorOptions));
+    }
+    return editor_1.JsonEditor.create(editorOptions, rules);
+}
+exports.converterOptionsToEditor = converterOptionsToEditor;
+/**
+ * A thin wrapper to allow an arbitrary {@link Editor.JsonEditor | JsonEditor} to be used via the
+ * \@fgv/ts-utils `Converter` pattern.
+ * @public
+ */
+class JsonEditorConverter extends ts_utils_1.Conversion.BaseConverter {
+    /**
+     * Constructs a new {@link Editor.JsonEditor | JsonEditor}Converter which uses the supplied editor
+     * @param editor -
+     */
+    constructor(editor) {
+        super((from, __self, context) => this._convert(from, context), editor.options.context);
+        this.editor = editor;
+    }
+    /**
+     * Constructs a new {@link Editor.JsonEditor | JsonEditor}Converter which uses the supplied editor
+     * @param editor -
+     */
+    static createWithEditor(editor) {
+        return (0, ts_utils_1.captureResult)(() => new JsonEditorConverter(editor));
+    }
+    /**
+     * Gets a derived converter which fails if the resulting converted
+     * {@link JsonValue | JsonValue} is not a {@link JsonObject | JsonObject}.
+     */
+    object() {
+        return this.map((jv) => {
+            if (!(0, json_1.isJsonObject)(jv)) {
+                return (0, ts_utils_1.fail)(`Cannot convert "${JSON.stringify(jv)}" to JSON object.`);
+            }
+            return (0, ts_utils_1.succeed)(jv);
+        });
+    }
+    /**
+     * Gets a derived converter which fails if the resulting converted
+     * {@link JsonValue | JsonValue} is not a {@link JsonArray | JsonArray}.
+     */
+    array() {
+        return this.map((jv) => {
+            if (!Array.isArray(jv) || typeof jv !== 'object') {
+                return (0, ts_utils_1.fail)(`Cannot convert "${JSON.stringify(jv)}" to JSON array.`);
+            }
+            return (0, ts_utils_1.succeed)(jv);
+        });
+    }
+    _convert(from, context) {
+        return this.editor.clone(from, context);
+    }
+}
+exports.JsonEditorConverter = JsonEditorConverter;
+/**
+ * An \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON, optionally
+ * rendering any string property names or values using mustache with a supplied view.
+ * @public
+ */
+class JsonConverter extends JsonEditorConverter {
+    /**
+     * Constructs a new {@link JsonConverter | JsonConverter} with
+     * supplied or default options.
+     * @param options - Optional partial {@link IJsonConverterOptions | options}
+     * to configure the converter.
+     */
+    constructor(options) {
+        const editor = converterOptionsToEditor(options).orThrow();
+        super(editor);
+    }
+    /**
+     * Creates a new {@link JsonConverter | JsonConverter}.
+     * @param options - Optional partial {@link IJsonConverterOptions | options}
+     * to configure the converter.
+     * @returns `Success` with a new {@link JsonConverter | JsonConverter}, or `Failure`
+     * with an informative message if an error occurs.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new JsonConverter(options));
+    }
+}
+exports.JsonConverter = JsonConverter;
+/**
+ * An \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON
+ * with mustache template rendering and multi-value property name rules enabled
+ * regardless of initial context.
+ * @public
+ */
+class TemplatedJsonConverter extends JsonEditorConverter {
+    /**
+     * Constructs a new {@link TemplatedJsonConverter | TemplatedJsonConverter} with
+     * supplied or default options.
+     * @param options - Optional partial {@link TemplatedJsonConverterOptions | options}
+     * to configure the converter.
+     */
+    constructor(options) {
+        options = Object.assign(Object.assign({}, options), TemplatedJsonConverter.templateOptions);
+        const editor = converterOptionsToEditor(options).orThrow();
+        super(editor);
+    }
+    /**
+     * Constructs a new {@link TemplatedJsonConverter | TemplatedJsonConverter} with
+     * supplied or default options.
+     * @param options - Optional partial {@link TemplatedJsonConverterOptions | options}
+     * to configure the converter.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new TemplatedJsonConverter(options));
+    }
+}
+/**
+ * Default {@link IJsonConverterOptions | JSON converter options}
+ * to enable templated conversion.
+ */
+TemplatedJsonConverter.templateOptions = {
+    useNameTemplates: true,
+    useValueTemplates: true,
+    useMultiValueTemplateNames: true,
+    useConditionalNames: false,
+    flattenUnconditionalValues: false
+};
+exports.TemplatedJsonConverter = TemplatedJsonConverter;
+/**
+ * An \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON with mustache
+ * template rendering, multi-value property name and conditional property
+ * name rules enabled regardless of initial context.
+ * @public
+ */
+class ConditionalJsonConverter extends JsonEditorConverter {
+    /**
+     * Constructs a new {@link ConditionalJsonConverter | ConditionalJsonConverter} with supplied or
+     * default options.
+     * @param options - Optional partial {@link ConditionalJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    constructor(options) {
+        options = Object.assign(Object.assign({}, options), ConditionalJsonConverter.conditionalOptions);
+        const editor = converterOptionsToEditor(options).orThrow();
+        super(editor);
+    }
+    /**
+     * Constructs a new {@link ConditionalJsonConverter | ConditionalJsonConverter} with supplied or
+     * default options.
+     * @param options - Optional partial {@link ConditionalJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new ConditionalJsonConverter(options));
+    }
+}
+/**
+ * Default {@link IJsonConverterOptions | JSON converter options}
+ * to enable conditional conversion.
+ */
+ConditionalJsonConverter.conditionalOptions = Object.assign(Object.assign({}, TemplatedJsonConverter.templateOptions), { useConditionalNames: true, flattenUnconditionalValues: true });
+exports.ConditionalJsonConverter = ConditionalJsonConverter;
+/**
+ * A \@fgv/ts-utils `Converter` from `unknown` to type-safe JSON with mustache
+ * template rendering, multi-value property name, conditional property
+ * name, and external reference rules enabled regardless of initial context.
+ * @public
+ */
+class RichJsonConverter extends JsonEditorConverter {
+    /**
+     * Constructs a new {@link RichJsonConverter | RichJsonConverter} with supplied or
+     * default options.
+     * @param options - Optional partial {@link RichJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    constructor(options) {
+        options = Object.assign(Object.assign({}, options), RichJsonConverter.richOptions);
+        const editor = converterOptionsToEditor(options).orThrow();
+        super(editor);
+    }
+    /**
+     * Constructs a new {@link RichJsonConverter | RichJsonConverter} with supplied or
+     * default options
+     * @param options - Optional partial {@link RichJsonConverterOptions | configuration or context}
+     * for the converter.
+     */
+    static create(options) {
+        return (0, ts_utils_1.captureResult)(() => new RichJsonConverter(options));
+    }
+}
+/**
+ * Default {@link IJsonConverterOptions | JSON converter options}
+ * to enable rich conversion.
+ */
+RichJsonConverter.richOptions = Object.assign(Object.assign({}, ConditionalJsonConverter.conditionalOptions), { useReferences: true });
+exports.RichJsonConverter = RichJsonConverter;
+//# sourceMappingURL=jsonConverter.js.map