@orpc/openapi 0.0.0-next.eb37cbe → 0.0.0-next.ed15210

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 (34) hide show
  1. package/dist/chunk-7MA7YRRY.js +25 -0
  2. package/dist/chunk-BUMQYADN.js +653 -0
  3. package/dist/{chunk-KNYXLM77.js → chunk-DSYVLQK3.js} +3 -15
  4. package/dist/fetch.js +19 -579
  5. package/dist/hono.js +34 -0
  6. package/dist/index.js +291 -103
  7. package/dist/next.js +34 -0
  8. package/dist/node.js +46 -0
  9. package/dist/src/{fetch → adapters/fetch}/index.d.ts +2 -2
  10. package/dist/src/adapters/fetch/input-structure-compact.d.ts +6 -0
  11. package/dist/src/{fetch/input-builder-full.d.ts → adapters/fetch/input-structure-detailed.d.ts} +3 -3
  12. package/dist/src/{fetch → adapters/fetch}/openapi-handler.d.ts +15 -13
  13. package/dist/src/{fetch → adapters/fetch}/openapi-payload-codec.d.ts +2 -2
  14. package/dist/src/adapters/hono/index.d.ts +2 -0
  15. package/dist/src/adapters/next/index.d.ts +2 -0
  16. package/dist/src/adapters/node/index.d.ts +5 -0
  17. package/dist/src/adapters/node/openapi-handler-server.d.ts +7 -0
  18. package/dist/src/adapters/node/openapi-handler-serverless.d.ts +7 -0
  19. package/dist/src/adapters/node/openapi-handler.d.ts +11 -0
  20. package/dist/src/adapters/node/types.d.ts +2 -0
  21. package/dist/src/openapi-error.d.ts +3 -0
  22. package/dist/src/openapi-generator.d.ts +24 -8
  23. package/dist/src/openapi-input-structure-parser.d.ts +22 -0
  24. package/dist/src/openapi-output-structure-parser.d.ts +18 -0
  25. package/dist/src/openapi-parameters-builder.d.ts +3 -0
  26. package/dist/src/schema.d.ts +1 -1
  27. package/dist/src/utils.d.ts +3 -3
  28. package/package.json +21 -6
  29. package/dist/src/fetch/input-builder-simple.d.ts +0 -6
  30. /package/dist/src/{fetch → adapters/fetch}/bracket-notation.d.ts +0 -0
  31. /package/dist/src/{fetch → adapters/fetch}/openapi-handler-server.d.ts +0 -0
  32. /package/dist/src/{fetch → adapters/fetch}/openapi-handler-serverless.d.ts +0 -0
  33. /package/dist/src/{fetch → adapters/fetch}/openapi-procedure-matcher.d.ts +0 -0
  34. /package/dist/src/{fetch → adapters/fetch}/schema-coercer.d.ts +0 -0
