@orpc/openapi 0.0.0-next.1431467 → 0.0.0-next.15d9202

package/README.md

@@ -32,7 +32,7 @@
 - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
 - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
 - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
-- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
 - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
 - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
 - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
@@ -55,6 +55,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
+- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
 - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
 - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
 - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.

package/dist/adapters/fetch/index.d.mts

@@ -6,7 +6,7 @@ import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
 
 declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
     private readonly standardHandler;
-    constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
     handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
 }
 

package/dist/adapters/fetch/index.d.ts

@@ -6,7 +6,7 @@ import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
 
 declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
     private readonly standardHandler;
-    constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
     handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
 }
 

package/dist/adapters/fetch/index.mjs

@@ -1,10 +1,11 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.B6uueFtN.mjs';
+export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/standard-server-fetch';
-import '../../shared/openapi.C_biOx82.mjs';
+import '../../shared/openapi.CJTe38Ya.mjs';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.BHG_gu5Z.mjs';
+import '../../shared/openapi.DZzpQAb-.mjs';
+import 'json-schema-typed/draft-2020-12';

package/dist/adapters/hono/index.mjs

@@ -1,10 +1,11 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.B6uueFtN.mjs';
+export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/standard-server-fetch';
-import '../../shared/openapi.C_biOx82.mjs';
+import '../../shared/openapi.CJTe38Ya.mjs';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.BHG_gu5Z.mjs';
+import '../../shared/openapi.DZzpQAb-.mjs';
+import 'json-schema-typed/draft-2020-12';

package/dist/adapters/next/index.mjs

@@ -1,10 +1,11 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.B6uueFtN.mjs';
+export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/standard-server-fetch';
-import '../../shared/openapi.C_biOx82.mjs';
+import '../../shared/openapi.CJTe38Ya.mjs';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.BHG_gu5Z.mjs';
+import '../../shared/openapi.DZzpQAb-.mjs';
+import 'json-schema-typed/draft-2020-12';

package/dist/adapters/node/index.d.mts

@@ -6,7 +6,7 @@ import { SendStandardResponseOptions } from '@orpc/standard-server-node';
 
 declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
     private readonly standardHandler;
-    constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
     handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
 }
 

package/dist/adapters/node/index.d.ts

@@ -6,7 +6,7 @@ import { SendStandardResponseOptions } from '@orpc/standard-server-node';
 
 declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
     private readonly standardHandler;
-    constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
     handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
 }
 

package/dist/adapters/node/index.mjs

@@ -1,12 +1,13 @@
 import { OpenAPISerializer } from '@orpc/openapi-client/standard';
 import { StandardHandler } from '@orpc/server/standard';
 import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
-import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.C_biOx82.mjs';
-import '@orpc/contract';
+import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.CJTe38Ya.mjs';
 import '@orpc/shared';
+import 'json-schema-typed/draft-2020-12';
+import '@orpc/contract';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.BHG_gu5Z.mjs';
+import '../../shared/openapi.DZzpQAb-.mjs';
 
 class OpenAPIHandler {
   standardHandler;

package/dist/adapters/standard/index.d.mts

@@ -16,8 +16,19 @@ declare class OpenAPICodec implements StandardCodec {
 declare class OpenAPIMatcher implements StandardMatcher {
     private readonly tree;
     private pendingRouters;
-    init(router: AnyRouter, path?: string[]): void;
+    init(router: AnyRouter, path?: readonly string[]): void;
     match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
 }
 
-export { OpenAPICodec, OpenAPIMatcher };
+/**
+ * {@link https://github.com/unjs/rou3}
+ *
+ * @internal
+ */
+declare function toRou3Pattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function decodeParams(params: Record<string, string>): Record<string, string>;
+
+export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };

package/dist/adapters/standard/index.d.ts

@@ -16,8 +16,19 @@ declare class OpenAPICodec implements StandardCodec {
 declare class OpenAPIMatcher implements StandardMatcher {
     private readonly tree;
     private pendingRouters;
-    init(router: AnyRouter, path?: string[]): void;
+    init(router: AnyRouter, path?: readonly string[]): void;
     match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
 }
 
-export { OpenAPICodec, OpenAPIMatcher };
+/**
+ * {@link https://github.com/unjs/rou3}
+ *
+ * @internal
+ */
+declare function toRou3Pattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function decodeParams(params: Record<string, string>): Record<string, string>;
+
+export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };

package/dist/adapters/standard/index.mjs

@@ -1,6 +1,7 @@
-export { O as OpenAPICodec, a as OpenAPIMatcher } from '../../shared/openapi.C_biOx82.mjs';
+export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.CJTe38Ya.mjs';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.BHG_gu5Z.mjs';
+import '../../shared/openapi.DZzpQAb-.mjs';
+import 'json-schema-typed/draft-2020-12';

package/dist/index.d.mts

@@ -1,167 +1,119 @@
-import { AnyContractProcedure, Schema, ContractRouter, HTTPPath } from '@orpc/contract';
-import * as OpenAPI from 'openapi3-ts/oas31';
-export { OpenAPI };
-export { OpenApiBuilder } from 'openapi3-ts/oas31';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat, keywords as JSONSchemaKeywords } from 'json-schema-typed/draft-2020-12';
-import { OpenAPIJsonSerializer } from '@orpc/openapi-client/standard';
+import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
+import { OpenAPIV3_1 } from 'openapi-types';
+export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
 import { AnyRouter } from '@orpc/server';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
 
