budibase/packages/frontend-core/src/fetch/index.ts

import TableFetch, { TableDatasource } from "./TableFetch"
import ViewFetch, { ViewV1Datasource } from "./ViewFetch"
import ViewV2Fetch, { ViewDatasource } from "./ViewV2Fetch"
import QueryFetch, { QueryDatasource } from "./QueryFetch"
import RelationshipFetch, { RelationshipDatasource } from "./RelationshipFetch"
import NestedProviderFetch, {
  NestedProviderDatasource,
} from "./NestedProviderFetch"
import FieldFetch, { FieldDatasource } from "./FieldFetch"
import JSONArrayFetch from "./JSONArrayFetch"
import UserFetch, { UserDatasource } from "./UserFetch"
import GroupUserFetch, { GroupUserDatasource } from "./GroupUserFetch"
import CustomFetch, { CustomDatasource } from "./CustomFetch"
import QueryArrayFetch from "./QueryArrayFetch"
import { APIClient } from "../api/types"
import { Table, ViewV2Enriched } from "@budibase/types"

export type DataFetchType = keyof typeof DataFetchMap
export type { DataFetchOptions } from "./DataFetch"

export const DataFetchMap = {
  table: TableFetch,
  view: ViewFetch,
  viewV2: ViewV2Fetch,
  query: QueryFetch,
  link: RelationshipFetch,
  user: UserFetch,
  groupUser: GroupUserFetch,
  custom: CustomFetch,

  // Client specific datasource types
  provider: NestedProviderFetch,
  field: FieldFetch<"field">,
  jsonarray: JSONArrayFetch,
  queryarray: QueryArrayFetch,
}

export type DataFetch =
  | TableFetch
  | ViewFetch
  | ViewV2Fetch
  | QueryFetch
  | RelationshipFetch
  | UserFetch
  | GroupUserFetch
  | CustomFetch
  | NestedProviderFetch
  | FieldFetch<"field">
  | JSONArrayFetch
  | QueryArrayFetch

export type DataFetchDatasource =
  | TableDatasource
  | ViewV1Datasource
  | ViewDatasource
  | QueryDatasource
  | RelationshipDatasource
  | UserDatasource
  | GroupUserDatasource
  | CustomDatasource
  | NestedProviderDatasource
  | FieldDatasource<"field" | "queryarray" | "jsonarray">
// | FieldDatasource<"field" | "queryarray" | "jsonarray">
// | FieldDatasource<"field" | "queryarray" | "jsonarray">

export type DataFetchDefinition =
  | Table
  | ViewV2Enriched
  | {
      schema?: Record<string, any> | null
      primaryDisplay?: string
    }

// Constructs a new fetch model for a certain datasource
export const fetchData = ({
  API,
  datasource,
  options,
}: {
  API: APIClient
  datasource: DataFetchDatasource
  options: any
}) => {
  const Fetch = DataFetchMap[datasource?.type] || TableFetch
  const fetch = new Fetch({ API, datasource, ...options })

  // Initially fetch data but don't bother waiting for the result
  fetch.getInitialData()

  return fetch
}

// Creates an empty fetch instance with no datasource configured, so no data
// will initially be loaded
const createEmptyFetchInstance = ({
  API,
  datasource,
}: {
  API: APIClient
  datasource: DataFetchDatasource
}) => {
  const handler = DataFetchMap[datasource?.type]
  if (!handler) {
    return null
  }
  return new handler({
    API,
    datasource: null as never,
    query: null as any,
  })
}

// Fetches the definition of any type of datasource
export const getDatasourceDefinition = async ({
  API,
  datasource,
}: {
  API: APIClient
  datasource: DataFetchDatasource
}) => {
  const instance = createEmptyFetchInstance({ API, datasource })
  return await instance?.getDefinition()
}

// Fetches the schema of any type of datasource
export const getDatasourceSchema = ({
  API,
  datasource,
  definition,
}: {
  API: APIClient
  datasource: DataFetchDatasource
  definition?: any
}) => {
  const instance = createEmptyFetchInstance({ API, datasource })
  return instance?.getSchema(definition)
}