nestjs-typebox/dist/types.d.ts

This library provides helper utilities for writing and validating NestJS APIs using [TypeBox](https://github.com/sinclairzx81/typebox) as an alternative to class-validator/class-transformer. Can be configured to patch @nestjs/swagger allowing OpenAPI gene

import type { PipeTransform, Type } from '@nestjs/common';
import { ApiOperationOptions } from '@nestjs/swagger';
import type { Static, StaticDecode, TComposite, TOmit, TPartial, TPick, TSchema } from '@sinclair/typebox';
import type { TypeCheck } from '@sinclair/typebox/compiler';
import { SchemaAnalysis } from './analyze-schema.js';
export type AllKeys<T> = T extends unknown ? Exclude<keyof T, symbol> : never;
export type Obj<T = unknown> = Record<string, T>;
export interface Configure {
    patchSwagger?: boolean;
    setFormats?: boolean;
}
export type MethodDecorator<T extends Function = any> = (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
export interface HttpEndpointDecoratorConfig<S extends TSchema = TSchema, RequestConfigs extends RequestValidatorConfig[] = RequestValidatorConfig[]> extends Omit<ApiOperationOptions, 'requestBody' | 'parameters'> {
    method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
    responseCode?: number;
    path?: string;
    validate?: ValidatorConfig<S, RequestConfigs>;
}
export interface SchemaValidator<T extends TSchema = TSchema> {
    schema: T;
    name: string;
    analysis: SchemaAnalysis;
    check: TypeCheck<T>['Check'];
    validate(data: Obj | Obj[]): unknown;
}
export interface ValidatorConfigBase {
    schema?: TSchema;
    coerceTypes?: boolean;
    stripUnknownProps?: boolean;
    name?: string;
    required?: boolean;
    pipes?: (PipeTransform | Type<PipeTransform>)[];
}
export interface ResponseValidatorConfig<T extends TSchema = TSchema> extends ValidatorConfigBase {
    schema: T;
    type?: 'response';
    responseCode?: number;
    description?: string;
    example?: Static<T>;
    required?: true;
    pipes?: never;
}
export interface ParamValidatorConfig extends ValidatorConfigBase {
    schema?: TSchema;
    type: 'param';
    name: string;
    stripUnknownProps?: never;
}
export interface QueryValidatorConfig extends ValidatorConfigBase {
    schema?: TSchema;
    type: 'query';
    name: string;
    stripUnknownProps?: never;
}
export interface BodyValidatorConfig extends ValidatorConfigBase {
    schema: TSchema;
    type: 'body';
}
export type RequestValidatorConfig = ParamValidatorConfig | QueryValidatorConfig | BodyValidatorConfig;
export type SchemaValidatorConfig = RequestValidatorConfig | ResponseValidatorConfig;
export type ValidatorType = NonNullable<SchemaValidatorConfig['type']>;
export interface ValidatorConfig<S extends TSchema, RequestConfigs extends RequestValidatorConfig[]> {
    response?: ResponseValidatorConfig<S> | S;
    request?: [...RequestConfigs];
}
export type RequestConfigsToTypes<RequestConfigs extends RequestValidatorConfig[]> = {
    [K in keyof RequestConfigs]: RequestConfigs[K]['required'] extends false ? RequestConfigs[K]['schema'] extends TSchema ? StaticDecode<RequestConfigs[K]['schema']> | undefined : string | undefined : RequestConfigs[K]['schema'] extends TSchema ? StaticDecode<RequestConfigs[K]['schema']> : string;
};
export type TPartialSome<T extends TSchema, K extends PropertyKey[]> = TComposite<[TOmit<T, K>, TPartial<TPick<T, K>>]>;