@fgv/ts-json-base 5.0.1-5 → 5.0.1-7

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

@@ -8,24 +8,35 @@ import { Validator } from '@fgv/ts-utils';
 import { Validators as Validators_3 } from '@fgv/ts-utils';
 
 /**
- * A helper function to create a {@link Converter | Converter} which converts a supplied `unknown` value to a valid
- * array of {@link JsonCompatibleType | JsonCompatibleType<T>}.
- * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>}
- * or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source array.
+ * A converter which converts a supplied `unknown` value to a valid array of {@link JsonCompatibleType | JsonCompatible} values.
+ * @public
+ */
+declare type ArrayConverter<T, TC = unknown> = Converter<JsonCompatibleType<T>[], TC>;
+
+/**
+ * A helper function to create a {@link JsonCompatible.ArrayConverter | JSON-compatible ArrayConverter<T, TC>}
+ * which converts a supplied `unknown` value to a valid array of {@link JsonCompatibleType | JsonCompatibleType<T>}.
+ * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source array.
  * @param onError - The error handling option to use for the conversion.
- * @returns A {@link Converter | Converter} which returns `JsonCompatibleType<T>[]`.
+ * @returns A {@link JsonCompatible.ArrayConverter | JSON-compatible ArrayConverter<T, TC>} which returns `JsonCompatibleType<T>[]`.
  * @public
  */
-declare function arrayOf<T, TC = unknown>(converter: JsonCompatible_2.Converter<T, TC> | JsonCompatible_2.Validator<T, TC>, onError?: Conversion.OnError): Converter<JsonCompatibleType<T>[], TC>;
+declare function arrayOf<T, TC = unknown>(converter: JsonCompatible_2.Converter<T, TC> | JsonCompatible_2.Validator<T, TC>, onError?: Conversion.OnError): JsonCompatible_2.ArrayConverter<T, TC>;
 
 /**
  * A helper function to create a {@link JsonCompatible.ArrayValidator | JSON-compatible ArrayValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
- * @param validateElement - The element to validate.
+ * @param validateElement - The element validator to use.
  * @param params - The parameters to use for the validation.
  * @returns A {@link JsonCompatible.ArrayValidator | JSON-compatible ArrayValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
  */
