@deephaven/storage 0.43.0 → 0.44.1-beta.0

package/dist/Storage.js

@@ -0,0 +1,6 @@
+export var SortDirection;
+(function (SortDirection) {
+  SortDirection["ASC"] = "asc";
+  SortDirection["DESC"] = "desc";
+})(SortDirection || (SortDirection = {}));
+//# sourceMappingURL=Storage.js.map

package/dist/Storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.js","names":["SortDirection"],"sources":["../src/Storage.ts"],"sourcesContent":["export type FilterValue = number | string | string[];\n\nexport type FilterConfigItem = {\n  columnName: string;\n  type: string;\n  value: FilterValue;\n};\n\nexport type FilterConfig = {\n  filterItems: FilterConfigItem[];\n  filterOperators: string[];\n};\n\nexport enum SortDirection {\n  ASC = 'asc',\n  DESC = 'desc',\n}\n\nexport type SortConfig = {\n  column: string;\n  direction: SortDirection;\n};\n\nexport type IndexRange = number[];\n\nexport interface Storage<T extends StorageItem> {\n  getTable(): Promise<StorageTable<T>>;\n  close(): void;\n}\n\nexport interface StorageTable<T extends StorageItem> {\n  getViewportData(): Promise<ViewportData<T>>;\n  getSnapshot(sortedRanges: IndexRange[]): Promise<StorageSnapshot<T>>;\n  setViewport(viewport: StorageTableViewport): void;\n  setFilters(config: FilterConfig[] | null): void;\n  setSorts(config: SortConfig[] | null): void;\n  setReversed(isReversed: boolean): void;\n  close(): void;\n  onUpdate(callback: ViewportUpdateCallback<T>): StorageListenerRemover;\n  size: number;\n}\n\nexport interface StorageItem {\n  id: string;\n}\n\nexport interface UnsavedStorageItem {\n  id: undefined;\n}\n\nexport type StorageTableViewport = {\n  top: number;\n  bottom: number;\n  columns?: string[];\n};\n\nexport type StorageSnapshot<T extends StorageItem> = Map<number, T>;\n\nexport type ViewportData<T extends StorageItem> = {\n  items: T[];\n  offset: number;\n};\n\nexport type ViewportUpdateCallback<T extends StorageItem> = (\n  viewportUpdate: ViewportData<T>\n) => void;\n\nexport type StorageListenerRemover = () => void;\n\nexport type StorageItemListener<T extends StorageItem> = (update: T) => void;\n\nexport type StorageErrorListener = (error: string) => void;\n"],"mappings":"AAaA,WAAYA,aAAa;AAGxB,WAHWA,aAAa;EAAbA,aAAa;EAAbA,aAAa;AAAA,GAAbA,aAAa,KAAbA,aAAa"}

package/dist/StorageTableViewportUpdater.js

