@orpc/client 0.0.0-next.c29cb6d → 0.0.0-next.c4a591c
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 +63 -20
- package/dist/index.js +6 -3
- package/dist/src/adapters/fetch/orpc-link.d.ts +34 -7
- package/dist/src/client.d.ts +2 -2
- 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 +5 -7
package/dist/fetch.js
CHANGED
@@ -1,46 +1,89 @@
|
|
1
1
|
// src/adapters/fetch/orpc-link.ts
|
2
|
+
import { ORPCError } from "@orpc/contract";
|
2
3
|
import { ORPCPayloadCodec } from "@orpc/server/fetch";
|
3
4
|
import { ORPC_HANDLER_HEADER, ORPC_HANDLER_VALUE, trim } from "@orpc/shared";
|
4
|
-
|
5
|
-
|
5
|
+
var RPCLink = class {
|
6
|
+
fetch;
|
7
|
+
payloadCodec;
|
8
|
+
maxURLLength;
|
9
|
+
fallbackMethod;
|
10
|
+
getMethod;
|
11
|
+
getHeaders;
|
12
|
+
url;
|
6
13
|
constructor(options) {
|
7
|
-
this.options = options;
|
8
14
|
this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
|
9
15
|
this.payloadCodec = options.payloadCodec ?? new ORPCPayloadCodec();
|
16
|
+
this.maxURLLength = options.maxURLLength ?? 2083;
|
17
|
+
this.fallbackMethod = options.fallbackMethod ?? "POST";
|
18
|
+
this.url = options.url;
|
19
|
+
this.getMethod = async (path, input, context) => {
|
20
|
+
return await options.method?.(path, input, context) ?? this.fallbackMethod;
|
21
|
+
};
|
22
|
+
this.getHeaders = async (path, input, context) => {
|
23
|
+
return new Headers(await options.headers?.(path, input, context));
|
24
|
+
};
|
10
25
|
}
|
11
|
-
fetch;
|
12
|
-
payloadCodec;
|
13
26
|
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
27
|
const clientContext = options.context;
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
headers.
|
23
|
-
}
|
24
|
-
const response = await this.fetch(url, {
|
25
|
-
method: "POST",
|
26
|
-
headers,
|
28
|
+
const encoded = await this.encode(path, input, options);
|
29
|
+
const response = await this.fetch(encoded.url, {
|
30
|
+
method: encoded.method,
|
31
|
+
headers: encoded.headers,
|
27
32
|
body: encoded.body,
|
28
33
|
signal: options.signal
|
29
34
|
}, clientContext);
|
30
35
|
const decoded = await this.payloadCodec.decode(response);
|
31
36
|
if (!response.ok) {
|
32
|
-
|
37
|
+
if (ORPCError.isValidJSON(decoded)) {
|
38
|
+
throw new ORPCError(decoded);
|
39
|
+
}
|
40
|
+
throw new ORPCError({
|
33
41
|
status: response.status,
|
34
42
|
code: "INTERNAL_SERVER_ERROR",
|
35
43
|
message: "Internal server error",
|
36
44
|
cause: decoded
|
37
45
|
});
|
38
|
-
throw error;
|
39
46
|
}
|
40
47
|
return decoded;
|
41
48
|
}
|
49
|
+
async encode(path, input, options) {
|
50
|
+
const clientContext = options.context;
|
51
|
+
const expectMethod = await this.getMethod(path, input, clientContext);
|
52
|
+
const methods = /* @__PURE__ */ new Set([expectMethod, this.fallbackMethod]);
|
53
|
+
const baseHeaders = await this.getHeaders(path, input, clientContext);
|
54
|
+
const baseUrl = new URL(`${trim(this.url, "/")}/${path.map(encodeURIComponent).join("/")}`);
|
55
|
+
baseHeaders.append(ORPC_HANDLER_HEADER, ORPC_HANDLER_VALUE);
|
56
|
+
for (const method of methods) {
|
57
|
+
const url = new URL(baseUrl);
|
58
|
+
const headers = new Headers(baseHeaders);
|
59
|
+
const encoded = this.payloadCodec.encode(input, method, this.fallbackMethod);
|
60
|
+
if (encoded.query) {
|
61
|
+
for (const [key, value] of encoded.query.entries()) {
|
62
|
+
url.searchParams.append(key, value);
|
63
|
+
}
|
64
|
+
}
|
65
|
+
if (url.toString().length > this.maxURLLength) {
|
66
|
+
continue;
|
67
|
+
}
|
68
|
+
if (encoded.headers) {
|
69
|
+
for (const [key, value] of encoded.headers.entries()) {
|
70
|
+
headers.append(key, value);
|
71
|
+
}
|
72
|
+
}
|
73
|
+
return {
|
74
|
+
url,
|
75
|
+
headers,
|
76
|
+
method: encoded.method,
|
77
|
+
body: encoded.body
|
78
|
+
};
|
79
|
+
}
|
80
|
+
throw new ORPCError({
|
81
|
+
code: "BAD_REQUEST",
|
82
|
+
message: "Cannot encode the request, please check the url length or payload."
|
83
|
+
});
|
84
|
+
}
|
42
85
|
};
|
43
86
|
export {
|
44
|
-
|
87
|
+
RPCLink
|
45
88
|
};
|
46
89
|
//# 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
5
|
import { type PublicORPCPayloadCodec } from '@orpc/server/fetch';
|
6
|
-
export interface
|
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
|
+
* Do not use GET as fallback method, it's very dangerous.
|
26
|
+
*
|
27
|
+
* @default 'POST'
|
28
|
+
*/
|
29
|
+
fallbackMethod?: HTTPMethod;
|
30
|
+
headers?: (path: readonly string[], input: unknown, context: TClientContext) => Promisable<Headers | Record<string, string>>;
|
9
31
|
fetch?: FetchWithContext<TClientContext>;
|
10
32
|
payloadCodec?: PublicORPCPayloadCodec;
|
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
36
|
private readonly payloadCodec;
|
16
|
-
|
17
|
-
|
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,4 +1,4 @@
|
|
1
|
-
import type { ContractRouter } from '@orpc/contract';
|
1
|
+
import type { ContractRouter, ContractRouterClient } from '@orpc/contract';
|
2
2
|
import type { ANY_ROUTER, RouterClient } from '@orpc/server';
|
3
3
|
import type { ClientLink } from './types';
|
4
4
|
export interface createORPCClientOptions {
|
@@ -7,5 +7,5 @@ export interface createORPCClientOptions {
|
|
7
7
|
*/
|
8
8
|
path?: string[];
|
9
9
|
}
|
10
|
-
export declare function createORPCClient<TRouter extends ANY_ROUTER | ContractRouter
|
10
|
+
export declare function createORPCClient<TRouter extends ANY_ROUTER | ContractRouter<any>, TClientContext = unknown>(link: ClientLink<TClientContext>, options?: createORPCClientOptions): TRouter extends ContractRouter<any> ? ContractRouterClient<TRouter, TClientContext> : TRouter extends ANY_ROUTER ? RouterClient<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: (path: readonly string[], input: unknown, options:
|
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.c4a591c",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -33,16 +33,14 @@
|
|
33
33
|
"!**/*.tsbuildinfo",
|
34
34
|
"dist"
|
35
35
|
],
|
36
|
-
"peerDependencies": {
|
37
|
-
"@orpc/contract": "0.0.0-next.c29cb6d"
|
38
|
-
},
|
39
36
|
"dependencies": {
|
40
|
-
"@orpc/
|
41
|
-
"@orpc/
|
37
|
+
"@orpc/contract": "0.0.0-next.c4a591c",
|
38
|
+
"@orpc/server": "0.0.0-next.c4a591c",
|
39
|
+
"@orpc/shared": "0.0.0-next.c4a591c"
|
42
40
|
},
|
43
41
|
"devDependencies": {
|
44
42
|
"zod": "^3.24.1",
|
45
|
-
"@orpc/openapi": "0.0.0-next.
|
43
|
+
"@orpc/openapi": "0.0.0-next.c4a591c"
|
46
44
|
},
|
47
45
|
"scripts": {
|
48
46
|
"build": "tsup --clean --sourcemap --entry.index=src/index.ts --entry.fetch=src/adapters/fetch/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
|