fix: setting extension placeholder and input action apikey (janhq#3430)

* fix: setting extension placeholder apikey * fix: extension settings migration --------- Co-authored-by: Louis <[email protected]>
christullier · Aug 22, 2024 · ab8af53 · ab8af53
1 parent 7c9d49b
commit ab8af53
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 107 deletions.
diff --git a/core/src/browser/extension.ts b/core/src/browser/extension.ts
@@ -122,13 +122,16 @@ export abstract class BaseExtension implements ExtensionType {
         await fs.mkdir(extensionSettingFolderPath)
       const settingFilePath = await joinPath([extensionSettingFolderPath, this.settingFileName])
 
-      // Persists new setting only
+      // Persists new settings
       if (await fs.existsSync(settingFilePath)) {
         const oldSettings = JSON.parse(await fs.readFileSync(settingFilePath, 'utf-8'))
-        if (Array.isArray(oldSettings))
-          settings = oldSettings.concat(
-            settings.filter((e) => !oldSettings.some((o) => o.key === e.key))
-          )
+        settings.forEach((setting) => {
+          // Keep setting value
+          if (setting.controllerProps && Array.isArray(oldSettings))
+            setting.controllerProps.value = oldSettings.find(
+              (e: any) => e.key === setting.key
+            )?.controllerProps?.value
+        })
       }
       await fs.writeFileSync(settingFilePath, JSON.stringify(settings, null, 2))
     } catch (err) {

diff --git a/extensions/inference-anthropic-extension/resources/settings.json b/extensions/inference-anthropic-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [Anthropic API documentation](https://docs.anthropic.com/claude/docs/intro-to-claude) for more information.",
+    "key": "anthropic-api-key",
+    "title": "API Key",
+    "description": "The Anthropic API uses API keys for authentication. Visit your [API Keys](https://console.anthropic.com/settings/keys) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "https://api.anthropic.com/v1/messages",
-      "value": "https://api.anthropic.com/v1/messages"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "anthropic-api-key",
-    "title": "API Key",
-    "description": "The Anthropic API uses API keys for authentication. Visit your [API Keys](https://console.anthropic.com/settings/keys) page to retrieve the API key you'll use in your requests.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [Anthropic API documentation](https://docs.anthropic.com/claude/docs/intro-to-claude) for more information.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "https://api.anthropic.com/v1/messages",
+      "value": "https://api.anthropic.com/v1/messages"
     }
   }
-]
+]
diff --git a/extensions/inference-cohere-extension/resources/settings.json b/extensions/inference-cohere-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [Cohere API documentation](https://docs.cohere.com/reference/chat) for more information.",
+    "key": "cohere-api-key",
+    "title": "API Key",
+    "description": "The Cohere API uses API keys for authentication. Visit your [API Keys](https://dashboard.cohere.com/api-keys) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "https://api.cohere.ai/v1/chat",
-      "value": "https://api.cohere.ai/v1/chat"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "cohere-api-key",
-    "title": "API Key",
-    "description": "The Cohere API uses API keys for authentication. Visit your [API Keys](https://dashboard.cohere.com/api-keys) page to retrieve the API key you'll use in your requests.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [Cohere API documentation](https://docs.cohere.com/reference/chat) for more information.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "https://api.cohere.ai/v1/chat",
+      "value": "https://api.cohere.ai/v1/chat"
     }
   }
 ]
diff --git a/extensions/inference-groq-extension/resources/settings.json b/extensions/inference-groq-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [Groq documentation](https://console.groq.com/docs/openai) for more information.",
+    "key": "groq-api-key",
+    "title": "API Key",
+    "description": "The Groq API uses API keys for authentication. Visit your [API Keys](https://console.groq.com/keys) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "https://api.groq.com/openai/v1/chat/completions",
-      "value": "https://api.groq.com/openai/v1/chat/completions"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "groq-api-key",
-    "title": "API Key",
-    "description": "The Groq API uses API keys for authentication. Visit your [API Keys](https://console.groq.com/keys) page to retrieve the API key you'll use in your requests.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [Groq documentation](https://console.groq.com/docs/openai) for more information.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "https://api.groq.com/openai/v1/chat/completions",
+      "value": "https://api.groq.com/openai/v1/chat/completions"
     }
   }
 ]
diff --git a/extensions/inference-martian-extension/resources/settings.json b/extensions/inference-martian-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [Martian API documentation](https://docs.withmartian.com/martian-model-router/api-reference/get-chat-completions) for more information.",
+    "key": "martian-api-key",
+    "title": "API Key",
+    "description": "The Martian API uses API keys for authentication. Visit your [API Keys](https://withmartian.com/dashboard) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "https://withmartian.com/api/openai/v1/chat/completions",
-      "value": "https://withmartian.com/api/openai/v1/chat/completions"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "martian-api-key",
-    "title": "API Key",
-    "description": "The Martian API uses API keys for authentication. Visit your [API Keys](https://withmartian.com/dashboard) page to retrieve the API key you'll use in your requests.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [Martian API documentation](https://docs.withmartian.com/martian-model-router/api-reference/get-chat-completions) for more information.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "https://withmartian.com/api/openai/v1/chat/completions",
+      "value": "https://withmartian.com/api/openai/v1/chat/completions"
     }
   }
 ]