@@ -0,0 +1,63 @@
+import { useEffect, useMemo } from 'react';
+import Log from '@deephaven/log';
+import throttle from 'lodash.throttle';
+var UPDATE_DELAY = 150;
+var ROW_BUFFER_PAGES = 3;
+var log = Log.module('StorageTableViewportUpdater');
+export function StorageTableViewportUpdater(_ref) {
+  var {
+    table,
+    columns,
+    top = 0,
+    bottom = 0,
+    filters,
+    sorts,
+    isReversed = false,
+    onUpdate
+  } = _ref;
+  var throttledUpdateViewport = useMemo(() => throttle(viewport => {
+    var viewHeight = viewport.bottom - viewport.top;
+    var bufferedTop = Math.max(0, viewport.top - viewHeight * ROW_BUFFER_PAGES);
+    var bufferedBottom = viewport.bottom + viewHeight * ROW_BUFFER_PAGES;
+    table.setViewport({
+      top: bufferedTop,
+      bottom: bufferedBottom,
+      columns: viewport.columns
+    });
+  }, UPDATE_DELAY), [table]);
+  useEffect(function updateViewportAndReturnCleanup() {
+    var cleanup = table.onUpdate(viewportData => {
+      var _viewportData$items, _viewportData$offset;
+      onUpdate({
+        items: (_viewportData$items = viewportData.items) !== null && _viewportData$items !== void 0 ? _viewportData$items : [],
+        offset: (_viewportData$offset = viewportData.offset) !== null && _viewportData$offset !== void 0 ? _viewportData$offset : 0
+      });
+    });
+    return () => {
+      log.debug('onUpdate cleanup');
+      cleanup();
+    };
+  }, [table, onUpdate]);
+  useEffect(function updateFilters() {
+    table.setFilters(filters !== null && filters !== void 0 ? filters : null);
+  }, [table, filters]);
+  useEffect(function updateSorts() {
+    table.setSorts(sorts !== null && sorts !== void 0 ? sorts : null);
+  }, [table, sorts]);
+  useEffect(function updateViewport() {
+    throttledUpdateViewport({
+      top,
+      bottom,
+      columns
+    });
+  }, [throttledUpdateViewport, top, bottom, columns, filters, sorts, isReversed]);
+  useEffect(function cleanupUpdateViewport() {
+    return () => {
+      log.debug2('Cancel throttledUpdateViewport');
+      throttledUpdateViewport.cancel();
+    };
+  }, [throttledUpdateViewport]);
+  return null;
+}
+export default StorageTableViewportUpdater;
+//# sourceMappingURL=StorageTableViewportUpdater.js.map

