@temporary-name/server 1.9.3-alpha.2d4311b66d2b675b022398c62ddc6fde97c93a6f → 1.9.3-alpha.305aebe633f301e28426c6b15cdfd58ddf45641c

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 (44) 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 +370 -197
  15. package/dist/index.d.ts +370 -197
  16. package/dist/index.mjs +461 -141
  17. package/dist/openapi/index.d.mts +18 -53
  18. package/dist/openapi/index.d.ts +18 -53
  19. package/dist/openapi/index.mjs +340 -367
  20. package/dist/shared/server.B0LJ_wu-.d.ts +41 -0
  21. package/dist/shared/server.BQZMQrPe.d.mts +41 -0
  22. package/dist/shared/server.C1RJffw4.mjs +30 -0
  23. package/dist/shared/server.CQIFwyhc.mjs +40 -0
  24. package/dist/shared/server.CYa9puL2.mjs +403 -0
  25. package/dist/shared/server.ChOv1yG3.mjs +319 -0
  26. package/dist/shared/server.CjPiuQYH.d.mts +51 -0
  27. package/dist/shared/server.CjPiuQYH.d.ts +51 -0
  28. package/dist/shared/server.Cza0RB3u.mjs +160 -0
  29. package/dist/shared/server.DXPMDozZ.d.mts +388 -0
  30. package/dist/shared/server.DXPMDozZ.d.ts +388 -0
  31. package/dist/shared/server.Ny4yD6yY.mjs +525 -0
  32. package/package.json +10 -28
  33. package/dist/plugins/index.d.mts +0 -160
  34. package/dist/plugins/index.d.ts +0 -160
  35. package/dist/plugins/index.mjs +0 -288
  36. package/dist/shared/server.BCcLYvdF.d.mts +0 -56
  37. package/dist/shared/server.CHV9AQHl.mjs +0 -412
  38. package/dist/shared/server.CdeqmULw.d.ts +0 -56
  39. package/dist/shared/server.Cn7WsRHl.mjs +0 -254
  40. package/dist/shared/server.DHezmW6C.d.mts +0 -23
  41. package/dist/shared/server.Da-qLzdU.d.ts +0 -23
  42. package/dist/shared/server.DecvGKtb.d.mts +0 -242
  43. package/dist/shared/server.DecvGKtb.d.ts +0 -242
  44. package/dist/shared/server.JtIZ8YG7.mjs +0 -237
