import API, { HttpMethod } from "api/Api"; import { ApiResponse, GenericApiResponse, ResponseMeta } from "./ApiResponses"; import { DEFAULT_EXECUTE_ACTION_TIMEOUT_MS } from "@appsmith/constants/ApiConstants"; import axios, { AxiosPromise, CancelTokenSource } from "axios"; import { Action, ActionViewMode } from "entities/Action"; import { APIRequest } from "constants/AppsmithActionConstants/ActionConstants"; import { WidgetType } from "constants/WidgetConstants"; export interface CreateActionRequest extends APIRequest { datasourceId: string; pageId: string; name: string; actionConfiguration: T; } export interface UpdateActionRequest extends CreateActionRequest { actionId: string; } export interface Property { key: string; value?: string; } export interface BodyFormData { editable: boolean; mandatory: boolean; description: string; key: string; value?: string; type: string; } export interface QueryConfig { queryString: string; } export interface ActionCreateUpdateResponse extends ApiResponse { id: string; jsonPathKeys: Record; } export type PaginationField = "PREV" | "NEXT"; export interface ExecuteActionRequest extends APIRequest { actionId: string; params?: Property[]; paginationField?: PaginationField; viewMode: boolean; } export interface ExecuteActionResponse extends ApiResponse { actionId: string; data: any; } export interface ActionApiResponseReq { headers: Record; body: Record | null; httpMethod: HttpMethod | ""; url: string; } export interface ActionExecutionResponse { responseMeta: ResponseMeta; data: { body: Record | string; headers: Record; statusCode: string; isExecutionSuccess: boolean; request: ActionApiResponseReq; errorType?: string; dataTypes: any[]; }; clientMeta: { duration: string; size: string; }; } export interface SuggestedWidget { type: WidgetType; bindingQuery: string; } export interface ActionResponse { body: unknown; headers: Record; request?: ActionApiResponseReq; statusCode: string; dataTypes: Record[]; duration: string; size: string; isExecutionSuccess?: boolean; suggestedWidgets?: SuggestedWidget[]; messages?: Array; errorType?: string; readableError?: string; responseDisplayFormat?: string; } export interface MoveActionRequest { action: Action; destinationPageId: string; } export interface CopyActionRequest { action: Action; pageId: string; } export interface UpdateActionNameRequest { pageId: string; actionId: string; layoutId: string; newName: string; oldName: string; } class ActionAPI extends API { static url = "v1/actions"; static apiUpdateCancelTokenSource: CancelTokenSource; static queryUpdateCancelTokenSource: CancelTokenSource; static createAction( apiConfig: Partial, ): AxiosPromise { return API.post(ActionAPI.url, apiConfig); } static fetchActions( applicationId: string, ): AxiosPromise> { return API.get(ActionAPI.url, { applicationId }); } static fetchActionsForViewMode( applicationId: string, ): AxiosPromise> { return API.get(`${ActionAPI.url}/view`, { applicationId }); } static fetchActionsByPageId( pageId: string, ): AxiosPromise> { return API.get(ActionAPI.url, { pageId }); } static updateAction( apiConfig: Partial, ): AxiosPromise { if (ActionAPI.apiUpdateCancelTokenSource) { ActionAPI.apiUpdateCancelTokenSource.cancel(); } ActionAPI.apiUpdateCancelTokenSource = axios.CancelToken.source(); const action = Object.assign({}, apiConfig); // While this line is not required, name can not be changed from this endpoint delete action.name; return API.put(`${ActionAPI.url}/${action.id}`, action, undefined, { cancelToken: ActionAPI.apiUpdateCancelTokenSource.token, }); } static updateActionName(updateActionNameRequest: UpdateActionNameRequest) { return API.put(ActionAPI.url + "/refactor", updateActionNameRequest); } static deleteAction(id: string) { return API.delete(`${ActionAPI.url}/${id}`); } static executeAction( executeAction: FormData, timeout?: number, ): AxiosPromise { return API.post(ActionAPI.url + "/execute", executeAction, undefined, { timeout: timeout || DEFAULT_EXECUTE_ACTION_TIMEOUT_MS, headers: { accept: "application/json", "Content-Type": "multipart/form-data", }, }); } static moveAction(moveRequest: MoveActionRequest) { return API.put(ActionAPI.url + "/move", moveRequest, undefined, { timeout: DEFAULT_EXECUTE_ACTION_TIMEOUT_MS, }); } static toggleActionExecuteOnLoad(actionId: string, shouldExecute: boolean) { return API.put(ActionAPI.url + `/executeOnLoad/${actionId}`, undefined, { flag: shouldExecute.toString(), }); } } export default ActionAPI;