Feature: KV API (#43)

* feat: add kv store API for extensions

* feat: add kv api to @kksh/api package

* bump: @kksh/api to 0.0.47

* feat: add IKV type export to UI module

* feat: add delete api for KV API

.changeset/config.json

@@ -8,6 +8,7 @@
 	"baseBranch": "develop",
 	"updateInternalDependencies": "patch",
 	"ignore": [
+		"jarvis",
 		"@kksh/desktop",
 		"@kksh/supabase",
 		"@kksh/utils",

apps/cli/CHANGELOG.md

@@ -1,5 +1,12 @@
 # kksh
 
+## 0.0.26
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.25
 
 ### Patch Changes

apps/cli/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "kksh",
 	"module": "dist/cli.js",
-	"version": "0.0.25",
+	"version": "0.0.26",
 	"type": "module",
 	"bin": {
 		"kksh": "./dist/cli.js",

apps/create-kunkun/CHANGELOG.md

@@ -1,5 +1,12 @@
 # create-kunkun
 
+## 0.1.36
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.1.35
 
 ### Patch Changes

apps/create-kunkun/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "create-kunkun",
 	"type": "module",
-	"version": "0.1.35",
+	"version": "0.1.36",
 	"bin": {
 		"create-kunkun": "dist/index.mjs"
 	},

apps/desktop/src/app.css

@@ -75,3 +75,7 @@
 		@apply bg-background text-foreground;
 	}
 }
+
+html {
+	overscroll-behavior: none;
+}

apps/desktop/src/routes/app/+page.svelte

@@ -7,7 +7,7 @@
 	import { cmdQueries } from "@/stores/cmdQuery"
 	import { isKeyboardEventFromInputElement } from "@/utils/dom"
 	import Icon from "@iconify/svelte"
-	import { toggleDevTools } from "@kksh/api/commands"
+	import { db, toggleDevTools } from "@kksh/api/commands"
 	import { Button, Command, DropdownMenu } from "@kksh/svelte5"
 	import {
 		BuiltinCmds,
@@ -24,7 +24,8 @@
 	import { exit } from "@tauri-apps/plugin-process"
 	import { ArrowBigUpIcon, CircleXIcon, EllipsisVerticalIcon, RefreshCcwIcon } from "lucide-svelte"
 	import { onMount } from "svelte"
-	import { hasCommand, whereIsCommand } from "tauri-plugin-shellx-api"
+
+	const kv = new db.KV(1)
 
 	let inputEle: HTMLInputElement | null = $state(null)
 	function onKeyDown(event: KeyboardEvent) {

apps/desktop/src/routes/app/extension/ui-iframe/+page.svelte

@@ -112,6 +112,7 @@
 		...iframeUiAPI
 	} satisfies IUiIframe
 	serverAPI.db = new db.JarvisExtDB(extInfoInDB.extId)
+	serverAPI.kv = new db.KV(extInfoInDB.extId)
 	serverAPI.app = {
 		language: () => Promise.resolve("en") // TODO: get locale
 	} satisfies IApp

apps/desktop/src/routes/app/extension/ui-worker/+page.svelte

@@ -23,7 +23,6 @@
 		toast,
 		// wrap,
 		type IComponent,
-		type IDb,
 		type WorkerExtension
 	} from "@kksh/api/ui/worker"
 	import { Button } from "@kksh/svelte5"
@@ -212,6 +211,7 @@
 		serverAPI.iframeUi = undefined
 		serverAPI.workerUi = extUiAPI
 		serverAPI.db = new db.JarvisExtDB(extInfoInDB.extId)
+		serverAPI.kv = new db.KV(extInfoInDB.extId)
 		serverAPI.app = {
 			language: () => Promise.resolve("en")
 		} satisfies IApp

package.json

@@ -16,21 +16,21 @@
 		"prettier": "^3.4.2",
 		"prettier-plugin-svelte": "^3.3.2",
 		"prettier-plugin-tailwindcss": "^0.6.9",
-		"svelte": "^5.14.4",
+		"svelte": "^5.16.2",
 		"svelte-check": "^4.1.1",
 		"turbo": "^2.3.3",
 		"typescript": "5.7.2"
 	},
