import type { Config } from '@api-helper/cli';
import { defineConfig } from '@api-helper/cli';

import { defineConfig } from '@api-helper/cli';

export default defineConfig({
  // Whether to generate only the TypeScript type of interface request data and return data. If yes, the request file and request function will not be generated.
  onlyTyping: false,
  // The output path after code generation
  outputPath: 'src/api/index.ts',
  // Use category output. After this function is enabled, multi-file code is output based on interface classification
  outputByCategory: false,
  // The target type of the generated code. Default: typescript
  target: 'typescript',
  // File path of the request function.
  requestFunctionFilePath: 'src/api/request.ts',
  // Custom type conversion
  // Example: { long: 'number' } — converts the 'long' type to 'number'
  transformType: Record<string, string | ((type: string, format?: string | 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password', emptyType?: string) => string)>,
  // Set all fields of the request data as required attributes, default: false
  requiredRequestField: false,
  // Set all fields of the response data as required attributes, default: true，默认：true
  requiredResponseField: true,
  // Generate an interface that contains only these categories
  includeCategory: [],
  // Exclude interfaces for these categories
  excludeCategory: [],
  // Generate specified interface
  // Example：['/v1/login', ['/v1/login', 'get'], ['/v1/login', '(get|post|put)'], ['/v1/login', '*']]，The * in the example represents all the request modes
  // More syntax reference for matching rules：https://github.com/micromatch/micromatch
  includeAPI: [],
  // Exclude specified interface
  excludeAPI: [],
  // Interface document service configuration
  documentServers: [{
    // Interface Document address [When the type is 'swagger', you can read local files, here can be a local file path]
    url: 'https://api-documentation.com/demo/swagger-ui.html',
    // Interface document type, call the built-in parser according to the document type, default value: 'swagger' [Built-in yapi and swagger parser, other document types, add parserPlugins to implement document parsing by yourself]
    type: 'swagger',
    // The name of the current interface document service. When there is a value, the file output becomes -> path/current name
    name: '',
    // The key to get the response data, body[dataKey]
    dataKey: '',
    // Accessing the document may require authentication information, which can be done using HTTP auth type.
    auth: {
      username: '',
      password: '',
    },
    // Accessing the document may require authentication information, which can be accessed using a token, such as Yapi's authentication token.
    authToken: '',
    // Request headers when fetching the interface document with AJAX.
    headers: {},
    // Hook events in the execution process.
    events: {
      // Event callback when generating interface name, the return value is used as the new InterfaceName, which is used to customize the InterfaceName.
      // onRenderInterfaceName(api, options) {},
      // Event callback when generating API name, the return value is used as the new RequestFunctionName, which is used to customize the RequestFunctionName.
      // onRenderRequestFunctionName(api, options) {},
    },
  }],
  // Parse extension plugins, used for custom parsing
  parserPlugins: [],
});