@orpc/openapi 0.0.0-next.da8ae32 → 0.0.0-next.da92bc0

package/dist/src/adapters/standard/bracket-notation.d.ts

@@ -1,84 +0,0 @@
-/**
- * Serialize an object or array into a list of [key, value] pairs.
- * The key will express by using bracket-notation.
- *
- * Notice: This way cannot express the empty object or array.
- *
- * @example
- * ```ts
- * const payload = {
- *  name: 'John Doe',
- *  pets: ['dog', 'cat'],
- * }
- *
- * const entities = serialize(payload)
- *
- * expect(entities).toEqual([
- *  ['name', 'John Doe'],
- *  ['name[pets][0]', 'dog'],
- *  ['name[pets][1]', 'cat'],
- * ])
- * ```
- */
-export declare function serialize(payload: unknown, parentKey?: string): [string, unknown][];
-/**
- * Deserialize a list of [key, value] pairs into an object or array.
- * The key is expressed by using bracket-notation.
- *
- * @example
- * ```ts
- * const entities = [
- *  ['name', 'John Doe'],
- *  ['name[pets][0]', 'dog'],
- *  ['name[pets][1]', 'cat'],
- *  ['name[dogs][]', 'hello'],
- *  ['name[dogs][]', 'kitty'],
- * ]
- *
- * const payload = deserialize(entities)
- *
- * expect(payload).toEqual({
- *  name: 'John Doe',
- *  pets: { 0: 'dog', 1: 'cat' },
- *  dogs: ['hello', 'kitty'],
- * })
- * ```
- */
-export declare function deserialize(entities: readonly (readonly [string, unknown])[]): Record<string, unknown> | unknown[] | undefined;
-/**
- * Escape the `[`, `]`, and `\` chars in a path segment.
- *
- * @example
- * ```ts
- * expect(escapeSegment('name[pets')).toEqual('name\\[pets')
- * ```
- */
-export declare function escapeSegment(segment: string): string;
-/**
- * Convert an array of path segments into a path string using bracket-notation.
- *
- * For the special char `[`, `]`, and `\` will be escaped by adding `\` at start.
- *
- * @example
- * ```ts
- * expect(stringifyPath(['name', 'pets', '0'])).toEqual('name[pets][0]')
- * ```
- */
-export declare function stringifyPath(path: readonly [string, ...string[]]): string;
-/**
- * Convert a path string using bracket-notation into an array of path segments.
- *
- * For the special char `[`, `]`, and `\` you should escape by adding `\` at start.
- * It only treats a pair `[${string}]` as a path segment.
- * If missing or escape it will bypass and treat as normal string.
- *
- * @example
- * ```ts
- * expect(parsePath('name[pets][0]')).toEqual(['name', 'pets', '0'])
- * expect(parsePath('name[pets][0')).toEqual(['name', 'pets', '[0'])
- * expect(parsePath('name[pets[0]')).toEqual(['name', 'pets[0')
- * expect(parsePath('name\\[pets][0]')).toEqual(['name[pets]', '0'])
- * ```
- */
-export declare function parsePath(path: string): [string, ...string[]];
-//# sourceMappingURL=bracket-notation.d.ts.map

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

@@ -1,6 +0,0 @@
-export * as BracketNotation from './bracket-notation';
-export * from './openapi-codec';
-export * from './openapi-handler';
-export * from './openapi-matcher';
-export * from './openapi-serializer';
-//# sourceMappingURL=index.d.ts.map

package/dist/src/adapters/standard/openapi-codec.d.ts

