trpc-openapi/dist/types.d.ts

tRPC OpenAPI

import { Procedure, ProcedureParams, Router } from '@trpc/server';
import type { RootConfig } from '@trpc/server/dist/core/internals/config';
import { TRPC_ERROR_CODE_KEY } from '@trpc/server/rpc';
import type { RouterDef } from '@trpc/server/src/core/router';
import { OpenAPIV3 } from 'openapi-types';
import { ZodIssue } from 'zod';
export type OpenApiMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
type TRPCMeta = Record<string, unknown>;
export type OpenApiContentType = 'application/json' | 'application/x-www-form-urlencoded' | (string & {});
export type OpenApiMeta<TMeta = TRPCMeta> = TMeta & {
    openapi?: {
        enabled?: boolean;
        method: OpenApiMethod;
        path: `/${string}`;
        summary?: string;
        description?: string;
        protect?: boolean;
        tags?: string[];
        headers?: (OpenAPIV3.ParameterBaseObject & {
            name: string;
            in?: 'header';
        })[];
        contentTypes?: OpenApiContentType[];
        deprecated?: boolean;
        example?: {
            request?: Record<string, any>;
            response?: Record<string, any>;
        };
    };
};
export type OpenApiProcedure<TMeta = TRPCMeta> = Procedure<'query' | 'mutation', ProcedureParams<RootConfig<{
    transformer: any;
    errorShape: any;
    ctx: any;
    meta: OpenApiMeta<TMeta>;
}>, any, any, any, any, any, OpenApiMeta<TMeta>>>;
export type OpenApiProcedureRecord<TMeta = TRPCMeta> = Record<string, OpenApiProcedure<TMeta>>;
export type OpenApiRouter<TMeta = TRPCMeta> = Router<RouterDef<RootConfig<{
    transformer: any;
    errorShape: any;
    ctx: any;
    meta: OpenApiMeta<TMeta>;
}>, any, any>>;
export type OpenApiSuccessResponse<D = any> = D;
export type OpenApiErrorResponse = {
    message: string;
    code: TRPC_ERROR_CODE_KEY;
    issues?: ZodIssue[];
};
export type OpenApiResponse<D = any> = OpenApiSuccessResponse<D> | OpenApiErrorResponse;
export {};
//# sourceMappingURL=types.d.ts.map