@riktajs/swagger 0.10.2 → 0.11.0

package/dist/plugin/swagger.plugin.js

@@ -1,126 +0,0 @@
-import fp from 'fastify-plugin';
-import fastifySwagger from '@fastify/swagger';
-import fastifySwaggerUI from '@fastify/swagger-ui';
-import { OpenApiGenerator } from '../openapi/generator.js';
-import { registry } from '@riktajs/core';
-const DEFAULT_OPTIONS = {
-    jsonPath: '/docs/json',
-    uiPath: '/docs',
-    exposeUI: true,
-    exposeSpec: true,
-};
-async function swaggerPluginImpl(fastify, options) {
-    const mergedOptions = { ...DEFAULT_OPTIONS, ...options };
-    const { jsonPath, uiPath, exposeUI, exposeSpec, controllers, config, info, transform } = mergedOptions;
-    const apiInfo = info || config?.info || {
-        title: 'API Documentation',
-        version: '1.0.0',
-    };
-    const generator = new OpenApiGenerator({
-        ...config,
-        info: apiInfo,
-    });
-    const controllersToDocument = controllers || registry.getControllers();
-    for (const controller of controllersToDocument) {
-        generator.addController(controller);
-    }
-    if (config?.securitySchemes) {
-        for (const [name, scheme] of Object.entries(config.securitySchemes)) {
-            generator.addSecurityScheme(name, scheme);
-        }
-    }
-    let spec = generator.generate();
-    if (transform) {
-        spec = await transform(spec);
-    }
-    await fastify.register(fastifySwagger, {
-        mode: 'static',
-        specification: {
-            document: spec,
-        },
-    });
-    if (exposeUI) {
-        const uiOptions = {
-            routePrefix: uiPath,
-            uiConfig: {
-                docExpansion: 'list',
-                deepLinking: true,
-                displayRequestDuration: true,
-                filter: true,
-                syntaxHighlight: {
-                    activate: true,
-                    theme: mergedOptions.theme === 'dark' ? 'monokai' : 'agate',
-                },
-            },
-            staticCSP: true,
-            transformStaticCSP: (header) => header,
-        };
-        if (mergedOptions.logo) {
-            uiOptions.logo = {
-                type: 'image/png',
-                content: mergedOptions.logo.url,
-                href: mergedOptions.logo.url,
-            };
-        }
-        await fastify.register(fastifySwaggerUI, uiOptions);
-    }
-    const defaultSwaggerUIJsonPath = `${uiPath}/json`;
-    const shouldRegisterCustomJsonRoute = exposeSpec && (!exposeUI ||
-        (jsonPath !== defaultSwaggerUIJsonPath && jsonPath !== '/docs/json'));
-    if (shouldRegisterCustomJsonRoute) {
-        fastify.get(jsonPath, {
-            schema: {
-                hide: true,
-            },
-        }, async () => {
-            return spec;
-        });
-    }
-    fastify.decorate('openApiSpec', spec);
-}
-export const swaggerPlugin = fp(swaggerPluginImpl, {
-    fastify: '>=4.0.0',
-    name: '@riktajs/swagger',
-    dependencies: [],
-});
-export async function registerSwagger(app, options = {}) {
-    await app.register(swaggerPlugin, options);
-}
-export function createSwaggerConfig(options = {}) {
-    const mergedOptions = { ...DEFAULT_OPTIONS, ...options };
-    const { uiPath, controllers, config, info } = mergedOptions;
-    const apiInfo = info || config?.info || {
-        title: 'API Documentation',
-        version: '1.0.0',
-    };
-    const generator = new OpenApiGenerator({
-        ...config,
-        info: apiInfo,
-    });
-    const controllersToDocument = controllers || registry.getControllers();
-    for (const controller of controllersToDocument) {
-        generator.addController(controller);
-    }
-    if (config?.securitySchemes) {
-        for (const [name, scheme] of Object.entries(config.securitySchemes)) {
-            generator.addSecurityScheme(name, scheme);
-        }
-    }
-    const specification = generator.generate();
-    return {
-        swaggerOptions: {
-            mode: 'static',
-            specification: { document: specification },
-        },
-        swaggerUIOptions: {
-            routePrefix: uiPath,
-            uiConfig: {
-                docExpansion: 'list',
-                deepLinking: true,
-                displayRequestDuration: true,
-                filter: true,
-            },
-        },
-        specification,
-    };
-}

package/dist/types.d.ts

