@xylabs/zod 5.0.83 → 5.0.84

package/README.md

@@ -53,6 +53,8 @@ function zodAllFactory<T, TName>(zod, name): object;
 
 **`Alpha`**
 
+Creates a bundle of `is`, `as`, and `to` factory functions for a given zod schema.
+
 ## Type Parameters
 
 ### T
@@ -69,14 +71,20 @@ function zodAllFactory<T, TName>(zod, name): object;
 
 `ZodType`\<`T`\>
 
+The zod schema to validate against
+
 ### name
 
 `TName`
 
+The name used to suffix the generated function names (e.g. 'Address' produces `isAddress`, `asAddress`, `toAddress`)
+
 ## Returns
 
 `object`
 
+An object containing `is<Name>`, `as<Name>`, and `to<Name>` functions
+
   ### <a id="zodAsAsyncFactory"></a>zodAsAsyncFactory
 
 [**@xylabs/zod**](#../README)
@@ -90,6 +98,9 @@ function zodAsAsyncFactory<TZod>(zod, name): {
 };
 ```
 
+Creates an async function that validates a value against a zod schema and returns it with a narrowed type.
+Uses `safeParseAsync` for schemas with async refinements. When called without an assert config, returns undefined on failure.
+
 ## Type Parameters
 
 ### TZod
@@ -102,12 +113,18 @@ function zodAsAsyncFactory<TZod>(zod, name): {
 
 `ZodType`\<`TZod`\>
 
+The zod schema to validate against
+
 ### name
 
 `string`
 
+A name used in error messages for identification
+
 ## Returns
 
+An async function that validates and narrows the type of a value
+
 ```ts
 <T>(value): Promise<T & TZod | undefined>;
 ```
@@ -165,6 +182,9 @@ function zodAsFactory<TZod>(zod, name): {
 };
 ```
 
+Creates a function that validates a value against a zod schema and returns it with a narrowed type.
+When called without an assert config, returns undefined on failure. When called with an assert config, throws on failure.
+
 ## Type Parameters
 
 ### TZod
@@ -177,12 +197,18 @@ function zodAsFactory<TZod>(zod, name): {
 
 `ZodType`\<`TZod`\>
 
+The zod schema to validate against
+
 ### name
 
 `string`
 
+A name used in error messages for identification
+
 ## Returns
 
+A function that validates and narrows the type of a value
+
 ```ts
 <T>(value): T & TZod | undefined;
 ```
@@ -237,6 +263,8 @@ function zodAsFactory<TZod>(zod, name): {
 function zodIsFactory<TZod>(zod): <T>(value) => value is T & TZod;
 ```
 
+Creates a type guard function that checks if a value matches a zod schema.
+
 ## Type Parameters
 
 ### TZod
@@ -249,8 +277,12 @@ function zodIsFactory<TZod>(zod): <T>(value) => value is T & TZod;
 
 `ZodType`\<`TZod`\>
 
+The zod schema to validate against
+
 ## Returns
 
+A type guard function that returns true if the value passes validation
+
 ```ts
 <T>(value): value is T & TZod;
 ```
@@ -284,6 +316,9 @@ function zodToAsyncFactory<TZod>(zod, name): {
 };
 ```
 
+Creates an async function that converts a value to the zod schema type, delegating to `zodAsAsyncFactory` internally.
+Provides overloads for optional assertion: without assert config resolves to undefined on failure, with assert config throws on failure.
+
 ## Type Parameters
 
 ### TZod
@@ -296,12 +331,18 @@ function zodToAsyncFactory<TZod>(zod, name): {
 
 `ZodType`\<`TZod`\>
 
+The zod schema to validate against
+
 ### name
 
 `string`
 
+A name used in error messages for identification
+
 ## Returns
 
+An async function that validates and converts a value to the schema type
+
 ```ts
 <T>(value): Promise<T & TZod | undefined>;
 ```
@@ -359,6 +400,9 @@ function zodToFactory<TZod>(zod, name): {
 };
 ```
 
+Creates a function that converts a value to the zod schema type, delegating to `zodAsFactory` internally.
+Provides overloads for optional assertion: without assert config returns undefined on failure, with assert config throws on failure.
+
 ## Type Parameters
 
 ### TZod
@@ -371,12 +415,18 @@ function zodToFactory<TZod>(zod, name): {
 
 `ZodType`\<`TZod`\>
 
+The zod schema to validate against
+
 ### name
 
 `string`
 
+A name used in error messages for identification
+
 ## Returns
 
+A function that validates and converts a value to the schema type
+
 ```ts
 <T>(value): T & TZod | undefined;
 ```
@@ -429,6 +479,8 @@ function zodToFactory<TZod>(zod, name): {
 
 ***
 
+Configuration object for zod factory functions, providing a name for error messages.
+
 ## Properties
 
 ### name
@@ -473,6 +525,8 @@ type ZodFactoryConfig =
   | ZodFactoryConfigObject;
 ```
 
+Configuration for zod factory assertion behavior, either an AssertConfig or a named config object.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/Config.d.ts

@@ -1,6 +1,8 @@
 import type { AssertConfig } from '@xylabs/error';
+/** Configuration object for zod factory functions, providing a name for error messages. */
 export interface ZodFactoryConfigObject {
     name: string;
 }
+/** Configuration for zod factory assertion behavior, either an AssertConfig or a named config object. */
 export type ZodFactoryConfig = AssertConfig | ZodFactoryConfigObject;
 //# sourceMappingURL=Config.d.ts.map

package/dist/neutral/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,sBAAsB,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,2FAA2F;AAC3F,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,yGAAyG;AACzG,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,sBAAsB,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/zodAsFactory.ts","../../src/zodIsFactory.ts","../../src/zodToFactory.ts","../../src/zodAllFactory.ts","../../src/zodAsAsyncFactory.ts","../../src/zodToAsyncFactory.ts"],"sourcesContent":["import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\n\nexport function zodAsFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  function asFunc<T>(value: T): (T & TZod) | undefined\n  function asFunc<T>(value: T, assert: ZodFactoryConfig): (T & TZod)\n  function asFunc<T>(value: T, assert?: ZodFactoryConfig): (T & TZod) | undefined {\n    const result = zod.safeParse(value)\n    if (result.success) {\n      return value as (T & TZod)\n    }\n    if (assert !== undefined) {\n      let assertConfig: AssertConfig\n      switch (typeof assert) {\n        case 'string': {\n          assertConfig = `[${name}][${value}] ${assert}`\n          break\n        }\n        case 'object': {\n          assertConfig = `[${name}][${assert.name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'boolean': {\n          assertConfig = `[${name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'function': {\n          assertConfig = assert(value, result.error.message)\n          break\n        }\n      }\n      return assertError(value, assertConfig, result.error.message)\n    }\n  }\n\n  return asFunc\n}\n","import type * as z from 'zod'\n\nexport function zodIsFactory<TZod>(zod: z.ZodType<TZod>) {\n  return <T>(value: T): value is T & TZod => zod.safeParse(value).success\n}\n","import { isDefined } from '@xylabs/typeof'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\nimport { zodAsFactory } from './zodAsFactory.ts'\n\nexport function zodToFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  const as = zodAsFactory<TZod>(zod, name)\n  function toFunc<T>(value: T): (T & TZod) | undefined\n  function toFunc<T>(value: T, assert: ZodFactoryConfig): (T & TZod)\n  function toFunc<T>(value: T, assert?: ZodFactoryConfig): (T & TZod) | undefined {\n    if (isDefined(assert)) {\n      return as(value, assert)\n    }\n    return as(value)\n  }\n  return toFunc\n}\n","import type * as z from 'zod'\n\nimport { zodAsFactory } from './zodAsFactory.ts'\nimport { zodIsFactory } from './zodIsFactory.ts'\nimport { zodToFactory } from './zodToFactory.ts'\n\n/** @alpha */\nexport type AllZodFactories<TType, TName extends string> = {\n  [K in `is${TName}`]: ReturnType<typeof zodIsFactory<TType>>\n} & {\n  [K in `as${TName}`]: ReturnType<typeof zodAsFactory<TType>>\n} & {\n  [K in `to${TName}`]: ReturnType<typeof zodToFactory<TType>>\n}\n\n/** @alpha */\nexport function zodAllFactory<T, TName extends string>(zod: z.ZodType<T>, name: TName) {\n  return {\n    [`is${name}`]: zodIsFactory<T>(zod),\n    [`as${name}`]: zodAsFactory<T>(zod, `as${name}`),\n    [`to${name}`]: zodToFactory<T>(zod, `to${name}`),\n  }\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\n\nexport function zodAsAsyncFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  function asFunc<T>(value: T): Promise<(T & TZod) | undefined>\n  function asFunc<T>(value: T, assert: ZodFactoryConfig): Promise<(T & TZod)>\n  async function asFunc<T>(value: T, assert?: ZodFactoryConfig): Promise<(T & TZod) | undefined> {\n    const result = await zod.safeParseAsync(value)\n    if (result.success) {\n      return value as (T & TZod)\n    }\n    if (assert !== undefined) {\n      let assertConfig: AssertConfig\n      switch (typeof assert) {\n        case 'string': {\n          assertConfig = `[${name}][${value}] ${assert}`\n          break\n        }\n        case 'object': {\n          assertConfig = `[${name}][${assert.name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'boolean': {\n          assertConfig = `[${name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'function': {\n          assertConfig = assert(value, result.error.message)\n          break\n        }\n      }\n      return assertError(value, assertConfig, result.error.message)\n    }\n  }\n\n  return asFunc\n}\n","import { isDefined } from '@xylabs/typeof'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\nimport { zodAsAsyncFactory } from './zodAsAsyncFactory.ts'\n\nexport function zodToAsyncFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  const as = zodAsAsyncFactory<TZod>(zod, name)\n  function toFunc<T>(value: T): Promise<(T & TZod) | undefined>\n  function toFunc<T>(value: T, assert: ZodFactoryConfig): Promise<(T & TZod)>\n  async function toFunc<T>(value: T, assert?: ZodFactoryConfig): Promise<(T & TZod) | undefined> {\n    if (isDefined(assert)) {\n      return await as(value, assert)\n    }\n    return await as(value)\n  }\n  return toFunc\n}\n"],"mappings":";AACA,SAAS,mBAAmB;AAKrB,SAAS,aAAmB,KAAsB,MAAc;AAGrE,WAAS,OAAU,OAAU,QAAmD;AAC9E,UAAM,SAAS,IAAI,UAAU,KAAK;AAClC,QAAI,OAAO,SAAS;AAClB,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,UAAI;AACJ,cAAQ,OAAO,QAAQ;AAAA,QACrB,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM;AAC5C;AAAA,QACF;AAAA,QACA,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,OAAO,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1E;AAAA,QACF;AAAA,QACA,KAAK,WAAW;AACd,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1D;AAAA,QACF;AAAA,QACA,KAAK,YAAY;AACf,yBAAe,OAAO,OAAO,OAAO,MAAM,OAAO;AACjD;AAAA,QACF;AAAA,MACF;AACA,aAAO,YAAY,OAAO,cAAc,OAAO,MAAM,OAAO;AAAA,IAC9D;AAAA,EACF;AAEA,SAAO;AACT;;;ACrCO,SAAS,aAAmB,KAAsB;AACvD,SAAO,CAAI,UAAgC,IAAI,UAAU,KAAK,EAAE;AAClE;;;ACJA,SAAS,iBAAiB;AAMnB,SAAS,aAAmB,KAAsB,MAAc;AACrE,QAAM,KAAK,aAAmB,KAAK,IAAI;AAGvC,WAAS,OAAU,OAAU,QAAmD;AAC9E,QAAI,UAAU,MAAM,GAAG;AACrB,aAAO,GAAG,OAAO,MAAM;AAAA,IACzB;AACA,WAAO,GAAG,KAAK;AAAA,EACjB;AACA,SAAO;AACT;;;ACDO,SAAS,cAAuC,KAAmB,MAAa;AACrF,SAAO;AAAA,IACL,CAAC,KAAK,IAAI,EAAE,GAAG,aAAgB,GAAG;AAAA,IAClC,CAAC,KAAK,IAAI,EAAE,GAAG,aAAgB,KAAK,KAAK,IAAI,EAAE;AAAA,IAC/C,CAAC,KAAK,IAAI,EAAE,GAAG,aAAgB,KAAK,KAAK,IAAI,EAAE;AAAA,EACjD;AACF;;;ACrBA,SAAS,eAAAA,oBAAmB;AAKrB,SAAS,kBAAwB,KAAsB,MAAc;AAG1E,iBAAe,OAAU,OAAU,QAA4D;AAC7F,UAAM,SAAS,MAAM,IAAI,eAAe,KAAK;AAC7C,QAAI,OAAO,SAAS;AAClB,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,UAAI;AACJ,cAAQ,OAAO,QAAQ;AAAA,QACrB,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM;AAC5C;AAAA,QACF;AAAA,QACA,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,OAAO,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1E;AAAA,QACF;AAAA,QACA,KAAK,WAAW;AACd,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1D;AAAA,QACF;AAAA,QACA,KAAK,YAAY;AACf,yBAAe,OAAO,OAAO,OAAO,MAAM,OAAO;AACjD;AAAA,QACF;AAAA,MACF;AACA,aAAOA,aAAY,OAAO,cAAc,OAAO,MAAM,OAAO;AAAA,IAC9D;AAAA,EACF;AAEA,SAAO;AACT;;;ACvCA,SAAS,aAAAC,kBAAiB;AAMnB,SAAS,kBAAwB,KAAsB,MAAc;AAC1E,QAAM,KAAK,kBAAwB,KAAK,IAAI;AAG5C,iBAAe,OAAU,OAAU,QAA4D;AAC7F,QAAIC,WAAU,MAAM,GAAG;AACrB,aAAO,MAAM,GAAG,OAAO,MAAM;AAAA,IAC/B;AACA,WAAO,MAAM,GAAG,KAAK;AAAA,EACvB;AACA,SAAO;AACT;","names":["assertError","isDefined","isDefined"]}
+{"version":3,"sources":["../../src/zodAsFactory.ts","../../src/zodIsFactory.ts","../../src/zodToFactory.ts","../../src/zodAllFactory.ts","../../src/zodAsAsyncFactory.ts","../../src/zodToAsyncFactory.ts"],"sourcesContent":["import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\n\n/**\n * Creates a function that validates a value against a zod schema and returns it with a narrowed type.\n * When called without an assert config, returns undefined on failure. When called with an assert config, throws on failure.\n * @param zod - The zod schema to validate against\n * @param name - A name used in error messages for identification\n * @returns A function that validates and narrows the type of a value\n */\nexport function zodAsFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  function asFunc<T>(value: T): (T & TZod) | undefined\n  function asFunc<T>(value: T, assert: ZodFactoryConfig): (T & TZod)\n  function asFunc<T>(value: T, assert?: ZodFactoryConfig): (T & TZod) | undefined {\n    const result = zod.safeParse(value)\n    if (result.success) {\n      return value as (T & TZod)\n    }\n    if (assert !== undefined) {\n      let assertConfig: AssertConfig\n      switch (typeof assert) {\n        case 'string': {\n          assertConfig = `[${name}][${value}] ${assert}`\n          break\n        }\n        case 'object': {\n          assertConfig = `[${name}][${assert.name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'boolean': {\n          assertConfig = `[${name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'function': {\n          assertConfig = assert(value, result.error.message)\n          break\n        }\n      }\n      return assertError(value, assertConfig, result.error.message)\n    }\n  }\n\n  return asFunc\n}\n","import type * as z from 'zod'\n\n/**\n * Creates a type guard function that checks if a value matches a zod schema.\n * @param zod - The zod schema to validate against\n * @returns A type guard function that returns true if the value passes validation\n */\nexport function zodIsFactory<TZod>(zod: z.ZodType<TZod>) {\n  return <T>(value: T): value is T & TZod => zod.safeParse(value).success\n}\n","import { isDefined } from '@xylabs/typeof'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\nimport { zodAsFactory } from './zodAsFactory.ts'\n\n/**\n * Creates a function that converts a value to the zod schema type, delegating to `zodAsFactory` internally.\n * Provides overloads for optional assertion: without assert config returns undefined on failure, with assert config throws on failure.\n * @param zod - The zod schema to validate against\n * @param name - A name used in error messages for identification\n * @returns A function that validates and converts a value to the schema type\n */\nexport function zodToFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  const as = zodAsFactory<TZod>(zod, name)\n  function toFunc<T>(value: T): (T & TZod) | undefined\n  function toFunc<T>(value: T, assert: ZodFactoryConfig): (T & TZod)\n  function toFunc<T>(value: T, assert?: ZodFactoryConfig): (T & TZod) | undefined {\n    if (isDefined(assert)) {\n      return as(value, assert)\n    }\n    return as(value)\n  }\n  return toFunc\n}\n","import type * as z from 'zod'\n\nimport { zodAsFactory } from './zodAsFactory.ts'\nimport { zodIsFactory } from './zodIsFactory.ts'\nimport { zodToFactory } from './zodToFactory.ts'\n\n/** @alpha */\nexport type AllZodFactories<TType, TName extends string> = {\n  [K in `is${TName}`]: ReturnType<typeof zodIsFactory<TType>>\n} & {\n  [K in `as${TName}`]: ReturnType<typeof zodAsFactory<TType>>\n} & {\n  [K in `to${TName}`]: ReturnType<typeof zodToFactory<TType>>\n}\n\n/**\n * Creates a bundle of `is`, `as`, and `to` factory functions for a given zod schema.\n * @alpha\n * @param zod - The zod schema to validate against\n * @param name - The name used to suffix the generated function names (e.g. 'Address' produces `isAddress`, `asAddress`, `toAddress`)\n * @returns An object containing `is<Name>`, `as<Name>`, and `to<Name>` functions\n */\nexport function zodAllFactory<T, TName extends string>(zod: z.ZodType<T>, name: TName) {\n  return {\n    [`is${name}`]: zodIsFactory<T>(zod),\n    [`as${name}`]: zodAsFactory<T>(zod, `as${name}`),\n    [`to${name}`]: zodToFactory<T>(zod, `to${name}`),\n  }\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\n\n/**\n * Creates an async function that validates a value against a zod schema and returns it with a narrowed type.\n * Uses `safeParseAsync` for schemas with async refinements. When called without an assert config, returns undefined on failure.\n * @param zod - The zod schema to validate against\n * @param name - A name used in error messages for identification\n * @returns An async function that validates and narrows the type of a value\n */\nexport function zodAsAsyncFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  function asFunc<T>(value: T): Promise<(T & TZod) | undefined>\n  function asFunc<T>(value: T, assert: ZodFactoryConfig): Promise<(T & TZod)>\n  async function asFunc<T>(value: T, assert?: ZodFactoryConfig): Promise<(T & TZod) | undefined> {\n    const result = await zod.safeParseAsync(value)\n    if (result.success) {\n      return value as (T & TZod)\n    }\n    if (assert !== undefined) {\n      let assertConfig: AssertConfig\n      switch (typeof assert) {\n        case 'string': {\n          assertConfig = `[${name}][${value}] ${assert}`\n          break\n        }\n        case 'object': {\n          assertConfig = `[${name}][${assert.name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'boolean': {\n          assertConfig = `[${name}][${value}] ${result.error.message}`\n          break\n        }\n        case 'function': {\n          assertConfig = assert(value, result.error.message)\n          break\n        }\n      }\n      return assertError(value, assertConfig, result.error.message)\n    }\n  }\n\n  return asFunc\n}\n","import { isDefined } from '@xylabs/typeof'\nimport type * as z from 'zod'\n\nimport type { ZodFactoryConfig } from './Config.ts'\nimport { zodAsAsyncFactory } from './zodAsAsyncFactory.ts'\n\n/**\n * Creates an async function that converts a value to the zod schema type, delegating to `zodAsAsyncFactory` internally.\n * Provides overloads for optional assertion: without assert config resolves to undefined on failure, with assert config throws on failure.\n * @param zod - The zod schema to validate against\n * @param name - A name used in error messages for identification\n * @returns An async function that validates and converts a value to the schema type\n */\nexport function zodToAsyncFactory<TZod>(zod: z.ZodType<TZod>, name: string) {\n  const as = zodAsAsyncFactory<TZod>(zod, name)\n  function toFunc<T>(value: T): Promise<(T & TZod) | undefined>\n  function toFunc<T>(value: T, assert: ZodFactoryConfig): Promise<(T & TZod)>\n  async function toFunc<T>(value: T, assert?: ZodFactoryConfig): Promise<(T & TZod) | undefined> {\n    if (isDefined(assert)) {\n      return await as(value, assert)\n    }\n    return await as(value)\n  }\n  return toFunc\n}\n"],"mappings":";AACA,SAAS,mBAAmB;AAYrB,SAAS,aAAmB,KAAsB,MAAc;AAGrE,WAAS,OAAU,OAAU,QAAmD;AAC9E,UAAM,SAAS,IAAI,UAAU,KAAK;AAClC,QAAI,OAAO,SAAS;AAClB,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,UAAI;AACJ,cAAQ,OAAO,QAAQ;AAAA,QACrB,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM;AAC5C;AAAA,QACF;AAAA,QACA,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,OAAO,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1E;AAAA,QACF;AAAA,QACA,KAAK,WAAW;AACd,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1D;AAAA,QACF;AAAA,QACA,KAAK,YAAY;AACf,yBAAe,OAAO,OAAO,OAAO,MAAM,OAAO;AACjD;AAAA,QACF;AAAA,MACF;AACA,aAAO,YAAY,OAAO,cAAc,OAAO,MAAM,OAAO;AAAA,IAC9D;AAAA,EACF;AAEA,SAAO;AACT;;;ACvCO,SAAS,aAAmB,KAAsB;AACvD,SAAO,CAAI,UAAgC,IAAI,UAAU,KAAK,EAAE;AAClE;;;ACTA,SAAS,iBAAiB;AAanB,SAAS,aAAmB,KAAsB,MAAc;AACrE,QAAM,KAAK,aAAmB,KAAK,IAAI;AAGvC,WAAS,OAAU,OAAU,QAAmD;AAC9E,QAAI,UAAU,MAAM,GAAG;AACrB,aAAO,GAAG,OAAO,MAAM;AAAA,IACzB;AACA,WAAO,GAAG,KAAK;AAAA,EACjB;AACA,SAAO;AACT;;;ACFO,SAAS,cAAuC,KAAmB,MAAa;AACrF,SAAO;AAAA,IACL,CAAC,KAAK,IAAI,EAAE,GAAG,aAAgB,GAAG;AAAA,IAClC,CAAC,KAAK,IAAI,EAAE,GAAG,aAAgB,KAAK,KAAK,IAAI,EAAE;AAAA,IAC/C,CAAC,KAAK,IAAI,EAAE,GAAG,aAAgB,KAAK,KAAK,IAAI,EAAE;AAAA,EACjD;AACF;;;AC3BA,SAAS,eAAAA,oBAAmB;AAYrB,SAAS,kBAAwB,KAAsB,MAAc;AAG1E,iBAAe,OAAU,OAAU,QAA4D;AAC7F,UAAM,SAAS,MAAM,IAAI,eAAe,KAAK;AAC7C,QAAI,OAAO,SAAS;AAClB,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,UAAI;AACJ,cAAQ,OAAO,QAAQ;AAAA,QACrB,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM;AAC5C;AAAA,QACF;AAAA,QACA,KAAK,UAAU;AACb,yBAAe,IAAI,IAAI,KAAK,OAAO,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1E;AAAA,QACF;AAAA,QACA,KAAK,WAAW;AACd,yBAAe,IAAI,IAAI,KAAK,KAAK,KAAK,OAAO,MAAM,OAAO;AAC1D;AAAA,QACF;AAAA,QACA,KAAK,YAAY;AACf,yBAAe,OAAO,OAAO,OAAO,MAAM,OAAO;AACjD;AAAA,QACF;AAAA,MACF;AACA,aAAOA,aAAY,OAAO,cAAc,OAAO,MAAM,OAAO;AAAA,IAC9D;AAAA,EACF;AAEA,SAAO;AACT;;;AC9CA,SAAS,aAAAC,kBAAiB;AAanB,SAAS,kBAAwB,KAAsB,MAAc;AAC1E,QAAM,KAAK,kBAAwB,KAAK,IAAI;AAG5C,iBAAe,OAAU,OAAU,QAA4D;AAC7F,QAAIC,WAAU,MAAM,GAAG;AACrB,aAAO,MAAM,GAAG,OAAO,MAAM;AAAA,IAC/B;AACA,WAAO,MAAM,GAAG,KAAK;AAAA,EACvB;AACA,SAAO;AACT;","names":["assertError","isDefined","isDefined"]}

package/dist/neutral/zodAllFactory.d.ts

@@ -10,7 +10,13 @@ export type AllZodFactories<TType, TName extends string> = {
 } & {
     [K in `to${TName}`]: ReturnType<typeof zodToFactory<TType>>;
 };
-/** @alpha */
+/**
+ * Creates a bundle of `is`, `as`, and `to` factory functions for a given zod schema.
+ * @alpha
+ * @param zod - The zod schema to validate against
+ * @param name - The name used to suffix the generated function names (e.g. 'Address' produces `isAddress`, `asAddress`, `toAddress`)
+ * @returns An object containing `is<Name>`, `as<Name>`, and `to<Name>` functions
+ */
 export declare function zodAllFactory<T, TName extends string>(zod: z.ZodType<T>, name: TName): {
     [x: string]: {
         <T_1>(value: T_1): (T_1 & T) | undefined;

package/dist/neutral/zodAllFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodAllFactory.d.ts","sourceRoot":"","sources":["../../src/zodAllFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,aAAa;AACb,MAAM,MAAM,eAAe,CAAC,KAAK,EAAE,KAAK,SAAS,MAAM,IAAI;KACxD,CAAC,IAAI,KAAK,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;CAC5D,GAAG;KACD,CAAC,IAAI,KAAK,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;CAC5D,GAAG;KACD,CAAC,IAAI,KAAK,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;CAC5D,CAAA;AAED,aAAa;AACb,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK;;;;;EAMpF"}
+{"version":3,"file":"zodAllFactory.d.ts","sourceRoot":"","sources":["../../src/zodAllFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,aAAa;AACb,MAAM,MAAM,eAAe,CAAC,KAAK,EAAE,KAAK,SAAS,MAAM,IAAI;KACxD,CAAC,IAAI,KAAK,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;CAC5D,GAAG;KACD,CAAC,IAAI,KAAK,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;CAC5D,GAAG;KACD,CAAC,IAAI,KAAK,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;CAC5D,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK;;;;;EAMpF"}

package/dist/neutral/zodAsAsyncFactory.d.ts

@@ -1,5 +1,12 @@
 import type * as z from 'zod';
 import type { ZodFactoryConfig } from './Config.ts';
+/**
+ * Creates an async function that validates a value against a zod schema and returns it with a narrowed type.
+ * Uses `safeParseAsync` for schemas with async refinements. When called without an assert config, returns undefined on failure.
+ * @param zod - The zod schema to validate against
+ * @param name - A name used in error messages for identification
+ * @returns An async function that validates and narrows the type of a value
+ */
 export declare function zodAsAsyncFactory<TZod>(zod: z.ZodType<TZod>, name: string): {
     <T>(value: T): Promise<(T & TZod) | undefined>;
     <T>(value: T, assert: ZodFactoryConfig): Promise<(T & TZod)>;

package/dist/neutral/zodAsAsyncFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodAsAsyncFactory.d.ts","sourceRoot":"","sources":["../../src/zodAsAsyncFactory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEnD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KACxD,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;KAC7C,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;EA+B5E"}
+{"version":3,"file":"zodAsAsyncFactory.d.ts","sourceRoot":"","sources":["../../src/zodAsAsyncFactory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEnD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KACxD,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;KAC7C,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;EA+B5E"}

package/dist/neutral/zodAsFactory.d.ts

@@ -1,5 +1,12 @@
 import type * as z from 'zod';
 import type { ZodFactoryConfig } from './Config.ts';
+/**
+ * Creates a function that validates a value against a zod schema and returns it with a narrowed type.
+ * When called without an assert config, returns undefined on failure. When called with an assert config, throws on failure.
+ * @param zod - The zod schema to validate against
+ * @param name - A name used in error messages for identification
+ * @returns A function that validates and narrows the type of a value
+ */
 export declare function zodAsFactory<TZod>(zod: z.ZodType<TZod>, name: string): {
     <T>(value: T): (T & TZod) | undefined;
     <T>(value: T, assert: ZodFactoryConfig): (T & TZod);

package/dist/neutral/zodAsFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodAsFactory.d.ts","sourceRoot":"","sources":["../../src/zodAsFactory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEnD,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KACnD,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS;KACpC,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;EA+BnE"}
+{"version":3,"file":"zodAsFactory.d.ts","sourceRoot":"","sources":["../../src/zodAsFactory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEnD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KACnD,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS;KACpC,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;EA+BnE"}

package/dist/neutral/zodIsFactory.d.ts

@@ -1,3 +1,8 @@
 import type * as z from 'zod';
+/**
+ * Creates a type guard function that checks if a value matches a zod schema.
+ * @param zod - The zod schema to validate against
+ * @returns A type guard function that returns true if the value passes validation
+ */
 export declare function zodIsFactory<TZod>(zod: z.ZodType<TZod>): <T>(value: T) => value is T & TZod;
 //# sourceMappingURL=zodIsFactory.d.ts.map

package/dist/neutral/zodIsFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodIsFactory.d.ts","sourceRoot":"","sources":["../../src/zodIsFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAC7C,CAAC,EAAE,OAAO,CAAC,KAAG,KAAK,IAAI,CAAC,GAAG,IAAI,CACxC"}
+{"version":3,"file":"zodIsFactory.d.ts","sourceRoot":"","sources":["../../src/zodIsFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAC7C,CAAC,EAAE,OAAO,CAAC,KAAG,KAAK,IAAI,CAAC,GAAG,IAAI,CACxC"}

package/dist/neutral/zodToAsyncFactory.d.ts

@@ -1,5 +1,12 @@
 import type * as z from 'zod';
 import type { ZodFactoryConfig } from './Config.ts';
+/**
+ * Creates an async function that converts a value to the zod schema type, delegating to `zodAsAsyncFactory` internally.
+ * Provides overloads for optional assertion: without assert config resolves to undefined on failure, with assert config throws on failure.
+ * @param zod - The zod schema to validate against
+ * @param name - A name used in error messages for identification
+ * @returns An async function that validates and converts a value to the schema type
+ */
 export declare function zodToAsyncFactory<TZod>(zod: z.ZodType<TZod>, name: string): {
     <T>(value: T): Promise<(T & TZod) | undefined>;
     <T>(value: T, assert: ZodFactoryConfig): Promise<(T & TZod)>;

package/dist/neutral/zodToAsyncFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodToAsyncFactory.d.ts","sourceRoot":"","sources":["../../src/zodToAsyncFactory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGnD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KAExD,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;KAC7C,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;EAQ5E"}
+{"version":3,"file":"zodToAsyncFactory.d.ts","sourceRoot":"","sources":["../../src/zodToAsyncFactory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGnD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KAExD,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;KAC7C,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;EAQ5E"}

package/dist/neutral/zodToFactory.d.ts

@@ -1,5 +1,12 @@
 import type * as z from 'zod';
 import type { ZodFactoryConfig } from './Config.ts';
+/**
+ * Creates a function that converts a value to the zod schema type, delegating to `zodAsFactory` internally.
+ * Provides overloads for optional assertion: without assert config returns undefined on failure, with assert config throws on failure.
+ * @param zod - The zod schema to validate against
+ * @param name - A name used in error messages for identification
+ * @returns A function that validates and converts a value to the schema type
+ */
 export declare function zodToFactory<TZod>(zod: z.ZodType<TZod>, name: string): {
     <T>(value: T): (T & TZod) | undefined;
     <T>(value: T, assert: ZodFactoryConfig): (T & TZod);

package/dist/neutral/zodToFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodToFactory.d.ts","sourceRoot":"","sources":["../../src/zodToFactory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGnD,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KAEnD,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS;KACpC,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;EAQnE"}
+{"version":3,"file":"zodToFactory.d.ts","sourceRoot":"","sources":["../../src/zodToFactory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAE7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGnD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM;KAEnD,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS;KACpC,CAAC,SAAS,CAAC,UAAU,gBAAgB,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;EAQnE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/zod",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -35,12 +35,12 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/error": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83"
+    "@xylabs/error": "~5.0.84",
+    "@xylabs/typeof": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "typescript": "~5.9.3",
     "vitest": "^4.0.18",
     "zod": "^4.3.6"