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

package/lib/packlets/context/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/*
+ * Copyright (c) 2023 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.defaultExtendVars = exports.JsonContextHelper = exports.CompositeJsonMap = void 0;
+var compositeJsonMap_1 = require("./compositeJsonMap");
+Object.defineProperty(exports, "CompositeJsonMap", { enumerable: true, get: function () { return compositeJsonMap_1.CompositeJsonMap; } });
+var contextHelpers_1 = require("./contextHelpers");
+Object.defineProperty(exports, "JsonContextHelper", { enumerable: true, get: function () { return contextHelpers_1.JsonContextHelper; } });
+var jsonContext_1 = require("./jsonContext");
+Object.defineProperty(exports, "defaultExtendVars", { enumerable: true, get: function () { return jsonContext_1.defaultExtendVars; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/context/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,mDAAqD;AAA5C,mHAAA,iBAAiB,OAAA;AAC1B,6CAQuB;AADrB,gHAAA,iBAAiB,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\nexport { CompositeJsonMap } from './compositeJsonMap';\nexport { JsonContextHelper } from './contextHelpers';\nexport {\n  IJsonContext,\n  IJsonReferenceMap,\n  JsonReferenceMapFailureReason,\n  TemplateVars,\n  TemplateVarsExtendFunction,\n  VariableValue,\n  defaultExtendVars\n} from './jsonContext';\n"]}

package/lib/packlets/context/jsonContext.d.ts

@@ -0,0 +1,84 @@
+import { DetailedResult, Result } from '@fgv/ts-utils';
+import { JsonObject, JsonValue } from '../json';
+/**
+ * Collection of variables used for template replacement in a JSON edit or
+ * conversion.
+ * @public
+ */
+export type TemplateVars = Record<string, unknown>;
+/**
+ * Describes one value in a {@link TemplateVars | TemplateVars} collection of
+ * variables.
+ * @public
+ */
+export type VariableValue = [string, unknown];
+/**
+ * Function used to create a new collection of {@link TemplateVars | TemplateVars} with
+ * one or more new or changed values.
+ * @public
+ */
+export type TemplateVarsExtendFunction = (base: TemplateVars | undefined, values: VariableValue[]) => Result<TemplateVars | undefined>;
+/**
+ * This default implementation of a {@link TemplateVarsExtendFunction | TemplateVarsExtendFunction}
+ * creates a new collection via inheritance from the supplied collection.
+ * @param base - The base {@link TemplateVars | variables} to be extended.
+ * @param values - The {@link VariableValue | values} to be added or overridden in the new variables.
+ * @public
+ */
+export declare function defaultExtendVars(base: TemplateVars | undefined, values: VariableValue[]): Result<TemplateVars | undefined>;
+/**
+ * Failure reason for {@link IJsonReferenceMap | IJsonReferenceMap} lookup, where `'unknown'`
+ * means that the object is not present in the map and `'error'` means
+ * that an error occurred while retrieving or converting it.
+ * @public
+ */
+export type JsonReferenceMapFailureReason = 'unknown' | 'error';
+/**
+ * Interface for a simple map that returns named {@link JsonValue | JsonValue} values with templating,
+ * conditional logic, and external reference lookups applied using an optionally supplied context.
+ * @public
+ */
+export interface IJsonReferenceMap {
+    /**
+     * Determine if a key might be valid for this map but does not determine if key actually
+     * exists. Allows key range to be constrained.
+     * @param key - The key to be tested.
+     * @returns `true` if the key is in the valid range, `false` otherwise.
+     */
+    keyIsInRange(key: string): boolean;
+    /**
+     * Determines if an object with the specified key actually exists in the map.
+     * @param key - The key to be tested.
+     * @returns `true` if an object with the specified key exists, `false` otherwise.
+     */
+    has(key: string): boolean;
+    /**
+     * Gets a {@link JsonObject | JsonObject} specified by key.
+     * @param key - The key of the object to be retrieved.
+     * @param context - Optional {@link IJsonContext | IJsonContext} used to construct
+     * the object.
+     * @returns `Success` with the formatted {@link JsonObject | object} if successful. `Failure`
+     * with detail `'unknown'`  if no such object exists, or `Failure` with detail `'error'` if
+     * the object was found but could not be formatted.
+     */
+    getJsonObject(key: string, context?: IJsonContext): DetailedResult<JsonObject, JsonReferenceMapFailureReason>;
+    /**
+     * Gets a {@link JsonValue | JsonValue} specified by key.
+     * @param key - The key of the object to be retrieved.
+     * @param context - Optional {@link IJsonContext | JSON Context} used to format the value
+     * @returns `Success` with the formatted {@link JsonValue | value} if successful. `Failure`
+     * with detail `'unknown'` if no such object exists, or `Failure` with detail `'error'` if
+     * the object was found but could not be formatted.
+     */
+    getJsonValue(key: string, context?: IJsonContext): DetailedResult<JsonValue, JsonReferenceMapFailureReason>;
+}
+/**
+ * Context used to convert or edit JSON objects.
+ * @public
+ */
+export interface IJsonContext {
+    vars?: TemplateVars;
+    refs?: IJsonReferenceMap;
+    extendVars?: TemplateVarsExtendFunction;
+}
+//# sourceMappingURL=jsonContext.d.ts.map

