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

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

@@ -3,6 +3,7 @@ import { Converter } from '@fgv/ts-utils';
 import { Converters as Converters_3 } from '@fgv/ts-utils';
 import { ObjectConverter as ObjectConverter_2 } from '@fgv/ts-utils';
 import { Result } from '@fgv/ts-utils';
+import { StringConverter } from '@fgv/ts-utils';
 import { Validation } from '@fgv/ts-utils';
 import { Validator } from '@fgv/ts-utils';
 import { Validators as Validators_3 } from '@fgv/ts-utils';
@@ -38,6 +39,14 @@ declare function arrayOf_2<T, TC = unknown>(validateElement: JsonCompatible_2.Va
  */
 declare type ArrayValidator<T, TC = unknown> = Validation.Classes.ArrayValidator<JsonCompatibleType<T>, TC>;
 
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `boolean`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+declare const boolean: Converter<boolean, IJsonConverterContext>;
+
 /**
  * Identifies whether some `unknown` value is a {@link JsonPrimitive | primitive},
  * {@link JsonObject | object} or {@link JsonArray | array}. Fails for any value
@@ -62,11 +71,16 @@ declare type Converter_2<T, TC = unknown> = Converter<JsonCompatibleType<T>, TC>
 
 declare namespace Converters {
     export {
+        literal,
+        enumeratedValue,
         IJsonConverterContext,
         jsonPrimitive,
         jsonObject,
         jsonArray,
-        jsonValue
+        jsonValue,
+        string,
+        number,
+        boolean
     }
 }
 export { Converters }
@@ -187,6 +201,22 @@ declare class DirectoryItem<TCT extends string = string> implements IFileTreeDir
  */
 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>;
 
+/**
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of
+ * supplied enumerated values. Anything else fails.
+ *
+ * @remarks
+ * This JSON variant accepts an {@link Converters.IJsonConverterContext | IJsonConverterContext} OR
+ * a `ReadonlyArray<T>` as its conversion context. If the context is an array, it is used to override the
+ * allowed values for that conversion; otherwise, the original `values` supplied at creation time are used.
+ *
+ * @param values - Array of allowed values.
+ * @param message - Optional custom failure message.
+ * @returns A new {@link Converter | Converter} returning `<T>`.
+ * @public
+ */
+declare function enumeratedValue<T>(values: ReadonlyArray<T>, message?: string): Converter<T, IJsonConverterContext | ReadonlyArray<T>>;
+
 /**
  * Class representing a file in a file tree.
  * @public
@@ -1146,6 +1176,22 @@ declare const jsonValue_2: Validator<JsonValue, IJsonValidatorContext>;
  */
 export declare type JsonValueType = 'primitive' | 'object' | 'array';
 
+/**
+ * Helper to create a converter for a literal value.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+declare function literal<T>(value: T): Converter<T, IJsonConverterContext>;
+
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `number`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+declare const number: Converter<number, IJsonConverterContext>;
+
 /**
  * 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.
@@ -1278,6 +1324,13 @@ export declare function sanitizeJsonObject<T>(from: T): Result<T>;
  */
 declare function strictObject<T, TC = unknown>(properties: Conversion.FieldConverters<JsonCompatibleType<T>, TC>, options?: Converters_3.StrictObjectConverterOptions<JsonCompatibleType<T>>): JsonCompatible_2.ObjectConverter<T, TC>;
 
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `string`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * @public
+ */
+declare const string: StringConverter<string, IJsonConverterContext>;
+
 /**
  * A validator which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public

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

@@ -1,4 +1,4 @@
-import { Converter } from '@fgv/ts-utils';
+import { Converter, StringConverter } from '@fgv/ts-utils';
 import { JsonArray, JsonObject, JsonPrimitive, JsonValue } from '../json';
 /**
  * Conversion context for JSON converters.
@@ -40,4 +40,46 @@ export declare const jsonArray: Converter<JsonArray, IJsonConverterContext>;
  * @public
  */
 export declare const jsonValue: Converter<JsonValue, IJsonConverterContext>;
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `string`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * @public
+ */
+export declare const string: StringConverter<string, IJsonConverterContext>;
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `number`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+export declare const number: Converter<number, IJsonConverterContext>;
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `boolean`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+export declare const boolean: Converter<boolean, IJsonConverterContext>;
+/**
+ * Helper to create a converter for a literal value.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+export declare function literal<T>(value: T): Converter<T, IJsonConverterContext>;
+/**
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of
+ * supplied enumerated values. Anything else fails.
+ *
+ * @remarks
+ * This JSON variant accepts an {@link Converters.IJsonConverterContext | IJsonConverterContext} OR
+ * a `ReadonlyArray<T>` as its conversion context. If the context is an array, it is used to override the
+ * allowed values for that conversion; otherwise, the original `values` supplied at creation time are used.
+ *
+ * @param values - Array of allowed values.
+ * @param message - Optional custom failure message.
+ * @returns A new {@link Converter | Converter} returning `<T>`.
+ * @public
+ */
+export declare function enumeratedValue<T>(values: ReadonlyArray<T>, message?: string): Converter<T, IJsonConverterContext | ReadonlyArray<T>>;
 //# sourceMappingURL=converters.d.ts.map

package/lib/packlets/converters/converters.js

@@ -21,7 +21,9 @@
  * SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonValue = exports.jsonArray = exports.jsonObject = exports.jsonPrimitive = void 0;
+exports.boolean = exports.number = exports.string = exports.jsonValue = exports.jsonArray = exports.jsonObject = exports.jsonPrimitive = void 0;
+exports.literal = literal;
+exports.enumeratedValue = enumeratedValue;
 const ts_utils_1 = require("@fgv/ts-utils");
 const json_1 = require("../json");
 /**
@@ -134,4 +136,57 @@ exports.jsonValue = new ts_utils_1.Conversion.BaseConverter((from, __self, ctx)
     }
     return exports.jsonPrimitive.convert(from, ctx);
 });
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `string`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * @public
+ */
+exports.string = new ts_utils_1.StringConverter();
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `number`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+exports.number = new ts_utils_1.Conversion.BaseConverter((from) => ts_utils_1.Converters.number.convert(from));
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `boolean`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+exports.boolean = new ts_utils_1.Conversion.BaseConverter((from) => ts_utils_1.Converters.boolean.convert(from));
+/**
+ * Helper to create a converter for a literal value.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+function literal(value) {
+    return ts_utils_1.Converters.literal(value);
+}
+/**
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of
+ * supplied enumerated values. Anything else fails.
+ *
+ * @remarks
+ * This JSON variant accepts an {@link Converters.IJsonConverterContext | IJsonConverterContext} OR
+ * a `ReadonlyArray<T>` as its conversion context. If the context is an array, it is used to override the
+ * allowed values for that conversion; otherwise, the original `values` supplied at creation time are used.
+ *
+ * @param values - Array of allowed values.
+ * @param message - Optional custom failure message.
+ * @returns A new {@link Converter | Converter} returning `<T>`.
+ * @public
+ */
+function enumeratedValue(values, message) {
+    return new ts_utils_1.Conversion.BaseConverter((from, __self, context) => {
+        const effectiveValues = Array.isArray(context) ? context : values;
+        const index = effectiveValues.indexOf(from);
+        if (index >= 0) {
+            return (0, ts_utils_1.succeed)(effectiveValues[index]);
+        }
+        return (0, ts_utils_1.fail)(message !== null && message !== void 0 ? message : `Invalid enumerated value ${JSON.stringify(from)}`);
+    });
+}
 //# sourceMappingURL=converters.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json-base",
-  "version": "5.0.1-7",
+  "version": "5.0.1-8",
   "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-7",
-    "@fgv/ts-utils-jest": "5.0.1-7"
+    "@fgv/ts-utils": "5.0.1-8",
+    "@fgv/ts-utils-jest": "5.0.1-8"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.1-7"
+    "@fgv/ts-utils": "5.0.1-8"
   },
   "dependencies": {
     "luxon": "^3.7.2"