decoders 2.4.1 → 2.5.0

package/dist/index.cjs

@@ -709,6 +709,18 @@ var nonEmptyString = regex(/\S/, "Must be non-empty string");
 function regex(regex2, msg) {
   return string.refine((s) => regex2.test(s), msg);
 }
+function startsWith(prefix) {
+  return string.refine(
+    (s) => s.startsWith(prefix),
+    `Must start with '${prefix}'`
+  );
+}
+function endsWith(suffix) {
+  return string.refine(
+    (s) => s.endsWith(suffix),
+    `Must end with '${suffix}'`
+  );
+}
 var email = regex(
   // The almost perfect email regex, taken from https://emailregex.com/
   /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/,
@@ -873,4 +885,6 @@ 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.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.identifier = identifier; 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.nanoid = nanoid; 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.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.setFromArray = setFromArray; 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.endsWith = endsWith; 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.identifier = identifier; 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.nanoid = nanoid; 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.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.setFromArray = setFromArray; 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.uuid = uuid; exports.uuidv1 = uuidv1; exports.uuidv4 = uuidv4;

package/dist/index.d.cts

@@ -476,6 +476,14 @@ declare const nonEmptyString: Decoder<string>;
  * Accepts and returns strings that match the given regular expression.
  */
 declare function regex(regex: RegExp, msg: string): Decoder<string>;
+/**
+ * Accepts and returns strings that start with the given prefix.
+ */
+declare function startsWith<P extends string>(prefix: P): Decoder<`${P}${string}`>;
+/**
+ * Accepts and returns strings that end with the given suffix.
+ */
+declare function endsWith<S extends string>(suffix: S): Decoder<`${string}${S}`>;
 /**
  * Accepts and returns strings that are syntactically valid email addresses.
  * (This will not mean that the email address actually exist.)
@@ -580,7 +588,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
@@ -592,4 +600,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, type SizeOptions, always, anyNumber, array, bigint, boolean, constant, date, datelike, decimal, define, dict, either, email, enum_, err, exact, fail, formatInline, formatShort, hardcoded, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, nanoid, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, set, setFromArray, 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, type SizeOptions, always, anyNumber, array, bigint, boolean, constant, date, datelike, decimal, define, dict, either, email, endsWith, enum_, err, exact, fail, formatInline, formatShort, hardcoded, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, nanoid, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, set, setFromArray, startsWith, string, taggedUnion, truthy, tuple, undefined_, unknown, url, uuid, uuidv1, uuidv4 };

package/dist/index.d.ts

@@ -476,6 +476,14 @@ declare const nonEmptyString: Decoder<string>;
  * Accepts and returns strings that match the given regular expression.
  */
 declare function regex(regex: RegExp, msg: string): Decoder<string>;
+/**
+ * Accepts and returns strings that start with the given prefix.
+ */
+declare function startsWith<P extends string>(prefix: P): Decoder<`${P}${string}`>;
+/**
+ * Accepts and returns strings that end with the given suffix.
+ */
+declare function endsWith<S extends string>(suffix: S): Decoder<`${string}${S}`>;
 /**
  * Accepts and returns strings that are syntactically valid email addresses.
  * (This will not mean that the email address actually exist.)
@@ -580,7 +588,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
@@ -592,4 +600,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, type SizeOptions, always, anyNumber, array, bigint, boolean, constant, date, datelike, decimal, define, dict, either, email, enum_, err, exact, fail, formatInline, formatShort, hardcoded, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, nanoid, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, set, setFromArray, 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, type SizeOptions, always, anyNumber, array, bigint, boolean, constant, date, datelike, decimal, define, dict, either, email, endsWith, enum_, err, exact, fail, formatInline, formatShort, hardcoded, hexadecimal, httpsUrl, identifier, inexact, instanceOf, integer, iso8601, json, jsonArray, jsonObject, lazy, mapping, maybe, mixed, nanoid, never, nonEmptyArray, nonEmptyString, null_, nullable, nullish, number, numeric, object, ok, oneOf, optional, poja, pojo, positiveInteger, positiveNumber, prep, record, regex, select, set, setFromArray, startsWith, string, taggedUnion, truthy, tuple, undefined_, unknown, url, uuid, uuidv1, uuidv4 };

package/dist/index.js

@@ -709,6 +709,18 @@ var nonEmptyString = regex(/\S/, "Must be non-empty string");
 function regex(regex2, msg) {
   return string.refine((s) => regex2.test(s), msg);
 }
+function startsWith(prefix) {
+  return string.refine(
+    (s) => s.startsWith(prefix),
+    `Must start with '${prefix}'`
+  );
+}
+function endsWith(suffix) {
+  return string.refine(
+    (s) => s.endsWith(suffix),
+    `Must end with '${suffix}'`
+  );
+}
 var email = regex(
   // The almost perfect email regex, taken from https://emailregex.com/
   /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/,
@@ -819,6 +831,7 @@ export {
   dict,
   either,
   email,
+  endsWith,
   enum_,
   err,
   exact,
@@ -863,6 +876,7 @@ export {
   select,
   set,
   setFromArray,
+  startsWith,
   string,
   taggedUnion,
   truthy,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "decoders",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Elegant and battle-tested validation library for type-safe input data for TypeScript",
   "license": "MIT",
   "repository": {
@@ -61,7 +61,7 @@
     "verify"
   ],
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.15.3",
+    "@arethetypeswrong/cli": "^0.16.4",
     "@release-it/keep-a-changelog": "^5.0.0",
     "@types/eslint": "^8.56.10",
     "@typescript-eslint/eslint-plugin": "^7.14.1",
@@ -70,15 +70,15 @@
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-simple-import-sort": "^12.1.0",
-    "fast-check": "^3.19.0",
+    "fast-check": "^3.22.0",
     "itertools": "^2.3.2",
-    "pkg-pr-new": "^0.0.9",
-    "prettier": "^3.3.2",
-    "publint": "^0.2.8",
-    "release-it": "^17.4.0",
+    "pkg-pr-new": "^0.0.24",
+    "prettier": "^3.3.3",
+    "publint": "^0.2.11",
+    "release-it": "^17.6.0",
     "ts-morph": "^23.0.0",
-    "tsd": "^0.31.1",
-    "tsup": "^8.1.0",
+    "tsd": "^0.31.2",
+    "tsup": "^8.3.0",
     "typescript": "^5.5.2",
     "vite-tsconfig-paths": "^4.3.2",
     "vitest": "^1.6.0"