-	"packageManager": "pnpm@9.15.0",
+	"packageManager": "pnpm@9.15.2",
 	"engines": {
 		"node": ">=22"
 	},
 	"dependencies": {
 		"@changesets/cli": "^2.27.11",
-		"@iconify/svelte": "^4.1.0",
-		"@supabase/supabase-js": "^2.47.9",
-		"@tauri-apps/api": "^2.1.1",
-		"@tauri-apps/cli": "^2.1.0",
+		"@iconify/svelte": "^4.2.0",
+		"@supabase/supabase-js": "^2.47.10",
+		"@tauri-apps/api": "^2.2.0",
+		"@tauri-apps/cli": "^2.2.2",
 		"@tauri-apps/plugin-deep-link": "^2.2.0",
 		"@tauri-apps/plugin-dialog": "^2.2.0",
 		"@tauri-apps/plugin-fs": "^2.2.0",
@@ -44,12 +44,12 @@
 		"@tauri-apps/plugin-store": "^2.2.0",
 		"@tauri-apps/plugin-updater": "^2.3.0",
 		"@tauri-apps/plugin-upload": "https://gitpkg.vercel.app/HuakunShen/tauri-plugins-workspace/plugins/upload?69b198b0ccba269fe7622a95ec6a33ae392bff03",
-		"supabase": "^2.1.1",
+		"supabase": "^2.2.1",
 		"tauri-plugin-network-api": "workspace:*",
 		"tauri-plugin-keyring-api": "workspace:*",
 		"tauri-plugin-shellx-api": "^2.0.14",
 		"tauri-plugin-system-info-api": "workspace:*",
-		"valibot": "^1.0.0-beta.9",
+		"valibot": "^1.0.0-beta.10",
 		"zod": "^3.24.1"
 	},
 	"workspaces": [

packages/api/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @kksh/api
 
+## 0.0.47
+
+### Patch Changes
+
+- Add Extension KV API
+
 ## 0.0.43
 
 ### Patch Changes

packages/api/jsr.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://jsr.io/schema/config-file.v1.json",
 	"name": "@kunkun/api",
-	"version": "0.0.44",
+	"version": "0.0.47",
 	"license": "MIT",
 	"exports": {
 		".": "./src/index.ts",

packages/api/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kksh/api",
-	"version": "0.0.46",
+	"version": "0.0.47",
 	"type": "module",
 	"exports": {
 		".": "./src/index.ts",
@@ -61,7 +61,7 @@
 		"semver": "^7.6.3",
 		"svelte-sonner": "^0.3.28",
 		"tauri-api-adapter": "^0.3.16",
-		"tauri-plugin-network-api": "2.0.4",
+		"tauri-plugin-network-api": "2.0.5",
 		"tauri-plugin-shellx-api": "^2.0.14",
 		"tauri-plugin-system-info-api": "2.0.8",
 		"valibot": "^1.0.0-beta.8"

packages/api/src/commands/db.ts

@@ -347,3 +347,91 @@ export class JarvisExtDB {
 		return updateExtensionDataById(data)
 	}
 }
+
+export class KV {
+	extId: number
+	db: JarvisExtDB
+	private DataType: string = "kunkun_kv"
+
+	constructor(extId: number) {
+		this.extId = extId
+		this.db = new JarvisExtDB(extId)
+	}
+
+	get<T = string>(key: string): Promise<T | null | undefined> {
+		return this.db
+			.search({
+				dataType: this.DataType,
+				searchText: key,
+				searchMode: SearchModeEnum.ExactMatch,
+				fields: ["search_text", "data"]
+			})
+			.then((items) => {
+				if (items.length === 0) {
+					return null
+				} else if (items.length > 1) {
+					throw new Error("Multiple KVs with the same key")
+				}
+				return items[0].data ? (JSON.parse(items[0].data).value as T) : null
+			})
+			.catch((err) => {
+				console.warn(err)
+				return null
+			})
+	}
+
+	set(key: string, value: string): Promise<void> {
+		return this.db
+			.search({
+				dataType: this.DataType,
+				searchText: key,
+				searchMode: SearchModeEnum.ExactMatch
+			})
+			.then((items) => {
+				if (items.length === 0) {
+					return this.db.add({
+						data: JSON.stringify({ value: value }),
+						dataType: this.DataType,
+						searchText: key
+					})
+				} else if (items.length === 1) {
+					return this.db.update({
+						dataId: items[0].dataId,
+						data: JSON.stringify({ value: value }),
+						searchText: key
+					})
+				} else {
+					return Promise.all(items.map((item) => this.db.delete(item.dataId))).then(() =>
+						Promise.resolve()
+					)
+				}
+			})
+	}
+
+	delete(key: string): Promise<void> {
+		return this.db
+			.search({
+				dataType: this.DataType,
+				searchText: key,
+				searchMode: SearchModeEnum.ExactMatch
+			})
+			.then((items) => {
+				return Promise.all(items.map((item) => this.db.delete(item.dataId))).then(() =>
+					Promise.resolve()
+				)
+			})
+	}
+
+	exists(key: string): Promise<boolean> {
+		return this.db
+			.search({
+				dataType: this.DataType,
+				searchText: key,
+				searchMode: SearchModeEnum.ExactMatch,
+				fields: []
+			})
+			.then((items) => {
+				return items.length > 0
+			})
+	}
+}

packages/api/src/ui/client.ts

@@ -28,7 +28,7 @@ import type {
 } from "tauri-plugin-shellx-api"
 import { EventEmitter, open as shellxOpen } from "tauri-plugin-shellx-api"
 import * as v from "valibot"
-import { type JarvisExtDB } from "../commands/db"
+import { KV, type JarvisExtDB } from "../commands/db"
 import type { fileSearch } from "../commands/fileSearch"
 import { type AppInfo } from "../models/apps"
 import type { LightMode, Position, Radius, ThemeColor } from "../models/styles"
@@ -182,6 +182,13 @@ export interface IDb {
 	update: typeof JarvisExtDB.prototype.update
 }
 
+export interface IKV {
+	get: typeof KV.prototype.get
+	set: typeof KV.prototype.set
+	exists: typeof KV.prototype.exists
+	delete: typeof KV.prototype.delete
+}
+
 export interface IFs {
 	readDir: typeof readDir
 	readFile: typeof readFile

packages/api/src/ui/index.ts

@@ -38,5 +38,15 @@ export type {
 	IUpdownload,
 	IFetch
 } from "tauri-api-adapter"
-export type { ISystem, IToast, IUiWorker, IUiIframe, IDb, IFs, IOpen, IEvent } from "../ui/client"
+export type {
+	ISystem,
+	IToast,
+	IUiWorker,
+	IUiIframe,
+	IDb,
+	IKV,
+	IFs,
+	IOpen,
+	IEvent
+} from "../ui/client"
 export type { IShell } from "./api/shell"

packages/api/src/ui/worker/index.ts

@@ -34,6 +34,7 @@ import type {
 	IDb,
 	IEvent,
 	IFs,
+	IKV,
 	IOpen,
 	IPath,
 	ISecurity,
@@ -47,13 +48,13 @@ import type { WorkerExtension } from "./ext"
 
 // export { expose, wrap } from "@huakunshen/comlink"
 export { WorkerExtension } from "./ext"
-export type { IDb } from "../client"
 /**
  * For the APIs annotated with "inherit from tauri-api-adapter", they inherit the client API completely from tauri-api-adapter
  * There may be server API changes for them, but the client API can be inherited
  */
 type API = {
 	db: IDb // for kunkun
+	kv: IKV // for kunkun
 	system: ISystem // for kunkun
 	open: IOpen // for kunkun
 	clipboard: IClipboard // inherit from tauri-api-adapter
@@ -93,6 +94,7 @@ export const toast = constructToastAPI(api.toast)
 export const updownload = constructUpdownloadAPI(api.updownload)
 export const {
 	db,
+	kv,
 	os,
 	clipboard,
 	dialog,

packages/db/src/lib.rs

@@ -499,7 +499,6 @@ impl JarvisDB {
             param_index += 1;
         }
         let mut stmt = self.conn.prepare(&query)?;
-        // println!("search_extension_data query: {}", query);
         let ext_data_iter =
             stmt.query_map(params_from_iter(params.iter().map(|p| p.as_ref())), |row| {
                 Ok(models::ExtData {

packages/extensions/demo-worker-template-ext/CHANGELOG.md

@@ -1,5 +1,12 @@
 # demo-template-extension
 
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.3
 
 ### Patch Changes

packages/extensions/demo-worker-template-ext/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "../../schema/manifest-json-schema.json",
 	"name": "demo-template-extension",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"type": "module",
 	"kunkun": {
 		"name": "Demo Template Extension",

packages/extensions/demo-worker-template-ext/src/index.ts

@@ -3,11 +3,13 @@ import {
 	app,
 	Child,
 	clipboard,
+	db,
 	expose,
 	Form,
 	fs,
 	Icon,
 	IconEnum,
+	kv,
 	List,
 	Markdown,
 	open,
@@ -51,6 +53,15 @@ class ExtensionTemplate extends WorkerExtension {
 		clipboard.readText().then((text) => {
 			console.log("Clipboard text:", text)
 		})
+		kv.exists("test").then((exists) => {
+			console.log("KV exists:", exists)
+		})
+		kv.set("test", Math.random().toString()).then(() => {
+			return kv.get("test").then((value) => {
+				console.log("KV value:", value)
+			})
+		})
+
 		// console.log("Check screen capture permission:", await security.mac.checkScreenCapturePermission())
 		// await security.mac.revealSecurityPane("AllFiles")
 		// console.log(await security.mac.verifyFingerprint())

packages/extensions/ext-sveltekit-exp/CHANGELOG.md

@@ -1,5 +1,12 @@
 # template-ext-sveltekit
 
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.3
 
 ### Patch Changes

packages/extensions/ext-sveltekit-exp/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://schema.kunkun.sh",
 	"name": "ext-sveltekit-exp",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"private": true,
 	"kunkun": {
 		"name": "TODO: Change Display Name",

packages/extensions/form-view/CHANGELOG.md

@@ -0,0 +1,8 @@
+# form-view
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47

packages/extensions/form-view/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://schema.kunkun.sh",
 	"name": "form-view",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
 	"kunkun": {
 		"name": "Form View",

packages/templates/template-ext-next/CHANGELOG.md

@@ -1,5 +1,12 @@
 # template-ext-next
 
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.1.1
 
 ### Patch Changes

packages/templates/template-ext-next/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-next",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"private": true,
 	"kunkun": {
 		"name": "TODO: Change Display Name",

packages/templates/template-ext-nuxt/CHANGELOG.md

@@ -1,5 +1,12 @@
 # template-ext-nuxt
 
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.3
 
 ### Patch Changes

packages/templates/template-ext-nuxt/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-nuxt",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"private": true,
 	"type": "module",
 	"kunkun": {

packages/templates/template-ext-react/CHANGELOG.md

@@ -1,5 +1,12 @@
 # template-ext-react
 
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.2
 
 ### Patch Changes

packages/templates/template-ext-react/package.json

@@ -2,7 +2,7 @@
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-react",
 	"private": true,
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

packages/templates/template-ext-svelte/CHANGELOG.md

@@ -1,5 +1,12 @@
 # template-ext-svelte
 
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.2
 
 ### Patch Changes

packages/templates/template-ext-svelte/package.json

@@ -2,7 +2,7 @@
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-svelte",
 	"private": true,
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

packages/templates/template-ext-sveltekit/CHANGELOG.md

@@ -1,5 +1,12 @@
 # template-ext-sveltekit
 
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47
+
 ## 0.0.3
 
 ### Patch Changes

packages/templates/template-ext-sveltekit/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-sveltekit",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"private": true,
 	"kunkun": {
 		"name": "TODO: Change Display Name",

packages/templates/template-ext-vue/CHANGELOG.md

@@ -0,0 +1,8 @@
+# template-ext-vue
+
+## 0.0.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47

packages/templates/template-ext-vue/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "template-ext-vue",
 	"private": true,
-	"version": "0.0.0",
+	"version": "0.0.1",
 	"type": "module",
 	"scripts": {
 		"dev": "vite",

packages/templates/template-ext-worker/CHANGELOG.md

@@ -0,0 +1,8 @@
+# template-ext-worker
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.0.47

packages/templates/template-ext-worker/package.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-worker",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
 	"kunkun": {
 		"name": "TODO: Extension Display Name",