@orpc/zod 0.0.0-next.d42488d → 0.0.0-next.d5f0415

package/README.md

@@ -0,0 +1,132 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/zod">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fzod?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+
+---
+
+## Highlights
+
+- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
+- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
+- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
+- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
+- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
+- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
+- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
+- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
+- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
+- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
+- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
+- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
+- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
+- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
+- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/zod`
+
+More schemas that [Zod](https://zod.dev/) doesn't support yet, and provides `ZodToJsonSchemaConverter` for generating OpenAPI specs.
+
+### More Schemas
+
+- `oz.url`: Zod schema for [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) instance.
+- `oz.blob`: Zod schema for [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) instance.
+- `oz.file`: Zod schema for [File](https://developer.mozilla.org/en-US/docs/Web/API/File) instance.
+- `oz.regexp`: Zod schema for [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) instance.
+
+```ts
+import { oz } from '@orpc/zod'
+import { z } from 'zod'
+
+const Example = z.object({
+  url: oz.url(),
+  blob: oz.blob(),
+  file: oz.file().type('image/png'),
+  regexp: oz.regexp(),
+})
+```
+
+### Generate OpenAPI Spec
+
+```ts
+import { OpenAPIGenerator } from '@orpc/openapi'
+import { ZodToJsonSchemaConverter } from '@orpc/zod'
+
+const openAPIGenerator = new OpenAPIGenerator({
+  schemaConverters: [new ZodToJsonSchemaConverter()],
+})
+
+const specFromContract = await openAPIGenerator.generate(contract, {
+  info: {
+    title: 'My App',
+    version: '0.0.0',
+  },
+})
+
+const specFromRouter = await openAPIGenerator.generate(router, {
+  info: {
+    title: 'My App',
+    version: '0.0.0',
+  },
+})
+```
+
+### Extending the Specification
+
+```ts
+import { oz } from '@orpc/zod'
+import { z } from 'zod'
+
+const InputSchema = oz.openapi(
+  z.object({
+    name: z.string(),
+  }),
+  {
+    examples: [
+      { name: 'Earth' },
+      { name: 'Mars' },
+    ],
+    // additional options...
+  }
+)
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.js

