@fgv/ts-json-base 3.0.0 → 3.0.1-alpha.0

package/dist/ts-json-base.d.ts

@@ -1,5 +1,6 @@
 import { Converter } from '@fgv/ts-utils';
 import { Result } from '@fgv/ts-utils';
+import { Validation } from '@fgv/ts-utils';
 import { Validator } from '@fgv/ts-utils';
 
 /**
@@ -44,15 +45,30 @@ declare function convertJsonDirectorySync<T>(srcPath: string, options: IDirector
 declare function convertJsonDirectoryToMapSync<T, TC = unknown>(srcPath: string, options: IDirectoryToMapConvertOptions<T, TC>): Result<Map<string, T>>;
 
 /**
- * Convenience function to read a JSON file and apply a supplied converter.
+ * 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.
+ * @returns `Success` with a result of type `<T>`, or `Failure`* with a message if an error occurs.
  * @public
  */
 declare function convertJsonFileSync<T>(srcPath: string, converter: Converter<T>): Result<T>;
 
+/**
+ * @public
+ */
+declare const DefaultJsonFsHelper: JsonFsHelper;
+
+/**
+ * Default configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+declare const DefaultJsonFsHelperConfig: IJsonFsHelperConfig;
+
+/**
+ * @public
+ */
+declare const DefaultJsonLike: IJsonLike;
+
 /**
  * Options for directory conversion.
  * TODO: add filtering, allowed and excluded.
@@ -63,16 +79,37 @@ declare interface IDirectoryConvertOptions<T, TC = unknown> {
      * The converter used to convert incoming JSON objects.
      */
     converter: Converter<T, TC>;
+    validator?: undefined;
 }
 
 /**
- * Options controlling conversion of a directory.
+ * Options controlling conversion of a directory to a `Map`.
  * @public
  */
 declare interface IDirectoryToMapConvertOptions<T, TC = unknown> extends IDirectoryConvertOptions<T, TC> {
     transformName?: ItemNameTransformFunction<T>;
 }
 
+/**
+ * Options controlling validation of a directory to a `Map`.
+ * @public
+ */
+declare interface IDirectoryToMapValidateOptions<T, TC = unknown> extends IDirectoryValidateOptions<T, TC> {
+    transformName?: ItemNameTransformFunction<T>;
+}
+
+/**
+ * Options for directory validation.
+ * @public
+ */
+declare interface IDirectoryValidateOptions<T, TC = unknown> {
+    converter?: undefined;
+    /**
+     * The validator used to validate incoming JSON objects
+     */
+    validator: Validator<T, TC>;
+}
+
 /**
  * Conversion context for JSON converters.
  * @public
@@ -81,6 +118,23 @@ declare interface IJsonConverterContext {
     ignoreUndefinedProperties?: boolean;
 }
 
+/**
+ * Configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+declare interface IJsonFsHelperConfig {
+    json: IJsonLike;
+    allowUndefinedWrite: boolean;
+}
+
+/**
+ * @public
+ */
+declare interface IJsonLike {
+    parse(text: string, reviver?: JsonReviver, options?: unknown): JsonValue | undefined;
+    stringify(value: JsonValue, replacer?: JsonReplacer, space?: string | number): string | undefined;
+}
+
 /**
  * Validation context for in-place JSON validators.
  * @public
@@ -173,13 +227,101 @@ declare namespace JsonFile {
         convertJsonDirectoryToMapSync,
         writeJsonFileSync,
         IDirectoryConvertOptions,
+        IDirectoryValidateOptions,
+        JsonFsDirectoryOptions,
         IReadDirectoryItem,
         ItemNameTransformFunction,
-        IDirectoryToMapConvertOptions
+        IDirectoryToMapConvertOptions,
+        IDirectoryToMapValidateOptions,
+        JsonFsDirectoryToMapOptions,
+        IJsonFsHelperConfig,
+        JsonFsHelperInitOptions,
+        DefaultJsonFsHelperConfig,
+        JsonFsHelper,
+        DefaultJsonFsHelper,
+        JsonReviver,
+        JsonReplacerFunction,
+        JsonReplacerArray,
+        JsonReplacer,
+        IJsonLike,
+        DefaultJsonLike
     }
 }
 export { JsonFile }
 
+/**
+ * Options for directory conversion or validation.
+ * @public
+ */
+declare type JsonFsDirectoryOptions<T, TC = unknown> = IDirectoryConvertOptions<T, TC> | IDirectoryValidateOptions<T, TC>;
+
+/**
+ * Options controlling processing of a directory to a `Map`.
+ * @public
+ */
+declare type JsonFsDirectoryToMapOptions<T, TC = unknown> = IDirectoryToMapConvertOptions<T, TC> | IDirectoryToMapValidateOptions<T, TC>;
+
+/**
+ * Helper class to simplify common filesystem operations involving JSON (or JSON-like)
+ * files.
+ * @public
+ */
+declare class JsonFsHelper {
+    /**
+     * Configuration for this {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     */
+    readonly config: IJsonFsHelperConfig;
+    /**
+     * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+     * and JSON values.
+     */
+    constructor(init?: JsonFsHelperInitOptions);
+    /**
+     * 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.
+     */
+    readJsonFileSync(srcPath: string): Result<JsonValue>;
+    /**
+     * Read a JSON file and apply a supplied converter or validator.
+     * @param srcPath - Path of the file to read.
+     * @param cv - Converter or validator used to process the file.
+     * @returns `Success` with a result of type `<T>`, or `Failure`
+     * with a message if an error occurs.
+     */
+    processJsonFileSync<T>(srcPath: string, cv: Validation.Convalidator<T>): Result<T>;
+    /**
+     * Reads all JSON files from a directory and apply a supplied converter or validator.
+     * @param srcPath - The path of the folder to be read.
+     * @param options - {@link JsonFile.JsonFsDirectoryOptions | Options} to control
+     * conversion and filtering
+     */
+    processJsonDirectorySync<T>(srcPath: string, options: JsonFsDirectoryOptions<T>): Result<IReadDirectoryItem<T>[]>;
+    /**
+     * Reads and converts or validates 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 JsonFile.JsonFsDirectoryToMapOptions | Options} to control conversion,
+     * filtering and naming.
+     */
+    processJsonDirectoryToMapSync<T, TC = unknown>(srcPath: string, options: JsonFsDirectoryToMapOptions<T, TC>): Result<Map<string, T>>;
+    /**
+     * Write type-safe JSON to a file.
+     * @param srcPath - Path of the file to write.
+     * @param value - The {@link JsonValue | JsonValue} to be written.
+     */
+    writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;
+}
+
+/**
+ * Initialization options for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+declare type JsonFsHelperInitOptions = Partial<IJsonFsHelperConfig>;
+
 /**
  * A {@link JsonObject | JsonObject} is a string-keyed object
  * containing only valid {@link JsonValue | JSON values}.
@@ -228,6 +370,26 @@ declare const jsonPrimitive: Converter<JsonPrimitive, IJsonConverterContext>;
  */
 declare const jsonPrimitive_2: Validator<JsonPrimitive, IJsonValidatorContext>;
 
