@vuu-ui/vuu-data-types 0.8.93 → 0.8.95

package/index.d.ts

@@ -1,8 +1,16 @@
+import type {
+  DataSourceFilter,
+  MenuRpcResponse,
+  Selection,
+  TableSchema,
+} from "@vuu-ui/vuu-data-types";
 import type { Filter } from "@vuu-ui/vuu-filter-types";
 import type { MenuActionClosePopup } from "@vuu-ui/vuu-popups";
 import type {
+  LinkDescriptorWithLabel,
   NoAction,
   OpenDialogAction,
+  TypeAheadMethod,
   VuuAggregation,
   VuuColumnDataType,
   VuuColumns,
@@ -11,10 +19,19 @@ import type {
   VuuGroupBy,
   VuuLinkDescriptor,
   VuuMenu,
+  VuuRange,
   VuuRowDataItemType,
+  VuuRpcRequest,
+  VuuRpcViewportResponse,
   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 {
@@ -26,12 +43,10 @@ import type {
 import type {
   VuuTableListRequest,
   VuuTableMetaRequest,
-  LinkDescriptorWithLabel,
-  VuuRpcViewportResponse,
-  TypeAheadMethod,
-  VuuRange,
 } from "@vuu-ui/vuu-protocol-types";
 import { DataValueTypeDescriptor } from "@vuu-ui/vuu-table-types";
+import { PostMessageToClientCallback } from "@vuu-ui/vuu-data-remote";
+import type { DataSourceConfigChanges, IEventEmitter } from "@vuu-ui/vuu-utils";
 
 export declare type DataValueValidationSuccessResult = {
   ok: true;
@@ -155,9 +170,9 @@ type IsExpanded = boolean;
 type Depth = number;
 type ChildCount = number;
 type RowKey = string;
-export type IsSelected = number;
+export declare type IsSelected = number;
 
-export type DataSourceRow = [
+export declare type DataSourceRow = [
   RowIndex,
   RenderKey,
   IsLeaf,
@@ -169,7 +184,7 @@ export type DataSourceRow = [
   ...VuuRowDataItemType[],
 ];
 
-export type DataSourceRowObject = {
+export declare type DataSourceRowObject = {
   index: number;
   key: string;
   isGroupRow: boolean;
@@ -177,7 +192,7 @@ export type DataSourceRowObject = {
   data: VuuDataRowDto;
 };
 
-export type DataSourceRowPredicate = (row: DataSourceRow) => boolean;
+export declare type DataSourceRowPredicate = (row: DataSourceRow) => boolean;
 
 export interface ContextMenuItemBase {
   className?: string;
@@ -191,7 +206,7 @@ export interface ContextMenuLeafItemDescriptor extends ContextMenuItemBase {
   options?: unknown;
 }
 
-export type ContextMenuItemDescriptor =
+export declare type ContextMenuItemDescriptor =
   | ContextMenuLeafItemDescriptor
   | ContextMenuGroupItemDescriptor;
 
@@ -209,10 +224,19 @@ export interface DataSourceAggregateMessage
   type: "aggregate";
 }
 
-export type DataUpdateMode = "batch" | "update" | "size-only";
+export declare type DataUpdateMode = "batch" | "update" | "size-only";
 
+export interface DataSourceClearMessage extends MessageWithClientViewportId {
+  type: "viewport-clear";
+}
 export interface DataSourceDataMessage extends MessageWithClientViewportId {
   mode: DataUpdateMode;
+  /**
+   * this is needed by the ArrayDataSource, biut not currently used by VuuDataSource.
+   * Suspect it will be valuable in any DtaSOurce and should eventually be made a
+   * required field.
+   */
+  range?: VuuRange;
   rows?: DataSourceRow[];
   size?: number;
   type: "viewport-update";
@@ -296,11 +320,11 @@ export interface DataSourceVisualLinksMessage
   links: VuuLinkDescriptor[];
 }
 
-export type VuuFeatureMessage =
+export declare type VuuFeatureMessage =
   | DataSourceMenusMessage
   | DataSourceVisualLinksMessage;
 
-export type DataSourceConfigMessage =
+export declare type DataSourceConfigMessage =
   | DataSourceAggregateMessage
   | DataSourceColumnsMessage
   | DataSourceFilterMessage
@@ -311,10 +335,11 @@ export type DataSourceConfigMessage =
 /**
  * Messages which are routed back to the DataSource
  */
-export type DataSourceCallbackMessage =
+export declare type DataSourceCallbackMessage =
   | DataSourceConfigMessage
   | DataSourceColumnsMessage
   | DataSourceDataMessage
+  | DataSourceClearMessage
   | DataSourceDebounceRequest
   | DataSourceDisabledMessage
   | DataSourceEnabledMessage
@@ -324,12 +349,12 @@ export type DataSourceCallbackMessage =
   | DataSourceVisualLinkRemovedMessage
   | DataSourceVisualLinksMessage;
 
-export type ConfigChangeColumnsMessage = {
+export declare type ConfigChangeColumnsMessage = {
   type: "columns";
   columns?: ColumnDescriptor[];
 };
 
-export type ConfigChangeMessage =
+export declare type ConfigChangeMessage =
   | ConfigChangeColumnsMessage
   | DataSourceAggregateMessage
   | DataSourceFilterMessage
@@ -338,7 +363,7 @@ export type ConfigChangeMessage =
   | DataSourceVisualLinkCreatedMessage
   | DataSourceVisualLinkRemovedMessage;
 
-export type ConfigChangeHandler = (msg: ConfigChangeMessage) => void;
+export declare type ConfigChangeHandler = (msg: ConfigChangeMessage) => void;
 
 /**
  * MenuBuilder describes a factory function that creates
@@ -347,7 +372,7 @@ export type ConfigChangeHandler = (msg: ConfigChangeMessage) => void;
  * can be used to determine which Menu Items to include
  * in the menu. Most often used for ContextMenus.
  */
-export type MenuBuilder<L = string, O = unknown> = (
+export declare type MenuBuilder<L = string, O = unknown> = (
   location: L,
   options: O,
 ) => ContextMenuItemDescriptor[];
@@ -360,7 +385,7 @@ export type MenuBuilder<L = string, O = unknown> = (
  * It should return true if it handled this MenuItem. This allows multiple Menu-
  * ActionHandlers to be chained.
  */
-export type MenuActionHandler = (
+export declare type MenuActionHandler = (
   reason: MenuActionClosePopup,
 ) => boolean | undefined;
 
@@ -369,7 +394,7 @@ export interface ContextMenuContextType {
   menuActionHandler: MenuActionHandler;
 }
 
-export type SchemaColumn = {
+export declare type SchemaColumn = {
   name: string;
   serverDataType: VuuColumnDataType;
 };
@@ -378,11 +403,11 @@ export type SchemaColumn = {
  * session will be present for session tables only, in which case the table
  * name represents the 'archetype' table name.
  */
-export type TableSchemaTable = VuuTable & {
+export declare type TableSchemaTable = VuuTable & {
   session?: string;
 };
 
-export type TableSchema = {
+export declare type TableSchema = {
   columns: SchemaColumn[];
   key: string;
   table: TableSchemaTable;
@@ -395,6 +420,7 @@ export type TableSchema = {
 export interface WithFullConfig {
   readonly aggregations: VuuAggregation[];
   readonly columns: VuuColumns;
+  readonly baseFilterSpec: DataSourceFilter;
   readonly filterSpec: DataSourceFilter;
   readonly groupBy: VuuGroupBy;
   readonly sort: VuuSort;
@@ -427,22 +453,25 @@ export interface SubscribeProps extends Partial<WithFullConfig> {
   title?: string;
 }
 
-export type SubscribeCallback = (message: DataSourceCallbackMessage) => void;
-export type OptimizeStrategy = "none" | "throttle" | "debounce";
+export declare type SubscribeCallback = (
+  message: DataSourceCallbackMessage,
+) => void;
+export declare type OptimizeStrategy = "none" | "throttle" | "debounce";
 
-export type DataSourceEventHandler = (viewportId: string) => void;
-export type RowSelectionEventHandler = (
+export declare type DataSourceEventHandler = (viewportId: string) => void;
+export declare type RowSelectionEventHandler = (
   selection: Selection,
   selectedRowCount: number,
 ) => void;
 
-export type DataSourceEvents = {
+export declare type DataSourceEvents = {
   config: (
     config: DataSourceConfig | undefined,
     confirmed?: boolean,
     configChanges?: DataSourceConfigChanges,
   ) => void;
   optimize: (optimize: OptimizeStrategy) => void;
+  "page-count": (pageCount: number) => void;
   range: (range: VuuRange) => void;
   resize: (size: number) => void;
   "row-selection": RowSelectionEventHandler;
@@ -461,31 +490,33 @@ export type DataSourceEvents = {
  * return Promise<true> indicates success
  * return Promise<errorMessage> indicates failure
  */
-export type DataSourceEditHandler = (
+export declare type DataSourceEditHandler = (
   rowKey: string,
   columnName: string,
   value: VuuRowDataItemType,
 ) => Promise<true | string>;
 
-export type DataSourceDeleteHandler = (key: string) => Promise<true | string>;
-export type DataSourceInsertHandler = (
+export declare type DataSourceDeleteHandler = (
+  key: string,
+) => Promise<true | string>;
+export declare type DataSourceInsertHandler = (
   key: string,
   data: VuuDataRowDto,
 ) => Promise<true | string>;
 
-export type RpcResponse =
+export declare type RpcResponse =
   | MenuRpcResponse
   | VuuUIMessageInRPCEditReject
   | VuuUIMessageInRPCEditResponse
   | ViewportRpcResponse;
 
-export type RpcResponseHandler = (
+export declare type RpcResponseHandler = (
   response: Omit<VuuRpcResponse, "vpId">,
 ) => boolean;
 
-export type RowSearchPredicate = (row: DataSourceRow) => boolean;
+export declare type RowSearchPredicate = (row: DataSourceRow) => boolean;
 
-export type DataSourceStatus =
+export declare type DataSourceStatus =
   | "disabled"
   | "disabling"
   | "enabled"
@@ -496,7 +527,14 @@ export type DataSourceStatus =
   | "suspended"
   | "unsubscribed";
 
-export type SuggestionFetcher = (params: TypeaheadParams) => Promise<string[]>;
+/**
+ * Given a Vuu Table and column, returns a list of sorted distinct values
+ * for that column. Only first 10 values will ever be returned. User must
+ * type additional text to narrow down values.
+ */
+export declare type SuggestionFetcher = (
+  params: TypeaheadParams,
+) => Promise<string[] | false>;
 export type SuggestionProvider = () => SuggestionFetcher;
 
 export interface TypeaheadSuggestionProvider {
@@ -506,10 +544,12 @@ export interface TypeaheadSuggestionProvider {
   ) => Promise<string[]>;
 }
 
-export type RangeTuple = [from: number, to: number];
-export type SelectionItem = number | RangeTuple;
-export type Selection = SelectionItem[];
-export type SelectionChangeHandler = (selection: Selection) => void;
+export declare type RangeTuple = [from: number, to: number];
+export declare type SelectionItem = number | RangeTuple;
+export declare type Selection = SelectionItem[];
+export declare type SelectionChangeHandler = (selection: Selection) => void;
+
+export declare type WithBaseFilter<T> = T & { baseFilter?: DataSourceFilter };
 
 export interface DataSource
   extends IEventEmitter<DataSourceEvents>,
@@ -525,7 +565,7 @@ export interface DataSource
    * @returns true if config has been applied (will not be if existig config is same)
    */
   applyConfig: (
-    config: DataSourceConfig,
+    config: WithBaseFilter<DataSourceConfig>,
     /**
      * If new config is missing attributes and these attributes are present on
      * existing config, shoule the existing attributes be preserved ?
@@ -534,7 +574,7 @@ export interface DataSource
   ) => DataSourceConfigChanges | undefined;
   closeTreeNode: (key: string, cascade?: boolean) => void;
   columns: string[];
-  config: DataSourceConfig;
+  config: WithBaseFilter<DataSourceConfig>;
   status: DataSourceStatus;
   /**
    *
@@ -548,7 +588,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;
   /**
@@ -573,6 +613,7 @@ export interface DataSource
    * Should emit a disabled event
    */
   disable?: () => void;
+  baseFilter?: DataSourceFilter;
   filter: DataSourceFilter;
 
   /**
@@ -648,21 +689,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;
@@ -677,20 +703,20 @@ export interface ServerProxySubscribeMessage extends WithFullConfig {
   visualLink?: LinkDescriptorWithLabel;
 }
 
-// export type VuuUIMessageInConnectionStatus = {
+// export declare type VuuUIMessageInConnectionStatus = {
 //   type: 'connection-status';
 // };
 
-export type VuuUIMessageInConnected = {
+export declare type VuuUIMessageInConnected = {
   type: "connected";
 };
 
-export type VuuUIMessageInConnectionFailed = {
+export declare type VuuUIMessageInConnectionFailed = {
   type: "connection-failed";
   reason: string;
 };
 
-export type VuuUIMessageInWorkerReady = {
+export declare type VuuUIMessageInWorkerReady = {
   type: "ready";
 };
 
@@ -753,7 +779,7 @@ export interface VuuUIMessageInMenuRej {
   type: "VIEW_PORT_MENU_REJ";
 }
 
-export type VuuUiMessageInRequestResponse =
+export declare type VuuUiMessageInRequestResponse =
   | VuuUIMessageInMenuRej
   | MenuRpcResponse
   | MenuRpcReject
@@ -764,16 +790,16 @@ export type VuuUiMessageInRequestResponse =
   | VuuUIMessageInTableList
   | VuuUIMessageInTableMeta;
 
-export type VuuUIMessageIn =
+export declare type VuuUIMessageIn =
   | VuuUiMessageInRequestResponse
   | VuuUIMessageInConnected
   | VuuUIMessageInConnectionFailed
   | VuuUIMessageInWorkerReady;
 
-export type WebSocketProtocol = string | string[] | undefined;
+export declare type WebSocketProtocol = string | string[] | undefined;
 
 export interface VuuUIMessageOutConnect {
-  protocol: WebSocketProtocol;
+  protocol?: WebSocketProtocol;
   type: "connect";
   token: string;
   url: string;
@@ -782,6 +808,10 @@ export interface VuuUIMessageOutConnect {
   retryLimitStartup?: number;
 }
 
+export interface VuuUIMessageOutDisconnect {
+  type: "disconnect";
+}
+
 export interface VuuUIMessageOutSubscribe extends ServerProxySubscribeMessage {
   type: "subscribe";
 }
@@ -872,7 +902,7 @@ export interface VuuUIMessageOutConfig extends ViewportMessageOut {
   type: "config";
 }
 
-export type VuuUIMessageOutViewport =
+export declare type VuuUIMessageOutViewport =
   | VuuUIMessageOutAggregate
   | VuuUIMessageOutCloseTreeNode
   | VuuUIMessageOutColumns
@@ -896,12 +926,44 @@ export interface TypeAheadRpcRequest {
   type: "RPC_CALL";
 }
 
-export type WithRequestId<T> = T & { requestId: string };
+export declare type WithRequestId<T> = T & { requestId: string };
 
-export type VuuUIMessageOut =
+export declare 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.93",
+  "version": "0.8.95",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-filter-types": "0.8.93",
-    "@vuu-ui/vuu-protocol-types": "0.8.93"
+    "@vuu-ui/vuu-filter-types": "0.8.95",
+    "@vuu-ui/vuu-protocol-types": "0.8.95"
   },
   "dependencies": {},
   "peerDependencies": {},