@zohodesk/library-platform 1.1.7 → 1.1.8-exp.1

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

@@ -1,4 +1,5 @@
 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";
 
@@ -19,8 +20,16 @@ function TextBoxView(_ref, ref) {
     value,
     required,
     disabled,
-    readonly
+    readonly,
+    actions
   } = state.properties;
+
+  const renderRightFieldActions = () => {
+    return actions !== null && actions !== void 0 && actions.length ? /*#__PURE__*/React.createElement(ActionEventMediator, {
+      actions: actions
+    }) : null;
+  };
+
   return /*#__PURE__*/React.createElement(TextBox, {
     inputRef: ref,
     htmlId: id,
@@ -40,7 +49,7 @@ function TextBoxView(_ref, ref) {
     }),
     customProps: {
       TextBoxProps: {
-        required
+        'aria-required': required
       }
     },
     onChange: value => dispatch({
@@ -48,7 +57,8 @@ function TextBoxView(_ref, ref) {
       payload: {
         value
       }
-    })
+    }),
+    renderRightPlaceholderNode: renderRightFieldActions()
   });
 }
 

package/es/platform/client-actions/bc/zclient-actions/SdkContract.js

@@ -0,0 +1,35 @@
+export const SdkContracts = {
+  getLocationMeta: {
+    type: 'object',
+    properties: {
+      clientActionId: {
+        type: 'string',
+        minLength: 1
+      }
+    },
+    required: ['clientActionId']
+  },
+  getComponentPropertiesMeta: {
+    type: 'object',
+    properties: {
+      clientActionId: {
+        type: 'string',
+        minLength: 1
+      }
+    },
+    required: ['clientActionId']
+  },
+  updateComponentPropertiesMeta: {
+    type: 'object',
+    properties: {
+      clientActionId: {
+        type: 'string',
+        minLength: 1
+      },
+      newComponentProperties: {
+        type: 'object'
+      }
+    },
+    required: ['clientActionId', 'newComponentProperties']
+  }
+};

package/es/platform/client-actions/behaviour/zclient-actions/adapters/resources/ClientActionResource.js

@@ -0,0 +1,105 @@
+import { AbstractResource } from "../../../../../sdk/application/interfaces/gateways/AbstractResource";
+import Repository from "../gateways/Repository";
+import Presenter from "../presenters/Presenter";
+import GetClientActionLocationUseCase from "../../applications/usecases/GetClientActionLocationUseCase";
+import GetClientActionUIComponentPropertiesUseCase from "../../applications/usecases/GetClientActionUIComponentPropertiesUseCase";
+import UpdateClientActionUIComponentPropertiesUseCase from "../../applications/usecases/UpdateClientActionUIComponentPropertiesUseCase";
+import GetClientActionsUseCase from "../../applications/usecases/GetClientActionsUseCase";
+import { SdkContracts } from "../../../../bc/zclient-actions/SdkContract";
+export class ClientActionResource extends AbstractResource {
+  initialize() {}
+
+  destroy() {}
+
+  getClientActionDependencies() {
+    const dependencies = {
+      repository: new Repository(),
+      presenter: new Presenter()
+    };
+    return dependencies;
+  }
+
+  createUseCase(dependencies, UseCaseClass) {
+    var _usecase$updateDepend, _usecase$updateDepend2;
+
+    const {
+      state,
+      updateState
+    } = this.dependencies;
+    const usecase = new UseCaseClass(dependencies);
+    (_usecase$updateDepend = usecase.updateDependency) === null || _usecase$updateDepend === void 0 ? void 0 : _usecase$updateDepend.call(usecase, state, updateState);
+    (_usecase$updateDepend2 = usecase.updateDependencies) === null || _usecase$updateDepend2 === void 0 ? void 0 : _usecase$updateDepend2.call(usecase, state, updateState);
+    return usecase;
+  }
+
+  getLocation(id) {
+    this.validateInput('getLocation', {
+      clientActionId: id
+    }, SdkContracts.getLocationMeta);
+    const {
+      getData,
+      setData
+    } = this.createCallback();
+    const dependencies = this.getClientActionDependencies();
+    const useCase = this.createUseCase(dependencies, GetClientActionLocationUseCase);
+    useCase.execute({
+      id,
+      callback: setData
+    });
+    return getData();
+  }
+
+  getUIComponentProperties(id) {
+    this.validateInput('getUIComponentProperties', {
+      clientActionId: id
+    }, SdkContracts.getComponentPropertiesMeta);
+    const {
+      getData,
+      setData
+    } = this.createCallback();
+    const dependencies = this.getClientActionDependencies();
+    const useCase = this.createUseCase(dependencies, GetClientActionUIComponentPropertiesUseCase);
+    useCase.execute({
+      id,
+      callback: setData
+    });
+    return getData();
+  }
+
+  getClientActions() {
+    const {
+      getData,
+      setData
+    } = this.createCallback();
+    const dependencies = this.getClientActionDependencies();
+    const useCase = this.createUseCase(dependencies, GetClientActionsUseCase);
+    useCase.execute({
+      callback: setData
+    });
+    return getData();
+  }
+
+  updateUIComponentProperties(id, newComponentProperties) {
+    this.validateInput('updateUIComponentProperties', {
+      clientActionId: id,
+      newComponentProperties
+    }, SdkContracts.updateComponentPropertiesMeta);
+    const {
+      getData,
+      setData
+    } = this.createCallback();
+    const dependencies = this.getClientActionDependencies();
+    const {
+      dispatch
+    } = this.dependencies;
+    const useCase = this.createUseCase(dependencies, UpdateClientActionUIComponentPropertiesUseCase);
+    useCase.execute({
+      id,
+      newComponentProperties,
+      dispatch,
+      callback: setData
+    });
+    return getData();
+  }
+
+}

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

