@orpc/server 0.0.0-next.eb37cbe → 0.0.0-next.ed15210
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/chunk-6YJ5NGUE.js +301 -0
- package/dist/chunk-WUOGVGWG.js +1 -0
- package/dist/chunk-XHFINNVL.js +217 -0
- package/dist/fetch.js +10 -310
- package/dist/hono.js +30 -0
- package/dist/index.js +718 -193
- package/dist/next.js +36 -0
- package/dist/node.js +87 -0
- package/dist/src/{fetch → adapters/fetch}/index.d.ts +1 -1
- package/dist/src/adapters/fetch/orpc-handler.d.ts +20 -0
- package/dist/src/{fetch → adapters/fetch}/orpc-payload-codec.d.ts +1 -1
- package/dist/src/{fetch → adapters/fetch}/orpc-procedure-matcher.d.ts +2 -2
- package/dist/src/adapters/fetch/types.d.ts +21 -0
- package/dist/src/adapters/hono/index.d.ts +3 -0
- package/dist/src/adapters/hono/middleware.d.ts +12 -0
- package/dist/src/adapters/next/index.d.ts +3 -0
- package/dist/src/adapters/next/serve.d.ts +19 -0
- package/dist/src/adapters/node/index.d.ts +5 -0
- package/dist/src/adapters/node/orpc-handler.d.ts +12 -0
- package/dist/src/adapters/node/request-listener.d.ts +28 -0
- package/dist/src/adapters/node/types.d.ts +22 -0
- package/dist/src/builder-with-errors-middlewares.d.ts +49 -0
- package/dist/src/builder-with-errors.d.ts +49 -0
- package/dist/src/builder-with-middlewares.d.ts +49 -0
- package/dist/src/builder.d.ts +35 -24
- package/dist/src/config.d.ts +6 -0
- package/dist/src/context.d.ts +10 -0
- package/dist/src/error.d.ts +10 -0
- package/dist/src/hidden.d.ts +1 -3
- package/dist/src/implementer-chainable.d.ts +11 -5
- package/dist/src/index.d.ts +7 -4
- package/dist/src/lazy-decorated.d.ts +4 -6
- package/dist/src/middleware-decorated.d.ts +6 -5
- package/dist/src/middleware.d.ts +29 -13
- package/dist/src/procedure-builder-with-input.d.ts +35 -0
- package/dist/src/procedure-builder-with-output.d.ts +34 -0
- package/dist/src/procedure-builder.d.ts +24 -18
- package/dist/src/procedure-client.d.ts +9 -22
- package/dist/src/procedure-decorated.d.ts +22 -11
- package/dist/src/procedure-implementer.d.ts +18 -13
- package/dist/src/procedure-utils.d.ts +17 -0
- package/dist/src/procedure.d.ts +37 -13
- package/dist/src/router-builder.d.ts +20 -16
- package/dist/src/router-client.d.ts +7 -6
- package/dist/src/router-implementer.d.ts +15 -12
- package/dist/src/router-utils.d.ts +15 -0
- package/dist/src/router.d.ts +9 -6
- package/dist/src/types.d.ts +2 -3
- package/package.json +24 -8
- package/dist/chunk-37HIYNDO.js +0 -182
- package/dist/src/fetch/composite-handler.d.ts +0 -8
- package/dist/src/fetch/orpc-handler.d.ts +0 -20
- package/dist/src/fetch/types.d.ts +0 -16
- package/dist/src/utils.d.ts +0 -3
- /package/dist/src/{fetch → adapters/fetch}/super-json.d.ts +0 -0
package/dist/next.js
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
import "./chunk-WUOGVGWG.js";
|
2
|
+
import {
|
3
|
+
ORPCPayloadCodec,
|
4
|
+
ORPCProcedureMatcher,
|
5
|
+
RPCHandler,
|
6
|
+
super_json_exports
|
7
|
+
} from "./chunk-6YJ5NGUE.js";
|
8
|
+
import "./chunk-XHFINNVL.js";
|
9
|
+
|
10
|
+
// src/adapters/next/serve.ts
|
11
|
+
import { value } from "@orpc/shared";
|
12
|
+
function serve(handler, ...[options]) {
|
13
|
+
const main = async (req) => {
|
14
|
+
const context = await value(options?.context ?? {}, req);
|
15
|
+
const { matched, response } = await handler.handle(req, { ...options, context });
|
16
|
+
if (matched) {
|
17
|
+
return response;
|
18
|
+
}
|
19
|
+
return new Response(`Cannot find a matching procedure for ${req.url}`, { status: 404 });
|
20
|
+
};
|
21
|
+
return {
|
22
|
+
GET: main,
|
23
|
+
POST: main,
|
24
|
+
PUT: main,
|
25
|
+
PATCH: main,
|
26
|
+
DELETE: main
|
27
|
+
};
|
28
|
+
}
|
29
|
+
export {
|
30
|
+
ORPCPayloadCodec,
|
31
|
+
ORPCProcedureMatcher,
|
32
|
+
RPCHandler,
|
33
|
+
super_json_exports as SuperJSON,
|
34
|
+
serve
|
35
|
+
};
|
36
|
+
//# sourceMappingURL=next.js.map
|
package/dist/node.js
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
import {
|
2
|
+
RPCHandler
|
3
|
+
} from "./chunk-6YJ5NGUE.js";
|
4
|
+
import "./chunk-XHFINNVL.js";
|
5
|
+
|
6
|
+
// src/adapters/node/request-listener.ts
|
7
|
+
function createRequest(req, res) {
|
8
|
+
const controller = new AbortController();
|
9
|
+
res.on("close", () => {
|
10
|
+
controller.abort();
|
11
|
+
});
|
12
|
+
const method = req.method ?? "GET";
|
13
|
+
const headers = createHeaders(req);
|
14
|
+
const protocol = "encrypted" in req.socket && req.socket.encrypted ? "https:" : "http:";
|
15
|
+
const host = headers.get("Host") ?? "localhost";
|
16
|
+
const url = new URL(req.originalUrl ?? req.url ?? "/", `${protocol}//${host}`);
|
17
|
+
const init = { method, headers, signal: controller.signal };
|
18
|
+
if (method !== "GET" && method !== "HEAD") {
|
19
|
+
init.body = new ReadableStream({
|
20
|
+
start(controller2) {
|
21
|
+
req.on("data", (chunk) => {
|
22
|
+
controller2.enqueue(new Uint8Array(chunk.buffer, chunk.byteOffset, chunk.byteLength));
|
23
|
+
});
|
24
|
+
req.on("end", () => {
|
25
|
+
controller2.close();
|
26
|
+
});
|
27
|
+
}
|
28
|
+
});
|
29
|
+
init.duplex = "half";
|
30
|
+
}
|
31
|
+
return new Request(url, init);
|
32
|
+
}
|
33
|
+
function createHeaders(req) {
|
34
|
+
const headers = new Headers();
|
35
|
+
const rawHeaders = req.rawHeaders;
|
36
|
+
for (let i = 0; i < rawHeaders.length; i += 2) {
|
37
|
+
headers.append(rawHeaders[i], rawHeaders[i + 1]);
|
38
|
+
}
|
39
|
+
return headers;
|
40
|
+
}
|
41
|
+
async function sendResponse(res, response) {
|
42
|
+
const headers = {};
|
43
|
+
for (const [key, value] of response.headers) {
|
44
|
+
if (key in headers) {
|
45
|
+
if (Array.isArray(headers[key])) {
|
46
|
+
headers[key].push(value);
|
47
|
+
} else {
|
48
|
+
headers[key] = [headers[key], value];
|
49
|
+
}
|
50
|
+
} else {
|
51
|
+
headers[key] = value;
|
52
|
+
}
|
53
|
+
}
|
54
|
+
res.writeHead(response.status, headers);
|
55
|
+
if (response.body != null && res.req.method !== "HEAD") {
|
56
|
+
for await (const chunk of response.body) {
|
57
|
+
res.write(chunk);
|
58
|
+
}
|
59
|
+
}
|
60
|
+
res.end();
|
61
|
+
}
|
62
|
+
|
63
|
+
// src/adapters/node/orpc-handler.ts
|
64
|
+
var RPCHandler2 = class {
|
65
|
+
orpcFetchHandler;
|
66
|
+
constructor(router, options) {
|
67
|
+
this.orpcFetchHandler = new RPCHandler(router, options);
|
68
|
+
}
|
69
|
+
async handle(req, res, ...rest) {
|
70
|
+
const request = createRequest(req, res);
|
71
|
+
const result = await this.orpcFetchHandler.handle(request, ...rest);
|
72
|
+
if (result.matched === false) {
|
73
|
+
return { matched: false };
|
74
|
+
}
|
75
|
+
const context = rest[0]?.context ?? {};
|
76
|
+
await rest[0]?.beforeSend?.(result.response, context);
|
77
|
+
await sendResponse(res, result.response);
|
78
|
+
return { matched: true };
|
79
|
+
}
|
80
|
+
};
|
81
|
+
export {
|
82
|
+
RPCHandler2 as RPCHandler,
|
83
|
+
createHeaders,
|
84
|
+
createRequest,
|
85
|
+
sendResponse
|
86
|
+
};
|
87
|
+
//# sourceMappingURL=node.js.map
|
@@ -0,0 +1,20 @@
|
|
1
|
+
import type { Hooks } from '@orpc/shared';
|
2
|
+
import type { Context } from '../../context';
|
3
|
+
import type { Router } from '../../router';
|
4
|
+
import type { FetchHandler, FetchHandleRest, FetchHandleResult } from './types';
|
5
|
+
import { type PublicORPCPayloadCodec } from './orpc-payload-codec';
|
6
|
+
import { type PublicORPCProcedureMatcher } from './orpc-procedure-matcher';
|
7
|
+
export type RPCHandlerOptions<T extends Context> = Hooks<Request, FetchHandleResult, T, {
|
8
|
+
signal?: AbortSignal;
|
9
|
+
}> & {
|
10
|
+
procedureMatcher?: PublicORPCProcedureMatcher;
|
11
|
+
payloadCodec?: PublicORPCPayloadCodec;
|
12
|
+
};
|
13
|
+
export declare class RPCHandler<T extends Context> implements FetchHandler<T> {
|
14
|
+
private readonly options?;
|
15
|
+
private readonly procedureMatcher;
|
16
|
+
private readonly payloadCodec;
|
17
|
+
constructor(router: Router<T, any>, options?: NoInfer<RPCHandlerOptions<T>> | undefined);
|
18
|
+
handle(request: Request, ...[options]: FetchHandleRest<T>): Promise<FetchHandleResult>;
|
19
|
+
}
|
20
|
+
//# sourceMappingURL=orpc-handler.d.ts.map
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import type { ANY_PROCEDURE } from '
|
2
|
-
import { type ANY_ROUTER } from '
|
1
|
+
import type { ANY_PROCEDURE } from '../../procedure';
|
2
|
+
import { type ANY_ROUTER } from '../../router';
|
3
3
|
export declare class ORPCProcedureMatcher {
|
4
4
|
private readonly router;
|
5
5
|
constructor(router: ANY_ROUTER);
|
@@ -0,0 +1,21 @@
|
|
1
|
+
import type { HTTPPath } from '@orpc/contract';
|
2
|
+
import type { Context } from '../../context';
|
3
|
+
export type FetchHandleOptions<T extends Context> = {
|
4
|
+
prefix?: HTTPPath;
|
5
|
+
} & (Record<never, never> extends T ? {
|
6
|
+
context?: T;
|
7
|
+
} : {
|
8
|
+
context: T;
|
9
|
+
});
|
10
|
+
export type FetchHandleRest<T extends Context> = [options: FetchHandleOptions<T>] | (Record<never, never> extends T ? [] : never);
|
11
|
+
export type FetchHandleResult = {
|
12
|
+
matched: true;
|
13
|
+
response: Response;
|
14
|
+
} | {
|
15
|
+
matched: false;
|
16
|
+
response: undefined;
|
17
|
+
};
|
18
|
+
export interface FetchHandler<T extends Context> {
|
19
|
+
handle: (request: Request, ...rest: FetchHandleRest<T>) => Promise<FetchHandleResult>;
|
20
|
+
}
|
21
|
+
//# sourceMappingURL=types.d.ts.map
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import type { Context as HonoContext, MiddlewareHandler } from 'hono';
|
2
|
+
import type { Context } from '../../context';
|
3
|
+
import type { FetchHandleOptions, FetchHandler } from '../fetch';
|
4
|
+
import { type Value } from '@orpc/shared';
|
5
|
+
export type CreateMiddlewareOptions<T extends Context> = Omit<FetchHandleOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
6
|
+
context?: Value<T, [HonoContext]>;
|
7
|
+
} : {
|
8
|
+
context: Value<T, [HonoContext]>;
|
9
|
+
});
|
10
|
+
export type CreateMiddlewareRest<T extends Context> = [options: CreateMiddlewareOptions<T>] | (Record<never, never> extends T ? [] : never);
|
11
|
+
export declare function createMiddleware<T extends Context>(handler: FetchHandler<T>, ...[options]: CreateMiddlewareRest<T>): MiddlewareHandler;
|
12
|
+
//# sourceMappingURL=middleware.d.ts.map
|
@@ -0,0 +1,19 @@
|
|
1
|
+
import type { NextRequest } from 'next/server';
|
2
|
+
import type { Context } from '../../context';
|
3
|
+
import type { FetchHandleOptions, FetchHandler } from '../fetch';
|
4
|
+
import { type Value } from '@orpc/shared';
|
5
|
+
export type ServeOptions<T extends Context> = Omit<FetchHandleOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
6
|
+
context?: Value<T, [NextRequest]>;
|
7
|
+
} : {
|
8
|
+
context: Value<T, [NextRequest]>;
|
9
|
+
});
|
10
|
+
export type ServeRest<T extends Context> = [options: ServeOptions<T>] | (Record<never, never> extends T ? [] : never);
|
11
|
+
export interface ServeResult {
|
12
|
+
GET: (req: NextRequest) => Promise<Response>;
|
13
|
+
POST: (req: NextRequest) => Promise<Response>;
|
14
|
+
PUT: (req: NextRequest) => Promise<Response>;
|
15
|
+
PATCH: (req: NextRequest) => Promise<Response>;
|
16
|
+
DELETE: (req: NextRequest) => Promise<Response>;
|
17
|
+
}
|
18
|
+
export declare function serve<T extends Context>(handler: FetchHandler<T>, ...[options]: ServeRest<T>): ServeResult;
|
19
|
+
//# sourceMappingURL=serve.d.ts.map
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import type { ServerResponse } from 'node:http';
|
2
|
+
import type { Context } from '../../context';
|
3
|
+
import type { Router } from '../../router';
|
4
|
+
import type { RPCHandlerOptions } from '../fetch/orpc-handler';
|
5
|
+
import type { RequestHandler, RequestHandleRest, RequestHandleResult } from './types';
|
6
|
+
import { type ExpressableIncomingMessage } from './request-listener';
|
7
|
+
export declare class RPCHandler<T extends Context> implements RequestHandler<T> {
|
8
|
+
private readonly orpcFetchHandler;
|
9
|
+
constructor(router: Router<T, any>, options?: NoInfer<RPCHandlerOptions<T>>);
|
10
|
+
handle(req: ExpressableIncomingMessage, res: ServerResponse, ...rest: RequestHandleRest<T>): Promise<RequestHandleResult>;
|
11
|
+
}
|
12
|
+
//# sourceMappingURL=orpc-handler.d.ts.map
|
@@ -0,0 +1,28 @@
|
|
1
|
+
import type { IncomingMessage, ServerResponse } from 'node:http';
|
2
|
+
export interface ExpressableIncomingMessage extends IncomingMessage {
|
3
|
+
originalUrl?: string;
|
4
|
+
}
|
5
|
+
/**
|
6
|
+
* Creates a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) object from a Node.js
|
7
|
+
* [`IncomingMessage`](https://nodejs.org/api/http.html#class-httpincomingmessage) and
|
8
|
+
* [`http.ServerResponse`](https://nodejs.org/api/http.html#class-httpserverresponse) pair.
|
9
|
+
*
|
10
|
+
*/
|
11
|
+
export declare function createRequest(req: ExpressableIncomingMessage, res: ServerResponse): Request;
|
12
|
+
/**
|
13
|
+
* Creates a [`Headers`](https://developer.mozilla.org/en-US/docs/Web/API/Headers) object from the headers
|
14
|
+
* in a Node.js [`IncomingMessage`](https://nodejs.org/api/http.html#class-httpincomingmessage).
|
15
|
+
*
|
16
|
+
* @param req The incoming request object.
|
17
|
+
* @returns A headers object.
|
18
|
+
*/
|
19
|
+
export declare function createHeaders(req: IncomingMessage): Headers;
|
20
|
+
/**
|
21
|
+
* Sends a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) to the client using the
|
22
|
+
* Node.js [`http.ServerResponse`](https://nodejs.org/api/http.html#class-httpserverresponse) object.
|
23
|
+
*
|
24
|
+
* @param res The server response object.
|
25
|
+
* @param response The response to send.
|
26
|
+
*/
|
27
|
+
export declare function sendResponse(res: ServerResponse, response: Response): Promise<void>;
|
28
|
+
//# sourceMappingURL=request-listener.d.ts.map
|
@@ -0,0 +1,22 @@
|
|
1
|
+
import type { HTTPPath } from '@orpc/contract';
|
2
|
+
import type { Promisable } from '@orpc/shared';
|
3
|
+
import type { IncomingMessage, ServerResponse } from 'node:http';
|
4
|
+
import type { Context } from '../../context';
|
5
|
+
export type RequestHandleOptions<T extends Context> = {
|
6
|
+
prefix?: HTTPPath;
|
7
|
+
beforeSend?: (response: Response, context: T) => Promisable<void>;
|
8
|
+
} & (Record<never, never> extends T ? {
|
9
|
+
context?: T;
|
10
|
+
} : {
|
11
|
+
context: T;
|
12
|
+
});
|
13
|
+
export type RequestHandleRest<T extends Context> = [options: RequestHandleOptions<T>] | (Record<never, never> extends T ? [] : never);
|
14
|
+
export type RequestHandleResult = {
|
15
|
+
matched: true;
|
16
|
+
} | {
|
17
|
+
matched: false;
|
18
|
+
};
|
19
|
+
export interface RequestHandler<T extends Context> {
|
20
|
+
handle: (req: IncomingMessage, res: ServerResponse, ...rest: RequestHandleRest<T>) => Promise<RequestHandleResult>;
|
21
|
+
}
|
22
|
+
//# sourceMappingURL=types.d.ts.map
|
@@ -0,0 +1,49 @@
|
|
1
|
+
import type { ContractBuilderConfig, ContractRouter, ErrorMap, ErrorMapGuard, ErrorMapSuggestions, HTTPPath, Route, Schema, SchemaInput, SchemaOutput, StrictErrorMap } from '@orpc/contract';
|
2
|
+
import type { ConflictContextGuard, Context, TypeCurrentContext, TypeInitialContext } from './context';
|
3
|
+
import type { ORPCErrorConstructorMap } from './error';
|
4
|
+
import type { FlattenLazy } from './lazy';
|
5
|
+
import type { Middleware } from './middleware';
|
6
|
+
import type { ProcedureHandler } from './procedure';
|
7
|
+
import type { Router } from './router';
|
8
|
+
import type { AdaptedRouter } from './router-builder';
|
9
|
+
import { ProcedureBuilder } from './procedure-builder';
|
10
|
+
import { ProcedureBuilderWithInput } from './procedure-builder-with-input';
|
11
|
+
import { ProcedureBuilderWithOutput } from './procedure-builder-with-output';
|
12
|
+
import { DecoratedProcedure } from './procedure-decorated';
|
13
|
+
import { RouterBuilder } from './router-builder';
|
14
|
+
export interface BuilderWithErrorsMiddlewaresDef<TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap> {
|
15
|
+
__initialContext?: TypeInitialContext<TInitialContext>;
|
16
|
+
__currentContext?: TypeCurrentContext<TCurrentContext>;
|
17
|
+
errorMap: TErrorMap;
|
18
|
+
middlewares: Middleware<any, any, any, any, any>[];
|
19
|
+
inputValidationIndex: number;
|
20
|
+
outputValidationIndex: number;
|
21
|
+
config: ContractBuilderConfig;
|
22
|
+
}
|
23
|
+
/**
|
24
|
+
* `BuilderWithErrorsMiddlewares` is a combination of `BuilderWithErrorsMiddlewares` and `BuilderWithErrors`.
|
25
|
+
*
|
26
|
+
* Why?
|
27
|
+
* - prevents .middleware after .use (can mislead the behavior)
|
28
|
+
* - prevents .contract after .errors (add error map to existing contract can make the contract invalid)
|
29
|
+
* - prevents .context after .use (middlewares required current context, so it tricky when change the current context)
|
30
|
+
*
|
31
|
+
*/
|
32
|
+
export declare class BuilderWithErrorsMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap> {
|
33
|
+
'~type': "BuilderWithErrorsMiddlewares";
|
34
|
+
'~orpc': BuilderWithErrorsMiddlewaresDef<TInitialContext, TCurrentContext, TErrorMap>;
|
35
|
+
constructor(def: BuilderWithErrorsMiddlewaresDef<TInitialContext, TCurrentContext, TErrorMap>);
|
36
|
+
errors<U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): BuilderWithErrorsMiddlewares<TInitialContext, TCurrentContext, TErrorMap & U>;
|
37
|
+
use<U extends Context>(middleware: Middleware<TCurrentContext, U, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>>): ConflictContextGuard<TCurrentContext & U> & BuilderWithErrorsMiddlewares<TInitialContext, TCurrentContext & U, TErrorMap>;
|
38
|
+
route(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TErrorMap>;
|
39
|
+
input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TErrorMap>;
|
40
|
+
output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, USchema, TErrorMap>;
|
41
|
+
handler<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, undefined, undefined, UFuncOutput, TErrorMap>): DecoratedProcedure<TInitialContext, TCurrentContext, undefined, undefined, UFuncOutput, TErrorMap, Route>;
|
42
|
+
prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap>;
|
43
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap>;
|
44
|
+
router<U extends Router<TCurrentContext, ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>>(router: U): AdaptedRouter<TInitialContext, U, TErrorMap>;
|
45
|
+
lazy<U extends Router<TCurrentContext, ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>>(loader: () => Promise<{
|
46
|
+
default: U;
|
47
|
+
}>): AdaptedRouter<TInitialContext, FlattenLazy<U>, TErrorMap>;
|
48
|
+
}
|
49
|
+
//# sourceMappingURL=builder-with-errors-middlewares.d.ts.map
|
@@ -0,0 +1,49 @@
|
|
1
|
+
import type { ContractBuilderConfig, ContractRouter, ErrorMap, ErrorMapGuard, ErrorMapSuggestions, HTTPPath, Route, Schema, SchemaInput, SchemaOutput, StrictErrorMap } from '@orpc/contract';
|
2
|
+
import type { BuilderConfig } from './builder';
|
3
|
+
import type { Context, TypeInitialContext } from './context';
|
4
|
+
import type { ORPCErrorConstructorMap } from './error';
|
5
|
+
import type { FlattenLazy } from './lazy';
|
6
|
+
import type { Middleware } from './middleware';
|
7
|
+
import type { DecoratedMiddleware } from './middleware-decorated';
|
8
|
+
import type { ProcedureHandler } from './procedure';
|
9
|
+
import type { Router } from './router';
|
10
|
+
import type { AdaptedRouter } from './router-builder';
|
11
|
+
import { BuilderWithErrorsMiddlewares } from './builder-with-errors-middlewares';
|
12
|
+
import { ProcedureBuilder } from './procedure-builder';
|
13
|
+
import { ProcedureBuilderWithInput } from './procedure-builder-with-input';
|
14
|
+
import { ProcedureBuilderWithOutput } from './procedure-builder-with-output';
|
15
|
+
import { DecoratedProcedure } from './procedure-decorated';
|
16
|
+
import { RouterBuilder } from './router-builder';
|
17
|
+
export interface BuilderWithErrorsDef<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
18
|
+
__initialContext?: TypeInitialContext<TInitialContext>;
|
19
|
+
errorMap: TErrorMap;
|
20
|
+
config: BuilderConfig;
|
21
|
+
}
|
22
|
+
/**
|
23
|
+
* `BuilderWithErrors` is a branch of `Builder` which it has error map.
|
24
|
+
*
|
25
|
+
* Why?
|
26
|
+
* - prevents .contract after .errors (add error map to existing contract can make the contract invalid)
|
27
|
+
*
|
28
|
+
*/
|
29
|
+
export declare class BuilderWithErrors<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
30
|
+
'~type': "BuilderWithErrors";
|
31
|
+
'~orpc': BuilderWithErrorsDef<TInitialContext, TErrorMap>;
|
32
|
+
constructor(def: BuilderWithErrorsDef<TInitialContext, TErrorMap>);
|
33
|
+
config(config: ContractBuilderConfig): BuilderWithErrors<TInitialContext, TErrorMap>;
|
34
|
+
context<UContext extends Context & TInitialContext = TInitialContext>(): BuilderWithErrors<UContext, TErrorMap>;
|
35
|
+
errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): BuilderWithErrors<TInitialContext, StrictErrorMap<U> & TErrorMap>;
|
36
|
+
middleware<UOutContext extends Context, TInput, TOutput = any>(middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<TErrorMap>>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<TErrorMap>>;
|
37
|
+
use<U extends Context>(middleware: Middleware<TInitialContext, U, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>>): BuilderWithErrorsMiddlewares<TInitialContext, TInitialContext & U, TErrorMap>;
|
38
|
+
route(route: Route): ProcedureBuilder<TInitialContext, TInitialContext, TErrorMap>;
|
39
|
+
input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): ProcedureBuilderWithInput<TInitialContext, TInitialContext, USchema, TErrorMap>;
|
40
|
+
output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): ProcedureBuilderWithOutput<TInitialContext, TInitialContext, USchema, TErrorMap>;
|
41
|
+
handler<UFuncOutput>(handler: ProcedureHandler<TInitialContext, undefined, undefined, UFuncOutput, TErrorMap>): DecoratedProcedure<TInitialContext, TInitialContext, undefined, undefined, UFuncOutput, TErrorMap, Route>;
|
42
|
+
prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TInitialContext, TErrorMap>;
|
43
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TInitialContext, TErrorMap>;
|
44
|
+
router<U extends Router<TInitialContext, ContractRouter<ErrorMap & Partial<TErrorMap>>>>(router: U): AdaptedRouter<TInitialContext, U, TErrorMap>;
|
45
|
+
lazy<U extends Router<TInitialContext, ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>>(loader: () => Promise<{
|
46
|
+
default: U;
|
47
|
+
}>): AdaptedRouter<TInitialContext, FlattenLazy<U>, TErrorMap>;
|
48
|
+
}
|
49
|
+
//# sourceMappingURL=builder-with-errors.d.ts.map
|
@@ -0,0 +1,49 @@
|
|
1
|
+
import type { ContractBuilderConfig, ContractRouter, ErrorMap, ErrorMapSuggestions, HTTPPath, Route, Schema, SchemaInput, SchemaOutput } from '@orpc/contract';
|
2
|
+
import type { ConflictContextGuard, Context, TypeCurrentContext, TypeInitialContext } from './context';
|
3
|
+
import type { Middleware } from './middleware';
|
4
|
+
import type { ProcedureHandler } from './procedure';
|
5
|
+
import type { Router } from './router';
|
6
|
+
import type { UnshiftedMiddlewaresRouter } from './router-utils';
|
7
|
+
import { BuilderWithErrorsMiddlewares } from './builder-with-errors-middlewares';
|
8
|
+
import { type ChainableImplementer } from './implementer-chainable';
|
9
|
+
import { type FlattenLazy } from './lazy';
|
10
|
+
import { ProcedureBuilder } from './procedure-builder';
|
11
|
+
import { ProcedureBuilderWithInput } from './procedure-builder-with-input';
|
12
|
+
import { ProcedureBuilderWithOutput } from './procedure-builder-with-output';
|
13
|
+
import { DecoratedProcedure } from './procedure-decorated';
|
14
|
+
import { RouterBuilder } from './router-builder';
|
15
|
+
/**
|
16
|
+
* `BuilderWithMiddlewares` is a branch of `Builder` which it has middlewares.
|
17
|
+
*
|
18
|
+
* Why?
|
19
|
+
* - prevents .middleware after .use (can mislead the behavior)
|
20
|
+
* - prevents .context after .use (middlewares required current context, so it tricky when change the current context)
|
21
|
+
*
|
22
|
+
*/
|
23
|
+
export interface BuilderWithMiddlewaresDef<TInitialContext extends Context, TCurrentContext extends Context> {
|
24
|
+
__initialContext?: TypeInitialContext<TInitialContext>;
|
25
|
+
__currentContext?: TypeCurrentContext<TCurrentContext>;
|
26
|
+
config: ContractBuilderConfig;
|
27
|
+
middlewares: Middleware<any, any, any, any, any>[];
|
28
|
+
inputValidationIndex: number;
|
29
|
+
outputValidationIndex: number;
|
30
|
+
}
|
31
|
+
export declare class BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context> {
|
32
|
+
'~type': "BuilderHasMiddlewares";
|
33
|
+
'~orpc': BuilderWithMiddlewaresDef<TInitialContext, TCurrentContext>;
|
34
|
+
constructor(def: BuilderWithMiddlewaresDef<TInitialContext, TCurrentContext>);
|
35
|
+
use<U extends Context>(middleware: Middleware<TCurrentContext, U, unknown, unknown, Record<never, never>>): ConflictContextGuard<TCurrentContext & U> & BuilderWithMiddlewares<TInitialContext, TCurrentContext & U>;
|
36
|
+
errors<U extends ErrorMap & ErrorMapSuggestions>(errors: U): BuilderWithErrorsMiddlewares<TInitialContext, TCurrentContext, U>;
|
37
|
+
route(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, Record<never, never>>;
|
38
|
+
input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, Record<never, never>>;
|
39
|
+
output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, USchema, Record<never, never>>;
|
40
|
+
handler<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, undefined, undefined, UFuncOutput, Record<never, never>>): DecoratedProcedure<TInitialContext, TCurrentContext, undefined, undefined, UFuncOutput, Record<never, never>, Route>;
|
41
|
+
prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, Record<never, never>>;
|
42
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, Record<never, never>>;
|
43
|
+
router<U extends Router<TCurrentContext, any>>(router: U): UnshiftedMiddlewaresRouter<U, TInitialContext>;
|
44
|
+
lazy<U extends Router<TCurrentContext, any>>(loader: () => Promise<{
|
45
|
+
default: U;
|
46
|
+
}>): UnshiftedMiddlewaresRouter<FlattenLazy<U>, TInitialContext>;
|
47
|
+
contract<U extends ContractRouter<any>>(contract: U): ChainableImplementer<TInitialContext, TCurrentContext, U>;
|
48
|
+
}
|
49
|
+
//# sourceMappingURL=builder-with-middlewares.d.ts.map
|
package/dist/src/builder.d.ts
CHANGED
@@ -1,35 +1,46 @@
|
|
1
|
-
import type {
|
2
|
-
import type {
|
1
|
+
import type { ContractBuilderConfig, ContractRouter, ErrorMap, ErrorMapSuggestions, HTTPPath, Route, Schema, SchemaInput, SchemaOutput, StrictErrorMap } from '@orpc/contract';
|
2
|
+
import type { ConflictContextGuard, Context, TypeInitialContext } from './context';
|
3
|
+
import type { DecoratedLazy } from './lazy-decorated';
|
3
4
|
import type { Middleware } from './middleware';
|
4
5
|
import type { DecoratedMiddleware } from './middleware-decorated';
|
6
|
+
import type { ProcedureHandler } from './procedure';
|
5
7
|
import type { Router } from './router';
|
6
|
-
import
|
7
|
-
import
|
8
|
+
import { BuilderWithErrors } from './builder-with-errors';
|
9
|
+
import { BuilderWithMiddlewares } from './builder-with-middlewares';
|
8
10
|
import { type ChainableImplementer } from './implementer-chainable';
|
9
|
-
import { type
|
11
|
+
import { type FlattenLazy } from './lazy';
|
10
12
|
import { ProcedureBuilder } from './procedure-builder';
|
11
|
-
import {
|
13
|
+
import { ProcedureBuilderWithInput } from './procedure-builder-with-input';
|
14
|
+
import { ProcedureBuilderWithOutput } from './procedure-builder-with-output';
|
15
|
+
import { DecoratedProcedure } from './procedure-decorated';
|
12
16
|
import { RouterBuilder } from './router-builder';
|
13
|
-
export interface
|
14
|
-
|
17
|
+
export interface BuilderConfig extends ContractBuilderConfig {
|
18
|
+
initialInputValidationIndex?: number;
|
19
|
+
initialOutputValidationIndex?: number;
|
15
20
|
}
|
16
|
-
export
|
21
|
+
export interface BuilderDef<TInitialContext extends Context> {
|
22
|
+
__initialContext?: TypeInitialContext<TInitialContext>;
|
23
|
+
config: BuilderConfig;
|
24
|
+
}
|
25
|
+
export declare class Builder<TInitialContext extends Context> {
|
17
26
|
'~type': "Builder";
|
18
|
-
'~orpc': BuilderDef<
|
19
|
-
constructor(def: BuilderDef<
|
20
|
-
|
21
|
-
|
22
|
-
middleware<
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
27
|
+
'~orpc': BuilderDef<TInitialContext>;
|
28
|
+
constructor(def: BuilderDef<TInitialContext>);
|
29
|
+
config(config: ContractBuilderConfig): Builder<TInitialContext>;
|
30
|
+
context<UContext extends Context & TInitialContext = TInitialContext>(): Builder<UContext>;
|
31
|
+
middleware<UOutContext extends Context, TInput, TOutput = any>(middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, Record<never, never>>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, Record<never, never>>;
|
32
|
+
errors<const U extends ErrorMap & ErrorMapSuggestions>(errors: U): BuilderWithErrors<TInitialContext, StrictErrorMap<U>>;
|
33
|
+
use<UOutContext extends Context>(middleware: Middleware<TInitialContext, UOutContext, unknown, unknown, Record<never, never>>): ConflictContextGuard<TInitialContext & UOutContext> & BuilderWithMiddlewares<TInitialContext, TInitialContext & UOutContext>;
|
34
|
+
route(route: Route): ProcedureBuilder<TInitialContext, TInitialContext, Record<never, never>>;
|
35
|
+
input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): ProcedureBuilderWithInput<TInitialContext, TInitialContext, USchema, Record<never, never>>;
|
36
|
+
output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): ProcedureBuilderWithOutput<TInitialContext, TInitialContext, USchema, Record<never, never>>;
|
37
|
+
handler<UFuncOutput>(handler: ProcedureHandler<TInitialContext, undefined, undefined, UFuncOutput, Record<never, never>>): DecoratedProcedure<TInitialContext, TInitialContext, undefined, undefined, UFuncOutput, Record<never, never>, Route>;
|
38
|
+
prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TInitialContext, Record<never, never>>;
|
39
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TInitialContext, Record<never, never>>;
|
40
|
+
router<U extends Router<TInitialContext, any>>(router: U): U;
|
41
|
+
lazy<U extends Router<TInitialContext, any>>(loader: () => Promise<{
|
31
42
|
default: U;
|
32
|
-
}>):
|
33
|
-
contract<U extends
|
43
|
+
}>): DecoratedLazy<FlattenLazy<U>>;
|
44
|
+
contract<U extends ContractRouter<any>>(contract: U): ChainableImplementer<TInitialContext, TInitialContext, U>;
|
34
45
|
}
|
35
46
|
//# sourceMappingURL=builder.d.ts.map
|
@@ -0,0 +1,10 @@
|
|
1
|
+
import type { IsNever } from '@orpc/shared';
|
2
|
+
export type Context = Record<string, any>;
|
3
|
+
export type TypeInitialContext<T extends Context> = (type: T) => any;
|
4
|
+
export type TypeCurrentContext<T extends Context> = {
|
5
|
+
type: T;
|
6
|
+
};
|
7
|
+
export type ConflictContextGuard<T extends Context> = true extends IsNever<T> | {
|
8
|
+
[K in keyof T]: IsNever<T[K]>;
|
9
|
+
}[keyof T] ? never : unknown;
|
10
|
+
//# sourceMappingURL=context.d.ts.map
|
@@ -0,0 +1,10 @@
|
|
1
|
+
import type { ErrorMap, ErrorMapItem, ORPCErrorOptions, Schema, SchemaInput, SchemaOutput } from '@orpc/contract';
|
2
|
+
import { ORPCError } from '@orpc/contract';
|
3
|
+
export type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<any, TData>, 'defined' | 'code' | 'status'>;
|
4
|
+
export type ORPCErrorConstructorMapItemRest<TData> = [options: ORPCErrorConstructorMapItemOptions<TData>] | (undefined extends TData ? [] : never);
|
5
|
+
export type ORPCErrorConstructorMapItem<TCode extends string, TDataSchema extends Schema> = (...rest: ORPCErrorConstructorMapItemRest<SchemaInput<TDataSchema>>) => ORPCError<TCode, SchemaOutput<TDataSchema>>;
|
6
|
+
export type ORPCErrorConstructorMap<T extends ErrorMap> = {
|
7
|
+
[K in keyof T]: K extends string ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, UInputSchema> : never : never;
|
8
|
+
};
|
9
|
+
export declare function createORPCErrorConstructorMap<T extends ErrorMap>(errors: T): ORPCErrorConstructorMap<T>;
|
10
|
+
//# sourceMappingURL=error.d.ts.map
|
package/dist/src/hidden.d.ts
CHANGED
@@ -1,6 +1,4 @@
|
|
1
|
-
import type {
|
2
|
-
export declare function setRouterContract<T extends object>(obj: T, contract: ContractRouter): T;
|
3
|
-
export declare function getRouterContract(obj: object): ContractRouter | undefined;
|
1
|
+
import type { HTTPPath } from '@orpc/contract';
|
4
2
|
export declare function deepSetLazyRouterPrefix<T extends object>(router: T, prefix: HTTPPath): T;
|
5
3
|
export declare function getLazyRouterPrefix(obj: object): HTTPPath | undefined;
|
6
4
|
//# sourceMappingURL=hidden.d.ts.map
|
@@ -1,10 +1,16 @@
|
|
1
|
+
import type { Context, TypeCurrentContext, TypeInitialContext } from './context';
|
1
2
|
import type { Middleware } from './middleware';
|
2
|
-
import type { Context, MergeContext, WELL_CONTEXT } from './types';
|
3
3
|
import { type ContractProcedure, type ContractRouter } from '@orpc/contract';
|
4
4
|
import { ProcedureImplementer } from './procedure-implementer';
|
5
5
|
import { RouterImplementer } from './router-implementer';
|
6
|
-
export type ChainableImplementer<
|
7
|
-
[K in keyof TContract]: TContract[K] extends ContractRouter ? ChainableImplementer<
|
8
|
-
} & Omit<RouterImplementer<
|
9
|
-
export declare function createChainableImplementer<
|
6
|
+
export type ChainableImplementer<TInitialContext extends Context, TCurrentContext extends Context, TContract extends ContractRouter<any>> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer URoute> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, URoute> : {
|
7
|
+
[K in keyof TContract]: TContract[K] extends ContractRouter<any> ? ChainableImplementer<TInitialContext, TCurrentContext, TContract[K]> : never;
|
8
|
+
} & Omit<RouterImplementer<TInitialContext, TCurrentContext, TContract>, '~type' | '~orpc'>;
|
9
|
+
export declare function createChainableImplementer<TInitialContext extends Context, TCurrentContext extends Context, TContract extends ContractRouter<any>>(contract: TContract, options: {
|
10
|
+
__initialContext?: TypeInitialContext<TInitialContext>;
|
11
|
+
__currentContext?: TypeCurrentContext<TCurrentContext>;
|
12
|
+
middlewares: Middleware<any, any, any, any, any>[];
|
13
|
+
inputValidationIndex: number;
|
14
|
+
outputValidationIndex: number;
|
15
|
+
}): ChainableImplementer<TInitialContext, TCurrentContext, TContract>;
|
10
16
|
//# sourceMappingURL=implementer-chainable.d.ts.map
|