@@ -1,10 +1,13 @@
1
- import { isProcedure, resolveContractProcedures, ORPCError, createRouterClient } from '@temporary-name/server';
2
- import { standardizeHTTPPath, fallbackContractConfig, getDynamicParams, 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 { j as jsonSerialize, d as deserialize, s as serialize } from '../shared/server.JtIZ8YG7.mjs';
1
+ import { isObject, stringifyJSON, findDeepMatches, clone, value, fallbackContractConfig, toHttpPath, assertNever, isORPCErrorStatus } from '@temporary-name/shared';
2
+ import { j as jsonSerialize } from '../shared/server.CQIFwyhc.mjs';
5
3
  import '@temporary-name/standard-server';
4
+ import { Z as ZodToJsonSchemaConverter, g as getEventIteratorSchemaDetails } from '../shared/server.Ny4yD6yY.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';
9
+ import '@temporary-name/server/openapi';
10
+ import 'zod/v4/core';
8
11
 
9
12
  const OPERATION_EXTENDER_SYMBOL = Symbol("ORPC_OPERATION_EXTENDER");
10
13
  function customOpenAPIOperation(o, extend) {
@@ -22,20 +25,12 @@ function getCustomOpenAPIOperation(o) {
22
25
  }
23
26
  function applyCustomOpenAPIOperation(operation, contract) {
24
27
  const operationCustoms = [];
25
- for (const errorItem of Object.values(contract["~orpc"].errorMap)) {
26
- const maybeExtender = errorItem ? getCustomOpenAPIOperation(errorItem) : void 0;
28
+ for (const middleware of contract["~orpc"].middlewares) {
29
+ const maybeExtender = getCustomOpenAPIOperation(middleware);
27
30
  if (maybeExtender) {
28
31
  operationCustoms.push(maybeExtender);
29
32
  }
30
33
  }
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
34
  let currentOperation = operation;
40
35
  for (const custom of operationCustoms) {
41
36
  if (typeof custom === "function") {
@@ -362,398 +357,376 @@ function resolveOpenAPIJsonSchemaRef(doc, schema) {
362
357
  return resolved ?? schema;
363
358
  }
364
359
 
365
- class CompositeSchemaConverter {
366
- converters;
367
- constructor(converters) {
368
- this.converters = converters;
369
- }
370
- async convert(schema, options) {
371
- for (const converter of this.converters) {
372
- if (await converter.condition(schema, options)) {
373
- return converter.convert(schema, options);
360
+ class OpenAPIGeneratorError extends Error {
361
+ }
362
+ async function generateOpenApiSpec(router, options = {}) {
363
+ const converter = typeof options.schemaConverter === "function" ? options.schemaConverter : new ZodToJsonSchemaConverter(options.schemaConverter ?? {}).convert;
364
+ const filter = options.filter ?? (({ contract, path }) => {
365
+ return !(options.exclude?.(contract, path) ?? false);
366
+ });
367
+ const doc = {
368
+ ...clone(options.spec),
369
+ info: options.spec?.info ?? { title: "API Reference", version: "0.0.0" },
370
+ openapi: "3.1.1"
371
+ };
372
+ const { baseSchemaConvertOptions } = await resolveCommonSchemas(doc, options.commonSchemas, converter);
373
+ const contracts = [];
374
+ await resolveContractProcedures({ path: [], router }, (traverseOptions) => {
375
+ if (!value(filter, traverseOptions)) {
376
+ return;
377
+ }
378
+ contracts.push(traverseOptions);
379
+ });
380
+ const namesByAuthConfig = /* @__PURE__ */ new Map();
381
+ const authConfigNames = /* @__PURE__ */ new Set();
382
+ for (const { contract } of contracts) {
383
+ for (const authConfig of contract["~orpc"].authConfigs) {
384
+ if (authConfig.type === "none" || namesByAuthConfig.has(authConfig)) {
385
+ continue;
386
+ }
387
+ const oasNameBase = authConfig.oasName ?? `${authConfig.type}Auth`;
388
+ let oasName = oasNameBase;
389
+ for (let i = 2; authConfigNames.has(oasName); i++) {
390
+ oasName = `${oasNameBase}${i}`;
374
391
  }
392
+ namesByAuthConfig.set(authConfig, oasName);
393
+ authConfigNames.add(oasName);
375
394
  }
376
- return [false, {}];
377
395
  }
378
- }
379
-
380
- class OpenAPIGeneratorError extends Error {
381
- }
382
- class OpenAPIGenerator {
383
- converter;
384
- constructor(options = {}) {
385
- this.converter = new CompositeSchemaConverter(toArray(options.schemaConverters));
396
+ if (namesByAuthConfig.size > 0) {
397
+ doc.components ??= {};
398
+ const schemes = doc.components.securitySchemes ??= {};
399
+ for (const [authConfig, name] of namesByAuthConfig) {
400
+ schemes[name] ??= authConfigToSecurityScheme(authConfig);
401
+ }
386
402
  }
387
- /**
388
- * Generates OpenAPI specifications from oRPC routers/contracts.
389
- *
390
- * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
391
- */
392
- async generate(router, options = {}) {
393
- const filter = options.filter ?? (({ contract, path }) => {
394
- return !(options.exclude?.(contract, path) ?? false);
395
- });
396
- const doc = {
397
- ...clone(options),
398
- info: options.info ?? { title: "API Reference", version: "0.0.0" },
399
- openapi: "3.1.1",
400
- exclude: void 0,
401
- filter: void 0,
402
- commonSchemas: void 0
403
- };
404
- const { baseSchemaConvertOptions, undefinedErrorJsonSchema } = await this.#resolveCommonSchemas(
405
- doc,
406
- options.commonSchemas
407
- );
408
- const contracts = [];
409
- await resolveContractProcedures({ path: [], router }, (traverseOptions) => {
410
- if (!value(filter, traverseOptions)) {
411
- return;
412
- }
413
- contracts.push(traverseOptions);
414
- });
415
- const errors = [];
416
- for (const { contract, path } of contracts) {
417
- const stringPath = path.join(".");
418
- try {
419
- const def = contract["~orpc"];
420
- const method = toOpenAPIMethod(fallbackContractConfig("defaultMethod", def.route.method));
421
- const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path));
422
- let operationObjectRef;
423
- if (def.route.spec !== void 0 && typeof def.route.spec !== "function") {
424
- operationObjectRef = def.route.spec;
425
- } else {
426
- operationObjectRef = {
427
- operationId: def.route.operationId ?? stringPath,
428
- summary: def.route.summary,
429
- description: def.route.description,
430
- deprecated: def.route.deprecated,
431
- tags: def.route.tags?.map((tag) => tag)
432
- };
433
- await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions);
434
- await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions);
435
- await this.#errorResponse(
436
- operationObjectRef,
437
- def,
438
- baseSchemaConvertOptions,
439
- undefinedErrorJsonSchema
440
- );
441
- }
442
- if (typeof def.route.spec === "function") {
443
- operationObjectRef = def.route.spec(operationObjectRef);
444
- }
445
- doc.paths ??= {};
446
- doc.paths[httpPath] ??= {};
447
- doc.paths[httpPath][method] = applyCustomOpenAPIOperation(operationObjectRef, contract);
448
- } catch (e) {
449
- if (!(e instanceof OpenAPIGeneratorError)) {
450
- throw e;
451
- }
452
- errors.push(
453
- `[OpenAPIGenerator] Error occurred while generating OpenAPI for procedure at path: ${stringPath}
454
- ${e.message}`
403
+ const errors = [];
404
+ for (const { contract, path } of contracts) {
405
+ const stringPath = path.join(".");
406
+ try {
407
+ const def = contract["~orpc"];
408
+ const method = toOpenAPIMethod(fallbackContractConfig("defaultMethod", def.route.method));
409
+ const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path));
410
+ let operationObjectRef;
411
+ if (def.route.spec !== void 0 && typeof def.route.spec !== "function") {
412
+ operationObjectRef = def.route.spec;
413
+ } else {
414
+ operationObjectRef = {
415
+ operationId: def.route.operationId ?? stringPath,
416
+ summary: def.route.summary,
417
+ description: def.route.description,
418
+ deprecated: def.route.deprecated,
419
+ tags: def.route.tags?.map((tag) => tag)
420
+ };
421
+ const security = def.authConfigs.map(
422
+ (authConfig) => authConfig.type === "none" ? {} : { [namesByAuthConfig.get(authConfig)]: [] }
455
423
  );
424
+ if (security.length > 0) {
425
+ operationObjectRef.security = security;
426
+ }
427
+ await handleRequest(doc, operationObjectRef, def, baseSchemaConvertOptions, converter);
428
+ await handleSuccessResponse(doc, operationObjectRef, def, baseSchemaConvertOptions, converter);
456
429
  }
430
+ if (typeof def.route.spec === "function") {
431
+ operationObjectRef = def.route.spec(operationObjectRef);
432
+ }
433
+ doc.paths ??= {};
434
+ doc.paths[httpPath] ??= {};
435
+ doc.paths[httpPath][method] = applyCustomOpenAPIOperation(operationObjectRef, contract);
436
+ } catch (e) {
437
+ if (!(e instanceof OpenAPIGeneratorError)) {
438
+ throw e;
439
+ }
440
+ errors.push(
441
+ `[OpenAPIGenerator] Error occurred while generating OpenAPI for procedure at path: ${stringPath}
442
+ ${e.message}`
443
+ );
457
444
  }
458
- if (errors.length) {
459
- throw new OpenAPIGeneratorError(
460
- `Some error occurred during OpenAPI generation:
445
+ }
446
+ if (errors.length) {
447
+ throw new OpenAPIGeneratorError(
448
+ `Some error occurred during OpenAPI generation:
461
449
 
462
450
  ${errors.join("\n\n")}`
463
- );
464
- }
465
- return jsonSerialize(doc)[0];
451
+ );
466
452
  }
467
- async #resolveCommonSchemas(doc, commonSchemas) {
468
- let undefinedErrorJsonSchema = {
469
- type: "object",
470
- properties: {
471
- defined: { const: false },
472
- code: { type: "string" },
473
- status: { type: "number" },
474
- message: { type: "string" },
475
- data: {}
476
- },
477
- required: ["defined", "code", "status", "message"]
478
- };
479
- const baseSchemaConvertOptions = {};
480
- if (commonSchemas) {
481
- baseSchemaConvertOptions.components = [];
482
- for (const key in commonSchemas) {
483
- const options = commonSchemas[key];
484
- if (options.schema === void 0) {
485
- continue;
453
+ return jsonSerialize(doc)[0];
454
+ }
455
+ async function resolveCommonSchemas(doc, commonSchemas, converter) {
456
+ let undefinedErrorJsonSchema = {
457
+ type: "object",
458
+ properties: {
459
+ defined: { const: false },
460
+ code: { type: "string" },
461
+ status: { type: "number" },
462
+ message: { type: "string" },
463
+ data: {}
464
+ },
465
+ required: ["defined", "code", "status", "message"]
466
+ };
467
+ const baseSchemaConvertOptions = {};
468
+ if (commonSchemas) {
469
+ baseSchemaConvertOptions.components = [];
470
+ for (const key in commonSchemas) {
471
+ const options = commonSchemas[key];
472
+ if (options.schema === void 0) {
473
+ continue;
474
+ }
475
+ const { schema, strategy = "input" } = options;
476
+ const [required, json] = await converter(schema, { strategy });
477
+ const allowedStrategies = [strategy];
478
+ if (strategy === "input") {
479
+ const [outputRequired, outputJson] = await converter(schema, { strategy: "output" });
480
+ if (outputRequired === required && stringifyJSON(outputJson) === stringifyJSON(json)) {
481
+ allowedStrategies.push("output");
486
482
  }
487
- const { schema, strategy = "input" } = options;
488
- const [required, json] = await this.converter.convert(schema, { strategy });
489
- const allowedStrategies = [strategy];
490
- if (strategy === "input") {
491
- const [outputRequired, outputJson] = await this.converter.convert(schema, { strategy: "output" });
492
- if (outputRequired === required && stringifyJSON(outputJson) === stringifyJSON(json)) {
493
- allowedStrategies.push("output");
494
- }
495
- } else if (strategy === "output") {
496
- const [inputRequired, inputJson] = await this.converter.convert(schema, { strategy: "input" });
497
- if (inputRequired === required && stringifyJSON(inputJson) === stringifyJSON(json)) {
498
- allowedStrategies.push("input");
499
- }
483
+ } else if (strategy === "output") {
484
+ const [inputRequired, inputJson] = await converter(schema, { strategy: "input" });
485
+ if (inputRequired === required && stringifyJSON(inputJson) === stringifyJSON(json)) {
486
+ allowedStrategies.push("input");
500
487
  }
501
- baseSchemaConvertOptions.components.push({
502
- schema,
503
- required,
504
- ref: `#/components/schemas/${key}`,
505
- allowedStrategies
506
- });
507
488
  }
508
- doc.components ??= {};
509
- doc.components.schemas ??= {};
510
- for (const key in commonSchemas) {
511
- const options = commonSchemas[key];
512
- if (options.schema === void 0) {
513
- if (options.error === "UndefinedError") {
514
- doc.components.schemas[key] = toOpenAPISchema(undefinedErrorJsonSchema);
515
- undefinedErrorJsonSchema = { $ref: `#/components/schemas/${key}` };
516
- }
517
- continue;
489
+ baseSchemaConvertOptions.components.push({
490
+ schema,
491
+ required,
492
+ ref: `#/components/schemas/${key}`,
493
+ allowedStrategies
494
+ });
495
+ }
496
+ doc.components ??= {};
497
+ doc.components.schemas ??= {};
498
+ for (const key in commonSchemas) {
499
+ const options = commonSchemas[key];
500
+ if (options.schema === void 0) {
501
+ if (options.error === "UndefinedError") {
502
+ doc.components.schemas[key] = toOpenAPISchema(undefinedErrorJsonSchema);
503
+ undefinedErrorJsonSchema = { $ref: `#/components/schemas/${key}` };
518
504
  }
519
- const { schema, strategy = "input" } = options;
520
- const [, json] = await this.converter.convert(schema, {
521
- ...baseSchemaConvertOptions,
522
- strategy,
523
- minStructureDepthForRef: 1
524
- // not allow use $ref for root schemas
525
- });
526
- doc.components.schemas[key] = toOpenAPISchema(json);
505
+ continue;
527
506
  }
507
+ const { schema, strategy = "input" } = options;
508
+ const [, json] = await converter(schema, {
509
+ ...baseSchemaConvertOptions,
510
+ strategy,
511
+ minStructureDepthForRef: 1
512
+ // not allow use $ref for root schemas
513
+ });
514
+ doc.components.schemas[key] = toOpenAPISchema(json);
528
515
  }
529
- return { baseSchemaConvertOptions, undefinedErrorJsonSchema };
530
516
  }
531
- async #request(doc, ref, def, baseSchemaConvertOptions) {
532
- const method = fallbackContractConfig("defaultMethod", def.route.method);
533
- const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
534
- const [_pathRequired, pathSchema] = await this.converter.convert(def.schemas.pathSchema, {
535
- ...baseSchemaConvertOptions,
536
- strategy: "input",
537
- minStructureDepthForRef: 1
538
- });
539
- if (dynamicParams?.length) {
540
- const error = new OpenAPIGeneratorError(
541
- // TODO: fix this error
542
- 'When input structure is "compact", and path has dynamic params, input schema must be an object with all dynamic params as required.'
543
- );
544
- if (!isObjectSchema(pathSchema)) {
545
- throw error;
546
- }
547
- if (!checkParamsSchema(pathSchema, dynamicParams)) {
548
- throw error;
549
- }
550
- ref.parameters ??= [];
551
- ref.parameters.push(...toOpenAPIParameters(pathSchema, "path"));
552
- } else {
553
- const error = new OpenAPIGeneratorError("Params set via path do not match those on the route");
554
- if (!isObjectSchema(pathSchema)) {
555
- console.log("FOO", pathSchema);
556
- throw error;
557
- }
558
- if (!checkParamsSchema(pathSchema, [])) {
559
- console.log("BAR", pathSchema);
560
- throw error;
561
- }
517
+ return { baseSchemaConvertOptions, undefinedErrorJsonSchema };
518
+ }
519
+ async function handleRequest(doc, ref, def, baseSchemaConvertOptions, converter) {
520
+ const method = fallbackContractConfig("defaultMethod", def.route.method);
521
+ const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
522
+ const [_pathRequired, pathSchema] = await converter(def.schemas.pathSchema, {
523
+ ...baseSchemaConvertOptions,
524
+ strategy: "input",
525
+ minStructureDepthForRef: 1
526
+ });
527
+ if (dynamicParams?.length) {
528
+ const error = new OpenAPIGeneratorError(
529
+ // TODO: fix this error
530
+ 'When input structure is "compact", and path has dynamic params, input schema must be an object with all dynamic params as required.'
531
+ );
532
+ if (!isObjectSchema(pathSchema)) {
533
+ throw error;
562
534
  }
563
- const [_queryRequired, querySchema] = await this.converter.convert(def.schemas.querySchema, {
564
- ...baseSchemaConvertOptions,
565
- strategy: "input",
566
- minStructureDepthForRef: 0
567
- });
568
- if (!isAnySchema(querySchema)) {
569
- const resolvedSchema = resolveOpenAPIJsonSchemaRef(doc, querySchema);
570
- if (!isObjectSchema(resolvedSchema)) {
571
- throw new OpenAPIGeneratorError("Query param schema must satisfy: object | any | unknown");
572
- }
573
- ref.parameters ??= [];
574
- ref.parameters.push(...toOpenAPIParameters(resolvedSchema, "query"));
535
+ if (!checkParamsSchema(pathSchema, dynamicParams)) {
536
+ throw error;
575
537
  }
576
- if (method !== "GET") {
577
- const details = getEventIteratorSchemaDetails(def.schemas.bodySchema);
578
- if (details) {
579
- ref.requestBody = {
580
- required: true,
581
- content: toOpenAPIEventIteratorContent(
582
- await this.converter.convert(details.yields, { ...baseSchemaConvertOptions, strategy: "input" }),
583
- await this.converter.convert(details.returns, { ...baseSchemaConvertOptions, strategy: "input" })
584
- )
585
- };
586
- } else {
587
- const [bodyRequired, bodySchema] = await this.converter.convert(def.schemas.bodySchema, {
588
- ...baseSchemaConvertOptions,
589
- strategy: "input",
590
- minStructureDepthForRef: 0
591
- });
592
- if (isAnySchema(bodySchema)) {
593
- return;
594
- }
595
- ref.requestBody = {
596
- required: bodyRequired,
597
- content: toOpenAPIContent(bodySchema)
598
- };
599
- }
538
+ ref.parameters ??= [];
539
+ ref.parameters.push(...toOpenAPIParameters(pathSchema, "path"));
540
+ } else {
541
+ const error = new OpenAPIGeneratorError("Params set via path do not match those on the route");
542
+ if (!isObjectSchema(pathSchema)) {
543
+ console.log("FOO", pathSchema);
544
+ throw error;
545
+ }
546
+ if (!checkParamsSchema(pathSchema, [])) {
547
+ console.log("BAR", pathSchema);
548
+ throw error;
600
549
  }
601
550
  }
602
- async #successResponse(doc, ref, def, baseSchemaConvertOptions) {
603
- const outputSchema = def.schemas.outputSchema;
604
- const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
605
- const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
606
- const eventIteratorSchemaDetails = getEventIteratorSchemaDetails(outputSchema);
607
- const outputStructure = fallbackContractConfig("defaultOutputStructure", def.route.outputStructure);
608
- if (eventIteratorSchemaDetails) {
609
- ref.responses ??= {};
610
- ref.responses[status] = {
611
- description,
551
+ const [_queryRequired, querySchema] = await converter(def.schemas.querySchema, {
552
+ ...baseSchemaConvertOptions,
553
+ strategy: "input",
554
+ minStructureDepthForRef: 0
555
+ });
556
+ if (!isAnySchema(querySchema)) {
557
+ const resolvedSchema = resolveOpenAPIJsonSchemaRef(doc, querySchema);
558
+ if (!isObjectSchema(resolvedSchema)) {
559
+ throw new OpenAPIGeneratorError("Query param schema must satisfy: object | any | unknown");
560
+ }
561
+ ref.parameters ??= [];
562
+ ref.parameters.push(...toOpenAPIParameters(resolvedSchema, "query"));
563
+ }
564
+ if (method !== "GET") {
565
+ const details = getEventIteratorSchemaDetails(def.schemas.bodySchema);
566
+ if (details) {
567
+ ref.requestBody = {
568
+ required: true,
612
569
  content: toOpenAPIEventIteratorContent(
613
- await this.converter.convert(eventIteratorSchemaDetails.yields, {
614
- ...baseSchemaConvertOptions,
615
- strategy: "output"
616
- }),
617
- await this.converter.convert(eventIteratorSchemaDetails.returns, {
618
- ...baseSchemaConvertOptions,
619
- strategy: "output"
620
- })
570
+ await converter(details.yields, { ...baseSchemaConvertOptions, strategy: "input" }),
571
+ await converter(details.returns, { ...baseSchemaConvertOptions, strategy: "input" })
621
572
  )
622
573
  };
623
- return;
624
- }
625
- const [required, json] = await this.converter.convert(outputSchema, {
626
- ...baseSchemaConvertOptions,
627
- strategy: "output",
628
- minStructureDepthForRef: outputStructure === "detailed" ? 1 : 0
629
- });
630
- if (outputStructure === "compact") {
631
- ref.responses ??= {};
632
- ref.responses[status] = {
633
- description
574
+ } else {
575
+ const [bodyRequired, bodySchema] = await converter(def.schemas.bodySchema, {
576
+ ...baseSchemaConvertOptions,
577
+ strategy: "input",
578
+ minStructureDepthForRef: 0
579
+ });
580
+ if (isAnySchema(bodySchema)) {
581
+ return;
582
+ }
583
+ ref.requestBody = {
584
+ required: bodyRequired,
585
+ content: toOpenAPIContent(bodySchema)
634
586
  };
635
- ref.responses[status].content = toOpenAPIContent(applySchemaOptionality(required, json));
636
- return;
637
587
  }
638
- const handledStatuses = /* @__PURE__ */ new Set();
639
- for (const item of expandUnionSchema(json)) {
640
- const error = new OpenAPIGeneratorError(`
641
- When output structure is "detailed", output schema must satisfy:
642
- {
643
- status?: number, // must be a literal number and in the range of 200-399
644
- headers?: Record<string, unknown>,
645
- body?: unknown
646
- }
588
+ }
589
+ }
590
+ async function handleSuccessResponse(doc, ref, def, baseSchemaConvertOptions, converter) {
591
+ const outputSchema = def.schemas.outputSchema;
592
+ const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
593
+ const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
594
+ const eventIteratorSchemaDetails = getEventIteratorSchemaDetails(outputSchema);
595
+ const outputStructure = fallbackContractConfig("defaultOutputStructure", def.route.outputStructure);
596
+ if (eventIteratorSchemaDetails) {
597
+ ref.responses ??= {};
598
+ ref.responses[status] = {
599
+ description,
600
+ content: toOpenAPIEventIteratorContent(
601
+ await converter(eventIteratorSchemaDetails.yields, {
602
+ ...baseSchemaConvertOptions,
603
+ strategy: "output"
604
+ }),
605
+ await converter(eventIteratorSchemaDetails.returns, {
606
+ ...baseSchemaConvertOptions,
607
+ strategy: "output"
608
+ })
609
+ )
610
+ };
611
+ return;
612
+ }
613
+ const [required, json] = await converter(outputSchema, {
614
+ ...baseSchemaConvertOptions,
615
+ strategy: "output",
616
+ minStructureDepthForRef: outputStructure === "detailed" ? 1 : 0
617
+ });
618
+ if (outputStructure === "compact") {
619
+ ref.responses ??= {};
620
+ ref.responses[status] = {
621
+ description
622
+ };
623
+ ref.responses[status].content = toOpenAPIContent(applySchemaOptionality(required, json));
624
+ return;
625
+ }
626
+ const handledStatuses = /* @__PURE__ */ new Set();
627
+ for (const item of expandUnionSchema(json)) {
628
+ const error = new OpenAPIGeneratorError(`
629
+ When output structure is "detailed", output schema must satisfy:
630
+ {
631
+ status?: number, // must be a literal number and in the range of 200-399
632
+ headers?: Record<string, unknown>,
633
+ body?: unknown
634
+ }
647
635
 
648
- But got: ${stringifyJSON(item)}
649
- `);
650
- if (!isObjectSchema(item)) {
636
+ But got: ${stringifyJSON(item)}
637
+ `);
638
+ if (!isObjectSchema(item)) {
639
+ throw error;
640
+ }
641
+ let schemaStatus;
642
+ let schemaDescription;
643
+ if (item.properties?.status !== void 0) {
644
+ const statusSchema = resolveOpenAPIJsonSchemaRef(doc, item.properties.status);
645
+ if (typeof statusSchema !== "object" || statusSchema.const === void 0 || typeof statusSchema.const !== "number" || !Number.isInteger(statusSchema.const) || isORPCErrorStatus(statusSchema.const)) {
651
646
  throw error;
652
647
  }
653
- let schemaStatus;
654
- let schemaDescription;
655
- if (item.properties?.status !== void 0) {
656
- const statusSchema = resolveOpenAPIJsonSchemaRef(doc, item.properties.status);
657
- if (typeof statusSchema !== "object" || statusSchema.const === void 0 || typeof statusSchema.const !== "number" || !Number.isInteger(statusSchema.const) || isORPCErrorStatus(statusSchema.const)) {
658
- throw error;
659
- }
660
- schemaStatus = statusSchema.const;
661
- schemaDescription = statusSchema.description;
662
- }
663
- const itemStatus = schemaStatus ?? status;
664
- const itemDescription = schemaDescription ?? description;
665
- if (handledStatuses.has(itemStatus)) {
666
- throw new OpenAPIGeneratorError(`
667
- When output structure is "detailed", each success status must be unique.
668
- But got status: ${itemStatus} used more than once.
669
- `);
648
+ schemaStatus = statusSchema.const;
649
+ schemaDescription = statusSchema.description;
650
+ }
651
+ const itemStatus = schemaStatus ?? status;
652
+ const itemDescription = schemaDescription ?? description;
653
+ if (handledStatuses.has(itemStatus)) {
654
+ throw new OpenAPIGeneratorError(`
655
+ When output structure is "detailed", each success status must be unique.
656
+ But got status: ${itemStatus} used more than once.
657
+ `);
658
+ }
659
+ handledStatuses.add(itemStatus);
660
+ ref.responses ??= {};
661
+ ref.responses[itemStatus] = {
662
+ description: itemDescription
663
+ };
664
+ if (item.properties?.headers !== void 0) {
665
+ const headersSchema = resolveOpenAPIJsonSchemaRef(doc, item.properties.headers);
666
+ if (!isObjectSchema(headersSchema)) {
667
+ throw error;
670
668
  }
671
- handledStatuses.add(itemStatus);
672
- ref.responses ??= {};
673
- ref.responses[itemStatus] = {
674
- description: itemDescription
675
- };
676
- if (item.properties?.headers !== void 0) {
677
- const headersSchema = resolveOpenAPIJsonSchemaRef(doc, item.properties.headers);
678
- if (!isObjectSchema(headersSchema)) {
679
- throw error;
680
- }
681
- for (const key in headersSchema.properties) {
682
- const headerSchema = headersSchema.properties[key];
683
- if (headerSchema !== void 0) {
684
- ref.responses[itemStatus].headers ??= {};
685
- ref.responses[itemStatus].headers[key] = {
686
- schema: toOpenAPISchema(headerSchema),
687
- required: item.required?.includes("headers") && headersSchema.required?.includes(key)
688
- };
689
- }
669
+ for (const key in headersSchema.properties) {
670
+ const headerSchema = headersSchema.properties[key];
671
+ if (headerSchema !== void 0) {
672
+ ref.responses[itemStatus].headers ??= {};
673
+ ref.responses[itemStatus].headers[key] = {
674
+ schema: toOpenAPISchema(headerSchema),
675
+ required: item.required?.includes("headers") && headersSchema.required?.includes(key)
676
+ };
690
677
  }
691
678
  }
692
- if (item.properties?.body !== void 0) {
693
- ref.responses[itemStatus].content = toOpenAPIContent(
694
- applySchemaOptionality(item.required?.includes("body") ?? false, item.properties.body)
695
- );
696
- }
697
- }
698
- }
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
679
  }
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
- };
680
+ if (item.properties?.body !== void 0) {
681
+ ref.responses[itemStatus].content = toOpenAPIContent(
682
+ applySchemaOptionality(item.required?.includes("body") ?? false, item.properties.body)
683
+ );
735
684
  }
736
685
  }
737
686
  }
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);
687
+ function authConfigToSecurityScheme(authConfig) {
688
+ switch (authConfig.type) {
689
+ case "basic":
690
+ return {
691
+ type: "http",
692
+ scheme: "basic",
693
+ description: authConfig.oasDescription
694
+ };
695
+ case "bearer":
696
+ return {
697
+ type: "http",
698
+ scheme: "bearer",
699
+ description: authConfig.oasDescription,
700
+ bearerFormat: authConfig.oasBearerFormat
701
+ };
702
+ case "header":
703
+ return {
704
+ type: "apiKey",
705
+ in: "header",
706
+ name: authConfig.name,
707
+ description: authConfig.oasDescription
708
+ };
709
+ case "query":
710
+ return {
711
+ type: "apiKey",
712
+ in: "query",
713
+ name: authConfig.name,
714
+ description: authConfig.oasDescription
715
+ };
716
+ case "cookie":
717
+ return {
718
+ type: "apiKey",
719
+ in: "cookie",
720
+ name: authConfig.name,
721
+ description: authConfig.oasDescription
722
+ };
723
+ default:
724
+ assertNever(authConfig, `Unsupported auth config type: ${authConfig.type}`);
725
+ }
753
726
  }
754
727
 
755
728
  const oo = {
756
729
  spec: customOpenAPIOperation
757
730
  };
758
731
 
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 };
732
+ export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, generateOpenApiSpec, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };