packages/openapi/src/index.ts - develop - dimamir/undb

packages/openapi/src/index.ts
122 строки3 KB
nichenqin
chore: add aggregate open api
17 ноя 2024, 06:31
17 ноя 2024, 06:31132a696
import {
  OpenAPIRegistry,
  OpenApiGeneratorV3,
  extendZodWithOpenApi,
  type RouteConfig,
} from "@asteasolutions/zod-to-openapi"
import { z } from "@undb/zod"

extendZodWithOpenApi(z)

import type { Base } from "@undb/base"
import { type IReadableRecordDTO, type TableDo, type View } from "@undb/table"
import {
  RECORD_COMPONENT,
  VIEW_PIVOT_COMPONENT,
  VIEW_RECORD_COMPONENT,
  bulkDeleteRecords,
  bulkDuplicateRecords,
  bulkUpdateRecords,
  createPivotViewDateComponent,
  createRecord,
  createRecordComponent,
  createRecords,
  deleteRecordById,
  duplicateRecordById,
  getAggregateRecords,
  getPivotData,
  getRecordById,
  getRecords,
  getViewRecordById,
  getViewRecords,
  recordSubscription,
  submitForm,
  triggerButton,
  updateRecord,
} from "./openapi/record.openapi"

export const API_TOKEN_HEADER_NAME = "x-undb-api-token"

export interface ViewsOpenApi {
  view: View
  record?: IReadableRecordDTO
}

export const createOpenApiSpec = (
  base: Base,
  table: TableDo,
  record: IReadableRecordDTO | undefined,
  views: ViewsOpenApi[],
) => {
  const registry = new OpenAPIRegistry()

  const recordSchema = createRecordComponent(table, undefined, record)
  registry.register(RECORD_COMPONENT, recordSchema.openapi({ description: table.name.value + " record schema" }))

  const routes: RouteConfig[] = [
    getRecords(base, table, recordSchema),
    getRecordById(base, table, recordSchema),
    createRecord(base, table),
    createRecords(base, table),
    updateRecord(base, table),
    bulkUpdateRecords(base, table),
    duplicateRecordById(base, table),
    bulkDuplicateRecords(base, table),
    deleteRecordById(base, table),
    bulkDeleteRecords(base, table),
    recordSubscription(base, table),
  ]

  const buttons = table.schema.getButtonFields()
  for (const button of buttons) {
    routes.push(triggerButton(base, table, button))
  }

  const forms = table.forms?.forms ?? []
  for (const form of forms) {
    routes.push(submitForm(base, table, form))
  }

  for (const { view, record } of views) {
    if (view.type === "pivot") {
      const pivotViewDataComponent = createPivotViewDateComponent(table, view)
      registry.register(view.name.value + ":" + VIEW_PIVOT_COMPONENT, pivotViewDataComponent)

      routes.push(getPivotData(base, table, view))
    } else {
      const viewRecordSchema = createRecordComponent(table, view, record)
      registry.register(
        view.name.value + ":" + VIEW_RECORD_COMPONENT,
        viewRecordSchema.openapi({ description: table.name.value + " " + view.name.value + " view record schema" }),
      )

      routes.push(getAggregateRecords(base, table, view))
      routes.push(getViewRecords(base, table, view, viewRecordSchema))
      routes.push(getViewRecordById(base, table, view, viewRecordSchema))
    }
  }

  const apiKeyAuth = registry.registerComponent("securitySchemes", "apiKeyAuth", {
    type: "apiKey",
    in: "header",
    name: API_TOKEN_HEADER_NAME,
  })

  for (const route of routes) {
    registry.registerPath(route)
    route.security = [{ [apiKeyAuth.name]: [] }]
  }

  const generator = new OpenApiGeneratorV3(registry.definitions)

  return generator.generateDocument({
    openapi: "3.1.0",
    info: {
      version: "1.0.0",
      title: table.name.value,
    },
    servers: [{ url: "/openapi" }],
  })
}

export * from "./api-token"