@fgv/ts-json-base 5.1.0-32 → 5.1.0-34

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

@@ -33,6 +33,15 @@ declare type AnyFileTreeDirectoryItem<TCT extends string = string> = IFileTreeDi
  */
 declare type AnyFileTreeFileItem<TCT extends string = string> = IFileTreeFileItem<TCT> | IMutableFileTreeFileItem<TCT>;
 
+/**
+ * Creates a schema node for a JSON `array` whose elements all match `items`.
+ * @param items - The schema applied to every element.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is `Array<Static<S>>`.
+ * @public
+ */
+declare function array<S extends ISchemaValidator<unknown>>(items: S, opts?: ISchemaOptions): ISchemaValidator<Static<S>[]>;
+
 /**
  * A converter which converts a supplied `unknown` value to a valid array of {@link JsonCompatibleType | JsonCompatible} values.
  * @public
@@ -72,12 +81,20 @@ declare type ArrayValidator<T, TC = unknown> = Validation.Classes.ArrayValidator
  */
 declare const boolean: Converter<boolean, IJsonConverterContext>;
 
+/**
+ * Creates a schema node for a JSON `boolean`.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is `boolean`.
+ * @public
+ */
+declare function boolean_2(opts?: ISchemaOptions): ISchemaValidator<boolean>;
+
 /**
  * A `BooleanValidator` which validates a boolean in place.
  * Accepts `IJsonValidatorContext` but ignores it.
  * @public
  */
-declare const boolean_2: Validator<boolean, IJsonValidatorContext>;
+declare const boolean_3: Validator<boolean, IJsonValidatorContext>;
 
 /**
  * Identifies whether some `unknown` value is a {@link JsonPrimitive | primitive},
@@ -290,6 +307,15 @@ declare function enumeratedValue<T>(values: ReadonlyArray<T>, message?: string):
  */
 declare function enumeratedValue_2<T>(values: ReadonlyArray<T>, message?: string): Validator<T, IJsonValidatorContext | ReadonlyArray<T>>;
 
+/**
+ * Creates a schema node for a closed set of string literals.
+ * @param values - The allowed string values.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is the union of `values`.
+ * @public
+ */
+declare function enumOf<T extends string>(values: readonly T[], opts?: ISchemaOptions): ISchemaValidator<T>;
+
 /**
  * Class representing a file in a file tree.
  * @public
@@ -524,6 +550,27 @@ declare function forFilesystem<TCT extends string = string>(prefix?: string): Re
  */
 declare function forFilesystem<TCT extends string = string>(params?: IFileTreeInitParams<TCT>): Result<FileTree_2<TCT>>;
 
+/**
+ * Parses a raw JSON Schema object (e.g. one discovered at an MCP tool boundary) into a typed schema
+ * value within the LLM-tool subset.
+ *
+ * @remarks
+ * Because the static type cannot be recovered from a runtime value, the result is typed as the
+ * opaque supertype `ISchemaValidator<JsonValue>` — the honest type when a schema arrives at runtime,
+ * since schemas may validate strings, numbers, booleans, arrays, or objects. The `validate()` method
+ * performs real runtime validation; the derived static type is the opaque `JsonValue`.
+ *
+ * Consumers who need a narrower derived type must author the schema via the factories.
+ *
+ * Out-of-subset features fail loudly (see `FORBIDDEN_KEYWORDS`); `description` is preserved on every
+ * node; other annotations (`title`, `default`, `format`, `examples`) are silently ignored.
+ *
+ * @param json - The raw JSON Schema object to parse.
+ * @returns `Success` with the parsed schema, or `Failure` describing the first out-of-subset feature.
+ * @public
+ */
+declare function fromJson(json: JsonObject): Result<ISchemaValidator<JsonValue>>;
+
 /**
  * Implementation of {@link FileTree.IMutableFileTreeAccessors} that uses the
  * file system to access and modify files and directories.
@@ -888,6 +935,67 @@ declare interface IJsonValidatorContext {
     ignoreUndefinedProperties?: boolean;
 }
 
+/**
+ * Schema node for a JSON `array`.
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmArraySchema<S extends ISchemaValidator<unknown>> = ISchemaValidator<Static<S>[]>;
+
+/**
+ * Schema node for a JSON `boolean`.
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmBooleanSchema = ISchemaValidator<boolean>;
+
+/**
+ * Schema node for a closed set of string literals (`enum`).
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmEnumSchema<T extends string> = ISchemaValidator<T>;
+
+/**
+ * Schema node for a JSON `number` or `integer`.
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmNumberSchema = ISchemaValidator<number>;
+
+/**
+ * Schema node for a JSON `object`.
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmObjectSchema<P extends ILlmProperties> = ISchemaValidator<ObjectStatic<P>>;
+
+/**
+ * Wrapper marking a property as optional within an object schema.
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmOptional<S extends ISchemaValidator<unknown>> = ISchemaValidator<Static<S> | undefined>;
+
+/**
+ * A record of property schemas, as accepted by the `object` factory.
+ * @public
+ */
+declare type ILlmProperties = Record<string, ISchemaValidator<unknown>>;
+
+/**
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmSchema<T> = ISchemaValidator<T>;
+
+/**
+ * Schema node for a JSON `string`.
+ * @deprecated Use `ISchemaValidator` instead.
+ * @public
+ */
+declare type ILlmStringSchema = ISchemaValidator<string>;
+
 /**
  * Extended accessors interface that supports mutation operations.
  * All mutation methods are required — use {@link FileTree.isMutableAccessors | isMutableAccessors}
@@ -1135,6 +1243,39 @@ declare class InMemoryTreeAccessors<TCT extends string = string> implements IMut
     saveFileContents(path: string, contents: string): Result<string>;
 }
 
+/**
+ * Creates a schema node for a JSON `integer`.
+ * @param opts - Optional description and strict mode (see `INumberSchemaOptions`).
+ * @returns An `ISchemaValidator` (tagged `integer`) whose `Static` type is `number`.
+ * @public
+ */
+declare function integer(opts?: INumberSchemaOptions): ISchemaValidator<number>;
+
+/**
+ * Options for the `number` and `integer` factories.
+ * @public
+ */
+declare interface INumberSchemaOptions extends ISchemaOptions {
+    /**
+     * When `true` (default), the derived validator rejects numeric strings such as `'42'` and
+     * accepts only genuine JSON numbers. Set `false` to opt into permissive coercion (numeric
+     * strings are accepted and converted to their numeric value).
+     */
+    strict?: boolean;
+}
+
+/**
+ * Options for the `object` factory.
+ * @public
+ */
+declare interface IObjectSchemaOptions extends ISchemaOptions {
+    /**
+     * When `false` (default), the validator rejects unrecognized properties and the emitted schema
+     * sets `additionalProperties: false`. Set `true` to allow extra fields.
+     */
+    additionalProperties?: boolean;
+}
+
 /**
  * Extended accessors interface that supports persistence operations.
  * @public
@@ -1172,6 +1313,55 @@ declare interface IReadDirectoryItem<T> {
     item: T;
 }
 
+/**
+ * Common options accepted by every schema factory.
+ * @public
+ */
+declare interface ISchemaOptions {
+    /**
+     * Optional human-readable description emitted into the wire JSON Schema.
+     */
+    description?: string;
+}
+
+/**
+ * A typed JSON Schema node for the LLM-tool subset. Every value returned by the
+ * schema factories implements this interface — it IS a `Validator<T>` and also
+ * carries a `toJson()` method for wire-format emission.
+ *
+ * @remarks
+ * The `__staticType` property is a phantom: it exists only in the type system to carry
+ * the derived static type `T` and is never assigned at runtime (declared optional so
+ * factory return values need not populate it). `Static<S>` reads this slot to recover
+ * `T` from a schema value without requiring a user-supplied type assertion. A plain
+ * optional property is used rather than a module-private `unique symbol` because this is
+ * a published package surface — a private-symbol-keyed property cannot be named in the
+ * emitted `.d.ts` (TypeBox issue #679), which would break declaration emission and API
+ * Extractor for downstream consumers.
+ *
+ * Consumers call `schema.validate(input)` directly; no separate adapter step is required.
+ * @public
+ */
+declare interface ISchemaValidator<T> extends Validator<T> {
+    /**
+     * Phantom type carrier — type-level only, never present at runtime.
+     */
+    readonly __staticType?: T;
+    /**
+     * Runtime discriminant. Identifies the schema node kind.
+     */
+    readonly _type: SchemaNodeType;
+    /**
+     * Optional human-readable description emitted into the wire JSON Schema.
+     */
+    readonly description?: string;
+    /**
+     * Emits the standard JSON Schema (draft-07 LLM-tool subset) wire form for this schema.
+     * @returns The JSON Schema object describing this schema node.
+     */
+    toJson(): JsonObject;
+}
+
 /**
  * Test if an `unknown` is potentially a {@link JsonArray | JsonArray}.
  * @param from - The `unknown` to be tested.
@@ -1525,6 +1715,64 @@ declare type JsonReplacerFunction = (key: string, value: JsonValue) => JsonValue
  */
 declare type JsonReviver = (key: string, value: JsonValue) => JsonValue;
 