+/**
+ * @public
+ */
+declare type JsonReplacer = JsonReplacerFunction | JsonReplacerArray;
+
+/**
+ * @public
+ */
+declare type JsonReplacerArray = (string | number)[];
+
+/**
+ * @public
+ */
+declare type JsonReplacerFunction = (key: string, value: JsonValue) => JsonValue;
+
+/**
+ * @public
+ */
+declare type JsonReviver = (key: string, value: JsonValue) => JsonValue;
+
 /**
  * A {@link JsonValue | JsonValue} is one of: a {@link JsonPrimitive | JsonPrimitive},
  * a {@link JsonObject | JsonObject} or an {@link JsonArray | JsonArray}.
@@ -282,10 +444,7 @@ export declare function pickJsonObject(src: JsonObject, path: string): Result<Js
 export declare function pickJsonValue(src: JsonObject, path: string): Result<JsonValue>;
 
 /**
- * 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.
+ * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}
  * @public
  */
 declare function readJsonFileSync(srcPath: string): Result<JsonValue>;
@@ -313,9 +472,7 @@ declare namespace Validators {
 export { Validators }
 
 /**
- * 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.
+ * {@inheritDoc JsonFile.JsonFsHelper.writeJsonFileSync}
  * @public
  */
 declare function writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;

package/lib/packlets/json-file/file.d.ts

@@ -1,47 +1,19 @@
 import { Converter, Result } from '@fgv/ts-utils';
 import { JsonValue } from '../json';
+import { IDirectoryConvertOptions, IDirectoryToMapConvertOptions, IReadDirectoryItem } from './jsonFsHelper';
 /**
- * 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.
+ * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}
  * @public
  */
 export declare function readJsonFileSync(srcPath: string): Result<JsonValue>;
 /**
- * Convenience function to read a JSON file and apply a supplied converter.
+ * 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.
+ * @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.
@@ -50,19 +22,6 @@ export interface IReadDirectoryItem<T> {
  * @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)
@@ -74,9 +33,7 @@ export interface IDirectoryToMapConvertOptions<T, TC = unknown> extends IDirecto
  */
 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.
+ * {@inheritDoc JsonFile.JsonFsHelper.writeJsonFileSync}
  * @public
  */
 export declare function writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;

package/lib/packlets/json-file/file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-file/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"}
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-file/file.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAEL,wBAAwB,EACxB,6BAA6B,EAC7B,kBAAkB,EAEnB,MAAM,gBAAgB,CAAC;AAGxB;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAEnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAE1F;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,CAEjC;AAED;;;;;;;;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,CAExB;AAOD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAEpF"}

package/lib/packlets/json-file/file.js

@@ -20,61 +20,27 @@
  * 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"));
+const jsonFsHelper_1 = require("./jsonFsHelper");
+const jsonLike_1 = require("./jsonLike");
 /**
- * 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.
+ * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}
  * @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);
-    });
+    return jsonFsHelper_1.DefaultJsonFsHelper.readJsonFileSync(srcPath);
 }
 exports.readJsonFileSync = readJsonFileSync;
 /**
- * Convenience function to read a JSON file and apply a supplied converter.
+ * 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.
+ * @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);
-    });
+    return jsonFsHelper_1.DefaultJsonFsHelper.processJsonFileSync(srcPath, converter);
 }
 exports.convertJsonFileSync = convertJsonFileSync;
 /**
@@ -85,42 +51,9 @@ exports.convertJsonFileSync = convertJsonFileSync;
  * @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();
-    });
+    return jsonFsHelper_1.DefaultJsonFsHelper.processJsonDirectorySync(srcPath, options);
 }
 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)
@@ -131,32 +64,19 @@ const defaultNameTransformer = (n) => (0, ts_utils_1.succeed)(n);
  * @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));
-        });
-    });
+    return jsonFsHelper_1.DefaultJsonFsHelper.processJsonDirectoryToMapSync(srcPath, options);
 }
 exports.convertJsonDirectoryToMapSync = convertJsonDirectoryToMapSync;
+const CompatJsonFsHelper = new jsonFsHelper_1.JsonFsHelper({
+    json: jsonLike_1.DefaultJsonLike,
+    allowUndefinedWrite: true // for compatibility
+});
 /**
- * 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.
+ * {@inheritDoc JsonFile.JsonFsHelper.writeJsonFileSync}
  * @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;
-    });
+    return CompatJsonFsHelper.writeJsonFileSync(srcPath, value);
 }
 exports.writeJsonFileSync = writeJsonFileSync;
 //# sourceMappingURL=file.js.map

package/lib/packlets/json-file/file.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/packlets/json-file/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,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,mBAAmB,CAAC,CAAC;QAClD,CAAC;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,CAAC;gBACrD,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;YACP,CAAC;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 JsonFile.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 JsonFile.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"]}
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/packlets/json-file/file.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAIH,iDAMwB;AACxB,yCAA6C;AAE7C;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,OAAO,kCAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC;AAFD,4CAEC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAI,OAAe,EAAE,SAAuB;IAC7E,OAAO,kCAAmB,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACrE,CAAC;AAFD,kDAEC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,OAAe,EACf,OAAoC;IAEpC,OAAO,kCAAmB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACxE,CAAC;AALD,4DAKC;AAED;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAC3C,OAAe,EACf,OAA6C;IAE7C,OAAO,kCAAmB,CAAC,6BAA6B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC7E,CAAC;AALD,sEAKC;AAED,MAAM,kBAAkB,GAAiB,IAAI,2BAAY,CAAC;IACxD,IAAI,EAAE,0BAAe;IACrB,mBAAmB,EAAE,IAAI,CAAC,oBAAoB;CAC/C,CAAC,CAAC;AAEH;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,OAAe,EAAE,KAAgB;IACjE,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC9D,CAAC;AAFD,8CAEC","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 } from '@fgv/ts-utils';\nimport { JsonValue } from '../json';\nimport {\n  DefaultJsonFsHelper,\n  IDirectoryConvertOptions,\n  IDirectoryToMapConvertOptions,\n  IReadDirectoryItem,\n  JsonFsHelper\n} from './jsonFsHelper';\nimport { DefaultJsonLike } from './jsonLike';\n\n/**\n * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}\n * @public\n */\nexport function readJsonFileSync(srcPath: string): Result<JsonValue> {\n  return DefaultJsonFsHelper.readJsonFileSync(srcPath);\n}\n\n/**\n * 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`* with a message if an error occurs.\n * @public\n */\nexport function convertJsonFileSync<T>(srcPath: string, converter: Converter<T>): Result<T> {\n  return DefaultJsonFsHelper.processJsonFileSync(srcPath, converter);\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 JsonFile.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 DefaultJsonFsHelper.processJsonDirectorySync(srcPath, options);\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 JsonFile.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 DefaultJsonFsHelper.processJsonDirectoryToMapSync(srcPath, options);\n}\n\nconst CompatJsonFsHelper: JsonFsHelper = new JsonFsHelper({\n  json: DefaultJsonLike,\n  allowUndefinedWrite: true // for compatibility\n});\n\n/**\n * {@inheritDoc JsonFile.JsonFsHelper.writeJsonFileSync}\n * @public\n */\nexport function writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean> {\n  return CompatJsonFsHelper.writeJsonFileSync(srcPath, value);\n}\n"]}

package/lib/packlets/json-file/index.d.ts

@@ -1,2 +1,4 @@
 export * from './file';
+export * from './jsonFsHelper';
+export * from './jsonLike';
 //# sourceMappingURL=index.d.ts.map

package/lib/packlets/json-file/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-file/index.ts"],"names":[],"mappings":"AAsBA,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-file/index.ts"],"names":[],"mappings":"AAsBA,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}

package/lib/packlets/json-file/index.js

@@ -36,4 +36,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./file"), exports);
+__exportStar(require("./jsonFsHelper"), exports);
+__exportStar(require("./jsonLike"), exports);
 //# sourceMappingURL=index.js.map

package/lib/packlets/json-file/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/json-file/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,yCAAuB","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\nexport * from './file';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/json-file/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,yCAAuB;AACvB,iDAA+B;AAC/B,6CAA2B","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\nexport * from './file';\nexport * from './jsonFsHelper';\nexport * from './jsonLike';\n"]}

package/lib/packlets/json-file/jsonFsHelper.d.ts

@@ -0,0 +1,147 @@
+import { Converter, Result, Validation, Validator } from '@fgv/ts-utils';
+import { JsonValue } from '../json';
+import { IJsonLike } from './jsonLike';
+/**
+ * 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>;
+    validator?: undefined;
+}
+/**
+ * Options for directory validation.
+ * @public
+ */
+export interface IDirectoryValidateOptions<T, TC = unknown> {
+    converter?: undefined;
+    /**
+     * The validator used to validate incoming JSON objects
+     */
+    validator: Validator<T, TC>;
+}
+/**
+ * Options for directory conversion or validation.
+ * @public
+ */
+export type JsonFsDirectoryOptions<T, TC = unknown> = IDirectoryConvertOptions<T, TC> | IDirectoryValidateOptions<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;
+}
+/**
+ * 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 to a `Map`.
+ * @public
+ */
+export interface IDirectoryToMapConvertOptions<T, TC = unknown> extends IDirectoryConvertOptions<T, TC> {
+    transformName?: ItemNameTransformFunction<T>;
+}
+/**
+ * Options controlling validation of a directory to a `Map`.
+ * @public
+ */
+export interface IDirectoryToMapValidateOptions<T, TC = unknown> extends IDirectoryValidateOptions<T, TC> {
+    transformName?: ItemNameTransformFunction<T>;
+}
+/**
+ * Options controlling processing of a directory to a `Map`.
+ * @public
+ */
+export type JsonFsDirectoryToMapOptions<T, TC = unknown> = IDirectoryToMapConvertOptions<T, TC> | IDirectoryToMapValidateOptions<T, TC>;
+/**
+ * Configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+export interface IJsonFsHelperConfig {
+    json: IJsonLike;
+    allowUndefinedWrite: boolean;
+}
+/**
+ * Initialization options for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+export type JsonFsHelperInitOptions = Partial<IJsonFsHelperConfig>;
+/**
+ * Default configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+export declare const DefaultJsonFsHelperConfig: IJsonFsHelperConfig;
+/**
+ * Helper class to simplify common filesystem operations involving JSON (or JSON-like)
+ * files.
+ * @public
+ */
+export declare class JsonFsHelper {
+    /**
+     * Configuration for this {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     */
+    readonly config: IJsonFsHelperConfig;
+    /**
+     * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+     * and JSON values.
+     */
+    constructor(init?: JsonFsHelperInitOptions);
+    /**
+     * 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.
+     */
+    readJsonFileSync(srcPath: string): Result<JsonValue>;
+    /**
+     * Read a JSON file and apply a supplied converter or validator.
+     * @param srcPath - Path of the file to read.
+     * @param cv - Converter or validator used to process the file.
+     * @returns `Success` with a result of type `<T>`, or `Failure`
+     * with a message if an error occurs.
+     */
+    processJsonFileSync<T>(srcPath: string, cv: Validation.Convalidator<T>): Result<T>;
+    /**
+     * Reads all JSON files from a directory and apply a supplied converter or validator.
+     * @param srcPath - The path of the folder to be read.
+     * @param options - {@link JsonFile.JsonFsDirectoryOptions | Options} to control
+     * conversion and filtering
+     */
+    processJsonDirectorySync<T>(srcPath: string, options: JsonFsDirectoryOptions<T>): Result<IReadDirectoryItem<T>[]>;
+    /**
+     * Reads and converts or validates 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 JsonFile.JsonFsDirectoryToMapOptions | Options} to control conversion,
+     * filtering and naming.
+     */
+    processJsonDirectoryToMapSync<T, TC = unknown>(srcPath: string, options: JsonFsDirectoryToMapOptions<T, TC>): Result<Map<string, T>>;
+    /**
+     * Write type-safe JSON to a file.
+     * @param srcPath - Path of the file to write.
+     * @param value - The {@link JsonValue | JsonValue} to be written.
+     */
+    writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;
+}
+/**
+ * @public
+ */
+export declare const DefaultJsonFsHelper: JsonFsHelper;
+//# sourceMappingURL=jsonFsHelper.d.ts.map

package/lib/packlets/json-file/jsonFsHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonFsHelper.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-file/jsonFsHelper.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,SAAS,EACT,MAAM,EACN,UAAU,EACV,SAAS,EAKV,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAmB,SAAS,EAAE,MAAM,YAAY,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO;IACvD;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO;IACxD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAC9C,wBAAwB,CAAC,CAAC,EAAE,EAAE,CAAC,GAC/B,yBAAyB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;CACT;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;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,yBAAyB,CAAC,CAAC,EAAE,EAAE,CAAC;IACvG,aAAa,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IACnD,6BAA6B,CAAC,CAAC,EAAE,EAAE,CAAC,GACpC,8BAA8B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAW1C;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAEnE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,mBAGvC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,YAAY;IACvB;;OAEG;IACH,SAAgB,MAAM,EAAE,mBAAmB,CAAC;IAE5C;;;;OAIG;gBACgB,IAAI,CAAC,EAAE,uBAAuB;IAOjD;;;;;OAKG;IACI,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;IAQ3D;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAMzF;;;;;OAKG;IACI,wBAAwB,CAAC,CAAC,EAC/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,GACjC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;IA6BlC;;;;;;;OAOG;IACI,6BAA6B,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAClD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,CAAC,GAC1C,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAgBzB;;;;OAIG;IACI,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC;CAW7E;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,YAAiC,CAAC"}

package/lib/packlets/json-file/jsonFsHelper.js

@@ -0,0 +1,186 @@
+"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.DefaultJsonFsHelper = exports.JsonFsHelper = exports.DefaultJsonFsHelperConfig = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const jsonLike_1 = require("./jsonLike");
+/**
+ * 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);
+/**
+ * Default configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+exports.DefaultJsonFsHelperConfig = {
+    json: jsonLike_1.DefaultJsonLike,
+    allowUndefinedWrite: false
+};
+/**
+ * Helper class to simplify common filesystem operations involving JSON (or JSON-like)
+ * files.
+ * @public
+ */
+class JsonFsHelper {
+    /**
+     * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+     * and JSON values.
+     */
+    constructor(init) {
+        this.config = Object.assign(Object.assign({}, exports.DefaultJsonFsHelperConfig), (init !== null && init !== void 0 ? init : {}));
+    }
+    /**
+     * 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.
+     */
+    readJsonFileSync(srcPath) {
+        return (0, ts_utils_1.captureResult)(() => {
+            const fullPath = path.resolve(srcPath);
+            const body = fs.readFileSync(fullPath, 'utf8').toString();
+            return this.config.json.parse(body);
+        });
+    }
+    /**
+     * Read a JSON file and apply a supplied converter or validator.
+     * @param srcPath - Path of the file to read.
+     * @param cv - Converter or validator used to process the file.
+     * @returns `Success` with a result of type `<T>`, or `Failure`
+     * with a message if an error occurs.
+     */
+    processJsonFileSync(srcPath, cv) {
+        return this.readJsonFileSync(srcPath).onSuccess((json) => {
+            return cv.convalidate(json);
+        });
+    }
+    /**
+     * Reads all JSON files from a directory and apply a supplied converter or validator.
+     * @param srcPath - The path of the folder to be read.
+     * @param options - {@link JsonFile.JsonFsDirectoryOptions | Options} to control
+     * conversion and filtering
+     */
+    processJsonDirectorySync(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) => {
+                var _a;
+                if (fi.isFile() && path.extname(fi.name) === '.json') {
+                    const filePath = path.resolve(fullPath, fi.name);
+                    return this.processJsonFileSync(filePath, (_a = options.converter) !== null && _a !== void 0 ? _a : options.validator)
+                        .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();
+        });
+    }
+    /**
+     * Reads and converts or validates 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 JsonFile.JsonFsDirectoryToMapOptions | Options} to control conversion,
+     * filtering and naming.
+     */
+    processJsonDirectoryToMapSync(srcPath, options) {
+        return this.processJsonDirectorySync(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));
+            });
+        });
+    }
+    /**
+     * Write type-safe JSON to a file.
+     * @param srcPath - Path of the file to write.
+     * @param value - The {@link JsonValue | JsonValue} to be written.
+     */
+    writeJsonFileSync(srcPath, value) {
+        return (0, ts_utils_1.captureResult)(() => {
+            const fullPath = path.resolve(srcPath);
+            const stringified = this.config.json.stringify(value, undefined, 2);
+            if (stringified === undefined && this.config.allowUndefinedWrite !== true) {
+                throw new Error(`Could not stringify ${value}`);
+            }
+            fs.writeFileSync(fullPath, stringified);
+            return true;
+        });
+    }
+}
+exports.JsonFsHelper = JsonFsHelper;
+/**
+ * @public
+ */
+exports.DefaultJsonFsHelper = new JsonFsHelper();
+//# sourceMappingURL=jsonFsHelper.js.map

