@zohodesk/library-platform 1.1.3-exp.2 → 1.1.3-exp.4

package/es/platform/zform/domain/ZField.js

@@ -18,8 +18,11 @@ export default class ZField {
       isMandatory,
       value,
       errorMessage,
-      visibility = true,
+      isVisible = true,
       pickListValues,
+      toolTip,
+      toolTipType,
+      defaultValue,
       subType
     } = _ref;
 
@@ -53,7 +56,7 @@ export default class ZField {
 
     _defineProperty(this, "errorMessage", void 0);
 
-    _defineProperty(this, "visibility", void 0);
+    _defineProperty(this, "isVisible", void 0);
 
     _defineProperty(this, "pickListValues", void 0);
 
@@ -61,6 +64,12 @@ export default class ZField {
 
     _defineProperty(this, "subType", void 0);
 
+    _defineProperty(this, "toolTip", void 0);
+
+    _defineProperty(this, "toolTipType", void 0);
+
+    _defineProperty(this, "defaultValue", void 0);
+
     this.displayLabel = displayLabel;
     this.apiName = apiName;
     this.isCustomField = isCustomField;
@@ -76,23 +85,53 @@ export default class ZField {
     this.isMandatory = isMandatory;
     this.value = value;
     this.errorMessage = errorMessage;
-    this.visibility = visibility;
+    this.isVisible = isVisible;
     this.defaultPickListValues = pickListValues;
     this.pickListValues = pickListValues;
     this.subType = subType;
+    this.toolTip = toolTip;
+    this.toolTipType = toolTipType;
+    this.defaultValue = defaultValue; // if(value===undefined){
+    //     this.setDefaultValue()
+    // }
+  }
 
-    if (value === undefined) {
-      this.setDefaultValue();
+  decideValueForBoolean(defaultValue) {
+    if (defaultValue === undefined || defaultValue === null) {
+      return false;
     }
+
+    if (typeof defaultValue === "string") {
+      return defaultValue === "true" ? true : false;
+    }
+
+    return defaultValue;
   }
 
-  setDefaultValue() {
-    if (this.type === "Multiselect") {
-      this.value = [];
-    } else if (this.type === "Boolean") {
-      this.value = false;
-    } else {
-      this.value = "";
+  decideValueForMultiselect(defaultValue) {
+    if (defaultValue === undefined || defaultValue === null) {
+      return [];
+    }
+
+    if (typeof defaultValue === "string") {
+      return defaultValue.split(";");
+    }
+
+    return defaultValue;
+  }
+
+  decideDefaultValue() {
+    switch (this.type) {
+      case 'Boolean':
+        this.value = this.decideValueForBoolean(this.defaultValue);
+        break;
+
+      case 'Multiselect':
+        this.value = this.decideValueForMultiselect(this.defaultValue);
+        break;
+
+      default:
+        this.value = this.defaultValue === undefined ? '' : this.defaultValue;
     }
   }
 
@@ -125,15 +164,16 @@ export default class ZField {
   }
 
   toggleVisibility() {
-    this.visibility = !this.visibility;
+    this.isVisible = !this.isVisible;
   }
 
   setVisibility(visibility) {
-    this.visibility = visibility;
+    this.isVisible = visibility;
   }
 
   isVisibile() {
-    return this.visibility;
+    // return this.visibility;
+    return this.isVisible;
   }
 
   setMandatory(isMandatory) {
@@ -161,8 +201,13 @@ export default class ZField {
       isMandatory: this.isMandatory,
       value: this.value,
       errorMessage: this.errorMessage,
-      visibility: this.visibility,
+      // NOTE: visibility is now isVisible, visibility is deprecated, only for backward compatibility of layout rules
+      visibility: this.isVisible,
+      isVisible: this.isVisible,
       pickListValues: this.pickListValues,
+      toolTip: this.toolTip,
+      toolTipType: this.toolTipType,
+      defaultValue: this.defaultValue,
       subType: this.subType
     };
   }

package/es/platform/zform/domain/ZSection.js

@@ -1,14 +1,18 @@
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 export default class ZSection {
+  // Optional field for description
+  // private visibility:boolean;
   constructor(_ref) {
     let {
       name,
       i18NLabel,
       isCustomSection,
+      description,
       id,
       fields,
-      visibility
+      // visibility
+      isVisible
     } = _ref;
 
     _defineProperty(this, "name", void 0);
@@ -17,18 +21,23 @@ export default class ZSection {
 
     _defineProperty(this, "isCustomSection", void 0);
 
+    _defineProperty(this, "description", void 0);
+
     _defineProperty(this, "id", void 0);
 
     _defineProperty(this, "fields", void 0);
 
-    _defineProperty(this, "visibility", void 0);
+    _defineProperty(this, "isVisible", void 0);
 
     this.name = name;
     this.i18NLabel = i18NLabel;
     this.isCustomSection = isCustomSection;
+    this.description = description || ''; // Default to empty string if not provided
+
     this.id = id;
-    this.fields = fields;
-    this.visibility = visibility;
+    this.fields = fields; // this.visibility=visibility;
+
+    this.isVisible = isVisible;
   }
 
   getName() {
@@ -40,7 +49,8 @@ export default class ZSection {
   }
 
   toggleVisibility() {
-    this.visibility = !this.visibility;
+    // this.visibility=!this.visibility
+    this.isVisible = !this.isVisible;
   }
 
   appendField(field) {
@@ -74,7 +84,8 @@ export default class ZSection {
   }
 
   setVisibility(visibility) {
-    this.visibility = visibility;
+    // this.visibility=visibility;
+    this.isVisible = visibility;
   }
 
   setFieldErrorMessage(fieldApiName, errorMessage) {
@@ -102,11 +113,13 @@ export default class ZSection {
       name: this.name,
       i18NLabel: this.i18NLabel,
       isCustomSection: this.isCustomSection,
+      description: this.description,
       id: this.id,
       fields: this.fields.map(field => {
         return field.toObject();
       }),
-      visibility: this.visibility
+      // visibility:this.visibility
+      isVisible: this.isVisible
     };
   }
 

package/es/platform/zhttp/applications/usecases/FetchUseCase.js

@@ -1,14 +1,10 @@
-/* eslint-disable @zohodesk/architecturerules/no-returnStatement-rule */
-
-/* eslint-disable max-lines-per-function */
+/* eslint-disable @zohodesk/architecturerules/define-property-schema */
 import { FETCH_FAILED, FETCH_SUCCESS_NO_CONTENT, FETCH_REQUESTED, FETCH_SUCCESS } from "../../../../bc/zhttp/Constants";
 import AbstractUseCase from "./AbstractUseCase";
+import { ZHttpErrorSource, ZHttpErrorCode } from "../../../../bc/zhttp/Errors";
 
 class FetchUseCase extends AbstractUseCase {
   async execute(inputModel) {
-    const {
-      fetchGateWay
-    } = this.dependencies;
     const {
       url,
       method = 'GET',
@@ -17,7 +13,6 @@ class FetchUseCase extends AbstractUseCase {
     const {
       metaData,
       dispatch,
-      payload,
       headers
     } = inputModel;
     dispatch({
@@ -28,80 +23,130 @@ class FetchUseCase extends AbstractUseCase {
         headers,
         metaData
       }
-    });
+    }); // NOTE: getResponse is hacky solution to get the data using function call instead of fetch, So any handling added to here needs to be added to fetch and vise versa
+
+    if (typeof getResponse === 'function') {
+      await this.handleGetResponseAsFunction(inputModel);
+    } else {
+      await this.handleFetchResponse(inputModel);
+    }
+  }
+
+  async handleGetResponseAsFunction(inputModel) {
+    const {
+      getResponse,
+      headers,
+      dispatch,
+      metaData
+    } = inputModel;
 
     try {
-      // NOTE: getResponse is hacky solution to get the data using function call instead of fetch, So any handling added to here needs to be added to fetch and vise versa
-      if (typeof getResponse === 'function') {
-        const data = await getResponse(headers);
+      const data = await getResponse(headers);
 
-        if (data === undefined) {
-          dispatch({
-            type: FETCH_SUCCESS_NO_CONTENT,
-            payload: {},
-            metaData
-          });
-        } else {
-          dispatch({
-            type: FETCH_SUCCESS,
-            payload: {
-              response: data
-            },
-            metaData
-          });
-        }
+      if (data === undefined) {
+        dispatch({
+          type: FETCH_SUCCESS_NO_CONTENT,
+          payload: {},
+          metaData
+        });
       } else {
-        const response = await fetchGateWay.fetch(url, {
-          headers,
-          method,
-          body: method === 'GET' ? null : payload
+        dispatch({
+          type: FETCH_SUCCESS,
+          payload: {
+            response: data
+          },
+          metaData
         });
+      }
+    } catch (errorObj) {
+      this.dispatchException(inputModel, errorObj, ZHttpErrorSource.GetResponse, ZHttpErrorCode.UnknownError);
+    }
+  }
+
+  async handleFetchResponse(inputModel) {
+    const {
+      fetchGateWay
+    } = this.dependencies;
+    const {
+      url,
+      method = 'GET',
+      headers,
+      payload
+    } = inputModel;
+
+    try {
+      const response = await fetchGateWay.fetch(url, {
+        headers,
+        method,
+        body: method === 'GET' ? null : payload
+      });
 
-        if (response.ok) {
-          if (response.status === 204) {
-            dispatch({
-              type: FETCH_SUCCESS_NO_CONTENT,
-              payload: {},
-              metaData
-            });
-          } else if (response.status === 200 && method === 'DELETE') {
-            dispatch({
-              type: FETCH_SUCCESS,
-              payload: {},
-              metaData
-            });
-          } else {
-            const data = await response.json();
-            dispatch({
-              type: FETCH_SUCCESS,
-              payload: {
-                response: data
-              },
-              metaData
-            });
-          }
-        } else {
-          const data = await response.json();
-          dispatch({
-            type: FETCH_FAILED,
-            payload: {
-              error: data
-            },
-            metaData
-          });
-        }
+      if (response.ok) {
+        await this.handleSuccessResponse(response, inputModel);
+      } else {
+        const data = await response.json();
+        const errorObj = { ...data,
+          statusCode: response.status
+        };
+        this.dispatchException(inputModel, errorObj, ZHttpErrorSource.Fetch, ZHttpErrorCode.ApiError);
       }
-    } catch (e) {
+    } catch (errorObj) {
+      this.dispatchException(inputModel, errorObj, ZHttpErrorSource.Fetch, ZHttpErrorCode.UnknownError);
+    }
+  }
+
+  async handleSuccessResponse(response, inputModel) {
+    const {
+      method = 'GET',
+      dispatch,
+      metaData
+    } = inputModel;
+    const statusCode = response.status;
+
+    if (statusCode === 204) {
+      dispatch({
+        type: FETCH_SUCCESS_NO_CONTENT,
+        payload: {},
+        metaData
+      });
+    } else if (statusCode === 200 && method === 'DELETE') {
       dispatch({
-        type: FETCH_FAILED,
+        type: FETCH_SUCCESS,
+        payload: {},
+        metaData
+      });
+    } else {
+      const data = await response.json();
+      dispatch({
+        type: FETCH_SUCCESS,
         payload: {
-          error: e
+          response: data
         },
         metaData
       });
     }
   }
 
+  dispatchException(inputModel, errorObj, source, code) {
+    const {
+      dispatch,
+      metaData
+    } = inputModel;
+    const error = {
+      code,
+      message: errorObj.message,
+      source,
+      info: errorObj
+    };
+    dispatch({
+      type: FETCH_FAILED,
+      payload: {
+        error
+      },
+      metaData
+    });
+  }
+
 }
 
 export default FetchUseCase;

package/es/platform/zlist/adapters/controllers/FieldExecuteFailedController.js

@@ -0,0 +1,25 @@
+import AbstractController from "./AbstractController";
+export default class FieldExecuteFailedController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      updateState,
+      dispatch,
+      action
+    } = event;
+    const {
+      payload,
+      metaData
+    } = action;
+    const {
+      recordExecuteFailedUseCase
+    } = this.service;
+    recordExecuteFailedUseCase.updateDependency(state, updateState);
+    recordExecuteFailedUseCase.execute({
+      dispatch,
+      payload,
+      metaData
+    });
+  }
+
+}

package/es/platform/zlist/adapters/gateways/Repository.js

@@ -1,5 +1,6 @@
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+import ListErrorState from "../../domain/entities/ListErrorState";
 import ListFactory from "../../applications/entities-factory/ListFactory";
 import SortBy from "../../domain/entities/SortBy";
 
@@ -22,7 +23,8 @@ class Repository {
     } = this.state.properties;
     const {
       sortBy,
-      errorRecordFailed
+      errorState,
+      isReOrderLoading
     } = this.getZListState();
     const list = ListFactory.createList({
       context,
@@ -34,7 +36,8 @@ class Repository {
       },
       sortBy: new SortBy(sortBy.id, sortBy.name, sortBy.order),
       limit: 50,
-      errorRecordFailed
+      isReOrderLoading,
+      errorState: new ListErrorState(errorState)
     });
     return list;
   }

package/es/platform/zlist/adapters/presenters/TableTranslator.js

@@ -47,10 +47,11 @@ export default class TableTranslator {
       zfield,
       zclientAction
     } = fallbackToDefault(behaviours, {}); // FIX: behaviours should be available by default
-    // const { sortBy, isReOrderLoading } = fallbackToDefault(zlist, {}); // FIX: zlist should be available by default
 
     const {
-      sortBy
+      sortBy,
+      errorState,
+      isReOrderLoading
     } = fallbackToDefault(zlist, {}); // FIX: zlist should be available by default
 
     const {
@@ -69,6 +70,10 @@ export default class TableTranslator {
 
     const fieldComponentMapping = fallbackToDefault(componentMapping.fields, {});
     const rowActionsUiType = componentMapping.rowActionsComponentName;
+    const {
+      shouldClearRecords: isRecordsShouldBeEmptied,
+      canErrorPage: isError
+    } = errorState;
     const {
       fields: availableFields,
       selectedFields,
@@ -94,8 +99,9 @@ export default class TableTranslator {
 
     const localStorageFieldWidths = fallbackToDefault(localStorageBehaviour === null || localStorageBehaviour === void 0 ? void 0 : (_localStorageBehaviou = localStorageBehaviour[moduleName]) === null || _localStorageBehaviou === void 0 ? void 0 : (_localStorageBehaviou2 = _localStorageBehaviou[viewId]) === null || _localStorageBehaviou2 === void 0 ? void 0 : _localStorageBehaviou2.modifiedWidths, EMPTY_OBJECT);
     const modifiedWidths = calculateFieldWidths(fields, localStorageFieldWidths, preferences);
-    const headersTranslator = new HeadersTranslator(fields, headerActions, context, modifiedWidths, sortBy);
-    const rowsTranslator = new RowsTranslator(records, fields, rowActions, context, fieldComponentMapping, rowActionsUiType, fieldActions); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
+    const recordsForDisplay = isRecordsShouldBeEmptied ? EMPTY_ARRAY : records;
+    const headersTranslator = new HeadersTranslator(fields, headerActions, context, modifiedWidths, sortBy, records);
+    const rowsTranslator = new RowsTranslator(recordsForDisplay, fields, rowActions, context, fieldComponentMapping, rowActionsUiType, fieldActions); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
     // const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator(), actionTranslator.getTranslator()];
 
     const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator()];
@@ -106,6 +112,7 @@ export default class TableTranslator {
       behaviours,
       viewModel: {
         reOrderConfig,
+        isError,
         selection: SelectionTranslator(state),
         focussedRow: focussedIndex,
         sortBy,
@@ -123,7 +130,7 @@ export default class TableTranslator {
         },
         keyboardControlsConfig,
         isLoading,
-        // isReOrderLoading,
+        isReOrderLoading,
         emptyStateUiType: componentMapping.emptyState || '',
         data: fields.length ? data : {
           headers: EMPTY_ARRAY,

package/es/platform/zlist/adapters/presenters/translators/ColumnTranslator.js

@@ -42,7 +42,7 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
   });
 
   if (!value && value !== false) {
-    return EmptyViewModel();
+    return EmptyViewModel(name);
   }
 
   if (fieldComponentMapping[name]) {
@@ -53,7 +53,7 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
 
   if (!fieldTranslator) {
     console.error(`Field type ${type} not supported`);
-    return EmptyViewModel();
+    return EmptyViewModel(name);
   }
 
   if (field.type == "LookUp") {

package/es/platform/zlist/adapters/presenters/translators/EmptyViewModel.js

@@ -1,7 +1,8 @@
 import FieldTypes from "../../../../../cc/fields/field/Types";
 
-function EmptyViewModel() {
+function EmptyViewModel(fieldName) {
   return {
+    name: fieldName,
     type: FieldTypes.SingleLineField,
     value: '-'
   };

package/es/platform/zlist/adapters/presenters/translators/Header.js

@@ -3,7 +3,7 @@ import ClientActionsTranslator from "../../../../client-actions/translators/clie
 import { SortOrder } from "../../../../zlist/domain/entities/interfaces/Properties";
 import { i18NProviderUtils } from '@zohodesk/i18n';
 
-function HeaderTranslator(field, actions, context, modifiedWidths, sortBy) {
+function HeaderTranslator(field, actions, context, modifiedWidths, sortBy, records) {
   const {
     id,
     name,
@@ -15,7 +15,8 @@ function HeaderTranslator(field, actions, context, modifiedWidths, sortBy) {
     sort: translateSortBy(field.id, sortBy)
   };
   const transformedActions = ClientActionsTranslator.transform(actions, { ...context,
-    field: newField
+    field: newField,
+    recordsLength: records.length.toString()
   });
   const width = modifiedWidths[name];
   return {

package/es/platform/zlist/adapters/presenters/translators/HeadersTranslator.js

@@ -1,11 +1,12 @@
 import HeaderTranslator from "./Header";
 export default class HeadersTranslator {
-  constructor(fields, actions, context, modifiedWidths, sortBy) {
+  constructor(fields, actions, context, modifiedWidths, sortBy, records) {
     this.fields = fields;
     this.actions = actions;
     this.context = context;
     this.modifiedWidths = modifiedWidths;
     this.sortBy = sortBy;
+    this.records = records;
     this.pipe = this.pipe.bind(this);
   }
 
@@ -14,7 +15,7 @@ export default class HeadersTranslator {
       return [];
     }
 
-    return this.fields.map(field => HeaderTranslator(field, this.actions, this.context, this.modifiedWidths, this.sortBy));
+    return this.fields.map(field => HeaderTranslator(field, this.actions, this.context, this.modifiedWidths, this.sortBy, this.records));
   }
 
   pipe(viewModel) {

package/es/platform/zlist/adapters/presenters/translators/fields/CurrencyFieldTranslator.js

@@ -10,6 +10,7 @@ const CurrencyFieldTranslator = (field, value, appendToActionPayload) => {
     uiType: uiType || FieldTypes.CurrencyField,
     appendToActionPayload,
     name,
+    currencyLocale: "INR",
     value
   });
 };

package/es/platform/zlist/adapters/presenters/translators/fields/FormulaFieldTranslator.js

@@ -19,6 +19,9 @@ const FormulaFieldTranslator = (field, value, appendToActionPayload) => {
     uiType: uiType || setFieldType,
     appendToActionPayload,
     name,
+    ...(setFieldType === FieldTypes.CurrencyField && {
+      currencyLocale: "INR"
+    }),
     value
   });
 };

package/es/platform/zlist/applications/entities-factory/ListFactory.js

@@ -7,9 +7,10 @@ class ListFactory {
       sortBy,
       query,
       context,
-      errorRecordFailed
+      errorState,
+      isReOrderLoading
     } = input;
-    return new List(limit, sortBy, query, context, errorRecordFailed);
+    return new List(limit, sortBy, query, context, isReOrderLoading, errorState);
   }
 
 }

package/es/platform/zlist/applications/usecases/FetchMoreUseCase.js

@@ -10,7 +10,7 @@ class FetchMoreUseCase extends AbstractUseCase {
     } = this.dependencies;
     const list = repository.getList();
 
-    if (!list.getErrorRecordFailed()) {
+    if (!list.hasFetchingFailedInMoreRecords()) {
       dispatch(list.createMoreRecordFetchAction());
     }
   }

package/es/platform/zlist/applications/usecases/RecordExecuteFailedUseCase.js

@@ -1,4 +1,4 @@
-import AbstractUseCase from "./AbstractUseCase";
+import AbstractUseCase from "./AbstractUseCase"; // TODO Rename this file to ApiFailedHandleUseCase.ts
 
 class RecordExecuteFailedUseCase extends AbstractUseCase {
   execute(input) {
@@ -12,8 +12,9 @@ class RecordExecuteFailedUseCase extends AbstractUseCase {
       presenter
     } = this.dependencies;
     const list = repository.getList();
-    const actions = list.getRecordExecuteFailedActions(payload, metaData);
+    list.processApiError(payload, metaData);
     presenter.updateView(list.toObject());
+    const actions = list.generateApiErrorEvent(payload, metaData);
     actions.forEach(action => {
       dispatch(action);
     });