@vuu-ui/vuu-data-types 0.13.13 → 0.13.14

package/index.d.ts

@@ -177,6 +177,8 @@ type Depth = number;
 type ChildCount = number;
 type RowKey = string;
 export declare type IsSelected = number;
+type Timestamp = number;
+type IsNew = boolean;
 
 export declare type DataSourceRow = [
   RowIndex,
@@ -187,6 +189,8 @@ export declare type DataSourceRow = [
   ChildCount,
   RowKey,
   IsSelected,
+  Timestamp,
+  IsNew,
   ...VuuRowDataItemType[],
 ];
 
@@ -435,6 +439,7 @@ export type DataSourceConfigChangeHandler = (
 
 export declare type DataSourceEvents = {
   config: DataSourceConfigChangeHandler;
+  freeze: (isFrozen: boolean, freezeTimeStamp: number) => void;
   optimize: (optimize: OptimizeStrategy) => void;
   "page-count": (pageCount: number) => void;
   range: (range: Range) => void;
@@ -542,6 +547,25 @@ export interface DataSource
   closeTreeNode: (keyOrIndex: string | number, cascade?: boolean) => void;
   columns: string[];
   config: WithBaseFilter<WithFullConfig>;
+  /**
+   * Applies a time filter to the viewport such that no new records created after the
+   * freeze are sent to client. This makes client's view stable, even when large numbers
+   * of new records are being created. The price is that view becomes stale. DataSource
+   * implementation is not required to support this functionality.
+   */
+  freeze?: () => void;
+  /**
+   * Removes the 'freeze' filter. See 'freeze' above.
+   */
+  unfreeze?: () => void;
+  /**
+   * see 'freeze' above. true if 'freeze' has previoulsy been called.
+   */
+  isFrozen?: boolean;
+  /**
+   * see 'freeze' above. If frozen, the time at which freeze was applied.
+   */
+  freezeTimestamp?: number | undefined;
   status: DataSourceStatus;
   /**
    *
@@ -827,6 +851,12 @@ export interface VuuUIMessageOutSetTitle extends ViewportMessageOut {
   type: "setTitle";
 }
 
+export interface VuuUIMessageOutFreeze extends ViewportMessageOut {
+  type: "FREEZE_VP";
+}
+export interface VuuUIMessageOutUnfreeze extends ViewportMessageOut {
+  type: "UNFREEZE_VP";
+}
 export interface VuuUIMessageOutDisable extends ViewportMessageOut {
   type: "disable";
 }
@@ -865,6 +895,8 @@ export interface VuuUIMessageOutConfig extends ViewportMessageOut {
 export declare type VuuUIMessageOutViewport =
   | VuuUIMessageOutCloseTreeNode
   | VuuUIMessageOutConfig
+  | VuuUIMessageOutFreeze
+  | VuuUIMessageOutUnfreeze
   | VuuUIMessageOutDisable
   | VuuUIMessageOutEnable
   | VuuUIMessageOutOpenTreeNode

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vuu-ui/vuu-data-types",
-  "version": "0.13.13",
+  "version": "0.13.14",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-filter-types": "0.13.13",
-    "@vuu-ui/vuu-protocol-types": "0.13.13"
+    "@vuu-ui/vuu-filter-types": "0.13.14",
+    "@vuu-ui/vuu-protocol-types": "0.13.14"
   },
   "dependencies": {},
   "peerDependencies": {},