-declare function arrayOf_2<T, TC = unknown>(validateElement: JsonCompatible_2.Validator<T, TC>, params?: Omit<Validation.Classes.ArrayValidatorConstructorParams<JsonCompatibleType<T>, TC>, 'validateElement'>): Validation.Classes.ArrayValidator<JsonCompatibleType<T>, TC>;
+declare function arrayOf_2<T, TC = unknown>(validateElement: JsonCompatible_2.Validator<T, TC>, params?: Omit<Validation.Classes.ArrayValidatorConstructorParams<JsonCompatibleType<T>, TC>, 'validateElement'>): JsonCompatible_2.ArrayValidator<T, TC>;
+
+/**
+ * A validator which validates arrays of {@link JsonCompatibleType | JsonCompatible} values in place.
+ * @public
+ */
+declare type ArrayValidator<T, TC = unknown> = Validation.Classes.ArrayValidator<JsonCompatibleType<T>, TC>;
 
 /**
  * Identifies whether some `unknown` value is a {@link JsonPrimitive | primitive},
@@ -166,10 +177,12 @@ declare class DirectoryItem<TCT extends string = string> implements IFileTreeDir
 }
 
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param discriminatorProp - The name of the property used to discriminate types.
  * @param converters - The converters to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 declare function discriminatedObject<T, TD extends string = string, TC = unknown>(discriminatorProp: string, converters: Converters_3.DiscriminatedObjectConverters<JsonCompatibleType<T>, TD, TC>): JsonCompatible_2.Converter<T, TC>;
@@ -269,6 +282,7 @@ declare class FileItem<TCT extends string = string> implements IFileTreeFileItem
 
 declare namespace FileTree {
     export {
+        inMemory,
         FileTreeItemType,
         ContentTypeFactory,
         IFileTreeInitParams,
@@ -280,7 +294,6 @@ declare namespace FileTree {
         DirectoryItem,
         FileItem,
         forFilesystem,
-        inMemory,
         IInMemoryFile,
         InMemoryTreeAccessors,
         FsFileTreeAccessors
@@ -815,7 +828,11 @@ declare namespace JsonCompatible {
         Converter_2 as Converter,
         Validator_2 as Validator,
         ObjectConverter,
-        ObjectValidator
+        ObjectValidator,
+        ArrayConverter,
+        ArrayValidator,
+        RecordConverter,
+        RecordValidator
     }
 }
 export { JsonCompatible }
@@ -825,7 +842,11 @@ declare namespace JsonCompatible_2 {
         Converter_2 as Converter,
         Validator_2 as Validator,
         ObjectConverter,
-        ObjectValidator
+        ObjectValidator,
+        ArrayConverter,
+        ArrayValidator,
+        RecordConverter,
+        RecordValidator
     }
 }
 
@@ -1126,10 +1147,12 @@ declare const jsonValue_2: Validator<JsonValue, IJsonValidatorContext>;
 export declare type JsonValueType = 'primitive' | 'object' | 'array';
 
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param properties - The properties to convert.
  * @param options - The options to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 declare function object<T, TC = unknown>(properties: Conversion.FieldConverters<JsonCompatibleType<T>, TC>, options?: Conversion.ObjectConverterOptions<JsonCompatibleType<T>>): JsonCompatible_2.ObjectConverter<T, TC>;
@@ -1184,30 +1207,44 @@ export declare function pickJsonValue(src: JsonObject, path: string): Result<Jso
 declare function readJsonFileSync(srcPath: string): Result<JsonValue>;
 
 /**
- * A helper function to create a {@link Converter | Converter} or which converts the `string`-keyed properties
- * using a supplied {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or
+ * A converter which converts a supplied `unknown` value to a valid record of {@link JsonCompatibleType | JsonCompatible} values.
+ * @public
+ */
+declare type RecordConverter<T, TC = unknown, TK extends string = string> = Converter<Record<TK, JsonCompatibleType<T>>, TC>;
+
+/**
+ * A helper function to create a {@link JsonCompatible.RecordConverter | JSON-compatible RecordConverter<T, TC, TK>}
+ * which converts the `string`-keyed properties using a supplied {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or
  * {@link JsonCompatible.Validator | JSON-compatible Validator<T>} to produce a
  * `Record<TK, JsonCompatibleType<T>>`.
  * @remarks
- * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed
+ * If present, the supplied `Converters.KeyedConverterOptions` can provide a strongly-typed
  * converter for keys and/or control the handling of elements that fail conversion.
  * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>}
  * or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source object.
- * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which
+ * @param options - Optional `Converters.KeyedConverterOptions<TK, TC>` which
  * supplies a key converter and/or error-handling options.
- * @returns A {@link Converter | Converter} which returns `Record<TK, JsonCompatibleType<T>>`.
+ * @returns A {@link JsonCompatible.RecordConverter | JSON-compatible RecordConverter<T, TC, TK>} which
+ * converts a supplied `unknown` value to a valid record of {@link JsonCompatibleType | JsonCompatible} values.
  * @public
  */
-declare function recordOf<T, TC = unknown, TK extends string = string>(converter: JsonCompatible_2.Converter<T, TC> | JsonCompatible_2.Validator<T, TC>, options?: Converters_3.KeyedConverterOptions<TK, TC>): Converter<Record<TK, JsonCompatibleType<T>>, TC>;
+declare function recordOf<T, TC = unknown, TK extends string = string>(converter: JsonCompatible_2.Converter<T, TC> | JsonCompatible_2.Validator<T, TC>, options?: Converters_3.KeyedConverterOptions<TK, TC>): JsonCompatible_2.RecordConverter<T, TC, TK>;
 
 /**
- * A helper function to create a {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
- * @param validateElement - The element to validate.
+ * A helper function to create a {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC, TK>} which validates a supplied `unknown` value
+ * to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @param validateElement - The element validator to use.
  * @param options - The options to use for the validation.
- * @returns A {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @returns A `Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>` which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @public
+ */
+declare function recordOf_2<T, TC = unknown, TK extends string = string>(validateElement: JsonCompatible_2.Validator<T, TC>, options?: Validators_3.IRecordOfValidatorOptions<TK, TC>): JsonCompatible_2.RecordValidator<T, TC, TK>;
+
+/**
+ * A validator which validates a record of {@link JsonCompatibleType | JsonCompatible} values.
  * @public
  */
