@zohodesk/library-platform 1.1.0-exp.1 → 1.1.0

package/README.md

@@ -21,7 +21,7 @@ import TableConnectedFactory from '@zohodesk/library-platform/TableConnectedFact
 
 const myTableComponent = TableConnectedFactory.create({
   name: 'MyTableComponent',
-  dataBroker: myDataBroker,
+  dataSource: myDataSource,
   eventHandlers: {
     onRowSelect: row => {
       console.log('Selected row:', row);
@@ -69,7 +69,7 @@ const myComponent = ComponentRegistry.get('MyComponent');
 The `TableConnectedFactory.create` method accepts the following parameters:
 
 - **name**: `string` - The name of the component.
-- **dataBroker**: `object` - The data broker instance to manage data fetching and manipulation.
+- **dataSource**: `object` - The data broker instance to manage data fetching and manipulation.
 - **eventHandlers**: `object` - An object containing event handler functions.
 - **View**: `React.Component` - Custom view component to render the table.
 

package/es/bc/{zdata-broker → zdata-source}/Actions.js

@@ -1,7 +1,7 @@
-import { DATA_BROKER_EXECUTE } from "./Constants";
-import { DATA_BROKER_FAILURE, DATA_BROKER_SUCCESS } from "./Symbols";
+import { DATA_SOURCE_EXECUTE } from "./Constants";
+import { DATA_SOURCE_FAILURE, DATA_SOURCE_SUCCESS } from "./Symbols";
 const Actions = [{
-  type: DATA_BROKER_EXECUTE,
+  type: DATA_SOURCE_EXECUTE,
   payload: {
     apiName: {
       name: 'apiName',
@@ -34,7 +34,7 @@ const Actions = [{
       schema: {
         type: 'object',
         properties: {
-          [DATA_BROKER_SUCCESS]: {
+          [DATA_SOURCE_SUCCESS]: {
             type: 'object',
             properties: {
               type: {
@@ -46,7 +46,7 @@ const Actions = [{
             },
             required: ['type', 'payload']
           },
-          [DATA_BROKER_FAILURE]: {
+          [DATA_SOURCE_FAILURE]: {
             type: 'object',
             properties: {
               type: {
@@ -59,7 +59,7 @@ const Actions = [{
             required: ['type', 'payload']
           }
         },
-        required: [DATA_BROKER_SUCCESS, DATA_BROKER_FAILURE]
+        required: [DATA_SOURCE_SUCCESS, DATA_SOURCE_FAILURE]
       }
     }
   }

package/es/bc/{zdata-broker → zdata-source}/Constants.js

@@ -1,10 +1,11 @@
 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 const DATA_BROKER_REGISTER = 'DATA_BROKER#REGISTER';
-export const DATA_BROKER_EXECUTE = 'DATA_BROKER#EXECUTE';
-export const DATA_BROKER_EXECUTE_SUCCEEDED = 'DATA_BROKER#EXECUTE_SUCCEEDED';
-export const DATA_BROKER_EXECUTE_NO_CONTENT_SUCCEEDED = 'DATA_BROKER#EXECUTE_NO_CONTENT_SUCCEEDED';
-export const DATA_BROKER_EXECUTE_FAILED = 'DATA_BROKER#EXECUTE_FAILED';
+export const DATA_SOURCE_REGISTER = 'DATA_SOURCE#REGISTER';
+export const DATA_SOURCE_EXECUTE = 'DATA_SOURCE#EXECUTE';
+export const DATA_SOURCE_EXECUTE_SUCCEEDED = 'DATA_SOURCE#EXECUTE_SUCCEEDED';
+export const DATA_SOURCE_EXECUTE_NO_CONTENT_SUCCEEDED = 'DATA_SOURCE#EXECUTE_NO_CONTENT_SUCCEEDED';
+export const DATA_SOURCE_EXECUTE_FAILED = 'DATA_SOURCE#EXECUTE_FAILED'; // REVIEW: This class is not used anywhere in the codebase.
+
 export class DataBrokerActionName {}
 
 _defineProperty(DataBrokerActionName, "GET_RECORDS", 'getRecords');

package/es/bc/zdata-source/EventHandlers.js

@@ -0,0 +1,2 @@
+import { DATA_SOURCE_EXECUTE, DATA_SOURCE_REGISTER } from "./Constants";
+import { FETCH_FAILED, FETCH_SUCCESS, FETCH_SUCCESS_NO_CONTENT } from "../zhttp/Constants";

package/es/bc/zdata-source/Symbols.js

@@ -0,0 +1,5 @@
+// Note: We need to properly handle uniqueness, because it is not api response
+export const DATA_SOURCE_SIGNATURE = 'DATA_SOURCE#SIGNATURE';
+export const DATA_SOURCE_FAILURE = 'DATA_SOURCE#FAILURE';
+export const DATA_SOURCE_SUCCESS = 'DATA_SOURCE#SUCCESS';
+export const DATA_SOURCE_NO_CONTENT = 'DATA_SOURCE#NO_CONTENT';

package/es/bc/zfield/ActionHandlers.js

@@ -1,2 +1,2 @@
 import { FIELD_EXECUTE, FIELD_REFETCH } from "./Constants";
-import { DATA_BROKER_EXECUTE_FAILED, DATA_BROKER_EXECUTE_NO_CONTENT_SUCCEEDED, DATA_BROKER_EXECUTE_SUCCEEDED } from "../zdata-broker/Constants";
+import { DATA_SOURCE_EXECUTE_FAILED, DATA_SOURCE_EXECUTE_NO_CONTENT_SUCCEEDED, DATA_SOURCE_EXECUTE_SUCCEEDED } from "../zdata-source/Constants";

package/es/bc/zlist/EventHandlers.js

@@ -1 +1 @@
-import { ZLIST_FETCH_MORE } from "./Constants";
+import { ZLIST_FETCH_MORE, ZLIST_RECORD_DELETE_SUCCEEDED, ZLIST_RECORD_UPDATE_SUCCEEDED } from "./Constants";

package/es/bc/zlist/Properties.js

@@ -7,47 +7,43 @@ export default {
       }
     }
   },
-  filter: {
+  departmentId: {
     required: true,
     typeMetadata: {
       schema: {
-        type: 'object',
-        properties: {
-          viewId: {
-            type: 'string'
-          },
-          orgId: {
-            type: 'string'
-          },
-          departmentId: {
-            type: 'string'
-          }
-        },
-        additionalProperties: {
-          type: 'string'
-        }
+        type: 'string'
       }
     }
   },
-  pageContext: {
+  viewId: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  },
+  context: {
     required: true,
     typeMetadata: {
       schema: {
         type: 'object',
         properties: {
+          orgId: {
+            type: 'string'
+          },
           orgName: {
             type: 'string'
           },
           departmentName: {
             type: 'string'
           },
-          moduleSanitatedName: {
+          servicePrefix: {
             type: 'string'
           }
         },
-        additionalProperties: {
-          type: 'string'
-        }
+        required: ['orgId', 'orgName', 'departmentName'],
+        additionalProperties: false
       }
     }
   },
@@ -66,14 +62,5 @@ export default {
         }]
       }
     }
-  },
-  limit: {
-    required: false,
-    defaultValue: 50,
-    typeMetadata: {
-      schema: {
-        type: 'number'
-      }
-    }
   }
 };

package/es/bc/zrecord/Constants.js

@@ -22,4 +22,6 @@ _defineProperty(RecordApiActionName, "DELETE_RECORDS", 'deleteRecords');
 
 _defineProperty(RecordApiActionName, "DELETE_RECORD", 'deleteRecord');
 
-_defineProperty(RecordApiActionName, "UPDATE_RECORD", 'updateRecord');
+_defineProperty(RecordApiActionName, "UPDATE_RECORD", 'updateRecord');
+
+_defineProperty(RecordApiActionName, "GET_CLIENTACTIONS", 'getClientActions');

package/es/cc/action-icon/Properties.js

@@ -34,6 +34,37 @@ export default {
       }
     }
   },
+  options: {
+    // NOTE: This is only a sample for FilterDropdown action component
+    required: false,
+    defaultValue: [],
+    typeMetadata: {
+      schema: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            label: {
+              type: "string"
+            },
+            value: {
+              type: "string"
+            }
+          }
+        }
+      }
+    }
+  },
+  isMultiselectable: {
+    // NOTE: This is only a sample for FilterDropdown action component
+    required: false,
+    defaultValue: false,
+    typeMetadata: {
+      schema: {
+        type: "boolean"
+      }
+    }
+  },
   isVisible: {
     required: false,
     defaultValue: true,

package/es/cc/action-location/Properties.js

@@ -4,7 +4,10 @@ export const actionsSchema = {
   items: {
     type: 'object',
     properties: {
-      type: {
+      component: {
+        type: 'string'
+      },
+      id: {
         type: 'string'
       },
       properties: {
@@ -16,42 +19,24 @@ export const actionsSchema = {
         items: {
           type: 'object',
           properties: {
-            action: {
-              type: 'object',
-              properties: {
-                id: {
-                  type: 'string'
-                },
-                dispatchType: {
-                  type: 'string'
-                }
-              },
-              required: ['id', 'dispatchType']
+            id: {
+              type: 'string'
             },
-            eventType: {
+            sourceEvent: {
               type: 'string'
             },
             payload: {
               type: 'object'
             }
           },
-          required: ['action', 'payload', 'eventType']
+          required: ['sourceEvent', 'id']
         }
       }
     },
-    required: ['type', 'properties']
+    required: ['component', 'properties']
   }
 };
 export default {
-  type: {
-    required: false,
-    typeMetadata: {
-      schema: {
-        type: 'string'
-      }
-    },
-    defaultValue: ''
-  },
   actions: {
     required: true,
     typeMetadata: {

package/es/cc/table-connected/Constants.js

@@ -0,0 +1,4 @@
+export const SMART_TABLE_EVENTS = {
+  DELETE_RECORDS_SUCCESS: 'SMART_TABLE#RECORD_DELETED',
+  UPDATE_RECORDS_SUCCESS: 'SMART_TABLE#RECORD_UPDATED'
+};

package/es/cc/table-connected/Properties.js

@@ -1,16 +1,23 @@
 import SelectionConfigSchema from "../../bc/list-selection/Properties";
 export default {
-  isFlexibleColumns: {
+  preferences: {
     required: false,
-    defaultValue: false,
+    defaultValue: {
+      autoColumnSizing: false
+    },
     typeMetadata: {
       schema: {
-        type: 'boolean'
+        type: 'object',
+        properties: {
+          autoColumnSizing: {
+            type: 'boolean'
+          }
+        }
       }
     }
   },
   ...SelectionConfigSchema,
-  uiMapping: {
+  componentMapping: {
     required: false,
     defaultValue: {
       fields: {},
@@ -23,6 +30,9 @@ export default {
           fields: {
             type: 'object'
           },
+          rowActionsComponentName: {
+            type: 'string'
+          },
           emptyState: {
             type: 'string'
           }
@@ -37,58 +47,5 @@ export default {
         type: 'string'
       }
     }
-  },
-  rowActions: {
-    required: false,
-    defaultValue: [],
-    typeMetadata: {
-      schema: {
-        type: 'array',
-        minItems: 0,
-        items: {
-          type: 'object',
-          properties: {
-            uiType: {
-              type: 'string'
-            },
-            properties: {
-              type: 'object'
-            },
-            eventMappings: {
-              type: 'array',
-              minItems: 0,
-              items: {
-                type: 'object',
-                properties: {
-                  id: {
-                    type: 'string'
-                  },
-                  action: {
-                    type: 'object',
-                    properties: {
-                      id: {
-                        type: 'string'
-                      },
-                      dispatchType: {
-                        type: 'string'
-                      }
-                    },
-                    required: ['id', 'dispatchType']
-                  },
-                  eventType: {
-                    type: 'string'
-                  },
-                  payloadMapping: {
-                    type: 'string'
-                  }
-                },
-                required: ['id', 'action', 'payloadMapping', 'eventType']
-              }
-            }
-          },
-          required: ['uiType', 'properties']
-        }
-      }
-    }
   }
 };

package/es/cc/table-list/Properties.js

@@ -1,5 +1,7 @@
+import { Alignment, SortedBy, Width } from "./data-types/Header";
+import RowCursor from "./data-types/RowCursor";
 import ResizerConfigSchema from "../../bc/table-column-resizer/Properties";
-import { actionsSchema } from "../action-location/Properties";
+import { actionsSchema } from "../../platform/client-actions/cc/action-event-mediator/Properties";
 import PropertiesConverter from "../component/properties/PropertiesConverter";
 import BooleanProperties from "../fields/boolean/Properties";
 import CurrencyProperties from "../fields/currency/Properties";
@@ -34,12 +36,24 @@ const TableListProperties = {
     },
     defaultValue: ''
   },
-  hasRowActions: {
+  rowActionsConfig: {
     required: false,
-    defaultValue: false,
+    defaultValue: {
+      hasActions: false,
+      columnWidth: Width.XSmall
+    },
     typeMetadata: {
       schema: {
-        type: 'boolean'
+        type: 'object',
+        properties: {
+          hasActions: {
+            type: 'boolean'
+          },
+          columnWidth: {
+            type: 'number',
+            enum: Object.values(Width)
+          }
+        }
       }
     }
   },
@@ -52,6 +66,16 @@ const TableListProperties = {
       }
     }
   },
+  rowCursor: {
+    required: false,
+    defaultValue: 'pointer',
+    typeMetadata: {
+      schema: {
+        type: 'string',
+        enum: Object.values(RowCursor)
+      }
+    }
+  },
   resizerConfig: {
     required: false,
     defaultValue: {
@@ -86,20 +110,20 @@ const TableListProperties = {
               text: {
                 type: 'string'
               },
-              size: {
-                type: 'string',
-                enum: ['xsmall', 'small', 'medium', 'large', 'xlarge']
+              width: {
+                type: 'number',
+                enum: Object.values(Width)
               },
               alignment: {
                 type: 'string',
-                enum: ['left', 'center', 'right']
+                enum: Object.values(Alignment)
               },
               sortable: {
                 type: 'boolean'
               },
               sortOrder: {
                 type: 'string',
-                enum: ['none', 'ascending', 'descending']
+                enum: Object.values(SortedBy)
               },
               sortTooltip: {
                 type: 'string'
@@ -123,7 +147,7 @@ const TableListProperties = {
             }]
           },
           ActionLocation: {
-            type: 'object',
+            renderComponentType: 'object',
             properties: {
               type: {
                 type: 'string'

package/es/cc/table-list/data-types/Header.js

@@ -4,17 +4,24 @@ export let SortedBy = /*#__PURE__*/function (SortedBy) {
   SortedBy["Descending"] = "descending";
   return SortedBy;
 }({});
-export let Size = /*#__PURE__*/function (Size) {
-  Size["XSmall"] = "xsmall";
-  Size["Small"] = "small";
-  Size["Medium"] = "medium";
-  Size["Large"] = "large";
-  Size["XLarge"] = "xlarge";
-  return Size;
+export let Width = /*#__PURE__*/function (Width) {
+  Width[Width["XSmall"] = 120] = "XSmall";
+  Width[Width["Small"] = 160] = "Small";
+  Width[Width["Medium"] = 200] = "Medium";
+  Width[Width["Large"] = 240] = "Large";
+  Width[Width["XLarge"] = 280] = "XLarge";
+  Width[Width["XXLarge"] = 320] = "XXLarge";
+  return Width;
 }({});
 export let Alignment = /*#__PURE__*/function (Alignment) {
   Alignment["Left"] = "left";
   Alignment["Center"] = "center";
   Alignment["Right"] = "right";
   return Alignment;
+}({});
+export let AlignmentOfFlex = /*#__PURE__*/function (AlignmentOfFlex) {
+  AlignmentOfFlex["left"] = "start";
+  AlignmentOfFlex["center"] = "center";
+  AlignmentOfFlex["right"] = "end";
+  return AlignmentOfFlex;
 }({});

package/es/cc/table-list/data-types/RowCursor.js

@@ -0,0 +1,8 @@
+var RowCursor = /*#__PURE__*/function (RowCursor) {
+  RowCursor["Default"] = "default";
+  RowCursor["Pointer"] = "pointer";
+  RowCursor["NotAllowed"] = "not-allowed";
+  return RowCursor;
+}(RowCursor || {});
+
+export default RowCursor;

package/es/cc/table-list/row/Properties.js

@@ -1,3 +1,5 @@
+import { Width } from "../data-types/Header";
+import RowCursor from "../data-types/RowCursor";
 const TableRowProperties = {
   isSelectionEnabled: {
     required: false,
@@ -53,6 +55,16 @@ const TableRowProperties = {
       }
     }
   },
+  cursor: {
+    required: false,
+    defaultValue: 'pointer',
+    typeMetadata: {
+      schema: {
+        type: 'string',
+        enum: Object.values(RowCursor)
+      }
+    }
+  },
   rowActionLocation: {
     required: false,
     defaultValue: {},
@@ -71,12 +83,13 @@ const TableRowProperties = {
       }
     }
   },
-  resizedColumnsWidth: {
+  rowActionsColumnWidth: {
     required: false,
-    defaultValue: false,
+    defaultValue: Width.XSmall,
     typeMetadata: {
       schema: {
-        type: 'object'
+        type: 'number',
+        enum: Object.values(Width)
       }
     }
   },

package/es/desk-frameworks/table-connected/frameworks/ListSdkFactory.js

@@ -1,4 +1,5 @@
 import { ZLIST_DELETE_RECORD, ZLIST_DELETE_RECORDS, ZLIST_RECORD_UPDATE } from "../../../bc/zlist/Constants";
+import { RECORD_LOCAL_MULTIPLE_DELETE, RECORD_LOCAL_UPDATE } from "../../../bc/zrecord/Constants";
 /* eslint-disable max-lines-per-function */
 
 export default class ListSdkFactory {
@@ -21,25 +22,84 @@ export default class ListSdkFactory {
           return (_state$behaviours2 = state.behaviours) === null || _state$behaviours2 === void 0 ? void 0 : (_state$behaviours2$zr = _state$behaviours2.zrecord.records) === null || _state$behaviours2$zr === void 0 ? void 0 : _state$behaviours2$zr.find(r => r.id === recordId);
         },
 
+        getContext(variableName) {
+          var _state$properties;
+
+          const {
+            departmentId,
+            viewId,
+            moduleName
+          } = state.properties;
+          const {
+            servicePrefix,
+            ...context
+          } = (_state$properties = state.properties) === null || _state$properties === void 0 ? void 0 : _state$properties.context;
+          const updatedContext = { ...context,
+            departmentId,
+            viewId,
+            moduleName
+          };
+          return variableName ? context === null || context === void 0 ? void 0 : context[variableName] : updatedContext;
+        },
+
         deleteRecord(recordId) {
+          let output = {
+            "data": [{
+              "id": recordId,
+              "Success": true,
+              "error": null
+            }]
+          };
           dispatch({
             type: ZLIST_DELETE_RECORD,
             payload: {
               recordId
             }
           });
+          return output;
         },
 
+        // deleteRecords(recordIds) {
+        //   dispatch({
+        //     type: ZLIST_DELETE_RECORDS,
+        //     payload: {
+        //       recordIds
+        //     }
+        //   });
+        // },
         deleteRecords(recordIds) {
+          let shouldFetch = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+          let output = {
+            "data": []
+          };
+          let DELETE_ACTION = shouldFetch ? ZLIST_DELETE_RECORDS : RECORD_LOCAL_MULTIPLE_DELETE;
           dispatch({
-            type: ZLIST_DELETE_RECORDS,
+            type: DELETE_ACTION,
             payload: {
               recordIds
             }
           });
+
+          for (let recordId of recordIds) {
+            let recordUpdateDetail = {
+              "id": recordId,
+              "Success": true,
+              "error": null
+            };
+            output.data.push(recordUpdateDetail);
+          }
+
+          return output;
         },
 
         updateRecord(recordId, record) {
+          let output = {
+            "results": [{
+              "id": recordId,
+              "Success": true,
+              "error": null
+            }]
+          };
           dispatch({
             type: ZLIST_RECORD_UPDATE,
             payload: {
@@ -47,6 +107,33 @@ export default class ListSdkFactory {
               record
             }
           });
+          return output;
+        },
+
+        updateRecords(recordsMap) {
+          let shouldFetch = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+          let output = {
+            "results": []
+          };
+          let UPDATE_ACTION = shouldFetch ? ZLIST_RECORD_UPDATE : RECORD_LOCAL_UPDATE;
+
+          for (let record of recordsMap) {
+            dispatch({
+              type: UPDATE_ACTION,
+              payload: {
+                recordId: record.id,
+                record: record
+              }
+            });
+            let recordUpdateDetail = {
+              "id": record.id,
+              "Success": true,
+              "error": null
+            };
+            output.results.push(recordUpdateDetail);
+          }
+
+          return output;
         }
 
       }