@@ -0,0 +1,11 @@
1
+ import type { Context, Router } from '@orpc/server';
2
+ import type { IncomingMessage, ServerResponse } from 'node:http';
3
+ import type { OpenAPIHandlerOptions } from '../fetch/openapi-handler';
4
+ import type { Hono } from '../fetch/openapi-procedure-matcher';
5
+ import { type RequestHandler, type RequestHandleRest, type RequestHandleResult } from '@orpc/server/node';
6
+ export declare class OpenAPIHandler<T extends Context> implements RequestHandler<T> {
7
+ private readonly openapiFetchHandler;
8
+ constructor(hono: Hono, router: Router<T, any>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
9
+ handle(req: IncomingMessage, res: ServerResponse, ...[options]: RequestHandleRest<T>): Promise<RequestHandleResult>;
10
+ }
11
+ //# sourceMappingURL=openapi-handler.d.ts.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1,3 @@
1
+ export declare class OpenAPIError extends Error {
2
+ }
3
+ //# sourceMappingURL=openapi-error.d.ts.map
@@ -1,12 +1,15 @@
1
- import type { ContractRouter } from '@orpc/contract';
2
1
  import type { ANY_ROUTER } from '@orpc/server';
2
+ import type { PublicOpenAPIInputStructureParser } from './openapi-input-structure-parser';
3
+ import type { PublicOpenAPIOutputStructureParser } from './openapi-output-structure-parser';
3
4
  import type { PublicOpenAPIPathParser } from './openapi-path-parser';
4
5
  import type { SchemaConverter } from './schema-converter';
6
+ import { type ContractRouter } from '@orpc/contract';
5
7
  import { type PublicJSONSerializer } from './json-serializer';
6
8
  import { type OpenAPI } from './openapi';
7
9
  import { type PublicOpenAPIContentBuilder } from './openapi-content-builder';
8
10
  import { type PublicOpenAPIParametersBuilder } from './openapi-parameters-builder';
9
11
  import { type PublicSchemaUtils } from './schema-utils';
12
+ type ErrorHandlerStrategy = 'throw' | 'log' | 'ignore';
10
13
  export interface OpenAPIGeneratorOptions {
11
14
  contentBuilder?: PublicOpenAPIContentBuilder;
12
15
  parametersBuilder?: PublicOpenAPIParametersBuilder;
@@ -14,6 +17,8 @@ export interface OpenAPIGeneratorOptions {
14
17
  schemaUtils?: PublicSchemaUtils;
15
18
  jsonSerializer?: PublicJSONSerializer;
16
19
  pathParser?: PublicOpenAPIPathParser;
20
+ inputStructureParser?: PublicOpenAPIInputStructureParser;
21
+ outputStructureParser?: PublicOpenAPIOutputStructureParser;
17
22
  /**
18
23
  * Throw error when you missing define tag definition on OpenAPI root tags
19
24
  *
@@ -30,22 +35,33 @@ export interface OpenAPIGeneratorOptions {
30
35
  */
31
36
  ignoreUndefinedPathProcedures?: boolean;
32
37
  /**
33
- * Throw error when you have error in OpenAPI generator
38
+ * What to do when we found an error with our router
34
39
  *
35
- * @default false
40
+ * @default 'throw'
41
+ */
42
+ errorHandlerStrategy?: ErrorHandlerStrategy;
43
+ /**
44
+ * Strict error response
45
+ *
46
+ * @default true
36
47
  */
37
- throwOnError?: boolean;
48
+ strictErrorResponses?: boolean;
38
49
  }
39
50
  export declare class OpenAPIGenerator {
40
- private readonly options?;
41
51
  private readonly contentBuilder;
42
52
  private readonly parametersBuilder;
43
53
  private readonly schemaConverter;
44
54
  private readonly schemaUtils;
45
55
  private readonly jsonSerializer;
46
56
  private readonly pathParser;
47
- constructor(options?: OpenAPIGeneratorOptions | undefined);
48
- generate(router: ContractRouter | ANY_ROUTER, doc: Omit<OpenAPI.OpenAPIObject, 'openapi'>): Promise<OpenAPI.OpenAPIObject>;
49
- private handleError;
57
+ private readonly inputStructureParser;
58
+ private readonly outputStructureParser;
59
+ private readonly errorHandlerStrategy;
60
+ private readonly ignoreUndefinedPathProcedures;
61
+ private readonly considerMissingTagDefinitionAsError;
62
+ private readonly strictErrorResponses;
63
+ constructor(options?: OpenAPIGeneratorOptions);
64
+ generate(router: ContractRouter<any> | ANY_ROUTER, doc: Omit<OpenAPI.OpenAPIObject, 'openapi'>): Promise<OpenAPI.OpenAPIObject>;
50
65
  }
66
+ export {};
51
67
  //# sourceMappingURL=openapi-generator.d.ts.map
@@ -0,0 +1,22 @@
1
+ import type { PublicOpenAPIPathParser } from './openapi-path-parser';
2
+ import type { JSONSchema, ObjectSchema } from './schema';
3
+ import type { SchemaConverter } from './schema-converter';
4
+ import type { PublicSchemaUtils } from './schema-utils';
5
+ import { type ANY_CONTRACT_PROCEDURE } from '@orpc/contract';
6
+ export interface OpenAPIInputStructureParseResult {
7
+ paramsSchema: ObjectSchema | undefined;
8
+ querySchema: ObjectSchema | undefined;
9
+ headersSchema: ObjectSchema | undefined;
10
+ bodySchema: JSONSchema.JSONSchema | undefined;
11
+ }
12
+ export declare class OpenAPIInputStructureParser {
13
+ private readonly schemaConverter;
14
+ private readonly schemaUtils;
15
+ private readonly pathParser;
16
+ constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils, pathParser: PublicOpenAPIPathParser);
17
+ parse(contract: ANY_CONTRACT_PROCEDURE, structure: 'compact' | 'detailed'): OpenAPIInputStructureParseResult;
18
+ private parseDetailedSchema;
19
+ private parseCompactSchema;
20
+ }
21
+ export type PublicOpenAPIInputStructureParser = Pick<OpenAPIInputStructureParser, keyof OpenAPIInputStructureParser>;
22
+ //# sourceMappingURL=openapi-input-structure-parser.d.ts.map
@@ -0,0 +1,18 @@
1
+ import type { ANY_CONTRACT_PROCEDURE } from '@orpc/contract';
2
+ import type { JSONSchema, ObjectSchema } from './schema';
3
+ import type { SchemaConverter } from './schema-converter';
4
+ import type { PublicSchemaUtils } from './schema-utils';
5
+ export interface OpenAPIOutputStructureParseResult {
6
+ headersSchema: ObjectSchema | undefined;
7
+ bodySchema: JSONSchema.JSONSchema | undefined;
8
+ }
9
+ export declare class OpenAPIOutputStructureParser {
10
+ private readonly schemaConverter;
11
+ private readonly schemaUtils;
12
+ constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils);
13
+ parse(contract: ANY_CONTRACT_PROCEDURE, structure: 'compact' | 'detailed'): OpenAPIOutputStructureParseResult;
14
+ private parseDetailedSchema;
15
+ private parseCompactSchema;
16
+ }
17
+ export type PublicOpenAPIOutputStructureParser = Pick<OpenAPIOutputStructureParser, keyof OpenAPIOutputStructureParser>;
18
+ //# sourceMappingURL=openapi-output-structure-parser.d.ts.map
@@ -4,6 +4,9 @@ export declare class OpenAPIParametersBuilder {
4
4
  build(paramIn: OpenAPI.ParameterObject['in'], jsonSchema: JSONSchema.JSONSchema & {
5
5
  type: 'object';
6
6
  } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.ParameterObject[];
7
+ buildHeadersObject(jsonSchema: JSONSchema.JSONSchema & {
8
+ type: 'object';
9
+ } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.HeadersObject;
7
10
  }
8
11
  export type PublicOpenAPIParametersBuilder = Pick<OpenAPIParametersBuilder, keyof OpenAPIParametersBuilder>;
9
12
  //# sourceMappingURL=openapi-parameters-builder.d.ts.map
@@ -8,5 +8,5 @@ export type FileSchema = JSONSchema.JSONSchema & {
8
8
  type: 'string';
9
9
  contentMediaType: string;
10
10
  } & object;
11
- export declare const NON_LOGIC_KEYWORDS: ("$anchor" | "$comment" | "$defs" | "$dynamicAnchor" | "$dynamicRef" | "$id" | "$schema" | "$vocabulary" | "contentEncoding" | "contentMediaType" | "default" | "definitions" | "deprecated" | "description" | "examples" | "format" | "readOnly" | "title" | "writeOnly")[];
11
+ export declare const NON_LOGIC_KEYWORDS: string[];
12
12
  //# sourceMappingURL=schema.d.ts.map
@@ -1,7 +1,7 @@
1
1
  import type { ContractRouter, HTTPPath, WELL_CONTRACT_PROCEDURE } from '@orpc/contract';
2
2
  import type { ANY_PROCEDURE, ANY_ROUTER, Lazy } from '@orpc/server';
3
3
  export interface EachLeafOptions {
4
- router: ContractRouter | ANY_ROUTER;
4
+ router: ContractRouter<any> | ANY_ROUTER;
5
5
  path: string[];
6
6
  }
7
7
  export interface EachLeafCallbackOptions {
@@ -12,7 +12,7 @@ export interface EachContractLeafResultItem {
12
12
  router: Lazy<ANY_PROCEDURE> | Lazy<Record<string, ANY_ROUTER> | ANY_PROCEDURE>;
13
13
  path: string[];
14
14
  }
15
- export declare function forEachContractProcedure(options: EachLeafOptions, callback: (options: EachLeafCallbackOptions) => void, result?: EachContractLeafResultItem[], isCurrentRouterContract?: boolean): EachContractLeafResultItem[];
16
- export declare function forEachAllContractProcedure(router: ContractRouter | ANY_ROUTER, callback: (options: EachLeafCallbackOptions) => void): Promise<void>;
15
+ export declare function forEachContractProcedure(options: EachLeafOptions, callback: (options: EachLeafCallbackOptions) => void, result?: EachContractLeafResultItem[]): EachContractLeafResultItem[];
16
+ export declare function forEachAllContractProcedure(router: ContractRouter<any> | ANY_ROUTER, callback: (options: EachLeafCallbackOptions) => void): Promise<void>;
17
17
  export declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
18
18
  //# sourceMappingURL=utils.d.ts.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/openapi",
3
3
  "type": "module",
4
- "version": "0.0.0-next.eb37cbe",
4
+ "version": "0.0.0-next.ed15210",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -20,10 +20,25 @@
20
20
  "default": "./dist/index.js"
21
21
  },
22
22
  "./fetch": {
23
- "types": "./dist/src/fetch/index.d.ts",
23
+ "types": "./dist/src/adapters/fetch/index.d.ts",
24
24
  "import": "./dist/fetch.js",
25
25
  "default": "./dist/fetch.js"
26
26
  },
27
+ "./hono": {
28
+ "types": "./dist/src/adapters/hono/index.d.ts",
29
+ "import": "./dist/hono.js",
30
+ "default": "./dist/hono.js"
31
+ },
32
+ "./next": {
33
+ "types": "./dist/src/adapters/next/index.d.ts",
34
+ "import": "./dist/next.js",
35
+ "default": "./dist/next.js"
36
+ },
37
+ "./node": {
38
+ "types": "./dist/src/adapters/node/index.d.ts",
39
+ "import": "./dist/node.js",
40
+ "default": "./dist/node.js"
41
+ },
27
42
  "./🔒/*": {
28
43
  "types": "./dist/src/*.d.ts"
29
44
  }
@@ -43,16 +58,16 @@
43
58
  "json-schema-typed": "^8.0.1",
44
59
  "openapi3-ts": "^4.4.0",
45
60
  "wildcard-match": "^5.1.3",
46
- "@orpc/contract": "0.0.0-next.eb37cbe",
47
- "@orpc/server": "0.0.0-next.eb37cbe",
48
- "@orpc/shared": "0.0.0-next.eb37cbe"
61
+ "@orpc/contract": "0.0.0-next.ed15210",
62
+ "@orpc/shared": "0.0.0-next.ed15210",
63
+ "@orpc/server": "0.0.0-next.ed15210"
49
64
  },
50
65
  "devDependencies": {
51
66
  "@readme/openapi-parser": "^2.6.0",
52
67
  "zod": "^3.24.1"
53
68
  },
54
69
  "scripts": {
55
- "build": "tsup --clean --sourcemap --entry.index=src/index.ts --entry.fetch=src/fetch/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
70
+ "build": "tsup --onSuccess='tsc -b --noCheck'",
56
71
  "build:watch": "pnpm run build --watch",
57
72
  "type:check": "tsc -b"
58
73
  }
@@ -1,6 +0,0 @@
1
- import type { Params } from 'hono/router';
2
- export declare class InputBuilderSimple {
3
- build(params: Params, payload: unknown): unknown;
4
- }
5
- export type PublicInputBuilderSimple = Pick<InputBuilderSimple, keyof InputBuilderSimple>;
6
- //# sourceMappingURL=input-builder-simple.d.ts.map