diff --git a/extensions/inference-mistral-extension/resources/settings.json b/extensions/inference-mistral-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [Mistral API documentation](https://docs.mistral.ai/api/#operation/createChatCompletion) for more information.",
+    "key": "mistral-api-key",
+    "title": "API Key",
+    "description": "The Mistral API uses API keys for authentication. Visit your [API Keys](https://console.mistral.ai/api-keys/) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "https://api.mistral.ai/v1/chat/completions",
-      "value": "https://api.mistral.ai/v1/chat/completions"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "mistral-api-key",
-    "title": "API Key",
-    "description": "The Mistral API uses API keys for authentication. Visit your [API Keys](https://console.mistral.ai/api-keys/) page to retrieve the API key you'll use in your requests.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [Mistral API documentation](https://docs.mistral.ai/api/#operation/createChatCompletion) for more information.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "https://api.mistral.ai/v1/chat/completions",
+      "value": "https://api.mistral.ai/v1/chat/completions"
     }
   }
 ]
diff --git a/extensions/inference-nvidia-extension/resources/settings.json b/extensions/inference-nvidia-extension/resources/settings.json
@@ -1,24 +1,24 @@
 [
-  {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [NVIDIA API documentation](https://www.nvidia.com/en-us/ai/) for more information.",
-    "controllerType": "input",
-    "controllerProps": {
-      "placeholder": "https://integrate.api.nvidia.com/v1/chat/completions",
-      "value": "https://integrate.api.nvidia.com/v1/chat/completions"
-    }
-  },
   {
     "key": "nvidia-api-key",
     "title": "API Key",
     "description": "The NVIDIA API uses API keys for authentication. Visit your [API Keys](https://org.ngc.nvidia.com/setup/personal-keys) page to retrieve the API key you'll use in your requests..",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "nvapi-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+      "placeholder": "Insert API Key",
       "value": "",
       "type": "password",
       "inputActions": ["unobscure", "copy"]
     }
+  },
+  {
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [NVIDIA API documentation](https://www.nvidia.com/en-us/ai/) for more information.",
+    "controllerType": "input",
+    "controllerProps": {
+      "placeholder": "https://integrate.api.nvidia.com/v1/chat/completions",
+      "value": "https://integrate.api.nvidia.com/v1/chat/completions"
+    }
   }
 ]
diff --git a/extensions/inference-openai-extension/resources/settings.json b/extensions/inference-openai-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [OpenAI API documentation](https://platform.openai.com/docs/api-reference/chat/create) for more information.",
+    "key": "openai-api-key",
+    "title": "API Key",
+    "description": "The OpenAI API uses API keys for authentication. Visit your [API Keys](https://platform.openai.com/account/api-keys) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "https://api.openai.com/v1/chat/completions",
-      "value": "https://api.openai.com/v1/chat/completions"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "openai-api-key",
-    "title": "API Key",
-    "description": "The OpenAI API uses API keys for authentication. Visit your [API Keys](https://platform.openai.com/account/api-keys) page to retrieve the API key you'll use in your requests.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions. See the [OpenAI API documentation](https://platform.openai.com/docs/api-reference/chat/create) for more information.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "https://api.openai.com/v1/chat/completions",
+      "value": "https://api.openai.com/v1/chat/completions"
     }
   }
 ]
diff --git a/extensions/inference-openrouter-extension/resources/settings.json b/extensions/inference-openrouter-extension/resources/settings.json
@@ -1,23 +1,14 @@
 [
-  {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions. See the [OpenRouter API documentation](https://openrouter.ai/docs) for more information.",
-    "controllerType": "input",
-    "controllerProps": {
-      "placeholder": "https://openrouter.ai/api/v1/chat/completions",
-      "value": "https://openrouter.ai/api/v1/chat/completions"
-    }
-  },
   {
     "key": "openrouter-api-key",
     "title": "API Key",
     "description": "The OpenRouter API uses API keys for authentication. Visit your [API Keys](https://openrouter.ai/keys) page to retrieve the API key you'll use in your requests.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+      "placeholder": "Insert API Key",
       "value": "",
-      "type": "password"
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
@@ -28,6 +19,6 @@
     "controllerProps": {
       "placeholder": "Leave empty for default model",
       "value": ""
-    } 
+    }
   }
 ]
diff --git a/extensions/inference-triton-trtllm-extension/resources/settings.json b/extensions/inference-triton-trtllm-extension/resources/settings.json
@@ -1,23 +1,24 @@
 [
   {
-    "key": "chat-completions-endpoint",
-    "title": "Chat Completions Endpoint",
-    "description": "The endpoint to use for chat completions.",
+    "key": "tritonllm-api-key",
+    "title": "API Key",
+    "description": "The Triton LLM API uses API keys for authentication.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "http://localhost:8000/v2/models/tensorrt_llm_bls/generate",
-      "value": "http://localhost:8000/v2/models/tensorrt_llm_bls/generate"
+      "placeholder": "Insert API Key",
+      "value": "",
+      "type": "password",
+      "inputActions": ["unobscure", "copy"]
     }
   },
   {
-    "key": "tritonllm-api-key",
-    "title": "Triton LLM API Key",
-    "description": "The Triton LLM API uses API keys for authentication.",
+    "key": "chat-completions-endpoint",
+    "title": "Chat Completions Endpoint",
+    "description": "The endpoint to use for chat completions.",
     "controllerType": "input",
     "controllerProps": {
-      "placeholder": "xxxxxxxxxxxxxxxxxxxx",
-      "value": "",
-      "type": "password"
+      "placeholder": "http://localhost:8000/v2/models/tensorrt_llm_bls/generate",
+      "value": "http://localhost:8000/v2/models/tensorrt_llm_bls/generate"
     }
   }
 ]