@zohodesk/library-platform 1.0.1 → 1.0.2-exp.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/field-validation/Constants.js

@@ -0,0 +1,4 @@
+export const VALIDATE_FIELD = 'FIELD_VALIDATION#VALIDATE_FIELD';
+export const FIELD_VALIDATION_RESULT = 'FIELD_VALIDATION#FIELD_VALIDATION_RESULT';
+export const VALIDATE_FIELDS = 'FIELD_VALIDATION#VALIDATE_FIELDS';
+export const VALIDATE_FIELDS_RESULT = 'FIELD_VALIDATION#VALIDATE_FIELDS_RESULT';

package/es/bc/field-validation/EventHandlers.js

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

package/es/bc/field-validation/Events.js

@@ -0,0 +1,106 @@
+import { VALIDATE_FIELD, FIELD_VALIDATION_RESULT, VALIDATE_FIELDS, VALIDATE_FIELDS_RESULT } from "./Constants";
+const fieldMeta = {
+  type: 'object',
+  properties: {
+    name: {
+      type: 'string'
+    },
+    type: {
+      type: 'string'
+    },
+    value: {
+      type: 'any'
+    }
+  }
+};
+const Events = [{
+  type: VALIDATE_FIELD,
+  payload: {
+    fields: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'array',
+          items: fieldMeta
+        }
+      }
+    }
+  }
+}, {
+  type: FIELD_VALIDATION_RESULT,
+  payload: {
+    validationResult: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'object',
+          properties: {
+            isValid: {
+              type: 'boolean'
+            },
+            message: {
+              type: 'string'
+            }
+          }
+        }
+      }
+    },
+    field: {
+      required: true,
+      typeMetadata: {
+        schema: fieldMeta
+      }
+    }
+  }
+}, {
+  type: VALIDATE_FIELDS,
+  payload: {
+    fields: {
+      required: true,
+      typeMetadata: {
+        schema: fieldMeta
+      }
+    },
+    value: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'any'
+        }
+      }
+    }
+  }
+}, {
+  type: VALIDATE_FIELDS_RESULT,
+  payload: {
+    validationResults: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'Array',
+          items: {
+            type: 'object',
+            properties: {
+              isValid: {
+                type: 'boolean'
+              },
+              message: {
+                type: 'string'
+              }
+            }
+          }
+        }
+      }
+    },
+    fields: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'array',
+          items: fieldMeta
+        }
+      }
+    }
+  }
+}];
+export default Events;

package/es/bc/field-validation/FieldTypes.js

@@ -0,0 +1,20 @@
+var FieldTypes = /*#__PURE__*/function (FieldTypes) {
+  FieldTypes["TextBox"] = "Text";
+  FieldTypes["Email"] = "Email";
+  FieldTypes["Decimal"] = "Decimal";
+  FieldTypes["Integer"] = "Integer";
+  FieldTypes["Phone"] = "Phone";
+  FieldTypes["Date"] = "Date";
+  FieldTypes["DateTime"] = "DateTime";
+  FieldTypes["Boolean"] = "Boolean";
+  FieldTypes["MultiSelect"] = "MultiSelect";
+  FieldTypes["Picklist"] = "Picklist";
+  FieldTypes["Percent"] = "Percent";
+  FieldTypes["Currency"] = "Currency";
+  FieldTypes["URL"] = "URL";
+  FieldTypes["LookUp"] = "LookUp";
+  FieldTypes["TextArea"] = "TextArea";
+  return FieldTypes;
+}(FieldTypes || {});
+
+export default FieldTypes;

package/es/bc/field-validation/Properties.js

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

package/es/bc/field-validation/index.js

@@ -0,0 +1,5 @@
+import Properties from "./Properties";
+import * as Constants from "./Constants";
+import Events from "./Events";
+import EventHandlers from "./EventHandlers";
+export { Properties, Constants, Events, EventHandlers };

package/es/bc/index.js

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

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

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

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

@@ -1 +1,2 @@
-export const UPDATE_REQUESTED = 'LOCAL_STORAGE#UPDATE_REQUESTED';
+export const STORE_REQUESTED = 'LOCAL_STORAGE#STORE_REQUESTED';
+export const STORE_KEY = 'LOCAL_STORAGE_BEHAVIOUR_KEY';

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

@@ -0,0 +1,21 @@
+export default [{
+  type: 'object',
+  properties: {
+    type: {
+      const: 'LOCAL_STORAGE#STORE_REQUESTED'
+    },
+    payload: {
+      type: 'object',
+      properties: {
+        storeKey: {
+          type: 'string'
+        },
+        data: {
+          type: 'object'
+        }
+      },
+      required: ['storeKey', 'data']
+    }
+  },
+  required: ['type', 'payload']
+}];

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

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

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

@@ -1,20 +1,25 @@
 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'
+  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/index.js

@@ -0,0 +1,2 @@
+import * as _SortByConstants from "./Constants";
+export { _SortByConstants as SortByConstants };

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

