@express-zod-api/zod-plugin 1.0.0-beta.3 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Version 1
+
+### v1.0.0
+
+- First release: almost exact copy of Zod plugin from `express-zod-api`.

package/README.md

@@ -11,7 +11,7 @@ This module extends Zod functionality when it's imported:
 - Adds `.label()` method to `ZodDefault`:
   - shorthand for `.meta({ default: ... })`;
 - Adds `.remap()` method to `ZodObject` for renaming object properties:
-  - Supports a mapping objects or an object transforming function as an argument;
+  - 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 provided `getBrand()` method can retrieve the brand from the schema.

package/dist/index.d.ts

@@ -24,14 +24,23 @@ declare module "zod/v4/core" {
         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 Alias for .meta({examples}), but argument is typed to ensure the correct placement for transformations */
+        /** @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 Change the default value in the generated Documentation to a label, alias for .meta({ default }) */
+        /** @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> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@express-zod-api/zod-plugin",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0",
   "license": "MIT",
   "description": "Zod plugin for express-zod-api",
   "sideEffects": true,
@@ -41,6 +41,13 @@
     "typescript": "^5.8.3",
     "zod": "^4.0.0"
   },
+  "keywords": [
+    "zod",
+    "schema",
+    "validation",
+    "plugin",
+    "typescript"
+  ],
   "scripts": {
     "pretest": "tsc --noEmit",
     "test": "vitest run",