@fgv/ts-json-base 5.0.1-1 → 5.0.1-10

package/lib/packlets/validators/validators.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");
 /**
@@ -47,7 +49,7 @@ exports.jsonPrimitive = new ts_utils_1.Validation.Base.GenericValidator({
         if (from === undefined && (ctx === null || ctx === void 0 ? void 0 : ctx.ignoreUndefinedProperties) === true) {
             return true;
         }
-        return (0, ts_utils_1.fail)(`"${String(from)}": not a valid JSON primitive.`);
+        return (0, ts_utils_1.fail)(`"${String(from)}": invalid JSON primitive.`);
     }
 });
 /**
@@ -60,7 +62,7 @@ exports.jsonPrimitive = new ts_utils_1.Validation.Base.GenericValidator({
 exports.jsonObject = new ts_utils_1.Validation.Base.GenericValidator({
     validator: (from, ctx, self) => {
         if (!(0, json_1.isJsonObject)(from)) {
-            return (0, ts_utils_1.fail)('not a valid JSON object.');
+            return (0, ts_utils_1.fail)('invalid JSON object.');
         }
         const errors = [];
         for (const [name, value] of Object.entries(from)) {
@@ -70,7 +72,7 @@ exports.jsonObject = new ts_utils_1.Validation.Base.GenericValidator({
             });
         }
         if (errors.length > 0) {
-            return (0, ts_utils_1.fail)(`not a valid JSON object:\n${errors.join('\n')}`);
+            return (0, ts_utils_1.fail)(`invalid JSON object:\n${errors.join('\n')}`);
         }
         return true;
     }
@@ -122,4 +124,61 @@ exports.jsonValue = new ts_utils_1.Validation.Base.GenericValidator({
         return result.success === true ? true : result;
     }
 });
+/**
+ * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.
+ * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * @public
+ */
+exports.string = new ts_utils_1.Validation.Classes.StringValidator();
+/**
+ * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.
+ * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * @public
+ */
+exports.number = new ts_utils_1.Validation.Classes.NumberValidator();
+/**
+ * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.
+ * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * @public
+ */
+exports.boolean = new ts_utils_1.Validation.Classes.BooleanValidator();
+/**
+ * Helper to create a validator for a literal value.
+ * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+function literal(value) {
+    return new ts_utils_1.Validation.Base.GenericValidator({
+        validator: (from) => {
+            return from === value ? true : (0, ts_utils_1.fail)(`Expected literal ${String(value)}, found ${JSON.stringify(from)}`);
+        }
+    });
+}
+/**
+ * Helper function to create a {@link Validator | Validator} which validates `unknown` to one of a set of
+ * supplied enumerated values. Anything else fails.
+ *
+ * @remarks
+ * This JSON variant accepts an {@link Validators.IJsonValidatorContext | IJsonValidatorContext} OR
+ * a `ReadonlyArray<T>` as its validation context. If the context is an array, it is used to override the
+ * allowed values for that validation; 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 Validator | Validator} returning `<T>`.
+ * @public
+ */
+function enumeratedValue(values, message) {
+    return new ts_utils_1.Validation.Base.GenericValidator({
+        validator: (from, context) => {
+            const effectiveValues = Array.isArray(context) ? context : values;
+            const index = effectiveValues.indexOf(from);
+            if (index >= 0) {
+                return true;
+            }
+            return (0, ts_utils_1.fail)(message !== null && message !== void 0 ? message : `Invalid enumerated value ${JSON.stringify(from)}`);
+        }
+    });
+}
 //# sourceMappingURL=validators.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json-base",
-  "version": "5.0.1-1",
+  "version": "5.0.1-10",
   "description": "Typescript types and basic functions for working with json",
   "main": "lib/index.js",
   "types": "dist/ts-json-base.d.ts",
@@ -31,33 +31,35 @@
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "@types/node": "^20.14.9",
-    "@typescript-eslint/eslint-plugin": "^8.42.0",
-    "@typescript-eslint/parser": "^8.42.0",
-    "eslint": "^9.35.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.2",
+    "@typescript-eslint/parser": "^8.46.2",
+    "eslint": "^9.39.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^7.2.1",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.4.1",
+    "rimraf": "^6.1.0",
+    "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",
-    "typescript": "5.8.3",
-    "eslint-plugin-n": "^17.21.3",
-    "@rushstack/heft-node-rig": "2.9.5",
-    "@rushstack/heft": "0.74.4",
-    "@rushstack/heft-jest-plugin": "0.16.13",
+    "typescript": "5.9.3",
+    "eslint-plugin-n": "^17.23.1",
+    "@rushstack/heft": "1.1.3",
+    "@rushstack/heft-jest-plugin": "1.1.3",
     "@types/heft-jest": "1.0.6",
-    "@microsoft/api-documenter": "^7.26.31",
-    "@rushstack/eslint-patch": "~1.12.0",
-    "@rushstack/eslint-config": "4.4.0",
+    "@microsoft/api-documenter": "^7.27.3",
+    "@rushstack/eslint-patch": "1.14.1",
+    "@rushstack/eslint-config": "4.5.3",
     "eslint-plugin-tsdoc": "~0.4.0",
     "@types/luxon": "^3.7.1",
-    "@fgv/ts-utils": "5.0.1-1",
-    "@fgv/ts-utils-jest": "5.0.1-1"
+    "@rushstack/heft-node-rig": "2.11.4",
+    "@microsoft/api-extractor": "^7.53.3",
+    "@fgv/ts-utils": "5.0.1-10",
+    "@fgv/ts-utils-jest": "5.0.1-10",
+    "@fgv/heft-dual-rig": "0.1.0"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.1-1"
+    "@fgv/ts-utils": "5.0.1-10"
   },
   "dependencies": {
     "luxon": "^3.7.2"