@zohodesk/library-platform 1.0.1 → 1.0.2-exp.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/index.ts

@@ -0,0 +1,3 @@
+export * from './sort-by';
+export * from './zhttp';
+export * from './zlist';

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

@@ -0,0 +1,10 @@
+import EventHandlers, { EventHandler } from '@cc/component/EventHandlers';
+import { LIST_SELECTION_TOGGLE_ALL, LIST_SELECTION_TOGGLE_ITEMS, LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE } from './Constants';
+
+interface ListSelectionActionHandlers extends EventHandlers {
+  [LIST_SELECTION_TOGGLE_ITEMS]: EventHandler;
+  [LIST_SELECTION_TOGGLE_ALL]: EventHandler;
+  [LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE]: EventHandler;
+}
+
+export default ListSelectionActionHandlers;

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

@@ -0,0 +1,45 @@
+import Action from '@cc/component/Action';
+import { LIST_SELECTION_TOGGLE_ALL, LIST_SELECTION_TOGGLE_ITEMS, LIST_SELECTION_TOGGLE_ITEMS_IN_RANGE } from './Constants';
+
+const Actions: Action[] = [
+  {
+    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.ts

@@ -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.ts

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

package/es/bc/local-storage/ActionHandlers.ts

@@ -0,0 +1,7 @@
+import ActionHandlers, {
+  ActionHandler
+} from '../../cc/component/ActionHandlers';
+
+export default interface LocalStorageActionHandlers extends ActionHandlers {
+  'LOCAL_STORAGE#UPDATE_REQUESTED': ActionHandler;
+}

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

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

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

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

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

@@ -0,0 +1,8 @@
+import EventHandlers, { EventHandler } from '@cc/component/EventHandlers';
+import { SORTBY_SORT } from './Constants';
+
+interface SortByActionHandlers extends EventHandlers {
+  [SORTBY_SORT]: EventHandler;
+}
+
+export default SortByActionHandlers;

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

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

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

@@ -0,0 +1,27 @@
+import SortOrder from './SortOrderEnum';
+
+export default {
+  sortBy: {
+    required: false,
+    defaultValue: {
+      id: '',
+      order: 'none'
+    },
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          id: {
+            type: 'string'
+          },
+          order: {
+            type: 'string',
+            enum: Object.values(SortOrder),
+            defaultValue: 'none'
+          }
+        },
+        required: ['id', 'order']
+      }
+    }
+  }
+};

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

@@ -0,0 +1,7 @@
+enum SortOrder {
+  NONE = 'none',
+  ASC = 'ascending',
+  DES = 'descending'
+}
+
+export default SortOrder;

package/es/bc/sort-by/index.ts

@@ -0,0 +1 @@
+export * as SortByConstants from './Constants';

package/es/bc/table-column-resizer/ActionHandlers.ts

@@ -0,0 +1,12 @@
+import ActionHandlers, {
+  ActionHandler
+} from '../../cc/component/ActionHandlers';
+
+export default interface TableColumnResizerActionHandlers
+  extends ActionHandlers {
+  'TABLE_COLUMN_RESIZER#RESIZE_STARTED': ActionHandler;
+  'TABLE_COLUMN_RESIZER#RESIZE_MOUSE_MOVED': ActionHandler;
+  'TABLE_COLUMN_RESIZER#RESIZE_SCROLL_MOVED': ActionHandler;
+  'TABLE_COLUMN_RESIZER#RESIZE_ENDED': ActionHandler;
+  'TABLE_COLUMN_RESIZER#RESIZE_FINISHED': ActionHandler;
+}

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

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

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

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

package/es/bc/zdata-source/Actions.ts

@@ -0,0 +1,72 @@
+import Action from '@cc/component/Action';
+import { DATA_SOURCE_EXECUTE } from './Constants';
+import { DATA_SOURCE_FAILURE, DATA_SOURCE_SUCCESS } from './Symbols';
+
+const Actions: Action[] = [
+  {
+    type: DATA_SOURCE_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: {
+            [DATA_SOURCE_SUCCESS]: {
+              type: 'object',
+              properties: {
+                type: {
+                  type: 'string'
+                },
+                payload: {
+                  type: 'object'
+                }
+              },
+              required: ['type', 'payload']
+            },
+            [DATA_SOURCE_FAILURE]: {
+              type: 'object',
+              properties: {
+                type: {
+                  type: 'string'
+                },
+                payload: {
+                  type: 'object'
+                }
+              },
+              required: ['type', 'payload']
+            }
+          },
+          required: [DATA_SOURCE_SUCCESS, DATA_SOURCE_FAILURE]
+        }
+      }
+    }
+  }
+];
+
+export default Actions;

package/es/bc/zdata-source/Constants.ts

@@ -0,0 +1,13 @@
+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 {
+  static readonly GET_RECORDS = 'getRecords';
+  static readonly DELETE_RECORDS = 'deleteRecords';
+  static readonly DELETE_RECORD = 'deleteRecord';
+  static readonly UPDATE_RECORD = 'updateRecord';
+}

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

@@ -0,0 +1,12 @@
+import EventHandlers, { EventHandler } from '@cc/component/EventHandlers';
+import { DATA_SOURCE_EXECUTE, DATA_SOURCE_REGISTER } from './Constants';
+
+import { FETCH_FAILED, FETCH_SUCCESS, FETCH_SUCCESS_NO_CONTENT } from '@bc/zhttp/Constants';
+
+export default interface ZDataSourceEventHandlers extends EventHandlers {
+  [DATA_SOURCE_REGISTER]: EventHandler;
+  [DATA_SOURCE_EXECUTE]: EventHandler;
+  [FETCH_SUCCESS_NO_CONTENT]: EventHandler;
+  [FETCH_SUCCESS]: EventHandler;
+  [FETCH_FAILED]: EventHandler;
+}

