@temporary-name/server 1.9.3-alpha.32780b2c7ad58cf8dcbc93a40f13494185223e6e → 1.9.3-alpha.3bfad2d4c9c25a8fb0e01d57b30d58f74bc8f953

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.
Files changed (42) hide show
  1. package/dist/adapters/aws-lambda/index.d.mts +4 -6
  2. package/dist/adapters/aws-lambda/index.d.ts +4 -6
  3. package/dist/adapters/aws-lambda/index.mjs +4 -4
  4. package/dist/adapters/fetch/index.d.mts +8 -86
  5. package/dist/adapters/fetch/index.d.ts +8 -86
  6. package/dist/adapters/fetch/index.mjs +16 -155
  7. package/dist/adapters/node/index.d.mts +8 -63
  8. package/dist/adapters/node/index.d.ts +8 -63
  9. package/dist/adapters/node/index.mjs +14 -120
  10. package/dist/adapters/standard/index.d.mts +5 -7
  11. package/dist/adapters/standard/index.d.ts +5 -7
  12. package/dist/adapters/standard/index.mjs +4 -4
  13. package/dist/helpers/index.mjs +3 -29
  14. package/dist/index.d.mts +114 -189
  15. package/dist/index.d.ts +114 -189
  16. package/dist/index.mjs +144 -119
  17. package/dist/openapi/index.d.mts +11 -27
  18. package/dist/openapi/index.d.ts +11 -27
  19. package/dist/openapi/index.mjs +8 -75
  20. package/dist/shared/server.BYV-qTJt.d.ts +41 -0
  21. package/dist/shared/server.C1RJffw4.mjs +30 -0
  22. package/dist/shared/server.CQIFwyhc.mjs +40 -0
  23. package/dist/shared/server.CWb33y9B.d.mts +41 -0
  24. package/dist/shared/server.ChOv1yG3.mjs +319 -0
  25. package/dist/shared/server.DXzEGRE2.mjs +403 -0
  26. package/dist/shared/server.DgzAlPjF.mjs +160 -0
  27. package/dist/shared/server.DimTvmOQ.d.mts +373 -0
  28. package/dist/shared/server.DimTvmOQ.d.ts +373 -0
  29. package/dist/shared/server.YUvuxHty.mjs +48 -0
  30. package/package.json +10 -27
  31. package/dist/plugins/index.d.mts +0 -160
  32. package/dist/plugins/index.d.ts +0 -160
  33. package/dist/plugins/index.mjs +0 -288
  34. package/dist/shared/server.BRCH88Sb.d.mts +0 -56
  35. package/dist/shared/server.Bb9Wxubg.d.ts +0 -23
  36. package/dist/shared/server.BbfNcgas.d.mts +0 -23
  37. package/dist/shared/server.D24uJlXJ.d.ts +0 -56
  38. package/dist/shared/server.DlRH_uit.mjs +0 -409
  39. package/dist/shared/server.Kxw442A9.mjs +0 -247
  40. package/dist/shared/server.XpnxYU3D.d.mts +0 -247
  41. package/dist/shared/server.XpnxYU3D.d.ts +0 -247
  42. package/dist/shared/server.u-02Z0mj.mjs +0 -254