@@ -1,15 +0,0 @@
-import type { AnyProcedure } from '@orpc/server';
-import type { StandardCodec, StandardParams, StandardRequest, StandardResponse } from '@orpc/server/standard';
-import { type ORPCError } from '@orpc/contract';
-import { OpenAPISerializer } from './openapi-serializer';
-export interface OpenAPICodecOptions {
-    serializer?: OpenAPISerializer;
-}
-export declare class OpenAPICodec implements StandardCodec {
-    private readonly serializer;
-    constructor(options?: OpenAPICodecOptions);
-    decode(request: StandardRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
-    encode(output: unknown, procedure: AnyProcedure): StandardResponse;
-    encodeError(error: ORPCError<any, any>): StandardResponse;
-}
-//# sourceMappingURL=openapi-codec.d.ts.map

package/dist/src/adapters/standard/openapi-handler.d.ts

@@ -1,7 +0,0 @@
-import type { Context } from '@orpc/server';
-import type { RPCHandlerOptions } from '@orpc/server/standard';
-import type { OpenAPICodecOptions } from './openapi-codec';
-import type { OpenAPIMatcherOptions } from './openapi-matcher';
-export interface OpenAPIHandlerOptions<T extends Context> extends RPCHandlerOptions<T>, OpenAPIMatcherOptions, OpenAPICodecOptions {
-}
-//# sourceMappingURL=openapi-handler.d.ts.map

package/dist/src/adapters/standard/openapi-matcher.d.ts

@@ -1,20 +0,0 @@
-import type { AnyRouter } from '@orpc/server';
-import type { StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
-import { type HTTPPath } from '@orpc/contract';
-export interface OpenAPIMatcherOptions {
-    /**
-     * Ignore procedure that does not have a method defined in the contract.
-     *
-     * @default false
-     */
-    ignoreUndefinedMethod?: boolean;
-}
-export declare class OpenAPIMatcher implements StandardMatcher {
-    private readonly tree;
-    private readonly ignoreUndefinedMethod;
-    constructor(options?: OpenAPIMatcherOptions);
-    private pendingRouters;
-    init(router: AnyRouter, path?: string[]): void;
-    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
-}
-//# sourceMappingURL=openapi-matcher.d.ts.map

package/dist/src/adapters/standard/openapi-serializer.d.ts

@@ -1,11 +0,0 @@
-import type { PublicJSONSerializer } from '../../json-serializer';
-export interface OpenAPISerializerOptions {
-    jsonSerializer?: PublicJSONSerializer;
-}
-export declare class OpenAPISerializer {
-    private readonly jsonSerializer;
-    constructor(options?: OpenAPISerializerOptions);
-    serialize(data: unknown): unknown;
-    deserialize(serialized: unknown): unknown;
-}
-//# sourceMappingURL=openapi-serializer.d.ts.map

package/dist/src/index.d.ts

@@ -1,17 +0,0 @@
-/** unnoq */
-import { setOperationExtender } from './openapi-operation-extender';
-export * from './json-serializer';
-export * from './openapi';
-export * from './openapi-content-builder';
-export * from './openapi-generator';
-export * from './openapi-operation-extender';
-export * from './openapi-parameters-builder';
-export * from './openapi-path-parser';
-export * from './schema';
-export * from './schema-converter';
-export * from './schema-utils';
-export * from './utils';
-export declare const oo: {
-    spec: typeof setOperationExtender;
-};
-//# sourceMappingURL=index.d.ts.map

package/dist/src/json-serializer.d.ts

@@ -1,5 +0,0 @@
-export declare class JSONSerializer {
-    serialize(payload: unknown): unknown;
-}
-export type PublicJSONSerializer = Pick<JSONSerializer, keyof JSONSerializer>;
-//# sourceMappingURL=json-serializer.d.ts.map

package/dist/src/openapi-content-builder.d.ts

@@ -1,10 +0,0 @@
-import type { OpenAPI } from './openapi';
-import type { JSONSchema } from './schema';
-import type { PublicSchemaUtils } from './schema-utils';
-export declare class OpenAPIContentBuilder {
-    private readonly schemaUtils;
-    constructor(schemaUtils: PublicSchemaUtils);
-    build(jsonSchema: JSONSchema.JSONSchema, options?: Partial<OpenAPI.MediaTypeObject>): OpenAPI.ContentObject;
-}
-export type PublicOpenAPIContentBuilder = Pick<OpenAPIContentBuilder, keyof OpenAPIContentBuilder>;
-//# sourceMappingURL=openapi-content-builder.d.ts.map

package/dist/src/openapi-error.d.ts

@@ -1,3 +0,0 @@
-export declare class OpenAPIError extends Error {
-}
-//# sourceMappingURL=openapi-error.d.ts.map

package/dist/src/openapi-generator.d.ts

@@ -1,67 +0,0 @@
-import type { PublicOpenAPIInputStructureParser } from './openapi-input-structure-parser';
-import type { PublicOpenAPIOutputStructureParser } from './openapi-output-structure-parser';
-import type { PublicOpenAPIPathParser } from './openapi-path-parser';
-import type { SchemaConverter } from './schema-converter';
-import { type ContractRouter } from '@orpc/contract';
-import { type AnyRouter } from '@orpc/server';
-import { type PublicJSONSerializer } from './json-serializer';
-import { type OpenAPI } from './openapi';
-import { type PublicOpenAPIContentBuilder } from './openapi-content-builder';
-import { type PublicOpenAPIParametersBuilder } from './openapi-parameters-builder';
-import { type PublicSchemaUtils } from './schema-utils';
-type ErrorHandlerStrategy = 'throw' | 'log' | 'ignore';
-export interface OpenAPIGeneratorOptions {
-    contentBuilder?: PublicOpenAPIContentBuilder;
-    parametersBuilder?: PublicOpenAPIParametersBuilder;
-    schemaConverters?: SchemaConverter[];
-    schemaUtils?: PublicSchemaUtils;
-    jsonSerializer?: PublicJSONSerializer;
-    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;
-}
-export 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;
-    constructor(options?: OpenAPIGeneratorOptions);
-    generate(router: ContractRouter<any> | AnyRouter, doc: Omit<OpenAPI.OpenAPIObject, 'openapi'>): Promise<OpenAPI.OpenAPIObject>;
-}
-export {};
-//# sourceMappingURL=openapi-generator.d.ts.map

package/dist/src/openapi-input-structure-parser.d.ts

@@ -1,22 +0,0 @@
-import type { AnyContractProcedure } from '@orpc/contract';
-import type { PublicOpenAPIPathParser } from './openapi-path-parser';
-import type { JSONSchema, ObjectSchema } from './schema';
-import type { SchemaConverter } from './schema-converter';
-import type { PublicSchemaUtils } from './schema-utils';
-export interface OpenAPIInputStructureParseResult {
-    paramsSchema: ObjectSchema | undefined;
-    querySchema: ObjectSchema | undefined;
-    headersSchema: ObjectSchema | undefined;
-    bodySchema: JSONSchema.JSONSchema | undefined;
-}
-export 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;
-}
-export type PublicOpenAPIInputStructureParser = Pick<OpenAPIInputStructureParser, keyof OpenAPIInputStructureParser>;
-//# sourceMappingURL=openapi-input-structure-parser.d.ts.map