-declare function recordOf_2<T, TC = unknown, TK extends string = string>(validateElement: JsonCompatible_2.Validator<T, TC>, options?: Validators_3.IRecordOfValidatorOptions<TK, TC>): Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>;
+declare type RecordValidator<T, TC = unknown, TK extends string = string> = Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>;
 
 /**
  * "Sanitizes" an `unknown` by stringifying and then parsing it.  Guarantees a
@@ -1231,10 +1268,12 @@ export declare function sanitizeJson(from: unknown): Result<JsonValue>;
 export declare function sanitizeJsonObject<T>(from: T): Result<T>;
 
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param properties - The properties to convert.
  * @param options - The options to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 declare function strictObject<T, TC = unknown>(properties: Conversion.FieldConverters<JsonCompatibleType<T>, TC>, options?: Converters_3.StrictObjectConverterOptions<JsonCompatibleType<T>>): JsonCompatible_2.ObjectConverter<T, TC>;

package/lib/packlets/file-tree/fileTreeHelpers.d.ts

@@ -1,6 +1,5 @@
 import { Result } from '@fgv/ts-utils';
 import { FileTree } from './fileTree';
-import { IInMemoryFile } from './in-memory';
 import { IFileTreeInitParams } from './fileTreeAccessors';
 /**
  * Helper function to create a new {@link FileTree.FileTree | FileTree} instance
@@ -20,24 +19,4 @@ export declare function forFilesystem<TCT extends string = string>(prefix?: stri
  * @public
  */
 export declare function forFilesystem<TCT extends string = string>(params?: IFileTreeInitParams<TCT>): Result<FileTree<TCT>>;
-/**
- * Helper function to create a new {@link FileTree.FileTree | FileTree} instance
- * with accessors for an in-memory file tree.
- * @param files - An array of File |{@link FileTree.IInMemoryFile | in-memory files} to include in the tree.
- * @param prefix - An optional prefix to add to the paths of all files in the tree.
- * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance
- * if successful, or `Failure` with an error message otherwise.
- * @public
- */
-export declare function inMemory<TCT extends string = string>(files: IInMemoryFile<TCT>[], prefix?: string): Result<FileTree<TCT>>;
-/**
- * Helper function to create a new {@link FileTree.FileTree | FileTree} instance
- * with accessors for an in-memory file tree.
- * @param files - An array of File |{@link FileTree.IInMemoryFile | in-memory files} to include in the tree.
- * @param params - Optional {@link FileTree.IFileTreeInitParams | initialization parameters} for the file tree.
- * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance
- * if successful, or `Failure` with an error message otherwise.
- * @public
- */
-export declare function inMemory<TCT extends string = string>(files: IInMemoryFile<TCT>[], params?: IFileTreeInitParams<TCT>): Result<FileTree<TCT>>;
 //# sourceMappingURL=fileTreeHelpers.d.ts.map

package/lib/packlets/file-tree/fileTreeHelpers.inMemory.d.ts

@@ -0,0 +1,25 @@
+import { Result } from '@fgv/ts-utils';
+import { FileTree } from './fileTree';
+import { IInMemoryFile } from './in-memory';
+import { IFileTreeInitParams } from './fileTreeAccessors';
+/**
+ * Helper function to create a new {@link FileTree.FileTree | FileTree} instance
+ * with accessors for an in-memory file tree.
+ * @param files - An array of File |{@link FileTree.IInMemoryFile | in-memory files} to include in the tree.
+ * @param prefix - An optional prefix to add to the paths of all files in the tree.
+ * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance
+ * if successful, or `Failure` with an error message otherwise.
+ * @public
+ */
+export declare function inMemory<TCT extends string = string>(files: IInMemoryFile<TCT>[], prefix?: string): Result<FileTree<TCT>>;
+/**
+ * Helper function to create a new {@link FileTree.FileTree | FileTree} instance
+ * with accessors for an in-memory file tree.
+ * @param files - An array of File |{@link FileTree.IInMemoryFile | in-memory files} to include in the tree.
+ * @param params - Optional {@link FileTree.IFileTreeInitParams | initialization parameters} for the file tree.
+ * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance
+ * if successful, or `Failure` with an error message otherwise.
+ * @public
+ */
+export declare function inMemory<TCT extends string = string>(files: IInMemoryFile<TCT>[], params?: IFileTreeInitParams<TCT>): Result<FileTree<TCT>>;
+//# sourceMappingURL=fileTreeHelpers.inMemory.d.ts.map

package/lib/packlets/file-tree/fileTreeHelpers.inMemory.js