+declare namespace JsonSchema {
+    export {
+        SchemaNodeType,
+        ISchemaValidator,
+        Static,
+        ILlmProperties,
+        OptionalKeys,
+        RequiredKeys,
+        OptionalPropertyStatic,
+        Simplify,
+        ObjectStatic,
+        ILlmSchema,
+        ILlmStringSchema,
+        ILlmNumberSchema,
+        ILlmBooleanSchema,
+        ILlmEnumSchema,
+        ILlmOptional,
+        ILlmArraySchema,
+        ILlmObjectSchema,
+        string_2 as string,
+        number_2 as number,
+        integer,
+        boolean_2 as boolean,
+        enumOf,
+        optional,
+        array,
+        object_3 as object,
+        ISchemaOptions,
+        INumberSchemaOptions,
+        IObjectSchemaOptions,
+        fromJson,
+        jsonSchemaConverter
+    }
+}
+export { JsonSchema }
+
+/**
+ * The main converter. Parses a raw JSON Schema object into a typed schema validator
+ * for the LLM-tool subset.
+ *
+ * @remarks
+ * Performs pre-flight checks (non-object root, union type arrays, forbidden keywords,
+ * unknown types) before dispatching to the per-type arm converters.
+ *
+ * The conversion context (`TC = string`) carries the current JSON Pointer path so that
+ * error messages from nested nodes name the actual failing node (e.g.
+ * `#/properties/config/properties/inner: 'required' key '...'`) rather than always
+ * reporting `#:`. The context defaults to `'#'` when absent (top-level call).
+ *
+ * Array and object arms reference `jsonSchemaConverter` by name from inside function
+ * declarations (hoisted). By the time any arm is called at runtime, `jsonSchemaConverter`
+ * is fully initialized, so recursive sub-schema calls also go through the pre-flight checks
+ * and produce meaningful error messages.
+ *
+ * @public
+ */
+declare const jsonSchemaConverter: Converter<ISchemaValidator<JsonValue>, string>;
+
 /**
  * Helper class to work with JSON files using FileTree API (web-compatible).
  * @public
@@ -1642,12 +1890,20 @@ declare type MutableFileTreeItem<TCT extends string = string> = IMutableFileTree
  */
 declare const number: Converter<number, IJsonConverterContext>;
 
+/**
+ * Creates a schema node for a JSON `number`.
+ * @param opts - Optional description and strict mode (see `INumberSchemaOptions`).
+ * @returns An `ISchemaValidator` whose `Static` type is `number`.
+ * @public
+ */
+declare function number_2(opts?: INumberSchemaOptions): ISchemaValidator<number>;
+
 /**
  * A `NumberValidator` which validates a number in place.
  * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
  * @public
  */