package/dist/index.mjs CHANGED
@@ -1,11 +1,70 @@
1
- import { mergePrefix, mergeTags, ContractProcedure, mergeErrorMap, mergeMeta, mergeRoute, prefixRoute, initialSchemas, isContractProcedure, getContractRouter } from '@temporary-name/contract';
2
- export { ValidationError, eventIterator, validateORPCError } from '@temporary-name/contract';
3
- import { onError, resolveMaybeOptionalOptions } from '@temporary-name/shared';
4
- export { AsyncIteratorClass, EventPublisher, ORPCError, asyncIteratorToStream as eventIteratorToStream, isDefinedError, onError, onFinish, onStart, onSuccess, safe, streamToAsyncIteratorClass as streamToEventIterator } from '@temporary-name/shared';
5
- import { SchemaClass, gatingContext } from '@temporary-name/zod';
6
- import { P as Procedure, c as createProcedureClient, e as enhanceRouter, a as addMiddleware, s as setHiddenRouterContract, l as lazyInternal, g as getLazyMeta, u as unlazy, i as isProcedure, b as isLazy, d as getRouter } from './shared/server.DlRH_uit.mjs';
7
- export { L as LAZY_SYMBOL, p as createAccessibleLazyRouter, f as createORPCErrorConstructorMap, o as getHiddenRouterContract, k as isStartWithMiddlewares, h as lazy, m as mergeCurrentContext, n as mergeMiddlewares, j as middlewareOutputFn, r as resolveContractProcedures, t as traverseContractProcedures, q as unlazyRouter } from './shared/server.DlRH_uit.mjs';
1
+ import { assertNever, splitFirst, ORPCError, onError, resolveMaybeOptionalOptions, isTypescriptObject, isPropertyKey } from '@temporary-name/shared';
2
+ export { AsyncIteratorClass, EventPublisher, ORPCError, asyncIteratorToStream as eventIteratorToStream, isDefinedError, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@temporary-name/shared';
3
+ import * as z from '@temporary-name/zod';
4
+ import { SchemaClass, object, core, gatingContext } from '@temporary-name/zod';
5
+ import { g as getCookie } from './shared/server.C1RJffw4.mjs';
6
+ import { P as Procedure, m as mergePrefix, a as mergeTags, e as enhanceRouter, C as Contract, p as parseEndpointDefinition, b as mergeRoute, c as prefixRoute, d as addMiddleware, l as lazyInternal, f as getLazyMeta, u as unlazy, i as isProcedure, h as isLazy, j as getRouter } from './shared/server.ChOv1yG3.mjs';
7
+ export { L as LAZY_SYMBOL, V as ValidationError, q as createAccessibleLazyRouter, w as endpointRegex, g as getDynamicParams, n as isStartWithMiddlewares, k as lazy, o as mergeMiddlewares, r as resolveContractProcedures, s as standardizeHTTPPath, t as traverseContractProcedures, v as unlazyRouter } from './shared/server.ChOv1yG3.mjs';
8
+ import { c as createProcedureClient } from './shared/server.DgzAlPjF.mjs';
9
+ export { m as mergeCurrentContext, a as middlewareOutputFn } from './shared/server.DgzAlPjF.mjs';
10
+ export { e as eventIterator, g as getEventIteratorSchemaDetails } from './shared/server.YUvuxHty.mjs';
8
11
  export { getEventMeta, withEventMeta } from '@temporary-name/standard-server';
12
+ import 'cookie';
13
+
14
+ function validateTokenPrefix(prefix, token) {
15
+ if (prefix && !token.startsWith(prefix)) {
16
+ throw new ORPCError("UNAUTHORIZED", { message: `Invalid auth token. It must start with "${prefix}"` });
17
+ }
18
+ }
19
+ function validateTokenAuth(config, token, options) {
20
+ const { tokenPrefix, validate } = config;
21
+ validateTokenPrefix(tokenPrefix, token);
22
+ return validate(token, options);
23
+ }
24
+ function authByQuery(config, options) {
25
+ const { name, tokenPrefix, validate } = config;
26
+ const query = options.request.url.searchParams;
27
+ const token = query.get(name);
28
+ if (!token) return void 0;
29
+ validateTokenPrefix(tokenPrefix, token);
30
+ return validate(token, options);
31
+ }
32
+ function authByHeader(config, options) {
33
+ const authHeader = options.request.headers.get(config.name);
34
+ return authHeader ? validateTokenAuth(config, authHeader, options) : void 0;
35
+ }
36
+ function authByCookie(config, options) {
37
+ const cookie = getCookie(options.request.headers, config.name);
38
+ return cookie ? validateTokenAuth(config, cookie, options) : void 0;
39
+ }
40
+ function authByBearer(config, options) {
41
+ const authHeader = options.request.headers.get("Authorization");
42
+ if (!authHeader) return void 0;
43
+ const [authType, bearer] = splitFirst(authHeader, " ");
44
+ return authType === "Bearer" ? validateTokenAuth(config, bearer, options) : void 0;
45
+ }
46
+ function authByBasic(config, options) {
47
+ const authHeader = options.request.headers.get("Authorization");
48
+ if (!authHeader) return void 0;
49
+ const [authType, encoded] = splitFirst(authHeader, " ");
50
+ if (authType !== "Basic") return void 0;
51
+ const decoded = Buffer.from(encoded, "base64").toString("utf-8");
52
+ const [username, password] = splitFirst(decoded, ":");
53
+ validateTokenPrefix(config.tokenPrefix, password);
54
+ return config.validate(username, password, options);
55
+ }
56
+ function authByType(config, options) {
57
+ const { type } = config;
58
+ return type === "header" ? authByHeader(config, options) : type === "query" ? authByQuery(config, options) : type === "cookie" ? authByCookie(config, options) : type === "bearer" ? authByBearer(config, options) : type === "basic" ? authByBasic(config, options) : type === "none" ? false : assertNever(type);
59
+ }
60
+ function authDescription(config) {
61
+ const { type } = config;
62
+ return type === "basic" ? "a Basic Authentication header" : type === "bearer" ? "a Bearer Authentication header" : type === "header" ? `a header named "${config.name}"` : type === "query" ? `a query parameter named "${config.name}"` : type === "cookie" ? `a cookie named "${config.name}"` : type === "none" ? "no authentication" : assertNever(type);
63
+ }
64
+
65
+ function mergeMeta(meta1, meta2) {
66
+ return { ...meta1, ...meta2 };
67
+ }
9
68
 
10
69
  class DecoratedProcedure extends Procedure {
11
70
  /**
@@ -26,24 +85,19 @@ class DecoratedProcedure extends Procedure {
26
85
  }
27
86
  }
28
87
 
29
- class ProcedureBuilder extends ContractProcedure {
88
+ const initialSchemas = {
89
+ pathSchema: z.strictObject({}),
90
+ querySchema: z.strictObject({}),
91
+ bodySchema: z.strictObject({}),
92
+ outputSchema: z.unknown()
93
+ };
94
+
95
+ class ProcedureBuilder extends Contract {
30
96
  z;
31
97
  constructor(def) {
32
98
  super(def);
33
99
  this.z = new SchemaClass();
34
100
  }
35
- /**
36
- * Adds type-safe custom errors to the contract.
37
- * The provided errors are spared-merged with any existing errors in the contract.
38
- *
39
- * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
40
- */
41
- errors(errors) {
42
- return new ProcedureBuilder({
43
- ...this["~orpc"],
44
- errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
45
- });
46
- }
47
101
  /**
48
102
  * Sets or updates the metadata for the contract.
49
103
  * The provided metadata is spared-merged with any existing metadata in the contract.
@@ -56,6 +110,19 @@ class ProcedureBuilder extends ContractProcedure {
56
110
  meta: mergeMeta(this["~orpc"].meta, meta)
57
111
  });
58
112
  }
113
+ endpoint(stringsOrEndpoint, ...values) {
114
+ const { method, path, pathSchema } = parseEndpointDefinition(stringsOrEndpoint, values);
115
+ const { prefix } = this["~orpc"];
116
+ const route = { method, path };
117
+ return new ProcedureBuilder({
118
+ ...this["~orpc"],
119
+ route: mergeRoute(this["~orpc"].route, prefix ? prefixRoute(route, prefix) : route),
120
+ schemas: {
121
+ ...this["~orpc"].schemas,
122
+ pathSchema
123
+ }
124
+ });
125
+ }
59
126
  /**
60
127
  * Sets or updates the route definition for the contract.
61
128
  * The provided route is spared-merged with any existing route in the contract.
@@ -64,29 +131,19 @@ class ProcedureBuilder extends ContractProcedure {
64
131
  * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
65
132
  * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
66
133
  */
67
- route(route) {
134
+ endpointOpts(route) {
68
135
  const { prefix } = this["~orpc"];
69
136
  return new ProcedureBuilder({
70
137
  ...this["~orpc"],
71
138
  route: mergeRoute(this["~orpc"].route, prefix ? prefixRoute(route, prefix) : route)
72
139
  });
73
140
  }
74
- path(schema) {
75
- return new ProcedureBuilder({
76
- ...this["~orpc"],
77
- schemas: {
78
- ...this["~orpc"].schemas,
79
- pathSchema: schema
80
- },
81
- inputValidationIndex: this["~orpc"].middlewares.length
82
- });
83
- }
84
141
  query(schema) {
85
142
  return new ProcedureBuilder({
86
143
  ...this["~orpc"],
87
144
  schemas: {
88
145
  ...this["~orpc"].schemas,
89
- querySchema: schema
146
+ querySchema: schema instanceof core.$ZodType ? schema : object(schema)
90
147
  },
91
148
  inputValidationIndex: this["~orpc"].middlewares.length
92
149
  });
@@ -96,7 +153,7 @@ class ProcedureBuilder extends ContractProcedure {
96
153
  ...this["~orpc"],
97
154
  schemas: {
98
155
  ...this["~orpc"].schemas,
99
- bodySchema: schema
156
+ bodySchema: schema instanceof core.$ZodType ? schema : object(schema)
100
157
  },
101
158
  inputValidationIndex: this["~orpc"].middlewares.length
102
159
  });
@@ -111,7 +168,7 @@ class ProcedureBuilder extends ContractProcedure {
111
168
  ...this["~orpc"],
112
169
  schemas: {
113
170
  ...this["~orpc"].schemas,
114
- outputSchema: schema
171
+ outputSchema: schema instanceof core.$ZodType ? schema : object(schema)
115
172
  },
116
173
  outputValidationIndex: this["~orpc"].middlewares.length
117
174
  });
@@ -129,6 +186,36 @@ class ProcedureBuilder extends ContractProcedure {
129
186
  middlewares: addMiddleware(this["~orpc"].middlewares, middleware)
130
187
  });
131
188
  }
