@orpc/contract 0.15.0 → 0.17.0

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/index.js CHANGED
@@ -1,96 +1,106 @@
1
1
  // src/procedure.ts
2
2
  var ContractProcedure = class {
3
- constructor(zz$cp) {
4
- this.zz$cp = zz$cp;
3
+ "~type" = "ContractProcedure";
4
+ "~orpc";
5
+ constructor(def) {
6
+ this["~orpc"] = def;
5
7
  }
6
8
  };
9
+ function isContractProcedure(item) {
10
+ if (item instanceof ContractProcedure) {
11
+ return true;
12
+ }
13
+ return (typeof item === "object" || typeof item === "function") && item !== null && "~type" in item && item["~type"] === "ContractProcedure" && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "InputSchema" in item["~orpc"] && "OutputSchema" in item["~orpc"];
14
+ }
15
+
16
+ // src/procedure-decorated.ts
7
17
  var DecoratedContractProcedure = class _DecoratedContractProcedure extends ContractProcedure {
8
- static decorate(cp) {
9
- if (cp instanceof _DecoratedContractProcedure)
10
- return cp;
11
- return new _DecoratedContractProcedure(cp.zz$cp);
18
+ static decorate(procedure) {
19
+ if (procedure instanceof _DecoratedContractProcedure) {
20
+ return procedure;
21
+ }
22
+ return new _DecoratedContractProcedure(procedure["~orpc"]);
12
23
  }
13
- route(opts) {
24
+ route(route) {
14
25
  return new _DecoratedContractProcedure({
15
- ...this.zz$cp,
16
- ...opts,
17
- method: opts.method,
18
- path: opts.path
26
+ ...this["~orpc"],
27
+ route
19
28
  });
20
29
  }
21
30
  prefix(prefix) {
22
- if (!this.zz$cp.path)
23
- return this;
24
31
  return new _DecoratedContractProcedure({
25
- ...this.zz$cp,
26
- path: `${prefix}${this.zz$cp.path}`
32
+ ...this["~orpc"],
33
+ ...this["~orpc"].route?.path ? {
34
+ route: {
35
+ ...this["~orpc"].route,
36
+ path: `${prefix}${this["~orpc"].route.path}`
37
+ }
38
+ } : void 0
27
39
  });
28
40
  }
29
- addTags(...tags) {
30
- if (!tags.length)
31
- return this;
41
+ unshiftTag(...tags) {
32
42
  return new _DecoratedContractProcedure({
33
- ...this.zz$cp,
34
- tags: [...this.zz$cp.tags ?? [], ...tags]
43
+ ...this["~orpc"],
44
+ route: {
45
+ ...this["~orpc"].route,
46
+ tags: [
47
+ ...tags,
48
+ ...this["~orpc"].route?.tags?.filter((tag) => !tags.includes(tag)) ?? []
49
+ ]
50
+ }
35
51
  });
36
52
  }
37
53
  input(schema, example) {
38
54
  return new _DecoratedContractProcedure({
39
- ...this.zz$cp,
55
+ ...this["~orpc"],
40
56
  InputSchema: schema,
41
57
  inputExample: example
42
58
  });
43
59
  }
44
60
  output(schema, example) {
45
61
  return new _DecoratedContractProcedure({
46
- ...this.zz$cp,
62
+ ...this["~orpc"],
47
63
  OutputSchema: schema,
48
64
  outputExample: example
49
65
  });
50
66
  }
51
67
  };
52
- function isContractProcedure(item) {
53
- if (item instanceof ContractProcedure)
54
- return true;
55
- return (typeof item === "object" || typeof item === "function") && item !== null && "zz$cp" in item && typeof item.zz$cp === "object" && item.zz$cp !== null && "InputSchema" in item.zz$cp && "OutputSchema" in item.zz$cp;
56
- }
57
68
 
58
69
  // src/router-builder.ts
59
70
  var ContractRouterBuilder = class _ContractRouterBuilder {
60
- constructor(zz$crb) {
61
- this.zz$crb = zz$crb;
62
- if (zz$crb.prefix && zz$crb.prefix.includes("{")) {
63
- throw new Error('Prefix cannot contain "{" for dynamic routing');
64
- }
71
+ "~type" = "ContractProcedure";
72
+ "~orpc";
73
+ constructor(def) {
74
+ this["~orpc"] = def;
65
75
  }
66
76
  prefix(prefix) {
67
77
  return new _ContractRouterBuilder({
68
- ...this.zz$crb,
69
- prefix: `${this.zz$crb.prefix ?? ""}${prefix}`
78
+ ...this["~orpc"],
79
+ prefix: `${this["~orpc"].prefix ?? ""}${prefix}`
70
80
  });
71
81
  }
72
- tags(...tags) {
73
- if (!tags.length)
74
- return this;
82
+ tag(...tags) {
75
83
  return new _ContractRouterBuilder({
76
- ...this.zz$crb,
77
- tags: [...this.zz$crb.tags ?? [], ...tags]
84
+ ...this["~orpc"],
85
+ tags: [...this["~orpc"].tags ?? [], ...tags]
78
86
  });
79
87
  }
80
88
  router(router) {
81
- const handled = {};
82
- for (const key in router) {
83
- const item = router[key];
84
- if (isContractProcedure(item)) {
85
- const decorated = DecoratedContractProcedure.decorate(item).addTags(
86
- ...this.zz$crb.tags ?? []
87
- );
88
- handled[key] = this.zz$crb.prefix ? decorated.prefix(this.zz$crb.prefix) : decorated;
89
- } else {
90
- handled[key] = this.router(item);
89
+ if (isContractProcedure(router)) {
90
+ let decorated = DecoratedContractProcedure.decorate(router);
91
+ if (this["~orpc"].tags) {
92
+ decorated = decorated.unshiftTag(...this["~orpc"].tags);
93
+ }
94
+ if (this["~orpc"].prefix) {
95
+ decorated = decorated.prefix(this["~orpc"].prefix);
91
96
  }
97
+ return decorated;
92
98
  }
93
- return handled;
99
+ const adapted = {};
100
+ for (const key in router) {
101
+ adapted[key] = this.router(router[key]);
102
+ }
103
+ return adapted;
94
104
  }
95
105
  };
96
106
 
@@ -101,16 +111,16 @@ var ContractBuilder = class {
101
111
  prefix
102
112
  });
103
113
  }
104
- tags(...tags) {
114
+ tag(...tags) {
105
115
  return new ContractRouterBuilder({
106
116
  tags
107
117
  });
108
118
  }
109
- route(opts) {
119
+ route(route) {
110
120
  return new DecoratedContractProcedure({
121
+ route,
111
122
  InputSchema: void 0,
112
- OutputSchema: void 0,
113
- ...opts
123
+ OutputSchema: void 0
114
124
  });
115
125
  }
116
126
  input(schema, example) {
@@ -122,9 +132,9 @@ var ContractBuilder = class {
122
132
  }
123
133
  output(schema, example) {
124
134
  return new DecoratedContractProcedure({
125
- InputSchema: void 0,
126
135
  OutputSchema: schema,
127
- outputExample: example
136
+ outputExample: example,
137
+ InputSchema: void 0
128
138
  });
129
139
  }
130
140
  router(router) {
@@ -132,48 +142,14 @@ var ContractBuilder = class {
132
142
  }
133
143
  };
134
144
 
135
- // src/constants.ts
136
- var ORPC_HEADER = "x-orpc-transformer";
137
- var ORPC_HEADER_VALUE = "t";
138
-
139
- // src/router.ts
140
- function eachContractRouterLeaf(router, callback, prefix = []) {
141
- for (const key in router) {
142
- const item = router[key];
143
- if (isContractProcedure(item)) {
144
- callback(item, [...prefix, key]);
145
- } else {
146
- eachContractRouterLeaf(item, callback, [...prefix, key]);
147
- }
148
- }
149
- }
150
-
151
- // src/utils.ts
152
- function standardizeHTTPPath(path) {
153
- return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
154
- }
155
- function prefixHTTPPath(prefix, path) {
156
- const prefix_ = standardizeHTTPPath(prefix);
157
- const path_ = standardizeHTTPPath(path);
158
- if (prefix_ === "/")
159
- return path_;
160
- if (path_ === "/")
161
- return prefix_;
162
- return `${prefix_}${path_}`;
163
- }
164
-
165
145
  // src/index.ts
166
146
  var oc = new ContractBuilder();
167
147
  export {
168
148
  ContractBuilder,
169
149
  ContractProcedure,
150
+ ContractRouterBuilder,
170
151
  DecoratedContractProcedure,
171
- ORPC_HEADER,
172
- ORPC_HEADER_VALUE,
173
- eachContractRouterLeaf,
174
152
  isContractProcedure,
175
- oc,
176
- prefixHTTPPath,
177
- standardizeHTTPPath
153
+ oc
178
154
  };
179
155
  //# sourceMappingURL=index.js.map
@@ -1,13 +1,14 @@
1
+ import type { RouteOptions } from './procedure';
1
2
  import type { ContractRouter } from './router';
2
3
  import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
3
- import { DecoratedContractProcedure, type RouteOptions } from './procedure';
4
+ import { DecoratedContractProcedure } from './procedure-decorated';
4
5
  import { ContractRouterBuilder } from './router-builder';
5
6
  export declare class ContractBuilder {
6
7
  prefix(prefix: HTTPPath): ContractRouterBuilder;
7
- tags(...tags: string[]): ContractRouterBuilder;
8
- route(opts: RouteOptions): DecoratedContractProcedure<undefined, undefined>;
9
- input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): DecoratedContractProcedure<USchema, undefined>;
10
- output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): DecoratedContractProcedure<undefined, USchema>;
8
+ tag(...tags: string[]): ContractRouterBuilder;
9
+ route(route: RouteOptions): DecoratedContractProcedure<undefined, undefined>;
10
+ input<U extends Schema = undefined>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined>;
11
+ output<U extends Schema = undefined>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U>;
11
12
  router<T extends ContractRouter>(router: T): T;
12
13
  }
13
14
  //# sourceMappingURL=builder.d.ts.map
@@ -1,10 +1,10 @@
1
1
  /** unnoq */
2
2
  import { ContractBuilder } from './builder';
3
3
  export * from './builder';
4
- export * from './constants';
5
4
  export * from './procedure';
5
+ export * from './procedure-decorated';
6
6
  export * from './router';
7
+ export * from './router-builder';
7
8
  export * from './types';
8
- export * from './utils';
9
9
  export declare const oc: ContractBuilder;
10
10
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,12 @@
1
+ import type { RouteOptions } from './procedure';
2
+ import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
3
+ import { ContractProcedure } from './procedure';
4
+ export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> extends ContractProcedure<TInputSchema, TOutputSchema> {
5
+ static decorate<UInputSchema extends Schema = undefined, UOutputSchema extends Schema = undefined>(procedure: ContractProcedure<UInputSchema, UOutputSchema>): DecoratedContractProcedure<UInputSchema, UOutputSchema>;
6
+ route(route: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
7
+ prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
8
+ unshiftTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
9
+ input<U extends Schema = undefined>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, TOutputSchema>;
10
+ output<U extends Schema = undefined>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<TInputSchema, U>;
11
+ }
12
+ //# sourceMappingURL=procedure-decorated.d.ts.map
@@ -1,47 +1,25 @@
1
- import type { HTTPMethod, HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
1
+ import type { HTTPMethod, HTTPPath, Schema, SchemaOutput } from './types';
2
2
  export interface RouteOptions {
3
3
  method?: HTTPMethod;
4
4
  path?: HTTPPath;
5
5
  summary?: string;
6
6
  description?: string;
7
7
  deprecated?: boolean;
8
- tags?: string[];
8
+ tags?: readonly string[];
9
+ }
10
+ export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema> {
11
+ route?: RouteOptions;
12
+ InputSchema: TInputSchema;
13
+ inputExample?: SchemaOutput<TInputSchema>;
14
+ OutputSchema: TOutputSchema;
15
+ outputExample?: SchemaOutput<TOutputSchema>;
9
16
  }
10
17
  export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> {
11
- zz$cp: {
12
- path?: HTTPPath;
13
- method?: HTTPMethod;
14
- summary?: string;
15
- description?: string;
16
- deprecated?: boolean;
17
- tags?: string[];
18
- InputSchema: TInputSchema;
19
- inputExample?: SchemaOutput<TInputSchema>;
20
- OutputSchema: TOutputSchema;
21
- outputExample?: SchemaOutput<TOutputSchema>;
22
- };
23
- constructor(zz$cp: {
24
- path?: HTTPPath;
25
- method?: HTTPMethod;
26
- summary?: string;
27
- description?: string;
28
- deprecated?: boolean;
29
- tags?: string[];
30
- InputSchema: TInputSchema;
31
- inputExample?: SchemaOutput<TInputSchema>;
32
- OutputSchema: TOutputSchema;
33
- outputExample?: SchemaOutput<TOutputSchema>;
34
- });
18
+ '~type': "ContractProcedure";
19
+ '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema>;
20
+ constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema>);
35
21
  }
22
+ export type ANY_CONTRACT_PROCEDURE = ContractProcedure<any, any>;
36
23
  export type WELL_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema>;
37
- export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> extends ContractProcedure<TInputSchema, TOutputSchema> {
38
- static decorate<TInputSchema extends Schema, TOutputSchema extends Schema>(cp: ContractProcedure<TInputSchema, TOutputSchema>): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
39
- route(opts: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
40
- prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
41
- addTags(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
42
- input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): DecoratedContractProcedure<USchema, TOutputSchema>;
43
- output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): DecoratedContractProcedure<TInputSchema, USchema>;
44
- }
45
- export type WELL_DEFINED_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema>;
46
- export declare function isContractProcedure(item: unknown): item is WELL_DEFINED_CONTRACT_PROCEDURE;
24
+ export declare function isContractProcedure(item: unknown): item is ANY_CONTRACT_PROCEDURE;
47
25
  //# sourceMappingURL=procedure.d.ts.map
@@ -1,16 +1,20 @@
1
- import type { ContractRouter, HandledContractRouter } from './router';
1
+ import type { ContractProcedure } from './procedure';
2
+ import type { ContractRouter } from './router';
2
3
  import type { HTTPPath } from './types';
4
+ import { DecoratedContractProcedure } from './procedure-decorated';
5
+ export type AdaptedContractRouter<TContract extends ContractRouter> = {
6
+ [K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema> ? DecoratedContractProcedure<UInputSchema, UOutputSchema> : TContract[K] extends ContractRouter ? AdaptedContractRouter<TContract[K]> : never;
7
+ };
8
+ export interface ContractRouterBuilderDef {
9
+ prefix?: HTTPPath;
10
+ tags?: string[];
11
+ }
3
12
  export declare class ContractRouterBuilder {
4
- zz$crb: {
5
- prefix?: HTTPPath;
6
- tags?: string[];
7
- };
8
- constructor(zz$crb: {
9
- prefix?: HTTPPath;
10
- tags?: string[];
11
- });
13
+ '~type': "ContractProcedure";
14
+ '~orpc': ContractRouterBuilderDef;
15
+ constructor(def: ContractRouterBuilderDef);
12
16
  prefix(prefix: HTTPPath): ContractRouterBuilder;
13
- tags(...tags: string[]): ContractRouterBuilder;
14
- router<T extends ContractRouter>(router: T): HandledContractRouter<T>;
17
+ tag(...tags: string[]): ContractRouterBuilder;
18
+ router<T extends ContractRouter>(router: T): AdaptedContractRouter<T>;
15
19
  }
16
20
  //# sourceMappingURL=router-builder.d.ts.map
@@ -1,16 +1,12 @@
1
+ import type { ANY_CONTRACT_PROCEDURE, ContractProcedure } from './procedure';
1
2
  import type { SchemaInput, SchemaOutput } from './types';
2
- import { type ContractProcedure, type DecoratedContractProcedure, type WELL_DEFINED_CONTRACT_PROCEDURE } from './procedure';
3
- export interface ContractRouter {
4
- [k: string]: ContractProcedure<any, any> | ContractRouter;
5
- }
6
- export type HandledContractRouter<TContract extends ContractRouter> = {
7
- [K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema> ? DecoratedContractProcedure<UInputSchema, UOutputSchema> : TContract[K] extends ContractRouter ? HandledContractRouter<TContract[K]> : never;
3
+ export type ContractRouter = ANY_CONTRACT_PROCEDURE | {
4
+ [k: string]: ContractRouter;
8
5
  };
9
- export declare function eachContractRouterLeaf(router: ContractRouter, callback: (item: WELL_DEFINED_CONTRACT_PROCEDURE, path: string[]) => void, prefix?: string[]): void;
10
- export type InferContractRouterInputs<T extends ContractRouter> = {
11
- [K in keyof T]: T[K] extends ContractProcedure<infer UInputSchema, any> ? SchemaInput<UInputSchema> : T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
6
+ export type InferContractRouterInputs<T extends ContractRouter> = T extends ContractProcedure<infer UInputSchema, any> ? SchemaInput<UInputSchema> : {
7
+ [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
12
8
  };
13
- export type InferContractRouterOutputs<T extends ContractRouter> = {
14
- [K in keyof T]: T[K] extends ContractProcedure<any, infer UOutputSchema> ? SchemaOutput<UOutputSchema> : T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
9
+ export type InferContractRouterOutputs<T extends ContractRouter> = T extends ContractProcedure<any, infer UOutputSchema> ? SchemaOutput<UOutputSchema> : {
10
+ [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
15
11
  };
16
12
  //# sourceMappingURL=router.d.ts.map
@@ -1,8 +1,7 @@
1
- import type { input, output, ZodType } from 'zod';
1
+ import type { StandardSchemaV1 } from '@standard-schema/spec';
2
2
  export type HTTPPath = `/${string}`;
3
3
  export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
4
- export type HTTPStatus = number;
5
- export type Schema = ZodType<any, any, any> | undefined;
6
- export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends ZodType<any, any, any> ? input<TSchema> : TFallback;
7
- export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends ZodType<any, any, any> ? output<TSchema> : TFallback;
4
+ export type Schema = StandardSchemaV1 | undefined;
5
+ export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : TFallback;
6
+ export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TFallback;
8
7
  //# sourceMappingURL=types.d.ts.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/contract",
3
3
  "type": "module",
4
- "version": "0.15.0",
4
+ "version": "0.17.0",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -28,11 +28,14 @@
28
28
  "!**/*.tsbuildinfo",
29
29
  "dist"
30
30
  ],
31
- "peerDependencies": {
32
- "zod": ">=3.23.0"
33
- },
34
31
  "dependencies": {
35
- "@orpc/shared": "0.15.0"
32
+ "@standard-schema/spec": "1.0.0-beta.4",
33
+ "@orpc/shared": "0.17.0"
34
+ },
35
+ "devDependencies": {
36
+ "arktype": "2.0.0-rc.26",
37
+ "valibot": "1.0.0-beta.9",
38
+ "zod": "3.24.1"
36
39
  },
37
40
  "scripts": {
38
41
  "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
@@ -1,3 +0,0 @@
1
- export declare const ORPC_HEADER = "x-orpc-transformer";
2
- export declare const ORPC_HEADER_VALUE = "t";
3
- //# sourceMappingURL=constants.d.ts.map
@@ -1,4 +0,0 @@
1
- import type { HTTPPath } from './types';
2
- export declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
3
- export declare function prefixHTTPPath(prefix: HTTPPath, path: HTTPPath): HTTPPath;
4
- //# sourceMappingURL=utils.d.ts.map