@@ -1,338 +0,0 @@
-import type { ZodType } from 'zod';
-export type OpenApiDataType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
-export type OpenApiFormat = 'int32' | 'int64' | 'float' | 'double' | 'date' | 'date-time' | 'password' | 'byte' | 'binary' | 'email' | 'uuid' | 'uri' | 'hostname' | 'ipv4' | 'ipv6';
-export interface OpenApiSchemaObject {
-    type?: OpenApiDataType;
-    format?: string;
-    description?: string;
-    default?: unknown;
-    example?: unknown;
-    enum?: unknown[];
-    items?: OpenApiSchemaObject;
-    properties?: Record<string, OpenApiSchemaObject>;
-    required?: string[];
-    nullable?: boolean;
-    allOf?: OpenApiSchemaObject[];
-    oneOf?: OpenApiSchemaObject[];
-    anyOf?: OpenApiSchemaObject[];
-    not?: OpenApiSchemaObject;
-    $ref?: string;
-    minimum?: number;
-    maximum?: number;
-    minLength?: number;
-    maxLength?: number;
-    pattern?: string;
-    additionalProperties?: boolean | OpenApiSchemaObject;
-}
-export type ParameterLocation = 'query' | 'path' | 'header' | 'cookie';
-export interface OpenApiParameterObject {
-    name: string;
-    in: ParameterLocation;
-    description?: string;
-    required?: boolean;
-    deprecated?: boolean;
-    schema?: OpenApiSchemaObject;
-    example?: unknown;
-    examples?: Record<string, {
-        value: unknown;
-        summary?: string;
-    }>;
-}
-export interface OpenApiRequestBodyObject {
-    description?: string;
-    required?: boolean;
-    content: Record<string, {
-        schema?: OpenApiSchemaObject;
-        example?: unknown;
-        examples?: Record<string, {
-            value: unknown;
-            summary?: string;
-        }>;
-    }>;
-}
-export interface OpenApiResponseObject {
-    description: string;
-    content?: Record<string, {
-        schema?: OpenApiSchemaObject;
-        example?: unknown;
-    }>;
-    headers?: Record<string, {
-        description?: string;
-        schema?: OpenApiSchemaObject;
-    }>;
-}
-export type OpenApiSecurityRequirement = Record<string, string[]>;
-export interface OpenApiSecurityScheme {
-    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
-    description?: string;
-    name?: string;
-    in?: 'query' | 'header' | 'cookie';
-    scheme?: string;
-    bearerFormat?: string;
-    flows?: {
-        implicit?: {
-            authorizationUrl: string;
-            scopes: Record<string, string>;
-        };
-        password?: {
-            tokenUrl: string;
-            scopes: Record<string, string>;
-        };
-        clientCredentials?: {
-            tokenUrl: string;
-            scopes: Record<string, string>;
-        };
-        authorizationCode?: {
-            authorizationUrl: string;
-            tokenUrl: string;
-            scopes: Record<string, string>;
-        };
-    };
-    openIdConnectUrl?: string;
-}
-export interface OpenApiOperation {
-    tags?: string[];
-    summary?: string;
-    description?: string;
-    externalDocs?: {
-        url: string;
-        description?: string;
-    };
-    operationId?: string;
-    parameters?: Array<{
-        name: string;
-        in: 'path' | 'query' | 'header' | 'cookie';
-        description?: string;
-        required?: boolean;
-        deprecated?: boolean;
-        schema?: OpenApiSchemaObject;
-        example?: unknown;
-    }>;
-    requestBody?: {
-        description?: string;
-        required?: boolean;
-        content: Record<string, {
-            schema?: OpenApiSchemaObject;
-            example?: unknown;
-        }>;
-    };
-    responses: Record<string, {
-        description: string;
-        headers?: Record<string, {
-            description?: string;
-            schema?: OpenApiSchemaObject;
-        }>;
-        content?: Record<string, {
-            schema?: OpenApiSchemaObject;
-            example?: unknown;
-        }>;
-    }>;
-    deprecated?: boolean;
-    security?: Array<Record<string, string[]>>;
-}
-export interface OpenApiPathItem {
-    get?: OpenApiOperation;
-    put?: OpenApiOperation;
-    post?: OpenApiOperation;
-    delete?: OpenApiOperation;
-    options?: OpenApiOperation;
-    head?: OpenApiOperation;
-    patch?: OpenApiOperation;
-    trace?: OpenApiOperation;
-    summary?: string;
-    description?: string;
-    parameters?: Array<{
-        name: string;
-        in: 'path' | 'query' | 'header' | 'cookie';
-        required?: boolean;
-        schema?: OpenApiSchemaObject;
-    }>;
-}
-export interface OpenApiInfoObject {
-    title: string;
-    version: string;
-    description?: string;
-    termsOfService?: string;
-    contact?: {
-        name?: string;
-        url?: string;
-        email?: string;
-    };
-    license?: {
-        name: string;
-        url?: string;
-        identifier?: string;
-    };
-}
-export interface OpenApiDocument {
-    openapi: string;
-    info: OpenApiInfoObject;
-    paths: Record<string, OpenApiPathItem>;
-    servers?: Array<{
-        url: string;
-        description?: string;
-        variables?: Record<string, {
-            default: string;
-            description?: string;
-            enum?: string[];
-        }>;
-    }>;
-    components?: {
-        schemas?: Record<string, OpenApiSchemaObject>;
-        securitySchemes?: Record<string, OpenApiSecurityScheme | {
-            type: string;
-            description?: string;
-            name?: string;
-            in?: string;
-            scheme?: string;
-            bearerFormat?: string;
-            flows?: unknown;
-        }>;
-        responses?: Record<string, OpenApiResponseObject>;
-        parameters?: Record<string, OpenApiParameterObject>;
-        requestBodies?: Record<string, OpenApiRequestBodyObject>;
-    };
-    security?: Array<Record<string, string[]>>;
-    tags?: Array<{
-        name: string;
-        description?: string;
-        externalDocs?: {
-            url: string;
-            description?: string;
-        };
-    }>;
-    externalDocs?: {
-        url: string;
-        description?: string;
-    };
-}
-export interface ApiOperationOptions {
-    summary?: string;
-    description?: string;
-    operationId?: string;
-    deprecated?: boolean;
-    tags?: string[];
-}
-export interface ApiResponseOptions {
-    status: number;
-    description?: string;
-    schema?: ZodType<unknown> | OpenApiSchemaObject;
-    type?: string;
-    example?: unknown;
-    isArray?: boolean;
-}
-export interface ApiPropertyOptions {
-    description?: string;
-    example?: unknown;
-    default?: unknown;
-    required?: boolean;
-    type?: OpenApiDataType | string;
-    format?: OpenApiFormat | string;
-    enum?: unknown[];
-    nullable?: boolean;
-    minimum?: number;
-    maximum?: number;
-    minLength?: number;
-    maxLength?: number;
-    pattern?: string;
-    deprecated?: boolean;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-}
-export interface ApiParamOptions {
-    name: string;
-    description?: string;
-    required?: boolean;
-    type?: OpenApiDataType | string;
-    format?: OpenApiFormat | string;
-    example?: unknown;
-    enum?: unknown[];
-    deprecated?: boolean;
-    schema?: ZodType<unknown>;
-}
-export interface ApiQueryOptions extends Omit<ApiParamOptions, 'required'> {
-    required?: boolean;
-    isArray?: boolean;
-}
-export interface ApiHeaderOptions {
-    name: string;
-    description?: string;
-    required?: boolean;
-    type?: OpenApiDataType | string;
-    deprecated?: boolean;
-    example?: unknown;
-    schema?: ZodType<unknown>;
-}
-export interface ApiBodyOptions {
-    description?: string;
-    required?: boolean;
-    type?: string;
-    schema?: ZodType<unknown> | OpenApiSchemaObject;
-    example?: unknown;
-    examples?: Record<string, {
-        value: unknown;
-        summary?: string;
-        description?: string;
-    }>;
-    isArray?: boolean;
-}
-export interface ApiSecurityOptions {
-    name: string;
-    scopes?: string[];
-}
-export interface SwaggerServerConfig {
-    url: string;
-    description?: string;
-    variables?: Record<string, {
-        default: string;
-        description?: string;
-        enum?: string[];
-    }>;
-}
-export interface SwaggerContactConfig {
-    name?: string;
-    url?: string;
-    email?: string;
-}
-export interface SwaggerLicenseConfig {
-    name: string;
-    url?: string;
-    identifier?: string;
-}
-export interface SwaggerExternalDocsConfig {
-    url: string;
-    description?: string;
-}
-export interface SwaggerTagConfig {
-    name: string;
-    description?: string;
-    externalDocs?: SwaggerExternalDocsConfig;
-}
-export interface SwaggerConfig {
-    info?: OpenApiInfoObject;
-    externalDocs?: SwaggerExternalDocsConfig;
-    servers?: SwaggerServerConfig[];
-    tags?: SwaggerTagConfig[];
-    securitySchemes?: Record<string, OpenApiSecurityScheme>;
-    security?: OpenApiSecurityRequirement[];
-    jsonPath?: string;
-    uiPath?: string;
-    openApiVersion?: '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.1.0';
-    includeUndocumented?: boolean;
-    basePath?: string;
-}
-export interface StoredResponseMetadata extends ApiResponseOptions {
-    _stored: true;
-}
-export interface StoredParamMetadata extends ApiParamOptions {
-    _stored: true;
-    location: ParameterLocation;
-}
-export interface ExtractedRouteInfo {
-    method: string;
-    path: string;
-    handlerName: string | symbol;
-    controllerPrefix: string;
-    controllerClass: Function;
-}
-export type Constructor<T = unknown> = new (...args: any[]) => T;

package/dist/types.js

@@ -1 +0,0 @@
-export {};