PromucFlow_constructor/app/client/src/api/ActionAPI.tsx

226 lines
5.3 KiB
TypeScript
Raw Normal View History

import API, { HttpMethod } from "./Api";
import { ApiResponse, GenericApiResponse, ResponseMeta } from "./ApiResponses";
2020-05-07 08:07:29 +00:00
import {
APIRequest,
DEFAULT_EXECUTE_ACTION_TIMEOUT_MS,
} from "constants/ApiConstants";
import { AxiosPromise } from "axios";
2019-11-12 09:43:13 +00:00
import { Datasource } from "./DatasourcesApi";
2020-02-07 02:32:52 +00:00
import { PaginationType } from "pages/Editor/APIEditor/Pagination";
2019-09-12 11:44:18 +00:00
export interface CreateActionRequest<T> extends APIRequest {
2019-11-07 09:32:38 +00:00
datasourceId: string;
2019-10-21 15:12:45 +00:00
pageId: string;
name: string;
2019-09-16 10:37:38 +00:00
actionConfiguration: T;
2019-09-12 11:44:18 +00:00
}
export interface UpdateActionRequest<T> extends CreateActionRequest<T> {
2019-09-16 10:37:38 +00:00
actionId: string;
2019-09-12 11:44:18 +00:00
}
export interface APIConfig {
2019-11-07 09:32:38 +00:00
datasourceId: string;
2019-10-21 15:12:45 +00:00
pageId: string;
name: string;
2019-09-16 10:37:38 +00:00
requestHeaders: Record<string, string>;
2019-10-21 15:12:45 +00:00
httpMethod: HttpMethod;
2019-09-16 10:37:38 +00:00
path: string;
body: JSON;
queryParams: Record<string, string>;
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 APIConfigRequest {
headers: Property[];
2019-10-21 15:12:45 +00:00
httpMethod: string;
path: string;
body: JSON | string | Record<string, any> | null;
queryParameters: Property[];
2020-02-07 02:32:52 +00:00
paginationType: PaginationType;
bodyFormData: BodyFormData[];
2020-05-07 08:07:29 +00:00
timeoutInMillisecond: number;
2019-09-12 11:44:18 +00:00
}
export interface QueryConfig {
2019-09-16 10:37:38 +00:00
queryString: string;
2019-09-12 11:44:18 +00:00
}
2019-09-16 10:37:38 +00:00
export interface ActionCreateUpdateResponse extends ApiResponse {
2019-10-21 15:12:45 +00:00
id: string;
jsonPathKeys: Record<string, string>;
}
export interface RestAction {
id: string;
name: string;
datasource:
| Pick<Datasource, "id">
| Omit<Datasource, "id">
| Partial<Datasource>;
2019-12-23 12:12:58 +00:00
pluginType?: string;
2020-01-24 09:54:40 +00:00
pageId: string;
2019-10-22 14:54:23 +00:00
actionConfiguration: Partial<APIConfigRequest>;
2019-11-20 10:57:05 +00:00
jsonPathKeys: string[];
cacheResponse?: string;
pluginId: string;
}
export interface RapidApiAction {
id: string;
name: string;
datasource: Pick<Datasource, "id"> | Omit<Datasource, "id">;
pluginType: string;
pageId: string;
actionConfiguration: Partial<APIConfigRequest>;
jsonPathKeys: string[];
cacheResponse?: string;
templateId: string;
proverId: string;
provider: ProviderInfo;
pluginId: string;
documentation: { text: string };
}
export interface ProviderInfo {
name: string;
imageUrl: string;
url: string;
description: string;
credentialSteps: string;
2019-09-12 11:44:18 +00:00
}
2020-03-12 20:27:39 +00:00
export type PaginationField = "PREV" | "NEXT";
2020-02-07 02:32:52 +00:00
2019-09-12 13:44:25 +00:00
export interface ExecuteActionRequest extends APIRequest {
2019-11-12 09:43:13 +00:00
action: Pick<RestAction, "id"> | Omit<RestAction, "id">;
2019-11-01 07:11:32 +00:00
params?: Property[];
2020-03-12 20:27:39 +00:00
paginationField?: PaginationField;
2019-09-12 13:44:25 +00:00
}
export interface ExecuteQueryRequest extends APIRequest {
action: Pick<RestAction, "id"> | Omit<RestAction, "id">;
}
2019-09-12 13:44:25 +00:00
export interface ExecuteActionResponse extends ApiResponse {
2019-09-16 10:37:38 +00:00
actionId: string;
data: any;
2019-09-12 13:44:25 +00:00
}
export interface ActionApiResponse {
2019-11-12 09:43:13 +00:00
responseMeta: ResponseMeta;
data: {
body: object;
headers: Record<string, string[]>;
2020-03-12 20:27:39 +00:00
statusCode: string;
isExecutionSuccess: boolean;
requestHeaders: Record<string, string[]>;
requestBody: object | null;
2019-11-12 09:43:13 +00:00
};
clientMeta: {
duration: string;
size: string;
};
}
export interface ActionResponse {
body: object;
headers: Record<string, string[]>;
requestBody: object | null;
requestHeaders: Record<string, string[]>;
2020-03-12 20:27:39 +00:00
statusCode: string;
duration: string;
size: string;
}
2020-01-24 09:54:40 +00:00
export interface MoveActionRequest {
action: RestAction;
destinationPageId: string;
}
export interface CopyActionRequest {
action: RestAction;
pageId: string;
}
class ActionAPI extends API {
static url = "v1/actions";
2019-09-12 11:44:18 +00:00
static fetchAPI(id: string): AxiosPromise<GenericApiResponse<RestAction>> {
2019-10-21 15:12:45 +00:00
return API.get(`${ActionAPI.url}/${id}`);
}
static createAPI(
apiConfig: RestAction,
): AxiosPromise<ActionCreateUpdateResponse> {
2019-10-21 15:12:45 +00:00
return API.post(ActionAPI.url, apiConfig);
}
static fetchActions(
2020-01-24 09:54:40 +00:00
applicationId: string,
): AxiosPromise<GenericApiResponse<RestAction[]>> {
2020-01-24 09:54:40 +00:00
return API.get(ActionAPI.url, { applicationId });
2019-10-21 15:12:45 +00:00
}
2020-02-21 12:16:49 +00:00
static fetchActionsByPageId(
pageId: string,
): AxiosPromise<GenericApiResponse<RestAction[]>> {
return API.get(ActionAPI.url, { pageId });
}
2019-10-21 15:12:45 +00:00
static updateAPI(
apiConfig: Partial<RestAction>,
): AxiosPromise<ActionCreateUpdateResponse> {
2019-12-16 08:49:10 +00:00
return API.put(`${ActionAPI.url}/${apiConfig.id}`, apiConfig);
2019-09-12 11:44:18 +00:00
}
2019-10-21 15:12:45 +00:00
static deleteAction(id: string) {
return API.delete(`${ActionAPI.url}/${id}`);
2019-09-12 11:44:18 +00:00
}
2019-09-16 10:37:38 +00:00
static createQuery(
createQuery: CreateActionRequest<QueryConfig>,
): AxiosPromise<ActionCreateUpdateResponse> {
return API.post(ActionAPI.url, createQuery);
2019-09-12 11:44:18 +00:00
}
2019-09-16 10:37:38 +00:00
static updateQuery(
updateQuery: UpdateActionRequest<QueryConfig>,
): AxiosPromise<ActionCreateUpdateResponse> {
return API.post(ActionAPI.url, updateQuery);
2019-09-12 13:44:25 +00:00
}
2019-09-16 10:37:38 +00:00
static executeAction(
executeAction: ExecuteActionRequest,
2020-05-07 08:07:29 +00:00
timeout?: number,
): AxiosPromise<ActionApiResponse> {
2020-05-05 08:13:39 +00:00
return API.post(ActionAPI.url + "/execute", executeAction, undefined, {
2020-05-07 08:07:29 +00:00
timeout: timeout || DEFAULT_EXECUTE_ACTION_TIMEOUT_MS,
2020-05-05 08:13:39 +00:00
});
2019-09-16 10:37:38 +00:00
}
2020-01-24 09:54:40 +00:00
static moveAction(moveRequest: MoveActionRequest) {
return API.put(ActionAPI.url + "/move", moveRequest);
}
static executeQuery(executeAction: any): AxiosPromise<ActionApiResponse> {
return API.post(ActionAPI.url + "/execute", executeAction);
}
2019-09-12 12:19:46 +00:00
}
2019-09-12 11:44:18 +00:00
2019-09-16 10:37:38 +00:00
export default ActionAPI;