@orpc/openapi-client 0.0.0-next.b45a533 → 0.0.0-next.b4fc1d9

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 (5) hide show
  1. package/README.md +2 -0
  2. package/dist/adapters/standard/index.d.mts +19 -10
  3. package/dist/adapters/standard/index.d.ts +19 -10
  4. package/dist/adapters/standard/index.mjs +18 -5
  5. package/package.json +4 -4
package/README.md CHANGED
@@ -60,6 +60,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
60
60
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
61
61
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
62
62
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
63
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
64
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
63
65
 
64
66
  ## `@orpc/openapi-client`
65
67
 
package/dist/adapters/standard/index.d.mts CHANGED
@@ -1,27 +1,36 @@
1
1
  import { Segment } from '@orpc/shared';
2
2
 
3
- type BracketNotationSerialized = [string, unknown][];
4
- declare class BracketNotationSerializer {
5
- serialize(data: unknown, segments?: Segment[], result?: BracketNotationSerialized): BracketNotationSerialized;
6
- deserialize(serialized: BracketNotationSerialized): Record<string, unknown> | unknown[];
3
+ type StandardBracketNotationSerialized = [string, unknown][];
4
+ declare class StandardBracketNotationSerializer {
5
+ serialize(data: unknown, segments?: Segment[], result?: StandardBracketNotationSerialized): StandardBracketNotationSerialized;
6
+ deserialize(serialized: StandardBracketNotationSerialized): Record<string, unknown> | unknown[];
7
7
  stringifyPath(segments: readonly Segment[]): string;
8
8
  parsePath(path: string): string[];
9
9
  }
10
10
 
11
- type OpenAPIJsonSerialized = [json: unknown, hasBlob: boolean];
12
- declare class OpenAPIJsonSerializer {
11
+ type StandardOpenAPIJsonSerialized = [json: unknown, hasBlob: boolean];
12
+ interface StandardOpenAPICustomJsonSerializer {
13
+ condition(data: unknown): boolean;
14
+ serialize(data: any): unknown;
15
+ }
16
+ interface StandardOpenAPIJsonSerializerOptions {
17
+ customJsonSerializers?: readonly StandardOpenAPICustomJsonSerializer[];
18
+ }
19
+ declare class StandardOpenAPIJsonSerializer {
20
+ private readonly customSerializers;
21
+ constructor(options?: StandardOpenAPIJsonSerializerOptions);
13
22
  serialize(data: unknown, hasBlobRef?: {
14
23
  value: boolean;
15
- }): OpenAPIJsonSerialized;
24
+ }): StandardOpenAPIJsonSerialized;
16
25
  }
17
26
 