@@ -1,44 +1,58 @@
-// ../../node_modules/.pnpm/is-what@5.0.2/node_modules/is-what/dist/getType.js
-function getType(payload) {
-  return Object.prototype.toString.call(payload).slice(8, -1);
-}
-
-// ../../node_modules/.pnpm/is-what@5.0.2/node_modules/is-what/dist/isPlainObject.js
-function isPlainObject(payload) {
-  if (getType(payload) !== "Object")
-    return false;
-  const prototype = Object.getPrototypeOf(payload);
-  return !!prototype && prototype.constructor === Object && prototype === Object.prototype;
-}
-
-// ../../node_modules/.pnpm/radash@12.1.0/node_modules/radash/dist/esm/async.mjs
-var guard = (func, shouldGuard) => {
-  const _guard = (err) => {
-    if (shouldGuard && !shouldGuard(err))
-      throw err;
-    return void 0;
-  };
-  const isPromise2 = (result) => result instanceof Promise;
-  try {
-    const result = func();
-    return isPromise2(result) ? result.catch(_guard) : result;
-  } catch (err) {
-    return _guard(err);
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
+  return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// ../../node_modules/.pnpm/escape-string-regexp@4.0.0/node_modules/escape-string-regexp/index.js
+var require_escape_string_regexp = __commonJS({
+  "../../node_modules/.pnpm/escape-string-regexp@4.0.0/node_modules/escape-string-regexp/index.js"(exports, module) {
+    "use strict";
+    module.exports = (string) => {
+      if (typeof string !== "string") {
+        throw new TypeError("Expected a string");
+      }
+      return string.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&").replace(/-/g, "\\x2d");
+    };
+  }
+});
 
 // src/coercer.ts
+import { guard, isObject } from "@orpc/shared";
 import {
   ZodFirstPartyTypeKind
 } from "zod";
-var ZodCoercer = class {
-  coerce(schema, value) {
-    if (!schema || schema["~standard"].vendor !== "zod") {
-      return value;
-    }
-    const zodSchema = schema;
-    const coerced = zodCoerceInternal(zodSchema, value, { bracketNotation: true });
-    return coerced;
+var ZodSmartCoercionPlugin = class {
+  init(options) {
+    options.clientInterceptors ??= [];
+    options.clientInterceptors.unshift((options2) => {
+      const inputSchema = options2.procedure["~orpc"].inputSchema;
+      if (!inputSchema || inputSchema["~standard"].vendor !== "zod") {
+        return options2.next();
+      }
+      const coercedInput = zodCoerceInternal(inputSchema, options2.input, { bracketNotation: true });
+      return options2.next({ ...options2, input: coercedInput });
+    });
   }
 };
 function zodCoerceInternal(schema, value, options) {
@@ -125,7 +139,7 @@ function zodCoerceInternal(schema, value, options) {
       if (value === void 0) {
         return [];
       }
-      if (isPlainObject(value) && Object.keys(value).every((k) => /^[1-9]\d*$/.test(k) || k === "0")) {
+      if (isObject(value) && Object.keys(value).every((k) => /^[1-9]\d*$/.test(k) || k === "0")) {
         const indexes = Object.keys(value).map((k) => Number(k)).sort((a, b) => a - b);
         const arr = Array.from({ length: (indexes.at(-1) ?? -1) + 1 });
         for (const i of indexes) {
@@ -136,7 +150,7 @@ function zodCoerceInternal(schema, value, options) {
     }
   } else if (typeName === ZodFirstPartyTypeKind.ZodObject) {
     const schema_ = schema;
-    if (isPlainObject(value)) {
+    if (isObject(value)) {
       const newObj = {};
       const keys = /* @__PURE__ */ new Set([
         ...Object.keys(value),
@@ -174,7 +188,7 @@ function zodCoerceInternal(schema, value, options) {
       if (value === void 0) {
         return /* @__PURE__ */ new Set();
       }
-      if (isPlainObject(value) && Object.keys(value).every((k) => /^[1-9]\d*$/.test(k) || k === "0")) {
+      if (isObject(value) && Object.keys(value).every((k) => /^[1-9]\d*$/.test(k) || k === "0")) {
         const indexes = Object.keys(value).map((k) => Number(k)).sort((a, b) => a - b);
         const arr = Array.from({ length: (indexes.at(-1) ?? -1) + 1 });
         for (const i of indexes) {
@@ -197,9 +211,9 @@ function zodCoerceInternal(schema, value, options) {
       if (value === void 0) {
         return /* @__PURE__ */ new Map();
       }
-      if (isPlainObject(value)) {
+      if (isObject(value)) {
         const arr = Array.from({ length: Object.keys(value).length }).fill(void 0).map(
-          (_, i) => isPlainObject(value[i]) && Object.keys(value[i]).length === 2 && "0" in value[i] && "1" in value[i] ? [value[i]["0"], value[i]["1"]] : void 0
+          (_, i) => isObject(value[i]) && Object.keys(value[i]).length === 2 && "0" in value[i] && "1" in value[i] ? [value[i]["0"], value[i]["1"]] : void 0
         );
         if (arr.every((v) => !!v)) {
           return new Map(
@@ -213,7 +227,7 @@ function zodCoerceInternal(schema, value, options) {
     }
   } else if (typeName === ZodFirstPartyTypeKind.ZodRecord) {
     const schema_ = schema;
-    if (isPlainObject(value)) {
+    if (isObject(value)) {
       const newObj = {};
       for (const [k, v] of Object.entries(value)) {
         const key = zodCoerceInternal(schema_._def.keyType, k, options_);
@@ -341,17 +355,8 @@ function zodCoerceInternal(schema, value, options) {
 }
 
 // src/converter.ts
+var import_escape_string_regexp = __toESM(require_escape_string_regexp(), 1);
 import { JSONSchemaFormat } from "@orpc/openapi";
-
-// ../../node_modules/.pnpm/escape-string-regexp@5.0.0/node_modules/escape-string-regexp/index.js
-function escapeStringRegexp(string) {
-  if (typeof string !== "string") {
-    throw new TypeError("Expected a string");
-  }
-  return string.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&").replace(/-/g, "\\x2d");
-}
-
-// src/converter.ts
 import {
   ZodFirstPartyTypeKind as ZodFirstPartyTypeKind2
 } from "zod";
@@ -528,6 +533,16 @@ function zodToJsonSchema(schema, options) {
     return {};
   }
   const schema__ = schema;
+  if (!options?.isHandledZodDescription && "description" in schema__._def) {
+    const json = zodToJsonSchema(schema__, {
+      ...options,
+      isHandledZodDescription: true
+    });
+    return {
+      description: schema__._def.description,
+      ...json
+    };
+  }
   if (!options?.isHandledCustomJSONSchema) {
     const customJSONSchema = getCustomJSONSchema(schema__._def, options);
     if (customJSONSchema) {
@@ -541,7 +556,7 @@ function zodToJsonSchema(schema, options) {
       };
     }
   }
-  const childOptions = { ...options, isHandledCustomJSONSchema: false };
+  const childOptions = { ...options, isHandledCustomJSONSchema: false, isHandledZodDescription: false };
   const customType = getCustomZodType(schema__._def);
   switch (customType) {
     case "Blob": {
@@ -601,13 +616,13 @@ function zodToJsonSchema(schema, options) {
             json.maxLength = check.value;
             break;
           case "includes":
-            json.pattern = escapeStringRegexp(check.value);
+            json.pattern = (0, import_escape_string_regexp.default)(check.value);
             break;
           case "startsWith":
-            json.pattern = `^${escapeStringRegexp(check.value)}`;
+            json.pattern = `^${(0, import_escape_string_regexp.default)(check.value)}`;
             break;
           case "endsWith":
-            json.pattern = `${escapeStringRegexp(check.value)}$`;
+            json.pattern = `${(0, import_escape_string_regexp.default)(check.value)}$`;
             break;
           case "emoji":
             json.pattern = "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$";
@@ -714,6 +729,7 @@ function zodToJsonSchema(schema, options) {
       const schema_ = schema__;
       const def = schema_._def;
       const json = { type: "array" };
+      json.items = zodToJsonSchema(def.type, childOptions);
       if (def.exactLength) {
         json.maxItems = def.exactLength.value;
         json.minItems = def.exactLength.value;
@@ -946,7 +962,8 @@ export {
   NON_LOGIC_KEYWORDS,
   UNDEFINED_JSON_SCHEMA,
   UNSUPPORTED_JSON_SCHEMA,
-  ZodCoercer,
+  ZodSmartCoercionPlugin as ZodAutoCoercePlugin,
+  ZodSmartCoercionPlugin,
   ZodToJsonSchemaConverter,
   blob,
   file,

package/dist/src/coercer.d.ts

@@ -1,6 +1,12 @@
-import type { Schema } from '@orpc/contract';
-import type { SchemaCoercer } from '@orpc/openapi/fetch';
-export declare class ZodCoercer implements SchemaCoercer {
-    coerce(schema: Schema, value: unknown): unknown;
+import type { Context } from '@orpc/server';
+import type { Plugin } from '@orpc/server/plugins';
+import type { StandardHandlerOptions } from '@orpc/server/standard';
+export declare class ZodSmartCoercionPlugin<TContext extends Context> implements Plugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
 }
+export { 
+/**
+ * @deprecated ZodAutoCoercePlugin has renamed to ZodSmartCoercionPlugin
+ */
+ZodSmartCoercionPlugin as ZodAutoCoercePlugin, };
 //# sourceMappingURL=coercer.d.ts.map

package/dist/src/converter.d.ts

@@ -35,6 +35,12 @@ export interface ZodToJsonSchemaOptions {
      * @internal
      */
     isHandledCustomJSONSchema?: boolean;
+    /**
+     * Track if current level schema is handled zod description to prevent recursive
+     *
+     * @internal
+     */
+    isHandledZodDescription?: boolean;
 }
 export declare function zodToJsonSchema(schema: StandardSchemaV1, options?: ZodToJsonSchemaOptions): Exclude<JSONSchema.JSONSchema, boolean>;
 export declare class ZodToJsonSchemaConverter implements SchemaConverter {

package/dist/src/schemas.d.ts

@@ -10,7 +10,7 @@ export declare function getCustomJSONSchema(def: ZodTypeDef, options?: {
     mode?: 'input' | 'output';
 }): Exclude<JSONSchema, boolean> | undefined;
 export declare function file(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>> & {
-    type: (mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)) => ZodEffects<ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>>, InstanceType<typeof File>, InstanceType<typeof File>>;
+    type(mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodEffects<ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>>, InstanceType<typeof File>, InstanceType<typeof File>>;
 };
 export declare function blob(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<InstanceType<typeof Blob>, ZodTypeDef, InstanceType<typeof Blob>>;
 export declare function invalidDate(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<Date, ZodTypeDef, Date>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/zod",
   "type": "module",
-  "version": "0.0.0-next.d42488d",
+  "version": "0.0.0-next.d5f0415",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -29,12 +29,16 @@
     "dist"
   ],
   "peerDependencies": {
-    "@orpc/openapi": "0.0.0-next.d42488d"
+    "@orpc/openapi": "0.0.0-next.d5f0415",
+    "@orpc/contract": "0.0.0-next.d5f0415",
+    "@orpc/server": "0.0.0-next.d5f0415"
   },
   "dependencies": {
+    "@standard-schema/spec": "^1.0.0",
     "json-schema-typed": "^8.0.1",
     "wildcard-match": "^5.1.3",
-    "zod": "^3.24.1"
+    "zod": "^3.24.1",
+    "@orpc/shared": "0.0.0-next.d5f0415"
   },
   "scripts": {
     "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",