@orpc/client 0.0.0-next.c29cb6d → 0.0.0-next.c3068b4
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/dist/fetch.js +87 -30
- package/dist/index.js +6 -3
- package/dist/src/adapters/fetch/orpc-link.d.ts +37 -10
- package/dist/src/client.d.ts +3 -3
- package/dist/src/dynamic-link.d.ts +3 -5
- package/dist/src/index.d.ts +1 -1
- package/dist/src/types.d.ts +2 -2
- package/package.json +6 -7
package/dist/fetch.js
CHANGED
@@ -1,46 +1,103 @@
|
|
1
1
|
// src/adapters/fetch/orpc-link.ts
|
2
|
-
import {
|
3
|
-
import {
|
4
|
-
import {
|
5
|
-
|
2
|
+
import { ORPCError } from "@orpc/contract";
|
3
|
+
import { fetchReToStandardBody } from "@orpc/server/fetch";
|
4
|
+
import { RPCSerializer } from "@orpc/server/standard";
|
5
|
+
import { isPlainObject, trim } from "@orpc/shared";
|
6
|
+
import cd from "content-disposition";
|
7
|
+
var RPCLink = class {
|
8
|
+
fetch;
|
9
|
+
rpcSerializer;
|
10
|
+
maxURLLength;
|
11
|
+
fallbackMethod;
|
12
|
+
getMethod;
|
13
|
+
getHeaders;
|
14
|
+
url;
|
6
15
|
constructor(options) {
|
7
|
-
this.options = options;
|
8
16
|
this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
|
9
|
-
this.
|
17
|
+
this.rpcSerializer = options.rpcSerializer ?? new RPCSerializer();
|
18
|
+
this.maxURLLength = options.maxURLLength ?? 2083;
|
19
|
+
this.fallbackMethod = options.fallbackMethod ?? "POST";
|
20
|
+
this.url = options.url;
|
21
|
+
this.getMethod = async (path, input, context) => {
|
22
|
+
return await options.method?.(path, input, context) ?? this.fallbackMethod;
|
23
|
+
};
|
24
|
+
this.getHeaders = async (path, input, context) => {
|
25
|
+
return new Headers(await options.headers?.(path, input, context));
|
26
|
+
};
|
10
27
|
}
|
11
|
-
fetch;
|
12
|
-
payloadCodec;
|
13
28
|
async call(path, input, options) {
|
14
|
-
const url = `${trim(this.options.url, "/")}/${path.map(encodeURIComponent).join("/")}`;
|
15
|
-
const encoded = this.payloadCodec.encode(input);
|
16
|
-
const headers = new Headers(encoded.headers);
|
17
|
-
headers.append(ORPC_HANDLER_HEADER, ORPC_HANDLER_VALUE);
|
18
29
|
const clientContext = options.context;
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
headers.append(key, value);
|
30
|
+
const encoded = await this.encode(path, input, options);
|
31
|
+
if (encoded.body instanceof Blob && !encoded.headers.has("content-disposition")) {
|
32
|
+
encoded.headers.set("content-disposition", cd(encoded.body instanceof File ? encoded.body.name : "blob"));
|
23
33
|
}
|
24
|
-
const response = await this.fetch(url, {
|
25
|
-
method:
|
26
|
-
headers,
|
34
|
+
const response = await this.fetch(encoded.url, {
|
35
|
+
method: encoded.method,
|
36
|
+
headers: encoded.headers,
|
27
37
|
body: encoded.body,
|
28
38
|
signal: options.signal
|
29
39
|
}, clientContext);
|
30
|
-
const
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
40
|
+
const body = await fetchReToStandardBody(response);
|
41
|
+
const deserialized = (() => {
|
42
|
+
try {
|
43
|
+
return this.rpcSerializer.deserialize(body);
|
44
|
+
} catch (error) {
|
45
|
+
if (response.ok) {
|
46
|
+
throw new ORPCError("INTERNAL_SERVER_ERROR", {
|
47
|
+
message: "Invalid RPC response",
|
48
|
+
cause: error
|
49
|
+
});
|
50
|
+
}
|
51
|
+
throw new ORPCError(response.status.toString(), {
|
52
|
+
message: response.statusText
|
53
|
+
});
|
54
|
+
}
|
55
|
+
})();
|
56
|
+
if (response.ok) {
|
57
|
+
return deserialized;
|
58
|
+
}
|
59
|
+
throw ORPCError.fromJSON(deserialized);
|
60
|
+
}
|
61
|
+
async encode(path, input, options) {
|
62
|
+
const clientContext = options.context;
|
63
|
+
const expectMethod = await this.getMethod(path, input, clientContext);
|
64
|
+
const headers = await this.getHeaders(path, input, clientContext);
|
65
|
+
const url = new URL(`${trim(this.url, "/")}/${path.map(encodeURIComponent).join("/")}`);
|
66
|
+
headers.append("x-orpc-handler", "rpc");
|
67
|
+
const serialized = this.rpcSerializer.serialize(input);
|
68
|
+
if (expectMethod === "GET" && isPlainObject(serialized)) {
|
69
|
+
const tryURL = new URL(url);
|
70
|
+
tryURL.searchParams.append("data", JSON.stringify(serialized));
|
71
|
+
if (tryURL.toString().length <= this.maxURLLength) {
|
72
|
+
return {
|
73
|
+
body: void 0,
|
74
|
+
method: expectMethod,
|
75
|
+
headers,
|
76
|
+
url: tryURL
|
77
|
+
};
|
78
|
+
}
|
39
79
|
}
|
40
|
-
|
80
|
+
const method = expectMethod === "GET" ? this.fallbackMethod : expectMethod;
|
81
|
+
if (isPlainObject(serialized)) {
|
82
|
+
if (!headers.has("content-type")) {
|
83
|
+
headers.set("content-type", "application/json");
|
84
|
+
}
|
85
|
+
return {
|
86
|
+
body: JSON.stringify(serialized),
|
87
|
+
method,
|
88
|
+
headers,
|
89
|
+
url
|
90
|
+
};
|
91
|
+
}
|
92
|
+
return {
|
93
|
+
body: serialized,
|
94
|
+
method,
|
95
|
+
headers,
|
96
|
+
url
|
97
|
+
};
|
41
98
|
}
|
42
99
|
};
|
43
100
|
export {
|
44
|
-
|
101
|
+
RPCLink
|
45
102
|
};
|
46
103
|
//# sourceMappingURL=fetch.js.map
|
package/dist/index.js
CHANGED
@@ -24,16 +24,19 @@ var DynamicLink = class {
|
|
24
24
|
this.linkResolver = linkResolver;
|
25
25
|
}
|
26
26
|
async call(path, input, options) {
|
27
|
-
const resolvedLink = await this.linkResolver(path, input, options);
|
27
|
+
const resolvedLink = await this.linkResolver(path, input, options.context);
|
28
28
|
const output = await resolvedLink.call(path, input, options);
|
29
29
|
return output;
|
30
30
|
}
|
31
31
|
};
|
32
32
|
|
33
33
|
// src/index.ts
|
34
|
-
|
34
|
+
import { isDefinedError, ORPCError, safe } from "@orpc/contract";
|
35
35
|
export {
|
36
36
|
DynamicLink,
|
37
|
-
|
37
|
+
ORPCError,
|
38
|
+
createORPCClient,
|
39
|
+
isDefinedError,
|
40
|
+
safe
|
38
41
|
};
|
39
42
|
//# sourceMappingURL=index.js.map
|
@@ -1,19 +1,46 @@
|
|
1
|
-
import type {
|
1
|
+
import type { ClientOptions, HTTPMethod } from '@orpc/contract';
|
2
2
|
import type { Promisable } from '@orpc/shared';
|
3
3
|
import type { ClientLink } from '../../types';
|
4
4
|
import type { FetchWithContext } from './types';
|
5
|
-
import {
|
6
|
-
export interface
|
5
|
+
import { RPCSerializer } from '@orpc/server/standard';
|
6
|
+
export interface RPCLinkOptions<TClientContext> {
|
7
|
+
/**
|
8
|
+
* Base url for all requests.
|
9
|
+
*/
|
7
10
|
url: string;
|
8
|
-
|
11
|
+
/**
|
12
|
+
* The maximum length of the URL.
|
13
|
+
*
|
14
|
+
* @default 2083
|
15
|
+
*/
|
16
|
+
maxURLLength?: number;
|
17
|
+
/**
|
18
|
+
* The method used to make the request.
|
19
|
+
*
|
20
|
+
* @default 'POST'
|
21
|
+
*/
|
22
|
+
method?(path: readonly string[], input: unknown, context: TClientContext): Promisable<HTTPMethod | undefined>;
|
23
|
+
/**
|
24
|
+
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
25
|
+
* GET is not allowed, it's very dangerous.
|
26
|
+
*
|
27
|
+
* @default 'POST'
|
28
|
+
*/
|
29
|
+
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
30
|
+
headers?(path: readonly string[], input: unknown, context: TClientContext): Promisable<Headers | Record<string, string>>;
|
9
31
|
fetch?: FetchWithContext<TClientContext>;
|
10
|
-
|
32
|
+
rpcSerializer?: RPCSerializer;
|
11
33
|
}
|
12
|
-
export declare class
|
13
|
-
private readonly options;
|
34
|
+
export declare class RPCLink<TClientContext> implements ClientLink<TClientContext> {
|
14
35
|
private readonly fetch;
|
15
|
-
private readonly
|
16
|
-
|
17
|
-
|
36
|
+
private readonly rpcSerializer;
|
37
|
+
private readonly maxURLLength;
|
38
|
+
private readonly fallbackMethod;
|
39
|
+
private readonly getMethod;
|
40
|
+
private readonly getHeaders;
|
41
|
+
private readonly url;
|
42
|
+
constructor(options: RPCLinkOptions<TClientContext>);
|
43
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
44
|
+
private encode;
|
18
45
|
}
|
19
46
|
//# sourceMappingURL=orpc-link.d.ts.map
|
package/dist/src/client.d.ts
CHANGED
@@ -1,5 +1,5 @@
|
|
1
|
-
import type {
|
2
|
-
import type {
|
1
|
+
import type { AnyContractRouter, ContractRouterClient } from '@orpc/contract';
|
2
|
+
import type { AnyRouter, RouterClient } from '@orpc/server';
|
3
3
|
import type { ClientLink } from './types';
|
4
4
|
export interface createORPCClientOptions {
|
5
5
|
/**
|
@@ -7,5 +7,5 @@ export interface createORPCClientOptions {
|
|
7
7
|
*/
|
8
8
|
path?: string[];
|
9
9
|
}
|
10
|
-
export declare function createORPCClient<TRouter extends
|
10
|
+
export declare function createORPCClient<TRouter extends AnyRouter | AnyContractRouter, TClientContext = unknown>(link: ClientLink<TClientContext>, options?: createORPCClientOptions): TRouter extends AnyRouter ? RouterClient<TRouter, TClientContext> : TRouter extends AnyContractRouter ? ContractRouterClient<TRouter, TClientContext> : never;
|
11
11
|
//# sourceMappingURL=client.d.ts.map
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import type {
|
1
|
+
import type { ClientOptions } from '@orpc/contract';
|
2
2
|
import type { Promisable } from '@orpc/shared';
|
3
3
|
import type { ClientLink } from './types';
|
4
4
|
/**
|
@@ -7,9 +7,7 @@ import type { ClientLink } from './types';
|
|
7
7
|
*/
|
8
8
|
export declare class DynamicLink<TClientContext> implements ClientLink<TClientContext> {
|
9
9
|
private readonly linkResolver;
|
10
|
-
constructor(linkResolver: (path: readonly string[], input: unknown,
|
11
|
-
|
12
|
-
}) => Promisable<ClientLink<TClientContext>>);
|
13
|
-
call(path: readonly string[], input: unknown, options: ProcedureClientOptions<TClientContext>): Promise<unknown>;
|
10
|
+
constructor(linkResolver: (path: readonly string[], input: unknown, context: TClientContext) => Promisable<ClientLink<TClientContext>>);
|
11
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
14
12
|
}
|
15
13
|
//# sourceMappingURL=dynamic-link.d.ts.map
|
package/dist/src/index.d.ts
CHANGED
package/dist/src/types.d.ts
CHANGED
@@ -1,5 +1,5 @@
|
|
1
|
-
import type {
|
1
|
+
import type { ClientOptions } from '@orpc/contract';
|
2
2
|
export interface ClientLink<TClientContext> {
|
3
|
-
call
|
3
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
4
4
|
}
|
5
5
|
//# sourceMappingURL=types.d.ts.map
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@orpc/client",
|
3
3
|
"type": "module",
|
4
|
-
"version": "0.0.0-next.
|
4
|
+
"version": "0.0.0-next.c3068b4",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -33,16 +33,15 @@
|
|
33
33
|
"!**/*.tsbuildinfo",
|
34
34
|
"dist"
|
35
35
|
],
|
36
|
-
"peerDependencies": {
|
37
|
-
"@orpc/contract": "0.0.0-next.c29cb6d"
|
38
|
-
},
|
39
36
|
"dependencies": {
|
40
|
-
"
|
41
|
-
"@orpc/
|
37
|
+
"content-disposition": "^0.5.4",
|
38
|
+
"@orpc/contract": "0.0.0-next.c3068b4",
|
39
|
+
"@orpc/shared": "0.0.0-next.c3068b4",
|
40
|
+
"@orpc/server": "0.0.0-next.c3068b4"
|
42
41
|
},
|
43
42
|
"devDependencies": {
|
44
43
|
"zod": "^3.24.1",
|
45
|
-
"@orpc/openapi": "0.0.0-next.
|
44
|
+
"@orpc/openapi": "0.0.0-next.c3068b4"
|
46
45
|
},
|
47
46
|
"scripts": {
|
48
47
|
"build": "tsup --clean --sourcemap --entry.index=src/index.ts --entry.fetch=src/adapters/fetch/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
|