package/dist/StorageTableViewportUpdater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageTableViewportUpdater.js","names":["useEffect","useMemo","Log","throttle","UPDATE_DELAY","ROW_BUFFER_PAGES","log","module","StorageTableViewportUpdater","table","columns","top","bottom","filters","sorts","isReversed","onUpdate","throttledUpdateViewport","viewport","viewHeight","bufferedTop","Math","max","bufferedBottom","setViewport","updateViewportAndReturnCleanup","cleanup","viewportData","items","offset","debug","updateFilters","setFilters","updateSorts","setSorts","updateViewport","cleanupUpdateViewport","debug2","cancel"],"sources":["../src/StorageTableViewportUpdater.ts"],"sourcesContent":["import { useEffect, useMemo } from 'react';\nimport Log from '@deephaven/log';\nimport throttle from 'lodash.throttle';\nimport {\n  FilterConfig,\n  SortConfig,\n  StorageItem,\n  StorageTable,\n  StorageTableViewport,\n  ViewportData,\n  ViewportUpdateCallback,\n} from './Storage';\n\nexport type StorageTableViewportUpdaterProps<T extends StorageItem> = {\n  table: StorageTable<T>;\n  columns?: string[];\n  top?: number;\n  bottom?: number;\n  filters?: FilterConfig[];\n  sorts?: SortConfig[];\n  isReversed?: boolean;\n  onUpdate: ViewportUpdateCallback<T>;\n};\n\nconst UPDATE_DELAY = 150;\n\nconst ROW_BUFFER_PAGES = 3;\n\nconst log = Log.module('StorageTableViewportUpdater');\n\nexport function StorageTableViewportUpdater<\n  T extends StorageItem = StorageItem\n>({\n  table,\n  columns,\n  top = 0,\n  bottom = 0,\n  filters,\n  sorts,\n  isReversed = false,\n  onUpdate,\n}: StorageTableViewportUpdaterProps<T>): null {\n  const throttledUpdateViewport = useMemo(\n    () =>\n      throttle((viewport: StorageTableViewport) => {\n        const viewHeight = viewport.bottom - viewport.top;\n        const bufferedTop = Math.max(\n          0,\n          viewport.top - viewHeight * ROW_BUFFER_PAGES\n        );\n        const bufferedBottom = viewport.bottom + viewHeight * ROW_BUFFER_PAGES;\n\n        table.setViewport({\n          top: bufferedTop,\n          bottom: bufferedBottom,\n          columns: viewport.columns,\n        });\n      }, UPDATE_DELAY),\n    [table]\n  );\n\n  useEffect(\n    function updateViewportAndReturnCleanup() {\n      const cleanup = table.onUpdate((viewportData: ViewportData<T>) => {\n        onUpdate({\n          items: viewportData.items ?? [],\n          offset: viewportData.offset ?? 0,\n        });\n      });\n\n      return () => {\n        log.debug('onUpdate cleanup');\n        cleanup();\n      };\n    },\n    [table, onUpdate]\n  );\n\n  useEffect(\n    function updateFilters() {\n      table.setFilters(filters ?? null);\n    },\n    [table, filters]\n  );\n\n  useEffect(\n    function updateSorts() {\n      table.setSorts(sorts ?? null);\n    },\n    [table, sorts]\n  );\n\n  useEffect(\n    function updateViewport() {\n      throttledUpdateViewport({\n        top,\n        bottom,\n        columns,\n      });\n    },\n    [throttledUpdateViewport, top, bottom, columns, filters, sorts, isReversed]\n  );\n\n  useEffect(\n    function cleanupUpdateViewport() {\n      return () => {\n        log.debug2('Cancel throttledUpdateViewport');\n        throttledUpdateViewport.cancel();\n      };\n    },\n    [throttledUpdateViewport]\n  );\n\n  return null;\n}\n\nexport default StorageTableViewportUpdater;\n"],"mappings":"AAAA,SAASA,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAC1C,OAAOC,GAAG,MAAM,gBAAgB;AAChC,OAAOC,QAAQ,MAAM,iBAAiB;AAsBtC,IAAMC,YAAY,GAAG,GAAG;AAExB,IAAMC,gBAAgB,GAAG,CAAC;AAE1B,IAAMC,GAAG,GAAGJ,GAAG,CAACK,MAAM,CAAC,6BAA6B,CAAC;AAErD,OAAO,SAASC,2BAA2B,OAWG;EAAA,IAT5C;IACAC,KAAK;IACLC,OAAO;IACPC,GAAG,GAAG,CAAC;IACPC,MAAM,GAAG,CAAC;IACVC,OAAO;IACPC,KAAK;IACLC,UAAU,GAAG,KAAK;IAClBC;EACmC,CAAC;EACpC,IAAMC,uBAAuB,GAAGhB,OAAO,CACrC,MACEE,QAAQ,CAAEe,QAA8B,IAAK;IAC3C,IAAMC,UAAU,GAAGD,QAAQ,CAACN,MAAM,GAAGM,QAAQ,CAACP,GAAG;IACjD,IAAMS,WAAW,GAAGC,IAAI,CAACC,GAAG,CAC1B,CAAC,EACDJ,QAAQ,CAACP,GAAG,GAAGQ,UAAU,GAAGd,gBAAgB,CAC7C;IACD,IAAMkB,cAAc,GAAGL,QAAQ,CAACN,MAAM,GAAGO,UAAU,GAAGd,gBAAgB;IAEtEI,KAAK,CAACe,WAAW,CAAC;MAChBb,GAAG,EAAES,WAAW;MAChBR,MAAM,EAAEW,cAAc;MACtBb,OAAO,EAAEQ,QAAQ,CAACR;IACpB,CAAC,CAAC;EACJ,CAAC,EAAEN,YAAY,CAAC,EAClB,CAACK,KAAK,CAAC,CACR;EAEDT,SAAS,CACP,SAASyB,8BAA8B,GAAG;IACxC,IAAMC,OAAO,GAAGjB,KAAK,CAACO,QAAQ,CAAEW,YAA6B,IAAK;MAAA;MAChEX,QAAQ,CAAC;QACPY,KAAK,yBAAED,YAAY,CAACC,KAAK,qEAAI,EAAE;QAC/BC,MAAM,0BAAEF,YAAY,CAACE,MAAM,uEAAI;MACjC,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,MAAM;MACXvB,GAAG,CAACwB,KAAK,CAAC,kBAAkB,CAAC;MAC7BJ,OAAO,EAAE;IACX,CAAC;EACH,CAAC,EACD,CAACjB,KAAK,EAAEO,QAAQ,CAAC,CAClB;EAEDhB,SAAS,CACP,SAAS+B,aAAa,GAAG;IACvBtB,KAAK,CAACuB,UAAU,CAACnB,OAAO,aAAPA,OAAO,cAAPA,OAAO,GAAI,IAAI,CAAC;EACnC,CAAC,EACD,CAACJ,KAAK,EAAEI,OAAO,CAAC,CACjB;EAEDb,SAAS,CACP,SAASiC,WAAW,GAAG;IACrBxB,KAAK,CAACyB,QAAQ,CAACpB,KAAK,aAALA,KAAK,cAALA,KAAK,GAAI,IAAI,CAAC;EAC/B,CAAC,EACD,CAACL,KAAK,EAAEK,KAAK,CAAC,CACf;EAEDd,SAAS,CACP,SAASmC,cAAc,GAAG;IACxBlB,uBAAuB,CAAC;MACtBN,GAAG;MACHC,MAAM;MACNF;IACF,CAAC,CAAC;EACJ,CAAC,EACD,CAACO,uBAAuB,EAAEN,GAAG,EAAEC,MAAM,EAAEF,OAAO,EAAEG,OAAO,EAAEC,KAAK,EAAEC,UAAU,CAAC,CAC5E;EAEDf,SAAS,CACP,SAASoC,qBAAqB,GAAG;IAC/B,OAAO,MAAM;MACX9B,GAAG,CAAC+B,MAAM,CAAC,gCAAgC,CAAC;MAC5CpB,uBAAuB,CAACqB,MAAM,EAAE;IAClC,CAAC;EACH,CAAC,EACD,CAACrB,uBAAuB,CAAC,CAC1B;EAED,OAAO,IAAI;AACb;AAEA,eAAeT,2BAA2B"}

