@zohodesk/library-platform 1.1.12 → 1.1.13

package/es/platform/zrecord/domain/entities/Filter.js

@@ -0,0 +1,247 @@
+import { CommonComparators, TextComparators, NumberComparators, DateComparators, ConditionTokens } from "../../../../bc/zrecord/Types";
+export class Filter {
+  constructor(config, condition, queryString) {
+    this.config = config;
+    this.condition = condition;
+    this.queryString = queryString;
+  }
+
+  getFilterQuery() {
+    return this.queryString;
+  }
+
+  getConfig() {
+    return this.config;
+  }
+
+  getCondition() {
+    return this.condition;
+  }
+
+  toObject() {
+    return {
+      config: this.config,
+      condition: this.condition,
+      queryString: this.queryString
+    };
+  }
+
+  setConfig(config) {
+    const condition = this.convertConfigToCondition(config);
+    const queryString = this.convertConditionToQueryStringRecursive(condition);
+    this.config = config;
+    this.condition = condition;
+    this.queryString = queryString;
+  }
+  /**
+   * input:
+   *  {
+   *    conditions: [
+   *      { fieldName: 'productCode', condition: "isn't", value: '12345' },
+   *      { fieldName: 'quantity', condition: 'is', value: 100 },
+   *      { fieldName: 'category', condition: 'contains', value: 'electronics' },
+   *      { fieldName: 'discount', condition: 'is not empty', value: null }
+   *    ],
+   *    pattern: "((1and2)or(3and4))"
+   *  }
+   *
+   * output:
+   *  {
+   *    type: 'OR',
+   *    conditions: [
+   *      {
+   *        type: 'AND',
+   *        conditions: [
+   *          { type: 'CONDITION', fieldName: 'productCode', condition: "isn't", value: '12345' },
+   *          { type: 'CONDITION', fieldName: 'quantity', condition: 'is', value: 100 }
+   *        ]
+   *      },
+   *      {
+   *        type: 'AND',
+   *        conditions: [
+   *          { type: 'CONDITION', fieldName: 'category', condition: 'contains', value: 'electronics' },
+   *          { type: 'CONDITION', fieldName: 'discount', condition: 'is not empty', value: null }
+   *        ]
+   *      }
+   *    ]
+   *  }
+   */
+
+
+  convertConfigToCondition(config) {
+    const {
+      conditions,
+      pattern
+    } = config;
+
+    if (conditions.length === 0 || pattern.trim() === '') {
+      return null;
+    } // Tokenize the pattern
+
+
+    const tokens = this.tokenizePattern(pattern);
+    const aliases = this.generateAliases(conditions);
+    let pos = 0;
+
+    const parseExpression = () => {
+      if (tokens[pos] === '(') {
+        pos++; // skip '('
+
+        const left = parseExpression();
+
+        if (pos < tokens.length && tokens[pos] === ')') {
+          pos++; // skip ')'
+
+          return left;
+        }
+
+        const operator = tokens[pos];
+        pos++; // skip operator
+
+        const right = parseExpression();
+
+        if (tokens[pos] === ')') {
+          pos++; // skip ')'
+        }
+
+        return {
+          type: operator === 'AND' ? ConditionTokens.AND : ConditionTokens.OR,
+          conditions: [left, right]
+        };
+      } else if (/^\d+$/.test(tokens[pos])) {
+        const alias = tokens[pos];
+        pos++;
+        return aliases[alias];
+      }
+
+      throw new Error('Invalid pattern');
+    };
+
+    return parseExpression();
+  } // Helper method to tokenize the pattern string (e.g. "(1and2)")
+
+
+  tokenizePattern(pattern) {
+    return pattern.replace(/\(/g, ' ( ').replace(/\)/g, ' ) ').replace(/and/g, ' AND ').replace(/or/g, ' OR ').replace(/not/g, ' NOT ').split(/\s+/).filter(token => token.length > 0);
+  } // Helper method to create aliases for the conditions (e.g. "1", "2")
+
+
+  generateAliases(conditions) {
+    const aliases = {};
+    conditions.forEach((condition, index) => {
+      const alias = String(index + 1); // Starting with "1"
+
+      aliases[alias] = {
+        type: ConditionTokens.CONDITION,
+        fieldName: condition.fieldName,
+        condition: condition.condition,
+        value: condition.value
+      };
+    });
+    return aliases;
+  }
+  /**
+   * input:
+   *  {
+   *    type: 'OR',
+   *    conditions: [
+   *      {
+   *        type: 'AND',
+   *        conditions: [
+   *          { type: 'CONDITION', fieldName: 'productCode', condition: "isn't", value: '12345' },
+   *          { type: 'CONDITION', fieldName: 'quantity', condition: 'is', value: 100 }
+   *        ]
+   *      },
+   *      {
+   *        type: 'AND',
+   *        conditions: [
+   *          { type: 'CONDITION', fieldName: 'category', condition: 'contains', value: 'electronics' },
+   *          { type: 'CONDITION', fieldName: 'discount', condition: 'is not empty', value: null }
+   *        ]
+   *      }
+   *    ]
+   *  }
+   *
+   * output:
+   *  "((productCode != 12345 AND quantity = 100) OR (category.contains('electronics') AND discount.isNotEmpty()))"
+   */
+
+
+  convertConditionToQueryStringRecursive(condition) {
+    if (!condition) {
+      return '';
+    }
+
+    if (condition.type === ConditionTokens.CONDITION) {
+      const {
+        fieldName,
+        condition: comp,
+        value
+      } = condition;
+
+      switch (comp) {
+        case CommonComparators.ISEMPTY:
+          return `${fieldName}.isEmpty()`;
+
+        case CommonComparators.ISNOTEMPTY:
+          return `${fieldName}.isNotEmpty()`;
+
+        case TextComparators.IS:
+          return `${fieldName} = '${value}'`;
+
+        case TextComparators.ISNT:
+          return `${fieldName} != '${value}'`;
+
+        case TextComparators.STARTSWITH:
+          return `${fieldName}.startsWith('${value}')`;
+
+        case TextComparators.ENDSWITH:
+          return `${fieldName}.endsWith('${value}')`;
+
+        case TextComparators.CONTAINS:
+          return `${fieldName}.contains('${value}')`;
+
+        case TextComparators.DOESNTCONTAIN:
+          return `!${fieldName}.contains('${value}')`;
+
+        case NumberComparators.EQUAL:
+          return `${fieldName} = ${value}`;
+
+        case NumberComparators.NOTEQUAL:
+          return `${fieldName} != ${value}`;
+
+        case NumberComparators.LESSTHAN:
+          return `${fieldName} < ${value}`;
+
+        case NumberComparators.LESSTHANEQUAL:
+          return `${fieldName} <= ${value}`;
+
+        case NumberComparators.GREATERTHAN:
+          return `${fieldName} > ${value}`;
+
+        case NumberComparators.GREATERTHANEQUAL:
+          return `${fieldName} >= ${value}`;
+
+        case DateComparators.ISAFTER:
+          return `${fieldName} > '${value}'`;
+
+        case DateComparators.ISBEFORE:
+          return `${fieldName} < '${value}'`;
+
+        case DateComparators.BETWEEN:
+          return `${fieldName}.between('${value.start}', '${value.end}')`;
+
+        case DateComparators.NOTBETWEEN:
+          return `!${fieldName}.between('${value.start}', '${value.end}')`;
+
+        default:
+          return '';
+      }
+    } else {
+      const operator = condition.type === ConditionTokens.AND ? ' AND ' : ' OR ';
+      const parts = condition.conditions.map(c => this.convertConditionToQueryStringRecursive(c));
+      return `(${parts.join(operator)})`;
+    }
+  }
+
+}

