@orpc/openapi-client 0.0.0-next.73eeb92 → 0.0.0-next.752b165

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.
package/README.md CHANGED
@@ -21,28 +21,24 @@
21
21
 
22
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
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.
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
25
25
 
26
26
  ---
27
27
 
28
28
  ## Highlights
29
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, Solid, Svelte), 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.
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
34
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
37
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
38
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
+ - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
46
42
 
47
43
  ## Documentation
48
44
 
@@ -53,13 +49,12 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
53
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
56
54
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
57
- - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
58
- - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
59
- - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
60
- - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
55
+ - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
61
56
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
62
- - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
57
+ - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
63
58
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
64
59
  - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
65
60
  - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
@@ -1,15 +1,22 @@
1
1
  import { ClientContext } from '@orpc/client';
2
- import { AnyContractRouter } from '@orpc/contract';
3
2
  import { LinkFetchClientOptions } from '@orpc/client/fetch';
4
- import { StandardLink } from '@orpc/client/standard';
5
- import { f as StandardOpenAPILinkOptions } from '../../shared/openapi-client.N18yafE2.mjs';
3
+ import { AnyContractRouter } from '@orpc/contract';
4
+ import { g as StandardOpenAPILinkOptions, h as StandardOpenAPILink } from '../../shared/openapi-client.f2unmElJ.mjs';
5
+ import '@orpc/client/standard';
6
6
  import '@orpc/shared';
7
7
  import '@orpc/standard-server';
8
8
 
9
9
  interface OpenAPILinkOptions<T extends ClientContext> extends StandardOpenAPILinkOptions<T>, LinkFetchClientOptions<T> {
10
10
  }
