decoders 2.4.0 → 2.4.2

package/dist/index.cjs

@@ -29,18 +29,12 @@ function makeObjectAnn(fields, text) {
 function makeArrayAnn(items, text) {
   return brand({ type: "array", items, text });
 }
-function makeFunctionAnn(text) {
-  return brand({ type: "function", text });
-}
-function makeUnknownAnn(value, text) {
-  return brand({ type: "unknown", value, text });
+function makeOpaqueAnn(value, text) {
+  return brand({ type: "opaque", value, text });
 }
 function makeScalarAnn(value, text) {
   return brand({ type: "scalar", value, text });
 }
-function makeCircularRefAnn(text) {
-  return brand({ type: "circular-ref", text });
-}
 function updateText(annotation, text) {
   if (text !== void 0) {
     return brand({ ...annotation, text });
@@ -81,22 +75,22 @@ function annotate(value, text, seen) {
   }
   if (Array.isArray(value)) {
     if (seen.has(value)) {
-      return makeCircularRefAnn(text);
+      return makeOpaqueAnn("<circular ref>", text);
     } else {
       return annotateArray(value, text, seen);
     }
   }
   if (isPojo(value)) {
     if (seen.has(value)) {
-      return makeCircularRefAnn(text);
+      return makeOpaqueAnn("<circular ref>", text);
     } else {
       return annotateObject(value, text, seen);
     }
   }
   if (typeof value === "function") {
-    return makeFunctionAnn(text);
+    return makeOpaqueAnn("<function>", text);
   }
-  return makeUnknownAnn(value, text);
+  return makeOpaqueAnn("???", text);
 }
 function public_annotate(value, text) {
   return annotate(value, text, /* @__PURE__ */ new WeakSet());
@@ -221,14 +215,12 @@ function serializeAnnotation(ann, prefix = "") {
     serialized = serializeArray(ann, prefix);
   } else if (ann.type === "object") {
     serialized = serializeObject(ann, prefix);
-  } else if (ann.type === "function") {
-    serialized = "<function>";
-  } else if (ann.type === "circular-ref") {
-    serialized = "<circular ref>";
-  } else if (ann.type === "unknown") {
-    serialized = "???";
-  } else {
+  } else if (ann.type === "scalar") {
     serialized = serializeValue(ann.value);
+  } else {
+    /* @__PURE__ */ ((_) => {
+    })(ann);
+    serialized = ann.value;
   }
   const text = ann.text;
   if (text !== void 0) {
@@ -317,8 +309,7 @@ function define(fn) {
   function then(next) {
     return define((blob, ok2, err2) => {
       const r1 = decode(blob);
-      if (!r1.ok)
-        return r1;
+      if (!r1.ok) return r1;
       const r2 = isDecoder(next) ? next : next(r1.value, ok2, err2);
       return isDecoder(r2) ? r2.decode(r1.value) : r2;
     });
@@ -525,8 +516,7 @@ function inexact(decoders) {
     const allkeys = new Set(Object.keys(plainObj));
     return object(decoders).transform((safepart) => {
       const safekeys = new Set(Object.keys(decoders));
-      for (const k of safekeys)
-        allkeys.add(k);
+      for (const k of safekeys) allkeys.add(k);
       const rv = {};
       for (const k of allkeys) {
         if (safekeys.has(k)) {

package/dist/index.d.cts

@@ -13,20 +13,12 @@ interface ScalarAnnotation {
     readonly value: unknown;
     readonly text?: string;
 }
-interface FunctionAnnotation {
-    readonly type: 'function';
+interface OpaqueAnnotation {
+    readonly type: 'opaque';
+    readonly value: string;
     readonly text?: string;
 }
-interface CircularRefAnnotation {
-    readonly type: 'circular-ref';
-    readonly text?: string;
-}
-interface UnknownAnnotation {
-    readonly type: 'unknown';
-    readonly value: unknown;
-    readonly text?: string;
-}
-type Annotation = ObjectAnnotation | ArrayAnnotation | ScalarAnnotation | FunctionAnnotation | CircularRefAnnotation | UnknownAnnotation;
+type Annotation = ObjectAnnotation | ArrayAnnotation | ScalarAnnotation | OpaqueAnnotation;
 
 /**
  * Result <value> <error>
@@ -588,7 +580,7 @@ declare function enum_<TEnum extends Record<string, string | number>>(enumObj: T
  * error messages and is more performant at runtime because it doesn't have to
  * try all decoders one by one.
  */
-declare function taggedUnion<O extends Record<string, Decoder<unknown>>, T = DecoderType<O[keyof O]>>(field: string, mapping: O): Decoder<T>;
+declare function taggedUnion<O extends Record<string, Decoder<unknown>>>(field: string, mapping: O): Decoder<DecoderType<O[keyof O]>>;
 /**
  * Briefly peek at a runtime input using a "scout" decoder first, then decide
  * which decoder to run on the (original) input, based on the information that

package/dist/index.d.ts

@@ -13,20 +13,12 @@ interface ScalarAnnotation {
     readonly value: unknown;
     readonly text?: string;
 }
-interface FunctionAnnotation {
-    readonly type: 'function';
+interface OpaqueAnnotation {
+    readonly type: 'opaque';
+    readonly value: string;
     readonly text?: string;
 }
-interface CircularRefAnnotation {
-    readonly type: 'circular-ref';
-    readonly text?: string;
-}
-interface UnknownAnnotation {
-    readonly type: 'unknown';
-    readonly value: unknown;
-    readonly text?: string;
-}
-type Annotation = ObjectAnnotation | ArrayAnnotation | ScalarAnnotation | FunctionAnnotation | CircularRefAnnotation | UnknownAnnotation;
+type Annotation = ObjectAnnotation | ArrayAnnotation | ScalarAnnotation | OpaqueAnnotation;
 
 /**
  * Result <value> <error>
@@ -588,7 +580,7 @@ declare function enum_<TEnum extends Record<string, string | number>>(enumObj: T
  * error messages and is more performant at runtime because it doesn't have to
  * try all decoders one by one.
  */
-declare function taggedUnion<O extends Record<string, Decoder<unknown>>, T = DecoderType<O[keyof O]>>(field: string, mapping: O): Decoder<T>;
+declare function taggedUnion<O extends Record<string, Decoder<unknown>>>(field: string, mapping: O): Decoder<DecoderType<O[keyof O]>>;
 /**
  * Briefly peek at a runtime input using a "scout" decoder first, then decide
  * which decoder to run on the (original) input, based on the information that

package/dist/index.js

@@ -29,18 +29,12 @@ function makeObjectAnn(fields, text) {
 function makeArrayAnn(items, text) {
   return brand({ type: "array", items, text });
 }
-function makeFunctionAnn(text) {
-  return brand({ type: "function", text });
-}
-function makeUnknownAnn(value, text) {
-  return brand({ type: "unknown", value, text });
+function makeOpaqueAnn(value, text) {
+  return brand({ type: "opaque", value, text });
 }
 function makeScalarAnn(value, text) {
   return brand({ type: "scalar", value, text });
 }
-function makeCircularRefAnn(text) {
-  return brand({ type: "circular-ref", text });
-}
 function updateText(annotation, text) {
   if (text !== void 0) {
     return brand({ ...annotation, text });
@@ -81,22 +75,22 @@ function annotate(value, text, seen) {
   }
   if (Array.isArray(value)) {
     if (seen.has(value)) {
-      return makeCircularRefAnn(text);
+      return makeOpaqueAnn("<circular ref>", text);
     } else {
       return annotateArray(value, text, seen);
     }
   }
   if (isPojo(value)) {
     if (seen.has(value)) {
-      return makeCircularRefAnn(text);
+      return makeOpaqueAnn("<circular ref>", text);
     } else {
       return annotateObject(value, text, seen);
     }
   }
   if (typeof value === "function") {
-    return makeFunctionAnn(text);
+    return makeOpaqueAnn("<function>", text);
   }
-  return makeUnknownAnn(value, text);
+  return makeOpaqueAnn("???", text);
 }
 function public_annotate(value, text) {
   return annotate(value, text, /* @__PURE__ */ new WeakSet());
@@ -221,14 +215,12 @@ function serializeAnnotation(ann, prefix = "") {
     serialized = serializeArray(ann, prefix);
   } else if (ann.type === "object") {
     serialized = serializeObject(ann, prefix);
-  } else if (ann.type === "function") {
-    serialized = "<function>";
-  } else if (ann.type === "circular-ref") {
-    serialized = "<circular ref>";
-  } else if (ann.type === "unknown") {
-    serialized = "???";
-  } else {
+  } else if (ann.type === "scalar") {
     serialized = serializeValue(ann.value);
+  } else {
+    /* @__PURE__ */ ((_) => {
+    })(ann);
+    serialized = ann.value;
   }
   const text = ann.text;
   if (text !== void 0) {
@@ -317,8 +309,7 @@ function define(fn) {
   function then(next) {
     return define((blob, ok2, err2) => {
       const r1 = decode(blob);
-      if (!r1.ok)
-        return r1;
+      if (!r1.ok) return r1;
       const r2 = isDecoder(next) ? next : next(r1.value, ok2, err2);
       return isDecoder(r2) ? r2.decode(r1.value) : r2;
     });
@@ -525,8 +516,7 @@ function inexact(decoders) {
     const allkeys = new Set(Object.keys(plainObj));
     return object(decoders).transform((safepart) => {
       const safekeys = new Set(Object.keys(decoders));
-      for (const k of safekeys)
-        allkeys.add(k);
+      for (const k of safekeys) allkeys.add(k);
       const rv = {};
       for (const k of allkeys) {
         if (safekeys.has(k)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "decoders",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "description": "Elegant and battle-tested validation library for type-safe input data for TypeScript",
   "license": "MIT",
   "repository": {
@@ -41,7 +41,7 @@
     "lint": "eslint --color --report-unused-disable-directives src/ test/ && prettier --list-different src/ test/ test-d/",
     "lint:docs": "cog -c --check docs/*.md || (npm run docs; git diff; echo 'Error: docs not up-to-date, please re-run \"npm docs\" to update them.' && exit 1)",
     "lint:package": "publint --strict && attw --pack",
-    "format": "eslint --color --report-unused-disable-directives --fix src/ test/ && prettier --write src/ test/ test-d/",
+    "format": "eslint --color --report-unused-disable-directives --fix src/ test/ ; prettier --write src/ test/ test-d/",
     "test": "vitest run --coverage",
     "test:completeness": "./bin/check.sh",
     "test:typescript": "tsc --noEmit",
@@ -61,25 +61,27 @@
     "verify"
   ],
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.13.5",
+    "@arethetypeswrong/cli": "^0.15.3",
     "@release-it/keep-a-changelog": "^5.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
-    "@vitest/coverage-istanbul": "^1.2.1",
-    "eslint": "^8.56.0",
+    "@types/eslint": "^8.56.10",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
+    "@vitest/coverage-istanbul": "^1.6.0",
+    "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
-    "fast-check": "^3.15.0",
-    "itertools": "^2.2.3",
-    "prettier": "^3.2.4",
-    "publint": "^0.2.7",
-    "release-it": "^17.0.1",
-    "ts-morph": "^21.0.1",
-    "tsd": "^0.30.4",
-    "tsup": "^8.0.1",
-    "typescript": "^5.3.3",
-    "vite-tsconfig-paths": "^4.3.1",
-    "vitest": "^1.2.1"
+    "eslint-plugin-simple-import-sort": "^12.1.0",
+    "fast-check": "^3.19.0",
+    "itertools": "^2.3.2",
+    "pkg-pr-new": "^0.0.9",
+    "prettier": "^3.3.2",
+    "publint": "^0.2.8",
+    "release-it": "^17.4.0",
+    "ts-morph": "^23.0.0",
+    "tsd": "^0.31.1",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.2",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.6.0"
   },
   "githubUrl": "https://github.com/nvie/decoders",
   "sideEffects": false