package/dist/StorageUtils.js

@@ -0,0 +1,39 @@
+import { Operator as FilterOperator } from '@deephaven/filters';
+export class StorageUtils {
+  static makeSortConfig(columnName, direction) {
+    return {
+      column: columnName,
+      direction
+    };
+  }
+  static makeFilterConfig(filters) {
+    var filterItems = [];
+    var filterOperators = [];
+    filters.forEach((filterItem, i) => {
+      filterItems.push(filterItem);
+      if (i > 0) {
+        filterOperators.push(FilterOperator.and);
+      }
+    });
+    return {
+      filterItems,
+      filterOperators
+    };
+  }
+  static combineFilterConfigs(config1, config2) {
+    var operator = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : FilterOperator.and;
+    return {
+      filterItems: [...config1.filterItems, ...config2.filterItems],
+      filterOperators: [...config1.filterOperators, operator, ...config2.filterOperators]
+    };
+  }
+  static makeFilterItem(columnName, type, value) {
+    return {
+      columnName,
+      type,
+      value
+    };
+  }
+}
+export default StorageUtils;
+//# sourceMappingURL=StorageUtils.js.map

package/dist/StorageUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageUtils.js","names":["Operator","FilterOperator","StorageUtils","makeSortConfig","columnName","direction","column","makeFilterConfig","filters","filterItems","filterOperators","forEach","filterItem","i","push","and","combineFilterConfigs","config1","config2","operator","makeFilterItem","type","value"],"sources":["../src/StorageUtils.ts"],"sourcesContent":["import { Operator as FilterOperator } from '@deephaven/filters';\nimport {\n  FilterConfig,\n  FilterConfigItem,\n  FilterValue,\n  SortConfig,\n  SortDirection,\n} from './Storage';\n\nexport class StorageUtils {\n  static makeSortConfig(\n    columnName: string,\n    direction: SortDirection\n  ): SortConfig {\n    return { column: columnName, direction };\n  }\n\n  static makeFilterConfig(filters: FilterConfigItem[]): FilterConfig {\n    const filterItems: FilterConfigItem[] = [];\n    const filterOperators: string[] = [];\n    filters.forEach((filterItem, i) => {\n      filterItems.push(filterItem);\n      if (i > 0) {\n        filterOperators.push(FilterOperator.and);\n      }\n    });\n    return {\n      filterItems,\n      filterOperators,\n    };\n  }\n\n  static combineFilterConfigs(\n    config1: FilterConfig,\n    config2: FilterConfig,\n    operator = FilterOperator.and\n  ): FilterConfig {\n    return {\n      filterItems: [...config1.filterItems, ...config2.filterItems],\n      filterOperators: [\n        ...config1.filterOperators,\n        operator,\n        ...config2.filterOperators,\n      ],\n    };\n  }\n\n  static makeFilterItem(\n    columnName: string,\n    type: string,\n    value: FilterValue\n  ): FilterConfigItem {\n    return { columnName, type, value };\n  }\n}\n\nexport default StorageUtils;\n"],"mappings":"AAAA,SAASA,QAAQ,IAAIC,cAAc,QAAQ,oBAAoB;AAS/D,OAAO,MAAMC,YAAY,CAAC;EACxB,OAAOC,cAAc,CACnBC,UAAkB,EAClBC,SAAwB,EACZ;IACZ,OAAO;MAAEC,MAAM,EAAEF,UAAU;MAAEC;IAAU,CAAC;EAC1C;EAEA,OAAOE,gBAAgB,CAACC,OAA2B,EAAgB;IACjE,IAAMC,WAA+B,GAAG,EAAE;IAC1C,IAAMC,eAAyB,GAAG,EAAE;IACpCF,OAAO,CAACG,OAAO,CAAC,CAACC,UAAU,EAAEC,CAAC,KAAK;MACjCJ,WAAW,CAACK,IAAI,CAACF,UAAU,CAAC;MAC5B,IAAIC,CAAC,GAAG,CAAC,EAAE;QACTH,eAAe,CAACI,IAAI,CAACb,cAAc,CAACc,GAAG,CAAC;MAC1C;IACF,CAAC,CAAC;IACF,OAAO;MACLN,WAAW;MACXC;IACF,CAAC;EACH;EAEA,OAAOM,oBAAoB,CACzBC,OAAqB,EACrBC,OAAqB,EAEP;IAAA,IADdC,QAAQ,uEAAGlB,cAAc,CAACc,GAAG;IAE7B,OAAO;MACLN,WAAW,EAAE,CAAC,GAAGQ,OAAO,CAACR,WAAW,EAAE,GAAGS,OAAO,CAACT,WAAW,CAAC;MAC7DC,eAAe,EAAE,CACf,GAAGO,OAAO,CAACP,eAAe,EAC1BS,QAAQ,EACR,GAAGD,OAAO,CAACR,eAAe;IAE9B,CAAC;EACH;EAEA,OAAOU,cAAc,CACnBhB,UAAkB,EAClBiB,IAAY,EACZC,KAAkB,EACA;IAClB,OAAO;MAAElB,UAAU;MAAEiB,IAAI;MAAEC;IAAM,CAAC;EACpC;AACF;AAEA,eAAepB,YAAY"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./Storage.js";
+export * from "./StorageTableViewportUpdater.js";
+export * from "./StorageUtils.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './Storage';\nexport * from './StorageTableViewportUpdater';\nexport * from './StorageUtils';\n"],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/storage",
-  "version": "0.43.0",
+  "version": "0.44.1-beta.0+ba13c913",
   "description": "Deephaven Storage abstract classes for storing app data",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -21,8 +21,8 @@
     "build:babel": "babel ./src --out-dir ./dist --extensions \".ts,.tsx,.js,.jsx\" --source-maps --root-mode upward"
   },
   "dependencies": {
-    "@deephaven/filters": "^0.43.0",
-    "@deephaven/log": "^0.43.0",
+    "@deephaven/filters": "^0.44.1-beta.0+ba13c913",
+    "@deephaven/log": "^0.44.1-beta.0+ba13c913",
     "lodash.throttle": "^4.1.1"
   },
   "peerDependencies": {
@@ -35,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b16776b5bdc15a02cd2897cd79d562ea38c60ed8"
+  "gitHead": "ba13c9139b3b7a5f5d64d79069f1de9d4727eeb6"
 }