-declare const number_2: Validation.Classes.NumberValidator<number, IJsonValidatorContext>;
+declare const number_3: Validation.Classes.NumberValidator<number, IJsonValidatorContext>;
 
 /**
  * A helper function to create a {@link JsonCompatible.ObjectConverter | JSON-compatible ObjectConverter<T, TC>} which converts a
@@ -1669,18 +1925,62 @@ declare function object<T, TC = unknown>(properties: Conversion.FieldConverters<
  */
 declare function object_2<T, TC = unknown>(properties: Validation.Classes.FieldValidators<JsonCompatibleType<T>, TC>, params?: Omit<Validation.Classes.ObjectValidatorConstructorParams<JsonCompatibleType<T>, TC>, 'fields'>): JsonCompatible_2.ObjectValidator<T, TC>;
 
+/**
+ * Creates a schema node for a JSON `object` with a fixed set of typed properties.
+ * @param properties - A record mapping property names to their schemas. Wrap a property with
+ * `optional` to make it optional.
+ * @param opts - Optional description and `additionalProperties` flag.
+ * @returns An `ISchemaValidator` whose `Static` type derives the required/optional split.
+ * @public
+ */
+declare function object_3<P extends ILlmProperties>(properties: P, opts?: IObjectSchemaOptions): ISchemaValidator<ObjectStatic<P>>;
+
 /**
  * A converter which converts a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
  */
 declare type ObjectConverter<T, TC = unknown> = ObjectConverter_2<JsonCompatibleType<T>, TC>;
 
+/**
+ * The derived static type for an object built from properties `P`: required keys carry their
+ * static type directly, optional keys carry theirs under a `?` modifier.
+ * @public
+ */
+declare type ObjectStatic<P extends ILlmProperties> = Simplify<{
+    [K in RequiredKeys<P>]: Static<P[K]>;
+} & {
+    [K in OptionalKeys<P>]?: OptionalPropertyStatic<P[K]>;
+}>;
+
 /**
  * A validator which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public
  */
 declare type ObjectValidator<T, TC = unknown> = Validation.Classes.ObjectValidator<JsonCompatibleType<T>, TC>;
 
+/**
+ * Marks a property schema as optional within an `object` schema.
+ * @param schema - The inner schema to make optional.
+ * @returns An `ISchemaValidator` whose `Static` type is `Static<S> | undefined`.
+ * @public
+ */
+declare function optional<S extends ISchemaValidator<unknown>>(schema: S): ISchemaValidator<Static<S> | undefined>;
+
+/**
+ * The keys of `P` whose schemas are optional (wrapped with the `optional` modifier).
+ * @public
+ */
+declare type OptionalKeys<P extends ILlmProperties> = {
+    [K in keyof P]: P[K] extends ISchemaValidator<infer U> ? (undefined extends U ? K : never) : never;
+}[keyof P];
+
+/**
+ * The static value type carried by an optional property (the inner schema's static type,
+ * without the `| undefined` that optionality adds — the `?` modifier conveys that separately).
+ * @public
+ */
+declare type OptionalPropertyStatic<V> = V extends ISchemaValidator<infer U> ? Exclude<U, undefined> : never;
+
 /**
  * Picks a nested {@link JsonObject | JsonObject} from a supplied
  * {@link JsonObject | JsonObject}.
@@ -1749,6 +2049,12 @@ declare function recordOf_2<T, TC = unknown, TK extends string = string>(validat
  */
 declare type RecordValidator<T, TC = unknown, TK extends string = string> = Validation.Validator<Record<TK, JsonCompatibleType<T>>, TC>;
 
+/**
+ * The keys of `P` whose schemas are required (i.e. not optional).
+ * @public
+ */
+declare type RequiredKeys<P extends ILlmProperties> = Exclude<keyof P, OptionalKeys<P>>;
+
 /**
  * "Sanitizes" an `unknown` by stringifying and then parsing it.  Guarantees a
  * valid {@link JsonValue | JsonValue} but is not idempotent and gives no guarantees
@@ -1795,6 +2101,31 @@ declare type SaveDetail = SaveCapability | SaveFailureReason;
  */
 declare type SaveFailureReason = 'not-supported' | 'read-only' | 'not-mutable' | 'path-excluded' | 'permission-denied';
 
