dont use local storage to avoid data loss across different app builds

Author: azmy60

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "bks-ai-shell",
   "name": "AI Shell",
-  "version": "1.0.25",
+  "version": "1.0.27",
   "minAppVersion": "5",
   "description": "Ask AI to analyze your database and generate SQL queries.",
   "author": {

package.json

@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.39.0",
-    "@beekeeperstudio/plugin": "^1.0.11",
+    "@beekeeperstudio/plugin": "^1.2.2",
     "@langchain/anthropic": "^0.3.21",
     "@langchain/core": "^0.3.48",
     "@material-symbols/font-400": "^0.31.2",

src/components/ChatInterface.vue

@@ -153,7 +153,7 @@ import Dropdown from "./common/Dropdown.vue";
 import DropdownOption from "./common/DropdownOption.vue";
 import { safeJSONStringify } from "../utils";
 import _ from "lodash";
-import { request, QueryResult } from "@beekeeperstudio/plugin";
+import { expandTableResult, QueryResult } from "@beekeeperstudio/plugin";
 
 const maxHistorySize = 50;
 
@@ -411,7 +411,7 @@ export default {
       return "```json\n" + str + "\n```";
     },
     async handleResultClick(results: QueryResult[]) {
-      await request("expandTableResult", { results });
+      await expandTableResult(results);
       await this.$nextTick();
       if (this.isAtBottom) {
         this.scrollToBottom();

src/components/toolMessage/RunQueryMessage.vue

@@ -47,7 +47,7 @@ const TABLE_MAX_ROWS = 5;
 export default {
   props: {
     data: {
-      type: Object as PropType<RunQueryResponse>,
+      type: Object as PropType<RunQueryResponse['result']>,
       required: true,
     },
   },

src/config.ts

@@ -1,10 +1,10 @@
 import instructions from "../instructions.txt?raw";
 import mongodbInstructions from "../mongodb-instructions.txt?raw";
-import { request } from "@beekeeperstudio/plugin";
+import { getConnectionInfo, getTables } from "@beekeeperstudio/plugin";
 
 export async function getDefaultInstructions() {
-  const response = await request("getConnectionInfo");
-  const tables = await request("getTables").then((tables) =>
+  const response = await getConnectionInfo();
+  const tables = await getTables().then((tables) =>
     tables.filter(
       (table) =>
         table.schema !== "information_schema" &&

src/main.ts

@@ -35,7 +35,7 @@ import json from "highlight.js/lib/languages/json";
 import sql from "highlight.js/lib/languages/sql";
 import "@beekeeperstudio/plugin/dist/eventForwarder";
 
-setDebugComms(false);
+setDebugComms(true);
 
 hljs.registerLanguage("sql", sql);
 hljs.registerLanguage("javascript", javascript);

src/store.ts

@@ -12,7 +12,7 @@ import {
   ToolMessage,
 } from "@langchain/core/messages";
 import { BaseModelProvider, BaseProvider } from "./providers/BaseModelProvider";
-import { request } from "@beekeeperstudio/plugin";
+import { expandTableResult, getEncryptedData, getViewState, setEncryptedData, setTabTitle, setViewState } from "@beekeeperstudio/plugin";
 import { isAbortError } from "./utils";
 
 interface Tool {
@@ -37,10 +37,6 @@ interface ViewState {
   conversationTitle: string;
 }
 
-interface EncryptedData {
-  anthropicApiKey: string;
-}
-
 interface ProviderState {
   providerId: ProviderId;
   apiKey: string;
@@ -96,13 +92,13 @@ export const useProviderStore = defineStore("providers", {
   },
   actions: {
     async initializeChat() {
-      const data = await request<EncryptedData>("getEncryptedData");
-      if (data) {
-        this.apiKey = data.anthropicApiKey;
+      const apiKey = await getEncryptedData("providers.anthropic.apiKey") as string;
+      if (apiKey) {
+        this.apiKey = apiKey;
       }
     },
     async initializeProvider() {
-      const state = await request<ViewState>("getViewState");
+      const state = await getViewState<ViewState>();
       if (state?.messages) {
         try {
           this.messages = mapStoredMessagesToChatMessages(state.messages);
@@ -218,7 +214,7 @@ export const useProviderStore = defineStore("providers", {
               const results = context.result!.results;
               if (results.length > 0 && results[0].rows.length > 0) {
                 localStorage.setItem(STORAGE_KEYS.HAS_OPENED_TABLE_RESULT, "1");
-                request("expandTableResult", { results: [results[0]] });
+                expandTableResult([results[0]]);
               }
             }
 
@@ -236,11 +232,9 @@ export const useProviderStore = defineStore("providers", {
       this.isAborting = false;
       this.isProcessing = false;
 
-      request("setViewState", {
-        state: {
-          messages: mapChatMessagesToStoredMessages(messages),
-          conversationTitle: this.conversationTitle,
-        },
+      setViewState({
+        messages: mapChatMessagesToStoredMessages(messages),
+        conversationTitle: this.conversationTitle,
       });
 
       if (!this.conversationTitle && !this.isGeneratingConversationTitle) {
@@ -251,14 +245,12 @@ export const useProviderStore = defineStore("providers", {
             this.messages,
           );
 
-          request("setTabTitle", { title });
+          setTabTitle(title);
           this.conversationTitle = title;
 
-          request("setViewState", {
-            state: {
-              messages: mapChatMessagesToStoredMessages(messages),
-              conversationTitle: this.conversationTitle,
-            },
+          setViewState({
+            messages: mapChatMessagesToStoredMessages(messages),
+            conversationTitle: this.conversationTitle,
           });
         } catch (e) {
           // If error occurs when generating title, do nothing
@@ -316,7 +308,7 @@ export const useProviderStore = defineStore("providers", {
     },
     async setApiKey(apiKey: string) {
       this.apiKey = apiKey;
-      await request("setEncryptedData", { anthropicApiKey: apiKey });
+      await setEncryptedData("providers.anthropic.apiKey", apiKey);
     },
     setModel(modelId: string) {
       this.pendingModelId = modelId;

src/tools/definitions.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { tool } from "@langchain/core/tools";
-import { request } from "@beekeeperstudio/plugin";
+import { getColumns, getConnectionInfo, getTables, runQuery } from "@beekeeperstudio/plugin";
 import { safeJSONStringify } from "../utils";
 
 const getTablesInputSchema = z.object({
@@ -21,7 +21,7 @@ const runQueryInputSchema = z.object({
 
 export const getConnectionInfoTool = tool(
   async () => {
-    const result = await request("getConnectionInfo");
+    const result = await getConnectionInfo();
     return safeJSONStringify(result);
   },
   {
@@ -33,7 +33,7 @@ export const getConnectionInfoTool = tool(
 
 export const getTablesTool = tool(
   async (params) => {
-    const result = await request("getTables", { schema: params.schema });
+    const result = await getTables(params.schema);
     return safeJSONStringify(result);
   },
   {
@@ -45,10 +45,7 @@ export const getTablesTool = tool(
 
 export const getColumnsTool = tool(
   async (params) => {
-    const result = await request("getColumns", {
-      table: params.table,
-      schema: params.schema,
-    });
+    const result = await getColumns(params.table, params.schema);
     return safeJSONStringify(result);
   },
   {
@@ -59,20 +56,9 @@ export const getColumnsTool = tool(
   },
 );
 
-export const getAllTabsTool = tool(
-  async () => {
-    const result = await request("getAllTabs");
-    return safeJSONStringify(result);
-  },
-  {
-    name: "get_all_tabs",
-    description: "Get a list of all open query tabs in Beekeeper Studio",
-  },
-);
-
 export const runQueryTool = tool(
   async (params) => {
-    const result = await request("runQuery", { query: params.query });
+    const result = await runQuery(params.query);
     return safeJSONStringify(result);
   },
   {
@@ -87,6 +73,5 @@ export const tools = [
   getConnectionInfoTool,
   getTablesTool,
   getColumnsTool,
-  getAllTabsTool,
   runQueryTool,
 ];

src/vue-shims.d.ts

@@ -8,13 +8,3 @@ declare module '*?raw' {
   const content: string
   export default content
 }
-
-// declare module '@vue/runtime-core' {
-//   import { request } from '@beekeeperstudio/plugin'
-//   import pluralize from 'pluralize'
-//
-//   interface ComponentCustomProperties {
-//     $request: typeof request
-//     $pluralize: typeof pluralize
-//   }
-// }

yarn.lock

@@ -40,10 +40,10 @@
     "@babel/helper-string-parser" "^7.25.9"
     "@babel/helper-validator-identifier" "^7.25.9"
 
-"@beekeeperstudio/plugin@^1.0.11":
-  version "1.0.11"
-  resolved "https://registry.yarnpkg.com/@beekeeperstudio/plugin/-/plugin-1.0.11.tgz#55b7252481a2849f77717d5aa090b6118954b222"
-  integrity sha512-FnqynrxPy0JC1InBfsBkbZQ84H+g+M/Frvmx6+CBD4LH3gCRXi5OsiY+2gLtCWfhNCEP5UsKKrS4KKkR7/dCkw==
+"@beekeeperstudio/plugin@^1.2.2":
+  version "1.2.2"
+  resolved "https://registry.yarnpkg.com/@beekeeperstudio/plugin/-/plugin-1.2.2.tgz#aec18f3c02d35493a8a1a566dec779906145faee"
+  integrity sha512-JWUCjfS2POwLeO7hQfEdeuokGTfVg6ArEC6AQIqUZ87/JZgnQu3BJUUKsg2Qk73SBppm4lBdXSLa24tVVw8m0w==
 
 "@cfworker/json-schema@^4.0.2":
   version "4.1.1"