@zohodesk/library-platform 1.1.10 → 1.1.12-exp.1

package/es/library/dot/legacy-to-new-arch/textbox/frameworks/ui/TextBoxView.js

@@ -1,7 +1,8 @@
 import React from "react";
-import ActionEventMediator from "../../../../../../platform/client-actions/components/action-event-mediator/frameworks/ui/ActionEventMediator";
 import TextBox from "@zohodesk/components/es/TextBoxIcon/TextBoxIcon";
 import TextBoxConstants from "../../../../../../cc/textbox/Constants";
+import RowActionsRenderer from "../../../../../../platform/client-actions/components/row-actions-renderer/frameworks/ui/RowActions/RowActionsRenderer";
+import { ActionViewGap } from "../../../../../../platform/client-actions/components/interfaces/ActionViewModel";
 
 function TextBoxView(_ref, ref) {
   let {
@@ -21,12 +22,15 @@ function TextBoxView(_ref, ref) {
     required,
     disabled,
     readonly,
-    actions
+    actions,
+    clientScripts
   } = state.properties;
 
   const renderRightFieldActions = () => {
-    return actions?.length ? /*#__PURE__*/React.createElement(ActionEventMediator, {
-      actions: actions
+    return actions?.length ? /*#__PURE__*/React.createElement(RowActionsRenderer, {
+      actions: actions,
+      clientScripts: clientScripts,
+      gap: ActionViewGap.SMALL
     }) : null;
   };
 

package/es/platform/app-context-behaviour/frameworks/AppContextBehaviourFactory.js

@@ -0,0 +1,31 @@
+import AppContextProperties from "../../../bc/app-context/Properties";
+import { platformSDK } from "../../sdk/frameworks/Sdk";
+import ResourceNamesEnum from "../../../bc/sdk/ResourceNamesEnum";
+
+class AppContextBehaviourFactory {
+  static create() {
+    return {
+      name: 'appContext',
+      setInitialState: _ref => {
+        let {
+          properties: {
+            context
+          }
+        } = _ref;
+        const appResource = platformSDK[ResourceNamesEnum.APP];
+        return {
+          headers: appResource && appResource.getApiHeader(),
+          context: { ...(appResource && appResource.getContext()),
+            ...context
+          }
+        };
+      },
+      // eventHandlers: EventHandlerFactory.create(),
+      eventHandlers: {},
+      properties: AppContextProperties
+    };
+  }
+
+}
+
+export default AppContextBehaviourFactory;

package/es/platform/client-actions/behaviour/zclient-actions/applications/usecases/SetClientActionsUseCase.js

@@ -10,9 +10,14 @@ class SetClientActionsUseCase extends AbstractUseCase {
     const {
       clientActions
     } = input;
+
+    if (!clientActions) {
+      return;
+    }
+
     const recordManager = repository.getClientActionsManagerEntity();
     const recordsEntity = ClientActionFactory.createMultipleClientActions(clientActions);
-    recordManager.setClientActions(recordsEntity);
+    recordManager.setData(recordsEntity);
     presenter.updateClientAction(recordManager.toObject());
   }
 

package/es/platform/client-actions/behaviour/zclient-actions/domain/entities/ClientActionManager.js

@@ -2,12 +2,15 @@ import { DATA_SOURCE_FAILURE, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_SUCCESS } from
 import { DATA_SOURCE_EXECUTE } from "../../../../../../bc/zdata-source/Constants";
 import { CLIENTACTION_EXECUTE_FAIL_CALLBACK, CLIENTACTION_EXECUTE_SUCCESS_CALLBACK, CLIENTACTION_EXECUTE_SUCCESS_NO_CONTENT_CALLBACK, ClientActionApiActionName } from "../../../../bc/zclient-actions/Constants";
 import GetClientActionsStrategy from "./GetClientActionsStrategy";
+import { CLIENTSCRIPT_FETCH_FAILURE_CALLBACK, CLIENTSCRIPT_FETCH_SUCCESS_CALLBACK, CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT_CALLBACK, ClientScriptAPIs } from "../../../../../client-scripts/bc/zclient-scripts-fetch/Constants";
+import GetClientScriptsStrategy from "../../../../../client-scripts/behaviour/zclient-scripts-fetch/domain/entities/GetClientScriptsStrategy";
 const clientActionExecuteStrategiesMap = {
-  [ClientActionApiActionName.GET_CLIENTACTIONS]: new GetClientActionsStrategy()
+  [ClientActionApiActionName.GET_CLIENTACTIONS]: new GetClientActionsStrategy(),
+  [ClientScriptAPIs.GET_CLIENTSCRIPTS]: new GetClientScriptsStrategy()
 };
 export default class ClientActionManager {
-  constructor(clientActions) {
-    this.clientActions = clientActions;
+  constructor(clientActionResponse) {
+    this.clientActionResponse = clientActionResponse;
   }
 
   createDataSourceMeta(_ref) {
@@ -67,6 +70,37 @@ export default class ClientActionManager {
     });
   }
 
+  createFetchClientScriptMeta(actionName, apiName, props) {
+    const clientActionExecuteStrategyMeta = {
+      actionName,
+      apiName,
+      props
+    };
+
+    if (this.isGetClientScriptsApi(actionName)) {
+      clientActionExecuteStrategyMeta.props.from = 1;
+    }
+
+    const successMeta = {
+      type: CLIENTSCRIPT_FETCH_SUCCESS_CALLBACK,
+      metaData: clientActionExecuteStrategyMeta
+    };
+    const successNoContentMeta = {
+      type: CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT_CALLBACK,
+      metaData: clientActionExecuteStrategyMeta
+    };
+    const failureMeta = {
+      type: CLIENTSCRIPT_FETCH_FAILURE_CALLBACK,
+      metaData: clientActionExecuteStrategyMeta
+    };
+    return this.createDataSourceMeta({
+      actionName,
+      successNoContentMeta,
+      failureMeta,
+      successMeta
+    });
+  }
+
   createSuccessEvents(response, metaData) {
     const {
       actionName
@@ -107,20 +141,25 @@ export default class ClientActionManager {
   }
 
   fetchingStarted() {
-    this.clientActions.setIsFetching(true);
+    this.clientActionResponse.setIsFetching(true);
   }
 
   fetchingFinished() {
-    this.clientActions.setIsFetching(false);
+    this.clientActionResponse.setIsFetching(false);
+  }
+
+  setData(data) {
+    this.clientActionResponse.setData(data);
   }
 
   getClientAction(id) {
-    return this.clientActions.getClientAction(id);
+    const clientActions = this.clientActionResponse;
+    return clientActions.getClientAction(id);
   }
 
   getClientActionModels() {
-    const clientActionModels = this.clientActions.toObject();
-    return clientActionModels.data;
+    const clientActionModels = this.clientActionResponse.toObject();
+    return clientActionModels.clientActions;
   }
 
   updateClientActionComponentProperties(id, newComponentProperties) {
@@ -140,16 +179,16 @@ export default class ClientActionManager {
     };
   }
 
-  setClientActions(clientActions) {
-    this.clientActions.setClientActions(clientActions);
-  }
-
   isGetClientActionsApi(actionName) {
     return ClientActionApiActionName.GET_CLIENTACTIONS === actionName;
   }
 
-  isClientActionsFetching() {
-    return this.clientActions.isClientActionsFetching();
+  isGetClientScriptsApi(actionName) {
+    return ClientScriptAPIs.GET_CLIENTSCRIPTS === actionName;
+  }
+
+  isFetching() {
+    return this.clientActionResponse.isFetching();
   }
 
   isClientActionApiName(apiName) {
@@ -175,12 +214,12 @@ export default class ClientActionManager {
     }
   }
 
+  isClientScriptApiName(apiName) {
+    return apiName === 'clientScripts';
+  }
+
   toObject() {
-    const clientActionsObj = this.clientActions.toObject();
-    return {
-      clientActions: clientActionsObj.data,
-      isFetching: clientActionsObj.isFetching
-    };
+    return this.clientActionResponse.toObject();
   }
 
 }

package/es/platform/client-actions/behaviour/zclient-actions/domain/entities/ClientActions.js

@@ -8,22 +8,22 @@ export default class ClientActions {
     let fetchLimit = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 100;
     this.clientActions = data.map(obj => new ClientAction(obj));
     this.fetchLimit = fetchLimit;
-    this.isFetching = isFetching;
+    this.isDataBeingFetched = isFetching;
   }
 
   setIsFetching(isFetching) {
-    this.isFetching = isFetching;
+    this.isDataBeingFetched = isFetching;
   }
 
-  setClientActions(clientActions) {
+  setData(clientActions) {
     this.clientActions = clientActions;
   }
 
-  isClientActionsFetching() {
-    return this.isFetching;
+  isFetching() {
+    return this.isDataBeingFetched;
   }
 
-  getClientActionsLength() {
+  getLength() {
     return this.clientActions.length;
   }
 
@@ -33,8 +33,8 @@ export default class ClientActions {
 
   toObject() {
     return {
-      data: this.clientActions.map(action => action.toObject()),
-      isFetching: this.isFetching
+      clientActions: this.clientActions.map(action => action.toObject()),
+      isFetching: this.isFetching()
     };
   }
 

package/es/platform/client-actions/behaviour/zclient-actions/domain/entities/interfaces/ClientActionResponse.js

@@ -0,0 +1 @@
+export {};

package/es/platform/client-actions/cc/action-event-mediator/Properties.js

@@ -1,9 +1,75 @@
 import { ActionViewGap } from "../../components/interfaces/ActionViewModel";
-import { actionSchema } from "../dynamic-action-component/Properties";
+import { clientScriptsSchema } from "../../../client-scripts/cc/zclient-scripts-execution/clientScriptsSchema";
+export const actionSchema = {
+  type: 'object',
+  properties: {
+    component: {
+      type: 'string'
+    },
+    id: {
+      type: 'string'
+    },
+    properties: {
+      type: 'object'
+    },
+    eventMappings: {
+      type: 'array',
+      minItems: 0,
+      items: {
+        type: 'object',
+        properties: {
+          action: {
+            type: 'object',
+            properties: {
+              event: {
+                type: 'string'
+              },
+              payload: {
+                type: 'object'
+              }
+            },
+            required: ['event', 'payload']
+          },
+          id: {
+            type: 'string'
+          },
+          sourceEvent: {
+            type: 'string'
+          }
+        },
+        required: ['id']
+      }
+    }
+  },
+  required: ['component', 'properties']
+};
 export const actionsSchema = {
   type: 'array',
-  minItems: 0,
-  items: actionSchema
+  minItems: 0
+};
+export const ActionEventMediatorProperties = {
+  action: {
+    required: true,
+    typeMetadata: {
+      schema: actionSchema
+    }
+  },
+  clientScripts: {
+    required: false,
+    defaultValue: [],
+    typeMetadata: {
+      schema: clientScriptsSchema
+    }
+  },
+  instanceName: {
+    required: false,
+    defaultValue: 'non-module',
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  }
 };
 export default {
   testId: {
@@ -21,6 +87,12 @@ export default {
       schema: actionsSchema
     }
   },
+  clientScripts: {
+    required: false,
+    typeMetadata: {
+      schema: clientScriptsSchema
+    }
+  },
   renderComponentType: {
     required: false,
     typeMetadata: {

package/es/platform/client-actions/components/action-event-mediator/adapters/controllers/MountController.js

@@ -12,7 +12,7 @@ export default class MountController {
       updateState
     } = input;
     this.initializeUseCase.updateDependencies(host, state, dispatch, updateState);
-    this.initializeUseCase.execute();
+    this.initializeUseCase.execute(input);
   }
 
 }

package/es/platform/client-actions/components/action-event-mediator/adapters/controllers/PropertiesChangeController.js

@@ -18,8 +18,8 @@ export default class PropertiesChangeController {
     } = action.payload;
     this.propertiesChangeUseCase.updateDependencies(host, state, dispatch, updateState);
     this.propertiesChangeUseCase.execute({
-      currentActions: currentProperties.actions,
-      previousActions: previousProperties.actions
+      currentAction: currentProperties.action,
+      previousAction: previousProperties.action
     });
   }
 

package/es/platform/client-actions/components/action-event-mediator/adapters/gateway/Repository.js

@@ -16,12 +16,12 @@ export default class Repository {
 
   getActionEventMediator() {
     const {
-      actions
+      action
     } = this.state.properties;
     const {
       handlers
     } = this.state;
-    const actionEventMediator = new ActionEventMediatorEntity(handlers, actions, this.element, this.dispatch);
+    const actionEventMediator = new ActionEventMediatorEntity(handlers, action, this.element, this.dispatch);
     return actionEventMediator;
   }
 

package/es/platform/client-actions/components/action-event-mediator/applications/usecases/InitializeUseCase.js

@@ -1,12 +1,26 @@
 import { AbstractUseCase } from "./AbstractUseCase";
+import { SET_CLIENT_SCRIPTS } from "../../../../../client-scripts/bc/zclient-scripts-execution/Constants";
 export default class InitializeUseCase extends AbstractUseCase {
-  execute() {
+  execute(input) {
     const {
       repository,
       presenter
     } = this.dependencies;
+    const {
+      dispatch,
+      state
+    } = input;
+    const {
+      clientScripts
+    } = state.properties;
     const actionLocation = repository.getActionEventMediator();
     actionLocation.initialize();
+    dispatch({
+      type: SET_CLIENT_SCRIPTS,
+      payload: {
+        clientScripts
+      }
+    });
     presenter.updateActionEventMediator(actionLocation.toObject());
   }
 

package/es/platform/client-actions/components/action-event-mediator/applications/usecases/PropertiesChangeUseCase.js

@@ -7,10 +7,10 @@ export default class PropertiesChangeUseCase extends AbstractUseCase {
     } = this.dependencies;
     const actionLocation = repository.getActionEventMediator();
     const {
-      currentActions,
-      previousActions
+      currentAction,
+      previousAction
     } = input;
-    actionLocation.processActionsChange(previousActions, currentActions);
+    actionLocation.processActionsChange(previousAction, currentAction);
     presenter.updateActionEventMediator(actionLocation.toObject());
   }
 

package/es/platform/client-actions/components/action-event-mediator/domain/entities/ActionEventMediatorEntity.js

@@ -1,8 +1,9 @@
 import TemplateResolver from "../../../../template-resolver";
+import { EXECUTE_CLIENT_SCRIPTS } from "../../../../../client-scripts/bc/zclient-scripts-execution/Constants";
 export default class ActionEventMediatorEntity {
-  constructor(handlers, actions, element, dispatch) {
+  constructor(handlers, action, element, dispatch) {
     this.handlers = handlers;
-    this.actions = actions;
+    this.action = action;
     this.element = element;
     this.dispatch = dispatch;
   }
@@ -15,21 +16,32 @@ export default class ActionEventMediatorEntity {
         actionId,
         ...payloadItems
       } = e.detail.payload;
-      const eventMapping = eventMappings.find(eventMapping => eventMapping.sourceEvent === event);
+      const targetEventMappings = eventMappings.filter(eventMapping => eventMapping.sourceEvent === event);
 
-      if (!eventMapping) {
+      if (!targetEventMappings || targetEventMappings.length === 0) {
         return;
       }
 
-      const dispatchEvent = eventMapping.targetEvent;
-      const eventMappingPayload = eventMapping.payload;
-      const replacementContext = {
-        "@payload": payloadItems
-      };
-      const resolvedPayload = TemplateResolver.replaceContextVariablesInObject(eventMappingPayload, replacementContext);
+      const eventsContext = [];
+      targetEventMappings.forEach(eventMapping => {
+        const {
+          targetEvent,
+          payload
+        } = eventMapping;
+        const replacementContext = {
+          "@payload": payloadItems
+        };
+        const resolvedPayload = TemplateResolver.replaceContextVariablesInObject(payload, replacementContext);
+        eventsContext.push({
+          targetEvent,
+          resolvedPayload
+        });
+      });
       this.dispatch({
-        type: dispatchEvent,
-        payload: resolvedPayload,
+        type: EXECUTE_CLIENT_SCRIPTS,
+        payload: {
+          clientScriptsEventContext: eventsContext
+        },
         metaData: {
           clientActionId: actionId
         }
@@ -37,14 +49,19 @@ export default class ActionEventMediatorEntity {
     };
   }
 
-  getEventNames(actions) {
+  getEventNames(action) {
     const eventNames = [];
-    actions.forEach(action => {
-      action.eventMappings.forEach(eventMapping => {
-        if (!eventNames.includes(eventMapping.sourceEvent)) {
-          eventNames.push(eventMapping.sourceEvent);
-        }
-      });
+    const {
+      eventMappings
+    } = action;
+    eventMappings.forEach(eventMapping => {
+      const {
+        sourceEvent
+      } = eventMapping;
+
+      if (!eventNames.includes(sourceEvent)) {
+        eventNames.push(sourceEvent);
+      }
     });
     return eventNames;
   }
@@ -66,15 +83,15 @@ export default class ActionEventMediatorEntity {
   }
 
   initialize() {
-    const eventNames = this.getEventNames(this.actions);
+    const eventNames = this.getEventNames(this.action);
     eventNames.forEach(eventName => {
       this.listen(eventName);
     });
   }
 
-  processActionsChange(previousActions, currentActions) {
-    const previousEventNames = this.getEventNames(previousActions).sort();
-    const currentEventNames = this.getEventNames(currentActions).sort();
+  processActionsChange(previousAction, currentAction) {
+    const previousEventNames = this.getEventNames(previousAction).sort();
+    const currentEventNames = this.getEventNames(currentAction).sort();
 
     if (this.compareEventNames(previousEventNames, currentEventNames)) {
       return;
@@ -89,7 +106,7 @@ export default class ActionEventMediatorEntity {
   }
 
   destroy() {
-    const eventNames = this.getEventNames(this.actions);
+    const eventNames = this.getEventNames(this.action);
     eventNames.forEach(eventName => {
       this.unListen(eventName);
     });

package/es/platform/client-actions/components/action-event-mediator/frameworks/ui/ActionEventMediator.js

@@ -1,7 +1,8 @@
 import { createCustomComponent } from "../../../../../../library/custom-component";
-import ActionEventMediatorProperties from "../../../../cc/action-event-mediator/Properties";
+import { ActionEventMediatorProperties } from "../../../../cc/action-event-mediator/Properties";
 import EventHandlersFactory from "./EventHandlersFactory";
 import ActionEventMediatorView from "./ActionEventMediatorView";
+import ClientScriptsExecutionBehaviourFactory from "../../../../../client-scripts/behaviour/zclient-scripts-execution/frameworks/ClientScriptsExecutionBehaviourFactory";
 export default createCustomComponent({
   name: 'ActionEventMediator',
   properties: ActionEventMediatorProperties,
@@ -9,5 +10,6 @@ export default createCustomComponent({
     handlers: {}
   }),
   eventHandlers: EventHandlersFactory.create(),
+  behaviours: [ClientScriptsExecutionBehaviourFactory.create()],
   View: ActionEventMediatorView
 });

package/es/platform/client-actions/components/action-event-mediator/frameworks/ui/ActionEventMediatorView.js

@@ -1,21 +1,38 @@
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
 import React from 'react';
-import RowActionsRenderer from "../../../row-actions-renderer/frameworks/ui/RowActionsRenderer";
-import { ComponentRegistry } from "../../../../../../library";
-export default function ActionEventMediatorView(_ref, ref) {
+import ComponentRegistry from "../../../../../../library/custom-component/frameworks/ui/ComponentRegistry";
+import ActionComponentMapping from "../../../../../../library/dot/components/action-location/frameworks/ui/ActionComponentMapping";
+
+function ActionEventMediatorView(_ref, ref) {
   let {
     state
   } = _ref;
   const {
-    actions,
-    renderComponentType,
-    gap,
-    testId
+    action
   } = state.properties;
-  const ActionRenderComponent = ComponentRegistry.get(renderComponentType) || RowActionsRenderer;
-  return /*#__PURE__*/React.createElement(ActionRenderComponent, {
-    testId: testId,
-    actions: actions,
-    gap: gap,
+  const {
+    component,
+    properties,
+    eventMappings,
+    id: actionId
+  } = action;
+  const Component = ComponentRegistry.get(component) || ActionComponentMapping[component];
+
+  if (!Component) {
+    return /*#__PURE__*/React.createElement("div", {
+      ref: ref
+    }, "Error");
+  }
+
+  return /*#__PURE__*/React.createElement(Component, _extends({
     getRef: ref
-  });
-}
+  }, properties, {
+    appendToActionPayload: {
+      eventMappings,
+      actionId
+    }
+  }));
+}
+
+export default ActionEventMediatorView;

package/es/platform/client-actions/components/action-event-mediator/frameworks/ui/ClientActionReordererRegistry.js

@@ -0,0 +1,40 @@
+class ClientActionReordererRegistry {
+  static isLoggingEnabled = __DEVELOPMENT__;
+  reorderers = new Map();
+
+  constructor() {}
+
+  static getInstance() {
+    if (!ClientActionReordererRegistry.instance) {
+      ClientActionReordererRegistry.instance = new ClientActionReordererRegistry();
+    }
+
+    return ClientActionReordererRegistry.instance;
+  }
+
+  register(name, reordererFn) {
+    const reordererFnNameRegex = /^[A-Za-z0-9_-]+#[A-Z][a-zA-Z]*ActionsReorderer$/;
+    const isValidReordererFnName = reordererFnNameRegex.test(name);
+
+    if (!isValidReordererFnName && ClientActionReordererRegistry.isLoggingEnabled) {
+      console.warn(`${name} is not a valid client action reorderer function name.Reorderer function name should be of the format \"<instanceName>#<location>ActionsReorderer\"`);
+    }
+
+    if (this.reorderers.has(name) && ClientActionReordererRegistry.isLoggingEnabled) {
+      console.warn(`Client action reorderer function with name "${name}" is already registered. Overwriting the existing function.`);
+    }
+
+    if (this.reorderers.has(name) && this.get(name) !== reordererFn && ClientActionReordererRegistry.isLoggingEnabled) {
+      console.warn(`Client action reorderer function with name "${name}" is already registered with a different instance. Overwriting the existing function.`);
+    }
+
+    this.reorderers.set(name, reordererFn);
+  }
+
+  get(name) {
+    return this.reorderers.get(name);
+  }
+
+}
+
+export default ClientActionReordererRegistry.getInstance();