+/**
+ * Discriminant tag carried by every schema node.
+ * @public
+ */
+declare type SchemaNodeType = 'string' | 'number' | 'integer' | 'boolean' | 'enum' | 'optional' | 'array' | 'object';
+
+/**
+ * Flattens an intersection of object types into a single object type for readable derived types.
+ * @public
+ */
+declare type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+/**
+ * Recover the derived static type `T` from a schema value.
+ *
+ * @remarks
+ * `Static<typeof MySchema>` resolves to the TypeScript type that `schema.validate()` produces
+ * and that `schema.toJson()` describes — derived, never asserted. No user-supplied `T` is ever
+ * required.
+ * @public
+ */
+declare type Static<S extends ISchemaValidator<unknown>> = S extends ISchemaValidator<infer T> ? T : never;
+
 /**
  * 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.
@@ -1813,12 +2144,20 @@ declare function strictObject<T, TC = unknown>(properties: Conversion.FieldConve
  */
 declare const string: StringConverter<string, IJsonConverterContext>;
 
+/**
+ * Creates a schema node for a JSON `string`.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is `string`.
+ * @public
+ */
+declare function string_2(opts?: ISchemaOptions): ISchemaValidator<string>;
+
 /**
  * A `StringValidator` which validates a string in place.
  * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
  * @public
  */
