@zohodesk/library-platform 1.1.0-exp.2 → 1.1.1

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/list-selection/Constants.js

@@ -1,3 +1,10 @@
 export const LIST_SELECTION_TOGGLE_ITEMS = 'LIST_SELECTION#TOGGLE_ITEMS';
 export const LIST_SELECTION_TOGGLE_ALL = 'LIST_SELECTION#TOGGLE_ALL';
-export const LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE = 'LIST_SELECTION#TOGGLE_ITEMS_IN_RANGE';
+export const LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE = 'LIST_SELECTION#TOGGLE_ITEMS_IN_RANGE';
+export const LIST_SELECTION_SELECT_ITEM = 'LIST_SELECTION#SELECT_ITEM';
+export const LIST_SELECTION_DESELECT_ITEM = 'LIST_SELECTION#DESELECT_ITEM';
+export const LIST_SELECTION_SELECT_ALL = 'LIST_SELECTION#SELECT_ALL';
+export const LIST_SELECTION_DESELECT_ALL = 'LIST_SELECTION#DESELECT_ALL';
+export const LIST_SELECTION_RECORDS_SELECTED = 'LIST_SELECTION#RECORDS_SELECTED';
+export const LIST_SELECTION_RECORDS_DESELECTED = 'LIST_SELECTION#RECORDS_DESELECTED';
+export const LIST_SELECTION_SELECTION_LIMIT_EXCEEDED = 'LIST_SELECTION#SELECTION_LIMIT_EXCEEDED';

package/es/bc/list-selection/Properties.js

@@ -2,9 +2,10 @@ export default {
   selectionConfig: {
     required: false,
     defaultValue: {
-      isEnabled: false,
       maxSelectionCount: 50,
-      limitExceedAlertMessage: 'Max records selected'
+      limitExceedAlertMessage: 'Max records selected',
+      isEnabled: false,
+      isSelectAllEnabled: false
     },
     typeMetadata: {
       schema: {
@@ -18,6 +19,9 @@ export default {
           },
           limitExceedAlertMessage: {
             type: 'string'
+          },
+          isSelectAllEnabled: {
+            type: 'boolean'
           }
         }
       }

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,50 +7,52 @@ 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'
+      }
+    }
+  },
+  query: {
+    required: false,
+    defaultValue: {},
+    typeMetadata: {
+      schema: {
+        type: 'object'
+      }
+    }
+  },
+  context: {
     required: true,
     typeMetadata: {
       schema: {
         type: 'object',
         properties: {
-          orgName: {
+          orgId: {
             type: 'string'
           },
-          servicePrefix: {
+          orgName: {
             type: 'string'
           },
           departmentName: {
             type: 'string'
           },
-          moduleSanitatedName: {
+          servicePrefix: {
             type: 'string'
           }
         },
-        additionalProperties: {
-          type: 'string'
-        }
+        required: ['orgId', 'orgName', 'departmentName'],
+        additionalProperties: false
       }
     }
   },
@@ -69,14 +71,5 @@ export default {
         }]
       }
     }
-  },
-  limit: {
-    required: false,
-    defaultValue: 50,
-    typeMetadata: {
-      schema: {
-        type: 'number'
-      }
-    }
   }
 };

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/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: {},
@@ -40,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-connected/constants/Events.js

@@ -0,0 +1,7 @@
+export default {
+  DELETE_RECORDS_SUCCESS: 'SMART_TABLE#RECORD_DELETED',
+  UPDATE_RECORDS_SUCCESS: 'SMART_TABLE#RECORD_UPDATED',
+  RECORDS_SELECTED: 'SMART_TABLE#RECORDS_SELECTED',
+  RECORDS_DESELECTED: 'SMART_TABLE#RECORDS_DESELECTED',
+  SELECTION_LIMIT_EXCEEDED: 'SMART_TABLE#SELECTION_LIMIT_EXCEEDED'
+};

package/es/cc/table-connected/constants/index.js

@@ -0,0 +1 @@
+export { default as Events } from "./Events";

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

@@ -0,0 +1,4 @@
+import * as _SmartTableConstants from "./constants";
+export { _SmartTableConstants as SmartTableConstants };
+import * as _SmartTableProperties from "./Properties";
+export { _SmartTableProperties as SmartTableProperties };

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

@@ -1,7 +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";
@@ -147,7 +147,7 @@ const TableListProperties = {
             }]
           },
           ActionLocation: {
-            type: 'object',
+            renderComponentType: 'object',
             properties: {
               type: {
                 type: 'string'
@@ -192,6 +192,9 @@ const TableListProperties = {
                 },
                 selectionTooltip: {
                   type: 'string'
+                },
+                isSelectAllEnabled: {
+                  type: 'boolean'
                 }
               },
               required: ['id', 'columns']
@@ -201,6 +204,45 @@ const TableListProperties = {
         required: ['headers', 'rows']
       }
     }
+  },
+  selection: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          selected: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          },
+          hasAllSelected: {
+            type: 'boolean'
+          }
+        },
+        required: ['selected', 'hasAllSelected']
+      }
+    }
+  },
+  selectionConfig: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          maxSelectionCount: {
+            type: 'number'
+          },
+          isEnabled: {
+            type: 'boolean'
+          },
+          isSelectAllEnabled: {
+            type: 'boolean'
+          }
+        }
+      }
+    }
   }
 };
 export default TableListProperties;

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

@@ -18,4 +18,10 @@ export let Alignment = /*#__PURE__*/function (Alignment) {
   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/desk-frameworks/table-connected/frameworks/EventHandlersFactory.js

@@ -1,4 +1,6 @@
+import { LIST_SELECTION_RECORDS_DESELECTED, LIST_SELECTION_RECORDS_SELECTED, LIST_SELECTION_SELECTION_LIMIT_EXCEEDED } from "../../../bc/list-selection/Constants";
 import ListSdkFactory from "./ListSdkFactory";
+import { SmartTableConstants } from "../../../cc/table-connected";
 
 function createHandlerWithSdk(handler) {
   return input => {
@@ -20,7 +22,37 @@ export default class EventHandlersFactory {
       return [eventName, handler];
     }));
     return { ...wrapped,
-      NAVIGATION: NavigationHandler
+      NAVIGATION: NavigationHandler,
+      [LIST_SELECTION_RECORDS_SELECTED]: _ref => {
+        let {
+          action,
+          dispatch
+        } = _ref;
+        return dispatch({
+          type: SmartTableConstants.Events.RECORDS_SELECTED,
+          payload: action.payload
+        });
+      },
+      [LIST_SELECTION_RECORDS_DESELECTED]: _ref2 => {
+        let {
+          action,
+          dispatch
+        } = _ref2;
+        return dispatch({
+          type: SmartTableConstants.Events.RECORDS_DESELECTED,
+          payload: action.payload
+        });
+      },
+      [LIST_SELECTION_SELECTION_LIMIT_EXCEEDED]: _ref3 => {
+        let {
+          action,
+          dispatch
+        } = _ref3;
+        return dispatch({
+          type: SmartTableConstants.Events.SELECTION_LIMIT_EXCEEDED,
+          payload: action.payload
+        });
+      }
     };
   }