@express-zod-api/zod-plugin 1.1.0-beta.1 → 1.2.0-beta.1

package/CHANGELOG.md

@@ -2,9 +2,13 @@
 
 ## Version 1
 
+### v1.2.0
+
+- Changed bundler from `tsup` to `tsdown`.
+
 ### v1.1.0
 
-- Added low-level helpers `pack()` and `unpack()` to handle inheritable metadata that withstands refinements:
+- Added low-level helpers `pack()` and `unpack()` to handle inheritable attributes that withstands refinements:
   - `schema.brand()` is a shorthand for `pack(schema, { brand })`;
   - `getBrand()` is a shorthand for `unpack(schema).brand`.
 

package/README.md

@@ -35,5 +35,5 @@ schema.meta(); // { examples: ["test", "another"] }
 ## Helpers
 
 - `getBrand()` — retrieves the brand from the schema that was set by its `.brand()` method;
-- `pack()` — returns a cloned schema having inheritable metadata assigned (such as brand);
-- `unpack()` — retrieves the metadata from the schema that was set by `pack()` helper.
+- `pack()` — returns a cloned schema having inheritable attributes assigned (such as brand);
+- `unpack()` — retrieves the attributes from the schema that was set by `pack()` helper.

package/dist/augmentation.d.ts

@@ -0,0 +1,48 @@
+import { z } from "zod";
+
+//#region remap.d.ts
+type TuplesFromObject<T> = { [P in keyof T]: [P, T[P]] }[keyof T];
+type GetKeyByValue<T, V> = TuplesFromObject<T> extends infer TT ? TT extends [infer P, V] ? P : never : never;
+/**
+ * @fileoverview Mapping utils for Zod Runtime Plugin (remap)
+ * @link https://stackoverflow.com/questions/55454125/typescript-remapping-object-properties-in-typesafe
+ * @todo try to reuse R.Remap from Ramda (requires to move its types to prod dependencies)
+ */
+type Remap<T, U extends { [P in keyof T]?: V }, V extends string> = { [P in NonNullable<U[keyof U]>]: T[GetKeyByValue<U, P>] };
+type Intact<T, U> = { [K in Exclude<keyof T, keyof U>]: T[K] };
+//#endregion
+//#region augmentation.d.ts
+declare module "zod/v4/core" {
+  interface GlobalMeta {
+    default?: unknown;
+    examples?: unknown[];
+  }
+}
+/**
+ * @fileoverview Zod Runtime Plugin
+ * @see https://github.com/colinhacks/zod/blob/90efe7fa6135119224412c7081bd12ef0bccef26/plugin/effect/src/index.ts#L21-L31
+ * @desc This code modifies and extends zod's functionality immediately when importing the plugin.
+ * @desc Enables .example() and .deprecated() on all schemas (ZodType)
+ * @desc Enables .label() on ZodDefault
+ * @desc Enables .remap() on ZodObject
+ * @desc Stores the argument supplied to .brand() on all schemas (runtime distinguishable branded types)
+ * */
+declare module "zod" {
+  interface ZodType<out Output = unknown, out Input = unknown, out Internals extends z.core.$ZodTypeInternals<Output, Input> = z.core.$ZodTypeInternals<Output, Input>> extends z.core.$ZodType<Output, Input, Internals> {
+    /** @desc Shorthand for .meta({ examples }) */
+    example(example: z.output<this>): this;
+    deprecated(): this;
+  }
+  interface ZodDefault<T extends z.core.SomeType = z.core.$ZodType> extends z._ZodType<z.core.$ZodDefaultInternals<T>>, z.core.$ZodDefault<T> {
+    /** @desc Shorthand for .meta({ default }) */
+    label(label: string): this;
+  }
+  interface ZodObject<out Shape extends z.core.$ZodShape = z.core.$ZodLooseShape, out Config extends z.core.$ZodObjectConfig = z.core.$strip> extends z._ZodType<z.core.$ZodObjectInternals<Shape, Config>>, z.core.$ZodObject<Shape, Config> {
+    remap<V extends string, U extends { [P in keyof Shape]?: V }>(mapping: U): z.ZodPipe<z.ZodPipe<this, z.ZodTransform>,
+    // internal type simplified
+    z.ZodObject<Remap<Shape, U, V> & Intact<Shape, U>, Config>>;
+    remap<U extends z.core.$ZodShape>(mapper: (subject: Shape) => U): z.ZodPipe<z.ZodPipe<this, z.ZodTransform>, z.ZodObject<U>>;
+  }
+}
+//#endregion
+export {};

