@vuu-ui/vuu-protocol-types 0.8.21-debug → 0.8.22-debug

package/index.d.ts

@@ -0,0 +1,542 @@
+// prettier-ignore
+export declare type VuuColumnDataType = "int" | "long" | "double" | "string" | "char" | "boolean";
+export declare type VuuMenuContext = "cell" | "row" | "grid" | "selected-rows";
+export declare type VuuTable = {
+  table: string;
+  module: string;
+};
+export declare type VuuRange = {
+  from: number;
+  to: number;
+};
+
+export declare type VuuSortType = "A" | "D";
+
+export declare type VuuSortCol = {
+  column: string;
+  sortType: VuuSortType;
+};
+export declare type VuuSort = {
+  sortDefs: VuuSortCol[];
+};
+export declare type VuuFilter = {
+  filter: string;
+};
+export interface VuuMenuItem {
+  context: VuuMenuContext;
+  filter: string;
+  name: string;
+  rpcName: string;
+}
+
+export interface VuuMenu {
+  name: string;
+  menus: (VuuMenuItem | VuuMenu)[];
+}
+
+export type VuuRowDataItemType = string | number | boolean;
+
+export type VuuDataRow = VuuRowDataItemType[];
+
+export declare type VuuRow = {
+  data: VuuDataRow;
+  rowIndex: number;
+  rowKey: string;
+  sel: 0 | 1;
+  ts: number;
+  updateType: "U" | "D" | "SIZE";
+  viewPortId: string;
+  vpSize: number;
+  vpVersion: string;
+};
+export declare type AggTypeSum = 1;
+export declare type AggTypeAverage = 2;
+export declare type AggTypeCount = 3;
+export declare type AggTypeHigh = 4;
+export declare type AggTypeLow = 5;
+export declare type AggTypeDistinct = 6;
+export declare type VuuAggType =
+  | AggTypeSum
+  | AggTypeAverage
+  | AggTypeCount
+  | AggTypeHigh
+  | AggTypeLow
+  | AggTypeDistinct;
+export declare type VuuAggregation = {
+  column: string;
+  aggType: VuuAggType;
+};
+
+export interface VuuLink {
+  fromColumn: string;
+  toTable: string;
+  toColumn: string;
+}
+
+export declare type VuuLinkDescriptor = {
+  parentVpId: string;
+  link: VuuLink;
+};
+
+/**
+ * LinkDescriptor with label is not strictly part of the Vuu Protocol
+ *
+ * The Label is added by client code, if user has assigned a custom
+ * Title to component bound to viewport.
+ * The parentClientVpId is also added by client. This is needed as the
+ * client vpId persists across sessions, whereas the server vpId does
+ * not.
+ */
+export type LinkDescriptorWithLabel = VuuLinkDescriptor & {
+  label?: string;
+  parentClientVpId: string;
+};
+
+export declare type VuuColumns = string[];
+export declare type VuuGroupBy = string[];
+export interface ServerToClientHeartBeat {
+  type: "HB";
+  ts: number;
+}
+export interface ServerToClientLoginSuccess {
+  type: "LOGIN_SUCCESS";
+  token: string;
+}
+export interface ServerToClientTableList {
+  type: "TABLE_LIST_RESP";
+  tables: VuuTable[];
+}
+
+export type VuuTableList = Pick<ServerToClientTableList, "tables">;
+
+export interface VuuTableMeta {
+  columns: VuuColumns;
+  dataTypes: VuuColumnDataType[];
+  key: string;
+}
+export interface VuuTableMetaWithTable extends VuuTableMeta {
+  table: VuuTable;
+}
+
+export interface ServerToClientTableMeta extends VuuTableMetaWithTable {
+  type: "TABLE_META_RESP";
+}
+
+export type VuuTableMeta = Pick<
+  ServerToClientTableMeta,
+  "columns" | "dataTypes" | "table"
+>;
+
+export interface ServerToClientMenus {
+  type: "VIEW_PORT_MENUS_RESP";
+  menu: VuuMenu;
+  vpId: string;
+}
+
+//TODO not all menu messages are "ADD_ROWS_TO_ORDERS"
+export interface ServerToClientMenu {
+  rpcName: "ADD_ROWS_TO_ORDERS";
+  type: "VIEW_PORT_MENU_RESP";
+  action: null | {
+    table?: VuuTable;
+    type: "OPEN_DIALOG_ACTION";
+  };
+  vpId: string;
+}
+
+export interface ServerToClientMenuReject {
+  error: string;
+  rpcName: string;
+  type: "VIEW_PORT_MENU_REJ";
+  vpId: string;
+}
+
+export interface ServerToClientMenuSessionTableAction
+  extends ServerToClientMenu {
+  action: {
+    table: VuuTable;
+    type: "OPEN_DIALOG_ACTION";
+  };
+}
+
+export interface ServerToClientViewPortVisualLinks {
+  type: "VP_VISUAL_LINKS_RESP";
+  links: VuuLinkDescriptor[];
+  vpId: string;
+}
+export interface ServerToClientCreateViewPortSuccess {
+  aggregations: VuuAggregation[];
+  columns: VuuColumns;
+  filterSpec: VuuFilter;
+  groupBy: VuuGroupBy;
+  range: VuuRange;
+  sort: VuuSort;
+  type: "CREATE_VP_SUCCESS";
+  table: string;
+  viewPortId: string;
+}
+export interface ServerToClientChangeViewPortSuccess {
+  aggregations: VuuAggregation[];
+  columns: VuuColumns;
+  filterSpec: VuuFilter;
+  groupBy: VuuGroupBy;
+  sort: VuuSort;
+  type: "CHANGE_VP_SUCCESS";
+  viewPortId: string;
+}
+export interface ServerToClientChangeViewPortRangeSuccess {
+  type: "CHANGE_VP_RANGE_SUCCESS";
+  viewPortId: string;
+  from: number;
+  to: number;
+}
+export interface ServerToClientDisableViewPortSuccess {
+  type: "DISABLE_VP_SUCCESS";
+  viewPortId: string;
+}
+export interface ServerToClientEnableViewPortSuccess {
+  type: "ENABLE_VP_SUCCESS";
+  viewPortId: string;
+}
+export interface ServerToClientRemoveViewPortSuccess {
+  type: "REMOVE_VP_SUCCESS";
+  viewPortId: string;
+}
+export interface ServerToClientSelectSuccess {
+  type: "SET_SELECTION_SUCCESS";
+  vpId: string;
+}
+export interface ServerToClientRPC {
+  type: "RPC_RESP";
+  method: string;
+  result: any;
+}
+
+// TODO flesh out as we know more
+export interface ServerToClientViewportRpcResponse {
+  action: {
+    key?: string;
+    msg?: string;
+    type: "VP_RPC_FAILURE" | "VP_RPC_SUCCESS" | "VP_CREATE_SUCCESS";
+  };
+  type: "VIEW_PORT_RPC_REPONSE";
+  method: string;
+  namedParams: { [key: string]: VuuRowDataItemType };
+  params: string[];
+  vpId: string;
+}
+
+export interface ServerToClientEditRPC {
+  action: unknown;
+  type: "VP_EDIT_RPC_RESPONSE";
+  rpcName: string;
+  vpId: string;
+}
+export interface ServerToClientEditRPCRejected {
+  error: string;
+  rpcName: string;
+  type: "VP_EDIT_RPC_REJECT";
+  vpId: string;
+}
+export interface ServerToClientOpenTreeNodeSuccess {
+  type: "OPEN_TREE_SUCCESS";
+}
+export interface ServerToClientCloseTreeNodeSuccess {
+  type: "CLOSE_TREE_SUCCESS";
+}
+export interface ServerToClientError {
+  msg: string;
+  type: "ERROR";
+}
+export interface ServerToClientCreateLinkSuccess {
+  childVpId: string;
+  childColumnName: string;
+  parentVpId: string;
+  parentColumnName: string;
+  type: "CREATE_VISUAL_LINK_SUCCESS";
+}
+export interface ServerToClientRemoveLinkSuccess {
+  childVpId: string;
+  type: "REMOVE_VISUAL_LINK_SUCCESS";
+}
+export interface ServerToClientTableRows {
+  batch: string;
+  isLast: boolean;
+  rows: VuuRow[];
+  timeStamp: number;
+  type: "TABLE_ROW";
+}
+export declare type ServerToClientBody =
+  | ServerToClientHeartBeat
+  | ServerToClientLoginSuccess
+  | ServerToClientCreateViewPortSuccess
+  | ServerToClientChangeViewPortSuccess
+  | ServerToClientChangeViewPortRangeSuccess
+  | ServerToClientDisableViewPortSuccess
+  | ServerToClientEnableViewPortSuccess
+  | ServerToClientRemoveViewPortSuccess
+  | ServerToClientSelectSuccess
+  | ServerToClientTableMeta
+  | ServerToClientTableList
+  | ServerToClientTableRows
+  | ServerToClientMenus
+  | ServerToClientMenu
+  | ServerToClientMenuReject
+  | ServerToClientMenuSessionTableAction
+  | ServerToClientRPC
+  | ServerToClientViewportRpcResponse
+  | ServerToClientViewPortVisualLinks
+  | ServerToClientOpenTreeNodeSuccess
+  | ServerToClientCloseTreeNodeSuccess
+  | ServerToClientCreateLinkSuccess
+  | ServerToClientRemoveLinkSuccess
+  | ServerToClientError
+  | ServerToClientEditRPC
+  | ServerToClientEditRPC
+  | ServerToClientEditRPCRejected;
+export interface ServerToClientMessage<
+  TBody extends ServerToClientBody = ServerToClientBody
+> {
+  body: TBody;
+  module: string;
+  requestId: string;
+  sessionId?: string;
+  token: string;
+  user: string;
+}
+export interface ClientToServerAuth {
+  type: "AUTH";
+  username: string;
+  password: string;
+}
+export interface ClientToServerLogin {
+  token: string;
+  type: "LOGIN";
+  user: string;
+}
+export interface ClientToServerHeartBeat {
+  type: "HB_RESP";
+  ts: number;
+}
+export interface ClientToServerDisable {
+  type: "DISABLE_VP";
+  viewPortId: string;
+}
+export interface ClientToServerEnable {
+  type: "ENABLE_VP";
+  viewPortId: string;
+}
+export interface ClientToServerTableList {
+  type: "GET_TABLE_LIST";
+}
+export interface ClientToServerTableMeta {
+  type: "GET_TABLE_META";
+  table: VuuTable;
+}
+export interface ClientToServerCreateViewPort {
+  columns: VuuColumns;
+  filterSpec: VuuFilter;
+  groupBy: string[];
+  type: "CREATE_VP";
+  range: VuuRange;
+  sort: VuuSort;
+  table: VuuTable;
+}
+export interface ClientToServerChangeViewPort {
+  aggregations: VuuAggregation[];
+  columns: VuuColumns;
+  filterSpec: VuuFilter;
+  groupBy: string[];
+  sort: VuuSort;
+  type: "CHANGE_VP";
+  viewPortId: string;
+}
+export interface ClientToServerRemoveViewPort {
+  type: "REMOVE_VP";
+  viewPortId: string;
+}
+export interface ClientToServerSelection {
+  type: "SET_SELECTION";
+  selection: number[];
+  vpId: string;
+}
+export interface ClientToServerViewPortRange {
+  from: number;
+  to: number;
+  type: "CHANGE_VP_RANGE";
+  viewPortId: string;
+}
+export interface ClientToServerVisualLinks {
+  type: "GET_VP_VISUAL_LINKS";
+  vpId: string;
+}
+export interface ClientToServerMenus {
+  type: "GET_VIEW_PORT_MENUS";
+  vpId: string;
+}
+export interface ClientToServerOpenTreeNode {
+  type: "OPEN_TREE_NODE";
+  vpId: string;
+  treeKey: string;
+}
+export interface ClientToServerCloseTreeNode {
+  type: "CLOSE_TREE_NODE";
+  vpId: string;
+  treeKey: string;
+}
+export interface ClientToServerCreateLink {
+  childVpId: string;
+  parentColumnName: string;
+  parentVpId: string;
+  type: "CREATE_VISUAL_LINK";
+}
+export interface ClientToServerRemoveLink {
+  childVpId: string;
+  type: "REMOVE_VISUAL_LINK";
+}
+
+export declare type RpcService = "TypeAheadRpcHandler" | "OrderEntryRpcHandler";
+
+export declare type TypeaheadParams =
+  | [VuuTable, string]
+  | [VuuTable, string, string];
+
+export declare type TypeAheadMethod =
+  | "getUniqueFieldValues"
+  | "getUniqueFieldValuesStartingWith";
+
+export declare type RpcMethod = TypeAheadMethod | "addRowsFromInstruments";
+
+export interface ClientToServerViewportRpcCall {
+  type: "VIEW_PORT_RPC_CALL";
+  rpcName: string;
+  namedParams: { [key: string]: VuuRowDataItemType };
+  params: string[];
+  vpId: string;
+}
+
+export interface ClientToServerGetUniqueValues {
+  type: "RPC_CALL";
+  method: "getUniqueFieldValues";
+  service: "TypeAheadRpcHandler";
+  params: [VuuTable, string];
+}
+export interface ClientToServerGetUniqueValuesStartingWith {
+  type: "RPC_CALL";
+  method: "getUniqueFieldValuesStartingWith";
+  service: "TypeAheadRpcHandler";
+  params: [VuuTable, string, string];
+}
+
+export declare type VuuRpcRequest =
+  | ClientToServerGetUniqueValues
+  | ClientToServerGetUniqueValuesStartingWith;
+// add remaining Rpc calls here
+
+export interface ClientToServerMenuBaseRPC {
+  rpcName: string;
+  vpId: string;
+}
+export interface ClientToServerMenuSelectRPC extends ClientToServerMenuBaseRPC {
+  type: "VIEW_PORT_MENUS_SELECT_RPC";
+}
+export interface ClientToServerMenuTableRPC extends ClientToServerMenuBaseRPC {
+  type: "VIEW_PORT_MENU_TABLE_RPC";
+}
+
+export type VuuRowRecord = { [key: string]: VuuRowDataItemType };
+export interface ClientToServerMenuRowRPC extends ClientToServerMenuBaseRPC {
+  type: "VIEW_PORT_MENU_ROW_RPC";
+  rowKey: string;
+  row: VuuRowRecord;
+}
+export interface ClientToServerMenuCellRPC extends ClientToServerMenuBaseRPC {
+  field: string;
+  rowKey: string;
+  value: VuuColumnDataType;
+  type: "VIEW_PORT_MENU_CELL_RPC";
+}
+
+export interface ClientToServerEditCellRpc {
+  rowKey: string;
+  type: "VP_EDIT_CELL_RPC";
+  field: string;
+  value: VuuRowDataItemType;
+}
+export interface ClientToServerEditRowRpc {
+  rowKey: string;
+  type: "VP_EDIT_ROW_RPC";
+  row: VuuDataRow;
+}
+
+export type VuuDataRowDto = { [key: string]: VuuRowDataItemType };
+export interface ClientToServerAddRowRpc {
+  rowKey: string;
+  type: "VP_EDIT_ADD_ROW_RPC";
+  data: VuuDataRowDto;
+}
+export interface ClientToServerDeleteRowRpc {
+  rowKey: string;
+  type: "VP_EDIT_DELETE_ROW_RPC";
+}
+export interface ClientToServerSubmitFormRpc {
+  type: "VP_EDIT_SUBMIT_FORM_RPC";
+}
+
+export type ClientToServerEditRpc =
+  | ClientToServerEditCellRpc
+  | ClientToServerAddRowRpc
+  | ClientToServerDeleteRowRpc
+  | ClientToServerEditRowRpc
+  | ClientToServerSubmitFormRpc;
+
+export type ClientToServerMenuRPC =
+  | ClientToServerMenuRowRPC
+  | ClientToServerMenuCellRPC
+  | ClientToServerMenuSelectRPC
+  | ClientToServerMenuTableRPC;
+
+export type ClientToServerMenuRPCType =
+  | "VIEW_PORT_MENUS_SELECT_RPC"
+  | "VIEW_PORT_MENU_TABLE_RPC"
+  | "VIEW_PORT_MENU_ROW_RPC"
+  | "VIEW_PORT_MENU_CELL_RPC";
+
+export declare type VuuRpcMessagesOut =
+  | ClientToServerMenuSelectRPC
+  | ClientToServerEditCellRpc;
+
+export declare type ClientToServerBody =
+  | ClientToServerAuth
+  | ClientToServerLogin
+  | ClientToServerHeartBeat
+  | ClientToServerDisable
+  | ClientToServerEnable
+  | ClientToServerTableList
+  | ClientToServerTableMeta
+  | ClientToServerCreateViewPort
+  | ClientToServerChangeViewPort
+  | ClientToServerRemoveViewPort
+  | ClientToServerSelection
+  | ClientToServerViewPortRange
+  | ClientToServerVisualLinks
+  | ClientToServerMenus
+  | ClientToServerOpenTreeNode
+  | ClientToServerCloseTreeNode
+  | ClientToServerCreateLink
+  | ClientToServerRemoveLink
+  | ClientToServerMenuRPC
+  | ClientToServerViewportRpcCall
+  | VuuRpcRequest;
+export interface ClientToServerMessage<
+  TBody extends ClientToServerBody = ClientToServerBody
+> {
+  body: TBody;
+  module: string;
+  requestId: string;
+  sessionId: string;
+  token: string;
+  user: string;
+}
+
+/** Menu RPC services */

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@vuu-ui/vuu-protocol-types",
-  "version": "0.8.21-debug",
+  "version": "0.8.22-debug",
   "author": "heswell",
   "license": "Apache-2.0",
   "dependencies": {},
   "peerDependencies": {},
   "files": [
+    "index.d.ts",
     "index.d.ts",
     "README.md"
   ],