npm - @xylabs/zod - Versions diffs - 7.0.6 → 8.0.0 - Mend

@xylabs/zod 7.0.6 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +1 -371
package/package.json +4 -4

package/README.md CHANGED Viewed

@@ -1,373 +1,3 @@
-> **Deprecated.** Use [`@ariestools/sdk`](../../ariestools-sdk/README.md) instead. This package is a backward-compatibility re-export shim.
-[![logo][]](https://xylabs.com)
 # @xylabs/zod
-[![npm][npm-badge]][npm-link]
-[![license][license-badge]][license-link]
-> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
-## Install
-Using npm:
-```sh
-npm install @xylabs/zod
-```
-Using yarn:
-```sh
-yarn add @xylabs/zod
-```
-Using pnpm:
-```sh
-pnpm add @xylabs/zod
-```
-Using bun:
-```sh
-bun add @xylabs/zod
-```
-## License
-See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-## Reference
-### packages
-  ### zod
-    ### .temp-typedoc
-      ### functions
-        ### <a id="zodAllFactory"></a>zodAllFactory
-[**@xylabs/zod**](#../README)
-***
-```ts
-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
-`T`
-### TName
-`TName` *extends* `string`
-## Parameters
-### zod
-`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)
-***
-```ts
-function zodAsAsyncFactory<TZod>(zod, name): {
-<T>  (value): Promise<T & TZod | undefined>;
-<T>  (value, assert): Promise<T & TZod>;
-};
-```
-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
-`TZod`
-## Parameters
-### zod
-`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
-\{
-\<`T`\>  (`value`): `Promise`\<`T` & `TZod` \| `undefined`\>;
-\<`T`\>  (`value`, `assert`): `Promise`\<`T` & `TZod`\>;
-\}
-        ### <a id="zodAsFactory"></a>zodAsFactory
-[**@xylabs/zod**](#../README)
-***
-```ts
-function zodAsFactory<TZod>(zod, name): {
-<T>  (value): T & TZod | undefined;
-<T>  (value, assert): T & TZod;
-};
-```
-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
-`TZod`
-## Parameters
-### zod
-`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
-\{
-\<`T`\>  (`value`): `T` & `TZod` \| `undefined`;
-\<`T`\>  (`value`, `assert`): `T` & `TZod`;
-\}
-        ### <a id="zodIsFactory"></a>zodIsFactory
-[**@xylabs/zod**](#../README)
-***
-```ts
-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
-`TZod`
-## Parameters
-### zod
-`ZodType`\<`TZod`\>
-The zod schema to validate against
-## Returns
-A type guard function that returns true if the value passes validation
-\<`T`\>(`value`) => `value is T & TZod`
-        ### <a id="zodToAsyncFactory"></a>zodToAsyncFactory
-[**@xylabs/zod**](#../README)
-***
-```ts
-function zodToAsyncFactory<TZod>(zod, name): {
-<T>  (value): Promise<T & TZod | undefined>;
-<T>  (value, assert): Promise<T & TZod>;
-};
-```
-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
-`TZod`
-## Parameters
-### zod
-`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
-\{
-\<`T`\>  (`value`): `Promise`\<`T` & `TZod` \| `undefined`\>;
-\<`T`\>  (`value`, `assert`): `Promise`\<`T` & `TZod`\>;
-\}
-        ### <a id="zodToFactory"></a>zodToFactory
-[**@xylabs/zod**](#../README)
-***
-```ts
-function zodToFactory<TZod>(zod, name): {
-<T>  (value): T & TZod | undefined;
-<T>  (value, assert): T & TZod;
-};
-```
-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
-`TZod`
-## Parameters
-### zod
-`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
-\{
-\<`T`\>  (`value`): `T` & `TZod` \| `undefined`;
-\<`T`\>  (`value`, `assert`): `T` & `TZod`;
-\}
-      ### interfaces
-        ### <a id="ZodFactoryConfigObject"></a>ZodFactoryConfigObject
-[**@xylabs/zod**](#../README)
-***
-Configuration object for zod factory functions, providing a name for error messages.
-## Properties
-### name
-```ts
-name: string;
-```
-      ### type-aliases
-        ### <a id="AllZodFactories"></a>AllZodFactories
-[**@xylabs/zod**](#../README)
-***
-```ts
-type AllZodFactories<TType, TName> = Record<`is${TName}`, ReturnType<typeof zodIsFactory>> & Record<`as${TName}`, ReturnType<typeof zodAsFactory>> & Record<`to${TName}`, ReturnType<typeof zodToFactory>>;
-```
-**`Alpha`**
-## Type Parameters
-### TType
-`TType`
-### TName
-`TName` *extends* `string`
-        ### <a id="ZodFactoryConfig"></a>ZodFactoryConfig
-[**@xylabs/zod**](#../README)
-***
-```ts
-type ZodFactoryConfig =
-  | AssertConfig
-  | ZodFactoryConfigObject;
-```
-Configuration for zod factory assertion behavior, either an AssertConfig or a named config object.
-## Credits
-[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/zod.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/zod
-[license-badge]: https://img.shields.io/npm/l/@xylabs/zod.svg
-[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+DEPRECATED — use `@ariestools/sdk/zod` instead.

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/zod",
-  "version": "7.0.6",
+  "version": "8.0.0",
   "description": "DEPRECATED — use @ariestools/sdk/zod. Backward-compatibility re-export shim.",
   "keywords": [
     "xylabs",
@@ -44,13 +44,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@ariestools/sdk": "~7.0.6"
+    "@ariestools/sdk": "~8.0.0"
   },
   "devDependencies": {
     "@opentelemetry/api": "~1.9.1",
     "@opentelemetry/sdk-trace-base": "~2.9.0",
-    "@xylabs/toolchain": "~8.6.0",
-    "@xylabs/tsconfig": "~8.6.0",
+    "@xylabs/toolchain": "~8.6.2",
+    "@xylabs/tsconfig": "~8.6.2",
     "async-mutex": "~0.5.0",
     "browserslist": "~4.28.4",
     "eslint": "~10.6.0",