package/lib/packlets/json-file/jsonFsHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonFsHelper.js","sourceRoot":"","sources":["../../../src/packlets/json-file/jsonFsHelper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CASuB;AACvB,uCAAyB;AACzB,2CAA6B;AAG7B,yCAAwD;AAkFxD;;;;;;GAMG;AACH,MAAM,sBAAsB,GAAG,CAAC,CAAS,EAAkB,EAAE,CAAC,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;AAiBzE;;;GAGG;AACU,QAAA,yBAAyB,GAAwB;IAC5D,IAAI,EAAE,0BAAe;IACrB,mBAAmB,EAAE,KAAK;CAC3B,CAAC;AAEF;;;;GAIG;AACH,MAAa,YAAY;IAMvB;;;;OAIG;IACH,YAAmB,IAA8B;QAC/C,IAAI,CAAC,MAAM,mCACN,iCAAyB,GACzB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAChB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,OAAe;QACrC,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE;YACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAI,OAAe,EAAE,EAA8B;QAC3E,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACvD,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,wBAAwB,CAC7B,OAAe,EACf,OAAkC;QAElC,OAAO,IAAA,wBAAa,EAA0B,GAAG,EAAE;YACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACvC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,mBAAmB,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,KAAK;iBAClB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;;gBACV,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC;oBACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;oBACjD,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,OAAO,CAAC,SAAS,CAAC;yBAC9E,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;wBACrB,OAAO,IAAA,kBAAO,EAAC;4BACb,QAAQ,EAAE,EAAE,CAAC,IAAI;4BACjB,IAAI,EAAE,OAAO;yBACd,CAAC,CAAC;oBACL,CAAC,CAAC;yBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;wBACrB,OAAO,IAAA,eAAI,EAAC,GAAG,EAAE,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;oBACxC,CAAC,CAAC,CAAC;gBACP,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;iBACD,MAAM,CAAC,CAAC,CAAC,EAAsC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;YACtE,OAAO,IAAA,qBAAU,EAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,6BAA6B,CAClC,OAAe,EACf,OAA2C;QAE3C,OAAO,IAAI,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;;YACzE,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,sBAAsB,CAAC;YACtE,OAAO,IAAA,qBAAU,EACf,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACjB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACvD,OAAO,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC3D,OAAO,IAAA,kBAAO,EAAc,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CACH,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,OAAO,IAAA,kBAAO,EAAC,IAAI,GAAG,CAAY,KAAK,CAAC,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,OAAe,EAAE,KAAgB;QACxD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE;YACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YACpE,IAAI,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,mBAAmB,KAAK,IAAI,EAAE,CAAC;gBAC1E,MAAM,IAAI,KAAK,CAAC,uBAAuB,KAAK,EAAE,CAAC,CAAC;YAClD,CAAC;YACD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,WAAY,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA9HD,oCA8HC;AAED;;GAEG;AACU,QAAA,mBAAmB,GAAiB,IAAI,YAAY,EAAE,CAAC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n  Converter,\n  Result,\n  Validation,\n  Validator,\n  captureResult,\n  fail,\n  mapResults,\n  succeed\n} from '@fgv/ts-utils';\nimport * as fs from 'fs';\nimport * as path from 'path';\n\nimport { JsonValue } from '../json';\nimport { DefaultJsonLike, IJsonLike } from './jsonLike';\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  validator?: undefined;\n}\n\n/**\n * Options for directory validation.\n * @public\n */\nexport interface IDirectoryValidateOptions<T, TC = unknown> {\n  converter?: undefined;\n  /**\n   * The validator used to validate incoming JSON objects\n   */\n  validator: Validator<T, TC>;\n}\n\n/**\n * Options for directory conversion or validation.\n * @public\n */\nexport type JsonFsDirectoryOptions<T, TC = unknown> =\n  | IDirectoryConvertOptions<T, TC>\n  | IDirectoryValidateOptions<T, TC>;\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 * 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 to a `Map`.\n * @public\n */\nexport interface IDirectoryToMapConvertOptions<T, TC = unknown> extends IDirectoryConvertOptions<T, TC> {\n  transformName?: ItemNameTransformFunction<T>;\n}\n\n/**\n * Options controlling validation of a directory to a `Map`.\n * @public\n */\nexport interface IDirectoryToMapValidateOptions<T, TC = unknown> extends IDirectoryValidateOptions<T, TC> {\n  transformName?: ItemNameTransformFunction<T>;\n}\n\n/**\n * Options controlling processing of a directory to a `Map`.\n * @public\n */\nexport type JsonFsDirectoryToMapOptions<T, TC = unknown> =\n  | IDirectoryToMapConvertOptions<T, TC>\n  | IDirectoryToMapValidateOptions<T, TC>;\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 * Configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.\n * @public\n */\nexport interface IJsonFsHelperConfig {\n  json: IJsonLike;\n  allowUndefinedWrite: boolean;\n}\n\n/**\n * Initialization options for {@link JsonFile.JsonFsHelper | JsonFsHelper}.\n * @public\n */\nexport type JsonFsHelperInitOptions = Partial<IJsonFsHelperConfig>;\n\n/**\n * Default configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.\n * @public\n */\nexport const DefaultJsonFsHelperConfig: IJsonFsHelperConfig = {\n  json: DefaultJsonLike,\n  allowUndefinedWrite: false\n};\n\n/**\n * Helper class to simplify common filesystem operations involving JSON (or JSON-like)\n * files.\n * @public\n */\nexport class JsonFsHelper {\n  /**\n   * Configuration for this {@link JsonFile.JsonFsHelper | JsonFsHelper}.\n   */\n  public readonly config: IJsonFsHelperConfig;\n\n  /**\n   * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.\n   * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings\n   * and JSON values.\n   */\n  public constructor(init?: JsonFsHelperInitOptions) {\n    this.config = {\n      ...DefaultJsonFsHelperConfig,\n      ...(init ?? {})\n    };\n  }\n\n  /**\n   * 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   */\n  public readJsonFileSync(srcPath: string): Result<JsonValue> {\n    return captureResult(() => {\n      const fullPath = path.resolve(srcPath);\n      const body = fs.readFileSync(fullPath, 'utf8').toString();\n      return this.config.json.parse(body) as JsonValue;\n    });\n  }\n\n  /**\n   * Read a JSON file and apply a supplied converter or validator.\n   * @param srcPath - Path of the file to read.\n   * @param cv - Converter or validator used to process the file.\n   * @returns `Success` with a result of type `<T>`, or `Failure`\n   * with a message if an error occurs.\n   */\n  public processJsonFileSync<T>(srcPath: string, cv: Validation.Convalidator<T>): Result<T> {\n    return this.readJsonFileSync(srcPath).onSuccess((json) => {\n      return cv.convalidate(json);\n    });\n  }\n\n  /**\n   * Reads all JSON files from a directory and apply a supplied converter or validator.\n   * @param srcPath - The path of the folder to be read.\n   * @param options - {@link JsonFile.JsonFsDirectoryOptions | Options} to control\n   * conversion and filtering\n   */\n  public processJsonDirectorySync<T>(\n    srcPath: string,\n    options: JsonFsDirectoryOptions<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 this.processJsonFileSync(filePath, options.converter ?? options.validator)\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   * Reads and converts or validates 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 JsonFile.JsonFsDirectoryToMapOptions | Options} to control conversion,\n   * filtering and naming.\n   */\n  public processJsonDirectoryToMapSync<T, TC = unknown>(\n    srcPath: string,\n    options: JsonFsDirectoryToMapOptions<T, TC>\n  ): Result<Map<string, T>> {\n    return this.processJsonDirectorySync(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   * 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   */\n  public writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean> {\n    return captureResult(() => {\n      const fullPath = path.resolve(srcPath);\n      const stringified = this.config.json.stringify(value, undefined, 2);\n      if (stringified === undefined && this.config.allowUndefinedWrite !== true) {\n        throw new Error(`Could not stringify ${value}`);\n      }\n      fs.writeFileSync(fullPath, stringified!);\n      return true;\n    });\n  }\n}\n\n/**\n * @public\n */\nexport const DefaultJsonFsHelper: JsonFsHelper = new JsonFsHelper();\n"]}

package/lib/packlets/json-file/jsonLike.d.ts

@@ -0,0 +1,29 @@
+import { JsonValue } from '../json';
+/**
+ * @public
+ */
+export type JsonReviver = (key: string, value: JsonValue) => JsonValue;
+/**
+ * @public
+ */
+export type JsonReplacerFunction = (key: string, value: JsonValue) => JsonValue;
+/**
+ * @public
+ */
+export type JsonReplacerArray = (string | number)[];
+/**
+ * @public
+ */
+export type JsonReplacer = JsonReplacerFunction | JsonReplacerArray;
+/**
+ * @public
+ */
+export interface IJsonLike {
+    parse(text: string, reviver?: JsonReviver, options?: unknown): JsonValue | undefined;
+    stringify(value: JsonValue, replacer?: JsonReplacer, space?: string | number): string | undefined;
+}
+/**
+ * @public
+ */
+export declare const DefaultJsonLike: IJsonLike;
+//# sourceMappingURL=jsonLike.d.ts.map

package/lib/packlets/json-file/jsonLike.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonLike.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-file/jsonLike.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG,iBAAiB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IACrF,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnG;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,SAAgB,CAAC"}

package/lib/packlets/json-file/jsonLike.js

@@ -0,0 +1,29 @@
+"use strict";
+/*
+ * Copyright (c) 2024 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.DefaultJsonLike = void 0;
+/**
+ * @public
+ */
+exports.DefaultJsonLike = JSON;
+//# sourceMappingURL=jsonLike.js.map

package/lib/packlets/json-file/jsonLike.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonLike.js","sourceRoot":"","sources":["../../../src/packlets/json-file/jsonLike.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAgCH;;GAEG;AACU,QAAA,eAAe,GAAc,IAAI,CAAC","sourcesContent":["/*\n * Copyright (c) 2024 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 { JsonValue } from '../json';\n\n/**\n * @public\n */\nexport type JsonReviver = (key: string, value: JsonValue) => JsonValue;\n\n/**\n * @public\n */\nexport type JsonReplacerFunction = (key: string, value: JsonValue) => JsonValue;\n\n/**\n * @public\n */\nexport type JsonReplacerArray = (string | number)[];\n\n/**\n * @public\n */\nexport type JsonReplacer = JsonReplacerFunction | JsonReplacerArray;\n\n/**\n * @public\n */\nexport interface IJsonLike {\n  parse(text: string, reviver?: JsonReviver, options?: unknown): JsonValue | undefined;\n  stringify(value: JsonValue, replacer?: JsonReplacer, space?: string | number): string | undefined;\n}\n\n/**\n * @public\n */\nexport const DefaultJsonLike: IJsonLike = JSON;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@fgv/ts-json-base",
-	"version": "3.0.0",
+	"version": "3.0.1-alpha.0",
 	"description": "Typescript types and basic functions for working with json",
 	"main": "lib/index.js",
 	"types": "dist/ts-json-base.d.ts",
@@ -16,8 +16,8 @@
 	"homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base#readme",
 	"sideEffects": false,
 	"devDependencies": {
-		"@fgv/ts-utils": "3.0.0",
-		"@fgv/ts-utils-jest": "3.0.0",
+		"@fgv/ts-utils": "3.0.1-alpha.0",
+		"@fgv/ts-utils-jest": "3.0.1-alpha.0",
 		"@types/jest": "^29.5.11",
 		"@types/mustache": "^4.2.5",
 		"@types/node": "^20.11.5",
@@ -43,7 +43,7 @@
 		"@microsoft/api-documenter": "^7.23.17"
 	},
 	"peerDependencies": {
-		"@fgv/ts-utils": "^3.0.0",
+		"@fgv/ts-utils": "3.0.1-alpha.0",
 		"mustache": "^4.2.0"
 	},
 	"scripts": {