189
+ // `& {}` is so AuthType will be expanded in parameter info tooltips.
190
+ // The default of false for ValidatedAuthContext is used when you pass in the type 'none'. We use false
191
+ // because we can't use null or undefined (see ValidatedAuthContext) but we still want it to be falsy.
192
+ useAuth(type, ...rest) {
193
+ const config = { type, ...rest[0] };
194
+ const middleware = os.$context().middleware(async (options) => {
195
+ const { next, context } = options;
196
+ if (context.auth) return next();
197
+ const auth = await authByType(config, options);
198
+ if (auth === void 0) {
199
+ const { authConfigs } = options.procedure["~orpc"];
200
+ if (context.auth !== false && config === authConfigs.at(-1)) {
201
+ let authDescriptions = authConfigs.map(authDescription).join(", ");
202
+ if (authConfigs.length > 1) {
203
+ authDescriptions = `one of: ${authDescriptions}`;
204
+ }
205
+ throw new ORPCError("UNAUTHORIZED", {
206
+ message: `Authentication required. You must provide ${authDescriptions}`
207
+ });
208
+ }
209
+ return next();
210
+ }
211
+ return next({ context: { auth } });
212
+ });
213
+ return new this.constructor({
214
+ ...this["~orpc"],
215
+ authConfigs: [...this["~orpc"].authConfigs, config],
216
+ middlewares: addMiddleware(this["~orpc"].middlewares, middleware)
217
+ });
218
+ }
132
219
  useGating(gates, isGateEnabled) {
133
220
  return this.use(({ next, context }) => {
134
221
  return gatingContext.run(
@@ -143,6 +230,9 @@ class ProcedureBuilder extends ContractProcedure {
143
230
  * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
144
231
  */
145
232
  handler(handler) {
233
+ if (this["~orpc"].schemas.outputSchema === initialSchemas.outputSchema) {
234
+ throw new Error("You must call .output() before calling .handler()");
235
+ }
146
236
  return new DecoratedProcedure({
147
237
  ...this["~orpc"],
148
238
  handler
@@ -244,7 +334,6 @@ function createApiBuilder(opts = {}) {
244
334
  return new Builder({
245
335
  route: {},
246
336
  meta: opts.meta ?? {},
247
- errorMap: {},
248
337
  inputValidationIndex: 0,
249
338
  outputValidationIndex: 0,
250
339
  middlewares: [
@@ -255,85 +344,12 @@ function createApiBuilder(opts = {}) {
255
344
  schemas: initialSchemas,
256
345
  // NB: this is a relic from orpc -- I'm not convinced there's a need for this (or if there is, that it's
257
346
  // the best solution). For now I've removed the interface to configure it externally.
258
- dedupeLeadingMiddlewares: true
347
+ dedupeLeadingMiddlewares: true,
348
+ authConfigs: []
259
349
  });
260
350
  }
261
351
  const os = createApiBuilder();
262
352
 
263
- function implementerInternal(contract, middlewares) {
264
- if (isContractProcedure(contract)) {
265
- const impl2 = new Builder({
266
- ...contract["~orpc"],
267
- middlewares,
268
- inputValidationIndex: middlewares.length,
269
- outputValidationIndex: middlewares.length,
270
- dedupeLeadingMiddlewares: true
271
- });
272
- return impl2;
273
- }
274
- const impl = new Proxy(contract, {
275
- get: (target, key) => {
276
- if (typeof key !== "string") {
277
- return Reflect.get(target, key);
278
- }
279
- let method;
280
- if (key === "middleware") {
281
- method = (mid) => decorateMiddleware(mid);
282
- } else if (key === "use") {
283
- method = (mid) => {
284
- return implementerInternal(contract, addMiddleware(middlewares, mid));
285
- };
286
- } else if (key === "router") {
287
- method = (router) => {
288
- const adapted = enhanceRouter(router, {
289
- middlewares,
290
- errorMap: {},
291
- prefix: void 0,
292
- tags: void 0,
293
- dedupeLeadingMiddlewares: true
294
- });
295
- return setHiddenRouterContract(adapted, contract);
296
- };
297
- }
298
- const next = getContractRouter(target, [key]);
299
- if (!next) {
300
- return method ?? next;
301
- }
302
- const nextImpl = implementerInternal(next, middlewares);
303
- if (method) {
304
- return new Proxy(method, {
305
- get(_, key2) {
306
- return Reflect.get(nextImpl, key2);
307
- }
308
- });
309
- }
310
- return nextImpl;
311
- }
312
- });
313
- return impl;
314
- }
315
- function implement(contract) {
316
- const implInternal = implementerInternal(contract, []);
317
- const impl = new Proxy(implInternal, {
318
- get: (target, key) => {
319
- let method;
320
- if (key === "$context") {
321
- method = () => impl;
322
- }
323
- const next = Reflect.get(target, key);
324
- if (!method || !next || typeof next !== "function" && typeof next !== "object") {
325
- return method || next;
326
- }
327
- return new Proxy(method, {
328
- get(_, key2) {
329
- return Reflect.get(next, key2);
330
- }
331
- });
332
- }
333
- });
334
- return impl;
335
- }
336
-
337
353
  function createAssertedLazyProcedure(lazied) {
338
354
  const lazyProcedure = lazyInternal(async () => {
339
355
  const { default: maybeProcedure } = await unlazy(lazied);
@@ -348,14 +364,6 @@ function createAssertedLazyProcedure(lazied) {
348
364
  }, getLazyMeta(lazied));
349
365
  return lazyProcedure;
350
366
  }
351
- function createContractedProcedure(procedure, contract) {
352
- return new Procedure({
353
- ...procedure["~orpc"],
354
- errorMap: contract["~orpc"].errorMap,
355
- route: contract["~orpc"].route,
356
- meta: contract["~orpc"].meta
357
- });
358
- }
359
367
  function call(procedure, input, ...rest) {
360
368
  const options = resolveMaybeOptionalOptions(rest);
361
369
  return createProcedureClient(procedure, options)(input, options);
@@ -386,4 +394,21 @@ function createRouterClient(router, ...rest) {
386
394
  return recursive;
387
395
  }
388
396
 
389
- export { Builder, BuilderWithMiddlewares, DecoratedProcedure, Procedure, ProcedureBuilder, addMiddleware, call, createApiBuilder, createAssertedLazyProcedure, createContractedProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, getLazyMeta, getRouter, implement, implementerInternal, isLazy, isProcedure, lazyInternal, os, setHiddenRouterContract, unlazy };
397
+ function isSchemaIssue(issue) {
398
+ if (!isTypescriptObject(issue) || typeof issue.message !== "string") {
399
+ return false;
400
+ }
401
+ if (issue.path !== void 0) {
402
+ if (!Array.isArray(issue.path)) {
403
+ return false;
404
+ }
405
+ if (!issue.path.every(
406
+ (segment) => isPropertyKey(segment) || isTypescriptObject(segment) && isPropertyKey(segment.key)
407
+ )) {
408
+ return false;
409
+ }
410
+ }
411
+ return true;
412
+ }
413
+
414
+ export { Builder, BuilderWithMiddlewares, Contract, DecoratedProcedure, Procedure, ProcedureBuilder, addMiddleware, call, createApiBuilder, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, getLazyMeta, getRouter, initialSchemas, isLazy, isProcedure, isSchemaIssue, lazyInternal, mergeMeta, os, parseEndpointDefinition, unlazy };
@@ -1,11 +1,12 @@
1
- import { OpenAPI, AnyContractProcedure, AnySchema, AnyContractRouter } from '@temporary-name/contract';
2
- export { OpenAPI } from '@temporary-name/contract';
3
- import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter, ORPCError, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@temporary-name/server';
4
- import { Promisable, Value, HTTPPath, HTTPMethod, NestedClient, Client, MaybeOptionalOptions } from '@temporary-name/shared';
1
+ import { Contract } from '@temporary-name/server';
2
+ import { OpenAPI, Promisable, Value, HTTPPath, HTTPMethod } from '@temporary-name/shared';
3
+ export { OpenAPI } from '@temporary-name/shared';
4
+ import { d as AnySchema, b as Contract$1, ac as TraverseContractProcedureCallbackOptions, a2 as ContractRouter, w as AnyRouter } from '../shared/server.DimTvmOQ.mjs';
5
5
  import { JSONSchema } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
6
6
  export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
7
+ import '@temporary-name/zod';
7
8
 
8
- type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
9
+ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: Contract) => OpenAPI.OperationObject);
9
10
  /**
10
11
  * Customize The Operation Object by proxy an error map item or a middleware.
11
12
  *
@@ -13,7 +14,7 @@ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: Open
13
14
  */
14
15
  declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
15
16
  declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
16
- declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
17
+ declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: Contract): OpenAPI.OperationObject;
17
18
 
18
19
  /**
19
20
  * @internal
@@ -76,7 +77,7 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
76
77
  * @deprecated Use `filter` option instead.
77
78
  * @default () => false
78
79
  */
79
- exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
80
+ exclude?: (procedure: Contract$1, path: readonly string[]) => boolean;
80
81
  /**
81
82
  * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
82
83
  *
@@ -129,7 +130,7 @@ declare class OpenAPIGenerator {
129
130
  *
130
131
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
131
132
  */
132
- generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
133
+ generate(router: ContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
133
134
  }
134
135
 
135
136
  /**
@@ -162,23 +163,6 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
162
163
  declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
163
164
  declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
164
165
 
165
- type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends boolean ? T : T extends null ? T : T extends undefined ? T : T extends Array<unknown> ? JsonifiedArray<T> : T extends Record<string, unknown> ? {
166
- [K in keyof T]: JsonifiedValue<T[K]>;
167
- } : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
168
- type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [
169
- U extends undefined ? null : JsonifiedValue<U>,
170
- ...JsonifiedArray<V>
171
- ] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
172
- /**
173
- * Convert types that JSON not support to corresponding json types
174
- *
175
- * @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
176
- */
177
- type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
178
- [K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
179
- };
180
- declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
181
-
182
166
  /**
183
167
  *@internal
184
168
  */
@@ -216,5 +200,5 @@ declare const oo: {
216
200
  spec: typeof customOpenAPIOperation;
217
201
  };
218
202
 
219
- export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
220
- export type { ConditionalSchemaConverter, FileSchema, JsonifiedArray, JsonifiedClient, JsonifiedValue, ObjectSchema, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter, SchemaConverterComponent };
203
+ export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
204
+ export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter, SchemaConverterComponent };
@@ -1,11 +1,12 @@
1
- import { OpenAPI, AnyContractProcedure, AnySchema, AnyContractRouter } from '@temporary-name/contract';
2
- export { OpenAPI } from '@temporary-name/contract';
3
- import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter, ORPCError, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@temporary-name/server';
4
- import { Promisable, Value, HTTPPath, HTTPMethod, NestedClient, Client, MaybeOptionalOptions } from '@temporary-name/shared';
1
+ import { Contract } from '@temporary-name/server';
2
+ import { OpenAPI, Promisable, Value, HTTPPath, HTTPMethod } from '@temporary-name/shared';
3
+ export { OpenAPI } from '@temporary-name/shared';
4
+ import { d as AnySchema, b as Contract$1, ac as TraverseContractProcedureCallbackOptions, a2 as ContractRouter, w as AnyRouter } from '../shared/server.DimTvmOQ.js';
5
5
  import { JSONSchema } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
6
6
  export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
7
+ import '@temporary-name/zod';
7
8
 
8
- type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
9
+ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: Contract) => OpenAPI.OperationObject);
9
10
  /**
10
11
  * Customize The Operation Object by proxy an error map item or a middleware.
11
12
  *
@@ -13,7 +14,7 @@ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: Open
13
14
  */
14
15
  declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
15
16
  declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
16
- declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
17
+ declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: Contract): OpenAPI.OperationObject;
17
18
 
18
19
  /**
19
20
  * @internal
@@ -76,7 +77,7 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
76
77
  * @deprecated Use `filter` option instead.
77
78
  * @default () => false
78
79
  */
79
- exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
80
+ exclude?: (procedure: Contract$1, path: readonly string[]) => boolean;
80
81
  /**
81
82
  * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
82
83
  *
@@ -129,7 +130,7 @@ declare class OpenAPIGenerator {
129
130
  *
130
131
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
131
132
  */
132
- generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
133
+ generate(router: ContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
133
134
  }
134
135
 
135
136
  /**
@@ -162,23 +163,6 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
162
163
  declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
163
164
  declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
164
165
 
165
- type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends boolean ? T : T extends null ? T : T extends undefined ? T : T extends Array<unknown> ? JsonifiedArray<T> : T extends Record<string, unknown> ? {
166
- [K in keyof T]: JsonifiedValue<T[K]>;
167
- } : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
168
- type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [
169
- U extends undefined ? null : JsonifiedValue<U>,
170
- ...JsonifiedArray<V>
171
- ] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
172
- /**
173
- * Convert types that JSON not support to corresponding json types
174
- *
175
- * @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
176
- */
177
- type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
178
- [K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
179
- };
180
- declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
181
-
182
166
  /**
183
167
  *@internal
184
168
  */
@@ -216,5 +200,5 @@ declare const oo: {
216
200
  spec: typeof customOpenAPIOperation;
217
201
  };
218
202
 
219
- export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
220
- export type { ConditionalSchemaConverter, FileSchema, JsonifiedArray, JsonifiedClient, JsonifiedValue, ObjectSchema, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter, SchemaConverterComponent };
203
+ export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
204
+ export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter, SchemaConverterComponent };
@@ -1,10 +1,11 @@
1
- import { isProcedure, resolveContractProcedures, ORPCError, createRouterClient } from '@temporary-name/server';
2
- import { fallbackContractConfig, getEventIteratorSchemaDetails } from '@temporary-name/contract';
3
- import { isObject, stringifyJSON, findDeepMatches, toArray, clone, value, toHttpPath, isORPCErrorStatus, fallbackORPCErrorStatus, fallbackORPCErrorMessage, resolveMaybeOptionalOptions, createORPCErrorFromJson } from '@temporary-name/shared';
4
- import { a as standardizeHTTPPath, j as jsonSerialize, g as getDynamicParams, d as deserialize, s as serialize } from '../shared/server.Kxw442A9.mjs';
1
+ import { isObject, stringifyJSON, findDeepMatches, toArray, clone, value, fallbackContractConfig, toHttpPath, isORPCErrorStatus } from '@temporary-name/shared';
2
+ import { j as jsonSerialize } from '../shared/server.CQIFwyhc.mjs';
5
3
  import '@temporary-name/standard-server';
4
+ import { g as getEventIteratorSchemaDetails } from '../shared/server.YUvuxHty.mjs';
5
+ import { s as standardizeHTTPPath, r as resolveContractProcedures, g as getDynamicParams } from '../shared/server.ChOv1yG3.mjs';
6
6
  import { TypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
7
7
  export { ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
8
+ import '@temporary-name/zod';
8
9
 
9
10
  const OPERATION_EXTENDER_SYMBOL = Symbol("ORPC_OPERATION_EXTENDER");
10
11
  function customOpenAPIOperation(o, extend) {
@@ -22,20 +23,12 @@ function getCustomOpenAPIOperation(o) {
22
23
  }
23
24
  function applyCustomOpenAPIOperation(operation, contract) {
24
25
  const operationCustoms = [];
25
- for (const errorItem of Object.values(contract["~orpc"].errorMap)) {
26
- const maybeExtender = errorItem ? getCustomOpenAPIOperation(errorItem) : void 0;
26
+ for (const middleware of contract["~orpc"].middlewares) {
27
+ const maybeExtender = getCustomOpenAPIOperation(middleware);
27
28
  if (maybeExtender) {
28
29
  operationCustoms.push(maybeExtender);
29
30
  }
30
31
  }
31
- if (isProcedure(contract)) {
32
- for (const middleware of contract["~orpc"].middlewares) {
33
- const maybeExtender = getCustomOpenAPIOperation(middleware);
34
- if (maybeExtender) {
35
- operationCustoms.push(maybeExtender);
36
- }
37
- }
38
- }
39
32
  let currentOperation = operation;
40
33
  for (const custom of operationCustoms) {
41
34
  if (typeof custom === "function") {
@@ -432,12 +425,6 @@ class OpenAPIGenerator {
432
425
  };
433
426
  await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions);
434
427
  await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions);
435
- await this.#errorResponse(
436
- operationObjectRef,
437
- def,
438
- baseSchemaConvertOptions,
439
- undefinedErrorJsonSchema
440
- );
441
428
  }
442
429
  if (typeof def.route.spec === "function") {
443
430
  operationObjectRef = def.route.spec(operationObjectRef);
@@ -696,64 +683,10 @@ ${errors.join("\n\n")}`
696
683
  }
697
684
  }
698
685
  }
699
- async #errorResponse(ref, def, baseSchemaConvertOptions, undefinedErrorSchema) {
700
- const errorMap = def.errorMap;
701
- const errors = {};
702
- for (const code in errorMap) {
703
- const config = errorMap[code];
704
- if (!config) {
705
- continue;
706
- }
707
- const status = fallbackORPCErrorStatus(code, config.status);
708
- const message = fallbackORPCErrorMessage(code, config.message);
709
- const [dataRequired, dataSchema] = await this.converter.convert(config.data, {
710
- ...baseSchemaConvertOptions,
711
- strategy: "output"
712
- });
713
- errors[status] ??= [];
714
- errors[status].push({
715
- type: "object",
716
- properties: {
717
- defined: { const: true },
718
- code: { const: code },
719
- status: { const: status },
720
- message: { type: "string", default: message },
721
- data: dataSchema
722
- },
723
- required: dataRequired ? ["defined", "code", "status", "message", "data"] : ["defined", "code", "status", "message"]
724
- });
725
- }
726
- ref.responses ??= {};
727
- for (const status in errors) {
728
- const schemas = errors[status];
729
- ref.responses[status] = {
730
- description: status,
731
- content: toOpenAPIContent({
732
- oneOf: [...schemas, undefinedErrorSchema]
733
- })
734
- };
735
- }
736
- }
737
- }
738
-
739
- function createJsonifiedRouterClient(router, ...rest) {
740
- const options = resolveMaybeOptionalOptions(rest);
741
- options.interceptors ??= [];
742
- options.interceptors.unshift(async (options2) => {
743
- try {
744
- return deserialize(serialize(await options2.next()));
745
- } catch (e) {
746
- if (e instanceof ORPCError) {
747
- throw createORPCErrorFromJson(deserialize(serialize(e.toJSON(), { outputFormat: "plain" })));
748
- }
749
- throw e;
750
- }
751
- });
752
- return createRouterClient(router, options);
753
686
  }
754
687
 
755
688
  const oo = {
756
689
  spec: customOpenAPIOperation
757
690
  };
758
691
 
759
- export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
692
+ export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };