@zohodesk/library-platform 1.0.0-exp.1 → 1.0.0-exp.3

package/README.md

@@ -1,21 +1,83 @@
-### Path Alias Configuring
+# Table List Library
 
-To configure your Path Alias, follow these steps:
+This library provides components for rendering Table List pages in compliance with the Zoho Desk Module Framework standards. It includes functionality for table handling.
 
-1. Make sure you have the latest version of `@zohodesk/react-cli` installed (v1.1.23).
+## Installation
 
-2. Configure path aliases by adding the following code to `react-cli.config.js`:
+To install the library, use the following command:
 
-```js
-alias: {
-    "@cc": "./src/cc"
-}
+```bash
+npm install @zohodesk/library-platform
 ```
-3. Configure path aliases by adding the following code to `jsconfig.json`
-```json
-"paths": {
-    "@cc/*": ["./src/cc/*"],
-    "@list-selection/*": ["./src/library/behaviours/list-selection/*"]
-}
+
+## Usage
+
+### Creating a Table Connected Component
+
+To create a Table Connected component, you can use the `TableConnectedFactory`. Here is a simple example:
+
+```javascript
+import TableConnectedFactory from '@zohodesk/library-platform/TableConnectedFactory';
+
+const myTableComponent = TableConnectedFactory.create({
+  name: 'MyTableComponent',
+  dataBroker: myDataBroker,
+  eventHandlers: {
+    onRowSelect: row => {
+      console.log('Selected row:', row);
+    }
+  }
+});
+```
+
+### Custom Component Creation
+
+You can create custom components using the `createCustomComponent` function. This function sets up the component with the necessary dependencies and lifecycle methods.
+
+#### Example
+
+```javascript
+import createCustomComponent from '@zohodesk/library-platform/createCustomComponent';
+
+const MyCustomComponent = createCustomComponent({
+  name: 'MyCustomComponent',
+  View: MyComponentView // Your component view
+});
+
+// Usage in application
+<MyCustomComponent />;
 ```
----
+
+### Component Registry
+
+The `ComponentRegistry` class is a singleton that allows you to register and retrieve components by name. This can be useful for managing component instances throughout your application.
+
+#### Example
+
+```javascript
+import ComponentRegistry from '@zohodesk/library-platform/ComponentRegistry';
+
+// Register a component
+ComponentRegistry.register('MyComponent', myComponentInstance);
+
+// Retrieve a component
+const myComponent = ComponentRegistry.get('MyComponent');
+```
+
+### Props Contract
+
+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.
+- **eventHandlers**: `object` - An object containing event handler functions.
+- **View**: `React.Component` - Custom view component to render the table.
+
+### Components Overview
+
+- **Properties**: Defines the props contract for the Table Connected component.
+- **TableConnectedView**: The default view component for rendering the table.
+- **EventHandlersFactory**: Factory to manage event handlers for the component.
+- **Behaviour Factories**: Include various behaviours such as HTTP requests, field management, and list rendering.
+- **ComponentRegistry**: Singleton for managing component instances across your application.
+- **createCustomComponent**: Function to create custom components with necessary dependencies and lifecycle methods.

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

@@ -0,0 +1 @@
+import { LIST_SELECTION_TOGGLE_ALL, LIST_SELECTION_TOGGLE_ITEMS, LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE } from "./Constants";

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

@@ -0,0 +1,38 @@
+import { LIST_SELECTION_TOGGLE_ALL, LIST_SELECTION_TOGGLE_ITEMS, LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE } from "./Constants";
+const Actions = [{
+  type: LIST_SELECTION_TOGGLE_ITEMS,
+  payload: {
+    selected: {
+      name: 'selected',
+      typeMetadata: {
+        schema: {
+          type: 'array'
+        }
+      }
+    }
+  }
+}, {
+  type: LIST_SELECTION_TOGGLE_ALL,
+  payload: {}
+}, {
+  type: LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE,
+  payload: {
+    startIndex: {
+      name: 'startIndex',
+      typeMetadata: {
+        schema: {
+          type: 'number'
+        }
+      }
+    },
+    endIndex: {
+      name: 'endIndex',
+      typeMetadata: {
+        schema: {
+          type: 'number'
+        }
+      }
+    }
+  }
+}];
+export default Actions;

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

@@ -0,0 +1,3 @@
+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';

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

@@ -0,0 +1,17 @@
+export default {
+  type: 'object',
+  properties: {
+    isEnabled: {
+      type: 'boolean',
+      defaultValue: false
+    },
+    maxSelectionCount: {
+      type: 'number',
+      defaultValue: 50
+    },
+    limitExceedAlertMessage: {
+      type: 'string',
+      defaultValue: 'Max records selected'
+    }
+  }
+};

package/es/bc/local-storage/Constants.js

@@ -0,0 +1 @@
+export const UPDATE_REQUESTED = 'LOCAL_STORAGE#UPDATE_REQUESTED';

package/es/bc/local-storage/Properties.js

@@ -0,0 +1,10 @@
+export default {
+  localStorageKey: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  }
+};

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

@@ -0,0 +1 @@
+import { SORTBY_SORT } from "./Constants";

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

@@ -0,0 +1,2 @@
+export const SORTBY_SORT = 'SORT_BY#SORT';
+export const SORTBY_SORTED = 'SORT_BY#SORTED';

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

@@ -0,0 +1,21 @@
+import SortOrder from "./SortOrderEnum";
+export default {
+  required: false,
+  defaultValue: {
+    id: '',
+    type: 'none'
+  },
+  typeMetadata: {
+    schema: {
+      id: {
+        required: true,
+        type: 'string'
+      },
+      order: {
+        type: 'string',
+        enum: Object.values(SortOrder),
+        defaultValue: 'none'
+      }
+    }
+  }
+};

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

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

package/es/bc/table-column-resizer/Constants.js

@@ -0,0 +1,5 @@
+export const RESIZE_STARTED = 'TABLE_COLUMN_RESIZER#RESIZE_STARTED';
+export const RESIZE_MOUSE_MOVED = 'TABLE_COLUMN_RESIZER#RESIZE_MOUSE_MOVED';
+export const RESIZE_SCROLL_MOVED = 'TABLE_COLUMN_RESIZER#RESIZE_SCROLL_MOVED';
+export const RESIZE_ENDED = 'TABLE_COLUMN_RESIZER#RESIZE_ENDED';
+export const RESIZE_FINISHED = 'TABLE_COLUMN_RESIZER#RESIZE_FINISHED';

package/es/bc/table-column-resizer/Properties.js

@@ -0,0 +1,18 @@
+export default {
+  type: 'object',
+  properties: {
+    isEnabled: {
+      type: 'boolean',
+      defaultValue: false
+    },
+    minWidth: {
+      type: 'number',
+      defaultValue: 120
+    },
+    maxWidth: {
+      type: 'number',
+      defaultValue: 1000
+    }
+  },
+  required: ['isEnabled']
+};

package/es/bc/zfield/ActionHandlers.js

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

package/es/bc/zfield/Actions.js

@@ -0,0 +1,31 @@
+import { FIELD_EXECUTE } from "./Constants";
+const Actions = [{
+  type: FIELD_EXECUTE,
+  payload: {
+    apiName: {
+      name: 'apiName',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    actionName: {
+      name: 'actionName',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    props: {
+      name: 'props',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    }
+  }
+}];
+export default Actions;

package/es/bc/zfield/Constants.js

@@ -0,0 +1,6 @@
+export const FIELD_EXECUTE = 'ZFIELD#EXECUTE';
+export const FIELD_FETCH = 'ZFIELD#FETCH';
+export const FIELD_FETCH_SUCCESS = 'ZFIELD#FETCH_SUCCESS';
+export const FIELD_FETCH_FAILURE = 'ZFIELD#FETCH_FAILURE';
+export const FIELD_FETCH_NO_CONTENT = 'ZFIELD#FETCH_NO_CONTENT';
+export const FIELD_REFETCH = 'ZFIELD#REFETCH';

package/es/bc/zfield/Properties.js

@@ -0,0 +1,2 @@
+const properties = {};
+export default properties;

package/es/bc/zhttp/ActionHandlers.js

@@ -0,0 +1 @@
+import { FETCH } from "./Constants";

package/es/bc/zhttp/Actions.js

@@ -0,0 +1,80 @@
+import { FETCH_FAILED, FETCH_SUCCESS_NO_CONTENT, FETCH_REQUESTED, FETCH_SUCCESS } from "./Constants";
+const Actions = [{
+  type: FETCH_REQUESTED,
+  payload: {
+    url: {
+      name: 'url',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    method: {
+      name: 'method',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    headers: {
+      name: 'headers',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    },
+    metaData: {
+      name: 'metaData',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    }
+  }
+}, {
+  type: FETCH_SUCCESS_NO_CONTENT,
+  payload: {},
+  metaData: {
+    typeMetadata: {
+      schema: {
+        type: 'object'
+      }
+    }
+  }
+}, {
+  type: FETCH_SUCCESS,
+  payload: {
+    response: {
+      name: 'response',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    }
+  },
+  metaData: {
+    typeMetadata: {
+      schema: {
+        type: 'object'
+      }
+    }
+  }
+}, {
+  type: FETCH_FAILED,
+  payload: {
+    error: {
+      name: 'error',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    }
+  }
+}];
+export default Actions;

package/es/bc/zhttp/Constants.js

@@ -0,0 +1,5 @@
+export const FETCH = 'ZHTTP#FETCH';
+export const FETCH_REQUESTED = 'ZHTTP#FETCH_REQUESTED';
+export const FETCH_SUCCESS_NO_CONTENT = 'ZHTTP#FETCH_SUCCESS_NO_CONTENT';
+export const FETCH_SUCCESS = 'ZHTTP#FETCH_SUCCESS';
+export const FETCH_FAILED = 'ZHTTP#FETCH_FAILED';

package/es/bc/zhttp/Properties.js

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

package/es/bc/zlist/Actions.js

@@ -0,0 +1,5 @@
+import { ZLIST_FETCH_MORE } from "./Constants";
+const Actions = [{
+  type: ZLIST_FETCH_MORE
+}];
+export default Actions;

package/es/bc/zlist/Constants.js

@@ -0,0 +1,4 @@
+export const ZLIST_DELETE_RECORDS = 'ZLIST#DELETE_RECORDS';
+export const ZLIST_RECORD_UPDATE = 'ZLIST#RECORD_UPDATE';
+export const ZLIST_FETCH_MORE = 'ZLIST#FETCH_MORE';
+export const ZLIST_FETCH_SORTED = 'ZLIST#FETCH_SORTED';

package/es/bc/zlist/EventHandlers.js

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

package/es/bc/zlist/Properties.js

@@ -0,0 +1,70 @@
+import SortByConfigSchema from "../sort-by/Properties";
+export default {
+  moduleName: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  },
+  filter: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          viewId: {
+            type: 'string'
+          },
+          orgId: {
+            type: 'string'
+          },
+          departmentId: {
+            type: 'string'
+          }
+        },
+        additionalProperties: {
+          type: 'string'
+        }
+      }
+    }
+  },
+  pageContext: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          orgName: {
+            type: 'string'
+          },
+          departmentName: {
+            type: 'string'
+          },
+          moduleSanitatedName: {
+            type: 'string'
+          }
+        },
+        additionalProperties: {
+          type: 'string'
+        }
+      }
+    }
+  },
+  sortBy: {
+    required: true,
+    typeMetadata: {
+      schema: SortByConfigSchema
+    }
+  },
+  limit: {
+    required: false,
+    defaultValue: 50,
+    typeMetadata: {
+      schema: {
+        type: 'number'
+      }
+    }
+  }
+};

package/es/bc/zrecord/Actions.js