package/dist/src/openapi-operation-extender.d.ts

@@ -1,7 +0,0 @@
-import type { AnyContractProcedure } from '@orpc/contract';
-import type { OpenAPI } from './openapi';
-export type OverrideOperationValue = OpenAPI.OperationObject | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
-export declare function setOperationExtender<T extends object>(o: T, extend: OverrideOperationValue): T;
-export declare function getOperationExtender(o: object): OverrideOperationValue | undefined;
-export declare function extendOperation(operation: OpenAPI.OperationObject, procedure: AnyContractProcedure): OpenAPI.OperationObject;
-//# sourceMappingURL=openapi-operation-extender.d.ts.map

package/dist/src/openapi-output-structure-parser.d.ts

@@ -1,18 +0,0 @@
-import type { AnyContractProcedure } from '@orpc/contract';
-import type { JSONSchema, ObjectSchema } from './schema';
-import type { SchemaConverter } from './schema-converter';
-import type { PublicSchemaUtils } from './schema-utils';
-export interface OpenAPIOutputStructureParseResult {
-    headersSchema: ObjectSchema | undefined;
-    bodySchema: JSONSchema.JSONSchema | undefined;
-}
-export 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;
-}
-export type PublicOpenAPIOutputStructureParser = Pick<OpenAPIOutputStructureParser, keyof OpenAPIOutputStructureParser>;
-//# sourceMappingURL=openapi-output-structure-parser.d.ts.map

package/dist/src/openapi-parameters-builder.d.ts