-type OverrideOperationValue = OpenAPI.OperationObject | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
-declare function setOperationExtender<T extends object>(o: T, extend: OverrideOperationValue): T;
-declare function getOperationExtender(o: object): OverrideOperationValue | undefined;
-declare function extendOperation(operation: OpenAPI.OperationObject, procedure: AnyContractProcedure): OpenAPI.OperationObject;
+type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
+declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
+declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
 
+/**
+ * @internal
+ */
 type ObjectSchema = JSONSchema & {
     type: 'object';
 } & object;
+/**
+ * @internal
+ */
 type FileSchema = JSONSchema & {
     type: 'string';
     contentMediaType: string;
 } & object;
-declare const NON_LOGIC_KEYWORDS: string[];
-
-declare class SchemaUtils {
-    isFileSchema(schema: JSONSchema): schema is FileSchema;
-    isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
-    isAnySchema(schema: JSONSchema): boolean;
-    isUndefinableSchema(schema: JSONSchema): boolean;
-    separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
-    filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
-}
-type PublicSchemaUtils = Pick<SchemaUtils, keyof SchemaUtils>;
+/**
+ * @internal
+ */
+declare const LOGIC_KEYWORDS: string[];
 
-declare class OpenAPIContentBuilder {
-    private readonly schemaUtils;
-    constructor(schemaUtils: PublicSchemaUtils);
-    build(jsonSchema: JSONSchema, options?: Partial<OpenAPI.MediaTypeObject>): OpenAPI.ContentObject;
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
 }
