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

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/applications/usecases/InitializeUseCase.js

@@ -0,0 +1,17 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { DATA_SOURCE_REGISTER } from "../../../../../../bc/zdata-source/Constants";
+export default class InitializeUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      apiTemplates,
+      dispatch
+    } = input;
+    dispatch({
+      type: DATA_SOURCE_REGISTER,
+      payload: {
+        apiTemplates
+      }
+    });
+  }
+
+}

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/applications/usecases/SetClientScriptsUseCase.js

@@ -0,0 +1,21 @@
+import AbstractUseCase from "./AbstractUseCase";
+import ClientActionFactory from "../entities-factory/ClientScriptsFactory";
+
+class SetClientScriptsUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      presenter,
+      repository
+    } = this.dependencies;
+    const {
+      clientScripts
+    } = input;
+    const recordManager = repository.getClientScriptsManagerEntity();
+    const scriptsEntity = ClientActionFactory.deSerializeClientScripts(clientScripts);
+    recordManager.setData(scriptsEntity);
+    presenter.updateClientScript(recordManager.toObject());
+  }
+
+}
+
+export default SetClientScriptsUseCase;

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/ClientScript.js

@@ -0,0 +1,24 @@
+export default class ClientScript {
+  constructor(clientScriptModel) {
+    this.targetEventName = clientScriptModel.targetEvent;
+    this.eventHandler = clientScriptModel.clientScript;
+  }
+
+  getEventName() {
+    return this.targetEventName;
+  }
+
+  getEventHandler() {
+    return this.eventHandler;
+  }
+
+  toObject() {
+    const targetEventName = this.getEventName();
+    const eventHandler = this.getEventHandler();
+    return {
+      targetEvent: targetEventName,
+      clientScript: eventHandler
+    };
+  }
+
+}

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/ClientScripts.js

@@ -0,0 +1,41 @@
+import ClientScript from "./ClientScript";
+export default class ClientScripts {
+  constructor(_ref) {
+    let {
+      data,
+      isFetching
+    } = _ref;
+    let fetchLimit = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 100;
+    this.clientScripts = data.map(obj => new ClientScript(obj));
+    this.fetchLimit = fetchLimit;
+    this.isDataBeingFetched = isFetching;
+  }
+
+  setIsFetching(isFetching) {
+    this.isDataBeingFetched = isFetching;
+  }
+
+  setData(clientScripts) {
+    this.clientScripts = clientScripts;
+  }
+
+  isFetching() {
+    return this.isDataBeingFetched;
+  }
+
+  getLength() {
+    return this.clientScripts.length;
+  }
+
+  getClientScript(eventName) {
+    return this.clientScripts.find(clientScript => clientScript.getEventName() === eventName) || null;
+  }
+
+  toObject() {
+    return {
+      clientScripts: this.clientScripts.map(clientScript => clientScript.toObject()),
+      isFetching: this.isFetching()
+    };
+  }
+
+}

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/GetClientScriptsStrategy.js

@@ -0,0 +1,44 @@
+import { SET_CLIENTSCRIPTS, CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT, CLIENTSCRIPT_FETCH_FAILURE, CLIENTSCRIPT_FETCH_SUCCESS } from "../../../../bc/zclient-scripts-fetch/Constants";
+export default class GetClientScriptsStrategy {
+  createSuccessEvents(response, metaData) {
+    const events = [];
+    const clientScripts = response;
+    events.push({
+      type: SET_CLIENTSCRIPTS,
+      payload: {
+        clientScripts
+      }
+    });
+    events.push({
+      type: CLIENTSCRIPT_FETCH_SUCCESS,
+      payload: {
+        clientScripts
+      },
+      metaData
+    });
+    return events;
+  }
+
+  createNoContentEvents(metaData) {
+    const events = [];
+    events.push({
+      type: CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT,
+      payload: {},
+      metaData
+    });
+    return events;
+  }
+
+  createFailureEvents(error, metaData) {
+    const events = [];
+    events.push({
+      type: CLIENTSCRIPT_FETCH_FAILURE,
+      payload: {
+        error
+      },
+      metaData
+    });
+    return events;
+  }
+
+}

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/State.js

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

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/interfaces/ClientScriptEventMappingState.js

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

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/interfaces/ClientScriptModel.js

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

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/interfaces/ClientScriptsModel.js

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

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/domain/entities/interfaces/IEvent.js

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

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/frameworks/ClientScriptsBehaviourFactory.js

