update types gui base (#1793)

frontend/taipy-gui/base/src/packaging/taipy-gui-base.d.ts

@@ -1,4 +1,4 @@
-import { Socket } from "socket.io-client";
+import { Socket } from 'socket.io-client';
 
 export type ModuleData = Record<string, VarName>;
 export type VarName = Record<string, VarData>;
@@ -6,39 +6,61 @@ export interface VarData {
     type: string;
     value: unknown;
     encoded_name: string;
+    data_update: boolean;
 }
+export type ColumnName = string;
+export type RequestDataOptions = {
+    columns?: Array<ColumnName>;
+    pagekey?: string;
+    alldata?: boolean;
+    start?: number;
+    end?: number;
+    filters?: Array<{
+        col: ColumnName;
+        value: string | boolean | number;
+        action: string;
+    }>;
+    aggregates?: Array<ColumnName>;
+    applies?: {
+        [key: ColumnName]: string;
+    };
+    infinite?: boolean;
+    reverse?: boolean;
+    orderby?: ColumnName;
+    sort?: "asc" | "desc";
+    styles?: {
+        [key: ColumnName]: string;
+    };
+    tooltips?: {
+        [key: ColumnName]: string;
+    };
+    handlenan?: boolean;
+    compare_datas?: string;
+};
+export type RequestDataEntry = {
+    options: RequestDataOptions;
+    receivedData: unknown;
+};
 declare class DataManager {
     _data: Record<string, unknown>;
     _init_data: ModuleData;
+    _requested_data: Record<string, Record<string, RequestDataEntry>>;
     constructor(variableModuleData: ModuleData);
     init(variableModuleData: ModuleData): ModuleData;
     getEncodedName(varName: string, module: string): string | undefined;
-    getName(encodedName: string): [string, string] | undefined;
-    get(encodedName: string): unknown;
+    getName(encodedName: string): [
+        string,
+        string
+    ] | undefined;
+    get(encodedName: string, dataEventKey?: string): unknown;
+    addRequestDataOptions(encodedName: string, dataEventKey: string, options: RequestDataOptions): void;
     getInfo(encodedName: string): VarData | undefined;
     getDataTree(): ModuleData;
     getAllData(): Record<string, unknown>;
-    update(encodedName: string, value: unknown): void;
+    update(encodedName: string, value: unknown, dataEventKey?: string): void;
+    deleteRequestedData(encodedName: string, dataEventKey: string): void;
 }
-export type WsMessageType =
-    | "A"
-    | "U"
-    | "DU"
-    | "MU"
-    | "RU"
-    | "AL"
-    | "BL"
-    | "NA"
-    | "ID"
-    | "MS"
-    | "DF"
-    | "PR"
-    | "ACK"
-    | "GMC"
-    | "GDT"
-    | "AID"
-    | "GR"
-    | "FV";
+export type WsMessageType = "A" | "U" | "DU" | "MU" | "RU" | "AL" | "BL" | "NA" | "ID" | "MS" | "DF" | "PR" | "ACK" | "GMC" | "GDT" | "AID" | "GR" | "FV";
 export interface WsMessage {
     type: WsMessageType | string;
     name: string;
@@ -49,12 +71,16 @@ export interface WsMessage {
     ack_id?: string;
 }
 export type OnInitHandler = (taipyApp: TaipyApp) => void;
-export type OnChangeHandler = (taipyApp: TaipyApp, encodedName: string, value: unknown) => void;
+export type OnChangeHandler = (taipyApp: TaipyApp, encodedName: string, value: unknown, dataEventKey?: string) => void;
 export type OnNotifyHandler = (taipyApp: TaipyApp, type: string, message: string) => void;
 export type OnReloadHandler = (taipyApp: TaipyApp, removedChanges: ModuleData) => void;
 export type OnWsMessage = (taipyApp: TaipyApp, event: string, payload: unknown) => void;
 export type OnWsStatusUpdate = (taipyApp: TaipyApp, messageQueue: string[]) => void;
-export type Route = [string, string];
+export type Route = [
+    string,
+    string
+];
+export type RequestDataCallback = (taipyApp: TaipyApp, encodedName: string, dataEventKey: string, value: unknown) => void;
 export declare class TaipyApp {
     socket: Socket;
     _onInit: OnInitHandler | undefined;
@@ -64,6 +90,7 @@ export declare class TaipyApp {
     _onWsMessage: OnWsMessage | undefined;
     _onWsStatusUpdate: OnWsStatusUpdate | undefined;
     _ackList: string[];
+    _rdc: Record<string, Record<string, RequestDataCallback>>;
     variableData: DataManager | undefined;
     functionData: DataManager | undefined;
     appId: string;
@@ -73,18 +100,13 @@ export declare class TaipyApp {
     path: string | undefined;
     routes: Route[] | undefined;
     wsAdapters: WsAdapter[];
-    constructor(
-        onInit?: OnInitHandler | undefined,
-        onChange?: OnChangeHandler | undefined,
-        path?: string | undefined,
-        socket?: Socket | undefined
-    );
+    constructor(onInit?: OnInitHandler | undefined, onChange?: OnChangeHandler | undefined, path?: string | undefined, socket?: Socket | undefined);
     get onInit(): OnInitHandler | undefined;
     set onInit(handler: OnInitHandler | undefined);
     onInitEvent(): void;
     get onChange(): OnChangeHandler | undefined;
     set onChange(handler: OnChangeHandler | undefined);
-    onChangeEvent(encodedName: string, value: unknown): void;
+    onChangeEvent(encodedName: string, value: unknown, dataEventKey?: string): void;
     get onNotify(): OnNotifyHandler | undefined;
     set onNotify(handler: OnNotifyHandler | undefined);
     onNotifyEvent(type: string, message: string): void;
@@ -101,20 +123,26 @@ export declare class TaipyApp {
     sendWsMessage(type: WsMessageType | string, id: string, payload: unknown, context?: string | undefined): void;
     registerWsAdapter(wsAdapter: WsAdapter): void;
     getEncodedName(varName: string, module: string): string | undefined;
-    getName(encodedName: string): [string, string] | undefined;
-    get(encodedName: string): unknown;
+    getName(encodedName: string): [
+        string,
+        string
+    ] | undefined;
+    get(encodedName: string, dataEventKey?: string): unknown;
     getInfo(encodedName: string): VarData | undefined;
     getDataTree(): ModuleData | undefined;
     getAllData(): Record<string, unknown> | undefined;
     getFunctionList(): string[];
     getRoutes(): Route[] | undefined;
+    deleteRequestedData(encodedName: string, dataEventKey: string): void;
     update(encodedName: string, value: unknown): void;
+    requestData(encodedName: string, cb: RequestDataCallback, options?: RequestDataOptions): void;
     getContext(): string;
     updateContext(path?: string | undefined): void;
     trigger(actionName: string, triggerId: string, payload?: Record<string, unknown>): void;
     upload(encodedName: string, files: FileList, progressCallback: (val: number) => void): Promise<string>;
     getPageMetadata(): Record<string, unknown>;
     getWsStatus(): string[];
+    getBaseUrl(): string;
 }
 export declare abstract class WsAdapter {
     abstract supportedMessageTypes: string[];