decoders 2.12.3 → 2.13.0

package/dist/index.cjs

@@ -1026,6 +1026,16 @@ var uuidv4 = (
   // https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)
   /* @__PURE__ */ uuid.refine((value) => value[14] === "4", "Must be uuidv4")
 );
+function isKsuid(value) {
+  return /^[0-9a-z]{27}$/i.test(value) && // Base62 alphabet sorts like ASCII, so the 2^160 - 1 upper bound is a
+  // string comparison
+  value <= "aWgEPTl1tmebfsQzFP4bxwgy80V";
+}
+// @__NO_SIDE_EFFECTS__
+function ksuid(options) {
+  const prefix = _optionalChain([options, 'optionalAccess', _8 => _8.prefix]);
+  return prefix ? (/* @__PURE__ */ startsWith(prefix)).refine((s) => isKsuid(s.slice(prefix.length)), "Must be ksuid") : string.refine(isKsuid, "Must be ksuid");
+}
 var decimal = /* @__PURE__ */ regex(/^[0-9]+$/, "Must only contain digits");
 var hexadecimal = /* @__PURE__ */ regex(
   /^[0-9a-f]+$/i,
@@ -1193,6 +1203,7 @@ var json = /* @__PURE__ */ either(
 
 
 
-exports._annotate = public_annotate; exports.always = always; exports.anyNumber = anyNumber; exports.anything = anything; exports.array = array; exports.between = between; exports.bigint = bigint; exports.boolean = boolean; exports.constant = constant; exports.date = date; exports.dateString = dateString; exports.datelike = datelike; exports.decimal = decimal; exports.define = define; exports.either = either; exports.email = email; exports.endsWith = endsWith; exports.enum_ = enum_; exports.err = err; exports.exact = exact; exports.fail = fail; exports.flexDate = flexDate; exports.formatInline = formatInline; exports.formatShort = formatShort; exports.hexadecimal = hexadecimal; exports.httpsUrl = httpsUrl; exports.identifier = identifier; exports.inexact = inexact; exports.instanceOf = instanceOf; exports.integer = integer; exports.isDate = isDate; exports.isDecoder = isDecoder; exports.isPlainObject = isPlainObject; exports.isPromiseLike = isPromiseLike; exports.iso8601 = iso8601; exports.isoDate = isoDate; exports.isoDateString = isoDateString; exports.json = json; exports.jsonArray = jsonArray; exports.jsonObject = jsonObject; exports.lazy = lazy; exports.mapping = mapping; exports.max = max; exports.min = min; exports.nanoid = nanoid; exports.natural = natural; exports.never = never; exports.nonEmptyArray = nonEmptyArray; exports.nonEmptyString = nonEmptyString; exports.nonNegativeNumber = nonNegativeNumber; exports.null_ = null_; exports.nullable = nullable; exports.nullish = nullish; exports.number = number; exports.numeric = numeric; 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.setFromArray = setFromArray; exports.sized = sized; exports.startsWith = startsWith; exports.string = string; exports.taggedUnion = taggedUnion; exports.truthy = truthy; exports.tuple = tuple; exports.undefined_ = undefined_; exports.unknown = unknown; exports.url = url; exports.urlString = urlString; exports.uuid = uuid; exports.uuidv1 = uuidv1; exports.uuidv4 = uuidv4;
+
+exports._annotate = public_annotate; exports.always = always; exports.anyNumber = anyNumber; exports.anything = anything; exports.array = array; exports.between = between; exports.bigint = bigint; exports.boolean = boolean; exports.constant = constant; exports.date = date; exports.dateString = dateString; exports.datelike = datelike; exports.decimal = decimal; exports.define = define; exports.either = either; exports.email = email; exports.endsWith = endsWith; exports.enum_ = enum_; exports.err = err; exports.exact = exact; exports.fail = fail; exports.flexDate = flexDate; exports.formatInline = formatInline; exports.formatShort = formatShort; exports.hexadecimal = hexadecimal; exports.httpsUrl = httpsUrl; exports.identifier = identifier; exports.inexact = inexact; exports.instanceOf = instanceOf; exports.integer = integer; exports.isDate = isDate; exports.isDecoder = isDecoder; exports.isPlainObject = isPlainObject; exports.isPromiseLike = isPromiseLike; exports.iso8601 = iso8601; exports.isoDate = isoDate; exports.isoDateString = isoDateString; exports.json = json; exports.jsonArray = jsonArray; exports.jsonObject = jsonObject; exports.ksuid = ksuid; exports.lazy = lazy; exports.mapping = mapping; exports.max = max; exports.min = min; exports.nanoid = nanoid; exports.natural = natural; exports.never = never; exports.nonEmptyArray = nonEmptyArray; exports.nonEmptyString = nonEmptyString; exports.nonNegativeNumber = nonNegativeNumber; exports.null_ = null_; exports.nullable = nullable; exports.nullish = nullish; exports.number = number; exports.numeric = numeric; 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.setFromArray = setFromArray; exports.sized = sized; exports.startsWith = startsWith; exports.string = string; exports.taggedUnion = taggedUnion; exports.truthy = truthy; exports.tuple = tuple; exports.undefined_ = undefined_; exports.unknown = unknown; exports.url = url; exports.urlString = urlString; exports.uuid = uuid; exports.uuidv1 = uuidv1; exports.uuidv4 = uuidv4;
 // istanbul ignore next -- @preserve
 // istanbul ignore else -- @preserve

package/dist/index.d.cts

@@ -645,6 +645,16 @@ declare const uuidv1: Decoder<string>;
  * strings.
  */
 declare const uuidv4: Decoder<string>;
+/**
+ * Accepts and returns [KSUID](https://github.com/segmentio/ksuid) strings
+ * (K-Sortable Unique IDentifier): 27 base62 chars, encoding a 160-bit value.
+ * Optionally, specify a prefix the KSUID must be preceded by, e.g.
+ * `ksuid({ prefix: 'msg_' })` accepts `msg_0ujtsYcgvSTl8PAuAdqWYSMnLOv`.
+ */
+declare function ksuid(): Decoder<string>;
+declare function ksuid<P extends string>(options: {
+    prefix: P;
+}): Decoder<`${P}${string}`>;
 /**
  * Accepts and returns strings with decimal digits only (base-10).
  * To convert these to numbers, use the `numeric` decoder.
@@ -733,4 +743,4 @@ declare function isPromiseLike(value: unknown): value is PromiseLike<unknown>;
  */
 declare function isPlainObject(value: unknown): value is Record<string, unknown>;
 
-export { type Annotation, type ArrayAnnotation, type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type ObjectAnnotation, type Ok, type OpaqueAnnotation, type Relax, type Result, type Scalar, type ScalarAnnotation, type SizeOptions, type Sized, public_annotate as _annotate, always, anyNumber, anything, array, between, bigint, boolean, constant, date, dateString, datelike, decimal, define, either, email, endsWith, enum_, err, exact, fail, flexDate, formatInline, formatShort, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, isDate, isDecoder, isPlainObject, isPromiseLike, iso8601, isoDate, isoDateString, json, jsonArray, jsonObject, lazy, mapping, max, min, nanoid, natural, never, nonEmptyArray, nonEmptyString, nonNegativeNumber, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, setFromArray, sized, startsWith, string, taggedUnion, truthy, tuple, undefined_, unknown, url, urlString, uuid, uuidv1, uuidv4 };
+export { type Annotation, type ArrayAnnotation, type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type ObjectAnnotation, type Ok, type OpaqueAnnotation, type Relax, type Result, type Scalar, type ScalarAnnotation, type SizeOptions, type Sized, public_annotate as _annotate, always, anyNumber, anything, array, between, bigint, boolean, constant, date, dateString, datelike, decimal, define, either, email, endsWith, enum_, err, exact, fail, flexDate, formatInline, formatShort, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, isDate, isDecoder, isPlainObject, isPromiseLike, iso8601, isoDate, isoDateString, json, jsonArray, jsonObject, ksuid, lazy, mapping, max, min, nanoid, natural, never, nonEmptyArray, nonEmptyString, nonNegativeNumber, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, setFromArray, sized, startsWith, string, taggedUnion, truthy, tuple, undefined_, unknown, url, urlString, uuid, uuidv1, uuidv4 };

package/dist/index.d.ts

@@ -645,6 +645,16 @@ declare const uuidv1: Decoder<string>;
  * strings.
  */
 declare const uuidv4: Decoder<string>;
+/**
+ * Accepts and returns [KSUID](https://github.com/segmentio/ksuid) strings
+ * (K-Sortable Unique IDentifier): 27 base62 chars, encoding a 160-bit value.
+ * Optionally, specify a prefix the KSUID must be preceded by, e.g.
+ * `ksuid({ prefix: 'msg_' })` accepts `msg_0ujtsYcgvSTl8PAuAdqWYSMnLOv`.
+ */
+declare function ksuid(): Decoder<string>;
+declare function ksuid<P extends string>(options: {
+    prefix: P;
+}): Decoder<`${P}${string}`>;
 /**
  * Accepts and returns strings with decimal digits only (base-10).
  * To convert these to numbers, use the `numeric` decoder.
@@ -733,4 +743,4 @@ declare function isPromiseLike(value: unknown): value is PromiseLike<unknown>;
  */
 declare function isPlainObject(value: unknown): value is Record<string, unknown>;
 
-export { type Annotation, type ArrayAnnotation, type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type ObjectAnnotation, type Ok, type OpaqueAnnotation, type Relax, type Result, type Scalar, type ScalarAnnotation, type SizeOptions, type Sized, public_annotate as _annotate, always, anyNumber, anything, array, between, bigint, boolean, constant, date, dateString, datelike, decimal, define, either, email, endsWith, enum_, err, exact, fail, flexDate, formatInline, formatShort, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, isDate, isDecoder, isPlainObject, isPromiseLike, iso8601, isoDate, isoDateString, json, jsonArray, jsonObject, lazy, mapping, max, min, nanoid, natural, never, nonEmptyArray, nonEmptyString, nonNegativeNumber, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, setFromArray, sized, startsWith, string, taggedUnion, truthy, tuple, undefined_, unknown, url, urlString, uuid, uuidv1, uuidv4 };
+export { type Annotation, type ArrayAnnotation, type DecodeResult, type Decoder, type DecoderType, type Err, type Formatter, type JSONArray, type JSONObject, type JSONValue, type ObjectAnnotation, type Ok, type OpaqueAnnotation, type Relax, type Result, type Scalar, type ScalarAnnotation, type SizeOptions, type Sized, public_annotate as _annotate, always, anyNumber, anything, array, between, bigint, boolean, constant, date, dateString, datelike, decimal, define, either, email, endsWith, enum_, err, exact, fail, flexDate, formatInline, formatShort, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, isDate, isDecoder, isPlainObject, isPromiseLike, iso8601, isoDate, isoDateString, json, jsonArray, jsonObject, ksuid, lazy, mapping, max, min, nanoid, natural, never, nonEmptyArray, nonEmptyString, nonNegativeNumber, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, setFromArray, sized, startsWith, string, taggedUnion, truthy, tuple, undefined_, unknown, url, urlString, uuid, uuidv1, uuidv4 };

package/dist/index.js

@@ -1026,6 +1026,16 @@ var uuidv4 = (
   // https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)
   /* @__PURE__ */ uuid.refine((value) => value[14] === "4", "Must be uuidv4")
 );
+function isKsuid(value) {
+  return /^[0-9a-z]{27}$/i.test(value) && // Base62 alphabet sorts like ASCII, so the 2^160 - 1 upper bound is a
+  // string comparison
+  value <= "aWgEPTl1tmebfsQzFP4bxwgy80V";
+}
+// @__NO_SIDE_EFFECTS__
+function ksuid(options) {
+  const prefix = options?.prefix;
+  return prefix ? (/* @__PURE__ */ startsWith(prefix)).refine((s) => isKsuid(s.slice(prefix.length)), "Must be ksuid") : string.refine(isKsuid, "Must be ksuid");
+}
 var decimal = /* @__PURE__ */ regex(/^[0-9]+$/, "Must only contain digits");
 var hexadecimal = /* @__PURE__ */ regex(
   /^[0-9a-f]+$/i,
@@ -1152,6 +1162,7 @@ export {
   json,
   jsonArray,
   jsonObject,
+  ksuid,
   lazy,
   mapping,
   max,

package/package.json

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