package/lib/packlets/context/jsonContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonContext.d.ts","sourceRoot":"","sources":["../../../src/packlets/context/jsonContext.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAW,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEhD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CACvC,IAAI,EAAE,YAAY,GAAG,SAAS,EAC9B,MAAM,EAAE,aAAa,EAAE,KACpB,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,YAAY,GAAG,SAAS,EAC9B,MAAM,EAAE,aAAa,EAAE,GACtB,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,CAMlC;AAED;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GAAG,SAAS,GAAG,OAAO,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnC;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B;;;;;;;;OAQG;IAEH,aAAa,CACX,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,YAAY,GACrB,cAAc,CAAC,UAAU,EAAE,6BAA6B,CAAC,CAAC;IAE7D;;;;;;;OAOG;IAEH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC;CAC7G;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,UAAU,CAAC,EAAE,0BAA0B,CAAC;CACzC"}

package/lib/packlets/context/jsonContext.js

@@ -0,0 +1,41 @@
+"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.defaultExtendVars = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * This default implementation of a {@link TemplateVarsExtendFunction | TemplateVarsExtendFunction}
+ * creates a new collection via inheritance from the supplied collection.
+ * @param base - The base {@link TemplateVars | variables} to be extended.
+ * @param values - The {@link VariableValue | values} to be added or overridden in the new variables.
+ * @public
+ */
+function defaultExtendVars(base, values) {
+    const rtrn = base ? Object.create(base) : {};
+    for (const v of values) {
+        rtrn[v[0]] = v[1];
+    }
+    return (0, ts_utils_1.succeed)(rtrn);
+}
+exports.defaultExtendVars = defaultExtendVars;
+//# sourceMappingURL=jsonContext.js.map