@@ -0,0 +1,20 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetClientActionLocationUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      id,
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const clientActionManager = repository.getClientActionsManagerEntity();
+    clientActionManager.validateClientActionId(id);
+    const clientAction = clientActionManager.getClientAction(id);
+    callback === null || callback === void 0 ? void 0 : callback(clientAction.getLocation());
+  }
+
+}
+
+export default GetClientActionLocationUseCase;

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

@@ -0,0 +1,20 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetClientActionUIComponentPropertiesUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      id,
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const clientActionManager = repository.getClientActionsManagerEntity();
+    clientActionManager.validateClientActionId(id);
+    const clientAction = clientActionManager.getClientAction(id);
+    callback === null || callback === void 0 ? void 0 : callback(clientAction.getUIComponentProperties());
+  }
+
+}
+
+export default GetClientActionUIComponentPropertiesUseCase;

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

@@ -0,0 +1,18 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetClientActionsUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const clientActionManager = repository.getClientActionsManagerEntity();
+    const clientActions = clientActionManager.getClientActionModels();
+    callback === null || callback === void 0 ? void 0 : callback(clientActions);
+  }
+
+}
+
+export default GetClientActionsUseCase;

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

@@ -0,0 +1,32 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { SET_CLIENTACTIONS } from "../../../../bc/zclient-actions/Constants";
+
+class UpdateClientActionUIComponentPropertiesUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      id,
+      newComponentProperties,
+      dispatch,
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const clientActionManager = repository.getClientActionsManagerEntity();
+    clientActionManager.validateClientActionId(id);
+    const {
+      updatedClientAction,
+      updatedClientActions
+    } = clientActionManager.updateClientActionComponentProperties(id, newComponentProperties);
+    dispatch({
+      type: SET_CLIENTACTIONS,
+      payload: {
+        clientActions: updatedClientActions
+      }
+    });
+    callback === null || callback === void 0 ? void 0 : callback(updatedClientAction.getUIComponentProperties());
+  }
+
+}
+
+export default UpdateClientActionUIComponentPropertiesUseCase;

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

@@ -41,6 +41,18 @@ export default class ClientAction {
     this.conditionMeta = clientActionObj.conditions;
   }
 
