@orpc/contract 0.0.0-next.f22c7ec → 0.0.0-next.f4539d6
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 +109 -0
- package/dist/index.d.mts +540 -0
- package/dist/index.d.ts +540 -0
- package/dist/index.mjs +355 -0
- package/package.json +12 -15
- package/dist/index.js +0 -406
- package/dist/src/builder.d.ts +0 -23
- package/dist/src/client-utils.d.ts +0 -5
- package/dist/src/client.d.ts +0 -19
- package/dist/src/config.d.ts +0 -36
- package/dist/src/error-map.d.ts +0 -58
- package/dist/src/error-orpc.d.ts +0 -109
- package/dist/src/error.d.ts +0 -13
- package/dist/src/index.d.ts +0 -18
- package/dist/src/procedure-client.d.ts +0 -6
- package/dist/src/procedure-decorated.d.ts +0 -14
- package/dist/src/procedure.d.ts +0 -83
- package/dist/src/router-builder.d.ts +0 -23
- package/dist/src/router-client.d.ts +0 -7
- package/dist/src/router.d.ts +0 -13
- package/dist/src/types.d.ts +0 -11
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import type { Client } from './client';
|
|
2
|
-
import type { ErrorFromErrorMap } from './error';
|
|
3
|
-
import type { ErrorMap } from './error-map';
|
|
4
|
-
import type { Schema, SchemaInput, SchemaOutput } from './types';
|
|
5
|
-
export type ContractProcedureClient<TClientContext, TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> = Client<TClientContext, SchemaInput<TInputSchema>, SchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
6
|
-
//# sourceMappingURL=procedure-client.d.ts.map
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions } from './error-map';
|
|
2
|
-
import type { RouteOptions } from './procedure';
|
|
3
|
-
import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
|
|
4
|
-
import { ContractProcedure } from './procedure';
|
|
5
|
-
export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap> {
|
|
6
|
-
static decorate<UInputSchema extends Schema, UOutputSchema extends Schema, TErrorMap extends ErrorMap>(procedure: ContractProcedure<UInputSchema, UOutputSchema, TErrorMap>): DecoratedContractProcedure<UInputSchema, UOutputSchema, TErrorMap>;
|
|
7
|
-
route(route: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
|
|
8
|
-
prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
|
|
9
|
-
unshiftTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
|
|
10
|
-
input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, TOutputSchema, TErrorMap>;
|
|
11
|
-
output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<TInputSchema, U, TErrorMap>;
|
|
12
|
-
errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap & U>;
|
|
13
|
-
}
|
|
14
|
-
//# sourceMappingURL=procedure-decorated.d.ts.map
|
package/dist/src/procedure.d.ts
DELETED
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap } from './error-map';
|
|
2
|
-
import type { HTTPMethod, HTTPPath, InputStructure, OutputStructure, Schema, SchemaOutput } from './types';
|
|
3
|
-
export interface RouteOptions {
|
|
4
|
-
method?: HTTPMethod;
|
|
5
|
-
path?: HTTPPath;
|
|
6
|
-
summary?: string;
|
|
7
|
-
description?: string;
|
|
8
|
-
deprecated?: boolean;
|
|
9
|
-
tags?: readonly string[];
|
|
10
|
-
/**
|
|
11
|
-
* The status code of the response when the procedure is successful.
|
|
12
|
-
*
|
|
13
|
-
* @default 200
|
|
14
|
-
*/
|
|
15
|
-
successStatus?: number;
|
|
16
|
-
/**
|
|
17
|
-
* The description of the response when the procedure is successful.
|
|
18
|
-
*
|
|
19
|
-
* @default 'OK'
|
|
20
|
-
*/
|
|
21
|
-
successDescription?: string;
|
|
22
|
-
/**
|
|
23
|
-
* Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
|
|
24
|
-
*
|
|
25
|
-
* @option 'compact'
|
|
26
|
-
* Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
|
|
27
|
-
*
|
|
28
|
-
* @option 'detailed'
|
|
29
|
-
* Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
|
|
30
|
-
*
|
|
31
|
-
* Example:
|
|
32
|
-
* ```ts
|
|
33
|
-
* const input = {
|
|
34
|
-
* params: { id: 1 },
|
|
35
|
-
* query: { search: 'hello' },
|
|
36
|
-
* headers: { 'Content-Type': 'application/json' },
|
|
37
|
-
* body: { name: 'John' },
|
|
38
|
-
* }
|
|
39
|
-
* ```
|
|
40
|
-
*
|
|
41
|
-
* @default 'compact'
|
|
42
|
-
*/
|
|
43
|
-
inputStructure?: InputStructure;
|
|
44
|
-
/**
|
|
45
|
-
* Determines how the response should be structured based on the output.
|
|
46
|
-
*
|
|
47
|
-
* @option 'compact'
|
|
48
|
-
* Includes only the body data, encoded directly in the response.
|
|
49
|
-
*
|
|
50
|
-
* @option 'detailed'
|
|
51
|
-
* Separates the output into `headers` and `body` fields.
|
|
52
|
-
* - `headers`: Custom headers to merge with the response headers.
|
|
53
|
-
* - `body`: The response data.
|
|
54
|
-
*
|
|
55
|
-
* Example:
|
|
56
|
-
* ```ts
|
|
57
|
-
* const output = {
|
|
58
|
-
* headers: { 'x-custom-header': 'value' },
|
|
59
|
-
* body: { message: 'Hello, world!' },
|
|
60
|
-
* };
|
|
61
|
-
* ```
|
|
62
|
-
*
|
|
63
|
-
* @default 'compact'
|
|
64
|
-
*/
|
|
65
|
-
outputStructure?: OutputStructure;
|
|
66
|
-
}
|
|
67
|
-
export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> {
|
|
68
|
-
route?: RouteOptions;
|
|
69
|
-
InputSchema: TInputSchema;
|
|
70
|
-
inputExample?: SchemaOutput<TInputSchema>;
|
|
71
|
-
OutputSchema: TOutputSchema;
|
|
72
|
-
outputExample?: SchemaOutput<TOutputSchema>;
|
|
73
|
-
errorMap: TErrorMap;
|
|
74
|
-
}
|
|
75
|
-
export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> {
|
|
76
|
-
'~type': "ContractProcedure";
|
|
77
|
-
'~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>;
|
|
78
|
-
constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>);
|
|
79
|
-
}
|
|
80
|
-
export type ANY_CONTRACT_PROCEDURE = ContractProcedure<any, any, any>;
|
|
81
|
-
export type WELL_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema, ErrorMap>;
|
|
82
|
-
export declare function isContractProcedure(item: unknown): item is ANY_CONTRACT_PROCEDURE;
|
|
83
|
-
//# sourceMappingURL=procedure.d.ts.map
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions, StrictErrorMap } from './error-map';
|
|
2
|
-
import type { ContractProcedure } from './procedure';
|
|
3
|
-
import type { ContractRouter } from './router';
|
|
4
|
-
import type { HTTPPath } from './types';
|
|
5
|
-
import { DecoratedContractProcedure } from './procedure-decorated';
|
|
6
|
-
export type AdaptedContractRouter<TContract extends ContractRouter<any>, TErrorMapExtra extends ErrorMap> = {
|
|
7
|
-
[K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrors> ? DecoratedContractProcedure<UInputSchema, UOutputSchema, UErrors & TErrorMapExtra> : TContract[K] extends ContractRouter<any> ? AdaptedContractRouter<TContract[K], TErrorMapExtra> : never;
|
|
8
|
-
};
|
|
9
|
-
export interface ContractRouterBuilderDef<TErrorMap extends ErrorMap> {
|
|
10
|
-
prefix?: HTTPPath;
|
|
11
|
-
tags?: string[];
|
|
12
|
-
errorMap: TErrorMap;
|
|
13
|
-
}
|
|
14
|
-
export declare class ContractRouterBuilder<TErrorMap extends ErrorMap> {
|
|
15
|
-
'~type': "ContractProcedure";
|
|
16
|
-
'~orpc': ContractRouterBuilderDef<TErrorMap>;
|
|
17
|
-
constructor(def: ContractRouterBuilderDef<TErrorMap>);
|
|
18
|
-
prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap>;
|
|
19
|
-
tag(...tags: string[]): ContractRouterBuilder<TErrorMap>;
|
|
20
|
-
errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): ContractRouterBuilder<U & TErrorMap>;
|
|
21
|
-
router<T extends ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>(router: T): AdaptedContractRouter<T, TErrorMap>;
|
|
22
|
-
}
|
|
23
|
-
//# sourceMappingURL=router-builder.d.ts.map
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { ContractProcedure } from './procedure';
|
|
2
|
-
import type { ContractProcedureClient } from './procedure-client';
|
|
3
|
-
import type { ContractRouter } from './router';
|
|
4
|
-
export type ContractRouterClient<TRouter extends ContractRouter<any>, TClientContext> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
|
|
5
|
-
[K in keyof TRouter]: TRouter[K] extends ContractRouter<any> ? ContractRouterClient<TRouter[K], TClientContext> : never;
|
|
6
|
-
};
|
|
7
|
-
//# sourceMappingURL=router-client.d.ts.map
|
package/dist/src/router.d.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap } from './error-map';
|
|
2
|
-
import type { ContractProcedure } from './procedure';
|
|
3
|
-
import type { SchemaInput, SchemaOutput } from './types';
|
|
4
|
-
export type ContractRouter<T extends ErrorMap> = ContractProcedure<any, any, T> | {
|
|
5
|
-
[k: string]: ContractRouter<T>;
|
|
6
|
-
};
|
|
7
|
-
export type InferContractRouterInputs<T extends ContractRouter<any>> = T extends ContractProcedure<infer UInputSchema, any, any> ? SchemaInput<UInputSchema> : {
|
|
8
|
-
[K in keyof T]: T[K] extends ContractRouter<any> ? InferContractRouterInputs<T[K]> : never;
|
|
9
|
-
};
|
|
10
|
-
export type InferContractRouterOutputs<T extends ContractRouter<any>> = T extends ContractProcedure<any, infer UOutputSchema, any> ? SchemaOutput<UOutputSchema> : {
|
|
11
|
-
[K in keyof T]: T[K] extends ContractRouter<any> ? InferContractRouterOutputs<T[K]> : never;
|
|
12
|
-
};
|
|
13
|
-
//# sourceMappingURL=router.d.ts.map
|
package/dist/src/types.d.ts
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import type { FindGlobalInstanceType } from '@orpc/shared';
|
|
2
|
-
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
3
|
-
export type HTTPPath = `/${string}`;
|
|
4
|
-
export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
5
|
-
export type InputStructure = 'compact' | 'detailed';
|
|
6
|
-
export type OutputStructure = 'compact' | 'detailed';
|
|
7
|
-
export type Schema = StandardSchemaV1 | undefined;
|
|
8
|
-
export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : TFallback;
|
|
9
|
-
export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TFallback;
|
|
10
|
-
export type AbortSignal = FindGlobalInstanceType<'AbortSignal'>;
|
|
11
|
-
//# sourceMappingURL=types.d.ts.map
|