decoders 2.6.0 → 2.7.0

package/README.md

@@ -1,7 +1,7 @@
 <img alt="Decoders logo" src="./docs/assets/logo@2x.png" style="width: 100%; max-width: 830px; max-height: 248px" width="830" /><br />
 
 [![npm](https://img.shields.io/npm/v/decoders.svg)](https://www.npmjs.com/package/decoders)
-[![Build Status](https://github.com/nvie/decoders/workflows/test/badge.svg)](https://github.com/nvie/decoders/actions)
+[![Test Status](https://github.com/nvie/decoders/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/nvie/decoders/actions)
 [![Bundle size for decoders](https://pkg-size.dev/badge/bundle/4200)](https://pkg-size.dev/decoders)
 
 Elegant and battle-tested validation library for type-safe input data for

package/dist/index.cjs

@@ -18,7 +18,8 @@ function isPojo(value) {
 }
 
 // src/core/annotate.ts
-var _register = /* @__PURE__ */ new WeakSet();
+var kAnnotationRegistry = Symbol.for("decoders.kAnnotationRegistry");
+var _register = globalThis[kAnnotationRegistry] ??= /* @__PURE__ */ new WeakSet();
 function brand(ann) {
   _register.add(ann);
   return ann;
@@ -102,7 +103,7 @@ function public_annotateObject(obj, text) {
 // src/lib/text.ts
 var INDENT = "  ";
 function isMultiline(s) {
-  return s.indexOf("\n") >= 0;
+  return s.includes("\n");
 }
 function indent(s, prefix = INDENT) {
   if (isMultiline(s)) {
@@ -166,7 +167,7 @@ function serializeArray(annotation, prefix) {
   const result = [];
   for (const item of items) {
     const [ser, ann] = serializeAnnotation(item, `${prefix}${INDENT}`);
-    result.push(`${prefix}${INDENT}${ser}${","}`);
+    result.push(`${prefix}${INDENT}${ser},`);
     if (ann !== void 0) {
       result.push(indent(ann, `${prefix}${INDENT}`));
     }
@@ -310,11 +311,8 @@ ${formatted}`);
 }
 function define(fn) {
   function decode(blob) {
-    return fn(
-      blob,
-      ok,
-      (msg) => err(isAnnotation(msg) ? msg : public_annotate(blob, msg))
-    );
+    const makeFlexErr = (msg) => err(isAnnotation(msg) ? msg : public_annotate(blob, msg));
+    return fn(blob, ok, makeFlexErr);
   }
   function verify(blob, formatter = formatInline) {
     const result = decode(blob);
@@ -341,6 +339,9 @@ function define(fn) {
       )
     );
   }
+  function refineType() {
+    return self;
+  }
   function then(next) {
     return define((blob, ok2, err2) => {
       const r1 = decode(blob);
@@ -368,12 +369,13 @@ function define(fn) {
       }
     });
   }
-  return brand2({
+  const unregistered = {
     verify,
     value,
     decode,
     transform,
     refine,
+    refineType,
     reject,
     describe,
     then,
@@ -391,9 +393,12 @@ function define(fn) {
         }
       }
     }
-  });
+  };
+  const self = brand2(unregistered);
+  return self;
 }
-var _register2 = /* @__PURE__ */ new WeakSet();
+var kDecoderRegistry = Symbol.for("decoders.kDecoderRegistry");
+var _register2 = globalThis[kDecoderRegistry] ??= /* @__PURE__ */ new WeakSet();
 function brand2(decoder) {
   _register2.add(decoder);
   return decoder;
@@ -409,30 +414,28 @@ var poja = define((blob, ok2, err2) => {
   }
   return ok2(blob);
 });
-function all(items, blobs, ok2, err2) {
-  const results = [];
-  for (let index = 0; index < items.length; ++index) {
-    const result = items[index];
-    if (result.ok) {
-      results.push(result.value);
-    } else {
-      const ann = result.error;
-      const clone = blobs.slice();
-      clone.splice(
-        index,
-        1,
-        public_annotate(ann, ann.text ? `${ann.text} (at index ${index})` : `index ${index}`)
-      );
-      return err2(public_annotate(clone));
-    }
-  }
-  return ok2(results);
-}
 function array(decoder) {
   const decodeFn = decoder.decode;
-  return poja.then((blobs, ok2, err2) => {
-    const results = blobs.map(decodeFn);
-    return all(results, blobs, ok2, err2);
+  return poja.then((inputs, ok2, err2) => {
+    const results = [];
+    for (let i = 0; i < inputs.length; ++i) {
+      const blob = inputs[i];
+      const result = decodeFn(blob);
+      if (result.ok) {
+        results.push(result.value);
+      } else {
+        results.length = 0;
+        const ann = result.error;
+        const clone = inputs.slice();
+        clone.splice(
+          i,
+          1,
+          public_annotate(ann, ann.text ? `${ann.text} (at index ${i})` : `index ${i}`)
+        );
+        return err2(public_annotate(clone));
+      }
+    }
+    return ok2(results);
   });
 }
 function isNonEmpty(arr) {
@@ -466,7 +469,10 @@ function tuple(...decoders) {
 // src/misc.ts
 function instanceOf(klass) {
   return define(
-    (blob, ok2, err2) => blob instanceof klass ? ok2(blob) : err2(`Must be ${klass.name} instance`)
+    (blob, ok2, err2) => (
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      blob instanceof klass ? ok2(blob) : err2(`Must be ${klass.name} instance`)
+    )
   );
 }
 function lazy(decoderFn) {
@@ -528,9 +534,7 @@ function object(decoders) {
         if (rawValue === void 0) {
           missingKeys.add(key);
         } else {
-          if (errors === null) {
-            errors = /* @__PURE__ */ new Map();
-          }
+          errors ??= /* @__PURE__ */ new Map();
           errors.set(key, ann);
         }
       }
@@ -595,8 +599,8 @@ function either(...decoders) {
   }
   return define((blob, _, err2) => {
     const errors = [];
-    for (let i = 0; i < decoders.length; i++) {
-      const result = decoders[i].decode(blob);
+    for (const decoder of decoders) {
+      const result = decoder.decode(blob);
       if (result.ok) {
         return result;
       } else {
@@ -697,7 +701,7 @@ var truthy = define((blob, ok2, _) => ok2(!!blob));
 // src/collections.ts
 function record(fst, snd) {
   const keyDecoder = snd !== void 0 ? fst : void 0;
-  const valueDecoder = snd !== void 0 ? snd : fst;
+  const valueDecoder = _nullishCoalesce(snd, () => ( fst));
   return pojo.then((input, ok2, err2) => {
     let rv = {};
     const errors = /* @__PURE__ */ new Map();
@@ -738,9 +742,9 @@ function mapping(decoder) {
 
 // src/lib/size-options.ts
 function bySizeOptions(options) {
-  const size = _optionalChain([options, 'optionalAccess', _6 => _6.size]);
-  const min = _nullishCoalesce(size, () => ( _optionalChain([options, 'optionalAccess', _7 => _7.min])));
-  const max = _nullishCoalesce(size, () => ( _optionalChain([options, 'optionalAccess', _8 => _8.max])));
+  const size = options.size;
+  const min = _nullishCoalesce(size, () => ( options.min));
+  const max = _nullishCoalesce(size, () => ( options.max));
   const atLeast = min === max ? "" : "at least ";
   const atMost = min === max ? "" : "at most ";
   const tooShort = min !== void 0 && `Too short, must be ${atLeast}${min} chars`;
@@ -815,19 +819,14 @@ var iso8601_re = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:
 var date = define((blob, ok2, err2) => {
   return isDate(blob) ? ok2(blob) : err2("Must be a Date");
 });
-var iso8601 = (
-  // Input itself needs to match the ISO8601 regex...
-  regex(iso8601_re, "Must be ISO8601 format").transform(
-    // Make sure it is a _valid_ date
-    (value) => {
-      const date2 = new Date(value);
-      if (isNaN(date2.getTime())) {
-        throw new Error("Must be valid date/time value");
-      }
-      return date2;
-    }
-  )
+var dateString = regex(
+  iso8601_re,
+  "Must be ISO8601 format"
+).refine(
+  (value) => !isNaN(new Date(value).getTime()),
+  "Must be valid date/time value"
 );
+var iso8601 = dateString.transform((value) => new Date(value));
 var datelike = either(date, iso8601).describe("Must be a Date or date string");
 
 // src/numbers.ts

package/dist/index.d.cts

@@ -130,6 +130,11 @@ interface Decoder<T> {
      */
     refine<N extends T>(predicate: (value: T) => value is N, msg: string): Decoder<N>;
     refine(predicate: (value: T) => boolean, msg: string): Decoder<T>;
+    /**
+     * Cast the return type of this read-only decoder to a narrower type. This is
+     * useful to return "branded" types. This method has no runtime effect.
+     */
+    refineType<SubT extends T>(): Decoder<SubT>;
     /**
      * Build a new decoder from the current one, with an extra rejection
      * criterium.
@@ -168,8 +173,7 @@ interface Decoder<T> {
      *
      *   string.pipe((s) => s.startsWith('@') ? username : email)
      */
-    pipe<V, D extends Decoder<V>>(next: D): Decoder<DecoderType<D>>;
-    pipe<V, D extends Decoder<V>>(next: (blob: T) => D): Decoder<DecoderType<D>>;
+    pipe<V, D extends Decoder<V>>(next: D | ((blob: T) => D)): Decoder<DecoderType<D>>;
     /**
      * The Standard Schema interface for this decoder.
      */

package/dist/index.d.ts

@@ -130,6 +130,11 @@ interface Decoder<T> {
      */
     refine<N extends T>(predicate: (value: T) => value is N, msg: string): Decoder<N>;
     refine(predicate: (value: T) => boolean, msg: string): Decoder<T>;
+    /**
+     * Cast the return type of this read-only decoder to a narrower type. This is
+     * useful to return "branded" types. This method has no runtime effect.
+     */
+    refineType<SubT extends T>(): Decoder<SubT>;
     /**
      * Build a new decoder from the current one, with an extra rejection
      * criterium.
@@ -168,8 +173,7 @@ interface Decoder<T> {
      *
      *   string.pipe((s) => s.startsWith('@') ? username : email)
      */
-    pipe<V, D extends Decoder<V>>(next: D): Decoder<DecoderType<D>>;
-    pipe<V, D extends Decoder<V>>(next: (blob: T) => D): Decoder<DecoderType<D>>;
+    pipe<V, D extends Decoder<V>>(next: D | ((blob: T) => D)): Decoder<DecoderType<D>>;
     /**
      * The Standard Schema interface for this decoder.
      */

package/dist/index.js

@@ -18,7 +18,8 @@ function isPojo(value) {
 }
 
 // src/core/annotate.ts
-var _register = /* @__PURE__ */ new WeakSet();
+var kAnnotationRegistry = Symbol.for("decoders.kAnnotationRegistry");
+var _register = globalThis[kAnnotationRegistry] ??= /* @__PURE__ */ new WeakSet();
 function brand(ann) {
   _register.add(ann);
   return ann;
@@ -102,7 +103,7 @@ function public_annotateObject(obj, text) {
 // src/lib/text.ts
 var INDENT = "  ";
 function isMultiline(s) {
-  return s.indexOf("\n") >= 0;
+  return s.includes("\n");
 }
 function indent(s, prefix = INDENT) {
   if (isMultiline(s)) {
@@ -166,7 +167,7 @@ function serializeArray(annotation, prefix) {
   const result = [];
   for (const item of items) {
     const [ser, ann] = serializeAnnotation(item, `${prefix}${INDENT}`);
-    result.push(`${prefix}${INDENT}${ser}${","}`);
+    result.push(`${prefix}${INDENT}${ser},`);
     if (ann !== void 0) {
       result.push(indent(ann, `${prefix}${INDENT}`));
     }
@@ -310,11 +311,8 @@ ${formatted}`);
 }
 function define(fn) {
   function decode(blob) {
-    return fn(
-      blob,
-      ok,
-      (msg) => err(isAnnotation(msg) ? msg : public_annotate(blob, msg))
-    );
+    const makeFlexErr = (msg) => err(isAnnotation(msg) ? msg : public_annotate(blob, msg));
+    return fn(blob, ok, makeFlexErr);
   }
   function verify(blob, formatter = formatInline) {
     const result = decode(blob);
@@ -341,6 +339,9 @@ function define(fn) {
       )
     );
   }
+  function refineType() {
+    return self;
+  }
   function then(next) {
     return define((blob, ok2, err2) => {
       const r1 = decode(blob);
@@ -368,12 +369,13 @@ function define(fn) {
       }
     });
   }
-  return brand2({
+  const unregistered = {
     verify,
     value,
     decode,
     transform,
     refine,
+    refineType,
     reject,
     describe,
     then,
@@ -391,9 +393,12 @@ function define(fn) {
         }
       }
     }
-  });
+  };
+  const self = brand2(unregistered);
+  return self;
 }
-var _register2 = /* @__PURE__ */ new WeakSet();
+var kDecoderRegistry = Symbol.for("decoders.kDecoderRegistry");
+var _register2 = globalThis[kDecoderRegistry] ??= /* @__PURE__ */ new WeakSet();
 function brand2(decoder) {
   _register2.add(decoder);
   return decoder;
@@ -409,30 +414,28 @@ var poja = define((blob, ok2, err2) => {
   }
   return ok2(blob);
 });
-function all(items, blobs, ok2, err2) {
-  const results = [];
-  for (let index = 0; index < items.length; ++index) {
-    const result = items[index];
-    if (result.ok) {
-      results.push(result.value);
-    } else {
-      const ann = result.error;
-      const clone = blobs.slice();
-      clone.splice(
-        index,
-        1,
-        public_annotate(ann, ann.text ? `${ann.text} (at index ${index})` : `index ${index}`)
-      );
-      return err2(public_annotate(clone));
-    }
-  }
-  return ok2(results);
-}
 function array(decoder) {
   const decodeFn = decoder.decode;
-  return poja.then((blobs, ok2, err2) => {
-    const results = blobs.map(decodeFn);
-    return all(results, blobs, ok2, err2);
+  return poja.then((inputs, ok2, err2) => {
+    const results = [];
+    for (let i = 0; i < inputs.length; ++i) {
+      const blob = inputs[i];
+      const result = decodeFn(blob);
+      if (result.ok) {
+        results.push(result.value);
+      } else {
+        results.length = 0;
+        const ann = result.error;
+        const clone = inputs.slice();
+        clone.splice(
+          i,
+          1,
+          public_annotate(ann, ann.text ? `${ann.text} (at index ${i})` : `index ${i}`)
+        );
+        return err2(public_annotate(clone));
+      }
+    }
+    return ok2(results);
   });
 }
 function isNonEmpty(arr) {
@@ -466,7 +469,10 @@ function tuple(...decoders) {
 // src/misc.ts
 function instanceOf(klass) {
   return define(
-    (blob, ok2, err2) => blob instanceof klass ? ok2(blob) : err2(`Must be ${klass.name} instance`)
+    (blob, ok2, err2) => (
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      blob instanceof klass ? ok2(blob) : err2(`Must be ${klass.name} instance`)
+    )
   );
 }
 function lazy(decoderFn) {
@@ -528,9 +534,7 @@ function object(decoders) {
         if (rawValue === void 0) {
           missingKeys.add(key);
         } else {
-          if (errors === null) {
-            errors = /* @__PURE__ */ new Map();
-          }
+          errors ??= /* @__PURE__ */ new Map();
           errors.set(key, ann);
         }
       }
@@ -595,8 +599,8 @@ function either(...decoders) {
   }
   return define((blob, _, err2) => {
     const errors = [];
-    for (let i = 0; i < decoders.length; i++) {
-      const result = decoders[i].decode(blob);
+    for (const decoder of decoders) {
+      const result = decoder.decode(blob);
       if (result.ok) {
         return result;
       } else {
@@ -697,7 +701,7 @@ var truthy = define((blob, ok2, _) => ok2(!!blob));
 // src/collections.ts
 function record(fst, snd) {
   const keyDecoder = snd !== void 0 ? fst : void 0;
-  const valueDecoder = snd !== void 0 ? snd : fst;
+  const valueDecoder = snd ?? fst;
   return pojo.then((input, ok2, err2) => {
     let rv = {};
     const errors = /* @__PURE__ */ new Map();
@@ -738,9 +742,9 @@ function mapping(decoder) {
 
 // src/lib/size-options.ts
 function bySizeOptions(options) {
-  const size = options?.size;
-  const min = size ?? options?.min;
-  const max = size ?? options?.max;
+  const size = options.size;
+  const min = size ?? options.min;
+  const max = size ?? options.max;
   const atLeast = min === max ? "" : "at least ";
   const atMost = min === max ? "" : "at most ";
   const tooShort = min !== void 0 && `Too short, must be ${atLeast}${min} chars`;
@@ -815,19 +819,14 @@ var iso8601_re = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:
 var date = define((blob, ok2, err2) => {
   return isDate(blob) ? ok2(blob) : err2("Must be a Date");
 });
-var iso8601 = (
-  // Input itself needs to match the ISO8601 regex...
-  regex(iso8601_re, "Must be ISO8601 format").transform(
-    // Make sure it is a _valid_ date
-    (value) => {
-      const date2 = new Date(value);
-      if (isNaN(date2.getTime())) {
-        throw new Error("Must be valid date/time value");
-      }
-      return date2;
-    }
-  )
+var dateString = regex(
+  iso8601_re,
+  "Must be ISO8601 format"
+).refine(
+  (value) => !isNaN(new Date(value).getTime()),
+  "Must be valid date/time value"
 );
+var iso8601 = dateString.transform((value) => new Date(value));
 var datelike = either(date, iso8601).describe("Must be a Date or date string");
 
 // src/numbers.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "decoders",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Elegant and battle-tested validation library for type-safe input data for TypeScript",
   "license": "MIT",
   "repository": {
@@ -14,7 +14,6 @@
   },
   "type": "module",
   "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
   "types": "./dist/index.d.cts",
   "exports": {
     ".": {
@@ -61,28 +60,27 @@
     "verify"
   ],
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.3",
+    "@arethetypeswrong/cli": "^0.17.4",
+    "@eslint/js": "^9.23.0",
     "@release-it/keep-a-changelog": "^6.0.0",
     "@standard-schema/spec": "^1.0.0",
-    "@types/eslint": "^8.56.10",
-    "@typescript-eslint/eslint-plugin": "^7.14.1",
-    "@typescript-eslint/parser": "^7.14.1",
-    "@vitest/coverage-istanbul": "^3.0.5",
-    "eslint": "^8.57.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-simple-import-sort": "^12.1.0",
-    "fast-check": "^3.23.2",
-    "itertools": "^2.3.2",
-    "pkg-pr-new": "^0.0.39",
-    "prettier": "^3.4.2",
-    "publint": "^0.3.2",
+    "@vitest/coverage-istanbul": "^3.0.9",
+    "eslint": "^9.23.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "fast-check": "^4.0.0",
+    "itertools": "^2.4.1",
+    "pkg-pr-new": "^0.0.41",
+    "prettier": "^3.5.3",
+    "publint": "^0.3.9",
     "release-it": "^18.1.2",
-    "ts-morph": "^25.0.0",
+    "ts-morph": "^25.0.1",
     "tsd": "^0.31.2",
-    "tsup": "^8.3.6",
-    "typescript": "^5.7.3",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.0.5"
+    "vitest": "^3.0.9"
   },
   "githubUrl": "https://github.com/nvie/decoders",
   "sideEffects": false