package/dist/index.d.ts

@@ -1,76 +1,28 @@
-import { z } from 'zod';
+import './augmentation.js';
+import { z } from "zod";
 
-type TuplesFromObject<T> = {
-    [P in keyof T]: [P, T[P]];
-}[keyof T];
-type GetKeyByValue<T, V> = TuplesFromObject<T> extends infer TT ? TT extends [infer P, V] ? P : never : never;
-/**
- * @fileoverview Mapping utils for Zod Runtime Plugin (remap)
- * @link https://stackoverflow.com/questions/55454125/typescript-remapping-object-properties-in-typesafe
- * @todo try to reuse R.Remap from Ramda (requires to move its types to prod dependencies)
- */
-type Remap<T, U extends {
-    [P in keyof T]?: V;
-}, V extends string> = {
-    [P in NonNullable<U[keyof U]>]: T[GetKeyByValue<U, P>];
-};
-type Intact<T, U> = {
-    [K in Exclude<keyof T, keyof U>]: T[K];
-};
-
-declare module "zod/v4/core" {
-    interface GlobalMeta {
-        default?: unknown;
-        examples?: unknown[];
-    }
-}
-/**
- * @fileoverview Zod Runtime Plugin
- * @see https://github.com/colinhacks/zod/blob/90efe7fa6135119224412c7081bd12ef0bccef26/plugin/effect/src/index.ts#L21-L31
- * @desc This code modifies and extends zod's functionality immediately when importing the plugin.
- * @desc Enables .example() and .deprecated() on all schemas (ZodType)
- * @desc Enables .label() on ZodDefault
- * @desc Enables .remap() on ZodObject
- * @desc Stores the argument supplied to .brand() on all schemas (runtime distinguishable branded types)
- * */
-declare module "zod" {
-    interface ZodType<out Output = unknown, out Input = unknown, out Internals extends z.core.$ZodTypeInternals<Output, Input> = z.core.$ZodTypeInternals<Output, Input>> extends z.core.$ZodType<Output, Input, Internals> {
-        /** @desc Shorthand for .meta({ examples }) */
-        example(example: z.output<this>): this;
-        deprecated(): this;
-    }
-    interface ZodDefault<T extends z.core.SomeType = z.core.$ZodType> extends z._ZodType<z.core.$ZodDefaultInternals<T>>, z.core.$ZodDefault<T> {
-        /** @desc Shorthand for .meta({ default }) */
-        label(label: string): this;
-    }
-    interface ZodObject<out Shape extends z.core.$ZodShape = z.core.$ZodLooseShape, out Config extends z.core.$ZodObjectConfig = z.core.$strip> extends z._ZodType<z.core.$ZodObjectInternals<Shape, Config>>, z.core.$ZodObject<Shape, Config> {
-        remap<V extends string, U extends {
-            [P in keyof Shape]?: V;
-        }>(mapping: U): z.ZodPipe<z.ZodPipe<this, z.ZodTransform>, // internal type simplified
-        z.ZodObject<Remap<Shape, U, V> & Intact<Shape, U>, Config>>;
-        remap<U extends z.core.$ZodShape>(mapper: (subject: Shape) => U): z.ZodPipe<z.ZodPipe<this, z.ZodTransform>, z.ZodObject<U>>;
-    }
-}
+//#region packer.d.ts
 
 /**
  * @public
- * @desc Attaches an inheritable metadata to the schema (withstands refinements).
+ * @desc Attaches an inheritable attributes to the schema (withstands refinements).
  */
 declare const pack: <T extends z.ZodType, B extends object>(subject: T, bag: B) => T & {
-    _zod: {
-        bag: T["_zod"]["bag"] & B;
-    };
+  _zod: {
+    bag: T["_zod"]["bag"] & B;
+  };
 };
 /**
  * @public
- * @desc Retrieves the metadata attached to the schema by pack() method.
+ * @desc Retrieves the attributes attached to the schema by pack() method.
  */
 declare const unpack: <T extends z.core.$ZodType>(subject: T) => T["_zod"]["bag"];
-
+//#endregion
+//#region brand.d.ts
 /**
  * @public
  * @desc Retrieves the brand from the schema set by its .brand() method.
  * */
 declare const getBrand: (subject: z.core.$ZodType) => string | number | symbol | undefined;
-
-export { getBrand, pack, unpack };
+//#endregion
+export { getBrand, pack, unpack };