package/es/bc/zdata-source/Properties.ts

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

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

@@ -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.ts

@@ -0,0 +1,12 @@
+import ActionHandlers, { ActionHandler } from '@cc/component/ActionHandlers';
+import { FIELD_EXECUTE, FIELD_REFETCH } from './Constants';
+import { DATA_SOURCE_EXECUTE_FAILED, DATA_SOURCE_EXECUTE_NO_CONTENT_SUCCEEDED, DATA_SOURCE_EXECUTE_SUCCEEDED } from '@bc/zdata-source/Constants';
+interface ZFieldActionHandlers extends ActionHandlers {
+  [FIELD_REFETCH]: ActionHandler;
+  [FIELD_EXECUTE]: ActionHandler;
+  [DATA_SOURCE_EXECUTE_SUCCEEDED]: ActionHandler;
+  [DATA_SOURCE_EXECUTE_NO_CONTENT_SUCCEEDED]: ActionHandler;
+  [DATA_SOURCE_EXECUTE_FAILED]: ActionHandler;
+}
+
+export default ZFieldActionHandlers;

package/es/bc/zfield/Actions.ts

@@ -0,0 +1,36 @@
+import Action from '@cc/component/Action';
+import { FIELD_EXECUTE } from './Constants';
+
+const Actions: Action[] = [
+  {
+    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.ts

@@ -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.ts

@@ -0,0 +1,5 @@
+import Properties from '@cc/component/properties';
+
+const properties: Properties = {};
+
+export default properties;

package/es/bc/zhttp/ActionHandlers.ts

@@ -0,0 +1,6 @@
+import ActionHandlers, { ActionHandler } from '@cc/component/ActionHandlers';
+import { FETCH } from './Constants';
+
+export default interface ZHttpActionHandlers extends ActionHandlers {
+  [FETCH]: ActionHandler;
+}

package/es/bc/zhttp/Actions.ts

@@ -0,0 +1,88 @@
+import Action from '@cc/component/Action';
+import { FETCH_FAILED, FETCH_SUCCESS_NO_CONTENT, FETCH_REQUESTED, FETCH_SUCCESS } from './Constants';
+
+const Actions: Action[] = [
+  {
+    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.ts

@@ -0,0 +1,6 @@
+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.ts

@@ -0,0 +1,11 @@
+export default {
+    headers: {
+        required: false,
+        defaultValue: '',
+        typeMetadata: {
+            schema: {
+                type: 'object'
+            }
+        }
+    }
+};

package/es/bc/zhttp/index.ts

@@ -0,0 +1 @@
+export * as ZHttpConstants from './Constants';

package/es/bc/zlist/Actions.ts

@@ -0,0 +1,6 @@
+import Action from '@cc/component/Action';
+import { ZLIST_FETCH_MORE } from './Constants';
+
+const Actions: Action[] = [{ type: ZLIST_FETCH_MORE }];
+
+export default Actions;

package/es/bc/zlist/Constants.ts

@@ -0,0 +1,9 @@
+export const ZLIST_DELETE_RECORDS = 'ZLIST#DELETE_RECORDS';
+export const ZLIST_DELETE_RECORD = 'ZLIST#DELETE_RECORD';
+export const ZLIST_RECORD_UPDATE = 'ZLIST#RECORD_UPDATE';
+export const ZLIST_FETCH_MORE = 'ZLIST#FETCH_MORE';
+export const ZLIST_FETCH_SORTED = 'ZLIST#FETCH_SORTED';
+export const ZLIST_RECORD_UPDATE_SUCCEEDED = 'ZLIST#RECORD_UPDATE_SUCCEEDED';
+export const ZLIST_RECORD_UPDATE_FAILED = 'ZLIST#RECORD_UPDATE_FAILED';
+export const ZLIST_RECORD_DELETE_SUCCEEDED = 'ZLIST#RECORD_DELETE_SUCCEEDED';
+export const ZLIST_RECORD_DELETE_FAILED = 'ZLIST#RECORD_DELETE_FAILED';

package/es/bc/zlist/EventHandlers.ts

@@ -0,0 +1,8 @@
+import EventHandlers, { EventHandler } from '@cc/component/EventHandlers';
+import { ZLIST_FETCH_MORE, ZLIST_RECORD_DELETE_SUCCEEDED, ZLIST_RECORD_UPDATE_SUCCEEDED } from './Constants';
+
+export default interface ZListEventHandlers extends EventHandlers {
+  [ZLIST_FETCH_MORE]: EventHandler;
+  [ZLIST_RECORD_UPDATE_SUCCEEDED]: EventHandler;
+  [ZLIST_RECORD_DELETE_SUCCEEDED]: EventHandler;
+}

package/es/bc/zlist/Properties.ts

@@ -0,0 +1,55 @@
+export default {
+  moduleName: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  },
+  departmentId: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  },
+  viewId: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  },
+  context: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          orgId: { type: 'string' },
+          orgName: { type: 'string' },
+          departmentName: { type: 'string' },
+          servicePrefix: { type: 'string' }
+        },
+        required: ['orgId', 'orgName', 'departmentName'],
+        additionalProperties: false
+      }
+    }
+  },
+  sortBy: {
+    required: false,
+    defaultValue: '',
+    typeMetadata: {
+      schema: {
+        type: 'string',
+        oneOf: [
+          { pattern: "^-.*" },
+          { not: { pattern: "^-.*" } }
+        ]
+      }
+    }
+  }
+};

package/es/bc/zlist/index.ts

@@ -0,0 +1 @@
+export * as ZListConstants from './Constants';