@@ -0,0 +1,31 @@
+"use strict";
+/*
+ * Copyright (c) 2025 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.inMemory = inMemory;
+const fileTree_1 = require("./fileTree");
+const in_memory_1 = require("./in-memory");
+function inMemory(files, params) {
+    params = typeof params === 'string' ? { prefix: params } : params;
+    return in_memory_1.InMemoryTreeAccessors.create(files, params).onSuccess((hal) => fileTree_1.FileTree.create(hal));
+}
+//# sourceMappingURL=fileTreeHelpers.inMemory.js.map

package/lib/packlets/file-tree/fileTreeHelpers.js

@@ -22,17 +22,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.forFilesystem = forFilesystem;
-exports.inMemory = inMemory;
 const ts_utils_1 = require("@fgv/ts-utils");
 const fileTree_1 = require("./fileTree");
 const fsTree_1 = require("./fsTree");
-const in_memory_1 = require("./in-memory");
 function forFilesystem(params) {
     params = typeof params === 'string' ? { prefix: params } : params;
     return (0, ts_utils_1.captureResult)(() => new fsTree_1.FsFileTreeAccessors(params)).onSuccess((hal) => fileTree_1.FileTree.create(hal));
 }
-function inMemory(files, params) {
-    params = typeof params === 'string' ? { prefix: params } : params;
-    return in_memory_1.InMemoryTreeAccessors.create(files, params).onSuccess((hal) => fileTree_1.FileTree.create(hal));
-}
 //# sourceMappingURL=fileTreeHelpers.js.map

package/lib/packlets/file-tree/index.browser.d.ts

@@ -3,4 +3,5 @@ export * from './fileTree';
 export * from './directoryItem';
 export * from './fileItem';
 export * from './in-memory';
+export { inMemory } from './fileTreeHelpers.inMemory';
 //# sourceMappingURL=index.browser.d.ts.map

package/lib/packlets/file-tree/index.browser.js

@@ -35,6 +35,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.inMemory = void 0;
 // Browser-safe FileTree exports - excludes Node.js filesystem dependencies
 // Export core interfaces and classes
 __exportStar(require("./fileTreeAccessors"), exports);
@@ -43,6 +44,8 @@ __exportStar(require("./directoryItem"), exports);
 __exportStar(require("./fileItem"), exports);
 // Export in-memory implementations for web compatibility
 __exportStar(require("./in-memory"), exports);
+var fileTreeHelpers_inMemory_1 = require("./fileTreeHelpers.inMemory");
+Object.defineProperty(exports, "inMemory", { enumerable: true, get: function () { return fileTreeHelpers_inMemory_1.inMemory; } });
 // Exclude:
 // - fsTree (requires Node.js fs/path)
 // - fileTreeHelpers (imports fsTree)

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

@@ -3,6 +3,7 @@ export * from './fileTree';
 export * from './directoryItem';
 export * from './fileItem';
 export * from './fileTreeHelpers';
+export { inMemory } from './fileTreeHelpers.inMemory';
 export * from './in-memory';
 export * from './fsTree';
 //# sourceMappingURL=index.d.ts.map

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

@@ -35,6 +35,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.inMemory = void 0;
 // Export core interfaces and classes
 __exportStar(require("./fileTreeAccessors"), exports);
 __exportStar(require("./fileTree"), exports);
@@ -42,6 +43,8 @@ __exportStar(require("./directoryItem"), exports);
 __exportStar(require("./fileItem"), exports);
 // Export tree-shakeable helpers (filesystem ones will be shaken out if not used)
 __exportStar(require("./fileTreeHelpers"), exports);
+var fileTreeHelpers_inMemory_1 = require("./fileTreeHelpers.inMemory");
+Object.defineProperty(exports, "inMemory", { enumerable: true, get: function () { return fileTreeHelpers_inMemory_1.inMemory; } });
 // Export in-memory implementations for web compatibility
 __exportStar(require("./in-memory"), exports);
 // Note: FsFileTreeAccessors is now only imported by fileTreeHelpers.ts

package/lib/packlets/json-compatible/common.d.ts

@@ -20,4 +20,24 @@ export type ObjectConverter<T, TC = unknown> = BaseObjectConverter<JsonCompatibl
  * @public
  */
 export type ObjectValidator<T, TC = unknown> = Validation.Classes.ObjectValidator<JsonCompatibleType<T>, TC>;
