@vuu-ui/vuu-data-remote 0.11.0 → 0.11.1

package/types/server-proxy/server-proxy.d.ts

@@ -0,0 +1,64 @@
+import type { DataSourceCallbackMessage, ServerProxySubscribeMessage, VuuUIMessageIn, VuuUIMessageOut, VuuUIMessageOutConnect, VuuUIMessageOutSubscribe, VuuUIMessageOutUnsubscribe, WithRequestId } from "@vuu-ui/vuu-data-types";
+import type { VuuRpcMenuRequest, VuuClientMessage, VuuServerMessage, VuuLinkDescriptor, VuuRpcServiceRequest, VuuTable, VuuCreateVisualLink, VuuRemoveVisualLink } from "@vuu-ui/vuu-protocol-types";
+import { WebSocketConnection } from "../WebSocketConnection";
+export type PostMessageToClientCallback = (message: VuuUIMessageIn | DataSourceCallbackMessage) => void;
+export type MessageOptions = {
+    module?: string;
+};
+export declare const TEST_setRequestId: (id: number) => number;
+export declare class ServerProxy {
+    private connection;
+    private postMessageToClient;
+    private viewports;
+    private mapClientToServerViewport;
+    private authToken;
+    private user;
+    private pendingLogin?;
+    private pendingRequests;
+    private sessionId?;
+    private queuedRequests;
+    private cachedTableMetaRequests;
+    private cachedTableSchemas;
+    private tableList;
+    constructor(connection: WebSocketConnection, callback: PostMessageToClientCallback);
+    private reconnect;
+    login(authToken?: string, user?: string): Promise<string | void>;
+    disconnect(): void;
+    subscribe(message: ServerProxySubscribeMessage): void;
+    /**
+     * Currently we only queue range requests, this may change
+     */
+    private addRequestToQueue;
+    private processQueuedRequests;
+    unsubscribe(clientViewportId: string): void;
+    private getViewportForClient;
+    /**********************************************************************/
+    /**********************************************************************/
+    private setViewRange;
+    private setConfig;
+    private setTitle;
+    private select;
+    private disableViewport;
+    private enableViewport;
+    private suspendViewport;
+    private resumeViewport;
+    private openTreeNode;
+    private closeTreeNode;
+    private createLink;
+    private removeLink;
+    private updateTitleOnVisualLinks;
+    private removeViewportFromVisualLinks;
+    private menuRpcCall;
+    private viewportRpcCall;
+    private rpcCall;
+    handleMessageFromClient(message: Exclude<VuuUIMessageOut, VuuUIMessageOutConnect | VuuUIMessageOutSubscribe | VuuUIMessageOutUnsubscribe> | WithRequestId<VuuRpcServiceRequest> | WithRequestId<VuuRpcMenuRequest> | WithRequestId<VuuCreateVisualLink> | WithRequestId<VuuRemoveVisualLink>): void;
+    private getTableMeta;
+    private awaitResponseToMessage;
+    sendIfReady(message: VuuClientMessage["body"], requestId: string, isReady?: boolean): boolean;
+    sendMessageToServer(body: VuuClientMessage["body"], requestId?: string, options?: MessageOptions): void;
+    handleMessageFromServer(message: VuuServerMessage): void;
+    private cacheTableMeta;
+    isTableOpen(table?: VuuTable): true | undefined;
+    getActiveLinks(linkDescriptors: VuuLinkDescriptor[]): VuuLinkDescriptor[];
+    processUpdates(): void;
+}

package/types/server-proxy/viewport.d.ts

