@budibase/frontend-core 3.2.29 → 3.2.30

package/src/api/{queries.js → queries.ts}

@@ -1,12 +1,42 @@
-export const buildQueryEndpoints = API => ({
+import {
+  DeleteQueryResponse,
+  ExecuteQueryRequest,
+  ExecuteV2QueryResponse,
+  FetchQueriesResponse,
+  FindQueryResponse,
+  ImportRestQueryRequest,
+  ImportRestQueryResponse,
+  PreviewQueryRequest,
+  PreviewQueryResponse,
+  SaveQueryRequest,
+  SaveQueryResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface QueryEndpoints {
+  executeQuery: (
+    queryId: string,
+    opts?: ExecuteQueryRequest
+  ) => Promise<ExecuteV2QueryResponse>
+  fetchQueryDefinition: (queryId: string) => Promise<FindQueryResponse>
+  getQueries: () => Promise<FetchQueriesResponse>
+  saveQuery: (query: SaveQueryRequest) => Promise<SaveQueryResponse>
+  deleteQuery: (id: string, rev: string) => Promise<DeleteQueryResponse>
+  previewQuery: (query: PreviewQueryRequest) => Promise<PreviewQueryResponse>
+  importQueries: (
+    data: ImportRestQueryRequest
+  ) => Promise<ImportRestQueryResponse>
+}
+
+export const buildQueryEndpoints = (API: BaseAPIClient): QueryEndpoints => ({
   /**
    * Executes a query against an external data connector.
    * @param queryId the ID of the query to execute
    * @param pagination pagination info for the query
    * @param parameters parameters for the query
    */
-  executeQuery: async ({ queryId, pagination, parameters }) => {
-    return await API.post({
+  executeQuery: async (queryId, { pagination, parameters } = {}) => {
+    return await API.post<ExecuteQueryRequest, ExecuteV2QueryResponse>({
       url: `/api/v2/queries/${queryId}`,
       body: {
         parameters,
@@ -48,27 +78,22 @@ export const buildQueryEndpoints = API => ({
 
   /**
    * Deletes a query
-   * @param queryId the ID of the query to delete
-   * @param queryRev the rev of the query to delete
+   * @param id the ID of the query to delete
+   * @param rev the rev of the query to delete
    */
-  deleteQuery: async ({ queryId, queryRev }) => {
+  deleteQuery: async (id, rev) => {
     return await API.delete({
-      url: `/api/queries/${queryId}/${queryRev}`,
+      url: `/api/queries/${id}/${rev}`,
     })
   },
 
   /**
    * Imports a set of queries into a certain datasource
-   * @param datasourceId the datasource ID to import queries into
-   * @param data the data string of the content to import
    */
-  importQueries: async ({ datasourceId, data }) => {
+  importQueries: async data => {
     return await API.post({
       url: "/api/queries/import",
-      body: {
-        datasourceId,
-        data,
-      },
+      body: data,
     })
   },
 

package/src/api/relationships.ts

@@ -0,0 +1,31 @@
+import { FetchEnrichedRowResponse, Row } from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface RelationshipEndpoints {
+  fetchRelationshipData: (
+    sourceId: string,
+    rowId: string,
+    fieldName?: string
+  ) => Promise<Row[]>
+}
+
+export const buildRelationshipEndpoints = (
+  API: BaseAPIClient
+): RelationshipEndpoints => ({
+  /**
+   * Fetches related rows for a certain field of a certain row.
+   * @param sourceId the ID of the table to fetch from
+   * @param rowId the ID of the row to fetch related rows for
+   * @param fieldName the name of the relationship field
+   */
+  fetchRelationshipData: async (sourceId, rowId, fieldName) => {
+    const response = await API.get<FetchEnrichedRowResponse>({
+      url: `/api/${sourceId}/${rowId}/enrich?field=${fieldName}`,
+    })
+    if (!fieldName) {
+      return [response]
+    } else {
+      return response[fieldName] || []
+    }
+  },
+})

package/src/api/{roles.js → roles.ts}

@@ -1,12 +1,29 @@
-export const buildRoleEndpoints = API => ({
+import {
+  AccessibleRolesResponse,
+  DeleteRoleResponse,
+  FetchRolesResponse,
+  SaveRoleRequest,
+  SaveRoleResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface RoleEndpoints {
+  deleteRole: (id: string, rev: string) => Promise<DeleteRoleResponse>
+  saveRole: (role: SaveRoleRequest) => Promise<SaveRoleResponse>
+  getRoles: () => Promise<FetchRolesResponse>
+  getRolesForApp: (appId: string) => Promise<any>
+  getAccessibleRoles: () => Promise<AccessibleRolesResponse>
+}
+
+export const buildRoleEndpoints = (API: BaseAPIClient): RoleEndpoints => ({
   /**
    * Deletes a role.
-   * @param roleId the ID of the role to delete
-   * @param roleRev the rev of the role to delete
+   * @param id the ID of the role to delete
+   * @param rev the rev of the role to delete
    */
-  deleteRole: async ({ roleId, roleRev }) => {
+  deleteRole: async (id, rev) => {
     return await API.delete({
-      url: `/api/roles/${roleId}/${roleRev}`,
+      url: `/api/roles/${id}/${rev}`,
     })
   },
 

package/src/api/routes.ts

@@ -0,0 +1,30 @@
+import {
+  FetchClientScreenRoutingResponse,
+  FetchScreenRoutingResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface RouteEndpoints {
+  fetchClientAppRoutes: () => Promise<FetchClientScreenRoutingResponse>
+  fetchAppRoutes: () => Promise<FetchScreenRoutingResponse>
+}
+
+export const buildRouteEndpoints = (API: BaseAPIClient): RouteEndpoints => ({
+  /**
+   * Fetches available routes for the client app.
+   */
+  fetchClientAppRoutes: async () => {
+    return await API.get({
+      url: `/api/routing/client`,
+    })
+  },
+
+  /**
+   * Fetches all routes for the current app.
+   */
+  fetchAppRoutes: async () => {
+    return await API.get({
+      url: "/api/routing",
+    })
+  },
+})

package/src/api/{rowActions.js → rowActions.ts}

@@ -1,13 +1,46 @@
-export const buildRowActionEndpoints = API => ({
+import {
+  RowActionsResponse,
+  RowActionResponse,
+  CreateRowActionRequest,
+  RowActionPermissionsResponse,
+  RowActionTriggerRequest,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface RowActionEndpoints {
+  fetch: (tableId: string) => Promise<Record<string, RowActionResponse>>
+  create: (tableId: string, name: string) => Promise<RowActionResponse>
+  delete: (tableId: string, rowActionId: string) => Promise<void>
+  enableView: (
+    tableId: string,
+    rowActionId: string,
+    viewId: string
+  ) => Promise<RowActionPermissionsResponse>
+  disableView: (
+    tableId: string,
+    rowActionId: string,
+    viewId: string
+  ) => Promise<RowActionPermissionsResponse>
+  trigger: (
+    sourceId: string,
+    rowActionId: string,
+    rowId: string
+  ) => Promise<void>
+}
+
+export const buildRowActionEndpoints = (
+  API: BaseAPIClient
+): RowActionEndpoints => ({
   /**
    * Gets the available row actions for a table.
    * @param tableId the ID of the table
    */
   fetch: async tableId => {
-    const res = await API.get({
-      url: `/api/tables/${tableId}/actions`,
-    })
-    return res?.actions || {}
+    return (
+      await API.get<RowActionsResponse>({
+        url: `/api/tables/${tableId}/actions`,
+      })
+    ).actions
   },
 
   /**
@@ -15,8 +48,8 @@ export const buildRowActionEndpoints = API => ({
    * @param name the name of the row action
    * @param tableId the ID of the table
    */
-  create: async ({ name, tableId }) => {
-    return await API.post({
+  create: async (tableId, name) => {
+    return await API.post<CreateRowActionRequest, RowActionResponse>({
       url: `/api/tables/${tableId}/actions`,
       body: {
         name,
@@ -24,27 +57,12 @@ export const buildRowActionEndpoints = API => ({
     })
   },
 
-  /**
-   * Updates a row action.
-   * @param name the new name of the row action
-   * @param tableId the ID of the table
-   * @param rowActionId the ID of the row action to update
-   */
-  update: async ({ tableId, rowActionId, name }) => {
-    return await API.put({
-      url: `/api/tables/${tableId}/actions/${rowActionId}`,
-      body: {
-        name,
-      },
-    })
-  },
-
   /**
    * Deletes a row action.
    * @param tableId the ID of the table
    * @param rowActionId the ID of the row action to delete
    */
-  delete: async ({ tableId, rowActionId }) => {
+  delete: async (tableId, rowActionId) => {
     return await API.delete({
       url: `/api/tables/${tableId}/actions/${rowActionId}`,
     })
@@ -56,7 +74,7 @@ export const buildRowActionEndpoints = API => ({
    * @param rowActionId the ID of the row action
    * @param viewId the ID of the view
    */
-  enableView: async ({ tableId, rowActionId, viewId }) => {
+  enableView: async (tableId, rowActionId, viewId) => {
     return await API.post({
       url: `/api/tables/${tableId}/actions/${rowActionId}/permissions/${viewId}`,
     })
@@ -68,7 +86,7 @@ export const buildRowActionEndpoints = API => ({
    * @param rowActionId the ID of the row action
    * @param viewId the ID of the view
    */
-  disableView: async ({ tableId, rowActionId, viewId }) => {
+  disableView: async (tableId, rowActionId, viewId) => {
     return await API.delete({
       url: `/api/tables/${tableId}/actions/${rowActionId}/permissions/${viewId}`,
     })
@@ -79,8 +97,8 @@ export const buildRowActionEndpoints = API => ({
    * @param tableId the ID of the table
    * @param rowActionId the ID of the row action to trigger
    */
-  trigger: async ({ sourceId, rowActionId, rowId }) => {
-    return await API.post({
+  trigger: async (sourceId, rowActionId, rowId) => {
+    return await API.post<RowActionTriggerRequest>({
       url: `/api/tables/${sourceId}/actions/${rowActionId}/trigger`,
       body: {
         rowId,

package/src/api/rows.ts

@@ -0,0 +1,120 @@
+import {
+  DeleteRowRequest,
+  ExportRowsRequest,
+  FindRowResponse,
+  PatchRowRequest,
+  PatchRowResponse,
+  Row,
+  SaveRowRequest,
+  SaveRowResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface RowEndpoints {
+  fetchRow: (tableId: string, rowId: string) => Promise<FindRowResponse>
+  saveRow: (
+    row: SaveRowRequest,
+    suppressErrors?: boolean
+  ) => Promise<SaveRowResponse>
+  patchRow: (
+    row: PatchRowRequest,
+    suppressErrors?: boolean
+  ) => Promise<PatchRowResponse>
+  deleteRow: (sourceId: string, id: string) => Promise<void>
+  deleteRows: (sourceId: string, rows: (Row | string)[]) => Promise<void>
+  exportRows: (
+    tableId: string,
+    format: string,
+    data: ExportRowsRequest
+  ) => Promise<string>
+}
+
+export const buildRowEndpoints = (API: BaseAPIClient): RowEndpoints => ({
+  /**
+   * Fetches data about a certain row in a data source.
+   * @param sourceId the ID of the table or view to fetch from
+   * @param rowId the ID of the row to fetch
+   */
+  fetchRow: async (sourceId, rowId) => {
+    return await API.get({
+      url: `/api/${sourceId}/rows/${rowId}`,
+    })
+  },
+
+  /**
+   * Creates or updates a row in a table.
+   * @param row the row to save
+   * @param suppressErrors whether or not to suppress error notifications
+   */
+  saveRow: async (row, suppressErrors = false) => {
+    const sourceId = row._viewId || row.tableId
+    return await API.post({
+      url: `/api/${sourceId}/rows`,
+      body: row,
+      suppressErrors,
+    })
+  },
+
+  /**
+   * Patches a row in a table.
+   * @param row the row to patch
+   * @param suppressErrors whether or not to suppress error notifications
+   */
+  patchRow: async (row, suppressErrors = false) => {
+    const sourceId = row._viewId || row.tableId
+    return await API.patch({
+      url: `/api/${sourceId}/rows`,
+      body: row,
+      suppressErrors,
+    })
+  },
+
+  /**
+   * Deletes a row from a table.
+   * @param sourceId the ID of the table or view to delete from
+   * @param rowId the ID of the row to delete
+   */
+  deleteRow: async (sourceId, rowId) => {
+    return await API.delete<DeleteRowRequest>({
+      url: `/api/${sourceId}/rows`,
+      body: {
+        _id: rowId,
+      },
+    })
+  },
+
+  /**
+   * Deletes multiple rows from a table.
+   * @param sourceId the table or view ID to delete the rows from
+   * @param rows the array of rows to delete
+   */
+  deleteRows: async (sourceId, rows) => {
+    rows.forEach(row => {
+      if (typeof row === "object") {
+        delete row?._viewId
+      }
+    })
+    return await API.delete<DeleteRowRequest>({
+      url: `/api/${sourceId}/rows`,
+      body: {
+        rows,
+      },
+    })
+  },
+
+  /**
+   * Exports rows.
+   * @param tableId the table ID to export the rows from
+   * @param format the format to export (csv or json)
+   * @param data the export options
+   */
+  exportRows: async (tableId, format, data) => {
+    return await API.post({
+      url: `/api/${tableId}/rows/exportRows?format=${format}`,
+      body: data,
+      parseResponse: async response => {
+        return await response.text()
+      },
+    })
+  },
+})

package/src/api/screens.ts

@@ -0,0 +1,35 @@
+import {
+  DeleteScreenResponse,
+  SaveScreenRequest,
+  SaveScreenResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface ScreenEndpoints {
+  saveScreen: (screen: SaveScreenRequest) => Promise<SaveScreenResponse>
+  deleteScreen: (id: string, rev: string) => Promise<DeleteScreenResponse>
+}
+
+export const buildScreenEndpoints = (API: BaseAPIClient): ScreenEndpoints => ({
+  /**
+   * Saves a screen definition
+   * @param screen the screen to save
+   */
+  saveScreen: async screen => {
+    return await API.post({
+      url: "/api/screens",
+      body: screen,
+    })
+  },
+
+  /**
+   * Deletes a screen.
+   * @param id the ID of the screen to delete
+   * @param rev the rev of the screen to delete
+   */
+  deleteScreen: async (id, rev) => {
+    return await API.delete({
+      url: `/api/screens/${id}/${rev}`,
+    })
+  },
+})

package/src/api/{self.js → self.ts}

@@ -1,11 +1,28 @@
-export const buildSelfEndpoints = API => ({
+import {
+  AppSelfResponse,
+  FetchAPIKeyResponse,
+  GenerateAPIKeyResponse,
+  GetGlobalSelfResponse,
+  UpdateSelfRequest,
+  UpdateSelfResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface SelfEndpoints {
+  updateSelf: (user: UpdateSelfRequest) => Promise<UpdateSelfResponse>
+  generateAPIKey: () => Promise<string | undefined>
+  fetchDeveloperInfo: () => Promise<FetchAPIKeyResponse>
+  fetchBuilderSelf: () => Promise<GetGlobalSelfResponse>
+  fetchSelf: () => Promise<AppSelfResponse>
+}
+
+export const buildSelfEndpoints = (API: BaseAPIClient): SelfEndpoints => ({
   /**
    * Using the logged in user, this will generate a new API key,
    * assuming the user is a builder.
-   * @return {Promise<object>} returns the API response, including an API key.
    */
   generateAPIKey: async () => {
-    const response = await API.post({
+    const response = await API.post<null, GenerateAPIKeyResponse>({
       url: "/api/global/self/api_key",
     })
     return response?.apiKey
@@ -13,7 +30,6 @@ export const buildSelfEndpoints = API => ({
 
   /**
    * retrieves the API key for the logged in user.
-   * @return {Promise<object>} An object containing the user developer information.
    */
   fetchDeveloperInfo: async () => {
     return API.get({

package/src/api/tables.ts

@@ -0,0 +1,192 @@
+import {
+  BulkImportRequest,
+  BulkImportResponse,
+  CsvToJsonRequest,
+  CsvToJsonResponse,
+  FetchTablesResponse,
+  Row,
+  SaveTableRequest,
+  SaveTableResponse,
+  SearchRowRequest,
+  PaginatedSearchRowResponse,
+  TableSchema,
+  ValidateNewTableImportRequest,
+  ValidateTableImportRequest,
+  ValidateTableImportResponse,
+  FindTableResponse,
+  FetchRowsResponse,
+  MigrateTableResponse,
+  MigrateTableRequest,
+  DeleteTableResponse,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface TableEndpoints {
+  fetchTableDefinition: (tableId: string) => Promise<FindTableResponse>
+  fetchTableData: (tableId: string) => Promise<FetchRowsResponse>
+  searchTable: (
+    sourceId: string,
+    opts: SearchRowRequest
+  ) => Promise<PaginatedSearchRowResponse>
+  importTableData: (
+    tableId: string,
+    rows: Row[],
+    identifierFields?: string[]
+  ) => Promise<BulkImportResponse>
+  csvToJson: (csvString: string) => Promise<CsvToJsonResponse>
+  getTables: () => Promise<FetchTablesResponse>
+  getTable: (tableId: string) => Promise<FindTableResponse>
+  saveTable: (table: SaveTableRequest) => Promise<SaveTableResponse>
+  deleteTable: (id: string, rev: string) => Promise<DeleteTableResponse>
+  validateNewTableImport: (
+    rows: Row[],
+    schema: TableSchema
+  ) => Promise<ValidateTableImportResponse>
+  validateExistingTableImport: (
+    rows: Row[],
+    tableId?: string
+  ) => Promise<ValidateTableImportResponse>
+  migrateColumn: (
+    tableId: string,
+    oldColumn: string,
+    newColumn: string
+  ) => Promise<MigrateTableResponse>
+}
+
+export const buildTableEndpoints = (API: BaseAPIClient): TableEndpoints => ({
+  /**
+   * Fetches a table definition.
+   * Since definitions cannot change at runtime, the result is cached.
+   * @param tableId the ID of the table to fetch
+   */
+  fetchTableDefinition: async tableId => {
+    return await API.get({
+      url: `/api/tables/${tableId}`,
+      cache: true,
+    })
+  },
+
+  /**
+   * Fetches all rows from a table.
+   * @param sourceId the ID of the table to fetch
+   */
+  fetchTableData: async sourceId => {
+    return await API.get({ url: `/api/${sourceId}/rows` })
+  },
+
+  /**
+   * Searches a table using Lucene.
+   * @param sourceId the ID of the table to search
+   * @param opts the search opts
+   */
+  searchTable: async (sourceId, opts) => {
+    return await API.post({
+      url: `/api/${sourceId}/search`,
+      body: opts,
+    })
+  },
+
+  /**
+   * Imports data into an existing table
+   * @param tableId the table ID to import to
+   * @param rows the data import object
+   * @param identifierFields column names to be used as keys for overwriting existing rows
+   */
+  importTableData: async (tableId, rows, identifierFields) => {
+    return await API.post<BulkImportRequest, BulkImportResponse>({
+      url: `/api/tables/${tableId}/import`,
+      body: {
+        rows,
+        identifierFields,
+      },
+    })
+  },
+
+  /**
+   * Converts a CSV string to JSON
+   * @param csvString the CSV string
+   */
+  csvToJson: async csvString => {
+    return await API.post<CsvToJsonRequest, CsvToJsonResponse>({
+      url: "/api/convert/csvToJson",
+      body: {
+        csvString,
+      },
+    })
+  },
+
+  /**
+   * Gets a list of tables.
+   */
+  getTables: async () => {
+    return await API.get({
+      url: "/api/tables",
+    })
+  },
+
+  /**
+   * Get a single table based on table ID.
+   * Dupe of fetchTableDefinition but not cached?
+   */
+  getTable: async tableId => {
+    return await API.get({
+      url: `/api/tables/${tableId}`,
+    })
+  },
+
+  /**
+   * Saves a table.
+   * @param table the table to save
+   */
+  saveTable: async table => {
+    return await API.post({
+      url: "/api/tables",
+      body: table,
+    })
+  },
+
+  /**
+   * Deletes a table.
+   * @param id the ID of the table to delete
+   * @param rev the rev of the table to delete
+   */
+  deleteTable: async (id, rev) => {
+    return await API.delete({
+      url: `/api/tables/${id}/${rev}`,
+    })
+  },
+
+  validateNewTableImport: async (rows, schema) => {
+    return await API.post<
+      ValidateNewTableImportRequest,
+      ValidateTableImportResponse
+    >({
+      url: "/api/tables/validateNewTableImport",
+      body: {
+        rows,
+        schema,
+      },
+    })
+  },
+  validateExistingTableImport: async (rows, tableId) => {
+    return await API.post<
+      ValidateTableImportRequest,
+      ValidateTableImportResponse
+    >({
+      url: "/api/tables/validateExistingTableImport",
+      body: {
+        rows,
+        tableId,
+      },
+    })
+  },
+  migrateColumn: async (tableId, oldColumn, newColumn) => {
+    return await API.post<MigrateTableRequest, MigrateTableResponse>({
+      url: `/api/tables/${tableId}/migrate`,
+      body: {
+        oldColumn,
+        newColumn,
+      },
+    })
+  },
+})