@beekeeperstudio/plugin 1.4.0 → 1.5.0

package/dist/internal.d.ts

@@ -0,0 +1,326 @@
+type ThemeType = "dark" | "light";
+interface QueryResult {
+    fields: {
+        id: string;
+        name: string;
+        dataType?: string;
+    }[];
+    rows: Record<string, unknown>[];
+}
+interface TableKey {
+    isComposite: boolean;
+    toTable: string;
+    toSchema: string;
+    toColumn: string | string[];
+    fromTable: string;
+    fromSchema: string;
+    fromColumn: string | string[];
+    constraintName?: string;
+    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 = {
+    field: string;
+    type: "=" | "!=" | "like" | "not like" | "<" | "<=" | ">" | ">=" | "in" | "is" | "is not";
+    value?: string | string[];
+    op?: "AND" | "OR";
+};
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+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 RequestMap = {
+    getSchemas: {
+        args: void;
+        return: string[];
+    };
+    getTables: {
+        args: {
+            schema?: string;
+        };
+        return: Table[];
+    };
+    getColumns: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: Column[];
+    };
+    getTableKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableKey[];
+    };
+    getPrimaryKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: PrimaryKey[];
+    };
+    getTableIndexes: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableIndex[];
+    };
+    getIncomingKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableKey[];
+    };
+    getOutgoingKeys: {
+        args: {
+            table: string;
+            schema?: string;
+        };
+        return: TableKey[];
+    };
+    getConnectionInfo: {
+        args: void;
+        return: ConnectionInfo;
+    };
+    getAppInfo: {
+        args: void;
+        return: AppInfo;
+    };
+    checkForUpdate: {
+        args: void;
+        return: boolean;
+    };
+    runQuery: {
+        args: {
+            query: string;
+        };
+        return: RunQueryResult;
+    };
+    expandTableResult: {
+        args: {
+            results: QueryResult[];
+        };
+        return: void;
+    };
+    setTabTitle: {
+        args: {
+            title: string;
+        };
+        return: void;
+    };
+    getViewContext: {
+        args: void;
+        return: any;
+    };
+    getViewState: {
+        args: void;
+        return: any;
+    };
+    setViewState: {
+        args: {
+            state: any;
+        };
+        return: void;
+    };
+    openExternal: {
+        args: {
+            link: string;
+        };
+        return: void;
+    };
+    getData: {
+        args: {
+            key: string;
+        };
+        return: any;
+    };
+    setData: {
+        args: {
+            key: string;
+            value: any;
+        };
+        return: void;
+    };
+    getEncryptedData: {
+        args: {
+            key: string;
+        };
+        return: any;
+    };
+    setEncryptedData: {
+        args: {
+            key: string;
+            value: any;
+        };
+        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;
+    };
+    "clipboard.writeText": {
+        args: {
+            text: string;
+        };
+        return: void;
+    };
+    "clipboard.writeImage": {
+        args: {
+            data: string;
+        };
+        return: void;
+    };
+    "clipboard.readText": {
+        args: void;
+        return: string;
+    };
+};
+type RequestPayload = {
+    [K in keyof RequestMap]: {
+        id: string;
+        name: K;
+        args: RequestMap[K]["args"];
+    };
+}[keyof RequestMap];
+type ResponsePayload = {
+    [K in keyof RequestMap]: {
+        id: string;
+        result: RequestMap[K]["return"];
+        error?: unknown;
+    };
+}[keyof RequestMap];
+type NotificationMap = {
+    tablesChanged: {
+        args: void;
+    };
+    broadcast: {
+        args: {
+            message: JsonValue;
+        };
+    };
+    themeChanged: {
+        args: AppTheme;
+    };
+    windowEvent: {
+        args: WindowEventObject;
+    };
+    pluginError: {
+        args: PluginErrorObject;
+    };
+};
+
+export type { NotificationMap, RequestMap, RequestPayload, ResponsePayload };

package/dist/internal.js

@@ -0,0 +1 @@
+

package/package.json

@@ -1,9 +1,23 @@
 {
   "name": "@beekeeperstudio/plugin",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "A simple TypeScript wrapper to send messages from your Beekeeper Studio plugin to the main app.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./dist/internal": {
+      "types": "./dist/internal.d.ts",
+      "import": "./dist/internal.js"
+    },
+    "./dist/eventForwarder": {
+      "types": "./dist/eventForwarder.d.ts",
+      "import": "./dist/eventForwarder.js"
+    }
+  },
   "files": [
     "dist/*.js",
     "dist/*.d.ts",