@@ -1,5 +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';
+export const RESIZE_STARTED = 'COLUMN_RESIZER#RESIZE_STARTED';
+export const RESIZE_MOUSE = 'COLUMN_RESIZER#RESIZE_MOUSE';
+export const RESIZE_SCROLL = 'COLUMN_RESIZER#RESIZE_SCROLL';
+export const RESIZE_ENDED = 'COLUMN_RESIZER#RESIZE_ENDED';
+export const RESIZE_FINISHED = 'COLUMN_RESIZER#RESIZE_FINISHED';

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

@@ -0,0 +1,114 @@
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Actions',
+  type: 'array',
+  items: {
+    oneOf: [{
+      type: 'object',
+      properties: {
+        type: {
+          const: 'COLUMN_RESIZER#RESIZE_STARTED'
+        },
+        payload: {
+          type: 'object',
+          properties: {
+            columnName: {
+              type: 'string'
+            },
+            initialPosition: {
+              type: 'number'
+            },
+            tableElement: {
+              type: 'object'
+            },
+            columnWidth: {
+              type: 'number'
+            },
+            mouseEvent: {
+              type: 'object'
+            }
+          },
+          required: ['columnName', 'initialPosition', 'tableElement', 'columnWidth', 'mouseEvent']
+        }
+      },
+      required: ['type', 'payload']
+    }, {
+      type: 'object',
+      properties: {
+        type: {
+          const: 'COLUMN_RESIZER#RESIZE_MOUSE'
+        },
+        payload: {
+          type: 'object',
+          properties: {
+            mouseEvent: {
+              type: 'object'
+            },
+            tableElement: {
+              type: 'object'
+            }
+          },
+          required: ['mouseEvent', 'tableElement']
+        }
+      },
+      required: ['type', 'payload']
+    }, {
+      type: 'object',
+      properties: {
+        type: {
+          const: 'COLUMN_RESIZER#RESIZE_SCROLL'
+        },
+        payload: {
+          type: 'object',
+          properties: {
+            tableElement: {
+              type: 'object'
+            }
+          },
+          required: ['tableElement']
+        }
+      },
+      required: ['type', 'payload']
+    }, {
+      type: 'object',
+      properties: {
+        type: {
+          const: 'COLUMN_RESIZER#RESIZE_ENDED'
+        },
+        payload: {
+          type: 'object',
+          properties: {
+            tableElement: {
+              type: 'object'
+            }
+          },
+          required: ['tableElement']
+        }
+      },
+      required: ['type', 'payload']
+    }, {
+      type: 'object',
+      properties: {
+        type: {
+          const: 'COLUMN_RESIZER#RESIZE_FINISHED'
+        },
+        payload: {
+          type: 'object',
+          properties: {
+            columnName: {
+              type: 'string'
+            },
+            oldWidth: {
+              type: 'number'
+            },
+            newWidth: {
+              type: 'number'
+            }
+          },
+          required: ['columnName', 'oldWidth', 'newWidth']
+        }
+      },
+      required: ['type', 'payload']
+    }]
+  }
+};

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

@@ -1,18 +1,31 @@
 export default {
-  type: 'object',
-  properties: {
-    isEnabled: {
-      type: 'boolean',
-      defaultValue: false
+  resizeConfig: {
+    required: false,
+    defaultValue: {
+      enabled: true,
+      isRTL: false,
+      minWidth: 120,
+      maxWidth: 1000
     },
-    minWidth: {
-      type: 'number',
-      defaultValue: 120
-    },
-    maxWidth: {
-      type: 'number',
-      defaultValue: 1000
+    typeMetadata: {
+      schema: {
+        type: 'object',
+        properties: {
+          enabled: {
+            type: 'boolean'
+          },
+          isRTL: {
+            type: 'boolean'
+          },
+          minWidth: {
+            type: 'number'
+          },
+          maxWidth: {
+            type: 'number'
+          }
+        },
+        required: []
+      }
     }
-  },
-  required: ['isEnabled']
+  }
 };

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

@@ -0,0 +1,67 @@
+import { DATA_SOURCE_EXECUTE } from "./Constants";
+import { DATA_SOURCE_FAILURE, DATA_SOURCE_SUCCESS } from "./Symbols";
+const Actions = [{
+  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.js

@@ -0,0 +1,17 @@
+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_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');
+
+_defineProperty(DataBrokerActionName, "DELETE_RECORDS", 'deleteRecords');
+
+_defineProperty(DataBrokerActionName, "DELETE_RECORD", 'deleteRecord');
+
+_defineProperty(DataBrokerActionName, "UPDATE_RECORD", 'updateRecord');

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

@@ -0,0 +1 @@
+export * from "./Symbol";

package/es/bc/zform/EventHandlers.js

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

package/es/bc/zform/Events.js

@@ -0,0 +1,6 @@
+import { ZFORM_SUBMIT } from "./Constants";
+const Events = [{
+  type: ZFORM_SUBMIT,
+  payload: {}
+}];
+export default Events;