package/dist/index.js

@@ -1 +1 @@
-import{globalRegistry as k,z as n}from"zod";var d="@express-zod-api/zod-plugin";import{z as f}from"zod";var a=(e,t)=>{let i=f.core.$constructor("$Packer",(s,r)=>{f.core.$ZodCheck.init(s,r),s._zod.onattach.push(b=>{Object.assign(b._zod.bag,r.bag)}),s._zod.check=()=>{}});return e.check(new i({check:"$Packer",bag:t}))},p=e=>e._zod.bag;var l="brand",u=function(e){return a(this,{[l]:e})},T=e=>{let{[l]:t}=p(e)||{};if(typeof t=="symbol"||typeof t=="string"||typeof t=="number")return t};import{z as c}from"zod";import*as o from"ramda";var y=function(e){let t=typeof e=="function"?e:o.renameKeys(o.reject(o.isNil,e)),i=t(o.map(o.invoker(0,"clone"),this._zod.def.shape)),r=(this._zod.def.catchall instanceof c.ZodUnknown?c.looseObject:c.object)(i);return this.transform(t).pipe(r)};var z=function(e){let t=k.get(this)?.examples?.slice()||[];return t.push(e),this.meta({examples:t})},g=function(){return this.meta({deprecated:!0})},x=function(e){return this.meta({default:e})},m=Symbol.for(d);if(!(m in globalThis)){globalThis[m]=!0;for(let e of Object.keys(n)){if(!e.startsWith("Zod")||/(Success|Error|Function)$/.test(e))continue;let t=n[e];typeof t=="function"&&Object.defineProperties(t.prototype,{example:{value:z,writable:!1},deprecated:{value:g,writable:!1},brand:{set(){},get(){return u.bind(this)}}})}Object.defineProperty(n.ZodDefault.prototype,"label",{value:x,writable:!1}),Object.defineProperty(n.ZodObject.prototype,"remap",{value:y,writable:!1})}export{T as getBrand,a as pack,p as unpack};
+import{globalRegistry as e,z as t}from"zod";import*as n from"ramda";var r=`@express-zod-api/zod-plugin`;const i=(e,n)=>{let r=t.core.$constructor(`$Packer`,(e,n)=>{t.core.$ZodCheck.init(e,n),e._zod.onattach.push(e=>{Object.assign(e._zod.bag,n.bag)}),e._zod.check=()=>{}});return e.check(new r({check:`$Packer`,bag:n}))},a=e=>e._zod.bag,o=`brand`,s=function(e){return i(this,{[o]:e})},c=e=>{let{[o]:t}=a(e)||{};if(typeof t==`symbol`||typeof t==`string`||typeof t==`number`)return t},l=function(e){let r=typeof e==`function`?e:n.renameKeys(n.reject(n.isNil,e)),i=r(n.map(n.invoker(0,`clone`),this._zod.def.shape)),a=this._zod.def.catchall instanceof t.ZodUnknown,o=(a?t.looseObject:t.object)(i);return this.transform(r).pipe(o)},u=function(t){let n=e.get(this)?.examples?.slice()||[];return n.push(t),this.meta({examples:n})},d=function(){return this.meta({deprecated:!0})},f=function(e){return this.meta({default:e})},p=Symbol.for(r);if(!(p in globalThis)){globalThis[p]=!0;for(let e of Object.keys(t)){if(!e.startsWith(`Zod`)||/(Success|Error|Function)$/.test(e))continue;let n=t[e];if(typeof n!=`function`)continue;Object.defineProperties(n.prototype,{example:{value:u,writable:!1},deprecated:{value:d,writable:!1},brand:{set(){},get(){return s.bind(this)}}})}Object.defineProperty(t.ZodDefault.prototype,`label`,{value:f,writable:!1}),Object.defineProperty(t.ZodObject.prototype,`remap`,{value:l,writable:!1})}export{c as getBrand,i as pack,a as unpack};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@express-zod-api/zod-plugin",
-  "version": "1.1.0-beta.1",
+  "version": "1.2.0-beta.1",
   "license": "MIT",
   "description": "Zod plugin for express-zod-api",
   "sideEffects": true,
@@ -51,7 +51,6 @@
   "scripts": {
     "pretest": "tsc --noEmit",
     "test": "vitest run",
-    "build": "tsup",
-    "postbuild": "attw --pack --profile esm-only"
+    "build": "tsdown"
   }
 }