-type PublicOpenAPIContentBuilder = Pick<OpenAPIContentBuilder, keyof OpenAPIContentBuilder>;
-
-declare class OpenAPIPathParser {
-    parseDynamicParams(path: string): {
-        name: string;
-        raw: string;
-    }[];
-}
-type PublicOpenAPIPathParser = Pick<OpenAPIPathParser, keyof OpenAPIPathParser>;
-
-type SchemaConvertStrategy = 'input' | 'output';
 interface SchemaConverter {
-    convert(schema: Schema, strategy: SchemaConvertStrategy): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
 }
 interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: Schema, strategy: SchemaConvertStrategy): boolean;
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
 }
 declare class CompositeSchemaConverter implements SchemaConverter {
     private readonly converters;
     constructor(converters: ConditionalSchemaConverter[]);
-    convert(schema: Schema, strategy: SchemaConvertStrategy): [required: boolean, jsonSchema: JSONSchema];
-}
-
-interface OpenAPIInputStructureParseResult {
-    paramsSchema: ObjectSchema | undefined;
-    querySchema: ObjectSchema | undefined;
-    headersSchema: ObjectSchema | undefined;
-    bodySchema: JSONSchema | undefined;
-}
-declare class OpenAPIInputStructureParser {
-    private readonly schemaConverter;
-    private readonly schemaUtils;
-    private readonly pathParser;
-    constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils, pathParser: PublicOpenAPIPathParser);
-    parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIInputStructureParseResult;
-    private parseDetailedSchema;
-    private parseCompactSchema;
-}
-type PublicOpenAPIInputStructureParser = Pick<OpenAPIInputStructureParser, keyof OpenAPIInputStructureParser>;
-
-interface OpenAPIOutputStructureParseResult {
-    headersSchema: ObjectSchema | undefined;
-    bodySchema: JSONSchema | undefined;
-}
-declare class OpenAPIOutputStructureParser {
-    private readonly schemaConverter;
-    private readonly schemaUtils;
-    constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils);
-    parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIOutputStructureParseResult;
-    private parseDetailedSchema;
-    private parseCompactSchema;
-}
-type PublicOpenAPIOutputStructureParser = Pick<OpenAPIOutputStructureParser, keyof OpenAPIOutputStructureParser>;
-
-declare class OpenAPIParametersBuilder {
-    build(paramIn: OpenAPI.ParameterObject['in'], jsonSchema: JSONSchema & {
-        type: 'object';
-    } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.ParameterObject[];
-    buildHeadersObject(jsonSchema: JSONSchema & {
-        type: 'object';
-    } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.HeadersObject;
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
 }
-type PublicOpenAPIParametersBuilder = Pick<OpenAPIParametersBuilder, keyof OpenAPIParametersBuilder>;
 
-type ErrorHandlerStrategy = 'throw' | 'log' | 'ignore';
 interface OpenAPIGeneratorOptions {
-    contentBuilder?: PublicOpenAPIContentBuilder;
-    parametersBuilder?: PublicOpenAPIParametersBuilder;
     schemaConverters?: ConditionalSchemaConverter[];
-    schemaUtils?: PublicSchemaUtils;
-    jsonSerializer?: OpenAPIJsonSerializer;
-    pathParser?: PublicOpenAPIPathParser;
-    inputStructureParser?: PublicOpenAPIInputStructureParser;
-    outputStructureParser?: PublicOpenAPIOutputStructureParser;
-    /**
-     * Throw error when you missing define tag definition on OpenAPI root tags
-     *
-     * Example: if procedure has tags ['foo', 'bar'], and OpenAPI root tags is ['foo'], then error will be thrown
-     * Because OpenAPI root tags is missing 'bar' tag
-     *
-     * @default false
-     */
-    considerMissingTagDefinitionAsError?: boolean;
-    /**
-     * Weather ignore procedures that has no path defined.
-     *
-     * @default false
-     */
-    ignoreUndefinedPathProcedures?: boolean;
-    /**
-     * What to do when we found an error with our router
-     *
-     * @default 'throw'
-     */
-    errorHandlerStrategy?: ErrorHandlerStrategy;
-    /**
-     * Strict error response
-     *
-     * @default true
-     */
-    strictErrorResponses?: boolean;
 }
 declare class OpenAPIGenerator {
-    private readonly contentBuilder;
-    private readonly parametersBuilder;
-    private readonly schemaConverter;
-    private readonly schemaUtils;
-    private readonly jsonSerializer;
-    private readonly pathParser;
-    private readonly inputStructureParser;
-    private readonly outputStructureParser;
-    private readonly errorHandlerStrategy;
-    private readonly ignoreUndefinedPathProcedures;
-    private readonly considerMissingTagDefinitionAsError;
-    private readonly strictErrorResponses;
+    #private;
+    private readonly serializer;
+    private readonly converter;
     constructor(options?: OpenAPIGeneratorOptions);
-    generate(router: ContractRouter<any> | AnyRouter, doc: Omit<OpenAPI.OpenAPIObject, 'openapi'>): Promise<OpenAPI.OpenAPIObject>;
+    generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
 }
 
+/**
+ * @internal
+ */
 declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
-declare function toOpenAPI31RoutePattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIPath(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
+/**
+ * @internal
+ */
+declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
+/**
+ * @internal
+ */
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+/**
+ * @internal
+ */
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+/**
+ * @internal
+ */
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
-/** unnoq */
+/**
+ *@internal
+ */
+declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
+/**
+ * @internal
+ */
+declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
+/**
+ * @internal
+ */
+declare function isAnySchema(schema: JSONSchema): boolean;
+/**
+ * @internal
+ */
+declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
+/**
+ * @internal
+ */
+declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
 
 declare const oo: {
-    spec: typeof setOperationExtender;
+    spec: typeof customOpenAPIOperation;
 };
 
-export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, NON_LOGIC_KEYWORDS, type ObjectSchema, OpenAPIContentBuilder, OpenAPIGenerator, type OpenAPIGeneratorOptions, OpenAPIParametersBuilder, OpenAPIPathParser, type OverrideOperationValue, type PublicOpenAPIContentBuilder, type PublicOpenAPIParametersBuilder, type PublicOpenAPIPathParser, type PublicSchemaUtils, type SchemaConvertStrategy, type SchemaConverter, SchemaUtils, extendOperation, getOperationExtender, oo, setOperationExtender, standardizeHTTPPath, toOpenAPI31RoutePattern };
+export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, standardizeHTTPPath, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };