models

export type AnySchema = Schema.Schema<any, any, any>

export type OpenAPIApiKeySecurityScheme = {
  type: "apiKey"
  description?: string
  name: string
  in: "query" | "header" | "cookie"
}

export type OpenAPIComponents<S = AnySchema> = {
  schemas?: Record<string, S>
  securitySchemes?: Record<string, OpenAPISecurityScheme>
}

export type OpenAPIHTTPSecurityScheme = {
  type: "http"
  description?: string
  scheme: "bearer" | "basic" | string
  /* only for scheme: 'bearer' */
  bearerFormat?: string
}

export type OpenAPIMutualTLSSecurityScheme = {
  type: "mutualTLS"
  description?: string
}

export type OpenAPIOAuth2SecurityScheme = {
  type: "oauth2"
  description?: string
  flows: Record<"implicit" | "password" | "clientCredentials" | "authorizationCode", Record<string, unknown>>
}

export type OpenAPIOpenIdConnectSecurityScheme = {
  type: "openIdConnect"
  description?: string
  openIdConnectUrl: string
}

export type OpenAPISchemaAllOfType = {
  allOf: Array<OpenAPISchemaType>
  nullable?: boolean
}

export type OpenAPISchemaAnyType = {}

export type OpenAPISchemaArrayType = {
  type: "array"
  items?: OpenAPISchemaType | Array<OpenAPISchemaType>
  minItems?: number
  maxItems?: number
  additionalItems?: OpenAPISchemaType
  nullable?: boolean
}

export type OpenAPISchemaBooleanType = {
  type: "boolean"
  nullable?: boolean
}

export type OpenAPISchemaEnumType = {
  type: "string" | "number" | "boolean"
  enum: Array<string | number | boolean | null>
  nullable?: boolean
}

export type OpenAPISchemaNullType = {
  type: "null"
}

export type OpenAPISchemaNumberType = {
  type: "number" | "integer"
  minimum?: number
  exclusiveMinimum?: boolean
  maximum?: number
  exclusiveMaximum?: boolean
  nullable?: boolean
}

export type OpenAPISchemaObjectType = {
  type: "object"
  required?: Array<string>
  properties?: { [x: string]: OpenAPISchemaType }
  additionalProperties?: boolean | OpenAPISchemaType
  nullable?: boolean
}

export type OpenAPISchemaOneOfType = {
  oneOf: ReadonlyArray<OpenAPISchemaType>
  nullable?: boolean
}

export type OpenAPISchemaStringType = {
  type: "string"
  minLength?: number
  maxLength?: number
  nullable?: boolean
}

export type OpenAPISchemaType = {
  description?: string
} & (
  | OpenAPISchemaNullType
  | OpenAPISchemaStringType
  | OpenAPISchemaNumberType
  | OpenAPISchemaBooleanType
  | OpenAPISchemaArrayType
  | OpenAPISchemaEnumType
  | OpenAPISchemaOneOfType
  | OpenAPISchemaAllOfType
  | OpenAPISchemaObjectType
  | OpenAPISchemaAnyType
  | OpenAPISpecReference
)

export type OpenAPISecurityRequirement = Record<string, Array<string>>

export type OpenAPISecurityScheme =
  | OpenAPIHTTPSecurityScheme
  | OpenAPIApiKeySecurityScheme
  | OpenAPIMutualTLSSecurityScheme
  | OpenAPIOAuth2SecurityScheme
  | OpenAPIOpenIdConnectSecurityScheme
  | OpenAPISpecReference

export type OpenAPISpec<S = AnySchema> = {
  openapi: "3.0.3"
  info: OpenAPISpecInfo
  servers?: Array<OpenAPISpecServer>
  paths: OpenAPISpecPaths<S>
  components?: OpenAPIComponents<S>
  security?: Array<OpenAPISecurityRequirement>
  tags?: Array<OpenAPISpecTag>
  externalDocs?: OpenAPISpecExternalDocs
}

export type OpenAPISpecExternalDocs = {
  url: string
  description?: string
}

export type OpenAPISpecInfo = {
  title: string
  version: string
  description?: string
  license?: OpenAPISpecLicense
}

export type OpenAPISpecLicense = {
  name: string
  url?: string
}

export type OpenAPISpecMethodName = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace"

export type OpenAPISpecOperation<S = AnySchema> = {
  requestBody?: OpenAPISpecRequestBody<S>
  responses?: OpenAPISpecResponses<S>
  operationId?: string
  description?: string
  parameters?: Array<OpenAPISpecParameter<S>>
  summary?: string
  deprecated?: boolean
  tags?: Array<string>
  security?: Array<OpenAPISecurityRequirement>
  externalDocs?: OpenAPISpecExternalDocs
}

export type OpenAPISpecParameter<S = AnySchema> = {
  name: string
  in: "query" | "header" | "path" | "cookie"
  schema: S
  description?: string
  required?: boolean
  deprecated?: boolean
  allowEmptyValue?: boolean
}

export type OpenAPISpecPathItem<S = AnySchema> = {
  [K in OpenAPISpecMethodName]?: OpenAPISpecOperation<S>
} & {
  summary?: string
  description?: string
  parameters?: Array<OpenAPISpecParameter>
}

export type OpenAPISpecPaths<S = AnySchema> = Record<string, OpenAPISpecPathItem<S>>

export type OpenAPISpecReference = {
  $ref: string
}

export type OpenAPISpecRequestBody<S = AnySchema> = {
  content: OpenApiSpecContent<S>
  description?: string
  required?: boolean
}

export type OpenAPISpecResponses<S = AnySchema> = {
  [K in OpenAPISpecStatusCode]?: OpenApiSpecResponse<S>
}

export type OpenAPISpecServer = {
  url: string
  description?: string
  variables?: Record<string, OpenAPISpecServerVariable>
}

export type OpenAPISpecServerVariable = {
  default: string
  enum?: [string, ...Array<string>]
  description?: string
}

export type OpenAPISpecStatusCode = 200 | 201 | 204

export type OpenAPISpecTag = {
  name: string
  description?: string
  externalDocs?: OpenAPISpecExternalDocs
}

export type OpenApiSpecContent<S = AnySchema> = {
  [K in OpenApiSpecContentType]?: OpenApiSpecMediaType<S>
}

export type OpenApiSpecContentType = "application/json" | "application/xml"

export type OpenApiSpecMediaType<S = AnySchema> = {
  schema?: S
  example?: object
  description?: string
}

export type OpenApiSpecResponse<S = AnySchema> = {
  content?: OpenApiSpecContent<S>
  headers?: OpenApiSpecResponseHeaders<S>
  description: string
}

export type OpenApiSpecResponseHeader<S = AnySchema> = {
  description?: string
  schema: S
}

export type OpenApiSpecResponseHeaders<S = AnySchema> = Record<string, OpenApiSpecResponseHeader<S>>