@zohodesk/library-platform 1.0.0-exp.1

package/src/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/src/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/src/bc/zfield/Properties.ts

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

package/src/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/src/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/src/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/src/bc/zhttp/Properties.ts

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

package/src/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/src/bc/zlist/Constants.ts

@@ -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/src/bc/zlist/EventHandlers.ts

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

package/src/bc/zlist/Properties.ts

@@ -0,0 +1,55 @@
+import SortByConfigSchema from '@bc/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/src/bc/zrecord/Actions.ts

@@ -0,0 +1,149 @@
+import Action from '@cc/component/Action';
+import { APPEND_RECORDS, RECORD_EXECUTE, RECORD_REFETCH } from './Constants';
+import { RECORD_FAILURE, RECORD_SUCCESS } from './Symbols';
+
+const Actions: Action[] = [
+  {
+    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/src/bc/zrecord/Constants.ts

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

package/src/bc/zrecord/EventHandlers.ts

@@ -0,0 +1,14 @@
+import EventHandlers, { EventHandler } from '@cc/component/EventHandlers';
+import { APPEND_RECORDS, RECORD_EXECUTE, RECORD_FETCH_MORE, RECORD_REFETCH } from './Constants';
+
+import { FETCH_FAILED, FETCH_SUCCESS, FETCH_SUCCESS_NO_CONTENT } from '@bc/zhttp/Constants';
+
+export default interface ZRecordEventHandlers extends EventHandlers {
+  [RECORD_REFETCH]: EventHandler;
+  [RECORD_EXECUTE]: EventHandler;
+  [RECORD_FETCH_MORE]: EventHandler;
+  [FETCH_SUCCESS_NO_CONTENT]: EventHandler;
+  [FETCH_SUCCESS]: EventHandler;
+  [FETCH_FAILED]: EventHandler;
+  [APPEND_RECORDS]: EventHandler;
+}

package/src/bc/zrecord/Properties.ts

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

package/src/bc/zrecord/Symbols.ts

@@ -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/src/cc/action-icon/Constants.ts

@@ -0,0 +1,5 @@
+class Constants {
+  static ACTION_ICON_CLICKED = "ACTION_ICON#CLICKED";
+}
+
+export default Constants;

package/src/cc/action-icon/Model.ts

@@ -0,0 +1,20 @@
+enum HoverVariant {
+  primary = 'primary',
+  danger = 'danger'
+}
+
+type ModelInput = {
+  icon: string;
+  label: string;
+  hoverVariant: HoverVariant;
+};
+
+function Model({ icon, label, hoverVariant }: ModelInput) {
+  return {
+    icon,
+    label,
+    hoverVariant
+  };
+}
+
+export default Model;

package/src/cc/action-icon/Properties.ts

@@ -0,0 +1,31 @@
+export default {
+  icon: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  },
+  label: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  },
+  hoverVariant: {
+    required: false,
+    defaultValue: "primary",
+    typeMetadata: {
+      schema: {
+        type: "string",
+        enum: [
+          "primary",
+          "danger"
+        ]
+      }
+    }
+  }
+};

package/src/cc/action-icon/index.ts

@@ -0,0 +1,3 @@
+export { default as ActionIconProperties } from "./Properties";
+export { default as ActionIconModel } from "./Model";
+export { default as ActionIconConstants } from "./Constants";

package/src/cc/action-location/Constants.ts

@@ -0,0 +1,7 @@
+class ActionLocationConstants {
+  static readonly MOUNT = 'ActionLocation#MOUNT';
+  static readonly UPDATE_PROPERTIES = 'ActionLocation#UPDATE_PROPERTIES';
+  static readonly UNMOUNT = 'ActionLocation#UNMOUNT';
+}
+
+export default ActionLocationConstants;

package/src/cc/action-location/Properties.ts

@@ -0,0 +1,10 @@
+export default {
+  actions: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: 'array'
+      }
+    }
+  }
+};

package/src/cc/architecture/IController.ts

@@ -0,0 +1,5 @@
+interface IController<T> {
+  handle(input: T): void;
+}
+
+export default IController;

package/src/cc/architecture/IUseCase.ts

@@ -0,0 +1,4 @@
+interface IUseCase<T> {
+  execute(input: T): void;
+}
+export default IUseCase;

package/src/cc/architecture/LifeCycleActionEnum.ts

@@ -0,0 +1,7 @@
+enum LifeCycleAction {
+  MOUNT = 'MOUNT',
+  UN_MOUNT = 'UN_MOUNT',
+  UPDATE_PROPERTIES = 'UPDATE_PROPERTIES'
+}
+
+export default LifeCycleAction;

package/src/cc/avatar/ActionHandlers.ts

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

package/src/cc/avatar/Actions.ts

@@ -0,0 +1,7 @@
+import Constants from "./Constants";
+
+export default [
+  {
+    type: Constants.AVATAR_CLICKED
+  }
+];

package/src/cc/avatar/Constants.ts

@@ -0,0 +1,5 @@
+class Constants {
+  static AVATAR_CLICKED = "AVATAR#CLICKED";
+}
+
+export default Constants;

package/src/cc/avatar/Data.ts

@@ -0,0 +1,17 @@
+enum Size {
+  XSmall = "xsmall",
+  Small = "small",
+  Medium = "medium",
+  Large = "large",
+  XLarge = "xlarge"
+}
+
+type AvatarDataType = {
+  name: string,
+  imageSrc?: string,
+  label?: string,
+  size: Size,
+  tooltip?: string
+}
+
+export default AvatarDataType;

package/src/cc/avatar/Model.ts

@@ -0,0 +1,16 @@
+function Model({
+  name,
+  imageSrc,
+  label,
+  size,
+  tooltip
+}) {
+  return {
+    name,
+    imageSrc,
+    label,
+    size,
+    tooltip
+  };
+}
+export default Model;

package/src/cc/avatar/Properties.ts

@@ -0,0 +1,50 @@
+export default {
+  name: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  },
+  imageSrc: {
+    required: false,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  },
+  label: {
+    required: false,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  },
+  size: {
+    required: false,
+    defaultValue: "medium",
+    typeMetadata: {
+      schema: {
+        type: "string",
+        enum: [
+          "xsmall",
+          "small",
+          "medium",
+          "large",
+          "xlarge"
+        ]
+      }
+    }
+  },
+  tooltip: {
+    required: true,
+    typeMetadata: {
+      schema: {
+        type: "string"
+      }
+    }
+  }
+};

package/src/cc/avatar/index.ts

@@ -0,0 +1,5 @@
+export { default as AvatarProperties } from "./Properties";
+export { default as AvatarModel } from "./Model";
+export { default as AvatarActions } from "./Actions";
+export { default as AvatarActionHandlers } from "./ActionHandlers";
+export { default as AvatarConstants} from "./Constants";

package/src/cc/checkbox/ActionHandlers.ts

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

package/src/cc/checkbox/Actions.ts

@@ -0,0 +1,7 @@
+import Constants from "./Constants";
+
+export default [
+  {
+    type: Constants.CHECKBOX_TOGGLED
+  }
+];

package/src/cc/checkbox/Constants.ts

@@ -0,0 +1,5 @@
+class Constants {
+  static readonly CHECKBOX_TOGGLED = "CHECKBOX#TOGGLED";
+}
+
+export default Constants;

package/src/cc/checkbox/Data.ts

@@ -0,0 +1,9 @@
+type CheckboxDataType = {
+  checked: boolean,
+  disabled?: boolean,
+  readonly?: boolean,
+  label?: string,
+  tooltip?: string
+}
+
+export default CheckboxDataType;