-declare const string_2: Validation.Classes.StringValidator<string, IJsonValidatorContext>;
+declare const string_3: Validation.Classes.StringValidator<string, IJsonValidatorContext>;
 
 /**
  * Creates a converter that accepts a string, parses it as JSON, and optionally
@@ -1863,9 +2202,9 @@ declare namespace Validators {
         jsonObject_2 as jsonObject,
         jsonArray_2 as jsonArray,
         jsonValue_2 as jsonValue,
-        string_2 as string,
-        number_2 as number,
-        boolean_2 as boolean
+        string_3 as string,
+        number_3 as number,
+        boolean_3 as boolean
     }
 }
 export { Validators }

package/lib/index.browser.d.ts

@@ -2,7 +2,8 @@ import * as Converters from './packlets/converters';
 import * as FileTree from './packlets/file-tree/index.browser';
 import * as JsonCompatible from './packlets/json-compatible';
 import * as JsonFile from './packlets/json-file/index.browser';
+import * as JsonSchema from './packlets/json-schema-builder';
 import * as Validators from './packlets/validators';
 export * from './packlets/json';
-export { Converters, FileTree, JsonCompatible, JsonFile, Validators };
+export { Converters, FileTree, JsonCompatible, JsonFile, JsonSchema, Validators };
 //# sourceMappingURL=index.browser.d.ts.map

package/lib/index.browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAE7D,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAE7D,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,UAAU,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC"}

package/lib/index.browser.js

@@ -57,7 +57,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.Validators = exports.JsonFile = exports.JsonCompatible = exports.FileTree = exports.Converters = void 0;
+exports.Validators = exports.JsonSchema = exports.JsonFile = exports.JsonCompatible = exports.FileTree = exports.Converters = void 0;
 const Converters = __importStar(require("./packlets/converters"));
 exports.Converters = Converters;
 // eslint-disable-next-line @rushstack/packlets/mechanics
@@ -68,6 +68,8 @@ exports.JsonCompatible = JsonCompatible;
 // eslint-disable-next-line @rushstack/packlets/mechanics
 const JsonFile = __importStar(require("./packlets/json-file/index.browser"));
 exports.JsonFile = JsonFile;
+const JsonSchema = __importStar(require("./packlets/json-schema-builder"));
+exports.JsonSchema = JsonSchema;
 const Validators = __importStar(require("./packlets/validators"));
 exports.Validators = Validators;
 __exportStar(require("./packlets/json"), exports);

package/lib/index.browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAS3C,gCAAU;AARnB,yDAAyD;AACzD,6EAA+D;AAO1C,4BAAQ;AAN7B,2EAA6D;AAM9B,wCAAc;AAL7C,yDAAyD;AACzD,6EAA+D;AAIhB,4BAAQ;AAHvD,kEAAoD;AAGK,gCAAU;AADnE,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as FileTree from './packlets/file-tree/index.browser';\nimport * as JsonCompatible from './packlets/json-compatible';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as JsonFile from './packlets/json-file/index.browser';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, Validators };\n"]}
+{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAU3C,gCAAU;AATnB,yDAAyD;AACzD,6EAA+D;AAQ1C,4BAAQ;AAP7B,2EAA6D;AAO9B,wCAAc;AAN7C,yDAAyD;AACzD,6EAA+D;AAKhB,4BAAQ;AAJvD,2EAA6D;AAIJ,gCAAU;AAHnE,kEAAoD;AAGiB,gCAAU;AAD/E,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as FileTree from './packlets/file-tree/index.browser';\nimport * as JsonCompatible from './packlets/json-compatible';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as JsonFile from './packlets/json-file/index.browser';\nimport * as JsonSchema from './packlets/json-schema-builder';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, JsonSchema, Validators };\n"]}

package/lib/index.d.ts

@@ -2,7 +2,8 @@ import * as Converters from './packlets/converters';
 import * as FileTree from './packlets/file-tree';
 import * as JsonCompatible from './packlets/json-compatible';
 import * as JsonFile from './packlets/json-file';
+import * as JsonSchema from './packlets/json-schema-builder';
 import * as Validators from './packlets/validators';
 export * from './packlets/json';
-export { Converters, FileTree, JsonCompatible, JsonFile, Validators };
+export { Converters, FileTree, JsonCompatible, JsonFile, JsonSchema, Validators };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC"}

package/lib/index.js

@@ -57,7 +57,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.Validators = exports.JsonFile = exports.JsonCompatible = exports.FileTree = exports.Converters = void 0;
+exports.Validators = exports.JsonSchema = exports.JsonFile = exports.JsonCompatible = exports.FileTree = exports.Converters = void 0;
 const Converters = __importStar(require("./packlets/converters"));
 exports.Converters = Converters;
 const FileTree = __importStar(require("./packlets/file-tree"));
@@ -66,6 +66,8 @@ const JsonCompatible = __importStar(require("./packlets/json-compatible"));
 exports.JsonCompatible = JsonCompatible;
 const JsonFile = __importStar(require("./packlets/json-file"));
 exports.JsonFile = JsonFile;
+const JsonSchema = __importStar(require("./packlets/json-schema-builder"));
+exports.JsonSchema = JsonSchema;
 const Validators = __importStar(require("./packlets/validators"));
 exports.Validators = Validators;
 __exportStar(require("./packlets/json"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAO3C,gCAAU;AANnB,+DAAiD;AAM5B,4BAAQ;AAL7B,2EAA6D;AAK9B,wCAAc;AAJ7C,+DAAiD;AAIF,4BAAQ;AAHvD,kEAAoD;AAGK,gCAAU;AADnE,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\nimport * as FileTree from './packlets/file-tree';\nimport * as JsonCompatible from './packlets/json-compatible';\nimport * as JsonFile from './packlets/json-file';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, Validators };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAQ3C,gCAAU;AAPnB,+DAAiD;AAO5B,4BAAQ;AAN7B,2EAA6D;AAM9B,wCAAc;AAL7C,+DAAiD;AAKF,4BAAQ;AAJvD,2EAA6D;AAIJ,gCAAU;AAHnE,kEAAoD;AAGiB,gCAAU;AAD/E,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\nimport * as FileTree from './packlets/file-tree';\nimport * as JsonCompatible from './packlets/json-compatible';\nimport * as JsonFile from './packlets/json-file';\nimport * as JsonSchema from './packlets/json-schema-builder';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, JsonSchema, Validators };\n"]}

package/lib/packlets/json-schema-builder/factories.d.ts

@@ -0,0 +1,95 @@
+import { ILlmProperties, ISchemaValidator, ObjectStatic, Static } from './types';
+/**
+ * Common options accepted by every schema factory.
+ * @public
+ */
+export interface ISchemaOptions {
+    /**
+     * Optional human-readable description emitted into the wire JSON Schema.
+     */
+    description?: string;
+}
+/**
+ * Options for the `number` and `integer` factories.
+ * @public
+ */
+export interface INumberSchemaOptions extends ISchemaOptions {
+    /**
+     * When `true` (default), the derived validator rejects numeric strings such as `'42'` and
+     * accepts only genuine JSON numbers. Set `false` to opt into permissive coercion (numeric
+     * strings are accepted and converted to their numeric value).
+     */
+    strict?: boolean;
+}
+/**
+ * Options for the `object` factory.
+ * @public
+ */
+export interface IObjectSchemaOptions extends ISchemaOptions {
+    /**
+     * When `false` (default), the validator rejects unrecognized properties and the emitted schema
+     * sets `additionalProperties: false`. Set `true` to allow extra fields.
+     */
+    additionalProperties?: boolean;
+}
+/**
+ * Creates a schema node for a JSON `string`.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is `string`.
+ * @public
+ */
+export declare function string(opts?: ISchemaOptions): ISchemaValidator<string>;
+/**
+ * Creates a schema node for a JSON `number`.
+ * @param opts - Optional description and strict mode (see `INumberSchemaOptions`).
+ * @returns An `ISchemaValidator` whose `Static` type is `number`.
+ * @public
+ */
+export declare function number(opts?: INumberSchemaOptions): ISchemaValidator<number>;
+/**
+ * Creates a schema node for a JSON `integer`.
+ * @param opts - Optional description and strict mode (see `INumberSchemaOptions`).
+ * @returns An `ISchemaValidator` (tagged `integer`) whose `Static` type is `number`.
+ * @public
+ */
+export declare function integer(opts?: INumberSchemaOptions): ISchemaValidator<number>;
+/**
+ * Creates a schema node for a JSON `boolean`.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is `boolean`.
+ * @public
+ */
+export declare function boolean(opts?: ISchemaOptions): ISchemaValidator<boolean>;
+/**
+ * Creates a schema node for a closed set of string literals.
+ * @param values - The allowed string values.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is the union of `values`.
+ * @public
+ */
+export declare function enumOf<T extends string>(values: readonly T[], opts?: ISchemaOptions): ISchemaValidator<T>;
+/**
+ * Marks a property schema as optional within an `object` schema.
+ * @param schema - The inner schema to make optional.
+ * @returns An `ISchemaValidator` whose `Static` type is `Static<S> | undefined`.
+ * @public
+ */
+export declare function optional<S extends ISchemaValidator<unknown>>(schema: S): ISchemaValidator<Static<S> | undefined>;
+/**
+ * Creates a schema node for a JSON `array` whose elements all match `items`.
+ * @param items - The schema applied to every element.
+ * @param opts - Optional description.
+ * @returns An `ISchemaValidator` whose `Static` type is `Array<Static<S>>`.
+ * @public
+ */
+export declare function array<S extends ISchemaValidator<unknown>>(items: S, opts?: ISchemaOptions): ISchemaValidator<Static<S>[]>;
+/**
+ * Creates a schema node for a JSON `object` with a fixed set of typed properties.
+ * @param properties - A record mapping property names to their schemas. Wrap a property with
+ * `optional` to make it optional.
+ * @param opts - Optional description and `additionalProperties` flag.
+ * @returns An `ISchemaValidator` whose `Static` type derives the required/optional split.
+ * @public
+ */
+export declare function object<P extends ILlmProperties>(properties: P, opts?: IObjectSchemaOptions): ISchemaValidator<ObjectStatic<P>>;
+//# sourceMappingURL=factories.d.ts.map

package/lib/packlets/json-schema-builder/factories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factories.d.ts","sourceRoot":"","sources":["../../../src/packlets/json-schema-builder/factories.ts"],"names":[],"mappings":"AAkCA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAkB,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjG;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAkVD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAEtE;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,IAAI,CAAC,EAAE,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAE5E;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,IAAI,CAAC,EAAE,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAExE;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAEzG;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC,EAC1D,MAAM,EAAE,CAAC,GACR,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAEzC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC,EACvD,KAAK,EAAE,CAAC,EACR,IAAI,CAAC,EAAE,cAAc,GACpB,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAE/B;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,cAAc,EAC7C,UAAU,EAAE,CAAC,EACb,IAAI,CAAC,EAAE,oBAAoB,GAC1B,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEnC"}