@@ -1,12 +0,0 @@
-import type { OpenAPI } from './openapi';
-import type { JSONSchema } from './schema';
-export declare class OpenAPIParametersBuilder {
-    build(paramIn: OpenAPI.ParameterObject['in'], jsonSchema: JSONSchema.JSONSchema & {
-        type: 'object';
-    } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.ParameterObject[];
-    buildHeadersObject(jsonSchema: JSONSchema.JSONSchema & {
-        type: 'object';
-    } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.HeadersObject;
-}
-export type PublicOpenAPIParametersBuilder = Pick<OpenAPIParametersBuilder, keyof OpenAPIParametersBuilder>;
-//# sourceMappingURL=openapi-parameters-builder.d.ts.map

package/dist/src/openapi-path-parser.d.ts

@@ -1,8 +0,0 @@
-export declare class OpenAPIPathParser {
-    parseDynamicParams(path: string): {
-        name: string;
-        raw: string;
-    }[];
-}
-export type PublicOpenAPIPathParser = Pick<OpenAPIPathParser, keyof OpenAPIPathParser>;
-//# sourceMappingURL=openapi-path-parser.d.ts.map

package/dist/src/openapi.d.ts

@@ -1,3 +0,0 @@
-export { OpenApiBuilder } from 'openapi3-ts/oas31';
-export type * as OpenAPI from 'openapi3-ts/oas31';
-//# sourceMappingURL=openapi.d.ts.map

package/dist/src/schema-converter.d.ts

@@ -1,16 +0,0 @@
-import type { Schema } from '@orpc/contract';
-import type { JSONSchema } from './schema';
-export interface SchemaConvertOptions {
-    strategy: 'input' | 'output';
-}
-export interface SchemaConverter {
-    condition(schema: Schema, options: SchemaConvertOptions): boolean;
-    convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
-}
-export declare class CompositeSchemaConverter implements SchemaConverter {
-    private readonly converters;
-    constructor(converters: SchemaConverter[]);
-    condition(): boolean;
-    convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
-}
-//# sourceMappingURL=schema-converter.d.ts.map

package/dist/src/schema-utils.d.ts

@@ -1,11 +0,0 @@
-import { type FileSchema, type JSONSchema, type ObjectSchema } from './schema';
-export declare class SchemaUtils {
-    isFileSchema(schema: JSONSchema.JSONSchema): schema is FileSchema;
-    isObjectSchema(schema: JSONSchema.JSONSchema): schema is ObjectSchema;
-    isAnySchema(schema: JSONSchema.JSONSchema): boolean;
-    isUndefinableSchema(schema: JSONSchema.JSONSchema): boolean;
-    separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
-    filterSchemaBranches(schema: JSONSchema.JSONSchema, check: (schema: JSONSchema.JSONSchema) => boolean, matches?: JSONSchema.JSONSchema[]): [matches: JSONSchema.JSONSchema[], rest: JSONSchema.JSONSchema | undefined];
-}
-export type PublicSchemaUtils = Pick<SchemaUtils, keyof SchemaUtils>;
-//# sourceMappingURL=schema-utils.d.ts.map

package/dist/src/schema.d.ts

@@ -1,12 +0,0 @@
-import * as JSONSchema from 'json-schema-typed/draft-2020-12';
-export { Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema };
-export type ObjectSchema = JSONSchema.JSONSchema & {
-    type: 'object';
-} & object;
-export type FileSchema = JSONSchema.JSONSchema & {
-    type: 'string';
-    contentMediaType: string;
-} & object;
-export declare const NON_LOGIC_KEYWORDS: string[];
-//# sourceMappingURL=schema.d.ts.map

package/dist/src/utils.d.ts

@@ -1,3 +0,0 @@
-import type { HTTPPath } from '@orpc/contract';
-export declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
-//# sourceMappingURL=utils.d.ts.map

package/dist/standard.js

@@ -1,14 +0,0 @@
-import {
-  OpenAPICodec,
-  OpenAPIMatcher,
-  OpenAPISerializer,
-  bracket_notation_exports
-} from "./chunk-DRV7KYES.js";
-import "./chunk-HC5PVG4R.js";
-export {
-  bracket_notation_exports as BracketNotation,
-  OpenAPICodec,
-  OpenAPIMatcher,
-  OpenAPISerializer
-};
-//# sourceMappingURL=standard.js.map