@xylabs/zod 5.0.80 → 5.0.82

package/README.md

@@ -1,4 +1,4 @@
-# @xylabs/object
+# @xylabs/zod
 
 [![logo][]](https://xylabs.com)
 
@@ -17,1800 +17,462 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Reference
 
-**@xylabs/object**
+**@xylabs/zod**
 
 ***
 
-## Classes
-
-- [IsObjectFactory](#classes/IsObjectFactory)
-- [ObjectWrapper](#classes/ObjectWrapper)
-- [ValidatorBase](#classes/ValidatorBase)
-
-## Interfaces
-
-- [ObjectTypeConfig](#interfaces/ObjectTypeConfig)
-- [Validator](#interfaces/Validator)
-- [TypeCheckConfig](#interfaces/TypeCheckConfig)
-- [TypeCheckRequiredConfig](#interfaces/TypeCheckRequiredConfig)
-- [TypeCheckOptionalConfig](#interfaces/TypeCheckOptionalConfig)
-
-## Type Aliases
-
-- [EmptyObject](#type-aliases/EmptyObject)
-- [EmptyObjectOf](#type-aliases/EmptyObjectOf)
-- [JsonValue](#type-aliases/JsonValue)
-- [JsonObject](#type-aliases/JsonObject)
-- [JsonArray](#type-aliases/JsonArray)
-- [OmitStartsWith](#type-aliases/OmitStartsWith)
-- [DeepOmitStartsWith](#type-aliases/DeepOmitStartsWith)
-- [DeepRestrictToStringKeys](#type-aliases/DeepRestrictToStringKeys)
-- [Optional](#type-aliases/Optional)
-- [Override](#type-aliases/Override)
-- [~~PartialRecord~~](#type-aliases/PartialRecord)
-- [PickStartsWith](#type-aliases/PickStartsWith)
-- [DeepPickStartsWith](#type-aliases/DeepPickStartsWith)
-- [StringKeyObject](#type-aliases/StringKeyObject)
-- [WithAdditional](#type-aliases/WithAdditional)
-- [OmitByPredicate](#type-aliases/OmitByPredicate)
-- [PickByPredicate](#type-aliases/PickByPredicate)
-- [AnyObject](#type-aliases/AnyObject)
-- [AsTypeFunction](#type-aliases/AsTypeFunction)
-- [AsOptionalTypeFunction](#type-aliases/AsOptionalTypeFunction)
-- [Compare](#type-aliases/Compare)
-- [StringOrAlertFunction](#type-aliases/StringOrAlertFunction)
-- [TypeCheck](#type-aliases/TypeCheck)
-
-## Variables
-
-- [AsObjectFactory](#variables/AsObjectFactory)
-- [AsTypeFactory](#variables/AsTypeFactory)
-- [asAnyObject](#variables/asAnyObject)
-- [deepMerge](#variables/deepMerge)
-
-## Functions
-
-- [isJsonValue](#functions/isJsonValue)
-- [isJsonArray](#functions/isJsonArray)
-- [isValidJsonFieldPair](#functions/isValidJsonFieldPair)
-- [isJsonObject](#functions/isJsonObject)
-- [createDeepMerge](#functions/createDeepMerge)
-- [isObject](#functions/isObject)
-- [isType](#functions/isType)
-- [omitBy](#functions/omitBy)
-- [omitByPrefix](#functions/omitByPrefix)
-- [pickBy](#functions/pickBy)
-- [pickByPrefix](#functions/pickByPrefix)
-- [removeFields](#functions/removeFields)
-- [toJsonArray](#functions/toJsonArray)
-- [toJsonObject](#functions/toJsonObject)
-- [toJsonValue](#functions/toJsonValue)
-- [toJsonString](#functions/toJsonString)
-- [toJson](#functions/toJson)
-
-### classes
-
-  ### <a id="IsObjectFactory"></a>IsObjectFactory
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Type Parameters
-
-### T
-
-`T` *extends* `TypedObject`
-
-## Constructors
-
-### Constructor
-
-```ts
-new IsObjectFactory<T>(): IsObjectFactory<T>;
-```
-
-### Returns
-
-`IsObjectFactory`\<`T`\>
-
-## Methods
-
-### create()
-
-```ts
-create(shape?, additionalChecks?): TypeCheck<T>;
-```
-
-### Parameters
-
-#### shape?
-
-`ObjectTypeShape`
-
-#### additionalChecks?
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`TypedObject`\>[]
-
-### Returns
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-  ### <a id="ObjectWrapper"></a>ObjectWrapper
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Extended by
-
-- [`ValidatorBase`](#ValidatorBase)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) = [`EmptyObject`](#../type-aliases/EmptyObject)
-
-## Constructors
-
-### Constructor
-
-```ts
-new ObjectWrapper<T>(obj): ObjectWrapper<T>;
-```
-
-### Parameters
-
-#### obj
-
-`T`
-
-### Returns
-
-`ObjectWrapper`\<`T`\>
-
-## Properties
-
-### obj
-
-```ts
-readonly obj: T;
-```
-
-## Accessors
-
-### stringKeyObj
-
-### Get Signature
-
-```ts
-get protected stringKeyObj(): StringKeyObject;
-```
-
-#### Returns
-
-[`StringKeyObject`](#../type-aliases/StringKeyObject)
-
-  ### <a id="ValidatorBase"></a>ValidatorBase
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Extends
-
-- [`ObjectWrapper`](#ObjectWrapper)\<`Partial`\<`T`\>\>
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) = [`AnyObject`](#../type-aliases/AnyObject)
-
-## Implements
-
-- [`Validator`](#../interfaces/Validator)\<`T`\>
-
-## Constructors
-
-### Constructor
-
-```ts
-new ValidatorBase<T>(obj): ValidatorBase<T>;
-```
-
-### Parameters
-
-#### obj
-
-`T`
-
-### Returns
-
-`ValidatorBase`\<`T`\>
-
-### Inherited from
-
-[`ObjectWrapper`](#ObjectWrapper).[`constructor`](ObjectWrapper.md#constructor)
-
-## Properties
-
-### obj
-
-```ts
-readonly obj: T;
-```
-
-### Inherited from
-
-[`ObjectWrapper`](#ObjectWrapper).[`obj`](ObjectWrapper.md#obj)
-
-## Accessors
-
-### stringKeyObj
-
-### Get Signature
-
-```ts
-get protected stringKeyObj(): StringKeyObject;
-```
-
-#### Returns
-
-[`StringKeyObject`](#../type-aliases/StringKeyObject)
-
-### Inherited from
-
-[`ObjectWrapper`](#ObjectWrapper).[`stringKeyObj`](ObjectWrapper.md#stringkeyobj)
-
-## Methods
-
-### validate()
-
-```ts
-abstract validate(payload): Promisable<Error[]>;
-```
-
-### Parameters
-
-#### payload
-
-`T`
-
-### Returns
-
-`Promisable`\<`Error`[]\>
-
-### Implementation of
-
-[`Validator`](#../interfaces/Validator).[`validate`](../interfaces/Validator.md#validate)
-
-### functions
-
-  ### <a id="createDeepMerge"></a>createDeepMerge
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function createDeepMerge(options): <T>(...objects) => MergeAll<T>;
-```
-
-Creates a deep merge function with the specified options.
-
-## Parameters
-
-### options
-
-`MergeOptions`
-
-Options for merging.
-
-## Returns
-
-A deep merge function configured for the specified options.
-
-```ts
-<T>(...objects): MergeAll<T>;
-```
-
-### Type Parameters
-
-### T
-
-`T` *extends* [`AnyObject`](#../type-aliases/AnyObject)[]
-
-### Parameters
-
-### objects
-
-...`T`
-
-### Returns
-
-`MergeAll`\<`T`\>
-
-  ### <a id="isJsonArray"></a>isJsonArray
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function isJsonArray(value): value is JsonArray;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-## Returns
-
-`value is JsonArray`
-
-  ### <a id="isJsonObject"></a>isJsonObject
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function isJsonObject(value): value is JsonObject;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-## Returns
-
-`value is JsonObject`
-
-  ### <a id="isJsonValue"></a>isJsonValue
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function isJsonValue(value): value is JsonValue;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-## Returns
-
-`value is JsonValue`
-
-  ### <a id="isObject"></a>isObject
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function isObject<T>(value): value is T & object;
-```
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### value
-
-`T`
-
-## Returns
-
-`value is T & object`
-
-  ### <a id="isType"></a>isType
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function isType(value, expectedType): boolean;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-### expectedType
-
-`FieldType`
-
-## Returns
-
-`boolean`
-
-  ### <a id="isValidJsonFieldPair"></a>isValidJsonFieldPair
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function isValidJsonFieldPair(__namedParameters): boolean;
-```
-
-## Parameters
-
-### \_\_namedParameters
-
-\[`unknown`, `unknown`\]
-
-## Returns
-
-`boolean`
-
-  ### <a id="omitBy"></a>omitBy
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function omitBy<T>(
-   obj, 
-   predicate, 
-maxDepth): Partial<T>;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-## Parameters
-
-### obj
-
-`T`
-
-### predicate
-
-[`OmitByPredicate`](#../type-aliases/OmitByPredicate)
-
-### maxDepth
-
-`number` = `1`
-
-## Returns
-
-`Partial`\<`T`\>
-
-  ### <a id="omitByPrefix"></a>omitByPrefix
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function omitByPrefix<T, P>(
-   payload, 
-   prefix, 
-maxDepth): DeepOmitStartsWith<T, P>;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-### P
-
-`P` *extends* `string`
-
-## Parameters
-
-### payload
-
-`T`
-
-### prefix
-
-`P`
-
-### maxDepth
-
-`number` = `100`
-
-## Returns
-
-[`DeepOmitStartsWith`](#../type-aliases/DeepOmitStartsWith)\<`T`, `P`\>
-
-  ### <a id="pickBy"></a>pickBy
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function pickBy<T>(
-   obj, 
-   predicate, 
-maxDepth): Partial<T>;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-## Parameters
-
-### obj
-
-`T`
-
-### predicate
-
-[`PickByPredicate`](#../type-aliases/PickByPredicate)
-
-### maxDepth
-
-`number` = `1`
-
-## Returns
-
-`Partial`\<`T`\>
-
-  ### <a id="pickByPrefix"></a>pickByPrefix
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function pickByPrefix<T, P>(
-   payload, 
-   prefix, 
-maxDepth): DeepPickStartsWith<T, P>;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-### P
-
-`P` *extends* `string`
-
-## Parameters
-
-### payload
-
-`T`
-
-### prefix
-
-`P`
-
-### maxDepth
-
-`number` = `100`
-
-## Returns
-
-[`DeepPickStartsWith`](#../type-aliases/DeepPickStartsWith)\<`T`, `P`\>
-
-  ### <a id="removeFields"></a>removeFields
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function removeFields<T, K>(obj, fields): Omit<T, K>;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-### K
-
-`K` *extends* `string` \| `number` \| `symbol`
-
-## Parameters
-
-### obj
-
-`T`
-
-### fields
-
-`K`[]
-
-## Returns
-
-`Omit`\<`T`, `K`\>
-
-  ### <a id="toJson"></a>toJson
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function toJson(value, maxDepth): JsonValue;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-### maxDepth
-
-`number` = `3`
-
-## Returns
-
-[`JsonValue`](#../type-aliases/JsonValue)
-
-  ### <a id="toJsonArray"></a>toJsonArray
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function toJsonArray(
-   value, 
-   cycleList?, 
-   maxDepth?): JsonArray;
-```
-
-## Parameters
-
-### value
-
-`unknown`[]
-
-### cycleList?
-
-`unknown`[]
-
-### maxDepth?
-
-`number` = `3`
-
-## Returns
-
-[`JsonArray`](#../type-aliases/JsonArray)
-
-  ### <a id="toJsonObject"></a>toJsonObject
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function toJsonObject(
-   value, 
-   cycleList?, 
-   maxDepth?): JsonObject;
-```
-
-## Parameters
-
-### value
-
-`object`
-
-### cycleList?
-
-`unknown`[]
-
-### maxDepth?
-
-`number` = `3`
-
-## Returns
-
-[`JsonObject`](#../type-aliases/JsonObject)
-
-  ### <a id="toJsonString"></a>toJsonString
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function toJsonString(value, maxDepth): string;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-### maxDepth
-
-`number` = `3`
-
-## Returns
-
-`string`
-
-  ### <a id="toJsonValue"></a>toJsonValue
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-function toJsonValue(
-   value, 
-   cycleList?, 
-   maxDepth?): JsonValue;
-```
-
-## Parameters
-
-### value
-
-`unknown`
-
-### cycleList?
-
-`unknown`[]
-
-### maxDepth?
-
-`number` = `3`
-
-## Returns
-
-[`JsonValue`](#../type-aliases/JsonValue)
-
-### interfaces
-
-  ### <a id="ObjectTypeConfig"></a>ObjectTypeConfig
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Extends
-
-- [`TypeCheckConfig`](#TypeCheckConfig)
-
-## Properties
-
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-### Inherited from
-
-[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
-
-  ### <a id="TypeCheckConfig"></a>TypeCheckConfig
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Extended by
-
-- [`ObjectTypeConfig`](#ObjectTypeConfig)
-- [`TypeCheckRequiredConfig`](#TypeCheckRequiredConfig)
-- [`TypeCheckOptionalConfig`](#TypeCheckOptionalConfig)
-
-## Properties
-
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-  ### <a id="TypeCheckOptionalConfig"></a>TypeCheckOptionalConfig
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Extends
-
-- [`TypeCheckConfig`](#TypeCheckConfig)
-
-## Properties
-
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-### Inherited from
-
-[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
-
-***
-
-### required
-
-```ts
-required: false;
-```
-
-  ### <a id="TypeCheckRequiredConfig"></a>TypeCheckRequiredConfig
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Extends
-
-- [`TypeCheckConfig`](#TypeCheckConfig)
-
-## Properties
-
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-### Inherited from
-
-[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
-
-***
-
-### required
-
-```ts
-required: true;
-```
-
-  ### <a id="Validator"></a>Validator
-
-[**@xylabs/object**](#../README)
-
-***
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) = [`AnyObject`](#../type-aliases/AnyObject)
-
-## Methods
-
-### validate()
-
-```ts
-validate(payload): Promisable<Error[]>;
-```
-
-### Parameters
-
-#### payload
-
-`T`
-
-### Returns
-
-`Promisable`\<`Error`[]\>
-
-### type-aliases
-
-  ### <a id="AnyObject"></a>AnyObject
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-type AnyObject = Record<TypedKey, unknown>;
-```
-
-Any object, which means that it does not enforce the set of fields that it has.  Extending from AnyObject
-will result in a type that includes the universal set of field names
-
-  ### <a id="AsOptionalTypeFunction"></a>AsOptionalTypeFunction
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-type AsOptionalTypeFunction<T> = <TType>(value) => undefined | TType;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `AnyNonPromise` = `AnyNonPromise`
-
-## Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-## Parameters
-
-### value
-
-`AnyNonPromise`
-
-## Returns
-
-`undefined` \| `TType`
-
-  ### <a id="AsTypeFunction"></a>AsTypeFunction
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-type AsTypeFunction<T> = {
-<TType>  (value): undefined | TType;
-<TType>  (value, config): TType;
-<TType>  (value, config): undefined | TType;
-<TType>  (value, assert): undefined | TType;
-<TType>  (value, assert, config): TType;
-<TType>  (value, assert, config): undefined | TType;
-};
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `AnyNonPromise` = `AnyNonPromise`
-
-## Call Signature
-
-```ts
-<TType>(value): undefined | TType;
-```
-
-### Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-### Parameters
-
-### value
-
-`AnyNonPromise`
-
-### Returns
-
-`undefined` \| `TType`
-
-## Call Signature
-
-```ts
-<TType>(value, config): TType;
-```
-
-### Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-### Parameters
-
-### value
-
-`AnyNonPromise`
-
-### config
-
-[`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig)
-
-### Returns
-
-`TType`
-
-## Call Signature
-
-```ts
-<TType>(value, config): undefined | TType;
-```
-
-### Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-### Parameters
-
-### value
-
-`AnyNonPromise`
-
-### config
-
-[`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig)
-
-### Returns
-
-`undefined` \| `TType`
-
-## Call Signature
-
-```ts
-<TType>(value, assert): undefined | TType;
-```
-
-### Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-### Parameters
-
-### value
-
-`AnyNonPromise`
-
-### assert
-
-[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
-
-### Returns
-
-`undefined` \| `TType`
-
-## Call Signature
-
-```ts
-<TType>(
-   value, 
-   assert, 
-   config): TType;
-```
-
-### Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-### Parameters
-
-### value
-
-`AnyNonPromise`
-
-### assert
-
-[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
-
-### config
-
-[`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig)
-
-### Returns
-
-`TType`
-
-## Call Signature
-
-```ts
-<TType>(
-   value, 
-   assert, 
-   config): undefined | TType;
-```
-
-### Type Parameters
-
-### TType
-
-`TType` *extends* `AnyNonPromise`
-
-### Parameters
-
-### value
-
-`AnyNonPromise`
-
-### assert
-
-[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
-
-### config
-
-[`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig)
-
-### Returns
-
-`undefined` \| `TType`
-
-  ### <a id="Compare"></a>Compare
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-type Compare<T> = (a, b) => number;
-```
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
+## Interfaces
 
-### a
+- [ZodFactoryConfigObject](#interfaces/ZodFactoryConfigObject)
 
-`T`
+## Type Aliases
 
-### b
+- [ZodFactoryConfig](#type-aliases/ZodFactoryConfig)
+- [AllZodFactories](#type-aliases/AllZodFactories)
 
-`T`
+## Functions
 
-## Returns
+- [zodAllFactory](#functions/zodAllFactory)
+- [zodAsAsyncFactory](#functions/zodAsAsyncFactory)
+- [zodAsFactory](#functions/zodAsFactory)
+- [zodIsFactory](#functions/zodIsFactory)
+- [zodToAsyncFactory](#functions/zodToAsyncFactory)
+- [zodToFactory](#functions/zodToFactory)
 
-`number`
+### functions
 
-  ### <a id="DeepOmitStartsWith"></a>DeepOmitStartsWith
+  ### <a id="zodAllFactory"></a>zodAllFactory
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-type DeepOmitStartsWith<T, Prefix> = T extends infer U[] ? DeepOmitStartsWith<U, Prefix>[] : T extends object ? { [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? never : K : K]: DeepOmitStartsWith<T[K], Prefix> } : T;
+function zodAllFactory<T, TName>(zod, name): object;
 ```
 
+**`Alpha`**
+
 ## Type Parameters
 
 ### T
 
 `T`
 
-### Prefix
-
-`Prefix` *extends* `string`
-
-  ### <a id="DeepPickStartsWith"></a>DeepPickStartsWith
+### TName
 
-[**@xylabs/object**](#../README)
+`TName` *extends* `string`
 
-***
+## Parameters
 
-```ts
-type DeepPickStartsWith<T, Prefix> = T extends infer U[] ? DeepPickStartsWith<U, Prefix>[] : T extends object ? { [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? K : never : K]: DeepPickStartsWith<T[K], Prefix> } : T;
-```
+### zod
 
-## Type Parameters
+`ZodType`\<`T`\>
 
-### T
+### name
 
-`T`
+`TName`
 
-### Prefix
+## Returns
 
-`Prefix` *extends* `string`
+`object`
 
-  ### <a id="DeepRestrictToStringKeys"></a>DeepRestrictToStringKeys
+  ### <a id="zodAsAsyncFactory"></a>zodAsAsyncFactory
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-type DeepRestrictToStringKeys<T> = { [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToStringKeys<U>[] : T[K] extends object ? DeepRestrictToStringKeys<T[K]> : T[K] };
+function zodAsAsyncFactory<TZod>(zod, name): {
+<T>  (value): Promise<T & TZod | undefined>;
+<T>  (value, assert): Promise<T & TZod>;
+};
 ```
 
 ## Type Parameters
 
-### T
-
-`T`
-
-  ### <a id="EmptyObject"></a>EmptyObject
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-type EmptyObject<T> = { [K in keyof T]?: never };
-```
+### TZod
 
-An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
-extended from, which then adds only those additional fields
+`TZod`
 
-## Type Parameters
+## Parameters
 
-### T
+### zod
 
-`T` *extends* `object` = `object`
+`ZodType`\<`TZod`\>
 
-  ### <a id="EmptyObjectOf"></a>EmptyObjectOf
+### name
 
-[**@xylabs/object**](#../README)
+`string`
 
-***
+## Returns
 
 ```ts
-type EmptyObjectOf<T> = EmptyObject<T> extends T ? EmptyObject<T> : never;
+<T>(value): Promise<T & TZod | undefined>;
 ```
 
-## Type Parameters
+### Type Parameters
 
 ### T
 
-`T` *extends* `object`
+`T`
 
-  ### <a id="JsonArray"></a>JsonArray
+### Parameters
 
-[**@xylabs/object**](#../README)
+### value
 
-***
+`T`
+
+### Returns
+
+`Promise`\<`T` & `TZod` \| `undefined`\>
 
 ```ts
-type JsonArray = JsonValue[];
+<T>(value, assert): Promise<T & TZod>;
 ```
 
-  ### <a id="JsonObject"></a>JsonObject
+### Type Parameters
 
-[**@xylabs/object**](#../README)
+### T
 
-***
+`T`
 
-```ts
-type JsonObject = object;
-```
+### Parameters
 
-## Index Signature
+### value
 
-```ts
-[key: string]: JsonValue
-```
+`T`
 
-  ### <a id="JsonValue"></a>JsonValue
+### assert
 
-[**@xylabs/object**](#../README)
+[`ZodFactoryConfig`](#../type-aliases/ZodFactoryConfig)
 
-***
+### Returns
 
-```ts
-type JsonValue = 
-  | string
-  | number
-  | boolean
-  | null
-  | JsonObject
-  | JsonArray;
-```
+`Promise`\<`T` & `TZod`\>
 
-  ### <a id="OmitByPredicate"></a>OmitByPredicate
+  ### <a id="zodAsFactory"></a>zodAsFactory
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-type OmitByPredicate<T> = (value, key) => boolean;
+function zodAsFactory<TZod>(zod, name): {
+<T>  (value): T & TZod | undefined;
+<T>  (value, assert): T & TZod;
+};
 ```
 
 ## Type Parameters
 
-### T
+### TZod
 
-`T` *extends* [`EmptyObject`](#EmptyObject) = `Record`\<`string`, `unknown`\>
+`TZod`
 
 ## Parameters
 
-### value
+### zod
 
-`T`\[keyof `T`\]
+`ZodType`\<`TZod`\>
 
-### key
+### name
 
-keyof `T`
+`string`
 
 ## Returns
 
-`boolean`
-
-  ### <a id="OmitStartsWith"></a>OmitStartsWith
-
-[**@xylabs/object**](#../README)
-
-***
-
 ```ts
-type OmitStartsWith<T, Prefix> = { [K in keyof T as K extends `${Prefix}${string}` ? never : K]: T[K] };
+<T>(value): T & TZod | undefined;
 ```
 
-## Type Parameters
+### Type Parameters
 
 ### T
 
 `T`
 
-### Prefix
+### Parameters
 
-`Prefix` *extends* `string`
+### value
 
-  ### <a id="Optional"></a>Optional
+`T`
 
-[**@xylabs/object**](#../README)
+### Returns
 
-***
+`T` & `TZod` \| `undefined`
 
 ```ts
-type Optional<T, F> = Omit<T, F> & Partial<Pick<T, F>>;
+<T>(value, assert): T & TZod;
 ```
 
-## Type Parameters
+### Type Parameters
 
 ### T
 
-`T` *extends* `object`
-
-### F
-
-`F` *extends* keyof `T`
-
-  ### <a id="Override"></a>Override
-
-[**@xylabs/object**](#../README)
+`T`
 
-***
+### Parameters
 
-```ts
-type Override<T1, T2> = Omit<T1, keyof T2> & T2;
-```
+### value
 
-## Type Parameters
+`T`
 
-### T1
+### assert
 
-`T1`
+[`ZodFactoryConfig`](#../type-aliases/ZodFactoryConfig)
 
-### T2
+### Returns
 
-`T2`
+`T` & `TZod`
 
-  ### <a id="PartialRecord"></a>PartialRecord
+  ### <a id="zodIsFactory"></a>zodIsFactory
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-type PartialRecord<K, T> = { [P in K]?: T };
+function zodIsFactory<TZod>(zod): <T>(value) => value is T & TZod;
 ```
 
 ## Type Parameters
 
-### K
-
-`K` *extends* keyof `any`
-
-### T
-
-`T`
+### TZod
 
-## Deprecated
+`TZod`
 
-use Partial<Record<>> instead
+## Parameters
 
-  ### <a id="PickByPredicate"></a>PickByPredicate
+### zod
 
-[**@xylabs/object**](#../README)
+`ZodType`\<`TZod`\>
 
-***
+## Returns
 
 ```ts
-type PickByPredicate<T> = (value, key) => boolean;
+<T>(value): value is T & TZod;
 ```
 
-## Type Parameters
+### Type Parameters
 
 ### T
 
-`T` *extends* [`EmptyObject`](#EmptyObject) = `Record`\<`string`, `unknown`\>
+`T`
 
-## Parameters
+### Parameters
 
 ### value
 
-`T`\[keyof `T`\]
-
-### key
-
-keyof `T`
-
-## Returns
-
-`boolean`
-
-  ### <a id="PickStartsWith"></a>PickStartsWith
-
-[**@xylabs/object**](#../README)
-
-***
-
-```ts
-type PickStartsWith<T, Prefix> = { [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K] };
-```
-
-## Type Parameters
-
-### T
-
 `T`
 
-### Prefix
+### Returns
 
-`Prefix` *extends* `string`
+`value is T & TZod`
 
-  ### <a id="StringKeyObject"></a>StringKeyObject
+  ### <a id="zodToAsyncFactory"></a>zodToAsyncFactory
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-type StringKeyObject<T> = object;
+function zodToAsyncFactory<TZod>(zod, name): {
+<T>  (value): Promise<T & TZod | undefined>;
+<T>  (value, assert): Promise<T & TZod>;
+};
 ```
 
 ## Type Parameters
 
-### T
-
-`T` = `unknown`
-
-## Index Signature
-
-```ts
-[key: string]: T
-```
-
-  ### <a id="StringOrAlertFunction"></a>StringOrAlertFunction
-
-[**@xylabs/object**](#../README)
+### TZod
 
-***
-
-```ts
-type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
-```
+`TZod`
 
-## Type Parameters
+## Parameters
 
-### T
+### zod
 
-`T` *extends* `AnyNonPromise`
+`ZodType`\<`TZod`\>
 
-  ### <a id="TypeCheck"></a>TypeCheck
+### name
 
-[**@xylabs/object**](#../README)
+`string`
 
-***
+## Returns
 
 ```ts
-type TypeCheck<T> = {
-  (obj): obj is T;
-  (obj, config): obj is T;
-  (obj, config): obj is T;
-};
+<T>(value): Promise<T & TZod | undefined>;
 ```
 
-## Type Parameters
+### Type Parameters
 
 ### T
 
-`T` *extends* `TypedValue`
-
-## Call Signature
-
-```ts
-(obj): obj is T;
-```
+`T`
 
 ### Parameters
 
-### obj
+### value
 
-`AnyNonPromise`
+`T`
 
 ### Returns
 
-`obj is T`
-
-## Call Signature
+`Promise`\<`T` & `TZod` \| `undefined`\>
 
 ```ts
-(obj, config): obj is T;
+<T>(value, assert): Promise<T & TZod>;
 ```
 
-### Parameters
-
-### obj
-
-`AnyNonPromise`
-
-### config
-
-[`TypeCheckConfig`](#../interfaces/TypeCheckConfig)
-
-### Returns
-
-`obj is T`
+### Type Parameters
 
-## Call Signature
+### T
 
-```ts
-(obj, config): obj is T;
-```
+`T`
 
 ### Parameters
 
-### obj
+### value
 
-`AnyNonPromise`
+`T`
 
-### config
+### assert
 
-`undefined` | `number` | [`TypeCheckConfig`](#../interfaces/TypeCheckConfig)
+[`ZodFactoryConfig`](#../type-aliases/ZodFactoryConfig)
 
 ### Returns
 
-`obj is T`
+`Promise`\<`T` & `TZod`\>
 
-  ### <a id="WithAdditional"></a>WithAdditional
+  ### <a id="zodToFactory"></a>zodToFactory
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-type WithAdditional<T, TAdditional> = TAdditional extends EmptyObject ? T & TAdditional : T;
+function zodToFactory<TZod>(zod, name): {
+<T>  (value): T & TZod | undefined;
+<T>  (value, assert): T & TZod;
+};
 ```
 
 ## Type Parameters
 
-### T
-
-`T` *extends* [`EmptyObject`](#EmptyObject) \| `void`
+### TZod
 
-### TAdditional
+`TZod`
 
-`TAdditional` *extends* [`EmptyObject`](#EmptyObject) \| `void` = `void`
-
-### variables
-
-  ### <a id="AsObjectFactory"></a>AsObjectFactory
+## Parameters
 
-[**@xylabs/object**](#../README)
+### zod
 
-***
+`ZodType`\<`TZod`\>
 
-```ts
-const AsObjectFactory: object;
-```
+### name
 
-## Type declaration
+`string`
 
-### create()
+## Returns
 
 ```ts
-create: <T>(typeCheck) => AsTypeFunction<T>;
+<T>(value): T & TZod | undefined;
 ```
 
 ### Type Parameters
 
-#### T
+### T
 
-`T` *extends* `TypedObject`
+`T`
 
 ### Parameters
 
-#### typeCheck
+### value
 
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
+`T`
 
 ### Returns
 
-[`AsTypeFunction`](#../type-aliases/AsTypeFunction)\<`T`\>
-
-### createOptional()
+`T` & `TZod` \| `undefined`
 
 ```ts
-createOptional: <T>(typeCheck) => (value) => undefined | T;
+<T>(value, assert): T & TZod;
 ```
 
 ### Type Parameters
 
-#### T
+### T
 
-`T` *extends* `TypedObject`
+`T`
 
 ### Parameters
 
-#### typeCheck
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-### Returns
+### value
 
-```ts
-(value): undefined | T;
-```
+`T`
 
-#### Parameters
+### assert
 
-##### value
+[`ZodFactoryConfig`](#../type-aliases/ZodFactoryConfig)
 
-`AnyNonPromise`
+### Returns
 
-#### Returns
+`T` & `TZod`
 
-`undefined` \| `T`
+### interfaces
 
-  ### <a id="AsTypeFactory"></a>AsTypeFactory
+  ### <a id="ZodFactoryConfigObject"></a>ZodFactoryConfigObject
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
-```ts
-const AsTypeFactory: object;
-```
-
-## Type declaration
-
-### create()
-
-```ts
-create: <T>(typeCheck) => AsTypeFunction<T>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `AnyNonPromise`
-
-### Parameters
-
-#### typeCheck
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-### Returns
-
-[`AsTypeFunction`](#../type-aliases/AsTypeFunction)\<`T`\>
+## Properties
 
-### createOptional()
+### name
 
 ```ts
-createOptional: <T>(typeCheck) => (value) => undefined | T;
+name: string;
 ```
 
-### Type Parameters
-
-#### T
-
-`T` *extends* `AnyNonPromise`
-
-### Parameters
+### type-aliases
 
-#### typeCheck
+  ### <a id="AllZodFactories"></a>AllZodFactories
 
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
+[**@xylabs/zod**](#../README)
 
-### Returns
+***
 
 ```ts
-(value): undefined | T;
+type AllZodFactories<TType, TName> = { [K in `is${TName}`]: ReturnType<typeof zodIsFactory> } & { [K in `as${TName}`]: ReturnType<typeof zodAsFactory> } & { [K in `to${TName}`]: ReturnType<typeof zodToFactory> };
 ```
 
-#### Parameters
+**`Alpha`**
 
-##### value
-
-`AnyNonPromise`
-
-#### Returns
-
-`undefined` \| `T`
+## Type Parameters
 
-  ### <a id="asAnyObject"></a>asAnyObject
+### TType
 
-[**@xylabs/object**](#../README)
+`TType`
 
-***
+### TName
 
-```ts
-const asAnyObject: AsTypeFunction<AnyObject>;
-```
+`TName` *extends* `string`
 
-  ### <a id="deepMerge"></a>deepMerge
+  ### <a id="ZodFactoryConfig"></a>ZodFactoryConfig
 
-[**@xylabs/object**](#../README)
+[**@xylabs/zod**](#../README)
 
 ***
 
 ```ts
-const deepMerge: <T>(...objects) => MergeAll<T>;
+type ZodFactoryConfig = 
+  | AssertConfig
+  | ZodFactoryConfigObject;
 ```
 
-Deeply merges multiple objects into a new object.
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`AnyObject`](#../type-aliases/AnyObject)[]
-
-## Parameters
-
-### objects
-
-...`T`
-
-Multiple objects to merge deeply.
-The function merges properties from all objects into a new object.
-If a property exists in multiple objects, the last object's value will be used.
-If a property is an object, it will be merged recursively.
-If a property is an array, it will be overwritten by the last object's value.
-If a property is a primitive value, it will be overwritten by the last object's value.
-If a property is undefined in the source, it will be skipped.
-If a property is a symbol, it will be merged as well.
-
-## Returns
-
-`MergeAll`\<`T`\>
-
-A new object with the merged properties.
-
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
@@ -1833,8 +495,8 @@ Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
 [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/object.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/object
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/zod.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/zod
 [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
 [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
 [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
@@ -1842,11 +504,11 @@ Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
 [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/object
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/object
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/zod
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/zod
 
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/object/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/object
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/zod/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/zod
 
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/object
-[socket-link]: https://socket.dev/npm/package/@xylabs/object
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/zod
+[socket-link]: https://socket.dev/npm/package/@xylabs/zod