@zohodesk/library-platform 1.0.1 → 1.0.2-exp.4

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.js

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

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

@@ -1,17 +1,26 @@
 export default {
-  type: 'object',
-  properties: {
-    isEnabled: {
-      type: 'boolean',
-      defaultValue: false
+  selectionConfig: {
+    required: false,
+    defaultValue: {
+      isEnabled: false,
+      maxSelectionCount: 50,
+      limitExceedAlertMessage: 'Max records selected'
     },
-    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'
+          }
+        }
+      }
     }
   }
 };

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/Properties.js

@@ -7,7 +7,7 @@ export default {
     },
     minWidth: {
       type: 'number',
-      defaultValue: 120
+      defaultValue: 100
     },
     maxWidth: {
       type: 'number',

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/zhttp/Properties.js

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

package/es/bc/zhttp/index.js

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

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

@@ -1,4 +1,3 @@
-import SortByConfigSchema from "../sort-by/Properties";
 export default {
   moduleName: {
     required: true,
@@ -8,62 +7,59 @@ 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'
+      }
+    }
+  },
+  viewId: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
       }
     }
   },
-  pageContext: {
+  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
       }
     }
   },
   sortBy: {
-    required: true,
-    typeMetadata: {
-      schema: SortByConfigSchema
-    }
-  },
-  limit: {
     required: false,
-    defaultValue: 50,
+    defaultValue: '',
     typeMetadata: {
       schema: {
-        type: 'number'
+        type: 'string',
+        oneOf: [{
+          pattern: "^-.*"
+        }, {
+          not: {
+            pattern: "^-.*"
+          }
+        }]
       }
     }
   }

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/Model.js

@@ -8,12 +8,16 @@ function Model(_ref) {
   let {
     icon,
     label,
-    hoverVariant
+    hoverVariant,
+    isDisabled,
+    isVisible
   } = _ref;
   return {
     icon,
     label,
-    hoverVariant
+    hoverVariant,
+    isDisabled,
+    isVisible
   };
 }
 

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

@@ -24,5 +24,54 @@ export default {
         enum: ["primary", "danger"]
       }
     }
+  },
+  isDisabled: {
+    required: false,
+    defaultValue: false,
+    typeMetadata: {
+      schema: {
+        type: "boolean"
+      }
+    }
+  },
+  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,
+    typeMetadata: {
+      schema: {
+        type: "boolean"
+      }
+    }
   }
 };

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

@@ -1,10 +1,46 @@
+export const actionsSchema = {
+  type: 'array',
+  minItems: 0,
+  items: {
+    type: 'object',
+    properties: {
+      component: {
+        type: 'string'
+      },
+      id: {
+        type: 'string'
+      },
+      properties: {
+        type: 'object'
+      },
+      eventMappings: {
+        type: 'array',
+        minItems: 0,
+        items: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string'
+            },
+            sourceEvent: {
+              type: 'string'
+            },
+            payload: {
+              type: 'object'
+            }
+          },
+          required: ['sourceEvent', 'id']
+        }
+      }
+    },
+    required: ['component', 'properties']
+  }
+};
 export default {
   actions: {
     required: true,
     typeMetadata: {
-      schema: {
-        type: 'array'
-      }
+      schema: actionsSchema
     }
   }
 };

package/es/cc/component/properties/PropertiesConverter.js

@@ -0,0 +1,23 @@
+export default class PropertiesConverter {
+  static toJsonSchema(properties) {
+    let required = [];
+    const updatedProperties = Object.entries(properties).reduce((value, _ref) => {
+      let [prop, schema] = _ref;
+
+      if (schema.required) {
+        required.push(prop);
+      }
+
+      return { ...value,
+        [prop]: { ...schema.typeMetadata.schema
+        }
+      };
+    }, {});
+    return {
+      type: 'object',
+      properties: updatedProperties,
+      required
+    };
+  }
+
+}

package/es/cc/empty-state/index.js

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

package/es/cc/fields/field/Properties.js