18
- declare class OpenAPISerializer {
27
+ declare class StandardOpenAPISerializer {
19
28
  #private;
20
29
  private readonly jsonSerializer;
21
30
  private readonly bracketNotation;
22
- constructor(jsonSerializer?: OpenAPIJsonSerializer, bracketNotation?: BracketNotationSerializer);
31
+ constructor(jsonSerializer: StandardOpenAPIJsonSerializer, bracketNotation: StandardBracketNotationSerializer);
23
32
  serialize(data: unknown): unknown;
24
33
  deserialize(data: unknown): unknown;
25
34
  }
26
35
 
27
- export { type BracketNotationSerialized, BracketNotationSerializer, type OpenAPIJsonSerialized, OpenAPIJsonSerializer, OpenAPISerializer };
36
+ export { type StandardBracketNotationSerialized, StandardBracketNotationSerializer, type StandardOpenAPICustomJsonSerializer, type StandardOpenAPIJsonSerialized, StandardOpenAPIJsonSerializer, type StandardOpenAPIJsonSerializerOptions, StandardOpenAPISerializer };
package/dist/adapters/standard/index.d.ts CHANGED
@@ -1,27 +1,36 @@
1
1
  import { Segment } from '@orpc/shared';
2
2
 
3
- type BracketNotationSerialized = [string, unknown][];
4
- declare class BracketNotationSerializer {
5
- serialize(data: unknown, segments?: Segment[], result?: BracketNotationSerialized): BracketNotationSerialized;
6
- deserialize(serialized: BracketNotationSerialized): Record<string, unknown> | unknown[];
3
+ type StandardBracketNotationSerialized = [string, unknown][];
4
+ declare class StandardBracketNotationSerializer {
5
+ serialize(data: unknown, segments?: Segment[], result?: StandardBracketNotationSerialized): StandardBracketNotationSerialized;
6
+ deserialize(serialized: StandardBracketNotationSerialized): Record<string, unknown> | unknown[];
7
7
  stringifyPath(segments: readonly Segment[]): string;
8
8
  parsePath(path: string): string[];
9
9
  }
10
10
 
11
- type OpenAPIJsonSerialized = [json: unknown, hasBlob: boolean];
12
- declare class OpenAPIJsonSerializer {
11
+ type StandardOpenAPIJsonSerialized = [json: unknown, hasBlob: boolean];
12
+ interface StandardOpenAPICustomJsonSerializer {
13
+ condition(data: unknown): boolean;
14
+ serialize(data: any): unknown;
15
+ }
16
+ interface StandardOpenAPIJsonSerializerOptions {
17
+ customJsonSerializers?: readonly StandardOpenAPICustomJsonSerializer[];
18
+ }
19
+ declare class StandardOpenAPIJsonSerializer {
20
+ private readonly customSerializers;
21
+ constructor(options?: StandardOpenAPIJsonSerializerOptions);
13
22
  serialize(data: unknown, hasBlobRef?: {
14
23
  value: boolean;
15
- }): OpenAPIJsonSerialized;
24
+ }): StandardOpenAPIJsonSerialized;
16
25
  }
17
26
 
18
- declare class OpenAPISerializer {
27
+ declare class StandardOpenAPISerializer {
19
28
  #private;
20
29
  private readonly jsonSerializer;
21
30
  private readonly bracketNotation;
22
- constructor(jsonSerializer?: OpenAPIJsonSerializer, bracketNotation?: BracketNotationSerializer);
31
+ constructor(jsonSerializer: StandardOpenAPIJsonSerializer, bracketNotation: StandardBracketNotationSerializer);
23
32
  serialize(data: unknown): unknown;
24
33
  deserialize(data: unknown): unknown;
25
34
  }
26
35
 
27
- export { type BracketNotationSerialized, BracketNotationSerializer, type OpenAPIJsonSerialized, OpenAPIJsonSerializer, OpenAPISerializer };
36
+ export { type StandardBracketNotationSerialized, StandardBracketNotationSerializer, type StandardOpenAPICustomJsonSerializer, type StandardOpenAPIJsonSerialized, StandardOpenAPIJsonSerializer, type StandardOpenAPIJsonSerializerOptions, StandardOpenAPISerializer };
package/dist/adapters/standard/index.mjs CHANGED
@@ -2,7 +2,7 @@ import { isObject, isAsyncIteratorObject } from '@orpc/shared';
2
2
  import { mapEventIterator, toORPCError, ORPCError } from '@orpc/client';
3
3
  import { ErrorEvent } from '@orpc/standard-server';
4
4
 
5
- class BracketNotationSerializer {
5
+ class StandardBracketNotationSerializer {
6
6
  serialize(data, segments = [], result = []) {
7
7
  if (Array.isArray(data)) {
8
8
  data.forEach((item, i) => {
@@ -121,8 +121,18 @@ function isValidArrayIndex(value) {
121
121
  return /^0$|^[1-9]\d*$/.test(value);
122
122
  }
123
123
 
124
- class OpenAPIJsonSerializer {
124
+ class StandardOpenAPIJsonSerializer {
125
+ customSerializers;
126
+ constructor(options = {}) {
127
+ this.customSerializers = options.customJsonSerializers ?? [];
128
+ }
125
129
  serialize(data, hasBlobRef = { value: false }) {
130
+ for (const custom of this.customSerializers) {
131
+ if (custom.condition(data)) {
132
+ const result = this.serialize(custom.serialize(data), hasBlobRef);
133
+ return result;
134
+ }
135
+ }
126
136
  if (data instanceof Blob) {
127
137
  hasBlobRef.value = true;
128
138
  return [data, hasBlobRef.value];
@@ -140,6 +150,9 @@ class OpenAPIJsonSerializer {
140
150
  if (isObject(data)) {
141
151
  const json = {};
142
152
  for (const k in data) {
153
+ if (k === "toJSON" && typeof data[k] === "function") {
154
+ continue;
155
+ }
143
156
  json[k] = this.serialize(data[k], hasBlobRef)[0];
144
157
  }
145
158
  return [json, hasBlobRef.value];
@@ -157,8 +170,8 @@ class OpenAPIJsonSerializer {
157
170
  }
158
171
  }
159
172
 
160
- class OpenAPISerializer {
161
- constructor(jsonSerializer = new OpenAPIJsonSerializer(), bracketNotation = new BracketNotationSerializer()) {
173
+ class StandardOpenAPISerializer {
174
+ constructor(jsonSerializer, bracketNotation) {
162
175
  this.jsonSerializer = jsonSerializer;
163
176
  this.bracketNotation = bracketNotation;
164
177
  }
@@ -213,4 +226,4 @@ class OpenAPISerializer {
213
226
  }
214
227
  }
215
228
 
216
- export { BracketNotationSerializer, OpenAPIJsonSerializer, OpenAPISerializer };
229
+ export { StandardBracketNotationSerializer, StandardOpenAPIJsonSerializer, StandardOpenAPISerializer };
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.b45a533",
4
+ "version": "0.0.0-next.b4fc1d9",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -29,9 +29,9 @@
29
29
  "dist"
30
30
  ],
31
31
  "dependencies": {
32
- "@orpc/client": "0.0.0-next.b45a533",
33
- "@orpc/standard-server": "0.0.0-next.b45a533",
34
- "@orpc/shared": "0.0.0-next.b45a533"
32
+ "@orpc/client": "0.0.0-next.b4fc1d9",
33
+ "@orpc/shared": "0.0.0-next.b4fc1d9",
34
+ "@orpc/standard-server": "0.0.0-next.b4fc1d9"
35
35
  },
36
36
  "scripts": {
37
37
  "build": "unbuild",