+/**
+ * A converter which converts a supplied `unknown` value to a valid array of {@link JsonCompatibleType | JsonCompatible} values.
+ * @public
+ */
+export type ArrayConverter<T, TC = unknown> = BaseConverter<JsonCompatibleType<T>[], TC>;
+/**
+ * A validator which validates arrays of {@link JsonCompatibleType | JsonCompatible} values in place.
+ * @public
+ */
+export type ArrayValidator<T, TC = unknown> = Validation.Classes.ArrayValidator<JsonCompatibleType<T>, TC>;
+/**
+ * A converter which converts a supplied `unknown` value to a valid record of {@link JsonCompatibleType | JsonCompatible} values.
+ * @public
+ */
+export type RecordConverter<T, TC = unknown, TK extends string = string> = BaseConverter<Record<TK, JsonCompatibleType<T>>, TC>;
+/**
+ * A validator which validates a record of {@link JsonCompatibleType | JsonCompatible} values.
+ * @public
+ */
+export type RecordValidator<T, TC = unknown, TK extends string = string> = Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>;
 //# sourceMappingURL=common.d.ts.map

package/lib/packlets/json-compatible/converters.d.ts

@@ -1,53 +1,59 @@
-import { Conversion, Converter, Converters } from '@fgv/ts-utils';
+import { Conversion, Converters } from '@fgv/ts-utils';
 import * as JsonCompatible from './common';
 import { JsonCompatibleType } from '../json';
 /**
- * A helper function to create a {@link Converter | Converter} which converts a supplied `unknown` value to a valid
- * array of {@link JsonCompatibleType | JsonCompatibleType<T>}.
- * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>}
- * or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source array.
+ * A helper function to create a {@link JsonCompatible.ArrayConverter | JSON-compatible ArrayConverter<T, TC>}
+ * which converts a supplied `unknown` value to a valid array of {@link JsonCompatibleType | JsonCompatibleType<T>}.
+ * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source array.
  * @param onError - The error handling option to use for the conversion.
- * @returns A {@link Converter | Converter} which returns `JsonCompatibleType<T>[]`.
+ * @returns A {@link JsonCompatible.ArrayConverter | JSON-compatible ArrayConverter<T, TC>} which returns `JsonCompatibleType<T>[]`.
  * @public
  */
-export declare function arrayOf<T, TC = unknown>(converter: JsonCompatible.Converter<T, TC> | JsonCompatible.Validator<T, TC>, onError?: Conversion.OnError): Converter<JsonCompatibleType<T>[], TC>;
+export declare function arrayOf<T, TC = unknown>(converter: JsonCompatible.Converter<T, TC> | JsonCompatible.Validator<T, TC>, onError?: Conversion.OnError): JsonCompatible.ArrayConverter<T, TC>;
 /**
- * A helper function to create a {@link Converter | Converter} or which converts the `string`-keyed properties
- * using a supplied {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or
+ * A helper function to create a {@link JsonCompatible.RecordConverter | JSON-compatible RecordConverter<T, TC, TK>}
+ * which converts the `string`-keyed properties using a supplied {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or
  * {@link JsonCompatible.Validator | JSON-compatible Validator<T>} to produce a
  * `Record<TK, JsonCompatibleType<T>>`.
  * @remarks
- * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed
+ * If present, the supplied `Converters.KeyedConverterOptions` can provide a strongly-typed
  * converter for keys and/or control the handling of elements that fail conversion.
  * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>}
  * or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source object.
- * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which
+ * @param options - Optional `Converters.KeyedConverterOptions<TK, TC>` which
  * supplies a key converter and/or error-handling options.
- * @returns A {@link Converter | Converter} which returns `Record<TK, JsonCompatibleType<T>>`.
+ * @returns A {@link JsonCompatible.RecordConverter | JSON-compatible RecordConverter<T, TC, TK>} which
+ * converts a supplied `unknown` value to a valid record of {@link JsonCompatibleType | JsonCompatible} values.
  * @public
  */
