@orpc/zod 0.41.1 → 0.41.2

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 (4) hide show
  1. package/README.md +132 -0
  2. package/dist/index.js +10 -9
  3. package/dist/src/coercer.d.ts +8 -3
  4. package/package.json +5 -5
package/README.md ADDED
@@ -0,0 +1,132 @@
1
+ <div align="center">
2
+ <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
3
+ </div>
4
+
5
+ <h1></h1>
6
+
7
+ <div align="center">
8
+ <a href="https://codecov.io/gh/unnoq/orpc">
9
+ <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
10
+ </a>
11
+ <a href="https://www.npmjs.com/package/@orpc/zod">
12
+ <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fzod?logo=npm" />
13
+ </a>
14
+ <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
15
+ <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
16
+ </a>
17
+ <a href="https://discord.gg/TXEbwRBvQn">
18
+ <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
19
+ </a>
20
+ </div>
21
+
22
+ <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
+
24
+ **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.
25
+
26
+ ---
27
+
28
+ ## Highlights
29
+
30
+ - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
31
+ - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
32
+ - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
+ - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
+ - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
+ - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
36
+ - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
+ - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
+ - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
39
+ - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
40
+ - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
41
+ - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
42
+ - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
43
+ - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
44
+ - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
45
+ - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
46
+
47
+ ## Documentation
48
+
49
+ You can find the full documentation [here](https://orpc.unnoq.com).
50
+
51
+ ## Packages
52
+
53
+ - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
+ - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
+ - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
56
+ - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
+ - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
58
+ - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
+ - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
+ - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
61
+
62
+ ## `@orpc/zod`
63
+
64
+ More schemas that [Zod](https://zod.dev/) doesn't support yet, and provides `ZodToJsonSchemaConverter` for generating OpenAPI specs.
65
+
66
+ ### More Schemas
67
+
68
+ - `oz.url`: Zod schema for [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) instance.
69
+ - `oz.blob`: Zod schema for [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) instance.
70
+ - `oz.file`: Zod schema for [File](https://developer.mozilla.org/en-US/docs/Web/API/File) instance.
71
+ - `oz.regexp`: Zod schema for [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) instance.
72
+
73
+ ```ts
74
+ import { oz } from '@orpc/zod'
75
+ import { z } from 'zod'
76
+
77
+ const Example = z.object({
78
+ url: oz.url(),
79
+ blob: oz.blob(),
80
+ file: oz.file().type('image/png'),
81
+ regexp: oz.regexp(),
82
+ })
83
+ ```
84
+
85
+ ### Generate OpenAPI Spec
86
+
87
+ ```ts
88
+ import { OpenAPIGenerator } from '@orpc/openapi'
89
+ import { ZodToJsonSchemaConverter } from '@orpc/zod'
90
+
91
+ const openAPIGenerator = new OpenAPIGenerator({
92
+ schemaConverters: [new ZodToJsonSchemaConverter()],
93
+ })
94
+
95
+ const specFromContract = await openAPIGenerator.generate(contract, {
96
+ info: {
97
+ title: 'My App',
98
+ version: '0.0.0',
99
+ },
100
+ })
101
+
102
+ const specFromRouter = await openAPIGenerator.generate(router, {
103
+ info: {
104
+ title: 'My App',
105
+ version: '0.0.0',
106
+ },
107
+ })
108
+ ```
109
+
110
+ ### Extending the Specification
111
+
112
+ ```ts
113
+ import { oz } from '@orpc/zod'
114
+ import { z } from 'zod'
115
+
116
+ const InputSchema = oz.openapi(
117
+ z.object({
118
+ name: z.string(),
119
+ }),
120
+ {
121
+ examples: [
122
+ { name: 'Earth' },
123
+ { name: 'Mars' },
124
+ ],
125
+ // additional options...
126
+ }
127
+ )
128
+ ```
129
+
130
+ ## License
131
+
132
+ Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
package/dist/index.js CHANGED
@@ -42,16 +42,16 @@ import { guard, isObject } from "@orpc/shared";
42
42
  import {
43
43
  ZodFirstPartyTypeKind
44
44
  } from "zod";
45
- var ZodAutoCoercePlugin = class {
46
- beforeCreateProcedureClient(clientOptions) {
47
- clientOptions.interceptors ??= [];
48
- clientOptions.interceptors.unshift((options) => {
49
- const inputSchema = options.procedure["~orpc"].inputSchema;
45
+ var ZodSmartCoercionPlugin = class {
46
+ init(options) {
47
+ options.clientInterceptors ??= [];
48
+ options.clientInterceptors.unshift((options2) => {
49
+ const inputSchema = options2.procedure["~orpc"].inputSchema;
50
50
  if (!inputSchema || inputSchema["~standard"].vendor !== "zod") {
51
- return options.next();
51
+ return options2.next();
52
52
  }
53
- const coercedInput = zodCoerceInternal(inputSchema, options.input, { bracketNotation: true });
54
- return options.next({ ...options, input: coercedInput });
53
+ const coercedInput = zodCoerceInternal(inputSchema, options2.input, { bracketNotation: true });
54
+ return options2.next({ ...options2, input: coercedInput });
55
55
  });
56
56
  }
57
57
  };
@@ -962,7 +962,8 @@ export {
962
962
  NON_LOGIC_KEYWORDS,
963
963
  UNDEFINED_JSON_SCHEMA,
964
964
  UNSUPPORTED_JSON_SCHEMA,
965
- ZodAutoCoercePlugin,
965
+ ZodSmartCoercionPlugin as ZodAutoCoercePlugin,
966
+ ZodSmartCoercionPlugin,
966
967
  ZodToJsonSchemaConverter,
967
968
  blob,
968
969
  file,
package/dist/src/coercer.d.ts CHANGED
@@ -1,7 +1,12 @@
1
1
  import type { Context } from '@orpc/server';
2
2
  import type { Plugin } from '@orpc/server/plugins';
3
- import type { WellCreateProcedureClientOptions } from '@orpc/server/standard';
4
- export declare class ZodAutoCoercePlugin<TContext extends Context> implements Plugin<TContext> {
5
- beforeCreateProcedureClient(clientOptions: WellCreateProcedureClientOptions<TContext>): void;
3
+ import type { StandardHandlerOptions } from '@orpc/server/standard';
4
+ export declare class ZodSmartCoercionPlugin<TContext extends Context> implements Plugin<TContext> {
5
+ init(options: StandardHandlerOptions<TContext>): void;
6
6
  }
7
+ export {
8
+ /**
9
+ * @deprecated ZodAutoCoercePlugin has renamed to ZodSmartCoercionPlugin
10
+ */
11
+ ZodSmartCoercionPlugin as ZodAutoCoercePlugin, };
7
12
  //# sourceMappingURL=coercer.d.ts.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/zod",
3
3
  "type": "module",
4
- "version": "0.41.1",
4
+ "version": "0.41.2",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -29,16 +29,16 @@
29
29
  "dist"
30
30
  ],
31
31
  "peerDependencies": {
32
- "@orpc/server": "0.41.1",
33
- "@orpc/contract": "0.41.1",
34
- "@orpc/openapi": "0.41.1"
32
+ "@orpc/contract": "0.41.2",
33
+ "@orpc/server": "0.41.2",
34
+ "@orpc/openapi": "0.41.2"
35
35
  },
36
36
  "dependencies": {
37
37
  "@standard-schema/spec": "^1.0.0",
38
38
  "json-schema-typed": "^8.0.1",
39
39
  "wildcard-match": "^5.1.3",
40
40
  "zod": "^3.24.1",
41
- "@orpc/shared": "0.41.1"
41
+ "@orpc/shared": "0.41.2"
42
42
  },
43
43
  "scripts": {
44
44
  "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",