@alextheman/utility 2.20.0 → 2.21.0

package/dist/index.cjs

@@ -46,6 +46,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 var index_exports = {};
 __export(index_exports, {
   APIError: () => APIError_default,
+  DataError: () => DataError_default,
   addDaysToDate: () => addDaysToDate_default,
   appendSemicolon: () => appendSemicolon_default,
   camelToKebab: () => camelToKebab_default,
@@ -72,6 +73,7 @@ __export(index_exports, {
   parseEnv: () => Env_default,
   parseIntStrict: () => parseIntStrict_default,
   parseUUID: () => UUID_default,
+  parseZodSchema: () => parseZodSchema_default,
   randomiseArray: () => randomiseArray_default,
   range: () => range_default,
   removeDuplicates: () => removeDuplicates_default,
@@ -425,6 +427,98 @@ function paralleliseArrays(firstArray, secondArray) {
 }
 var paralleliseArrays_default = paralleliseArrays;
 
+// src/types/APIError.ts
+var httpErrorCodeLookup = {
+  400: "BAD_REQUEST",
+  401: "UNAUTHORISED",
+  403: "FORBIDDEN",
+  404: "NOT_FOUND",
+  /* Supporting this one too because it's funny. You'll never use it in practice because 
+                why would an error give a teapot, but it's funny. Do not question me. */
+  418: "I_AM_A_TEAPOT",
+  500: "INTERNAL_SERVER_ERROR"
+};
+var APIError = class extends Error {
+  constructor(status = 500, message, options) {
+    var _a;
+    super(message, options);
+    __publicField(this, "status");
+    this.status = status;
+    if (message) {
+      this.message = message;
+    } else {
+      this.message = (_a = httpErrorCodeLookup[this.status]) != null ? _a : "API_ERROR";
+    }
+    Object.defineProperty(this, "message", { enumerable: true });
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  static check(input) {
+    const data = input;
+    return typeof data === "object" && data !== null && typeof (data == null ? void 0 : data.status) === "number" && typeof (data == null ? void 0 : data.message) === "string";
+  }
+};
+var APIError_default = APIError;
+
+// src/types/DataError.ts
+var DataError = class extends Error {
+  /** @param data - The data that caused the error. */
+  /** @param message - A human-readable error message (e.g. The data provided is invalid). */
+  /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
+  /** @param options - Extra options to pass to super Error constructor. */
+  constructor(data, message = "The data provided is invalid", code = "INVALID_DATA", options) {
+    super(message, options);
+    __publicField(this, "data");
+    __publicField(this, "code");
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, new.target);
+    }
+    this.name = new.target.name;
+    this.code = code;
+    this.data = data;
+    Object.defineProperty(this, "message", { enumerable: true });
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  static check(input) {
+    const data = input;
+    return typeof data === "object" && data !== null && typeof data.message === "string" && typeof data.code === "string" && "data" in data;
+  }
+};
+var DataError_default = DataError;
+
+// src/types/Email.ts
+var import_zod = __toESM(require("zod"), 1);
+var emailSchema = import_zod.default.email().brand();
+function parseEmail(data) {
+  return emailSchema.parse(data);
+}
+var Email_default = parseEmail;
+
+// src/types/Env.ts
+var import_zod2 = require("zod");
+var envSchema = import_zod2.z.enum(["test", "development", "production"]);
+function parseEnv(data = "development") {
+  return envSchema.parse(data);
+}
+var Env_default = parseEnv;
+
+// src/types/UUID.ts
+var import_zod3 = __toESM(require("zod"), 1);
+var uuidSchema = import_zod3.default.uuid().brand();
+function parseUUID(UUID) {
+  return uuidSchema.parse(UUID);
+}
+var UUID_default = parseUUID;
+
+// src/functions/parseZodSchema.ts
+function parseZodSchema(schema, data) {
+  const parsedResult = schema.safeParse(data);
+  if (!parsedResult.success) {
+    throw new DataError_default(data);
+  }
+  return parsedResult.data;
+}
+var parseZodSchema_default = parseZodSchema;
+
 // src/functions/randomiseArray.ts
 function randomiseArray(array) {
   const mutableArray = [...array];
@@ -608,65 +702,10 @@ function stripIndents(first, ...args) {
   return reduceLines2(fullString.split("\n"), options);
 }
 var stripIndents_default = stripIndents;
-
-// src/types/APIError.ts
-var httpErrorCodeLookup = {
-  400: "BAD_REQUEST",
-  401: "UNAUTHORISED",
-  403: "FORBIDDEN",
-  404: "NOT_FOUND",
-  /* Supporting this one too because it's funny. You'll never use it in practice because 
-                why would an error give a teapot, but it's funny. Do not question me. */
-  418: "I_AM_A_TEAPOT",
-  500: "INTERNAL_SERVER_ERROR"
-};
-var APIError = class extends Error {
-  constructor(status = 500, message, options) {
-    var _a;
-    super(message, options);
-    __publicField(this, "status");
-    this.status = status;
-    if (message) {
-      this.message = message;
-    } else {
-      this.message = (_a = httpErrorCodeLookup[this.status]) != null ? _a : "API_ERROR";
-    }
-    Object.defineProperty(this, "message", { enumerable: true });
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-  static check(input) {
-    const data = input;
-    return typeof data === "object" && data !== null && typeof (data == null ? void 0 : data.status) === "number" && typeof (data == null ? void 0 : data.message) === "string";
-  }
-};
-var APIError_default = APIError;
-
-// src/types/Email.ts
-var import_zod = __toESM(require("zod"), 1);
-var emailSchema = import_zod.default.email().brand();
-function parseEmail(data) {
-  return emailSchema.parse(data);
-}
-var Email_default = parseEmail;
-
-// src/types/Env.ts
-var import_zod2 = require("zod");
-var envSchema = import_zod2.z.enum(["test", "development", "production"]);
-function parseEnv(data = "development") {
-  return envSchema.parse(data);
-}
-var Env_default = parseEnv;
-
-// src/types/UUID.ts
-var import_zod3 = __toESM(require("zod"), 1);
-var uuidSchema = import_zod3.default.uuid().brand();
-function parseUUID(UUID) {
-  return uuidSchema.parse(UUID);
-}
-var UUID_default = parseUUID;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   APIError,
+  DataError,
   addDaysToDate,
   appendSemicolon,
   camelToKebab,
@@ -693,6 +732,7 @@ var UUID_default = parseUUID;
   parseEnv,
   parseIntStrict,
   parseUUID,
+  parseZodSchema,
   randomiseArray,
   range,
   removeDuplicates,

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import z, { z as z$1 } from 'zod';
+import z, { z as z$1, core, ZodType } from 'zod';
 
 declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
 
@@ -18,6 +18,17 @@ declare class APIError extends Error {
     static check(input: unknown): input is APIError;
 }
 
+declare class DataError extends Error {
+    data: unknown;
+    code: string;
+    /** @param data - The data that caused the error. */
+    /** @param message - A human-readable error message (e.g. The data provided is invalid). */
+    /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
+    /** @param options - Extra options to pass to super Error constructor. */
+    constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
+    static check(input: unknown): input is DataError;
+}
+
 declare const emailSchema: z.core.$ZodBranded<z.ZodEmail, "Email">;
 type Email = z.infer<typeof emailSchema>;
 declare function parseEmail(data: unknown): Email;
@@ -96,6 +107,8 @@ declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray:
 
 declare function parseIntStrict(...[string, radix]: Parameters<typeof parseInt>): number;
 
+declare function parseZodSchema<Output, Input, Internals extends core.$ZodTypeInternals<Output, Input>>(schema: ZodType<Output, Input, Internals>, data: unknown): core.output<ZodType<Output, Input, Internals>>;
+
 declare function randomiseArray<T>(array: T[]): T[];
 
 declare function range(start: number, stop: number, step?: number): number[];
@@ -133,4 +146,4 @@ type StripIndentsFunction = (strings: TemplateStringsArray, ...interpolations: u
 declare function stripIndents(options: StripIndentsOptions): StripIndentsFunction;
 declare function stripIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
 
-export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type HTTPErrorCodes, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, type RemoveIndentsFunction, type RemoveIndentsOptions, type StringListToArrayOptions, type StripIndentsFunction, type StripIndentsOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseEmail, parseEnv, parseIntStrict, parseUUID, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, stripIndents, truncate, wait };
+export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type HTTPErrorCodes, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, type RemoveIndentsFunction, type RemoveIndentsOptions, type StringListToArrayOptions, type StripIndentsFunction, type StripIndentsOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseEmail, parseEnv, parseIntStrict, parseUUID, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, stripIndents, truncate, wait };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import z, { z as z$1 } from 'zod';
+import z, { z as z$1, core, ZodType } from 'zod';
 
 declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
 
@@ -18,6 +18,17 @@ declare class APIError extends Error {
     static check(input: unknown): input is APIError;
 }
 
+declare class DataError extends Error {
+    data: unknown;
+    code: string;
+    /** @param data - The data that caused the error. */
+    /** @param message - A human-readable error message (e.g. The data provided is invalid). */
+    /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
+    /** @param options - Extra options to pass to super Error constructor. */
+    constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
+    static check(input: unknown): input is DataError;
+}
+
 declare const emailSchema: z.core.$ZodBranded<z.ZodEmail, "Email">;
 type Email = z.infer<typeof emailSchema>;
 declare function parseEmail(data: unknown): Email;
@@ -96,6 +107,8 @@ declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray:
 
 declare function parseIntStrict(...[string, radix]: Parameters<typeof parseInt>): number;
 
+declare function parseZodSchema<Output, Input, Internals extends core.$ZodTypeInternals<Output, Input>>(schema: ZodType<Output, Input, Internals>, data: unknown): core.output<ZodType<Output, Input, Internals>>;
+
 declare function randomiseArray<T>(array: T[]): T[];
 
 declare function range(start: number, stop: number, step?: number): number[];
@@ -133,4 +146,4 @@ type StripIndentsFunction = (strings: TemplateStringsArray, ...interpolations: u
 declare function stripIndents(options: StripIndentsOptions): StripIndentsFunction;
 declare function stripIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
 
-export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type HTTPErrorCodes, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, type RemoveIndentsFunction, type RemoveIndentsOptions, type StringListToArrayOptions, type StripIndentsFunction, type StripIndentsOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseEmail, parseEnv, parseIntStrict, parseUUID, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, stripIndents, truncate, wait };
+export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type HTTPErrorCodes, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, type RemoveIndentsFunction, type RemoveIndentsOptions, type StringListToArrayOptions, type StripIndentsFunction, type StripIndentsOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseEmail, parseEnv, parseIntStrict, parseUUID, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, stripIndents, truncate, wait };

package/dist/index.js

@@ -357,6 +357,98 @@ function paralleliseArrays(firstArray, secondArray) {
 }
 var paralleliseArrays_default = paralleliseArrays;
 
+// src/types/APIError.ts
+var httpErrorCodeLookup = {
+  400: "BAD_REQUEST",
+  401: "UNAUTHORISED",
+  403: "FORBIDDEN",
+  404: "NOT_FOUND",
+  /* Supporting this one too because it's funny. You'll never use it in practice because 
+                why would an error give a teapot, but it's funny. Do not question me. */
+  418: "I_AM_A_TEAPOT",
+  500: "INTERNAL_SERVER_ERROR"
+};
+var APIError = class extends Error {
+  constructor(status = 500, message, options) {
+    var _a;
+    super(message, options);
+    __publicField(this, "status");
+    this.status = status;
+    if (message) {
+      this.message = message;
+    } else {
+      this.message = (_a = httpErrorCodeLookup[this.status]) != null ? _a : "API_ERROR";
+    }
+    Object.defineProperty(this, "message", { enumerable: true });
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  static check(input) {
+    const data = input;
+    return typeof data === "object" && data !== null && typeof (data == null ? void 0 : data.status) === "number" && typeof (data == null ? void 0 : data.message) === "string";
+  }
+};
+var APIError_default = APIError;
+
+// src/types/DataError.ts
+var DataError = class extends Error {
+  /** @param data - The data that caused the error. */
+  /** @param message - A human-readable error message (e.g. The data provided is invalid). */
+  /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
+  /** @param options - Extra options to pass to super Error constructor. */
+  constructor(data, message = "The data provided is invalid", code = "INVALID_DATA", options) {
+    super(message, options);
+    __publicField(this, "data");
+    __publicField(this, "code");
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, new.target);
+    }
+    this.name = new.target.name;
+    this.code = code;
+    this.data = data;
+    Object.defineProperty(this, "message", { enumerable: true });
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  static check(input) {
+    const data = input;
+    return typeof data === "object" && data !== null && typeof data.message === "string" && typeof data.code === "string" && "data" in data;
+  }
+};
+var DataError_default = DataError;
+
+// src/types/Email.ts
+import z from "zod";
+var emailSchema = z.email().brand();
+function parseEmail(data) {
+  return emailSchema.parse(data);
+}
+var Email_default = parseEmail;
+
+// src/types/Env.ts
+import { z as z2 } from "zod";
+var envSchema = z2.enum(["test", "development", "production"]);
+function parseEnv(data = "development") {
+  return envSchema.parse(data);
+}
+var Env_default = parseEnv;
+
+// src/types/UUID.ts
+import z3 from "zod";
+var uuidSchema = z3.uuid().brand();
+function parseUUID(UUID) {
+  return uuidSchema.parse(UUID);
+}
+var UUID_default = parseUUID;
+
+// src/functions/parseZodSchema.ts
+function parseZodSchema(schema, data) {
+  const parsedResult = schema.safeParse(data);
+  if (!parsedResult.success) {
+    throw new DataError_default(data);
+  }
+  return parsedResult.data;
+}
+var parseZodSchema_default = parseZodSchema;
+
 // src/functions/randomiseArray.ts
 function randomiseArray(array) {
   const mutableArray = [...array];
@@ -540,64 +632,9 @@ function stripIndents(first, ...args) {
   return reduceLines2(fullString.split("\n"), options);
 }
 var stripIndents_default = stripIndents;
-
-// src/types/APIError.ts
-var httpErrorCodeLookup = {
-  400: "BAD_REQUEST",
-  401: "UNAUTHORISED",
-  403: "FORBIDDEN",
-  404: "NOT_FOUND",
-  /* Supporting this one too because it's funny. You'll never use it in practice because 
-                why would an error give a teapot, but it's funny. Do not question me. */
-  418: "I_AM_A_TEAPOT",
-  500: "INTERNAL_SERVER_ERROR"
-};
-var APIError = class extends Error {
-  constructor(status = 500, message, options) {
-    var _a;
-    super(message, options);
-    __publicField(this, "status");
-    this.status = status;
-    if (message) {
-      this.message = message;
-    } else {
-      this.message = (_a = httpErrorCodeLookup[this.status]) != null ? _a : "API_ERROR";
-    }
-    Object.defineProperty(this, "message", { enumerable: true });
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-  static check(input) {
-    const data = input;
-    return typeof data === "object" && data !== null && typeof (data == null ? void 0 : data.status) === "number" && typeof (data == null ? void 0 : data.message) === "string";
-  }
-};
-var APIError_default = APIError;
-
-// src/types/Email.ts
-import z from "zod";
-var emailSchema = z.email().brand();
-function parseEmail(data) {
-  return emailSchema.parse(data);
-}
-var Email_default = parseEmail;
-
-// src/types/Env.ts
-import { z as z2 } from "zod";
-var envSchema = z2.enum(["test", "development", "production"]);
-function parseEnv(data = "development") {
-  return envSchema.parse(data);
-}
-var Env_default = parseEnv;
-
-// src/types/UUID.ts
-import z3 from "zod";
-var uuidSchema = z3.uuid().brand();
-function parseUUID(UUID) {
-  return uuidSchema.parse(UUID);
-}
-var UUID_default = parseUUID;
 export {
   APIError_default as APIError,
+  DataError_default as DataError,
   addDaysToDate_default as addDaysToDate,
   appendSemicolon_default as appendSemicolon,
   camelToKebab_default as camelToKebab,
@@ -624,6 +661,7 @@ export {
   Env_default as parseEnv,
   parseIntStrict_default as parseIntStrict,
   UUID_default as parseUUID,
+  parseZodSchema_default as parseZodSchema,
   randomiseArray_default as randomiseArray,
   range_default as range,
   removeDuplicates_default as removeDuplicates,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",
@@ -34,13 +34,15 @@
     "prepare": "husky",
     "test": "vitest run",
     "test-watch": "vitest",
-    "update-dependencies": "bash -c 'npx npm-check-updates -u \"$@\" && npm install' --"
+    "update-dependencies": "bash -c 'npx npm-check-updates -u \"$@\" && npm install' --",
+    "use-live-eslint-plugin": "npm uninstall @alextheman/eslint-plugin && npm install --save-dev @alextheman/eslint-plugin",
+    "use-local-eslint-plugin": "npm --prefix ../eslint-plugin run create-local-package && npm uninstall @alextheman/eslint-plugin && npm install --save-dev ../eslint-plugin/alextheman-eslint-plugin-*.tgz"
   },
   "dependencies": {
     "zod": "^4.1.12"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^3.2.1",
+    "@alextheman/eslint-plugin": "^4.1.0",
     "@types/node": "^24.10.1",
     "eslint": "^9.39.1",
     "globals": "^16.5.0",