PromucFlow_constructor/app/client/src/entities/DataTree/dataTreeFactory.ts
Hetu Nandu 39b0a4e5a6
feat: Native promises support in Appsmith (#8988)
Co-authored-by: Apeksha Bhosale <7846888+ApekshaBhosale@users.noreply.github.com>
2021-12-23 14:17:20 +00:00

157 lines
4.7 KiB
TypeScript

import {
ActionDataState,
ActionDataWithMeta,
} from "reducers/entityReducers/actionsReducer";
import { WidgetProps } from "widgets/BaseWidget";
import { ActionResponse } from "api/ActionAPI";
import { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
import { MetaState } from "reducers/entityReducers/metaReducer";
import { PageListPayload } from "constants/ReduxActionConstants";
import { ActionConfig, PluginType } from "entities/Action";
import { AppDataState } from "reducers/entityReducers/appReducer";
import { DependencyMap, DynamicPath } from "utils/DynamicBindingUtils";
import { generateDataTreeAction } from "entities/DataTree/dataTreeAction";
import { generateDataTreeJSAction } from "entities/DataTree/dataTreeJSAction";
import { generateDataTreeWidget } from "entities/DataTree/dataTreeWidget";
import { JSCollectionDataState } from "reducers/entityReducers/jsActionsReducer";
import { ValidationConfig } from "constants/PropertyControlConstants";
import { Variable } from "entities/JSCollection";
import {
ActionDescription,
ClearPluginActionDescription,
RunPluginActionDescription,
} from "entities/DataTree/actionTriggers";
export type ActionDispatcher = (
...args: any[]
) => Promise<unknown> | ActionDescription;
export enum ENTITY_TYPE {
ACTION = "ACTION",
WIDGET = "WIDGET",
APPSMITH = "APPSMITH",
JSACTION = "JSACTION",
}
export enum EvaluationSubstitutionType {
TEMPLATE = "TEMPLATE",
PARAMETER = "PARAMETER",
SMART_SUBSTITUTE = "SMART_SUBSTITUTE",
}
export interface DataTreeAction
extends Omit<ActionDataWithMeta, "data" | "config"> {
data: ActionResponse["body"];
actionId: string;
config: Partial<ActionConfig>;
pluginType: PluginType;
name: string;
run: ActionDispatcher | RunPluginActionDescription | Record<string, unknown>;
clear:
| ActionDispatcher
| ClearPluginActionDescription
| Record<string, unknown>;
dynamicBindingPathList: DynamicPath[];
bindingPaths: Record<string, EvaluationSubstitutionType>;
ENTITY_TYPE: ENTITY_TYPE.ACTION;
dependencyMap: DependencyMap;
logBlackList: Record<string, true>;
}
export interface DataTreeJSAction {
pluginType: PluginType.JS;
name: string;
ENTITY_TYPE: ENTITY_TYPE.JSACTION;
body: string;
[propName: string]: any;
meta: Record<string, MetaArgs>;
dynamicBindingPathList: DynamicPath[];
bindingPaths: Record<string, EvaluationSubstitutionType>;
variables: Array<string>;
dependencyMap: DependencyMap;
}
export interface MetaArgs {
arguments: Variable[];
}
export interface DataTreeWidget extends WidgetProps {
bindingPaths: Record<string, EvaluationSubstitutionType>;
triggerPaths: Record<string, boolean>;
validationPaths: Record<string, ValidationConfig>;
ENTITY_TYPE: ENTITY_TYPE.WIDGET;
logBlackList: Record<string, true>;
}
export interface DataTreeAppsmith extends Omit<AppDataState, "store"> {
ENTITY_TYPE: ENTITY_TYPE.APPSMITH;
store: Record<string, unknown>;
}
export type DataTreeObjectEntity =
| DataTreeAction
| DataTreeJSAction
| DataTreeWidget
| DataTreeAppsmith;
export type DataTreeEntity =
| DataTreeObjectEntity
| PageListPayload
| ActionDispatcher;
export type DataTree = {
[entityName: string]: DataTreeEntity;
};
type DataTreeSeed = {
actions: ActionDataState;
editorConfigs: Record<string, any[]>;
pluginDependencyConfig: Record<string, DependencyMap>;
widgets: CanvasWidgetsReduxState;
widgetsMeta: MetaState;
pageList: PageListPayload;
appData: AppDataState;
jsActions: JSCollectionDataState;
};
export class DataTreeFactory {
static create({
actions,
appData,
editorConfigs,
jsActions,
pageList,
pluginDependencyConfig,
widgets,
widgetsMeta,
}: DataTreeSeed): DataTree {
const dataTree: DataTree = {};
actions.forEach((action) => {
const editorConfig = editorConfigs[action.config.pluginId];
const dependencyConfig = pluginDependencyConfig[action.config.pluginId];
dataTree[action.config.name] = generateDataTreeAction(
action,
editorConfig,
dependencyConfig,
);
});
jsActions.forEach((js) => {
dataTree[js.config.name] = generateDataTreeJSAction(js);
});
Object.values(widgets).forEach((widget) => {
dataTree[widget.widgetName] = generateDataTreeWidget(
widget,
widgetsMeta[widget.widgetId],
);
});
dataTree.pageList = pageList;
dataTree.appsmith = {
...appData,
// combine both persistent and transient state with the transient state
// taking precedence in case the key is the same
store: { ...appData.store.persistent, ...appData.store.transient },
} as DataTreeAppsmith;
(dataTree.appsmith as DataTreeAppsmith).ENTITY_TYPE = ENTITY_TYPE.APPSMITH;
return dataTree;
}
}