@vuu-ui/vuu-data-types 0.8.92 → 0.8.94

package/index.d.ts

@@ -15,6 +15,12 @@ import type {
   VuuSort,
   VuuTable,
   VuuRpcRequest,
+  VuuRpcServiceRequest,
+  VuuRpcMenuRequest,
+  VuuRpcViewportRequest,
+  VuuCreateVisualLink,
+  VuuRemoveVisualLink,
+  VuuTableList,
 } from "@vuu-ui/vuu-protocol-types";
 import type { DataSourceConfigChanges, IEventEmitter } from "@vuu-ui/vuu-utils";
 import type {
@@ -32,6 +38,7 @@ import type {
   VuuRange,
 } from "@vuu-ui/vuu-protocol-types";
 import { DataValueTypeDescriptor } from "@vuu-ui/vuu-table-types";
+import { PostMessageToClientCallback } from "@vuu-ui/vuu-data-remote";
 
 export declare type DataValueValidationSuccessResult = {
   ok: true;
@@ -211,6 +218,9 @@ export interface DataSourceAggregateMessage
 
 export type DataUpdateMode = "batch" | "update" | "size-only";
 
+export interface DataSourceClearMessage extends MessageWithClientViewportId {
+  type: "viewport-clear";
+}
 export interface DataSourceDataMessage extends MessageWithClientViewportId {
   mode: DataUpdateMode;
   rows?: DataSourceRow[];
@@ -315,6 +325,7 @@ export type DataSourceCallbackMessage =
   | DataSourceConfigMessage
   | DataSourceColumnsMessage
   | DataSourceDataMessage
+  | DataSourceClearMessage
   | DataSourceDebounceRequest
   | DataSourceDisabledMessage
   | DataSourceEnabledMessage
@@ -526,6 +537,11 @@ export interface DataSource
    */
   applyConfig: (
     config: DataSourceConfig,
+    /**
+     * If new config is missing attributes and these attributes are present on
+     * existing config, shoule the existing attributes be preserved ?
+     */
+    preserveExistingConfigAttributes?: boolean,
   ) => DataSourceConfigChanges | undefined;
   closeTreeNode: (key: string, cascade?: boolean) => void;
   columns: string[];
@@ -543,7 +559,7 @@ export interface DataSource
    * If an suspend is requested and not resumed within 3 seconds, it will automatically be promoted to a disable.,
    */
   suspend?: () => void;
-  resume?: () => void;
+  resume?: (callback?: SubscribeCallback) => void;
 
   deleteRow?: DataSourceDeleteHandler;
   /**
@@ -643,21 +659,6 @@ export declare type MenuRpcAction =
   | NoAction
   | ShowToastAction;
 
-export type ConnectionStatus =
-  | "connecting"
-  | "connection-open-awaiting-session"
-  | "connected"
-  | "disconnected"
-  | "failed"
-  | "reconnected";
-
-export interface ConnectionStatusMessage {
-  type: "connection-status";
-  reason?: string;
-  retry?: boolean;
-  status: ConnectionStatus;
-}
-
 export interface ConnectionQualityMetrics {
   type: "connection-metrics";
   messagesLength: number;
@@ -768,7 +769,7 @@ export type VuuUIMessageIn =
 export type WebSocketProtocol = string | string[] | undefined;
 
 export interface VuuUIMessageOutConnect {
-  protocol: WebSocketProtocol;
+  protocol?: WebSocketProtocol;
   type: "connect";
   token: string;
   url: string;
@@ -777,6 +778,10 @@ export interface VuuUIMessageOutConnect {
   retryLimitStartup?: number;
 }
 
+export interface VuuUIMessageOutDisconnect {
+  type: "disconnect";
+}
+
 export interface VuuUIMessageOutSubscribe extends ServerProxySubscribeMessage {
   type: "subscribe";
 }
@@ -895,8 +900,40 @@ export type WithRequestId<T> = T & { requestId: string };
 
 export type VuuUIMessageOut =
   | VuuUIMessageOutConnect
+  | VuuUIMessageOutDisconnect
   | VuuUIMessageOutSubscribe
   | VuuUIMessageOutUnsubscribe
   | VuuUIMessageOutViewport
-  | WithRequestId<VuuTableListRequest>
-  | WithRequestId<VuuTableMetaRequest>;
+  | WithRequestId<VuuTableListRequest | VuuTableMetaRequest>;
+
+export type ConnectOptions = {
+  url: string;
+  token: string;
+  username: string;
+  protocol?: WebSocketProtocol;
+  /** Max number of reconnect attempts in the event of unsuccessful websocket connection at startup */
+  retryLimitStartup?: number;
+  /** Max number of reconnect attempts in the event of a disconnected websocket connection */
+  retryLimitDisconnect?: number;
+};
+
+export interface ServerAPI {
+  destroy: (viewportId?: string) => void;
+  getTableSchema: (table: VuuTable) => Promise<TableSchema>;
+  getTableList: (module?: string) => Promise<VuuTableList>;
+  // TODO its not really unknown
+  rpcCall: <T = unknown>(
+    msg:
+      | VuuRpcServiceRequest
+      | VuuRpcMenuRequest
+      | VuuRpcViewportRequest
+      | VuuCreateVisualLink
+      | VuuRemoveVisualLink,
+  ) => Promise<T>;
+  send: (message: VuuUIMessageOut) => void;
+  subscribe: (
+    message: ServerProxySubscribeMessage,
+    callback: PostMessageToClientCallback,
+  ) => void;
+  unsubscribe: (viewport: string) => void;
+}

package/package.json

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