import type { Plugin, Gasket } from '@gasket/core';
import type { Options } from 'swagger-jsdoc';
import type { SwaggerUiOptions } from 'swagger-ui-express';
import type { FastifySwaggerUiOptions } from '@fastify/swagger-ui';
import type { CreatePrompt, CreateContext } from 'create-gasket-app';

type SwaggerOptions = {
  /**
   * Target swagger spec file, either json or yaml. (Default:
   * 'swagger.json')
   */
  definitionFile?: string,

  /** Route to Swagger UI (Default: '/api-docs') */
  apiDocsRoute?: string,

  /**
   * If set, the definitionFile will be generated based on JSDocs in the
   * configured files. See the swagger-jsdocs options for what is
   * supported.
   */
  jsdoc?: Options,

  /**
   * Optional custom UI options. See swagger-ui-express options for what is
   * supported.
   */
  ui?: SwaggerUiOptions

  /**
   * Optional custom UI options (Fastify Only). See @fastify/swagger-ui options for what is
   * supported.
   */
  uiOptions?: FastifySwaggerUiOptions
}

declare module '@gasket/core' {
  export interface GasketConfig {
    swagger?: SwaggerOptions
  }
}

type BsdOptions = {
  root?: string,
  swagger?: SwaggerOptions
}

export function buildSwaggerDefinition(gasket: Gasket, options?: BsdOptions): Promise<void>;

declare module 'create-gasket-app' {
  export interface CreateContext {
    useSwagger?: boolean;
  }
}

/* Externalize Swagger prompts for preset */
export function promptSwagger(
  context: CreateContext,
  prompt: CreatePrompt
): Promise<CreateContext>

declare const plugin: Plugin;
export default plugin;