+  getLocation() {
+    return this.location;
+  }
+
+  getUIComponentProperties() {
+    return this.uiComponentMapping.getPropertiesValueMapping();
+  }
+
+  updateUIComponentProperties(newProperties) {
+    this.uiComponentMapping.updatePropertiesValueMapping(newProperties);
+  }
+
   toObject() {
     return {
       id: this.id,

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

@@ -114,6 +114,32 @@ export default class ClientActionManager {
     this.clientActions.setIsFetching(false);
   }
 
+  getClientAction(id) {
+    return this.clientActions.getClientAction(id);
+  }
+
+  getClientActionModels() {
+    const clientActionModels = this.clientActions.toObject();
+    return clientActionModels.data;
+  }
+
+  updateClientActionComponentProperties(id, newComponentProperties) {
+    const clientActions = this.getClientActionModels();
+    const updatedClientAction = this.getClientAction(id);
+    updatedClientAction.updateUIComponentProperties(newComponentProperties);
+    const updatedClientActions = clientActions.map(clientAction => {
+      if (clientAction.id === updatedClientAction.getId()) {
+        return updatedClientAction.toObject();
+      }
+
+      return clientAction;
+    });
+    return {
+      updatedClientAction,
+      updatedClientActions
+    };
+  }
+
   setClientActions(clientActions) {
     this.clientActions.setClientActions(clientActions);
   }
@@ -130,6 +156,25 @@ export default class ClientActionManager {
     return apiName === 'clientActions';
   }
 
+  validateClientActionId(id) {
+    const isValidClientActionIdFormat = id !== '' && id !== null && !isNaN(Number(id)) && typeof id === 'string';
+
+    if (!isValidClientActionIdFormat) {
+      throw new Error(`ClientActionResource: Invalid value '${id}' passed as client action id.`);
+    }
+
+    this.doesClientActionExist(id);
+  }
+
+  doesClientActionExist(id) {
+    const clientActions = this.getClientActionModels();
+    const doesClientActionExist = clientActions.find(clientAction => clientAction.id === id);
+
+    if (doesClientActionExist === undefined) {
+      throw new Error(`ClientActionResource: No client action exists for the ID '${id}'.`);
+    }
+  }
+
   toObject() {
     const clientActionsObj = this.clientActions.toObject();
     return {

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

@@ -23,6 +23,16 @@ export default class UIComponentMapping {
     this.eventMappings = new EventMappings(uiComponentMappingObj.eventMappings);
   }
 
+  getPropertiesValueMapping() {
+    return this.propertiesValueMapping;
+  }
+
+  updatePropertiesValueMapping(newProperties) {
+    this.propertiesValueMapping = { ...this.propertiesValueMapping,
+      ...newProperties
+    };
+  }
+
   toObject() {
     return {
       id: this.id,

package/es/platform/client-actions/behaviour/zclient-actions/frameworks/sdk/ClientActionsSDKFactory.js

@@ -0,0 +1,29 @@
+import ResourceNamesEnum from "../../../../../../bc/sdk/ResourceNamesEnum";
+import { platformSDK } from "../../../../../sdk/frameworks/Sdk";
+export default class ClientActionsSDKFactory {
+  static getClientActionSDK(clientActionResource) {
+    return {
+      getLocation: id => clientActionResource.getLocation(id),
+      getUIComponentProperties: id => clientActionResource.getUIComponentProperties(id),
+      getClientActions: () => clientActionResource.getClientActions(),
+      updateUIComponentProperties: (id, newComponentProperties) => clientActionResource.updateUIComponentProperties(id, newComponentProperties)
+    };
+  }
+
+  static create(_ref) {
+    let {
+      instanceName
+    } = _ref;
+    const clientActionResource = platformSDK[ResourceNamesEnum.CLIENT_ACTION](instanceName);
+    const clientActionSDK = ClientActionsSDKFactory.getClientActionSDK(clientActionResource);
+    return {
+      clientAction: {
+        getLocation: clientActionSDK.getLocation,
+        getUIComponentProperties: clientActionSDK.getUIComponentProperties,
+        getClientActions: clientActionSDK.getClientActions,
+        updateUIComponentProperties: clientActionSDK.updateUIComponentProperties
+      }
+    };
+  }
+
+}

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

@@ -6,6 +6,15 @@ export const actionsSchema = {
   items: actionSchema
 };
 export default {
+  testId: {
+    required: false,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    },
+    defaultValue: ''
+  },
   actions: {
     required: true,
     typeMetadata: {

package/es/platform/client-actions/cc/dynamic-action-component/Properties.js

@@ -35,7 +35,7 @@ export const actionSchema = {
             type: 'string'
           }
         },
-        required: ['sourceEvent', 'id']
+        required: ['id']
       }
     }
   },

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

@@ -10,7 +10,7 @@ export default class PropertiesChangeUseCase extends AbstractUseCase {
       currentActions,
       previousActions
     } = input;
-    actionLocation.processActionsChange(currentActions, previousActions);
+    actionLocation.processActionsChange(previousActions, currentActions);
     presenter.updateActionEventMediator(actionLocation.toObject());
   }
 

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

@@ -16,6 +16,7 @@ export default class ActionEventMediatorEntity {
     return e => {
       const {
         eventMappings,
+        actionId,
         ...payloadItems
       } = e.detail.payload;
       const eventMapping = eventMappings.find(eventMapping => eventMapping.sourceEvent === event);
@@ -25,14 +26,17 @@ export default class ActionEventMediatorEntity {
       }
 
       const dispatchEvent = eventMapping.targetEvent;
-      const payload = eventMapping.payload;
+      const eventMappingPayload = eventMapping.payload;
       const replacementContext = {
         "@payload": payloadItems
       };
-      const resolvedPayload = TemplateResolver.replaceContextVariablesInObject(payload, replacementContext);
+      const resolvedPayload = TemplateResolver.replaceContextVariablesInObject(eventMappingPayload, replacementContext);
       this.dispatch({
         type: dispatchEvent,
-        payload: resolvedPayload
+        payload: resolvedPayload,
+        metaData: {
+          clientActionId: actionId
+        }
       });
     };
   }

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

@@ -8,10 +8,12 @@ export default function ActionEventMediatorView(_ref, ref) {
   const {
     actions,
     renderComponentType,
-    gap
+    gap,
+    testId
   } = state.properties;
   const ActionRenderComponent = ComponentRegistry.get(renderComponentType) || RowActionsRenderer;
   return /*#__PURE__*/React.createElement(ActionRenderComponent, {
+    testId: testId,
     actions: actions,
     gap: gap,
     getRef: ref

package/es/platform/client-actions/components/dynamic-component/frameworks/ui/DynamicActionComponentView.js

@@ -12,7 +12,8 @@ function DynamicComponentView(_ref, ref) {
   const {
     component,
     properties,
-    eventMappings
+    eventMappings,
+    id: actionId
   } = action;
   const Component = ComponentRegistry.get(component) || ActionComponentMapping[component];
 
@@ -26,7 +27,8 @@ function DynamicComponentView(_ref, ref) {
     getRef: ref,
     ...properties,
     appendToActionPayload: {
-      eventMappings
+      eventMappings,
+      actionId
     }
   });
 }

package/es/platform/client-actions/components/row-actions-renderer/frameworks/ui/RowActionsRendererView.js

@@ -11,10 +11,13 @@ function RowActionsRendererView(_ref, ref) {
   } = _ref;
   const {
     actions,
-    gap
+    gap,
+    testId
   } = state.properties;
   return /*#__PURE__*/React.createElement(Flex, {
     ref: ref,
+    testId: testId,
+    customId: testId,
     $ui_displayMode: "inline",
     $ui_alignItems: "center",
     $ui_className: `${style.wrapper} ${gap !== ActionViewGap.NONE ? style[`gap_${gap}`] : ''}`

package/es/platform/components/form-connected/adapters/resources/SmartFormResources.js

@@ -16,7 +16,11 @@ import SubmitUseCase from "../../../../zform/applications/usecases/SubmitUseCase
 import { AbstractResource } from "../../../../sdk/application/interfaces/gateways/AbstractResource";
 import { SdkContracts } from "../../../../../cc/form-connected/SdkContract"; // hack
 
-import { validations as defaultFieldValidations } from "../../../../../library/behaviours/field-validation/frameworks/utils/FormBasicValidationAdaptor";
+import ValidateFieldUseCase from "../../../../zform/applications/usecases/ValidateFieldUseCase";
+import SetFieldErrorMessageUseCase from "../../../../zform/applications/usecases/SetFieldErrorMessageUseCase";
+import FocusFieldUseCase from "../../../../zform/applications/usecases/FocusFieldUseCase";
+import InsertValidationRuleUseCase from "../../../../zform/applications/usecases/InsertValidationRuleSuccessUseCase";
+import GetFieldErrorMessageUseCase from "../../../../zform/applications/usecases/GetFieldErrorMessageUseCase";
 export class SmartFormResources extends AbstractResource {
   initialize() {}
 
@@ -48,8 +52,7 @@ export class SmartFormResources extends AbstractResource {
     const dependencies = {
       repository: new ZFormRepository(),
       presenter: new ZFormPresenter(),
-      validator: new ZFormValidator(defaultFieldValidations),
-      // Hack Need to pass customValidators
+      validator: new ZFormValidator(),
       layoutRuleApplier: new ZFormLayoutRuleApplier()
     };
     return dependencies;
@@ -176,13 +179,13 @@ export class SmartFormResources extends AbstractResource {
   }
 
   getFieldValue(fieldName) {
+    this.validateInput('getFieldValue', {
+      fieldName
+    }, SdkContracts.getFieldValueInputMeta);
     const {
       getData,
       setData
     } = this.createCallback();
-    this.validateInput('getFieldValue', {
-      fieldName
-    }, SdkContracts.getFieldValueInputMeta);
     const {
       dispatch
     } = this.dependencies;
@@ -196,6 +199,85 @@ export class SmartFormResources extends AbstractResource {
     return getData();
   }
 
+  validateField(fieldName, eventName) {
+    this.validateInput('validateField', {
+      fieldName,
+      eventName
+    }, SdkContracts.validateFieldInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, ValidateFieldUseCase);
+    usecase.execute({
+      fieldName,
+      dispatch
+    });
+  }
+
+  insertValidationRule(index, validationRule) {
+    this.validateInput('insertValidationRule', {
+      index,
+      validationRule
+    }, SdkContracts.insertValidationRuleInputMeta);
+    InsertValidationRuleUseCase;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, InsertValidationRuleUseCase);
+    usecase.execute({
+      index,
+      validationRule
+    });
+  }
+
+  getFieldErrorMessage(fieldName) {
+    this.validateInput('getFieldErrorMessage', {
+      fieldName
+    }, SdkContracts.getFieldErrorMessageInputMeta);
+    const {
+      getData,
+      setData
+    } = this.createCallback();
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, GetFieldErrorMessageUseCase);
+    usecase.execute({
+      fieldName,
+      callback: setData,
+      dispatch
+    });
+    return getData();
+  }
+
+  setFieldErrorMessage(fieldName, errorMessage) {
+    this.validateInput('setFieldErrorMessage', {
+      fieldName,
+      errorMessage
+    }, SdkContracts.setFieldErrorMessageInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, SetFieldErrorMessageUseCase);
+    usecase.execute({
+      fieldApiName: fieldName,
+      errorMessage,
+      dispatch
+    });
+  }
+
+  focusField(fieldName) {
+    this.validateInput('focusField', {
+      fieldName
+    }, SdkContracts.focusFieldInputMeta);
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, FocusFieldUseCase);
+    usecase.execute({
+      fieldName
+    });
+  }
+
   submit() {
     const {
       dispatch