@express-zod-api/zod-plugin 3.0.0-beta.2 → 4.0.0-beta.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 4
+
+### v4.0.0
+
+- Supported `zod` versions: `^4.3.4`;
+- Zod made metadata inheritable, so that `pack()` and `unpack()` are removed;
+  - Use the `.meta()` method of a schema instead of both helpers;
+- Runtime distinguishable brand is now stored along with other metadata.
+
 ## Version 3
 
 ### v3.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Anna Bocharova
+Copyright (c) 2026 Anna Bocharova
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,12 +13,12 @@ This module extends Zod functionality when it's imported:
 - Adds `.remap()` method to `ZodObject` for renaming object properties:
   - Supports a mapping object or an object transforming function as an argument;
   - Relies on `R.renameKeys()` from the `ramda` library;
-- Alters the `.brand()` method on all Zod schemas by making the assigned brand available in runtime:
-  - The brand set this way will withstand refinements, unlike the metadata set by `.meta()`.
+- Alters the `.brand()` method on all Zod schemas:
+  - shorthand for `.meta({ "x-brand": ... })` making the brand available in runtime via `getBrand()` helper;
 
 ## Requirements
 
-- Zod `^4.1.13`
+- Zod `^4.3.4`
 
 ## Basic usage
 
@@ -29,11 +29,9 @@ import { getBrand } from "@express-zod-api/zod-plugin";
 const schema = z.string().example("test").example("another").brand("custom");
 
 getBrand(schema); // "custom"
-schema.meta(); // { examples: ["test", "another"] }
+schema.meta(); // { examples: ["test", "another"], "x-brand": "custom" }
 ```
 
 ## Helpers
 
-- `getBrand()` — retrieves the brand from the schema that was set by its `.brand()` method;
-- `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.
+- `getBrand()` — retrieves the brand from the schema that was set by its `.brand()` method.

package/dist/index.d.ts

@@ -1,28 +1,12 @@
 import './augmentation.js';
 import { z } from "zod";
 
-//#region src/packer.d.ts
-
-/**
- * @public
- * @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;
-  };
-};
-/**
- * @public
- * @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 src/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;
 //#endregion
-export { getBrand, pack, unpack };
+export { getBrand };

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@express-zod-api/zod-plugin",
-  "version": "3.0.0-beta.2",
+  "version": "4.0.0-beta.2",
   "license": "MIT",
   "description": "Zod plugin for express-zod-api",
   "sideEffects": true,
@@ -36,13 +36,13 @@
     "ramda": "^0.32.0"
   },
   "peerDependencies": {
-    "zod": "^4.1.13"
+    "zod": "^4.3.4"
   },
   "devDependencies": {
-    "@types/ramda": "^0.31.0",
+    "@types/ramda": "^0.31.1",
     "camelize-ts": "^3.0.0",
-    "typescript": "^5.9.2",
-    "zod": "^4.1.13"
+    "typescript": "^5.9.3",
+    "zod": "^4.3.4"
   },
   "keywords": [
     "zod",