@@ -0,0 +1,142 @@
+import { APPEND_RECORDS, RECORD_EXECUTE, RECORD_REFETCH } from "./Constants";
+import { RECORD_FAILURE, RECORD_SUCCESS } from "./Symbols";
+const Actions = [{
+  type: RECORD_EXECUTE,
+  payload: {
+    apiName: {
+      name: 'apiName',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    actionName: {
+      name: 'actionName',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    props: {
+      name: 'props',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    }
+  },
+  metaData: {
+    name: 'metaData',
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          [RECORD_SUCCESS]: {
+            type: 'object',
+            properties: {
+              type: {
+                type: 'string'
+              },
+              payload: {
+                type: 'object'
+              }
+            },
+            required: ['type', 'payload']
+          },
+          [RECORD_FAILURE]: {
+            type: 'object',
+            properties: {
+              type: {
+                type: 'string'
+              },
+              payload: {
+                type: 'object'
+              }
+            },
+            required: ['type', 'payload']
+          }
+        },
+        required: ['RECORD_SUCCESS', 'RECORD_FAILURE']
+      }
+    }
+  }
+}, {
+  type: RECORD_REFETCH,
+  payload: {
+    apiName: {
+      name: 'apiName',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    actionName: {
+      name: 'actionName',
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    props: {
+      name: 'props',
+      typeMetadata: {
+        schema: {
+          type: 'object'
+        }
+      }
+    }
+  },
+  metaData: {
+    name: 'metaData',
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          [RECORD_SUCCESS]: {
+            type: 'object',
+            properties: {
+              type: {
+                type: 'string'
+              },
+              payload: {
+                type: 'object'
+              }
+            },
+            required: ['type', 'payload']
+          },
+          [RECORD_FAILURE]: {
+            type: 'object',
+            properties: {
+              type: {
+                type: 'string'
+              },
+              payload: {
+                type: 'object'
+              }
+            },
+            required: ['type', 'payload']
+          }
+        },
+        required: ['RECORD_SUCCESS', 'RECORD_FAILURE']
+      }
+    }
+  }
+}, {
+  type: APPEND_RECORDS,
+  payload: {
+    records: {
+      name: 'records',
+      typeMetadata: {
+        schema: {
+          type: 'array'
+        }
+      }
+    }
+  }
+}];
+export default Actions;

package/es/bc/zrecord/Constants.js

@@ -0,0 +1,16 @@
+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 RECORD_EXECUTE = 'RECORD#EXECUTE';
+export const RECORD_REFETCH = 'RECORD#REFETCH';
+export const RECORD_FETCH_MORE = 'RECORD#FETCH_MORE';
+export const RECORD_FIELD_CHANGE = 'RECORD#FIELD_CHANGE';
+export const RECORD_LOCAL_UPDATE = 'RECORD#LOCAL_UPDATE';
+export const RECORD_LOCAL_MULTIPLE_DELETE = 'RECORD#LOCAL_MULTIPLE_DELETE';
+export const APPEND_RECORDS = 'RECORD#APPEND_RECORDS';
+export class RecordApiActionName {}
+
+_defineProperty(RecordApiActionName, "GET_RECORDS", 'getRecords');
+
+_defineProperty(RecordApiActionName, "DELETE_RECORDS", 'deleteRecords');
+
+_defineProperty(RecordApiActionName, "UPDATE_RECORD", 'updateRecord');

package/es/bc/zrecord/EventHandlers.js

@@ -0,0 +1,2 @@
+import { APPEND_RECORDS, RECORD_EXECUTE, RECORD_FETCH_MORE, RECORD_REFETCH } from "./Constants";
+import { FETCH_FAILED, FETCH_SUCCESS, FETCH_SUCCESS_NO_CONTENT } from "../zhttp/Constants";

package/es/bc/zrecord/Properties.js

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

package/es/bc/zrecord/Symbols.js

@@ -0,0 +1,4 @@
+// Note: We need to properly handle uniqueness , because it is not api response
+export const RECORD_FAILURE = 'RECORD#FAILURE';
+export const RECORD_SUCCESS = 'RECORD#SUCCESS';
+export const RECORD_NO_CONTENT = 'RECORD#NO_CONTENT';

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

@@ -0,0 +1,7 @@
+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; }
+
+class Constants {}
+
+_defineProperty(Constants, "ACTION_ICON_CLICKED", "ACTION_ICON#CLICKED");
+
+export default Constants;

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

@@ -0,0 +1,20 @@
+var HoverVariant = /*#__PURE__*/function (HoverVariant) {
+  HoverVariant["primary"] = "primary";
+  HoverVariant["danger"] = "danger";
+  return HoverVariant;
+}(HoverVariant || {});
+
+function Model(_ref) {
+  let {
+    icon,
+    label,
+    hoverVariant
+  } = _ref;
+  return {
+    icon,
+    label,
+    hoverVariant
+  };
+}
+
+export default Model;