package/es/platform/zrecord/domain/entities/RecordsManager.js

@@ -14,11 +14,18 @@ const recordExecuteStrategiesMap = {
   [RecordApiActionName.GET_REORDERRECORD]: new GetReOrderRecordsStrategy()
 };
 export default class RecordsManager {
-  constructor(records) {
+  constructor(records, filter, isLocalSearchEnabled) {
     this.records = records;
+    this.filter = filter;
+    this.isLocalSearchEnabled = isLocalSearchEnabled;
+    this.isLocalSearchEnabled = false;
   }
 
   createDataSourceExecuteEvent(props, actionName, metaData) {
+    if (actionName === RecordApiActionName.GET_RECORDS && props.filter === undefined) {
+      props.filter = this.filter.getFilterQuery();
+    }
+
     return {
       type: DATA_SOURCE_EXECUTE,
       payload: {
@@ -249,6 +256,18 @@ export default class RecordsManager {
     this.records.updateRecord(recordId, record);
   }
 
+  getFilterCondition() {
+    return this.filter.getCondition();
+  }
+
+  getFilterConfig() {
+    return this.filter.getConfig();
+  }
+
+  setFilterConfig(filterConfig) {
+    this.filter.setConfig(filterConfig);
+  }
+
   deleteMultipleRecord(recordIds) {
     this.records.deleteMultipleRecord(recordIds);
   }
@@ -257,9 +276,32 @@ export default class RecordsManager {
     return apiName === 'records';
   }
 
+  filterRecordsLocal(queryString, records) {
+    let filteredRecords = records;
+    const regex = /contains\(\s*['"]([^'"]*)['"]\s*\)/;
+    const match = queryString.match(regex);
+    const keyword = match[1];
+
+    if (keyword.trim().length > 0) {
+      const key = keyword.toLowerCase();
+      filteredRecords = filteredRecords.filter(record => Object.values(record).some(v => String(v ?? "").toLowerCase().includes(key)));
+    }
+
+    return filteredRecords;
+  }
+
+  setIsLocalSearchEnabled(isEnabled) {
+    this.isLocalSearchEnabled = isEnabled;
+  }
+
   toObject() {
     const recordsObj = this.records.toObject();
+    const queryString = this.filter.toObject().queryString;
+    const localRecordsObj = queryString.length > 0 ? this.filterRecordsLocal(queryString, recordsObj.data) : recordsObj.data;
     return {
+      filter: this.filter.toObject(),
+      localRecords: localRecordsObj,
+      isLocalSearchEnabled: this.isLocalSearchEnabled,
       records: recordsObj.data,
       hasMore: recordsObj.hasMore,
       isFetching: recordsObj.isFetching

package/es/platform/zrecord/domain/entities/interfaces/IFilter.js

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

package/es/platform/zrecord/frameworks/ActionsHandlersFactory.js

@@ -1,5 +1,5 @@
 /* eslint-disable max-lines-per-function */
-import { APPEND_RECORDS, RECORD_EXECUTE, RECORD_FETCH_MORE, RECORD_FIELD_CHANGE, RECORD_LOCAL_MULTIPLE_DELETE, RECORD_LOCAL_UPDATE, SET_RECORDS, RECORD_REFETCH, RECORD_EXECUTE_SUCCEEDED, RECORD_EXECUTE_SUCCEEDED_NO_CONTENT, RECORD_EXECUTE_FAILED, RECORD_EXECUTE_SUCCESS_NO_CONTENT_CALLBACK, RECORD_EXECUTE_SUCCESS_CALLBACK, RECORD_EXECUTE_FAIL_CALLBACK, CREATE_RECORD, RECORD_MARK_AS_READ, RECORD_MARK_AS_UNREAD } from "../../../bc/zrecord/Constants";
+import { APPEND_RECORDS, RECORD_EXECUTE, RECORD_FETCH_MORE, RECORD_FIELD_CHANGE, RECORD_LOCAL_MULTIPLE_DELETE, RECORD_LOCAL_UPDATE, SET_RECORDS, RECORD_REFETCH, RECORD_EXECUTE_SUCCEEDED, RECORD_EXECUTE_SUCCEEDED_NO_CONTENT, RECORD_EXECUTE_FAILED, RECORD_EXECUTE_SUCCESS_NO_CONTENT_CALLBACK, RECORD_EXECUTE_SUCCESS_CALLBACK, RECORD_EXECUTE_FAIL_CALLBACK, CREATE_RECORD, RECORD_MARK_AS_READ, RECORD_MARK_AS_UNREAD, RECORD_LOCAL_FILTER } from "../../../bc/zrecord/Constants";
 import MountController from "../adapters/controllers/MountController";
 import Presenter from "../adapters/presenters/Presenter";
 import Repository from "../adapters/gateways/Repository";
@@ -19,6 +19,7 @@ import FetchStateStopController from "../adapters/controllers/FetchStateStopCont
 import CreateRecordController from "../adapters/controllers/CreateRecordController";
 import MarkAsReadController from "../adapters/controllers/MarkAsReadController";
 import MarkAsUnReadController from "../adapters/controllers/MarkAsUnReadController";
+import FilterRecordLocalController from "../adapters/controllers/FilterRecordLocalController";
 export default class ActionsHandlersFactory {
   static create(apiDetails) {
     const presenter = new Presenter();
@@ -44,6 +45,7 @@ export default class ActionsHandlersFactory {
     const createRecordController = new CreateRecordController(service);
     const markAsReadController = new MarkAsReadController(service);
     const markAsUnReadController = new MarkAsUnReadController(service);
+    const filterRecordLocalController = new FilterRecordLocalController(service);
     return {
       MOUNT: mountController.handle,
       [RECORD_MARK_AS_READ]: markAsReadController.handle,
@@ -62,6 +64,7 @@ export default class ActionsHandlersFactory {
       [RECORD_FIELD_CHANGE]: fieldChangeController.handle,
       [RECORD_LOCAL_UPDATE]: recordUpdateLocalController.handle,
       [RECORD_EXECUTE_SUCCESS_NO_CONTENT_CALLBACK]: noContentController.handle,
+      [RECORD_LOCAL_FILTER]: filterRecordLocalController.handle,
       [CREATE_RECORD]: createRecordController.handle
     };
   }

package/es/platform/zrecord/frameworks/RecordBehaviourFactory.js

@@ -1,11 +1,21 @@
 import ActionsHandlersFactory from "./ActionsHandlersFactory";
+import { initialFilterConfig } from "../../../bc/zrecord/Types";
 export default class RecordBehaviourFactory {
   static create(apiDetails) {
     return {
       name: 'zrecord',
       eventHandlers: ActionsHandlersFactory.create(apiDetails),
       properties: {},
-      setInitialState: () => ({})
+      setInitialState: () => {
+        const filterRestoreObjectInitial = {
+          config: initialFilterConfig,
+          condition: null,
+          queryString: ''
+        };
+        return {
+          filter: filterRestoreObjectInitial
+        };
+      }
     };
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/library-platform",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "",
   "main": "es/index.js",
   "files": [
@@ -42,23 +42,23 @@
     "@typescript-eslint/parser": "^7.11.0",
     "@zoho/SecurityJS": "7.2.4",
     "@zohodesk-private/css-variable-migrator": "^1.0.8",
-    "@zohodesk-private/desk-components": "1.3.16",
+    "@zohodesk-private/desk-components": "1.4.7",
     "@zohodesk-private/dot-registry": "0.0.2",
     "@zohodesk-private/node-plugins": "1.1.9",
-    "@zohodesk/a11y": "2.3.6",
+    "@zohodesk/a11y": "2.3.8",
     "@zohodesk/codestandard-analytics": "1.0.2",
     "@zohodesk/codestandard-validator": "1.0.0",
-    "@zohodesk/components": "1.4.18",
-    "@zohodesk/dot": "1.7.17",
-    "@zohodesk/dotkit": "1.0.3",
+    "@zohodesk/components": "1.5.8",
+    "@zohodesk/dot": "1.8.6",
+    "@zohodesk/dotkit": "1.0.7",
     "@zohodesk/eslint-plugin-architecturerules": "0.0.6-exp-4",
     "@zohodesk/eslint-plugin-no-hardcoding": "1.0.6-platform-1",
-    "@zohodesk/hooks": "2.0.5",
-    "@zohodesk/icons": "1.1.0",
+    "@zohodesk/hooks": "2.0.6",
+    "@zohodesk/icons": "1.1.5",
     "@zohodesk/layout": "3.1.0",
-    "@zohodesk/svg": "1.2.1",
-    "@zohodesk/utils": "1.3.15",
-    "@zohodesk/variables": "1.1.0",
+    "@zohodesk/svg": "1.2.6",
+    "@zohodesk/utils": "1.3.16",
+    "@zohodesk/variables": "1.2.0",
     "@zohodesk/virtualizer": "1.0.13",
     "babel-jest": "29.7.0",
     "color": "4.2.3",
@@ -77,17 +77,18 @@
     "typescript": "4.9.5"
   },
   "peerDependencies": {
-    "@zohodesk-private/desk-components": "1.3.16",
+    "@zoho/SecurityJS": "7.2.4",
+    "@zohodesk-private/desk-components": "1.4.7",
     "@zohodesk-private/dot-registry": "0.0.2",
-    "@zohodesk/a11y": "2.3.6",
-    "@zohodesk/components": "1.4.18",
-    "@zohodesk/dot": "1.7.17",
-    "@zohodesk/dotkit": "1.0.3",
-    "@zohodesk/hooks": "2.0.5",
+    "@zohodesk/a11y": "2.3.8",
+    "@zohodesk/components": "1.5.8",
+    "@zohodesk/dot": "1.8.6",
+    "@zohodesk/dotkit": "1.0.7",
+    "@zohodesk/hooks": "2.0.6",
     "@zohodesk/i18n": "1.0.0-beta.31",
-    "@zohodesk/icons": "1.1.0",
+    "@zohodesk/icons": "1.1.5",
     "@zohodesk/layout": "3.1.0",
-    "@zohodesk/svg": "1.2.1",
+    "@zohodesk/svg": "1.2.6",
     "@zohodesk/utils": "1.3.15",
     "color": "4.2.3",
     "react-sortable-hoc": "1.11.0"

package/es/bc/sort-by/SortOrderEnum.js

@@ -1,8 +0,0 @@
-var SortOrder = /*#__PURE__*/function (SortOrder) {
-  SortOrder["NONE"] = "none";
-  SortOrder["ASC"] = "ascending";
-  SortOrder["DES"] = "descending";
-  return SortOrder;
-}(SortOrder || {});
-
-export default SortOrder;

package/es/library/behaviours/sort-by/frameworks/ui/DemoBehaviour.js

@@ -1,20 +0,0 @@
-import Properties from "../../../../../bc/sort-by/Properties";
-
-// REVIEW: Class never used
-class DemoBehaviour {
-  static create() {
-    return {
-      name: 'demo_behaviour',
-      setInitialState: () => ({}),
-      properties: Properties,
-      eventHandlers: {
-        "DEMO": () => {
-          alert('demo');
-        }
-      }
-    };
-  }
-
-}
-
-export default DemoBehaviour;

package/es/library/dot/components/table-list/adapters/controllers/SortByController.js

@@ -1,25 +0,0 @@
-import { SORTBY_SORT } from "../../../../../../bc/sort-by/Constants";
-import AbstractController from "./AbstractController";
-
-class SortByController extends AbstractController {
-  handle(event) {
-    const {
-      dispatch,
-      action
-    } = event;
-    const {
-      id,
-      name
-    } = action.payload;
-    dispatch({
-      type: SORTBY_SORT,
-      payload: {
-        id,
-        name
-      }
-    });
-  }
-
-}
-
-export default SortByController;

package/es/library/dot/components/table-list/adapters/controllers/SortedController.js

@@ -1,18 +0,0 @@
-import { ZLIST_FETCH_SORTED } from "../../../../../../bc/zlist/Constants";
-import AbstractController from "./AbstractController";
-
-class SortedController extends AbstractController {
-  handle(event) {
-    const {
-      action,
-      dispatch
-    } = event;
-    dispatch({
-      type: ZLIST_FETCH_SORTED,
-      payload: action.payload
-    });
-  }
-
-}
-
-export default SortedController;

package/es/library/dot/components/table-list/frameworks/ui/handlers/HandleSortClick.js

@@ -1,12 +0,0 @@
-import { TableListConstants } from "../../../../../../../cc";
-export default function handleSortClick(dispatch, _ref) {
-  let {
-    id
-  } = _ref;
-  dispatch({
-    type: TableListConstants.TABLE_LIST_SORTED,
-    payload: {
-      id
-    }
-  });
-}

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

@@ -1,38 +0,0 @@
-import SortOrder from "../../../../bc/sort-by/SortOrderEnum";
-
-class SortBy {
-  toQueryString(sortBy) {
-    const {
-      name,
-      order
-    } = sortBy;
-    let sortQueryString = '';
-
-    if (order === SortOrder.ASC) {
-      sortQueryString = name;
-    } else if (order === SortOrder.DES) {
-      sortQueryString = `-${name}`;
-    }
-
-    return sortQueryString;
-  }
-
-  toObject(sortBy) {
-    let sortByParsed = sortBy.split('-');
-
-    if (sortByParsed[0] === '-') {
-      return {
-        name: sortByParsed[1],
-        order: SortOrder.DES
-      };
-    } else {
-      return {
-        name: sortByParsed[0],
-        order: SortOrder.ASC
-      };
-    }
-  }
-
-}
-
-export default SortBy;

package/es/platform/zlist/domain/entities/SortBy.js

@@ -1,58 +0,0 @@
-import { SortOrder } from "./interfaces/Properties";
-
-class SortBy {
-  constructor(id, name, order) {
-    this.id = id;
-    this.name = name;
-    this.order = order;
-  }
-
-  toObject() {
-    return {
-      id: this.id,
-      name: this.name,
-      order: this.order
-    };
-  }
-
-  toQueryString() {
-    const {
-      name,
-      order
-    } = this;
-    let sortQueryString = '';
-
-    if (order === SortOrder.DES) {
-      sortQueryString = `-${name}`;
-    } else if (order === SortOrder.ASC) {
-      sortQueryString = name;
-    }
-
-    return sortQueryString;
-  }
-
-  doSorting(id, name) {
-    if (this.id === id) {
-      this.toggleSort();
-    } else {
-      this.resetSortBy(id, name);
-    }
-  }
-
-  toggleSort() {
-    if (this.order === SortOrder.ASC) {
-      this.order = SortOrder.DES;
-    } else {
-      this.order = SortOrder.ASC;
-    }
-  }
-
-  resetSortBy(id, name) {
-    this.id = id;
-    this.name = name;
-    this.order = SortOrder.ASC;
-  }
-
-}
-
-export default SortBy;