PromucFlow_constructor/app/client/src/api/PageApi.tsx
akash-codemonk dbfd986d0e
Add action settings tab to api and query pane (#434)
* Add action settings tab to api and query pane

- Ask for confirmation before running an action

* Update  property of actions basedon the updateLayout response

Prevent confirmation dialog for Action run, until  property of action is true

Send an API Request when the user toggles the  property of an Action

* update http method to toggle executeOnLoad for an action to PUT

* Fix save layout response type

* Remove console.log

* If updating executeOnLoad, avoid calling update action API

Co-authored-by: Abhinav Jha <abhinav@appsmith.com>
2020-08-27 21:09:16 +05:30

173 lines
4.0 KiB
TypeScript

import Api from "./Api";
import { ContainerWidgetProps } from "widgets/ContainerWidget";
import { ApiResponse } from "./ApiResponses";
import { WidgetProps } from "widgets/BaseWidget";
import { AxiosPromise } from "axios";
import { PageAction } from "constants/ActionConstants";
export interface FetchPageRequest {
id: string;
}
export interface FetchPublishedPageRequest {
pageId: string;
bustCache?: boolean;
}
export interface SavePageRequest {
dsl: ContainerWidgetProps<WidgetProps>;
layoutId: string;
pageId: string;
}
export interface PageLayout {
id: string;
dsl: Partial<ContainerWidgetProps<any>>;
layoutOnLoadActions: PageAction[][];
layoutActions: PageAction[];
}
export type FetchPageResponse = ApiResponse & {
data: {
id: string;
name: string;
applicationId: string;
layouts: Array<PageLayout>;
};
};
export type FetchPublishedPageResponse = ApiResponse & {
data: {
id: string;
dsl: Partial<ContainerWidgetProps<any>>;
pageId: string;
};
};
export interface SavePageResponse extends ApiResponse {
data: {
id: string;
layoutOnLoadActions: PageAction[][];
dsl: Partial<ContainerWidgetProps<any>>;
};
}
export interface CreatePageRequest {
applicationId: string;
name: string;
}
export interface UpdatePageRequest {
id: string;
name: string;
}
export interface CreatePageResponse extends ApiResponse {
data: {};
}
export interface FetchPageListResponse extends ApiResponse {
data: {
pages: Array<{
id: string;
name: string;
isDefault: boolean;
layouts: Array<PageLayout>;
}>;
organizationId: string;
};
}
export interface DeletePageRequest {
id: string;
}
export interface ClonePageRequest {
id: string;
}
export interface UpdateWidgetNameRequest {
pageId: string;
layoutId: string;
newName: string;
oldName: string;
}
export interface UpdateWidgetNameResponse extends ApiResponse {
data: PageLayout;
}
class PageApi extends Api {
static url = "v1/pages";
static refactorLayoutURL = "v1/layouts/refactor";
static getLayoutUpdateURL = (pageId: string, layoutId: string) => {
return `v1/layouts/${layoutId}/pages/${pageId}`;
};
static getPublishedPageURL = (pageId: string, bustCache?: boolean) => {
const url = `v1/pages/${pageId}/view`;
return !!bustCache ? url + "?v=" + +new Date() : url;
};
static updatePageUrl = (pageId: string) => `${PageApi.url}/${pageId}`;
static fetchPage(
pageRequest: FetchPageRequest,
): AxiosPromise<FetchPageResponse> {
return Api.get(PageApi.url + "/" + pageRequest.id);
}
static savePage(
savePageRequest: SavePageRequest,
): AxiosPromise<SavePageResponse> {
const body = { dsl: savePageRequest.dsl };
return Api.put(
PageApi.getLayoutUpdateURL(
savePageRequest.pageId,
savePageRequest.layoutId,
),
body,
);
}
static fetchPublishedPage(
pageRequest: FetchPublishedPageRequest,
): AxiosPromise<FetchPublishedPageResponse> {
return Api.get(
PageApi.getPublishedPageURL(pageRequest.pageId, pageRequest.bustCache),
);
}
static createPage(
createPageRequest: CreatePageRequest,
): AxiosPromise<FetchPageResponse> {
return Api.post(PageApi.url, createPageRequest);
}
static updatePage(request: UpdatePageRequest): AxiosPromise<ApiResponse> {
return Api.put(PageApi.updatePageUrl(request.id), request);
}
static fetchPageList(
applicationId: string,
): AxiosPromise<FetchPageListResponse> {
return Api.get(PageApi.url + "/application/" + applicationId);
}
static deletePage(request: DeletePageRequest): AxiosPromise<ApiResponse> {
return Api.delete(PageApi.url + "/" + request.id);
}
static clonePage(request: ClonePageRequest): AxiosPromise<ApiResponse> {
return Api.post(PageApi.url + "/clone/" + request.id);
}
static updateWidgetName(
request: UpdateWidgetNameRequest,
): AxiosPromise<UpdateWidgetNameResponse> {
return Api.put(PageApi.refactorLayoutURL, request);
}
}
export default PageApi;