-export declare function recordOf<T, TC = unknown, TK extends string = string>(converter: JsonCompatible.Converter<T, TC> | JsonCompatible.Validator<T, TC>, options?: Converters.KeyedConverterOptions<TK, TC>): Converter<Record<TK, JsonCompatibleType<T>>, TC>;
+export declare function recordOf<T, TC = unknown, TK extends string = string>(converter: JsonCompatible.Converter<T, TC> | JsonCompatible.Validator<T, TC>, options?: Converters.KeyedConverterOptions<TK, TC>): JsonCompatible.RecordConverter<T, TC, TK>;
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param properties - The properties to convert.
  * @param options - The options to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 export declare function object<T, TC = unknown>(properties: Conversion.FieldConverters<JsonCompatibleType<T>, TC>, options?: Conversion.ObjectConverterOptions<JsonCompatibleType<T>>): JsonCompatible.ObjectConverter<T, TC>;
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param properties - The properties to convert.
  * @param options - The options to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 export declare function strictObject<T, TC = unknown>(properties: Conversion.FieldConverters<JsonCompatibleType<T>, TC>, options?: Converters.StrictObjectConverterOptions<JsonCompatibleType<T>>): JsonCompatible.ObjectConverter<T, TC>;
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param discriminatorProp - The name of the property used to discriminate types.
  * @param converters - The converters to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 export declare function discriminatedObject<T, TD extends string = string, TC = unknown>(discriminatorProp: string, converters: Converters.DiscriminatedObjectConverters<JsonCompatibleType<T>, TD, TC>): JsonCompatible.Converter<T, TC>;

package/lib/packlets/json-compatible/converters.js