11
- declare class OpenAPILink<T extends ClientContext> extends StandardLink<T> {
11
+ /**
12
+ * The OpenAPI Link for fetch runtime communicates with the server that follow the OpenAPI specification.
13
+ *
14
+ * @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
15
+ * @see {@link https://swagger.io/specification/ OpenAPI Specification}
16
+ */
17
+ declare class OpenAPILink<T extends ClientContext> extends StandardOpenAPILink<T> {
12
18
  constructor(contract: AnyContractRouter, options: OpenAPILinkOptions<T>);
13
19
  }
14
20
 
15
- export { OpenAPILink, type OpenAPILinkOptions };
21
+ export { OpenAPILink };
22
+ export type { OpenAPILinkOptions };
@@ -1,15 +1,22 @@
1
1
  import { ClientContext } from '@orpc/client';
2
- import { AnyContractRouter } from '@orpc/contract';
3
2
  import { LinkFetchClientOptions } from '@orpc/client/fetch';
4
- import { StandardLink } from '@orpc/client/standard';
5
- import { f as StandardOpenAPILinkOptions } from '../../shared/openapi-client.N18yafE2.js';
3
+ import { AnyContractRouter } from '@orpc/contract';
4
+ import { g as StandardOpenAPILinkOptions, h as StandardOpenAPILink } from '../../shared/openapi-client.f2unmElJ.js';
5
+ import '@orpc/client/standard';
6
6
  import '@orpc/shared';
7
7
  import '@orpc/standard-server';
8
8
 
9
9
  interface OpenAPILinkOptions<T extends ClientContext> extends StandardOpenAPILinkOptions<T>, LinkFetchClientOptions<T> {
10
10
  }
11
- declare class OpenAPILink<T extends ClientContext> extends StandardLink<T> {
11
+ /**
12
+ * The OpenAPI Link for fetch runtime communicates with the server that follow the OpenAPI specification.
13
+ *
14
+ * @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
15
+ * @see {@link https://swagger.io/specification/ OpenAPI Specification}
16
+ */
17
+ declare class OpenAPILink<T extends ClientContext> extends StandardOpenAPILink<T> {
12
18
  constructor(contract: AnyContractRouter, options: OpenAPILinkOptions<T>);
13
19
  }
14
20
 
15
- export { OpenAPILink, type OpenAPILinkOptions };
21
+ export { OpenAPILink };
22
+ export type { OpenAPILinkOptions };
@@ -1,19 +1,15 @@
1
1
  import { LinkFetchClient } from '@orpc/client/fetch';
2
- import { StandardLink } from '@orpc/client/standard';
3
- import { a as StandardOpenAPIJsonSerializer, b as StandardOpenapiLinkCodec, c as StandardOpenAPISerializer, S as StandardBracketNotationSerializer } from '../../shared/openapi-client.V75iq1Nn.mjs';
4
2
  import '@orpc/shared';
5
- import '@orpc/client';
6
3
  import '@orpc/contract';
4
+ import { b as StandardOpenAPILink } from '../../shared/openapi-client.D3eD5ojB.mjs';
5
+ import '@orpc/client';
6
+ import '@orpc/client/standard';
7
7
  import '@orpc/standard-server';
8
8
 
9
- class OpenAPILink extends StandardLink {
9
+ class OpenAPILink extends StandardOpenAPILink {
10
10
  constructor(contract, options) {
11
- const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
12
- const bracketNotationSerializer = new StandardBracketNotationSerializer();
13
- const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
14
- const linkCodec = new StandardOpenapiLinkCodec(contract, serializer, options);
15
11
  const linkClient = new LinkFetchClient(options);
16
- super(linkCodec, linkClient, options);
12
+ super(contract, linkClient, options);
17
13
  }
18
14
  }
19
15
 
@@ -1,10 +1,63 @@
1
- export { S as StandardBracketNotationSerialized, a as StandardBracketNotationSerializer, c as StandardOpenAPICustomJsonSerializer, b as StandardOpenAPIJsonSerialized, e as StandardOpenAPIJsonSerializer, d as StandardOpenAPIJsonSerializerOptions, f as StandardOpenAPILinkOptions, i as StandardOpenAPISerializeOptions, j as StandardOpenAPISerializer, h as StandardOpenapiLinkCodec, g as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.N18yafE2.mjs';
1
+ export { S as StandardBracketNotationSerialized, b as StandardBracketNotationSerializer, a as StandardBracketNotationSerializerOptions, d as StandardOpenAPICustomJsonSerializer, c as StandardOpenAPIJsonSerialized, f as StandardOpenAPIJsonSerializer, e as StandardOpenAPIJsonSerializerOptions, h as StandardOpenAPILink, g as StandardOpenAPILinkOptions, k as StandardOpenAPISerializeOptions, l as StandardOpenAPISerializer, j as StandardOpenapiLinkCodec, i as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.f2unmElJ.mjs';
2
2
  import { HTTPPath } from '@orpc/client';
3
3
  import '@orpc/client/standard';
4
4
  import '@orpc/contract';
5
5
  import '@orpc/shared';
6
6
  import '@orpc/standard-server';
7
7
 
8
+ /**
9
+ * parse a form data with bracket notation
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const form = new FormData()
14
+ * form.append('a', '1')
15
+ * form.append('user[name]', 'John')
16
+ * form.append('user[age]', '20')
17
+ * form.append('user[friends][]', 'Bob')
18
+ * form.append('user[friends][]', 'Alice')
19
+ * form.append('user[friends][]', 'Charlie')
20
+ * form.append('thumb', new Blob(['hello']), 'thumb.png')
21
+ *
22
+ * parseFormData(form)
23
+ * // {
24
+ * // a: '1',
25
+ * // user: {
26
+ * // name: 'John',
27
+ * // age: '20',
28
+ * // friends: ['Bob', 'Alice', 'Charlie'],
29
+ * // },
30
+ * // thumb: form.get('thumb'),
31
+ * // }
32
+ * ```
33
+ *
34
+ * @see {@link https://orpc.unnoq.com/docs/openapi/bracket-notation Bracket Notation Docs}
35
+ */
36
+ declare function parseFormData(form: FormData): any;
37
+ /**
38
+ * Get the issue message from the error.
39
+ *
40
+ * @param error - The error (can be anything) can contain `data.issues` (standard schema issues)
41
+ * @param path - The path of the field that has the issue follow [bracket notation](https://orpc.unnoq.com/docs/openapi/bracket-notation)
42
+ *
43
+ * @example
44
+ * ```tsx
45
+ * const { error, data, execute } = useServerAction(someAction)
46
+ *
47
+ * return <form action={(form) => execute(parseFormData(form))}>
48
+ * <input name="user[name]" type="text" />
49
+ * <p>{getIssueMessage(error, 'user[name]')}</p>
50
+ *
51
+ * <input name="user[age]" type="number" />
52
+ * <p>{getIssueMessage(error, 'user[age]')}</p>
53
+ *
54
+ * <input name="images[]" type="file" />
55
+ * <p>{getIssueMessage(error, 'images[]')}</p>
56
+ * </form>
57
+ *
58
+ */
59
+ declare function getIssueMessage(error: unknown, path: string): string | undefined;
60
+
8
61
  /**
9
62
  * @internal
10
63
  */
@@ -17,4 +70,4 @@ declare function getDynamicParams(path: HTTPPath | undefined): {
17
70
  name: string;
18
71
  }[] | undefined;
19
72
 
20
- export { getDynamicParams, standardizeHTTPPath };
73
+ export { getDynamicParams, getIssueMessage, parseFormData, standardizeHTTPPath };
@@ -1,10 +1,63 @@
1
- export { S as StandardBracketNotationSerialized, a as StandardBracketNotationSerializer, c as StandardOpenAPICustomJsonSerializer, b as StandardOpenAPIJsonSerialized, e as StandardOpenAPIJsonSerializer, d as StandardOpenAPIJsonSerializerOptions, f as StandardOpenAPILinkOptions, i as StandardOpenAPISerializeOptions, j as StandardOpenAPISerializer, h as StandardOpenapiLinkCodec, g as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.N18yafE2.js';
1
+ export { S as StandardBracketNotationSerialized, b as StandardBracketNotationSerializer, a as StandardBracketNotationSerializerOptions, d as StandardOpenAPICustomJsonSerializer, c as StandardOpenAPIJsonSerialized, f as StandardOpenAPIJsonSerializer, e as StandardOpenAPIJsonSerializerOptions, h as StandardOpenAPILink, g as StandardOpenAPILinkOptions, k as StandardOpenAPISerializeOptions, l as StandardOpenAPISerializer, j as StandardOpenapiLinkCodec, i as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.f2unmElJ.js';
2
2
  import { HTTPPath } from '@orpc/client';
3
3
  import '@orpc/client/standard';
4
4
  import '@orpc/contract';
5
5
  import '@orpc/shared';
6
6
  import '@orpc/standard-server';
7
7
 
8
+ /**
9
+ * parse a form data with bracket notation
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const form = new FormData()
14
+ * form.append('a', '1')
15
+ * form.append('user[name]', 'John')
16
+ * form.append('user[age]', '20')
17
+ * form.append('user[friends][]', 'Bob')
18
+ * form.append('user[friends][]', 'Alice')
19
+ * form.append('user[friends][]', 'Charlie')
20
+ * form.append('thumb', new Blob(['hello']), 'thumb.png')
21
+ *
22
+ * parseFormData(form)
23
+ * // {
24
+ * // a: '1',
25
+ * // user: {
26
+ * // name: 'John',
27
+ * // age: '20',
28
+ * // friends: ['Bob', 'Alice', 'Charlie'],
29
+ * // },
30
+ * // thumb: form.get('thumb'),
31
+ * // }
32
+ * ```
33
+ *
34
+ * @see {@link https://orpc.unnoq.com/docs/openapi/bracket-notation Bracket Notation Docs}
35
+ */
36
+ declare function parseFormData(form: FormData): any;
37
+ /**
38
+ * Get the issue message from the error.
39
+ *
40
+ * @param error - The error (can be anything) can contain `data.issues` (standard schema issues)
41
+ * @param path - The path of the field that has the issue follow [bracket notation](https://orpc.unnoq.com/docs/openapi/bracket-notation)
42
+ *
43
+ * @example
44
+ * ```tsx
45
+ * const { error, data, execute } = useServerAction(someAction)
46
+ *
47
+ * return <form action={(form) => execute(parseFormData(form))}>
48
+ * <input name="user[name]" type="text" />
49
+ * <p>{getIssueMessage(error, 'user[name]')}</p>
50
+ *
51
+ * <input name="user[age]" type="number" />
52
+ * <p>{getIssueMessage(error, 'user[age]')}</p>
53
+ *
54
+ * <input name="images[]" type="file" />
55
+ * <p>{getIssueMessage(error, 'images[]')}</p>
56
+ * </form>
57
+ *
58
+ */
59
+ declare function getIssueMessage(error: unknown, path: string): string | undefined;
60
+
8
61
  /**
9
62
  * @internal
10
63
  */
@@ -17,4 +70,4 @@ declare function getDynamicParams(path: HTTPPath | undefined): {
17
70
  name: string;
18
71
  }[] | undefined;
19
72
 
20
- export { getDynamicParams, standardizeHTTPPath };
73
+ export { getDynamicParams, getIssueMessage, parseFormData, standardizeHTTPPath };
@@ -1,6 +1,43 @@
1
- export { S as StandardBracketNotationSerializer, a as StandardOpenAPIJsonSerializer, c as StandardOpenAPISerializer, b as StandardOpenapiLinkCodec, g as getDynamicParams, s as standardizeHTTPPath } from '../../shared/openapi-client.V75iq1Nn.mjs';
2
- import '@orpc/shared';
3
- import '@orpc/client';
1
+ import { S as StandardBracketNotationSerializer } from '../../shared/openapi-client.D3eD5ojB.mjs';
2
+ export { a as StandardOpenAPIJsonSerializer, b as StandardOpenAPILink, d as StandardOpenAPISerializer, c as StandardOpenapiLinkCodec, g as getDynamicParams, s as standardizeHTTPPath } from '../../shared/openapi-client.D3eD5ojB.mjs';
3
+ import { isSchemaIssue } from '@orpc/contract';
4
+ import { isTypescriptObject } from '@orpc/shared';
4
5
  import '@orpc/client/standard';
5
- import '@orpc/contract';
6
+ import '@orpc/client';
6
7
  import '@orpc/standard-server';
8
+
9
+ function parseFormData(form) {
10
+ const serializer = new StandardBracketNotationSerializer();
11
+ return serializer.deserialize(Array.from(form.entries()));
12
+ }
13
+ function getIssueMessage(error, path) {
14
+ if (!isTypescriptObject(error) || !isTypescriptObject(error.data) || !Array.isArray(error.data.issues)) {
15
+ return void 0;
16
+ }
17
+ const serializer = new StandardBracketNotationSerializer();
18
+ for (const issue of error.data.issues) {
19
+ if (!isSchemaIssue(issue)) {
20
+ continue;
21
+ }
22
+ if (issue.path === void 0) {
23
+ if (path === "") {
24
+ return issue.message;
25
+ }
26
+ continue;
27
+ }
28
+ const issuePath = serializer.stringifyPath(
29
+ issue.path.map((segment) => typeof segment === "object" ? segment.key.toString() : segment.toString())
30
+ );
31
+ if (issuePath === path) {
32
+ return issue.message;
33
+ }
34
+ if (path.endsWith("[]") && issuePath.replace(/\[(?:0|[1-9]\d*)\]$/, "[]") === path) {
35
+ return issue.message;
36
+ }
37
+ if (path === "" && issuePath.match(/(?:0|[1-9]\d*)$/)) {
38
+ return issue.message;
39
+ }
40
+ }
41
+ }
42
+
43
+ export { StandardBracketNotationSerializer, getIssueMessage, parseFormData };
package/dist/index.d.mts CHANGED
@@ -4,6 +4,11 @@ type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends
4
4
  [K in keyof T]: JsonifiedValue<T[K]>;
5
5
  } : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
6
6
  type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [U extends undefined ? null : JsonifiedValue<U>, ...JsonifiedArray<V>] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
7
+ /**
8
+ * Convert types that JSON not support to corresponding json types
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
11
+ */
7
12
  type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
8
13
  [K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
9
14
  };
package/dist/index.d.ts CHANGED
@@ -4,6 +4,11 @@ type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends
4
4
  [K in keyof T]: JsonifiedValue<T[K]>;
5
5
  } : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
6
6
  type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [U extends undefined ? null : JsonifiedValue<U>, ...JsonifiedArray<V>] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
7
+ /**
8
+ * Convert types that JSON not support to corresponding json types
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
11
+ */
7
12
  type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
8
13
  [K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
9
14
  };
@@ -1,10 +1,14 @@
1
- import { isObject, value, get, isAsyncIteratorObject } from '@orpc/shared';
2
- import { isORPCErrorStatus, mapEventIterator, toORPCError, ORPCError as ORPCError$1 } from '@orpc/client';
3
- import { toHttpPath } from '@orpc/client/standard';
1
+ import { toHttpPath, getMalformedResponseErrorCode, StandardLink } from '@orpc/client/standard';
2
+ import { isObject, NullProtoObj, value, get, isAsyncIteratorObject } from '@orpc/shared';
3
+ import { isORPCErrorStatus, isORPCErrorJson, createORPCErrorFromJson, mapEventIterator, toORPCError } from '@orpc/client';
4
4
  import { isContractProcedure, fallbackContractConfig, ORPCError } from '@orpc/contract';
5
5
  import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  class StandardBracketNotationSerializer {
8
+ maxArrayIndex;
9
+ constructor(options = {}) {
10
+ this.maxArrayIndex = options.maxBracketNotationArrayIndex ?? 9999;
11
+ }
8
12
  serialize(data, segments = [], result = []) {
9
13
  if (Array.isArray(data)) {
10
14
  data.forEach((item, i) => {
@@ -34,20 +38,26 @@ class StandardBracketNotationSerializer {
34
38
  currentRef[nextSegment] = [];
35
39
  }
36
40
  if (i !== segments.length - 1) {
37
- if (Array.isArray(currentRef[nextSegment]) && !isValidArrayIndex(segment)) {
38
- currentRef[nextSegment] = { ...currentRef[nextSegment] };
41
+ if (Array.isArray(currentRef[nextSegment]) && !isValidArrayIndex(segment, this.maxArrayIndex)) {
42
+ if (arrayPushStyles.has(currentRef[nextSegment])) {
43
+ arrayPushStyles.delete(currentRef[nextSegment]);
44
+ currentRef[nextSegment] = pushStyleArrayToObject(currentRef[nextSegment]);
45
+ } else {
46
+ currentRef[nextSegment] = arrayToObject(currentRef[nextSegment]);
47
+ }
39
48
  }
40
49
  } else {
41
50
  if (Array.isArray(currentRef[nextSegment])) {
42
51
  if (segment === "") {
43
52
  if (currentRef[nextSegment].length && !arrayPushStyles.has(currentRef[nextSegment])) {
44
- currentRef[nextSegment] = { ...currentRef[nextSegment] };
53
+ currentRef[nextSegment] = arrayToObject(currentRef[nextSegment]);
45
54
  }
46
55
  } else {
47
56
  if (arrayPushStyles.has(currentRef[nextSegment])) {
48
- currentRef[nextSegment] = { "": currentRef[nextSegment].at(-1) };
49
- } else if (!isValidArrayIndex(segment)) {
50
- currentRef[nextSegment] = { ...currentRef[nextSegment] };
57
+ arrayPushStyles.delete(currentRef[nextSegment]);
58
+ currentRef[nextSegment] = pushStyleArrayToObject(currentRef[nextSegment]);
59
+ } else if (!isValidArrayIndex(segment, this.maxArrayIndex)) {
60
+ currentRef[nextSegment] = arrayToObject(currentRef[nextSegment]);
51
61
  }
52
62
  }
53
63
  }
@@ -55,12 +65,14 @@ class StandardBracketNotationSerializer {
55
65
  currentRef = currentRef[nextSegment];
56
66
  nextSegment = segment;
57
67
  });
58
- if (Array.isArray(currentRef)) {
59
- if (nextSegment === "") {
60
- arrayPushStyles.add(currentRef);
61
- currentRef.push(value);
68
+ if (Array.isArray(currentRef) && nextSegment === "") {
69
+ arrayPushStyles.add(currentRef);
70
+ currentRef.push(value);
71
+ } else if (nextSegment in currentRef) {
72
+ if (Array.isArray(currentRef[nextSegment])) {
73
+ currentRef[nextSegment].push(value);
62
74
  } else {
63
- currentRef[Number(nextSegment)] = value;
75
+ currentRef[nextSegment] = [currentRef[nextSegment], value];
64
76
  }
65
77
  } else {
66
78
  currentRef[nextSegment] = value;
@@ -119,8 +131,20 @@ class StandardBracketNotationSerializer {
119
131
  return inBrackets || segments.length === 0 ? [path] : segments;
120
132
  }
121
133
  }
122
- function isValidArrayIndex(value) {
123
- return /^0$|^[1-9]\d*$/.test(value);
134
+ function isValidArrayIndex(value, maxIndex) {
135
+ return /^0$|^[1-9]\d*$/.test(value) && Number(value) <= maxIndex;
136
+ }
137
+ function arrayToObject(array) {
138
+ const obj = new NullProtoObj();
139
+ array.forEach((item, i) => {
140
+ obj[i] = item;
141
+ });
142
+ return obj;
143
+ }
144
+ function pushStyleArrayToObject(array) {
145
+ const obj = new NullProtoObj();
146
+ obj[""] = array.length === 1 ? array[0] : array;
147
+ return obj;
124
148
  }
125
149
 
126
150
  class StandardOpenAPIJsonSerializer {
@@ -202,7 +226,7 @@ class StandardOpenapiLinkCodec {
202
226
  throw new Error(`[StandardOpenapiLinkCodec] expect a contract procedure at ${path.join(".")}`);
203
227
  }
204
228
  const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
205
- return inputStructure === "compact" ? this.#encodeCompact(procedure, path, input, options, baseUrl.toString(), headers) : this.#encodeDetailed(procedure, path, input, options, baseUrl.toString(), headers);
229
+ return inputStructure === "compact" ? this.#encodeCompact(procedure, path, input, options, baseUrl, headers) : this.#encodeDetailed(procedure, path, input, options, baseUrl, headers);
206
230
  }
207
231
  #encodeCompact(procedure, path, input, options, baseUrl, headers) {
208
232
  let httpPath = standardizeHTTPPath(procedure["~orpc"].route.path ?? toHttpPath(path));
@@ -221,7 +245,8 @@ class StandardOpenapiLinkCodec {
221
245
  httpBody = Object.keys(body).length ? body : void 0;
222
246
  }
223
247
  const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
224
- const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}${httpPath}`);
248
+ const url = new URL(baseUrl);
249
+ url.pathname = `${url.pathname.replace(/\/$/, "")}${httpPath}`;
225
250
  if (method === "GET") {
226
251
  const serialized = this.serializer.serialize(httpBody, { outputFormat: "URLSearchParams" });
227
252
  for (const [key, value2] of serialized) {
@@ -266,7 +291,8 @@ class StandardOpenapiLinkCodec {
266
291
  mergedHeaders = mergeStandardHeaders(input.headers, headers);
267
292
  }
268
293
  const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
269
- const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}${httpPath}`);
294
+ const url = new URL(baseUrl);
295
+ url.pathname = `${url.pathname.replace(/\/$/, "")}${httpPath}`;
270
296
  if (input?.query !== void 0) {
271
297
  const query = this.serializer.serialize(input.query, { outputFormat: "URLSearchParams" });
272
298
  for (const [key, value2] of query) {
@@ -310,12 +336,12 @@ class StandardOpenapiLinkCodec {
310
336
  }
311
337
  })();
312
338
  if (!isOk) {
313
- if (ORPCError.isValidJSON(deserialized)) {
314
- throw ORPCError.fromJSON(deserialized);
339
+ if (isORPCErrorJson(deserialized)) {
340
+ throw createORPCErrorFromJson(deserialized);
315
341
  }
316
- throw new ORPCError("MALFORMED_ORPC_ERROR_RESPONSE", {
342
+ throw new ORPCError(getMalformedResponseErrorCode(response.status), {
317
343
  status: response.status,
318
- data: deserialized
344
+ data: { ...response, body: deserialized }
319
345
  });
320
346
  }
321
347
  const procedure = get(this.contract, path);
@@ -327,6 +353,7 @@ class StandardOpenapiLinkCodec {
327
353
  return deserialized;
328
354
  }
329
355
  return {
356
+ status: response.status,
330
357
  headers: response.headers,
331
358
  body: deserialized
332
359
  };
@@ -387,8 +414,8 @@ class StandardOpenAPISerializer {
387
414
  return mapEventIterator(data, {
388
415
  value: async (value) => value,
389
416
  error: async (e) => {
390
- if (e instanceof ErrorEvent && ORPCError$1.isValidJSON(e.data)) {
391
- return ORPCError$1.fromJSON(e.data, { cause: e });
417
+ if (e instanceof ErrorEvent && isORPCErrorJson(e.data)) {
418
+ return createORPCErrorFromJson(e.data, { cause: e });
392
419
  }
393
420
  return e;
394
421
  }
@@ -398,4 +425,14 @@ class StandardOpenAPISerializer {
398
425
  }
399
426
  }
400
427
 
401
- export { StandardBracketNotationSerializer as S, StandardOpenAPIJsonSerializer as a, StandardOpenapiLinkCodec as b, StandardOpenAPISerializer as c, getDynamicParams as g, standardizeHTTPPath as s };
428
+ class StandardOpenAPILink extends StandardLink {
429
+ constructor(contract, linkClient, options) {
430
+ const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
431
+ const bracketNotationSerializer = new StandardBracketNotationSerializer({ maxBracketNotationArrayIndex: 4294967294 });
432
+ const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
433
+ const linkCodec = new StandardOpenapiLinkCodec(contract, serializer, options);
434
+ super(linkCodec, linkClient, options);
435
+ }
436
+ }
437
+
438
+ export { StandardBracketNotationSerializer as S, StandardOpenAPIJsonSerializer as a, StandardOpenAPILink as b, StandardOpenapiLinkCodec as c, StandardOpenAPISerializer as d, getDynamicParams as g, standardizeHTTPPath as s };
@@ -1,11 +1,29 @@
1
1
  import { ClientContext, ClientOptions } from '@orpc/client';
2
- import { StandardLinkCodec, StandardLinkOptions } from '@orpc/client/standard';
2
+ import { StandardLinkCodec, StandardLinkOptions, StandardLink, StandardLinkClient } from '@orpc/client/standard';
3
3
  import { AnyContractRouter } from '@orpc/contract';
4
- import { Segment, Value } from '@orpc/shared';
4
+ import { Segment, Value, Promisable } from '@orpc/shared';
5
5
  import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
6
6
 
7
7
  type StandardBracketNotationSerialized = [string, unknown][];
8
+ interface StandardBracketNotationSerializerOptions {
9
+ /**
10
+ * Maximum allowed array index for bracket notation deserialization.
11
+ *
12
+ * This helps protect against memory exhaustion attacks where malicious input
13
+ * uses extremely large array indices (e.g., `?arr[4294967296]=value`).
14
+ *
15
+ * While bracket notation creates sparse arrays that handle large indices efficiently,
16
+ * downstream code might inadvertently convert these sparse arrays to dense arrays,
17
+ * potentially creating millions of undefined elements and causing memory issues.
18
+ *
19
+ * @note Only applies to deserialization.
20
+ * @default 9_999 (array with 10,000 elements)
21
+ */
22
+ maxBracketNotationArrayIndex?: number;
23
+ }
8
24
  declare class StandardBracketNotationSerializer {
25
+ private readonly maxArrayIndex;
26
+ constructor(options?: StandardBracketNotationSerializerOptions);
9
27
  serialize(data: unknown, segments?: Segment[], result?: StandardBracketNotationSerialized): StandardBracketNotationSerialized;
10
28
  deserialize(serialized: StandardBracketNotationSerialized): Record<string, unknown> | unknown[];
11
29
  stringifyPath(segments: readonly Segment[]): string;
@@ -44,7 +62,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
44
62
  /**
45
63
  * Base url for all requests.
46
64
  */
47
- url: Value<string | URL, [
65
+ url: Value<Promisable<string | URL>, [
48
66
  options: ClientOptions<T>,
49
67
  path: readonly string[],
50
68
  input: unknown
@@ -52,7 +70,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
52
70
  /**
53
71
  * Inject headers to the request.
54
72
  */
55
- headers?: Value<StandardHeaders, [
73
+ headers?: Value<Promisable<StandardHeaders>, [
56
74
  options: ClientOptions<T>,
57
75
  path: readonly string[],
58
76
  input: unknown
@@ -71,5 +89,9 @@ declare class StandardOpenapiLinkCodec<T extends ClientContext> implements Stand
71
89
 
72
90
  interface StandardOpenAPILinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardOpenapiLinkCodecOptions<T>, StandardOpenAPIJsonSerializerOptions {
73
91
  }
92
+ declare class StandardOpenAPILink<T extends ClientContext> extends StandardLink<T> {
93
+ constructor(contract: AnyContractRouter, linkClient: StandardLinkClient<T>, options: StandardOpenAPILinkOptions<T>);
94
+ }
74
95
 
75
- export { type StandardBracketNotationSerialized as S, StandardBracketNotationSerializer as a, type StandardOpenAPIJsonSerialized as b, type StandardOpenAPICustomJsonSerializer as c, type StandardOpenAPIJsonSerializerOptions as d, StandardOpenAPIJsonSerializer as e, type StandardOpenAPILinkOptions as f, type StandardOpenapiLinkCodecOptions as g, StandardOpenapiLinkCodec as h, type StandardOpenAPISerializeOptions as i, StandardOpenAPISerializer as j };
96
+ export { StandardBracketNotationSerializer as b, StandardOpenAPIJsonSerializer as f, StandardOpenAPILink as h, StandardOpenapiLinkCodec as j, StandardOpenAPISerializer as l };
97
+ export type { StandardBracketNotationSerialized as S, StandardBracketNotationSerializerOptions as a, StandardOpenAPIJsonSerialized as c, StandardOpenAPICustomJsonSerializer as d, StandardOpenAPIJsonSerializerOptions as e, StandardOpenAPILinkOptions as g, StandardOpenapiLinkCodecOptions as i, StandardOpenAPISerializeOptions as k };
@@ -1,11 +1,29 @@
1
1
  import { ClientContext, ClientOptions } from '@orpc/client';
2
- import { StandardLinkCodec, StandardLinkOptions } from '@orpc/client/standard';
2
+ import { StandardLinkCodec, StandardLinkOptions, StandardLink, StandardLinkClient } from '@orpc/client/standard';
3
3
  import { AnyContractRouter } from '@orpc/contract';
4
- import { Segment, Value } from '@orpc/shared';
4
+ import { Segment, Value, Promisable } from '@orpc/shared';
5
5
  import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
6
6
 
7
7
  type StandardBracketNotationSerialized = [string, unknown][];
8
+ interface StandardBracketNotationSerializerOptions {
9
+ /**
10
+ * Maximum allowed array index for bracket notation deserialization.
11
+ *
12
+ * This helps protect against memory exhaustion attacks where malicious input
13
+ * uses extremely large array indices (e.g., `?arr[4294967296]=value`).
14
+ *
15
+ * While bracket notation creates sparse arrays that handle large indices efficiently,
16
+ * downstream code might inadvertently convert these sparse arrays to dense arrays,
17
+ * potentially creating millions of undefined elements and causing memory issues.
18
+ *
19
+ * @note Only applies to deserialization.
20
+ * @default 9_999 (array with 10,000 elements)
21
+ */
22
+ maxBracketNotationArrayIndex?: number;
23
+ }
8
24
  declare class StandardBracketNotationSerializer {
25
+ private readonly maxArrayIndex;
26
+ constructor(options?: StandardBracketNotationSerializerOptions);
9
27
  serialize(data: unknown, segments?: Segment[], result?: StandardBracketNotationSerialized): StandardBracketNotationSerialized;
10
28
  deserialize(serialized: StandardBracketNotationSerialized): Record<string, unknown> | unknown[];
11
29
  stringifyPath(segments: readonly Segment[]): string;
@@ -44,7 +62,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
44
62
  /**
45
63
  * Base url for all requests.
46
64
  */
47
- url: Value<string | URL, [
65
+ url: Value<Promisable<string | URL>, [
48
66
  options: ClientOptions<T>,
49
67
  path: readonly string[],
50
68
  input: unknown
@@ -52,7 +70,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
52
70
  /**
53
71
  * Inject headers to the request.
54
72
  */
55
- headers?: Value<StandardHeaders, [
73
+ headers?: Value<Promisable<StandardHeaders>, [
56
74
  options: ClientOptions<T>,
57
75
  path: readonly string[],
58
76
  input: unknown
@@ -71,5 +89,9 @@ declare class StandardOpenapiLinkCodec<T extends ClientContext> implements Stand
71
89
 
72
90
  interface StandardOpenAPILinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardOpenapiLinkCodecOptions<T>, StandardOpenAPIJsonSerializerOptions {
73
91
  }
92
+ declare class StandardOpenAPILink<T extends ClientContext> extends StandardLink<T> {
93
+ constructor(contract: AnyContractRouter, linkClient: StandardLinkClient<T>, options: StandardOpenAPILinkOptions<T>);
94
+ }
74
95
 
75
- export { type StandardBracketNotationSerialized as S, StandardBracketNotationSerializer as a, type StandardOpenAPIJsonSerialized as b, type StandardOpenAPICustomJsonSerializer as c, type StandardOpenAPIJsonSerializerOptions as d, StandardOpenAPIJsonSerializer as e, type StandardOpenAPILinkOptions as f, type StandardOpenapiLinkCodecOptions as g, StandardOpenapiLinkCodec as h, type StandardOpenAPISerializeOptions as i, StandardOpenAPISerializer as j };
96
+ export { StandardBracketNotationSerializer as b, StandardOpenAPIJsonSerializer as f, StandardOpenAPILink as h, StandardOpenapiLinkCodec as j, StandardOpenAPISerializer as l };
97
+ export type { StandardBracketNotationSerialized as S, StandardBracketNotationSerializerOptions as a, StandardOpenAPIJsonSerialized as c, StandardOpenAPICustomJsonSerializer as d, StandardOpenAPIJsonSerializerOptions as e, StandardOpenAPILinkOptions as g, StandardOpenapiLinkCodecOptions as i, StandardOpenAPISerializeOptions as k };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/openapi-client",
3
3
  "type": "module",
4
- "version": "0.0.0-next.73eeb92",
4
+ "version": "0.0.0-next.752b165",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -34,13 +34,13 @@
34
34
  "dist"
35
35
  ],
36
36
  "dependencies": {
37
- "@orpc/standard-server": "0.0.0-next.73eeb92",
38
- "@orpc/contract": "0.0.0-next.73eeb92",
39
- "@orpc/client": "0.0.0-next.73eeb92",
40
- "@orpc/shared": "0.0.0-next.73eeb92"
37
+ "@orpc/shared": "0.0.0-next.752b165",
38
+ "@orpc/contract": "0.0.0-next.752b165",
39
+ "@orpc/client": "0.0.0-next.752b165",
40
+ "@orpc/standard-server": "0.0.0-next.752b165"
41
41
  },
42
42
  "devDependencies": {
43
- "@orpc/server": "0.0.0-next.73eeb92"
43
+ "@orpc/server": "0.0.0-next.752b165"
44
44
  },
45
45
  "scripts": {
46
46
  "build": "unbuild",