@@ -1,6 +1,14 @@
 export default {
-  id: {
+  type: {
     required: true,
+    typeMetadata: {
+      schema: {
+        type: 'string'
+      }
+    }
+  },
+  id: {
+    required: false,
     defaultValue: null,
     typeMetadata: {
       schema: {

package/es/cc/fields/field/Types.js

@@ -1,20 +1,20 @@
 var Types = /*#__PURE__*/function (Types) {
-  Types["CheckboxField"] = "CheckboxField";
-  Types["SwitchField"] = "SwitchField";
-  Types["SingleLineField"] = "SingleLineField";
-  Types["MultiLineField"] = "MultiLineField";
-  Types["EmailField"] = "EmailField";
-  Types["URLField"] = "URLField";
-  Types["PhoneField"] = "PhoneField";
-  Types["CurrencyField"] = "CurrencyField";
-  Types["LookUpField"] = "LookUpField";
-  Types["PickListField"] = "PickListField";
-  Types["PercentageField"] = "PercentageField";
-  Types["DateField"] = "DateField";
-  Types["DateTimeField"] = "DateTimeField";
-  Types["NumberField"] = "NumberField";
-  Types["DecimalField"] = "DecimalField";
-  Types["MultiSelectField"] = "MultiSelectField";
+  Types["CheckboxField"] = "Checkbox";
+  Types["SwitchField"] = "Switch";
+  Types["SingleLineField"] = "SingleLine";
+  Types["MultiLineField"] = "MultiLine";
+  Types["EmailField"] = "Email";
+  Types["URLField"] = "URL";
+  Types["PhoneField"] = "Phone";
+  Types["CurrencyField"] = "Currency";
+  Types["LookUpField"] = "LookUp";
+  Types["PickListField"] = "PickList";
+  Types["PercentageField"] = "Percentage";
+  Types["DateField"] = "Date";
+  Types["DateTimeField"] = "DateTime";
+  Types["NumberField"] = "Number";
+  Types["DecimalField"] = "Decimal";
+  Types["MultiSelectField"] = "MultiSelect";
   return Types;
 }(Types || {});
 

package/es/cc/fields/multi-select/Properties.js

@@ -18,7 +18,7 @@ export default { ...FieldProperties,
     }
   },
   options: {
-    required: true,
+    required: false,
     typeMetadata: {
       schema: {
         type: 'array',

package/es/cc/fields/pick-list/Properties.js

@@ -18,7 +18,7 @@ export default { ...FieldProperties,
     }
   },
   options: {
-    required: true,
+    required: false,
     typeMetadata: {
       schema: {
         type: 'array',

package/es/cc/index.js

@@ -8,4 +8,5 @@ export * from "./table-list";
 export * from "./tags";
 export * from "./text";
 export * from "./action-icon";
+export * from "./empty-state";
 export * from "./fields";

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,36 +1,23 @@
-import ZListProperties from "../../bc/zlist/Properties";
 import SelectionConfigSchema from "../../bc/list-selection/Properties";
-export default { ...ZListProperties,
-  sortBy: {
-    required: false,
-    defaultValue: '',
-    typeMetadata: {
-      schema: {
-        type: 'string'
-      }
-    }
-  },
-  isFlexibleColumns: {
-    required: false,
-    defaultValue: false,
-    typeMetadata: {
-      schema: {
-        type: 'boolean'
-      }
-    }
-  },
-  selectionConfig: {
+export default {
+  preferences: {
     required: false,
     defaultValue: {
-      isEnabled: false,
-      maxSelectionCount: 50,
-      limitExceedAlertMessage: 'Max records selected'
+      autoColumnSizing: false
     },
     typeMetadata: {
-      schema: SelectionConfigSchema
+      schema: {
+        type: 'object',
+        properties: {
+          autoColumnSizing: {
+            type: 'boolean'
+          }
+        }
+      }
     }
   },
-  uiMapping: {
+  ...SelectionConfigSchema,
+  componentMapping: {
     required: false,
     defaultValue: {
       fields: {},
@@ -41,50 +28,24 @@ export default { ...ZListProperties,
         type: 'object',
         properties: {
           fields: {
-            type: 'object',
-            defaultValue: {}
+            type: 'object'
+          },
+          rowActionsComponentName: {
+            type: 'string'
           },
           emptyState: {
-            type: 'string',
-            defaultValue: ''
+            type: 'string'
           }
         }
       }
     }
   },
-  headers: {
-    required: false,
-    defaultValue: '',
-    typeMetadata: {
-      schema: {
-        type: 'object'
-      }
-    }
-  },
   moduleName: {
     required: true,
-    defaultValue: 'ticket',
     typeMetadata: {
       schema: {
         type: 'string'
       }
     }
-  },
-  rowActions: {
-    required: false,
-    defaultValue: [],
-    typeMetadata: {
-      schema: {
-        type: 'array'
-      }
-    }
-  },
-  limit: {
-    required: true,
-    typeMetadata: {
-      schema: {
-        type: 'number'
-      }
-    }
   }
 };