package/lib/packlets/context/jsonContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonContext.js","sourceRoot":"","sources":["../../../src/packlets/context/jsonContext.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAgE;AA2BhE;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,IAA8B,EAC9B,MAAuB;IAEvB,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE;QACtB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KACnB;IACD,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AATD,8CASC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { DetailedResult, Result, succeed } from '@fgv/ts-utils';\nimport { JsonObject, JsonValue } from '../json';\n\n/**\n * Collection of variables used for template replacement in a JSON edit or\n * conversion.\n * @public\n */\nexport type TemplateVars = Record<string, unknown>;\n\n/**\n * Describes one value in a {@link TemplateVars | TemplateVars} collection of\n * variables.\n * @public\n */\nexport type VariableValue = [string, unknown];\n\n/**\n * Function used to create a new collection of {@link TemplateVars | TemplateVars} with\n * one or more new or changed values.\n * @public\n */\nexport type TemplateVarsExtendFunction = (\n  base: TemplateVars | undefined,\n  values: VariableValue[]\n) => Result<TemplateVars | undefined>;\n\n/**\n * This default implementation of a {@link TemplateVarsExtendFunction | TemplateVarsExtendFunction}\n * creates a new collection via inheritance from the supplied collection.\n * @param base - The base {@link TemplateVars | variables} to be extended.\n * @param values - The {@link VariableValue | values} to be added or overridden in the new variables.\n * @public\n */\nexport function defaultExtendVars(\n  base: TemplateVars | undefined,\n  values: VariableValue[]\n): Result<TemplateVars | undefined> {\n  const rtrn = base ? Object.create(base) : {};\n  for (const v of values) {\n    rtrn[v[0]] = v[1];\n  }\n  return succeed(rtrn);\n}\n\n/**\n * Failure reason for {@link IJsonReferenceMap | IJsonReferenceMap} lookup, where `'unknown'`\n * means that the object is not present in the map and `'error'` means\n * that an error occurred while retrieving or converting it.\n * @public\n */\nexport type JsonReferenceMapFailureReason = 'unknown' | 'error';\n\n/**\n * Interface for a simple map that returns named {@link JsonValue | JsonValue} values with templating,\n * conditional logic, and external reference lookups applied using an optionally supplied context.\n * @public\n */\nexport interface IJsonReferenceMap {\n  /**\n   * Determine if a key might be valid for this map but does not determine if key actually\n   * exists. Allows key range to be constrained.\n   * @param key - The key to be tested.\n   * @returns `true` if the key is in the valid range, `false` otherwise.\n   */\n  keyIsInRange(key: string): boolean;\n\n  /**\n   * Determines if an object with the specified key actually exists in the map.\n   * @param key - The key to be tested.\n   * @returns `true` if an object with the specified key exists, `false` otherwise.\n   */\n  has(key: string): boolean;\n\n  /**\n   * Gets a {@link JsonObject | JsonObject} specified by key.\n   * @param key - The key of the object to be retrieved.\n   * @param context - Optional {@link IJsonContext | IJsonContext} used to construct\n   * the object.\n   * @returns `Success` with the formatted {@link JsonObject | object} if successful. `Failure`\n   * with detail `'unknown'`  if no such object exists, or `Failure` with detail `'error'` if\n   * the object was found but could not be formatted.\n   */\n  // eslint-disable-next-line no-use-before-define\n  getJsonObject(\n    key: string,\n    context?: IJsonContext\n  ): DetailedResult<JsonObject, JsonReferenceMapFailureReason>;\n\n  /**\n   * Gets a {@link JsonValue | JsonValue} specified by key.\n   * @param key - The key of the object to be retrieved.\n   * @param context - Optional {@link IJsonContext | JSON Context} used to format the value\n   * @returns `Success` with the formatted {@link JsonValue | value} if successful. `Failure`\n   * with detail `'unknown'` if no such object exists, or `Failure` with detail `'error'` if\n   * the object was found but could not be formatted.\n   */\n  // eslint-disable-next-line no-use-before-define\n  getJsonValue(key: string, context?: IJsonContext): DetailedResult<JsonValue, JsonReferenceMapFailureReason>;\n}\n\n/**\n * Context used to convert or edit JSON objects.\n * @public\n */\nexport interface IJsonContext {\n  vars?: TemplateVars;\n  refs?: IJsonReferenceMap;\n  extendVars?: TemplateVarsExtendFunction;\n}\n"]}

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

@@ -0,0 +1,54 @@
+import { Converter } from '@fgv/ts-utils';
+import { IJsonContext } from '../context';
+import { JsonArray, JsonObject } from '../json';
+import { ConditionalJsonConverterOptions, JsonConverter, RichJsonConverterOptions, TemplatedJsonConverterOptions } from './jsonConverter';
+/**
+ * A simple validating {@link JsonConverter | JSON converter}. Converts unknown to
+ * JSON or fails if the unknown contains any invalid JSON values.
+ * @public
+ */
+export declare const json: JsonConverter;
+/**
+ * A simple validating {@link JsonConverter | JSON converter}. Converts unknown
+ * to a {@link JsonObject | JsonObject}, or fails if the `unknown` contains invalid
+ * JSON or is not an object.
+ * @public
+ */
+export declare const jsonObject: Converter<JsonObject, IJsonContext>;
+/**
+ * A simple validating {@link JsonConverter | JSON converter}. Converts `unknown` to a
+ * {@link JsonArray | JsonArray}, or fails if the unknown contains invalid JSON or is
+ * not an array.
+ * @public
+ */
+export declare const jsonArray: Converter<JsonArray, IJsonContext>;
+/**
+ * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts an
+ * `unknown` value to JSON, rendering any property names or string values using mustache with
+ * the supplied context.  See the mustache documentation for details of mustache syntax and view.
+ * @param options - {@link TemplatedJsonConverterOptions | Options and context} for
+ * the conversion.
+ * @public
+ */
+export declare function templatedJson(options?: Partial<TemplatedJsonConverterOptions>): JsonConverter;
+/**
+ * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts a
+ * supplied `unknown` to strongly-typed JSON, by first rendering any property
+ * names or string values using mustache with the supplied context, then applying
+ * multi-value property expansion and conditional flattening based on property names.
+ * @param options - {@link ConditionalJsonConverterOptions | Options and context} for
+ * the conversion.
+ * @public
+ */
+export declare function conditionalJson(options?: Partial<ConditionalJsonConverterOptions>): JsonConverter;
+/**
+ * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts a
+ * supplied `unknown` to strongly-typed JSON, by first rendering any property
+ * names or string values using mustache with the supplied context, then applying
+ * multi-value property expansion and conditional flattening based on property names.
+ * @param options - {@link RichJsonConverterOptions | Options and context} for
+ * the conversion.
+ * @public
+ */
+export declare function richJson(options?: Partial<RichJsonConverterOptions>): JsonConverter;
+//# sourceMappingURL=converters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"converters.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAEL,+BAA+B,EAC/B,aAAa,EAEb,wBAAwB,EAExB,6BAA6B,EAC9B,MAAM,iBAAiB,CAAC;AAEzB;;;;GAIG;AACH,eAAO,MAAM,IAAI,EAAE,aAAmC,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,YAAY,CAAiB,CAAC;AAE7E;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,YAAY,CAAgB,CAAC;AAM1E;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAAG,aAAa,CAQ7F;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC,GAAG,aAAa,CAQjG;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,aAAa,CAQnF"}

package/lib/packlets/converters/converters.js

@@ -0,0 +1,105 @@
+"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.richJson = exports.conditionalJson = exports.templatedJson = exports.jsonArray = exports.jsonObject = exports.json = void 0;
+const jsonConverter_1 = require("./jsonConverter");
+/**
+ * A simple validating {@link JsonConverter | JSON converter}. Converts unknown to
+ * JSON or fails if the unknown contains any invalid JSON values.
+ * @public
+ */
+exports.json = new jsonConverter_1.JsonConverter();
+/**
+ * A simple validating {@link JsonConverter | JSON converter}. Converts unknown
+ * to a {@link JsonObject | JsonObject}, or fails if the `unknown` contains invalid
+ * JSON or is not an object.
+ * @public
+ */
+exports.jsonObject = exports.json.object();
+/**
+ * A simple validating {@link JsonConverter | JSON converter}. Converts `unknown` to a
+ * {@link JsonArray | JsonArray}, or fails if the unknown contains invalid JSON or is
+ * not an array.
+ * @public
+ */
+exports.jsonArray = exports.json.array();
+let templatedJsonDefault;
+let conditionalJsonDefault;
+let richJsonDefault;
+/**
+ * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts an
+ * `unknown` value to JSON, rendering any property names or string values using mustache with
+ * the supplied context.  See the mustache documentation for details of mustache syntax and view.
+ * @param options - {@link TemplatedJsonConverterOptions | Options and context} for
+ * the conversion.
+ * @public
+ */
+function templatedJson(options) {
+    if (!options) {
+        if (!templatedJsonDefault) {
+            templatedJsonDefault = new jsonConverter_1.TemplatedJsonConverter();
+        }
+        return templatedJsonDefault;
+    }
+    return new jsonConverter_1.TemplatedJsonConverter(options);
+}
+exports.templatedJson = templatedJson;
+/**
+ * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts a
+ * supplied `unknown` to strongly-typed JSON, by first rendering any property
+ * names or string values using mustache with the supplied context, then applying
+ * multi-value property expansion and conditional flattening based on property names.
+ * @param options - {@link ConditionalJsonConverterOptions | Options and context} for
+ * the conversion.
+ * @public
+ */
+function conditionalJson(options) {
+    if (!options) {
+        if (!conditionalJsonDefault) {
+            conditionalJsonDefault = new jsonConverter_1.ConditionalJsonConverter();
+        }
+        return conditionalJsonDefault;
+    }
+    return new jsonConverter_1.ConditionalJsonConverter(options);
+}
+exports.conditionalJson = conditionalJson;
+/**
+ * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts a
+ * supplied `unknown` to strongly-typed JSON, by first rendering any property
+ * names or string values using mustache with the supplied context, then applying
+ * multi-value property expansion and conditional flattening based on property names.
+ * @param options - {@link RichJsonConverterOptions | Options and context} for
+ * the conversion.
+ * @public
+ */
+function richJson(options) {
+    if (!options) {
+        if (!richJsonDefault) {
+            richJsonDefault = new jsonConverter_1.RichJsonConverter();
+        }
+        return richJsonDefault;
+    }
+    return new jsonConverter_1.RichJsonConverter(options);
+}
+exports.richJson = richJson;
+//# sourceMappingURL=converters.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAKH,mDAQyB;AAEzB;;;;GAIG;AACU,QAAA,IAAI,GAAkB,IAAI,6BAAa,EAAE,CAAC;AAEvD;;;;;GAKG;AACU,QAAA,UAAU,GAAwC,YAAI,CAAC,MAAM,EAAE,CAAC;AAE7E;;;;;GAKG;AACU,QAAA,SAAS,GAAuC,YAAI,CAAC,KAAK,EAAE,CAAC;AAE1E,IAAI,oBAA+C,CAAC;AACpD,IAAI,sBAAiD,CAAC;AACtD,IAAI,eAA0C,CAAC;AAE/C;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,OAAgD;IAC5E,IAAI,CAAC,OAAO,EAAE;QACZ,IAAI,CAAC,oBAAoB,EAAE;YACzB,oBAAoB,GAAG,IAAI,sCAAsB,EAAE,CAAC;SACrD;QACD,OAAO,oBAAoB,CAAC;KAC7B;IACD,OAAO,IAAI,sCAAsB,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AARD,sCAQC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAAC,OAAkD;IAChF,IAAI,CAAC,OAAO,EAAE;QACZ,IAAI,CAAC,sBAAsB,EAAE;YAC3B,sBAAsB,GAAG,IAAI,wCAAwB,EAAE,CAAC;SACzD;QACD,OAAO,sBAAsB,CAAC;KAC/B;IACD,OAAO,IAAI,wCAAwB,CAAC,OAAO,CAAC,CAAC;AAC/C,CAAC;AARD,0CAQC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,OAA2C;IAClE,IAAI,CAAC,OAAO,EAAE;QACZ,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,IAAI,iCAAiB,EAAE,CAAC;SAC3C;QACD,OAAO,eAAe,CAAC;KACxB;IACD,OAAO,IAAI,iCAAiB,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC;AARD,4BAQC","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 { Converter } from '@fgv/ts-utils';\nimport { IJsonContext } from '../context';\nimport { JsonArray, JsonObject } from '../json';\nimport {\n  ConditionalJsonConverter,\n  ConditionalJsonConverterOptions,\n  JsonConverter,\n  RichJsonConverter,\n  RichJsonConverterOptions,\n  TemplatedJsonConverter,\n  TemplatedJsonConverterOptions\n} from './jsonConverter';\n\n/**\n * A simple validating {@link JsonConverter | JSON converter}. Converts unknown to\n * JSON or fails if the unknown contains any invalid JSON values.\n * @public\n */\nexport const json: JsonConverter = new JsonConverter();\n\n/**\n * A simple validating {@link JsonConverter | JSON converter}. Converts unknown\n * to a {@link JsonObject | JsonObject}, or fails if the `unknown` contains invalid\n * JSON or is not an object.\n * @public\n */\nexport const jsonObject: Converter<JsonObject, IJsonContext> = json.object();\n\n/**\n * A simple validating {@link JsonConverter | JSON converter}. Converts `unknown` to a\n * {@link JsonArray | JsonArray}, or fails if the unknown contains invalid JSON or is\n * not an array.\n * @public\n */\nexport const jsonArray: Converter<JsonArray, IJsonContext> = json.array();\n\nlet templatedJsonDefault: JsonConverter | undefined;\nlet conditionalJsonDefault: JsonConverter | undefined;\nlet richJsonDefault: JsonConverter | undefined;\n\n/**\n * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts an\n * `unknown` value to JSON, rendering any property names or string values using mustache with\n * the supplied context.  See the mustache documentation for details of mustache syntax and view.\n * @param options - {@link TemplatedJsonConverterOptions | Options and context} for\n * the conversion.\n * @public\n */\nexport function templatedJson(options?: Partial<TemplatedJsonConverterOptions>): JsonConverter {\n  if (!options) {\n    if (!templatedJsonDefault) {\n      templatedJsonDefault = new TemplatedJsonConverter();\n    }\n    return templatedJsonDefault;\n  }\n  return new TemplatedJsonConverter(options);\n}\n\n/**\n * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts a\n * supplied `unknown` to strongly-typed JSON, by first rendering any property\n * names or string values using mustache with the supplied context, then applying\n * multi-value property expansion and conditional flattening based on property names.\n * @param options - {@link ConditionalJsonConverterOptions | Options and context} for\n * the conversion.\n * @public\n */\nexport function conditionalJson(options?: Partial<ConditionalJsonConverterOptions>): JsonConverter {\n  if (!options) {\n    if (!conditionalJsonDefault) {\n      conditionalJsonDefault = new ConditionalJsonConverter();\n    }\n    return conditionalJsonDefault;\n  }\n  return new ConditionalJsonConverter(options);\n}\n\n/**\n * Helper function which creates a new {@link JsonConverter | JsonConverter} which converts a\n * supplied `unknown` to strongly-typed JSON, by first rendering any property\n * names or string values using mustache with the supplied context, then applying\n * multi-value property expansion and conditional flattening based on property names.\n * @param options - {@link RichJsonConverterOptions | Options and context} for\n * the conversion.\n * @public\n */\nexport function richJson(options?: Partial<RichJsonConverterOptions>): JsonConverter {\n  if (!options) {\n    if (!richJsonDefault) {\n      richJsonDefault = new RichJsonConverter();\n    }\n    return richJsonDefault;\n  }\n  return new RichJsonConverter(options);\n}\n"]}

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

@@ -0,0 +1,83 @@
+import { Converter, Result } from '@fgv/ts-utils';
+import { JsonValue } from '../json';
+/**
+ * Convenience function to read type-safe JSON from a file
+ * @param srcPath - Path of the file to read
+ * @returns `Success` with a {@link JsonValue | JsonValue} or `Failure`
+ * with a message if an error occurs.
+ * @public
+ */
+export declare function readJsonFileSync(srcPath: string): Result<JsonValue>;
+/**
+ * Convenience function to read a JSON file and apply a supplied converter.
+ * @param srcPath - Path of the file to read.
+ * @param converter - `Converter` used to convert the file contents
+ * @returns `Success` with a result of type `<T>`, or `Failure`
+ * with a message if an error occurs.
+ * @public
+ */
+export declare function convertJsonFileSync<T>(srcPath: string, converter: Converter<T>): Result<T>;
+/**
+ * Options for directory conversion.
+ * TODO: add filtering, allowed and excluded.
+ * @public
+ */
+export interface IDirectoryConvertOptions<T, TC = unknown> {
+    /**
+     * The converter used to convert incoming JSON objects.
+     */
+    converter: Converter<T, TC>;
+}
+/**
+ * Return value for one item in a directory conversion.
+ * @public
+ */
+export interface IReadDirectoryItem<T> {
+    /**
+     * Relative name of the file that was processed
+     */
+    filename: string;
+    /**
+     * The payload of the file.
+     */
+    item: T;
+}
+/**
+ * Reads all JSON files from a directory and apply a supplied converter.
+ * @param srcPath - The path of the folder to be read.
+ * @param options - {@link Files.IDirectoryConvertOptions | Options} to control
+ * conversion and filtering
+ * @public
+ */
+export declare function convertJsonDirectorySync<T>(srcPath: string, options: IDirectoryConvertOptions<T>): Result<IReadDirectoryItem<T>[]>;
+/**
+ * Function to transform the name of a some entity, given an original name
+ * and the contents of the entity.
+ * @public
+ */
+export type ItemNameTransformFunction<T> = (name: string, item: T) => Result<string>;
+/**
+ * Options controlling conversion of a directory.
+ * @public
+ */
+export interface IDirectoryToMapConvertOptions<T, TC = unknown> extends IDirectoryConvertOptions<T, TC> {
+    transformName?: ItemNameTransformFunction<T>;
+}
+/**
+ * Reads and converts all JSON files from a directory, returning a
+ * `Map<string, T>` indexed by file base name (i.e. minus the extension)
+ * with an optional name transformation applied if present.
+ * @param srcPath - The path of the folder to be read.
+ * @param options - {@link Files.IDirectoryToMapConvertOptions | Options} to control conversion,
+ * filtering and naming.
+ * @public
+ */
+export declare function convertJsonDirectoryToMapSync<T, TC = unknown>(srcPath: string, options: IDirectoryToMapConvertOptions<T, TC>): Result<Map<string, T>>;
+/**
+ * Convenience function to write type-safe JSON to a file.
+ * @param srcPath - Path of the file to write.
+ * @param value - The {@link JsonValue | JsonValue} to be written.
+ * @public
+ */
+export declare function writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;
+//# sourceMappingURL=file.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/file.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAAE,MAAM,EAA4C,MAAM,eAAe,CAAC;AAI5F,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAMnE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAI1F;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO;IACvD;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACnC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,CA2BjC;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,WAAW,6BAA6B,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,wBAAwB,CAAC,CAAC,EAAE,EAAE,CAAC;IACrG,aAAa,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAWD;;;;;;;;GAQG;AACH,wBAAgB,6BAA6B,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAC3D,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,6BAA6B,CAAC,CAAC,EAAE,EAAE,CAAC,GAC5C,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAcxB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAMpF"}

package/lib/packlets/converters/file.js

@@ -0,0 +1,162 @@
+"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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeJsonFileSync = exports.convertJsonDirectoryToMapSync = exports.convertJsonDirectorySync = exports.convertJsonFileSync = exports.readJsonFileSync = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * Convenience function to read type-safe JSON from a file
+ * @param srcPath - Path of the file to read
+ * @returns `Success` with a {@link JsonValue | JsonValue} or `Failure`
+ * with a message if an error occurs.
+ * @public
+ */
+function readJsonFileSync(srcPath) {
+    return (0, ts_utils_1.captureResult)(() => {
+        const fullPath = path.resolve(srcPath);
+        const body = fs.readFileSync(fullPath, 'utf8').toString();
+        return JSON.parse(body);
+    });
+}
+exports.readJsonFileSync = readJsonFileSync;
+/**
+ * Convenience function to read a JSON file and apply a supplied converter.
+ * @param srcPath - Path of the file to read.
+ * @param converter - `Converter` used to convert the file contents
+ * @returns `Success` with a result of type `<T>`, or `Failure`
+ * with a message if an error occurs.
+ * @public
+ */
+function convertJsonFileSync(srcPath, converter) {
+    return readJsonFileSync(srcPath).onSuccess((json) => {
+        return converter.convert(json);
+    });
+}
+exports.convertJsonFileSync = convertJsonFileSync;
+/**
+ * Reads all JSON files from a directory and apply a supplied converter.
+ * @param srcPath - The path of the folder to be read.
+ * @param options - {@link Files.IDirectoryConvertOptions | Options} to control
+ * conversion and filtering
+ * @public
+ */
+function convertJsonDirectorySync(srcPath, options) {
+    return (0, ts_utils_1.captureResult)(() => {
+        const fullPath = path.resolve(srcPath);
+        if (!fs.statSync(fullPath).isDirectory()) {
+            throw new Error(`${fullPath}: Not a directory`);
+        }
+        const files = fs.readdirSync(fullPath, { withFileTypes: true });
+        const results = files
+            .map((fi) => {
+            if (fi.isFile() && path.extname(fi.name) === '.json') {
+                const filePath = path.resolve(fullPath, fi.name);
+                return convertJsonFileSync(filePath, options.converter)
+                    .onSuccess((payload) => {
+                    return (0, ts_utils_1.succeed)({
+                        filename: fi.name,
+                        item: payload
+                    });
+                })
+                    .onFailure((message) => {
+                    return (0, ts_utils_1.fail)(`${fi.name}: ${message}`);
+                });
+            }
+            return undefined;
+        })
+            .filter((r) => r !== undefined);
+        return (0, ts_utils_1.mapResults)(results).orThrow();
+    });
+}
+exports.convertJsonDirectorySync = convertJsonDirectorySync;
+/**
+ * Function to transform the name of some entity, given only a previous name. This
+ * default implementation always returns `Success` with the value that was passed in.
+ * @param n - The name to be transformed.
+ * @returns - `Success` with the string that was passed in.
+ * @public
+ */
+const defaultNameTransformer = (n) => (0, ts_utils_1.succeed)(n);
+/**
+ * Reads and converts all JSON files from a directory, returning a
+ * `Map<string, T>` indexed by file base name (i.e. minus the extension)
+ * with an optional name transformation applied if present.
+ * @param srcPath - The path of the folder to be read.
+ * @param options - {@link Files.IDirectoryToMapConvertOptions | Options} to control conversion,
+ * filtering and naming.
+ * @public
+ */
+function convertJsonDirectoryToMapSync(srcPath, options) {
+    return convertJsonDirectorySync(srcPath, options).onSuccess((items) => {
+        var _a;
+        const transformName = (_a = options.transformName) !== null && _a !== void 0 ? _a : defaultNameTransformer;
+        return (0, ts_utils_1.mapResults)(items.map((item) => {
+            const basename = path.basename(item.filename, '.json');
+            return transformName(basename, item.item).onSuccess((name) => {
+                return (0, ts_utils_1.succeed)([name, item.item]);
+            });
+        })).onSuccess((items) => {
+            return (0, ts_utils_1.succeed)(new Map(items));
+        });
+    });
+}
+exports.convertJsonDirectoryToMapSync = convertJsonDirectoryToMapSync;
+/**
+ * Convenience function to write type-safe JSON to a file.
+ * @param srcPath - Path of the file to write.
+ * @param value - The {@link JsonValue | JsonValue} to be written.
+ * @public
+ */
+function writeJsonFileSync(srcPath, value) {
+    return (0, ts_utils_1.captureResult)(() => {
+        const fullPath = path.resolve(srcPath);
+        fs.writeFileSync(fullPath, JSON.stringify(value, undefined, 2));
+        return true;
+    });
+}
+exports.writeJsonFileSync = writeJsonFileSync;
+//# sourceMappingURL=file.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/packlets/converters/file.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CAA4F;AAC5F,uCAAyB;AACzB,2CAA6B;AAI7B;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AAND,4CAMC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAI,OAAe,EAAE,SAAuB;IAC7E,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;QAClD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,kDAIC;AA8BD;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,OAAe,EACf,OAAoC;IAEpC,OAAO,IAAA,wBAAa,EAA0B,GAAG,EAAE;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,mBAAmB,CAAC,CAAC;SACjD;QACD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,KAAK;aAClB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YACV,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE;gBACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;gBACjD,OAAO,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,CAAC;qBACpD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,OAAO,IAAA,kBAAO,EAAC;wBACb,QAAQ,EAAE,EAAE,CAAC,IAAI;wBACjB,IAAI,EAAE,OAAO;qBACd,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,OAAO,IAAA,eAAI,EAAC,GAAG,EAAE,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBACxC,CAAC,CAAC,CAAC;aACN;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,CAAC,EAAsC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QACtE,OAAO,IAAA,qBAAU,EAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AA9BD,4DA8BC;AAiBD;;;;;;GAMG;AACH,MAAM,sBAAsB,GAAG,CAAC,CAAS,EAAkB,EAAE,CAAC,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;AAEzE;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAC3C,OAAe,EACf,OAA6C;IAE7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;;QACpE,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,sBAAsB,CAAC;QACtE,OAAO,IAAA,qBAAU,EACf,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACjB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACvD,OAAO,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC3D,OAAO,IAAA,kBAAO,EAAc,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,IAAA,kBAAO,EAAC,IAAI,GAAG,CAAY,KAAK,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAjBD,sEAiBC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,OAAe,EAAE,KAAgB;IACjE,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;QAChE,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAND,8CAMC","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 { Converter, Result, captureResult, fail, mapResults, succeed } from '@fgv/ts-utils';\nimport * as fs from 'fs';\nimport * as path from 'path';\n\nimport { JsonValue } from '../json';\n\n/**\n * Convenience function to read type-safe JSON from a file\n * @param srcPath - Path of the file to read\n * @returns `Success` with a {@link JsonValue | JsonValue} or `Failure`\n * with a message if an error occurs.\n * @public\n */\nexport function readJsonFileSync(srcPath: string): Result<JsonValue> {\n  return captureResult(() => {\n    const fullPath = path.resolve(srcPath);\n    const body = fs.readFileSync(fullPath, 'utf8').toString();\n    return JSON.parse(body) as JsonValue;\n  });\n}\n\n/**\n * Convenience function to read a JSON file and apply a supplied converter.\n * @param srcPath - Path of the file to read.\n * @param converter - `Converter` used to convert the file contents\n * @returns `Success` with a result of type `<T>`, or `Failure`\n * with a message if an error occurs.\n * @public\n */\nexport function convertJsonFileSync<T>(srcPath: string, converter: Converter<T>): Result<T> {\n  return readJsonFileSync(srcPath).onSuccess((json) => {\n    return converter.convert(json);\n  });\n}\n\n/**\n * Options for directory conversion.\n * TODO: add filtering, allowed and excluded.\n * @public\n */\nexport interface IDirectoryConvertOptions<T, TC = unknown> {\n  /**\n   * The converter used to convert incoming JSON objects.\n   */\n  converter: Converter<T, TC>;\n}\n\n/**\n * Return value for one item in a directory conversion.\n * @public\n */\nexport interface IReadDirectoryItem<T> {\n  /**\n   * Relative name of the file that was processed\n   */\n  filename: string;\n\n  /**\n   * The payload of the file.\n   */\n  item: T;\n}\n\n/**\n * Reads all JSON files from a directory and apply a supplied converter.\n * @param srcPath - The path of the folder to be read.\n * @param options - {@link Files.IDirectoryConvertOptions | Options} to control\n * conversion and filtering\n * @public\n */\nexport function convertJsonDirectorySync<T>(\n  srcPath: string,\n  options: IDirectoryConvertOptions<T>\n): Result<IReadDirectoryItem<T>[]> {\n  return captureResult<IReadDirectoryItem<T>[]>(() => {\n    const fullPath = path.resolve(srcPath);\n    if (!fs.statSync(fullPath).isDirectory()) {\n      throw new Error(`${fullPath}: Not a directory`);\n    }\n    const files = fs.readdirSync(fullPath, { withFileTypes: true });\n    const results = files\n      .map((fi) => {\n        if (fi.isFile() && path.extname(fi.name) === '.json') {\n          const filePath = path.resolve(fullPath, fi.name);\n          return convertJsonFileSync(filePath, options.converter)\n            .onSuccess((payload) => {\n              return succeed({\n                filename: fi.name,\n                item: payload\n              });\n            })\n            .onFailure((message) => {\n              return fail(`${fi.name}: ${message}`);\n            });\n        }\n        return undefined;\n      })\n      .filter((r): r is Result<IReadDirectoryItem<T>> => r !== undefined);\n    return mapResults(results).orThrow();\n  });\n}\n\n/**\n * Function to transform the name of a some entity, given an original name\n * and the contents of the entity.\n * @public\n */\nexport type ItemNameTransformFunction<T> = (name: string, item: T) => Result<string>;\n\n/**\n * Options controlling conversion of a directory.\n * @public\n */\nexport interface IDirectoryToMapConvertOptions<T, TC = unknown> extends IDirectoryConvertOptions<T, TC> {\n  transformName?: ItemNameTransformFunction<T>;\n}\n\n/**\n * Function to transform the name of some entity, given only a previous name. This\n * default implementation always returns `Success` with the value that was passed in.\n * @param n - The name to be transformed.\n * @returns - `Success` with the string that was passed in.\n * @public\n */\nconst defaultNameTransformer = (n: string): Result<string> => succeed(n);\n\n/**\n * Reads and converts all JSON files from a directory, returning a\n * `Map<string, T>` indexed by file base name (i.e. minus the extension)\n * with an optional name transformation applied if present.\n * @param srcPath - The path of the folder to be read.\n * @param options - {@link Files.IDirectoryToMapConvertOptions | Options} to control conversion,\n * filtering and naming.\n * @public\n */\nexport function convertJsonDirectoryToMapSync<T, TC = unknown>(\n  srcPath: string,\n  options: IDirectoryToMapConvertOptions<T, TC>\n): Result<Map<string, T>> {\n  return convertJsonDirectorySync(srcPath, options).onSuccess((items) => {\n    const transformName = options.transformName ?? defaultNameTransformer;\n    return mapResults(\n      items.map((item) => {\n        const basename = path.basename(item.filename, '.json');\n        return transformName(basename, item.item).onSuccess((name) => {\n          return succeed<[string, T]>([name, item.item]);\n        });\n      })\n    ).onSuccess((items) => {\n      return succeed(new Map<string, T>(items));\n    });\n  });\n}\n\n/**\n * Convenience function to write type-safe JSON to a file.\n * @param srcPath - Path of the file to write.\n * @param value - The {@link JsonValue | JsonValue} to be written.\n * @public\n */\nexport function writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean> {\n  return captureResult(() => {\n    const fullPath = path.resolve(srcPath);\n    fs.writeFileSync(fullPath, JSON.stringify(value, undefined, 2));\n    return true;\n  });\n}\n"]}

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

@@ -0,0 +1,5 @@
+import * as Converters from './converters';
+import * as File from './file';
+export * from './jsonConverter';
+export { Converters, File };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC"}