@beekeeperstudio/plugin 1.4.0 → 1.6.0

package/dist/index.d.ts

@@ -19,9 +19,38 @@ interface TableKey {
     onUpdate?: string;
     onDelete?: string;
 }
+type IndexColumn = {
+    name: string;
+    order?: 'ASC' | 'DESC' | '2d' | '2dsphere' | 'text' | 'geoHaystack' | 'hashed' | number;
+    /** MySQL Only */
+    prefix?: number | null;
+};
+type PrimaryKey = {
+    columnName: string;
+    position: number;
+};
+type TableIndex = {
+    id: string;
+    table: string;
+    schema: string;
+    name: string;
+    columns: IndexColumn[];
+    unique: boolean;
+    primary: boolean;
+    /** for postgres 15 and above https://www.postgresql.org/about/featurematrix/detail/392/ */
+    nullsNotDistinct?: boolean;
+};
+type Table = {
+    name: string;
+    schema?: string;
+};
+type Column = {
+    name: string;
+    type: string;
+};
 type WindowEventClass = "MouseEvent" | "KeyboardEvent" | "PointerEvent" | "Event";
 type WindowEventInits = MouseEventInit | KeyboardEventInit | PointerEventInit;
-type TableFilter$1 = {
+type TableFilter = {
     field: string;
     type: "=" | "!=" | "like" | "not like" | "<" | "<=" | ">" | ">=" | "in" | "is" | "is not";
     value?: string | string[];
@@ -80,333 +109,309 @@ type PluginViewContext = {
     command: string;
     params?: CellMenuParams | ColumnMenuParams | RowMenuParams | CornerMenuParams;
 };
+type DatabaseType = 'postgresql' | 'mysql' | 'mariadb' | 'sqlite' | 'sqlserver' | 'oracle' | 'mongodb' | 'cassandra' | 'clickhouse' | 'firebird' | 'bigquery' | 'redshift' | 'duckdb' | 'libsql' | 'redis' | 'surrealdb' | 'trino';
+type ConnectionInfo = {
+    /** @alias databaseType */
+    connectionType: string;
+    /** The ID of the connection */
+    id: number;
+    /** The name of the connection specified in the connection form */
+    workspaceId: number;
+    /** The name of the connection specified in the connection form */
+    connectionName: string;
+    databaseType: DatabaseType;
+    /** The name of the database connected to */
+    databaseName: string;
+    defaultSchema?: string;
+    readOnlyMode: boolean;
+};
+type AppInfo = {
+    version: string;
+    theme: AppTheme;
+};
+type AppTheme = {
+    palette: Record<string, string>;
+    cssString: string;
+    type: ThemeType;
+};
+type RunQueryResult = {
+    results: QueryResult[];
+    error?: unknown;
+};
+type OpenQueryTabOptions = {
+    query?: string;
+};
+type OpenTableTableTabOptions = {
+    table: string;
+    schema?: string;
+    filters?: TableFilter[];
+    database?: string;
+};
+type OpenTableStructureTabOptions = {
+    table: string;
+    schema?: string;
+    database?: string;
+};
+type RequestFileSaveOptions = {
+    data: string;
+    fileName: string;
+    /** @default "utf8" */
+    encoding?: "utf8" | "base64";
+    filters?: {
+        name: string;
+        extensions: string[];
+    }[];
+};
+type PluginErrorObject = {
+    name?: string;
+    message: string;
+    stack?: string;
+};
+type WindowEventObject = {
+    eventType: string;
+    eventClass: WindowEventClass;
+    eventInitOptions: WindowEventInits;
+};
+type ConfirmOptions = {
+    confirmLabel?: string;
+    cancelLabel?: string;
+};
 
-interface BaseRequest {
-    id: string;
-}
-interface GetTablesRequest extends BaseRequest {
-    name: "getTables";
-    args: {
-        schema?: string;
+type RequestMap = {
+    getSchemas: {
+        args: void;
+        return: string[];
     };
-}
-interface GetColumnsRequest extends BaseRequest {
-    name: "getColumns";
-    args: {
-        table: string;
-        schema?: string;
+    getTables: {
+        args: {
+            schema?: string;
+        };
+        return: Table[];
     };
-}
-type GetTableKeysRequest = BaseRequest & {
-    name: "getTableKeys";
-    args: {
-        table: string;
-        schema?: string;
+    getColumns: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: Column[];
     };
-};
-type GetAppInfoRequest = BaseRequest & {
-    name: "getAppInfo";
-    args: void;
-};
-interface GetConnectionInfoRequest extends BaseRequest {
-    name: "getConnectionInfo";
-    args: void;
-}
-interface RunQueryRequest extends BaseRequest {
-    name: "runQuery";
-    args: {
-        query: string;
+    getTableKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableKey[];
     };
-}
-interface ExpandTableResultRequest extends BaseRequest {
-    name: "expandTableResult";
-    args: {
-        results: QueryResult[];
+    getPrimaryKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: PrimaryKey[];
     };
-}
-interface SetTabTitleRequest extends BaseRequest {
-    name: "setTabTitle";
-    args: {
-        title: string;
+    getTableIndexes: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableIndex[];
     };
-}
-type GetViewContextRequest = BaseRequest & {
-    name: "getViewContext";
-    args: void;
-};
-interface GetViewStateRequest extends BaseRequest {
-    name: "getViewState";
-    args: void;
-}
-interface SetViewStateRequest<T extends unknown> extends BaseRequest {
-    name: "setViewState";
-    args: {
-        state: T;
+    getIncomingKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableKey[];
     };
-}
-interface OpenExternalRequest extends BaseRequest {
-    name: "openExternal";
-    args: {
-        link: string;
+    getOutgoingKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableKey[];
     };
-}
-interface SetDataRequest<T extends unknown> extends BaseRequest {
-    name: "setData";
-    args: {
-        key: string;
-        value: T;
+    getConnectionInfo: {
+        args: void;
+        return: ConnectionInfo;
     };
-}
-interface GetDataRequest extends BaseRequest {
-    name: "getData";
-    args: {
-        key: string;
+    getAppInfo: {
+        args: void;
+        return: AppInfo;
     };
-}
-interface GetEncryptedDataRequest extends BaseRequest {
-    name: "getEncryptedData";
-    args: {
-        key: string;
+    checkForUpdate: {
+        args: void;
+        return: boolean;
     };
-}
-interface SetEncryptedDataRequest<T extends unknown> extends BaseRequest {
-    name: "setEncryptedData";
-    args: {
-        key: string;
-        value: T;
+    runQuery: {
+        args: {
+            query: string;
+        };
+        return: RunQueryResult;
     };
-}
-interface ClipboardWriteTextRequest extends BaseRequest {
-    name: "clipboard.writeText";
-    args: {
-        text: string;
+    expandTableResult: {
+        args: {
+            results: QueryResult[];
+        };
+        return: void;
     };
-}
-interface ClipboardReadTextRequest extends BaseRequest {
-    name: "clipboard.readText";
-    args: void;
-}
-type OpenQueryTabRequest = BaseRequest & {
-    name: "openTab";
-    args: {
-        type: "query";
-        query?: string;
-    };
-};
-type OpenTableTableTabRequest = BaseRequest & {
-    name: "openTab";
-    args: {
-        type: "tableTable";
-        table: string;
-        schema?: string;
-        filters?: TableFilter$1[];
-        database?: string;
-    };
-};
-type OpenTableStructureTabRequest = BaseRequest & {
-    name: "openTab";
-    args: {
-        type: "tableStructure";
-        table: string;
-        schema?: string;
-        database?: string;
-    };
-};
-type CheckForUpdateRequest = BaseRequest & {
-    name: "checkForUpdate";
-    args: void;
-};
-type OpenTabRequest = OpenQueryTabRequest | OpenTableTableTabRequest | OpenTableStructureTabRequest;
-type PluginRequestData = GetTablesRequest | GetColumnsRequest | GetTableKeysRequest | GetAppInfoRequest | GetConnectionInfoRequest | RunQueryRequest | ExpandTableResultRequest | SetTabTitleRequest | GetViewContextRequest | GetViewStateRequest | SetViewStateRequest<unknown> | OpenExternalRequest | GetDataRequest | SetDataRequest<unknown> | GetEncryptedDataRequest | SetEncryptedDataRequest<unknown> | ClipboardWriteTextRequest | ClipboardReadTextRequest | OpenTabRequest | CheckForUpdateRequest;
-type PluginRequestPayload = PluginRequestData;
-
-type AppTheme = {
-    palette: Record<string, string>;
-    cssString: string;
-    type: ThemeType;
-};
-type ThemeChangedNotification = {
-    name: "themeChanged";
-    args: AppTheme;
-};
-type WindowEventNotification = {
-    name: "windowEvent";
-    args: {
-        eventType: string;
-        eventClass: WindowEventClass;
-        eventInitOptions: WindowEventInits;
+    setTabTitle: {
+        args: {
+            title: string;
+        };
+        return: void;
     };
-};
-type PluginErrorNotification = {
-    name: "pluginError";
-    args: {
-        name?: string;
-        message?: string;
-        stack?: string;
+    getViewContext: {
+        args: void;
+        return: any;
     };
-};
-type BroadcastNotification<Message extends JsonValue = JsonValue> = {
-    name: "broadcast";
-    args: {
-        message: Message;
+    getViewState: {
+        args: void;
+        return: any;
     };
-};
-type PluginNotificationData = ThemeChangedNotification | WindowEventNotification | PluginErrorNotification | BroadcastNotification;
-
-type TabType = string;
-type TableFilter = any;
-type TableOrView = any;
-interface BaseResponse {
-    id: string;
-    error?: Error;
-}
-interface GetTablesResponse extends BaseResponse {
-    result: {
-        name: string;
-        schema?: string;
-    }[];
-}
-interface GetColumnsResponse extends BaseResponse {
-    result: {
-        name: string;
-        type: string;
-    }[];
-}
-type GetTableKeysResponse = BaseResponse & {
-    result: TableKey[];
-};
-interface GetConnectionInfoResponse extends BaseResponse {
-    result: {
-        /** @deprecated Use `databaseType` instead */
-        connectionType: string;
-        /** The ID of the connection */
-        id: number;
-        /** The name of the connection specified in the connection form */
-        workspaceId: number;
-        /** The name of the connection specified in the connection form */
-        connectionName: string;
-        databaseType: 'postgresql' | 'mysql' | 'mariadb' | 'sqlite' | 'sqlserver' | 'oracle' | 'mongodb' | 'cassandra' | 'clickhouse' | 'firebird' | 'bigquery' | 'redshift' | 'duckdb' | 'libsql' | 'redis' | 'surrealdb' | 'trino';
-        /** The name of the database connected to */
-        databaseName: string;
-        defaultSchema?: string;
-        readOnlyMode: boolean;
+    setViewState: {
+        args: {
+            state: any;
+        };
+        return: void;
     };
-}
-type GetAppInfoResponse = BaseResponse & {
-    result: {
-        version: string;
-        theme: AppTheme;
+    openExternal: {
+        args: {
+            link: string;
+        };
+        return: void;
     };
-};
-interface RunQueryResponse extends BaseResponse {
-    result: {
-        results: QueryResult[];
-        error?: unknown;
+    getData: {
+        args: {
+            key: string;
+        };
+        return: any;
     };
-}
-interface ExpandTableResultResponse extends BaseResponse {
-    result: void;
-}
-interface SetTabTitleResponse extends BaseResponse {
-    result: void;
-}
-type GetViewContextResponse = BaseResponse & {
-    result: PluginViewContext;
-};
-interface GetViewStateResponse<T extends unknown> extends BaseResponse {
-    result: T;
-}
-interface SetViewStateResponse extends BaseResponse {
-    result: void;
-}
-interface OpenExternalResponse extends BaseResponse {
-    result: void;
-}
-interface GetDataResponse<T extends unknown> extends BaseResponse {
-    result: T;
-}
-interface SetDataResponse extends BaseResponse {
-    result: void;
-}
-interface GetEncryptedDataResponse<T extends unknown> extends BaseResponse {
-    result: T;
-}
-interface SetEncryptedDataResponse extends BaseResponse {
-    result: void;
-}
-interface ClipboardWriteTextResponse extends BaseResponse {
-    result: void;
-}
-interface ClipboardReadTextResponse extends BaseResponse {
-    result: string;
-}
-interface OpenTabResponse extends BaseResponse {
-    result: void;
-}
-interface CheckForUpdateResponse extends BaseResponse {
-    result: boolean;
-}
-type PluginResponseData = GetTablesResponse | GetColumnsResponse | GetTableKeysResponse | GetConnectionInfoResponse | RunQueryResponse | ExpandTableResultResponse | SetTabTitleResponse | GetViewContextResponse | GetViewStateResponse<unknown> | SetViewStateResponse | OpenExternalResponse | GetDataResponse<unknown> | SetDataResponse | GetEncryptedDataResponse<unknown> | SetEncryptedDataResponse | ClipboardWriteTextResponse | ClipboardReadTextResponse | OpenTabResponse | CheckForUpdateResponse;
-type PluginResponsePayload = PluginResponseData;
-type TabResponse = BaseTabResponse | QueryTabResponse | TableTabResponse;
-interface BaseTabResponse {
-    type: TabType;
-    id: number;
-    title: string;
-}
-interface QueryTabResponse extends BaseTabResponse {
-    type: "query";
-    data: {
-        query: string;
-        result: unknown;
+    setData: {
+        args: {
+            key: string;
+            value: any;
+        };
+        return: void;
     };
-}
-interface TableTabResponse extends BaseTabResponse {
-    type: "table";
-    data: {
-        table: TableOrView;
-        filters: TableFilter[] | string;
-        result: unknown;
+    getEncryptedData: {
+        args: {
+            key: string;
+        };
+        return: any;
     };
-}
-
-declare global {
-    interface ImportMeta {
-        env: {
-            MODE: string;
+    setEncryptedData: {
+        args: {
+            key: string;
+            value: any;
         };
-    }
-}
-declare function setDebugComms(enabled: boolean): void;
-declare function request(raw: any): Promise<any>;
-declare function notify<Message extends JsonValue = JsonValue>(name: BroadcastNotification["name"], args: BroadcastNotification<Message>["args"]): void;
-declare function notify(name: PluginErrorNotification["name"], args: PluginErrorNotification["args"]): void;
-declare function notify(name: WindowEventNotification["name"], args: WindowEventNotification["args"]): void;
-declare function addNotificationListener<Message extends JsonValue = JsonValue>(name: BroadcastNotification["name"], handler: (args: BroadcastNotification<Message>["args"]) => void): void;
-declare function addNotificationListener(name: ThemeChangedNotification["name"], handler: (args: ThemeChangedNotification["args"]) => void): void;
-declare function removeNotificationListener(name: string, handler: (args: any) => void): void;
+        return: void;
+    };
+    openTab: {
+        args: ({
+            type: "query";
+        } & OpenQueryTabOptions) | ({
+            type: "tableTable";
+        } & OpenTableTableTabOptions) | ({
+            type: "tableStructure";
+        } & OpenTableStructureTabOptions);
+        return: void;
+    };
+    requestFileSave: {
+        args: RequestFileSaveOptions;
+        return: void;
+    };
+    toggleStatusBarUI: {
+        args: {
+            force?: boolean;
+        };
+        return: void;
+    };
+    confirm: {
+        args: {
+            title?: string;
+            message?: string;
+            options?: {
+                confirmLabel?: string;
+                cancelLabel?: string;
+            };
+        };
+        return: boolean;
+    };
+    "clipboard.writeText": {
+        args: {
+            text: string;
+        };
+        return: void;
+    };
+    "clipboard.writeImage": {
+        args: {
+            data: string;
+        };
+        return: void;
+    };
+    "clipboard.readText": {
+        args: void;
+        return: string;
+    };
+    "noty.success": {
+        args: {
+            message: string;
+        };
+        return: void;
+    };
+    "noty.error": {
+        args: {
+            message: string;
+        };
+        return: void;
+    };
+    "noty.info": {
+        args: {
+            message: string;
+        };
+        return: void;
+    };
+    "noty.warning": {
+        args: {
+            message: string;
+        };
+        return: void;
+    };
+};
 
+/**
+ * Get a list of schemas from the current database.
+ *
+ * @since Beekeeper Studio 5.5.0
+ **/
+declare function getSchemas(): Promise<string[]>;
 /**
  * Get a list of tables from the current database.
+ *
  * @since Beekeeper Studio 5.3.0
  **/
-declare function getTables(schema?: string): Promise<GetTablesResponse['result']>;
+declare function getTables(schema?: string): Promise<Table[]>;
 /**
  * Get a list of columns from a table.
  *
  * @since Beekeeper Studio 5.3.0
  **/
-declare function getColumns(table: string, schema?: string): Promise<GetColumnsResponse['result']>;
+declare function getColumns(table: string, schema?: string): Promise<Column[]>;
 /** @since Beekeeper Studio 5.4.0 */
-declare function getTableKeys(table: string, schema?: string): Promise<GetTableKeysResponse['result']>;
+declare function getTableKeys(table: string, schema?: string): Promise<TableKey[]>;
+/** @since Beekeeper Studio 5.5.0 */
+declare function getTableIndexes(table: string, schema?: string): Promise<TableIndex[]>;
+declare function getPrimaryKeys(table: string, schema?: string): Promise<PrimaryKey[]>;
+declare function getIncomingKeys(table: string, schema?: string): Promise<TableKey[]>;
+declare function getOutgoingKeys(table: string, schema?: string): Promise<TableKey[]>;
 /**
  * Get information about the current database connection.
  *
  * @since Beekeeper Studio 5.3.0
  **/
-declare function getConnectionInfo(): Promise<GetConnectionInfoResponse['result']>;
+declare function getConnectionInfo(): Promise<ConnectionInfo>;
 /** @since Beekeeper Studio 5.4.0 */
-declare function getAppInfo(): Promise<GetAppInfoResponse['result']>;
+declare function getAppInfo(): Promise<AppInfo>;
 /**
  * Get the version of Beekeeper Studio
  * @since Beekeeper Studio 5.3.0
@@ -419,7 +424,7 @@ declare function getAppVersion(): Promise<"5.3" | (string & {
  *
  * @since Beekeeper Studio 5.4.0
  **/
-declare function checkForUpdate(): Promise<CheckForUpdateResponse['result']>;
+declare function checkForUpdate(): Promise<boolean>;
 /**
  * Execute a SQL query against the current database.
  *
@@ -429,19 +434,19 @@ declare function checkForUpdate(): Promise<CheckForUpdateResponse['result']>;
  *
  * @since Beekeeper Studio 5.3.0
  **/
-declare function runQuery(query: string): Promise<RunQueryResponse['result']>;
+declare function runQuery(query: string): Promise<RunQueryResult>;
 /**
  * Display query results in the bottom table panel (shell-type tabs only).
  *
  * @since Beekeeper Studio 5.3.0
  **/
-declare function expandTableResult(results: any[]): Promise<ExpandTableResultResponse['result']>;
+declare function expandTableResult(results: QueryResult[]): Promise<void>;
 /**
  * Set the title of the current plugin tab.
  *
  * @since Beekeeper Studio 5.3.0
  **/
-declare function setTabTitle(title: string): Promise<SetTabTitleResponse['result']>;
+declare function setTabTitle(title: string): Promise<void>;
 /**
  * Get the current view context.
  *
@@ -452,25 +457,25 @@ declare function setTabTitle(title: string): Promise<SetTabTitleResponse['result
  *
  * @since Beekeeper Studio 5.4.0
  **/
-declare function getViewContext(): Promise<GetViewContextResponse['result']>;
+declare function getViewContext(): Promise<PluginViewContext>;
 /**
  * Get the current state of your view instance.
  *
  * @see {@link https://docs.beekeeperstudio.io/plugin_development/plugin-views/#view-state|View State}
  * @since Beekeeper Studio 5.3.0
  **/
-declare function getViewState<T>(): Promise<GetViewStateResponse<T>['result']>;
+declare function getViewState<T = unknown>(): Promise<T>;
 /**
  * Set the state of your view instance.
  *
  * @see {@link https://docs.beekeeperstudio.io/plugin_development/plugin-views/#view-state|View State}
  * @since Beekeeper Studio 5.3.0
  **/
-declare function setViewState<T>(state: T): Promise<SetViewStateResponse['result']>;
+declare function setViewState<T = unknown>(state: T): Promise<void>;
 /** @since Beekeeper Studio 5.3.0 */
-declare function openExternal(link: string): Promise<OpenExternalResponse['result']>;
+declare function openExternal(link: string): Promise<void>;
 /** @since Beekeeper Studio 5.3.0 */
-declare function getData<T>(key?: string): Promise<GetDataResponse<T>['result']>;
+declare function getData<T = unknown>(key?: string): Promise<T>;
 /**
  * Store data that can be retrieved later.
  *
@@ -483,10 +488,10 @@ declare function getData<T>(key?: string): Promise<GetDataResponse<T>['result']>
  *
  * @since Beekeeper Studio 5.3.0
  */
-declare function setData<T>(key: string, value: T): Promise<SetDataResponse['result']>;
-declare function setData<T>(value: T): Promise<SetDataResponse['result']>;
+declare function setData<T = unknown>(key: string, value: T): Promise<void>;
+declare function setData<T = unknown>(value: T): Promise<void>;
 /** @since Beekeeper Studio 5.3.0 */
-declare function getEncryptedData<T>(key: string): Promise<GetEncryptedDataResponse<T>['result']>;
+declare function getEncryptedData<T>(key: string): Promise<T>;
 /**
  * Store encrypted data that can be retrieved later.
  *
@@ -499,12 +504,19 @@ declare function getEncryptedData<T>(key: string): Promise<GetEncryptedDataRespo
  *
  * @since Beekeeper Studio 5.3.0
  */
-declare function setEncryptedData<T>(key: string, value: T): Promise<SetEncryptedDataResponse['result']>;
-declare function setEncryptedData<T>(value: T): Promise<SetEncryptedDataResponse['result']>;
+declare function setEncryptedData<T = unknown>(key: string, value: T): Promise<void>;
+declare function setEncryptedData<T = unknown>(value: T): Promise<void>;
 /** @since Beekeeper Studio 5.4.0 */
-declare function openTab(type: "query", args?: Omit<OpenQueryTabRequest['args'], 'type'>): Promise<OpenTabResponse>;
-declare function openTab(type: "tableTable", args: Omit<OpenTableTableTabRequest['args'], 'type'>): Promise<OpenTabResponse>;
-declare function openTab(type: "tableStructure", args: Omit<OpenTableStructureTabRequest['args'], 'type'>): Promise<OpenTabResponse>;
+declare function openTab(type: "query", options?: OpenQueryTabOptions): Promise<void>;
+declare function openTab(type: "tableTable", options: OpenTableTableTabOptions): Promise<void>;
+declare function openTab(type: "tableStructure", options: OpenTableStructureTabOptions): Promise<void>;
+declare function requestFileSave(options: RequestFileSaveOptions): Promise<void>;
+declare function showStatusBarUI(): Promise<void>;
+declare function hideStatusBarUI(): Promise<void>;
+/** @since Beekeeper Studio 5.5.? */
+declare function toggleStatusBarUI(): Promise<void>;
+/** @since Beekeeper Studio 5.5.? */
+declare function confirm(title?: string, message?: string, options?: ConfirmOptions): Promise<boolean>;
 /** @since Beekeeper Studio 5.4.0 */
 declare const broadcast: {
     post<T extends JsonValue = JsonValue>(message: T): void;
@@ -514,17 +526,43 @@ declare const broadcast: {
 declare const log: {
     error(err: string | Error): void;
 };
-/**
- * Clipboard interface.
- *
- * @since Beekeeper Studio 5.3.0
- **/
+/** Clipboard interface. */
 declare const clipboard: {
-    /** Write text to the Electron clipboard. */
+    /** Write text to the Electron clipboard.
+     * @since Beekeeper Studio 5.3.0 */
     writeText(text: string): Promise<void>;
-    /** Read text from the Electron clipboard. */
+    /** Read text from the Electron clipboard.
+     * @since Beekeeper Studio 5.3.0 */
     readText(): Promise<string>;
+    /** @param data - Base64 encoded image data.
+     * @since Beekeeper Studio 5.5.0 */
+    writeImage(data: string): Promise<void>;
 };
+/** @since Beekeeper Studio 5.5.? */
+declare const noty: {
+    success(message: string): Promise<void>;
+    info(message: string): Promise<void>;
+    warning(message: string): Promise<void>;
+    error(message: string): Promise<void>;
+};
+declare function setDebugComms(enabled: boolean): void;
+declare function notify<Message extends JsonValue = JsonValue>(name: "broadcast", args: {
+    message: Message;
+}): void;
+declare function notify(name: "pluginError", args: PluginErrorObject): void;
+declare function notify(name: "windowEvent", args: WindowEventObject): void;
+declare function addNotificationListener(name: "tablesChanged", handler: () => void): void;
+declare function addNotificationListener<Message extends JsonValue = JsonValue>(name: "broadcast", handler: (args: {
+    message: Message;
+}) => void): void;
+declare function addNotificationListener(name: "themeChanged", handler: (args: AppTheme) => void): void;
+declare function removeNotificationListener(name: "tablesChanged", handler: (args: any) => void): void;
+declare function removeNotificationListener<Message extends JsonValue = JsonValue>(name: "broadcast", handler: (args: any) => void): void;
+declare function removeNotificationListener(name: "themeChanged", handler: (args: any) => void): void;
+declare function request<T extends keyof RequestMap>(raw: {
+    name: T;
+    args: RequestMap[T]["args"];
+}): Promise<RequestMap[T]["return"]>;
 
-export { addNotificationListener, broadcast, checkForUpdate, clipboard, expandTableResult, getAppInfo, getAppVersion, getColumns, getConnectionInfo, getData, getEncryptedData, getTableKeys, getTables, getViewContext, getViewState, log, notify, openExternal, openTab, removeNotificationListener, request, runQuery, setData, setDebugComms, setEncryptedData, setTabTitle, setViewState };
-export type { ActiveRange, AppTheme, BroadcastNotification, CellMenuParams, CellMenuTarget, CheckForUpdateRequest, CheckForUpdateResponse, ClipboardReadTextRequest, ClipboardReadTextResponse, ClipboardWriteTextRequest, ClipboardWriteTextResponse, ColumnMenuParams, ColumnMenuTarget, CornerMenuParams, CornerMenuTarget, ExpandTableResultRequest, ExpandTableResultResponse, GetAppInfoRequest, GetAppInfoResponse, GetColumnsRequest, GetColumnsResponse, GetConnectionInfoRequest, GetConnectionInfoResponse, GetDataRequest, GetDataResponse, GetEncryptedDataRequest, GetEncryptedDataResponse, GetTableKeysRequest, GetTableKeysResponse, GetTablesRequest, GetTablesResponse, GetViewContextRequest, GetViewContextResponse, GetViewStateRequest, GetViewStateResponse, JsonValue, LoadViewParams, OpenExternalRequest, OpenExternalResponse, OpenQueryTabRequest, OpenTabRequest, OpenTabResponse, OpenTableStructureTabRequest, OpenTableTableTabRequest, PluginErrorNotification, PluginNotificationData, PluginRequestData, PluginRequestPayload, PluginResponseData, PluginResponsePayload, PluginViewContext, QueryResult, RowMenuParams, RowMenuTarget, RunQueryRequest, RunQueryResponse, SetDataRequest, SetDataResponse, SetEncryptedDataRequest, SetEncryptedDataResponse, SetTabTitleRequest, SetTabTitleResponse, SetViewStateRequest, SetViewStateResponse, TabResponse, TableFilter$1 as TableFilter, TableKey, ThemeChangedNotification, ThemeType, WindowEventClass, WindowEventInits, WindowEventNotification };
+export { addNotificationListener, broadcast, checkForUpdate, clipboard, confirm, expandTableResult, getAppInfo, getAppVersion, getColumns, getConnectionInfo, getData, getEncryptedData, getIncomingKeys, getOutgoingKeys, getPrimaryKeys, getSchemas, getTableIndexes, getTableKeys, getTables, getViewContext, getViewState, hideStatusBarUI, log, notify, noty, openExternal, openTab, removeNotificationListener, request, requestFileSave, runQuery, setData, setDebugComms, setEncryptedData, setTabTitle, setViewState, showStatusBarUI, toggleStatusBarUI };
+export type { ActiveRange, AppInfo, AppTheme, CellMenuParams, CellMenuTarget, Column, ColumnMenuParams, ColumnMenuTarget, ConfirmOptions, ConnectionInfo, CornerMenuParams, CornerMenuTarget, DatabaseType, IndexColumn, JsonValue, LoadViewParams, OpenQueryTabOptions, OpenTableStructureTabOptions, OpenTableTableTabOptions, PluginErrorObject, PluginViewContext, PrimaryKey, QueryResult, RequestFileSaveOptions, RowMenuParams, RowMenuTarget, RunQueryResult, Table, TableFilter, TableIndex, TableKey, ThemeType, WindowEventClass, WindowEventInits, WindowEventObject };