@@ -0,0 +1,117 @@
+import { DataSourceFilter, DataSourceRow, DataSourceCallbackMessage, DataSourceDebounceRequest, DataSourceDisabledMessage, DataSourceEnabledMessage, DataSourceMenusMessage, DataSourceSetConfigMessage, DataSourceSubscribedMessage, DataSourceVisualLinkCreatedMessage, DataSourceVisualLinkRemovedMessage, DataSourceVisualLinksMessage, DataUpdateMode, Selection, TableSchema, WithFullConfig, ServerProxySubscribeMessage, VuuUIMessageOutOpenTreeNode, VuuUIMessageOutCloseTreeNode, WithRequestId } from "@vuu-ui/vuu-data-types";
+import { VuuViewportChangeRequest, ClientToServerCloseTreeNode, VuuCreateVisualLink, VuuViewportCreateRequest, ClientToServerDisable, ClientToServerEnable, ClientToServerOpenTreeNode, VuuRemoveVisualLink, ClientToServerSelection, VuuViewportRangeRequest, LinkDescriptorWithLabel, VuuViewportCreateResponse, VuuMenu, VuuRange, VuuRow, VuuTable } from "@vuu-ui/vuu-protocol-types";
+export type ViewportStatus = "" | "subscribing" | "resubscribing" | "subscribed";
+interface Disable {
+    type: "disable";
+}
+interface Enable {
+    type: "enable";
+}
+interface ChangeViewportRange {
+    type: "CHANGE_VP_RANGE";
+}
+interface ViewportFilter {
+    data: DataSourceFilter;
+    type: "filter";
+}
+interface ConfigOperation {
+    data: WithFullConfig;
+    type: "config";
+}
+interface SelectionOperation {
+    data: Selection;
+    type: "selection";
+}
+type AsyncOperationWithData = ConfigOperation | ViewportFilter | SelectionOperation;
+type AsyncOperation = AsyncOperationWithData | ChangeViewportRange | Disable | Enable | VuuCreateVisualLink | VuuRemoveVisualLink;
+type RangeRequestTuple = [
+    VuuViewportRangeRequest | null,
+    DataSourceRow[]?,
+    DataSourceDebounceRequest?
+];
+type LinkedParent = {
+    colName: string;
+    parentViewportId: string;
+    parentColName: string;
+};
+export declare const NO_DATA_UPDATE: Readonly<[undefined, undefined]>;
+export declare class Viewport {
+    #private;
+    private aggregations;
+    private batchMode;
+    private bufferSize;
+    private columns;
+    private dataWindow;
+    private filter;
+    private groupBy;
+    private sort;
+    private hasUpdates;
+    private pendingUpdates;
+    private keys;
+    private pendingLinkedParent?;
+    private pendingOperations;
+    private pendingRangeRequests;
+    private postMessageToClient;
+    private rowCountChanged;
+    private selectedRows;
+    private lastUpdateStatus;
+    private updateThrottleTimer;
+    private lastRowsReturnedToClient;
+    private rangeMonitor;
+    clientViewportId: string;
+    disabled: boolean;
+    isTree: boolean;
+    links?: LinkDescriptorWithLabel[];
+    linkedParent?: LinkedParent;
+    serverViewportId?: string;
+    suspended: boolean;
+    suspendTimer: number | null;
+    table: VuuTable;
+    title: string | undefined;
+    constructor({ aggregations, bufferSize, columns, filterSpec: filter, groupBy, table, range, sort, title, viewport, visualLink, }: ServerProxySubscribeMessage, 
+    /**
+     * Viewport is given access to postMessageToClient in the event that it needs
+     * to send 'out of band' messageg, e.g cached SIZE messages when a timer
+     * expires
+     */
+    postMessageToClient: (message: DataSourceCallbackMessage) => void);
+    private setLastSizeOnlyUpdateSize;
+    private setLastUpdate;
+    get hasUpdatesToProcess(): boolean;
+    get size(): number;
+    get clientRange(): VuuRange;
+    get status(): ViewportStatus;
+    set status(status: ViewportStatus);
+    subscribe(): VuuViewportCreateRequest;
+    handleSubscribed({ viewPortId, aggregations, columns, filterSpec: filter, range, sort, groupBy, table, }: VuuViewportCreateResponse, baseTableSchema: TableSchema): DataSourceSubscribedMessage;
+    awaitOperation(requestId: string, msg: AsyncOperation): void;
+    completeOperation(requestId: string, ...params: unknown[]): DataSourceSetConfigMessage | DataSourceDisabledMessage | DataSourceEnabledMessage | WithRequestId<DataSourceVisualLinkCreatedMessage> | WithRequestId<DataSourceVisualLinkRemovedMessage> | undefined;
+    rangeRequest(requestId: string, range: VuuRange): RangeRequestTuple;
+    setLinks(links: LinkDescriptorWithLabel[]): [DataSourceVisualLinksMessage, LinkDescriptorWithLabel | undefined];
+    setMenu(menu: VuuMenu): DataSourceMenusMessage;
+    openTreeNode(requestId: string, message: VuuUIMessageOutOpenTreeNode): ClientToServerOpenTreeNode;
+    closeTreeNode(requestId: string, message: VuuUIMessageOutCloseTreeNode): ClientToServerCloseTreeNode;
+    createLink(requestId: string, vuuCreateVisualLink: VuuCreateVisualLink): VuuCreateVisualLink;
+    removeLink(requestId: string): VuuRemoveVisualLink;
+    suspend(): void;
+    resume(): [number, DataSourceRow[]];
+    currentData(): DataSourceRow[];
+    enable(requestId: string): ClientToServerEnable;
+    disable(requestId: string): ClientToServerDisable;
+    setConfig(requestId: string, config: WithFullConfig): VuuViewportChangeRequest;
+    selectRequest(requestId: string, selected: Selection): ClientToServerSelection;
+    private removePendingRangeRequest;
+    private rangeRequestAlreadyPending;
+    updateRows(rows: VuuRow[]): void;
+    private getKeyForRowAtIndex;
+    getClientRows(): Readonly<[
+        DataSourceRow[] | undefined,
+        DataUpdateMode | undefined
+    ]>;
+    private sendThrottledSizeMessage;
+    private shouldThrottleMessage;
+    private throttleMessage;
+    getNewRowCount: () => number | undefined;
+    createRequest(params: Partial<Omit<VuuViewportChangeRequest, "type" | "viewPortId">>, overWrite?: boolean): VuuViewportChangeRequest;
+}
+export {};

package/types/worker.d.ts

@@ -0,0 +1 @@
+export {};