@@ -0,0 +1,12 @@
+import ClientScriptsHandlersFactory from "./ClientScriptsHandlersFactory";
+export default class ClientScriptsBehaviourFactory {
+  static create(apiDetails) {
+    return {
+      name: 'zclientScriptsEventMapping',
+      eventHandlers: ClientScriptsHandlersFactory.create(apiDetails),
+      properties: {},
+      setInitialState: () => ({})
+    };
+  }
+
+}

package/es/platform/client-scripts/behaviour/zclient-scripts-fetch/frameworks/ClientScriptsHandlersFactory.js

@@ -0,0 +1,47 @@
+import MountController from "../adapters/controllers/MountController";
+import Presenter from "../adapters/presenters/Presenter";
+import Repository from "../adapters/gateways/Repository";
+import Service from "../adapters/gateways/Service";
+import { CLIENTSCRIPT_FETCH, CLIENTSCRIPT_FETCH_FAILURE_CALLBACK, CLIENTSCRIPT_FETCH_SUCCESS_CALLBACK, CLIENTSCRIPT_FETCH_SUCCESS, CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT, CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT_CALLBACK, SET_CLIENTSCRIPTS, CLIENTSCRIPT_FETCH_FAILURE } from "../../../bc/zclient-scripts-fetch/Constants";
+import FetchClientScriptsController from "../adapters/controllers/FetchClientScriptsController";
+import FetchClientScriptsStopController from "../adapters/controllers/FetchClientScriptsStopController";
+import FetchClientScriptsSuccessController from "../adapters/controllers/FetchClientScriptsSuccessController";
+import FetchClientScriptsFailureController from "../adapters/controllers/FetchClientScriptsFailureController";
+import FetchClientScriptsNoContentController from "../adapters/controllers/FetchClientScriptsNoContentController";
+import SetClientScriptsController from "../adapters/controllers/SetClientScriptsController";
+export default class ClientScriptsHandlersFactory {
+  static getClientScriptsControllerHandles(service) {
+    return {
+      fetchClientScripts: new FetchClientScriptsController(service).handle,
+      fetchClientScriptsSuccess: new FetchClientScriptsSuccessController(service).handle,
+      fetchClientScriptsStop: new FetchClientScriptsStopController(service).handle,
+      fetchClientScriptsFailure: new FetchClientScriptsFailureController(service).handle,
+      fetchClientScriptsNoContent: new FetchClientScriptsNoContentController(service).handle,
+      setClientScripts: new SetClientScriptsController(service).handle
+    };
+  }
+
+  static create(apiDetails) {
+    const presenter = new Presenter();
+    const repository = new Repository();
+    const dependencies = {
+      presenter,
+      repository
+    };
+    const service = new Service(dependencies);
+    const mountController = new MountController(apiDetails, service);
+    const clientScriptControllerHandle = ClientScriptsHandlersFactory.getClientScriptsControllerHandles(service);
+    return {
+      MOUNT: mountController.handle,
+      [CLIENTSCRIPT_FETCH]: clientScriptControllerHandle.fetchClientScripts,
+      [CLIENTSCRIPT_FETCH_FAILURE_CALLBACK]: clientScriptControllerHandle.fetchClientScriptsFailure,
+      [CLIENTSCRIPT_FETCH_SUCCESS_CALLBACK]: clientScriptControllerHandle.fetchClientScriptsSuccess,
+      [CLIENTSCRIPT_FETCH_SUCCESS]: clientScriptControllerHandle.fetchClientScriptsStop,
+      [CLIENTSCRIPT_FETCH_FAILURE]: clientScriptControllerHandle.fetchClientScriptsStop,
+      [CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT]: clientScriptControllerHandle.fetchClientScriptsStop,
+      [SET_CLIENTSCRIPTS]: clientScriptControllerHandle.setClientScripts,
+      [CLIENTSCRIPT_FETCH_SUCCESS_NO_CONTENT_CALLBACK]: clientScriptControllerHandle.fetchClientScriptsNoContent
+    };
+  }
+
+}

package/es/platform/client-scripts/cc/zclient-scripts-execution/clientScriptsSchema.js

@@ -0,0 +1,15 @@
+export const clientScriptsSchema = {
+  type: 'array',
+  minItems: 0,
+  items: {
+    type: 'object',
+    properties: {
+      targetEventName: {
+        type: 'string'
+      },
+      clientScript: {
+        type: 'string'
+      }
+    }
+  }
+};

package/es/platform/components/app/adapters/resources/AppResource.js

@@ -6,10 +6,20 @@ export class AppResource extends AbstractResource {
 
   destroy() {}
 
+  initializeContext(context) {
+    this.context = context;
+  }
+
+  initializeApiHeader(headers) {
+    this.headers = headers;
+  }
+
   getContext() {
-    return {
-      context: ['organization', 'department', 'user']
-    };
+    return this.context;
+  }
+
+  getApiHeader() {
+    return this.headers;
   }
 
 }

package/es/platform/components/form-connected/frameworks/EventHandlersFactory.js

@@ -1,7 +1,7 @@
 import SmartFormConstants from "../../../../cc/form-connected/ExternalConstants";
 import FormSdkFactory from "./FormSdkFactory";
 import FormConstants from "../../../../cc/form/Constants";
-import { ZFORM_FIELD_BLURRED, ZFORM_FIELD_VALUE_CHANGED, ZFORM_SUBMIT_SUCCESS, ZFORM_SUBMIT_VALIDATION_FAILURE } from "../../../../bc/zform/Symbol";
+import { ZFORM_FIELD_BLURRED, ZFORM_FIELD_VALUE_CHANGED, ZFORM_SUBMIT_FAILURE, ZFORM_SUBMIT_SUCCESS, ZFORM_SUBMIT_VALIDATION_FAILURE } from "../../../../bc/zform/Symbol";
 import { platformSDK_old } from "../../../sdk/frameworks/Sdk";
 const {
   SMART_FORM_FIELD_FOCUSED,
@@ -56,6 +56,7 @@ export default class EventHandlersFactory {
       [FormConstants.FORM_FIELD_FOCUSED]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_FIELD_FOCUSED),
       [ZFORM_FIELD_BLURRED]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_FIELD_BLURRED),
       [ZFORM_SUBMIT_SUCCESS]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_SUBMIT_SUCCESS),
+      [ZFORM_SUBMIT_FAILURE]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_SUBMIT_FAILURE),
       [ZFORM_SUBMIT_VALIDATION_FAILURE]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_SUBMIT_FAILURE),
       [ZFORM_FIELD_VALUE_CHANGED]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_FIELD_VALUE_CHANGED)
     };

package/es/platform/components/form-connected/frameworks/FormConnectedFactory.js

@@ -13,6 +13,9 @@ import ResourceNamesEnum from "../../../../bc/sdk/ResourceNamesEnum";
 import { sdkRegistry } from "../../../sdk/frameworks/SdkRegistry";
 import { SmartFormResources } from "../adapters/resources/SmartFormResources";
 import ClientActionsBehaviourFactory from "../../../client-actions/behaviour/zclient-actions/frameworks/ClientActionsBehaviourFactory";
