decoders 2.3.0-beta.1 → 2.3.0-beta.3

package/dist/index.cjs

@@ -1,4 +1,13 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/lib/utils.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/lib/utils.ts
+function isNumber(value) {
+  return typeof value === "number";
+}
+function isString(value) {
+  return typeof value === "string";
+}
+function isBigInt(value) {
+  return typeof value === "bigint";
+}
 function isDate(value) {
   return !!value && Object.prototype.toString.call(value) === "[object Date]" && !isNaN(value);
 }
@@ -380,9 +389,6 @@ function isNonEmpty(arr) {
 function nonEmptyArray(decoder) {
   return array(decoder).refine(isNonEmpty, "Must be non-empty array");
 }
-function set(decoder) {
-  return array(decoder).transform((items) => new Set(items));
-}
 var ntuple = (n) => poja.refine((arr) => arr.length === n, `Must be a ${n}-tuple`);
 function tuple(...decoders) {
   return ntuple(decoders.length).then((blobs, ok2, err2) => {
@@ -453,7 +459,7 @@ function object(decoders) {
   return pojo.then((plainObj, ok2, err2) => {
     const actualKeys = new Set(Object.keys(plainObj));
     const missingKeys = difference(knownKeys, actualKeys);
-    const record = {};
+    const record2 = {};
     let errors = null;
     for (const key of Object.keys(decoders)) {
       const decoder = decoders[key];
@@ -462,7 +468,7 @@ function object(decoders) {
       if (result.ok) {
         const value = result.value;
         if (value !== void 0) {
-          record[key] = value;
+          record2[key] = value;
         }
         missingKeys.delete(key);
       } else {
@@ -489,7 +495,7 @@ function object(decoders) {
       }
       return err2(objAnn);
     }
-    return ok2(record);
+    return ok2(record2);
   });
 }
 function exact(decoders) {
@@ -527,41 +533,6 @@ function inexact(decoders) {
     return decoder.decode(plainObj);
   });
 }
-function dict(decoder) {
-  return pojo.then((plainObj, ok2, err2) => {
-    let rv = {};
-    let errors = null;
-    for (const key of Object.keys(plainObj)) {
-      const value = plainObj[key];
-      const result = decoder.decode(value);
-      if (result.ok) {
-        if (errors === null) {
-          rv[key] = result.value;
-        }
-      } else {
-        rv = {};
-        if (errors === null) {
-          errors = /* @__PURE__ */ new Map();
-        }
-        errors.set(key, result.error);
-      }
-    }
-    if (errors !== null) {
-      return err2(merge(public_annotateObject(plainObj), errors));
-    } else {
-      return ok2(rv);
-    }
-  });
-}
-function mapping(decoder) {
-  return dict(decoder).transform(
-    (obj) => new Map(
-      // This is effectively Object.entries(obj), but in a way that Flow
-      // will know the types are okay
-      Object.keys(obj).map((key) => [key, obj[key]])
-    )
-  );
-}
 
 // src/unions.ts
 var EITHER_PREFIX = "Either:\n";
@@ -600,6 +571,17 @@ function oneOf(constants) {
     );
   });
 }
+function enum_(enumObj) {
+  const values = Object.values(enumObj);
+  if (!values.some(isNumber)) {
+    return oneOf(values);
+  } else {
+    const nums = values.filter(isNumber);
+    const ignore = new Set(nums.map((val) => enumObj[val]));
+    const strings = values.filter(isString).filter((val) => !ignore.has(val));
+    return oneOf([...nums, ...strings]);
+  }
+}
 function taggedUnion(field, mapping2) {
   const scout = object({
     [field]: prep(String, oneOf(Object.keys(mapping2)))
@@ -625,9 +607,9 @@ function lazyval(value) {
 var null_ = constant(null);
 var undefined_ = constant(void 0);
 var nullish_ = define(
-  (blob, ok2, err2) => blob == null ? ok2(blob) : (
-    // Combine error message into a single line for readability
-    err2("Must be undefined or null")
+  (blob, ok2, err2) => (
+    // Equiv to either(undefined_, null_), but combined for better error message
+    blob == null ? ok2(blob) : err2("Must be undefined or null")
   )
 );
 function optional(decoder, defaultValue) {
@@ -665,7 +647,7 @@ var mixed = unknown;
 
 // src/numbers.ts
 var anyNumber = define(
-  (blob, ok2, err2) => typeof blob === "number" ? ok2(blob) : err2("Must be number")
+  (blob, ok2, err2) => isNumber(blob) ? ok2(blob) : err2("Must be number")
 );
 var number = anyNumber.refine(
   (n) => Number.isFinite(n),
@@ -675,10 +657,16 @@ var integer = number.refine(
   (n) => Number.isInteger(n),
   "Number must be an integer"
 );
-var positiveNumber = number.refine((n) => n >= 0, "Number must be positive").transform(Math.abs);
-var positiveInteger = integer.refine((n) => n >= 0, "Number must be positive").transform(Math.abs);
+var positiveNumber = number.refine(
+  (n) => n >= 0 && !Object.is(n, -0),
+  "Number must be positive"
+);
+var positiveInteger = integer.refine(
+  (n) => n >= 0 && !Object.is(n, -0),
+  "Number must be positive"
+);
 var bigint = define(
-  (blob, ok2, err2) => typeof blob === "bigint" ? ok2(blob) : err2("Must be bigint")
+  (blob, ok2, err2) => isBigInt(blob) ? ok2(blob) : err2("Must be bigint")
 );
 
 // src/booleans.ts
@@ -688,10 +676,53 @@ var boolean = define((blob, ok2, err2) => {
 var truthy = define((blob, ok2, _) => ok2(!!blob));
 var numericBoolean = number.transform((n) => !!n);
 
+// src/collections.ts
+function record(fst, snd) {
+  const keyDecoder = snd !== void 0 ? fst : void 0;
+  const valueDecoder = snd !== void 0 ? snd : fst;
+  return pojo.then((input, ok2, err2) => {
+    let rv = {};
+    const errors = /* @__PURE__ */ new Map();
+    for (const [key, value] of Object.entries(input)) {
+      const keyResult = _optionalChain([keyDecoder, 'optionalAccess', _2 => _2.decode, 'call', _3 => _3(key)]);
+      if (_optionalChain([keyResult, 'optionalAccess', _4 => _4.ok]) === false) {
+        return err2(
+          public_annotate(
+            input,
+            `Invalid key ${JSON.stringify(key)}: ${formatShort(keyResult.error)}`
+          )
+        );
+      }
+      const k = _nullishCoalesce(_optionalChain([keyResult, 'optionalAccess', _5 => _5.value]), () => ( key));
+      const result = valueDecoder.decode(value);
+      if (result.ok) {
+        if (errors.size === 0) {
+          rv[k] = result.value;
+        }
+      } else {
+        errors.set(key, result.error);
+        rv = {};
+      }
+    }
+    if (errors.size > 0) {
+      return err2(merge(public_annotateObject(input), errors));
+    } else {
+      return ok2(rv);
+    }
+  });
+}
+var dict = record;
+function set(decoder) {
+  return array(decoder).transform((items) => new Set(items));
+}
+function mapping(decoder) {
+  return record(decoder).transform((obj) => new Map(Object.entries(obj)));
+}
+
 // src/strings.ts
 var url_re = /^([A-Za-z]{3,9}(?:[+][A-Za-z]{3,9})?):\/\/(?:([-;:&=+$,\w]+)@)?(?:([A-Za-z0-9.-]+)(?::([0-9]{2,5}))?)(\/(?:[-+~%/.,\w]*)?(?:\?[-+=&;%@.,/\w]*)?(?:#[.,!/\w]*)?)?$/;
 var string = define(
-  (blob, ok2, err2) => typeof blob === "string" ? ok2(blob) : err2("Must be string")
+  (blob, ok2, err2) => isString(blob) ? ok2(blob) : err2("Must be string")
 );
 var nonEmptyString = regex(/\S/, "Must be non-empty string");
 function regex(regex2, msg) {
@@ -722,6 +753,12 @@ var uuidv4 = (
   // https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)
   uuid.refine((value) => value[14] === "4", "Must be uuidv4")
 );
+var decimal = regex(/^[0-9]+$/, "Must only contain digits");
+var hexadecimal = regex(
+  /^[0-9a-f]+$/i,
+  "Must only contain hexadecimal digits"
+);
+var numeric = decimal.transform(Number);
 
 // src/dates.ts
 var iso8601_re = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:?\d{2})$/;
@@ -741,9 +778,10 @@ var iso8601 = (
     }
   )
 );
+var datelike = either(date, iso8601).describe("Must be a Date or date string");
 
 // src/json.ts
-var jsonObject = lazy(() => dict(json));
+var jsonObject = lazy(() => record(json));
 var jsonArray = lazy(() => array(json));
 var json = either(
   null_,
@@ -813,4 +851,10 @@ var json = either(
 
 
 
-exports.always = always; exports.anyNumber = anyNumber; exports.array = array; exports.bigint = bigint; exports.boolean = boolean; exports.constant = constant; exports.date = date; exports.define = define; exports.dict = dict; exports.either = either; exports.email = email; exports.err = err; exports.exact = exact; exports.fail = fail; exports.formatInline = formatInline; exports.formatShort = formatShort; exports.hardcoded = hardcoded; exports.httpsUrl = httpsUrl; exports.inexact = inexact; exports.instanceOf = instanceOf; exports.integer = integer; exports.iso8601 = iso8601; exports.json = json; exports.jsonArray = jsonArray; exports.jsonObject = jsonObject; exports.lazy = lazy; exports.mapping = mapping; exports.maybe = maybe; exports.mixed = mixed; exports.never = never; exports.nonEmptyArray = nonEmptyArray; exports.nonEmptyString = nonEmptyString; exports.null_ = null_; exports.nullable = nullable; exports.nullish = nullish; exports.number = number; exports.numericBoolean = numericBoolean; exports.object = object; exports.ok = ok; exports.oneOf = oneOf; exports.optional = optional; exports.poja = poja; exports.pojo = pojo; exports.positiveInteger = positiveInteger; exports.positiveNumber = positiveNumber; exports.prep = prep; exports.regex = regex; exports.select = select; exports.set = set; exports.string = string; exports.taggedUnion = taggedUnion; exports.truthy = truthy; exports.tuple = tuple; exports.undefined_ = undefined_; exports.unknown = unknown; exports.url = url; exports.uuid = uuid; exports.uuidv1 = uuidv1; exports.uuidv4 = uuidv4;
+
+
+
+
+
+
+exports.always = always; exports.anyNumber = anyNumber; exports.array = array; exports.bigint = bigint; exports.boolean = boolean; exports.constant = constant; exports.date = date; exports.datelike = datelike; exports.decimal = decimal; exports.define = define; exports.dict = dict; exports.either = either; exports.email = email; exports.enum_ = enum_; exports.err = err; exports.exact = exact; exports.fail = fail; exports.formatInline = formatInline; exports.formatShort = formatShort; exports.hardcoded = hardcoded; exports.hexadecimal = hexadecimal; exports.httpsUrl = httpsUrl; exports.inexact = inexact; exports.instanceOf = instanceOf; exports.integer = integer; exports.iso8601 = iso8601; exports.json = json; exports.jsonArray = jsonArray; exports.jsonObject = jsonObject; exports.lazy = lazy; exports.mapping = mapping; exports.maybe = maybe; exports.mixed = mixed; exports.never = never; exports.nonEmptyArray = nonEmptyArray; exports.nonEmptyString = nonEmptyString; exports.null_ = null_; exports.nullable = nullable; exports.nullish = nullish; exports.number = number; exports.numeric = numeric; exports.numericBoolean = numericBoolean; exports.object = object; exports.ok = ok; exports.oneOf = oneOf; exports.optional = optional; exports.poja = poja; exports.pojo = pojo; exports.positiveInteger = positiveInteger; exports.positiveNumber = positiveNumber; exports.prep = prep; exports.record = record; exports.regex = regex; exports.select = select; exports.set = set; exports.string = string; exports.taggedUnion = taggedUnion; exports.truthy = truthy; exports.tuple = tuple; exports.undefined_ = undefined_; exports.unknown = unknown; exports.url = url; exports.uuid = uuid; exports.uuidv1 = uuidv1; exports.uuidv4 = uuidv4;

package/dist/index.d.cts

@@ -162,11 +162,6 @@ declare function array<T>(decoder: Decoder<T>): Decoder<T[]>;
  * Like `array()`, but will reject arrays with 0 elements.
  */
 declare function nonEmptyArray<T>(decoder: Decoder<T>): Decoder<[T, ...T[]]>;
-/**
- * Similar to `array()`, but returns the result as an [ES6
- * Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
- */
-declare function set<T>(decoder: Decoder<T>): Decoder<Set<T>>;
 type TupleDecoderType<Ds extends readonly Decoder<unknown>[]> = {
     [K in keyof Ds]: DecoderType<Ds[K]>;
 };
@@ -205,8 +200,9 @@ declare function nullable<T>(decoder: Decoder<T>): Decoder<T | null>;
 declare function nullable<T, C extends Scalar>(decoder: Decoder<T>, defaultValue: (() => C) | C): Decoder<NonNullable<T> | C>;
 declare function nullable<T, V>(decoder: Decoder<T>, defaultValue: (() => V) | V): Decoder<NonNullable<T> | V>;
 /**
- * @deprecated
- * Alias of nullish().
+ * @deprecated Will get removed in a future version.
+ *
+ * Alias of `nullish()`.
  */
 declare const maybe: typeof nullish;
 /**
@@ -236,12 +232,13 @@ declare function always<T>(value: (() => T) | T): Decoder<T>;
  */
 declare function never(msg: string): Decoder<never>;
 /**
- * Alias of never().
+ * Alias of `never()`.
  */
 declare const fail: typeof never;
 /**
- * @deprecated
- * Alias of always.
+ * Alias of `always()`.
+ *
+ * @deprecated Will get removed in a future version.
  */
 declare const hardcoded: typeof always;
 /**
@@ -253,8 +250,9 @@ declare const hardcoded: typeof always;
  */
 declare const unknown: Decoder<unknown>;
 /**
- * @deprecated
- * Alias of unknown.
+ * Alias of `unknown`.
+ *
+ * @deprecated Will get removed in a future version.
  */
 declare const mixed: Decoder<unknown>;
 
@@ -268,9 +266,41 @@ declare const boolean: Decoder<boolean>;
 declare const truthy: Decoder<boolean>;
 /**
  * Accepts numbers, but return their boolean representation.
+ *
+ * @deprecated This decoder will be removed in a future version. You can use
+ * `truthy` to get almost the same effect.
  */
 declare const numericBoolean: Decoder<boolean>;
 
+/**
+ * Accepts objects where all values match the given decoder, and returns the
+ * result as a `Record<string, V>`.
+ */
+declare function record<V>(valueDecoder: Decoder<V>): Decoder<Record<string, V>>;
+/**
+ * Accepts objects where all keys and values match the given decoders, and
+ * returns the result as a `Record<K, V>`. The given key decoder must return
+ * strings.
+ */
+declare function record<K extends string, V>(keyDecoder: Decoder<K>, valueDecoder: Decoder<V>): Decoder<Record<K, V>>;
+/**
+ * @deprecated Will get removed in a future version.
+ *
+ * Alias of `record()`.
+ */
+declare const dict: typeof record;
+/**
+ * Similar to `array()`, but returns the result as an [ES6
+ * Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
+ */
+declare function set<T>(decoder: Decoder<T>): Decoder<Set<T>>;
+/**
+ * Similar to `record()`, but returns the result as a `Map<string, T>` (an [ES6
+ * Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map))
+ * instead.
+ */
+declare function mapping<T>(decoder: Decoder<T>): Decoder<Map<string, T>>;
+
 /**
  * Accepts and returns `Date` instances.
  */
@@ -283,6 +313,12 @@ declare const date: Decoder<Date>;
  * `.toISOString()` when sending, decode them with `iso8601` when receiving.
  */
 declare const iso8601: Decoder<Date>;
+/**
+ * Accepts either a Date, or an ISO date string, returns a Date instance.
+ * This is commonly useful to build decoders that can be reused to validate
+ * object with Date instances as well as objects coming from JSON payloads.
+ */
+declare const datelike: Decoder<Date>;
 
 type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
 type JSONObject = {
@@ -420,23 +456,6 @@ declare function exact<Ds extends Record<string, Decoder<unknown>>>(decoders: Ds
  */
 declare function inexact(decoders: Record<any, never>): Decoder<Record<string, unknown>>;
 declare function inexact<Ds extends Record<string, Decoder<unknown>>>(decoders: Ds): Decoder<ObjectDecoderType<Ds> & Record<string, unknown>>;
-/**
- * Accepts objects where all values match the given decoder, and returns the
- * result as a `Record<string, T>`.
- *
- * The main difference between `object()` and `dict()` is that you'd typically
- * use `object()` if this is a record-like object, where all field names are
- * known and the values are heterogeneous. Whereas with `dict()` the keys are
- * typically dynamic and the values homogeneous, like in a dictionary,
- * a lookup table, or a cache.
- */
-declare function dict<T>(decoder: Decoder<T>): Decoder<Record<string, T>>;
-/**
- * Similar to `dict()`, but returns the result as a `Map<string, T>` (an [ES6
- * Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map))
- * instead.
- */
-declare function mapping<T>(decoder: Decoder<T>): Decoder<Map<string, T>>;
 
 /**
  * Accepts and returns strings.
@@ -482,6 +501,21 @@ declare const uuidv1: Decoder<string>;
  * strings.
  */
 declare const uuidv4: Decoder<string>;
+/**
+ * Accepts and returns strings with decimal digits only (base-10).
+ * To convert these to numbers, use the `numeric` decoder.
+ */
+declare const decimal: Decoder<string>;
+/**
+ * Accepts and returns strings with hexadecimal digits only (base-16).
+ */
+declare const hexadecimal: Decoder<string>;
+/**
+ * Accepts valid numerical strings (in base-10) and returns them as a number.
+ * To only accept numerical strings and keep them as string values, use the
+ * `decimal` decoder.
+ */
+declare const numeric: Decoder<number>;
 
 /**
  * Accepts values accepted by any of the given decoders.
@@ -496,6 +530,10 @@ declare function either<TDecoders extends readonly Decoder<unknown>[], T = Decod
  * specified values.
  */
 declare function oneOf<C extends Scalar>(constants: readonly C[]): Decoder<C>;
+/**
+ * Accepts and return an enum value.
+ */
+declare function enum_<TEnum extends Record<string, string | number>>(enumObj: TEnum): Decoder<TEnum[keyof TEnum]>;
 /**
  * If you are decoding tagged unions you may want to use the `taggedUnion()`
  * decoder instead of the general purpose `either()` decoder to get better
@@ -536,4 +574,4 @@ declare function taggedUnion<O extends Record<string, Decoder<unknown>>, T = Dec
  */
 declare function select<T, D extends Decoder<unknown>>(scout: Decoder<T>, selectFn: (result: T) => D): Decoder<DecoderType<D>>;
 
-export { type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type Ok, type Result, type Scalar, always, anyNumber, array, bigint, boolean, constant, date, define, dict, either, email, err, exact, fail, formatInline, formatShort, hardcoded, httpsUrl, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numericBoolean, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, regex, select, set, string, taggedUnion, truthy, tuple, undefined_, unknown, url, uuid, uuidv1, uuidv4 };
+export { type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type Ok, type Result, type Scalar, always, anyNumber, array, bigint, boolean, constant, date, datelike, decimal, define, dict, either, email, enum_, err, exact, fail, formatInline, formatShort, hardcoded, hexadecimal, httpsUrl, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numeric, numericBoolean, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, set, string, taggedUnion, truthy, tuple, undefined_, unknown, url, uuid, uuidv1, uuidv4 };

package/dist/index.d.ts

@@ -162,11 +162,6 @@ declare function array<T>(decoder: Decoder<T>): Decoder<T[]>;
  * Like `array()`, but will reject arrays with 0 elements.
  */
 declare function nonEmptyArray<T>(decoder: Decoder<T>): Decoder<[T, ...T[]]>;
-/**
- * Similar to `array()`, but returns the result as an [ES6
- * Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
- */
-declare function set<T>(decoder: Decoder<T>): Decoder<Set<T>>;
 type TupleDecoderType<Ds extends readonly Decoder<unknown>[]> = {
     [K in keyof Ds]: DecoderType<Ds[K]>;
 };
@@ -205,8 +200,9 @@ declare function nullable<T>(decoder: Decoder<T>): Decoder<T | null>;
 declare function nullable<T, C extends Scalar>(decoder: Decoder<T>, defaultValue: (() => C) | C): Decoder<NonNullable<T> | C>;
 declare function nullable<T, V>(decoder: Decoder<T>, defaultValue: (() => V) | V): Decoder<NonNullable<T> | V>;
 /**
- * @deprecated
- * Alias of nullish().
+ * @deprecated Will get removed in a future version.
+ *
+ * Alias of `nullish()`.
  */
 declare const maybe: typeof nullish;
 /**
@@ -236,12 +232,13 @@ declare function always<T>(value: (() => T) | T): Decoder<T>;
  */
 declare function never(msg: string): Decoder<never>;
 /**
- * Alias of never().
+ * Alias of `never()`.
  */
 declare const fail: typeof never;
 /**
- * @deprecated
- * Alias of always.
+ * Alias of `always()`.
+ *
+ * @deprecated Will get removed in a future version.
  */
 declare const hardcoded: typeof always;
 /**
@@ -253,8 +250,9 @@ declare const hardcoded: typeof always;
  */
 declare const unknown: Decoder<unknown>;
 /**
- * @deprecated
- * Alias of unknown.
+ * Alias of `unknown`.
+ *
+ * @deprecated Will get removed in a future version.
  */
 declare const mixed: Decoder<unknown>;
 
@@ -268,9 +266,41 @@ declare const boolean: Decoder<boolean>;
 declare const truthy: Decoder<boolean>;
 /**
  * Accepts numbers, but return their boolean representation.
+ *
+ * @deprecated This decoder will be removed in a future version. You can use
+ * `truthy` to get almost the same effect.
  */
 declare const numericBoolean: Decoder<boolean>;
 
+/**
+ * Accepts objects where all values match the given decoder, and returns the
+ * result as a `Record<string, V>`.
+ */
+declare function record<V>(valueDecoder: Decoder<V>): Decoder<Record<string, V>>;
+/**
+ * Accepts objects where all keys and values match the given decoders, and
+ * returns the result as a `Record<K, V>`. The given key decoder must return
+ * strings.
+ */
+declare function record<K extends string, V>(keyDecoder: Decoder<K>, valueDecoder: Decoder<V>): Decoder<Record<K, V>>;
+/**
+ * @deprecated Will get removed in a future version.
+ *
+ * Alias of `record()`.
+ */
+declare const dict: typeof record;
+/**
+ * Similar to `array()`, but returns the result as an [ES6
+ * Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
+ */
+declare function set<T>(decoder: Decoder<T>): Decoder<Set<T>>;
+/**
+ * Similar to `record()`, but returns the result as a `Map<string, T>` (an [ES6
+ * Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map))
+ * instead.
+ */
+declare function mapping<T>(decoder: Decoder<T>): Decoder<Map<string, T>>;
+
 /**
  * Accepts and returns `Date` instances.
  */
@@ -283,6 +313,12 @@ declare const date: Decoder<Date>;
  * `.toISOString()` when sending, decode them with `iso8601` when receiving.
  */
 declare const iso8601: Decoder<Date>;
+/**
+ * Accepts either a Date, or an ISO date string, returns a Date instance.
+ * This is commonly useful to build decoders that can be reused to validate
+ * object with Date instances as well as objects coming from JSON payloads.
+ */
+declare const datelike: Decoder<Date>;
 
 type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
 type JSONObject = {
@@ -420,23 +456,6 @@ declare function exact<Ds extends Record<string, Decoder<unknown>>>(decoders: Ds
  */
 declare function inexact(decoders: Record<any, never>): Decoder<Record<string, unknown>>;
 declare function inexact<Ds extends Record<string, Decoder<unknown>>>(decoders: Ds): Decoder<ObjectDecoderType<Ds> & Record<string, unknown>>;
-/**
- * Accepts objects where all values match the given decoder, and returns the
- * result as a `Record<string, T>`.
- *
- * The main difference between `object()` and `dict()` is that you'd typically
- * use `object()` if this is a record-like object, where all field names are
- * known and the values are heterogeneous. Whereas with `dict()` the keys are
- * typically dynamic and the values homogeneous, like in a dictionary,
- * a lookup table, or a cache.
- */
-declare function dict<T>(decoder: Decoder<T>): Decoder<Record<string, T>>;
-/**
- * Similar to `dict()`, but returns the result as a `Map<string, T>` (an [ES6
- * Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map))
- * instead.
- */
-declare function mapping<T>(decoder: Decoder<T>): Decoder<Map<string, T>>;
 
 /**
  * Accepts and returns strings.
@@ -482,6 +501,21 @@ declare const uuidv1: Decoder<string>;
  * strings.
  */
 declare const uuidv4: Decoder<string>;
+/**
+ * Accepts and returns strings with decimal digits only (base-10).
+ * To convert these to numbers, use the `numeric` decoder.
+ */
+declare const decimal: Decoder<string>;
+/**
+ * Accepts and returns strings with hexadecimal digits only (base-16).
+ */
+declare const hexadecimal: Decoder<string>;
+/**
+ * Accepts valid numerical strings (in base-10) and returns them as a number.
+ * To only accept numerical strings and keep them as string values, use the
+ * `decimal` decoder.
+ */
+declare const numeric: Decoder<number>;
 
 /**
  * Accepts values accepted by any of the given decoders.
@@ -496,6 +530,10 @@ declare function either<TDecoders extends readonly Decoder<unknown>[], T = Decod
  * specified values.
  */
 declare function oneOf<C extends Scalar>(constants: readonly C[]): Decoder<C>;
+/**
+ * Accepts and return an enum value.
+ */
+declare function enum_<TEnum extends Record<string, string | number>>(enumObj: TEnum): Decoder<TEnum[keyof TEnum]>;
 /**
  * If you are decoding tagged unions you may want to use the `taggedUnion()`
  * decoder instead of the general purpose `either()` decoder to get better
@@ -536,4 +574,4 @@ declare function taggedUnion<O extends Record<string, Decoder<unknown>>, T = Dec
  */
 declare function select<T, D extends Decoder<unknown>>(scout: Decoder<T>, selectFn: (result: T) => D): Decoder<DecoderType<D>>;
 
-export { type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type Ok, type Result, type Scalar, always, anyNumber, array, bigint, boolean, constant, date, define, dict, either, email, err, exact, fail, formatInline, formatShort, hardcoded, httpsUrl, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numericBoolean, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, regex, select, set, string, taggedUnion, truthy, tuple, undefined_, unknown, url, uuid, uuidv1, uuidv4 };
+export { type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type Ok, type Result, type Scalar, always, anyNumber, array, bigint, boolean, constant, date, datelike, decimal, define, dict, either, email, enum_, err, exact, fail, formatInline, formatShort, hardcoded, hexadecimal, httpsUrl, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numeric, numericBoolean, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, set, string, taggedUnion, truthy, tuple, undefined_, unknown, url, uuid, uuidv1, uuidv4 };

package/dist/index.js

@@ -1,4 +1,13 @@
 // src/lib/utils.ts
+function isNumber(value) {
+  return typeof value === "number";
+}
+function isString(value) {
+  return typeof value === "string";
+}
+function isBigInt(value) {
+  return typeof value === "bigint";
+}
 function isDate(value) {
   return !!value && Object.prototype.toString.call(value) === "[object Date]" && !isNaN(value);
 }
@@ -380,9 +389,6 @@ function isNonEmpty(arr) {
 function nonEmptyArray(decoder) {
   return array(decoder).refine(isNonEmpty, "Must be non-empty array");
 }
-function set(decoder) {
-  return array(decoder).transform((items) => new Set(items));
-}
 var ntuple = (n) => poja.refine((arr) => arr.length === n, `Must be a ${n}-tuple`);
 function tuple(...decoders) {
   return ntuple(decoders.length).then((blobs, ok2, err2) => {
@@ -453,7 +459,7 @@ function object(decoders) {
   return pojo.then((plainObj, ok2, err2) => {
     const actualKeys = new Set(Object.keys(plainObj));
     const missingKeys = difference(knownKeys, actualKeys);
-    const record = {};
+    const record2 = {};
     let errors = null;
     for (const key of Object.keys(decoders)) {
       const decoder = decoders[key];
@@ -462,7 +468,7 @@ function object(decoders) {
       if (result.ok) {
         const value = result.value;
         if (value !== void 0) {
-          record[key] = value;
+          record2[key] = value;
         }
         missingKeys.delete(key);
       } else {
@@ -489,7 +495,7 @@ function object(decoders) {
       }
       return err2(objAnn);
     }
-    return ok2(record);
+    return ok2(record2);
   });
 }
 function exact(decoders) {
@@ -527,41 +533,6 @@ function inexact(decoders) {
     return decoder.decode(plainObj);
   });
 }
-function dict(decoder) {
-  return pojo.then((plainObj, ok2, err2) => {
-    let rv = {};
-    let errors = null;
-    for (const key of Object.keys(plainObj)) {
-      const value = plainObj[key];
-      const result = decoder.decode(value);
-      if (result.ok) {
-        if (errors === null) {
-          rv[key] = result.value;
-        }
-      } else {
-        rv = {};
-        if (errors === null) {
-          errors = /* @__PURE__ */ new Map();
-        }
-        errors.set(key, result.error);
-      }
-    }
-    if (errors !== null) {
-      return err2(merge(public_annotateObject(plainObj), errors));
-    } else {
-      return ok2(rv);
-    }
-  });
-}
-function mapping(decoder) {
-  return dict(decoder).transform(
-    (obj) => new Map(
-      // This is effectively Object.entries(obj), but in a way that Flow
-      // will know the types are okay
-      Object.keys(obj).map((key) => [key, obj[key]])
-    )
-  );
-}
 
 // src/unions.ts
 var EITHER_PREFIX = "Either:\n";
@@ -600,6 +571,17 @@ function oneOf(constants) {
     );
   });
 }
+function enum_(enumObj) {
+  const values = Object.values(enumObj);
+  if (!values.some(isNumber)) {
+    return oneOf(values);
+  } else {
+    const nums = values.filter(isNumber);
+    const ignore = new Set(nums.map((val) => enumObj[val]));
+    const strings = values.filter(isString).filter((val) => !ignore.has(val));
+    return oneOf([...nums, ...strings]);
+  }
+}
 function taggedUnion(field, mapping2) {
   const scout = object({
     [field]: prep(String, oneOf(Object.keys(mapping2)))
@@ -625,9 +607,9 @@ function lazyval(value) {
 var null_ = constant(null);
 var undefined_ = constant(void 0);
 var nullish_ = define(
-  (blob, ok2, err2) => blob == null ? ok2(blob) : (
-    // Combine error message into a single line for readability
-    err2("Must be undefined or null")
+  (blob, ok2, err2) => (
+    // Equiv to either(undefined_, null_), but combined for better error message
+    blob == null ? ok2(blob) : err2("Must be undefined or null")
   )
 );
 function optional(decoder, defaultValue) {
@@ -665,7 +647,7 @@ var mixed = unknown;
 
 // src/numbers.ts
 var anyNumber = define(
-  (blob, ok2, err2) => typeof blob === "number" ? ok2(blob) : err2("Must be number")
+  (blob, ok2, err2) => isNumber(blob) ? ok2(blob) : err2("Must be number")
 );
 var number = anyNumber.refine(
   (n) => Number.isFinite(n),
@@ -675,10 +657,16 @@ var integer = number.refine(
   (n) => Number.isInteger(n),
   "Number must be an integer"
 );
-var positiveNumber = number.refine((n) => n >= 0, "Number must be positive").transform(Math.abs);
-var positiveInteger = integer.refine((n) => n >= 0, "Number must be positive").transform(Math.abs);
+var positiveNumber = number.refine(
+  (n) => n >= 0 && !Object.is(n, -0),
+  "Number must be positive"
+);
+var positiveInteger = integer.refine(
+  (n) => n >= 0 && !Object.is(n, -0),
+  "Number must be positive"
+);
 var bigint = define(
-  (blob, ok2, err2) => typeof blob === "bigint" ? ok2(blob) : err2("Must be bigint")
+  (blob, ok2, err2) => isBigInt(blob) ? ok2(blob) : err2("Must be bigint")
 );
 
 // src/booleans.ts
@@ -688,10 +676,53 @@ var boolean = define((blob, ok2, err2) => {
 var truthy = define((blob, ok2, _) => ok2(!!blob));
 var numericBoolean = number.transform((n) => !!n);
 
+// src/collections.ts
+function record(fst, snd) {
+  const keyDecoder = snd !== void 0 ? fst : void 0;
+  const valueDecoder = snd !== void 0 ? snd : fst;
+  return pojo.then((input, ok2, err2) => {
+    let rv = {};
+    const errors = /* @__PURE__ */ new Map();
+    for (const [key, value] of Object.entries(input)) {
+      const keyResult = keyDecoder?.decode(key);
+      if (keyResult?.ok === false) {
+        return err2(
+          public_annotate(
+            input,
+            `Invalid key ${JSON.stringify(key)}: ${formatShort(keyResult.error)}`
+          )
+        );
+      }
+      const k = keyResult?.value ?? key;
+      const result = valueDecoder.decode(value);
+      if (result.ok) {
+        if (errors.size === 0) {
+          rv[k] = result.value;
+        }
+      } else {
+        errors.set(key, result.error);
+        rv = {};
+      }
+    }
+    if (errors.size > 0) {
+      return err2(merge(public_annotateObject(input), errors));
+    } else {
+      return ok2(rv);
+    }
+  });
+}
+var dict = record;
+function set(decoder) {
+  return array(decoder).transform((items) => new Set(items));
+}
+function mapping(decoder) {
+  return record(decoder).transform((obj) => new Map(Object.entries(obj)));
+}
+
 // src/strings.ts
 var url_re = /^([A-Za-z]{3,9}(?:[+][A-Za-z]{3,9})?):\/\/(?:([-;:&=+$,\w]+)@)?(?:([A-Za-z0-9.-]+)(?::([0-9]{2,5}))?)(\/(?:[-+~%/.,\w]*)?(?:\?[-+=&;%@.,/\w]*)?(?:#[.,!/\w]*)?)?$/;
 var string = define(
-  (blob, ok2, err2) => typeof blob === "string" ? ok2(blob) : err2("Must be string")
+  (blob, ok2, err2) => isString(blob) ? ok2(blob) : err2("Must be string")
 );
 var nonEmptyString = regex(/\S/, "Must be non-empty string");
 function regex(regex2, msg) {
@@ -722,6 +753,12 @@ var uuidv4 = (
   // https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)
   uuid.refine((value) => value[14] === "4", "Must be uuidv4")
 );
+var decimal = regex(/^[0-9]+$/, "Must only contain digits");
+var hexadecimal = regex(
+  /^[0-9a-f]+$/i,
+  "Must only contain hexadecimal digits"
+);
+var numeric = decimal.transform(Number);
 
 // src/dates.ts
 var iso8601_re = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:?\d{2})$/;
@@ -741,9 +778,10 @@ var iso8601 = (
     }
   )
 );
+var datelike = either(date, iso8601).describe("Must be a Date or date string");
 
 // src/json.ts
-var jsonObject = lazy(() => dict(json));
+var jsonObject = lazy(() => record(json));
 var jsonArray = lazy(() => array(json));
 var json = either(
   null_,
@@ -761,16 +799,20 @@ export {
   boolean,
   constant,
   date,
+  datelike,
+  decimal,
   define,
   dict,
   either,
   email,
+  enum_,
   err,
   exact,
   fail,
   formatInline,
   formatShort,
   hardcoded,
+  hexadecimal,
   httpsUrl,
   inexact,
   instanceOf,
@@ -790,6 +832,7 @@ export {
   nullable,
   nullish,
   number,
+  numeric,
   numericBoolean,
   object,
   ok,
@@ -800,6 +843,7 @@ export {
   positiveInteger,
   positiveNumber,
   prep,
+  record,
   regex,
   select,
   set,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "decoders",
-  "version": "2.3.0-beta.1",
+  "version": "2.3.0-beta.3",
   "description": "Elegant and battle-tested validation library for type-safe input data for TypeScript",
   "license": "MIT",
   "repository": {