@@ -28,50 +28,54 @@ exports.strictObject = strictObject;
 exports.discriminatedObject = discriminatedObject;
 const ts_utils_1 = require("@fgv/ts-utils");
 /**
- * A helper function to create a {@link Converter | Converter} which converts a supplied `unknown` value to a valid
- * array of {@link JsonCompatibleType | JsonCompatibleType<T>}.
- * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>}
- * or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source array.
+ * A helper function to create a {@link JsonCompatible.ArrayConverter | JSON-compatible ArrayConverter<T, TC>}
+ * which converts a supplied `unknown` value to a valid array of {@link JsonCompatibleType | JsonCompatibleType<T>}.
+ * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source array.
  * @param onError - The error handling option to use for the conversion.
- * @returns A {@link Converter | Converter} which returns `JsonCompatibleType<T>[]`.
+ * @returns A {@link JsonCompatible.ArrayConverter | JSON-compatible ArrayConverter<T, TC>} which returns `JsonCompatibleType<T>[]`.
  * @public
  */
 function arrayOf(converter, onError = 'failOnError') {
     return ts_utils_1.Converters.arrayOf(converter, onError);
 }
 /**
- * A helper function to create a {@link Converter | Converter} or which converts the `string`-keyed properties
- * using a supplied {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or
+ * A helper function to create a {@link JsonCompatible.RecordConverter | JSON-compatible RecordConverter<T, TC, TK>}
+ * which converts the `string`-keyed properties using a supplied {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} or
  * {@link JsonCompatible.Validator | JSON-compatible Validator<T>} to produce a
  * `Record<TK, JsonCompatibleType<T>>`.
  * @remarks
- * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed
+ * If present, the supplied `Converters.KeyedConverterOptions` can provide a strongly-typed
  * converter for keys and/or control the handling of elements that fail conversion.
  * @param converter - {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>}
  * or {@link JsonCompatible.Validator | JSON-compatible Validator<T>} used for each item in the source object.
- * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which
+ * @param options - Optional `Converters.KeyedConverterOptions<TK, TC>` which
  * supplies a key converter and/or error-handling options.
- * @returns A {@link Converter | Converter} which returns `Record<TK, JsonCompatibleType<T>>`.
+ * @returns A {@link JsonCompatible.RecordConverter | JSON-compatible RecordConverter<T, TC, TK>} which
+ * converts a supplied `unknown` value to a valid record of {@link JsonCompatibleType | JsonCompatible} values.
  * @public
  */
 function recordOf(converter, options) {
     return ts_utils_1.Converters.recordOf(converter, options !== null && options !== void 0 ? options : { onError: 'fail' });
 }
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param properties - The properties to convert.
  * @param options - The options to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 function object(properties, options) {
     return new ts_utils_1.Conversion.ObjectConverter(properties, options);
 }
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param properties - The properties to convert.
  * @param options - The options to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 function strictObject(properties, options) {
@@ -79,10 +83,12 @@ function strictObject(properties, options) {
     return new ts_utils_1.Conversion.ObjectConverter(properties, objectOptions);
 }
 /**
- * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * A helper function to create a {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} which converts a
+ * supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @param discriminatorProp - The name of the property used to discriminate types.
  * @param converters - The converters to use for the conversion.
- * @returns A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
+ * @returns A {@link JsonCompatible.Converter | JSON-compatible Converter<T, TC>} which
+ * converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatibleType<T>} value.
  * @public
  */
 function discriminatedObject(discriminatorProp, converters) {

package/lib/packlets/json-compatible/validators.d.ts

@@ -3,20 +3,21 @@ import * as JsonCompatible from './common';
 import { Validation, Validators } from '@fgv/ts-utils';
 /**
  * A helper function to create a {@link JsonCompatible.ArrayValidator | JSON-compatible ArrayValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
- * @param validateElement - The element to validate.
+ * @param validateElement - The element validator to use.
  * @param params - The parameters to use for the validation.
  * @returns A {@link JsonCompatible.ArrayValidator | JSON-compatible ArrayValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
  */
-export declare function arrayOf<T, TC = unknown>(validateElement: JsonCompatible.Validator<T, TC>, params?: Omit<Validation.Classes.ArrayValidatorConstructorParams<JsonCompatibleType<T>, TC>, 'validateElement'>): Validation.Classes.ArrayValidator<JsonCompatibleType<T>, TC>;
+export declare function arrayOf<T, TC = unknown>(validateElement: JsonCompatible.Validator<T, TC>, params?: Omit<Validation.Classes.ArrayValidatorConstructorParams<JsonCompatibleType<T>, TC>, 'validateElement'>): JsonCompatible.ArrayValidator<T, TC>;
 /**
- * A helper function to create a {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
- * @param validateElement - The element to validate.
+ * A helper function to create a {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC, TK>} which validates a supplied `unknown` value
+ * to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @param validateElement - The element validator to use.
  * @param options - The options to use for the validation.
- * @returns A {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @returns A `Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>` which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
  */
-export declare function recordOf<T, TC = unknown, TK extends string = string>(validateElement: JsonCompatible.Validator<T, TC>, options?: Validators.IRecordOfValidatorOptions<TK, TC>): Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>;
+export declare function recordOf<T, TC = unknown, TK extends string = string>(validateElement: JsonCompatible.Validator<T, TC>, options?: Validators.IRecordOfValidatorOptions<TK, TC>): JsonCompatible.RecordValidator<T, TC, TK>;
 /**
  * A helper function to create a {@link JsonCompatible.ObjectValidator | JSON-compatible ObjectValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @param properties - The properties to validate.

package/lib/packlets/json-compatible/validators.js

@@ -27,7 +27,7 @@ exports.object = object;
 const ts_utils_1 = require("@fgv/ts-utils");
 /**
  * A helper function to create a {@link JsonCompatible.ArrayValidator | JSON-compatible ArrayValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
- * @param validateElement - The element to validate.
+ * @param validateElement - The element validator to use.
  * @param params - The parameters to use for the validation.
  * @returns A {@link JsonCompatible.ArrayValidator | JSON-compatible ArrayValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
@@ -36,10 +36,11 @@ function arrayOf(validateElement, params) {
     return ts_utils_1.Validators.arrayOf(validateElement, params !== null && params !== void 0 ? params : {});
 }
 /**
- * A helper function to create a {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
- * @param validateElement - The element to validate.
+ * A helper function to create a {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC, TK>} which validates a supplied `unknown` value
+ * to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @param validateElement - The element validator to use.
  * @param options - The options to use for the validation.
- * @returns A {@link JsonCompatible.RecordValidator | JSON-compatible RecordValidator<T, TC>} which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
+ * @returns A `Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>` which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
  */
 function recordOf(validateElement, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json-base",
-  "version": "5.0.1-5",
+  "version": "5.0.1-7",
   "description": "Typescript types and basic functions for working with json",
   "main": "lib/index.js",
   "types": "dist/ts-json-base.d.ts",
@@ -53,11 +53,11 @@
     "@rushstack/eslint-config": "4.5.3",
     "eslint-plugin-tsdoc": "~0.4.0",
     "@types/luxon": "^3.7.1",
-    "@fgv/ts-utils": "5.0.1-5",
-    "@fgv/ts-utils-jest": "5.0.1-5"
+    "@fgv/ts-utils": "5.0.1-7",
+    "@fgv/ts-utils-jest": "5.0.1-7"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.1-5"
+    "@fgv/ts-utils": "5.0.1-7"
   },
   "dependencies": {
     "luxon": "^3.7.2"