+import ClientScriptsBehaviourFactory from "../../../client-scripts/behaviour/zclient-scripts-fetch/frameworks/ClientScriptsBehaviourFactory";
+import FormFallbackView from "../../../../library/dot/components/form/frameworks/ui/FormFallbackView";
+import AppContextBehaviourFactory from "../../../app-context-behaviour/frameworks/AppContextBehaviourFactory";
 sdkRegistry.registerResource({
   resourceName: ResourceNamesEnum.SMART_FORM,
   resource: SmartFormResources
@@ -41,11 +44,14 @@ export default class FormConnectedFactory {
     return createCustomComponent({
       name: name,
       View: View,
+      FallbackView: FormFallbackView,
       properties: Properties,
       eventHandlers: EventHandlersfactory.create(eventHandlers),
       transformState: FormTranslator.transformState,
-      behaviours: [SdkBehaviourFactory.create([ResourceNamesEnum.SMART_FORM]), ClientActionsBehaviourFactory.create({
+      behaviours: [SdkBehaviourFactory.create([ResourceNamesEnum.SMART_FORM]), AppContextBehaviourFactory.create(), ClientActionsBehaviourFactory.create({
         getClientActions: _dataSource.httpTemplates.getClientActions
+      }), ClientScriptsBehaviourFactory.create({
+        getClientScripts: _dataSource.httpTemplates.getClientScripts
       }), ZHttpBehaviourFactory.create(), DataBrokerBehaviourFactory.create(), RecordBehaviourFactory.create(_dataSource.httpTemplates), ZFormBehaviourFactory.create()]
     });
   }

package/es/platform/components/form-connected/frameworks/FormConnectedView.js

@@ -15,7 +15,8 @@ function View(_ref, ref) {
     headerLeftActions,
     headerRightActions,
     footerLeftActions,
-    footerRightActions
+    footerRightActions,
+    clientScripts
   } = state.viewModel;
   return /*#__PURE__*/React.createElement(Form, {
     getRef: ref,
@@ -27,7 +28,8 @@ function View(_ref, ref) {
     headerRightActions: headerRightActions,
     footerLeftActions: footerLeftActions,
     footerRightActions: footerRightActions,
-    rightPanel: rightPanel
+    rightPanel: rightPanel,
+    clientScripts: clientScripts
   });
 }
 

package/es/platform/components/table-connected/adapters/controllers/ColumnChooserUpdateController.js

@@ -8,6 +8,10 @@ export default class ColumnChooserUpdateController extends AbstractController {
     } = event;
     const {
       context
+    } = state.behaviours.appContext;
+    const {
+      viewId,
+      departmentId
     } = state.properties;
     const fields = event.action.payload.selectedArray;
     dispatch({
@@ -15,7 +19,9 @@ export default class ColumnChooserUpdateController extends AbstractController {
       payload: {
         actionName: 'updateSelectedFields',
         props: { ...context,
-          fields
+          fields,
+          viewId,
+          departmentId
         },
         apiName: 'updateSelectedFields'
       }

package/es/platform/components/table-connected/adapters/controllers/ResolutionBasedLimitController.js

@@ -0,0 +1,21 @@
+import AbstractController from "./AbstractController";
+import { ZLIST_INITIALIZE } from "../../../../../bc/zlist/Constants";
+export default class ResolutionBasedLimitController extends AbstractController {
+  handle(event) {
+    const {
+      dispatch,
+      action
+    } = event;
+    const {
+      count
+    } = action.payload;
+    const newLimit = Math.ceil(count / 25) * 25;
+    dispatch({
+      type: ZLIST_INITIALIZE,
+      payload: {
+        resolutionBasedLimit: newLimit
+      }
+    });
+  }
+
+}

package/es/platform/components/table-connected/adapters/resources/ErrorPrinter.js

@@ -1,20 +1,23 @@
 export default class ErrorPrinter {
   static printError(error) {
-    console.error('Error occurred:', error);
+    __DEVELOPMENT__ && console.error('Error occurred:', error);
   }
 
   static displaySchemaErrors(title, errors) {
     let dataName = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '(root)';
-    console.group(title.msg, ...title.styles);
-    errors.forEach((_ref, i) => {
-      let {
-        dataPath,
-        keyword,
-        message
-      } = _ref;
-      console.error(`%c${i + 1}. %c${dataName + dataPath}%c → ${keyword} ${message}`, 'color: initial;', 'color: #FF6F61; font-weight: bold;', 'color: #FFA500;');
-    });
-    console.groupEnd();
+
+    if (__DEVELOPMENT__) {
+      console.group(title.msg, ...title.styles);
+      errors.forEach((_ref, i) => {
+        let {
+          dataPath,
+          keyword,
+          message
+        } = _ref;
+        console.error(`%c${i + 1}. %c${dataName + dataPath}%c → ${keyword} ${message}`, 'color: initial;', 'color: #FF6F61; font-weight: bold;', 'color: #FFA500;');
+      });
+      console.groupEnd();
+    }
   }
 
 }

package/es/platform/components/table-connected/adapters/resources/SmartTableResource.js

@@ -17,6 +17,10 @@ import UpdateMultipleRecordUseCase from "../../../../zlist/applications/usecases
 import GetContextUseCase from "../../../../zlist/applications/usecases/GetContextUseCase";
 import ReOrderUseCase from "../../../../zlist/applications/usecases/ReOrderUseCase";
 import { SdkContracts } from "../../../../../cc/table-connected/SdkContract";
+import SortUseCase from "../../../../zlist/applications/usecases/SortUseCase";
+import { Analytics } from "../../../../../library/analytics";
+import MarkAsReadUseCase from "../../../../zrecord/applications/usecases/MarkAsReadUseCase";
+import MarkAsUnReadUseCase from "../../../../zrecord/applications/usecases/MarkAsUnReadUseCase";
 export class SmartTableResource extends AbstractResource {
   initialize() {}
 
@@ -58,6 +62,23 @@ export class SmartTableResource extends AbstractResource {
     return usecase;
   }
 
+  getMetrics(sdkName) {
+    const {
+      state
+    } = this.dependencies;
+    const now = new Date().toISOString();
+    const smartTableSdkMethodUsed = {
+      event: "smart_table_sdk_method_used",
+      timestamp: now,
+      contextDetails: {
+        moduleName: state.moduleName,
+        instanceName: state.instanceName,
+        method: sdkName
+      }
+    };
+    return smartTableSdkMethodUsed;
+  }
+
   getRecords() {
     const {
       getData,
@@ -68,6 +89,8 @@ export class SmartTableResource extends AbstractResource {
     usecase.execute({
       callback: setData
     });
+    let metric = this.getMetrics('getRecords()');
+    Analytics.push(metric);
     return getData();
   }
 
@@ -85,6 +108,8 @@ export class SmartTableResource extends AbstractResource {
       recordId,
       callback: setData
     });
+    let metric = this.getMetrics(`getRecord(recordId)`);
+    Analytics.push(metric);
     return getData();
   }
 
@@ -147,6 +172,12 @@ export class SmartTableResource extends AbstractResource {
       callback: setData,
       shouldFetch
     });
+
+    if (shouldFetch) {
+      let metric = this.getMetrics(`deleteRecords(recordIds)`);
+      Analytics.push(metric);
+    }
+
     return getData();
   }
 
@@ -197,6 +228,12 @@ export class SmartTableResource extends AbstractResource {
       callback: setData,
       shouldFetch
     });
+
+    if (shouldFetch) {
+      let metric = this.getMetrics(`updateRecords(recordsMap)`);
+      Analytics.push(metric);
+    }
+
     return getData();
   }
 
@@ -269,4 +306,49 @@ export class SmartTableResource extends AbstractResource {
     });
   }
 
+  sortRecords(sortBy) {
+    this.validateInput('sortRecords', {
+      sortBy
+    }, SdkContracts.sortByInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getListDependencies();
+    const usecase = this.createUseCase(dependencies, SortUseCase);
+    usecase.execute({
+      sortBy,
+      dispatch
+    });
+  }
+
+  markAsRead(recordId) {
+    this.validateInput('markAsRead', {
+      recordId
+    }, SdkContracts.markAsReadInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getRecordDependencies();
+    const usecase = this.createUseCase(dependencies, MarkAsReadUseCase);
+    usecase.execute({
+      recordId,
+      dispatch
+    });
+  }
+
+  markAsUnRead(recordId) {
+    this.validateInput('markAsUnRead', {
+      recordId
+    }, SdkContracts.markAsUnReadInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getRecordDependencies();
+    const usecase = this.createUseCase(dependencies, MarkAsUnReadUseCase);
+    usecase.execute({
+      recordId,
+      dispatch
+    });
+  }
+
 }