Feature: add helper api (#95)

* feat: add helper API for installation guides and update UI components

- Implement helperAPI with methods to navigate to installation guides for Deno, FFmpeg, and Homebrew
- Update extension and help page components to use new helper API
- Modify command filtering in builtin commands
- Adjust page navigation in help pages to use goHome instead of goBack
- Remove unused imports and clean up components

* chore: bump @kksh/api to 0.1.2 and update dependent packages

apps/cli/CHANGELOG.md

@@ -1,5 +1,12 @@
 # kksh
 
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.32
 
 ### Patch Changes

apps/cli/package.json

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

apps/create-kunkun/CHANGELOG.md

@@ -1,5 +1,12 @@
 # create-kunkun
 
+## 0.1.45
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.1.44
 
 ### Patch Changes

apps/create-kunkun/package.json

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

apps/desktop/src/lib/cmds/builtin.ts

@@ -476,11 +476,10 @@ export const rawBuiltinCmds: BuiltinCmd[] = [
 ].map((cmd) => ({ ...cmd, id: uuidv4() }))
 
 export const builtinCmds = derived([appConfig, appState], ([$appConfig, $appState]) => {
-	return rawBuiltinCmds
-		.filter((cmd) => {
-			const passDeveloper = cmd.flags?.developer ? $appConfig.developerMode : true
-			const passDev = cmd.flags?.dev ? dev : true
-			return passDeveloper && passDev
-		})
-		.filter((cmd) => commandScore(cmd.name, $appState.searchTerm, cmd.keywords) > 0.5)
+	return rawBuiltinCmds.filter((cmd) => {
+		const passDeveloper = cmd.flags?.developer ? $appConfig.developerMode : true
+		const passDev = cmd.flags?.dev ? dev : true
+		return passDeveloper && passDev
+	})
+	// .filter((cmd) => commandScore(cmd.name, $appState.searchTerm, cmd.keywords) > 0.5)
 })

apps/desktop/src/lib/cmds/ext.ts

@@ -1,6 +1,7 @@
 import { i18n } from "@/i18n"
 import { appState } from "@/stores"
 import { winExtMap } from "@/stores/winExtMap"
+import { helperAPI } from "@/utils/helper"
 import { trimSlash } from "@/utils/url"
 import { constructExtensionSupportDir } from "@kksh/api"
 import { db, spawnExtensionFileServer } from "@kksh/api/commands"
@@ -93,6 +94,7 @@ export async function onHeadlessCmdSelect(
 	const serverAPI2 = {
 		...serverAPI,
 		iframeUi: undefined,
+		helper: helperAPI,
 		workerUi: undefined,
 		db: new db.JarvisExtDB(extInfoInDB.extId),
 		kv: new db.KV(extInfoInDB.extId),

apps/desktop/src/lib/components/standalone/help/brew-install.svelte

@@ -1,12 +1,9 @@
 <script lang="ts">
 	import InstallCodeBlock from "@/components/common/install-code-block.svelte"
 	import Icon from "@iconify/svelte"
-	import { IconEnum } from "@kksh/api/models"
-	import { Button, Tabs } from "@kksh/svelte5"
 	import { TauriLink } from "@kksh/ui"
 	import { platform } from "@tauri-apps/plugin-os"
 	import { onMount } from "svelte"
-	import { toast } from "svelte-sonner"
 	import { whereIsCommand } from "tauri-plugin-shellx-api"
 
 	let brewPath = $state("")
@@ -21,12 +18,7 @@
 </script>
 
 <h1 class="font-mono text-2xl font-bold">Install Homebrew</h1>
-<TauriLink
-	href="/app/help/brew-install"
-	icon={IconEnum.Iconify}
-	iconValue="devicon:homebrew"
-	class="flex items-center"
->
+<TauriLink href="/app/help/brew-install" class="flex items-center">
 	<span class="text-lg">Homebrew Website</span>
 	<Icon icon="devicon:homebrew" class="h-6 w-6" />
 </TauriLink>

apps/desktop/src/lib/utils/helper.ts

@@ -0,0 +1,19 @@
+/**
+ * This file contains APIs for helper
+ */
+
+import { i18n } from "@/i18n"
+import type { IHelper } from "@kksh/api"
+import { goto } from "$app/navigation"
+
+export const helperAPI: IHelper = {
+	guideInstallDeno: function (): Promise<void> {
+		return goto(i18n.resolveRoute("/app/help/deno-install"))
+	},
+	guideInstallFfmpeg: function (): Promise<void> {
+		return goto(i18n.resolveRoute("/app/help/ffmpeg-install"))
+	},
+	guideInstallHomebrew: function (): Promise<void> {
+		return goto(i18n.resolveRoute("/app/help/brew-install"))
+	}
+}

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

@@ -225,10 +225,10 @@
 				onExtCmdSelect={commandLaunchers.onExtCmdSelect}
 			/>
 		{/if}
-		<AppsCmds apps={$appsLoader} />
 		<QuickLinks quickLinks={$quickLinks} />
 		<BuiltinCmds builtinCmds={$builtinCmds} />
 		<SystemCmds systemCommands={$systemCommands} />
+		<AppsCmds apps={$appsLoader} />
 
 		<!-- <AppsCmds apps={$appsFiltered} /> -->
 		<!-- {#if $quickLinksFiltered.length > 0}

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

@@ -2,6 +2,7 @@
 	import DanceTransition from "@/components/dance/dance-transition.svelte"
 	import { i18n } from "@/i18n"
 	import { appConfig, winExtMap } from "@/stores"
+	import { helperAPI } from "@/utils/helper"
 	import { goBackOnEscape } from "@/utils/key"
 	import { goHome } from "@/utils/route"
 	import { positionToCssStyleString, positionToTailwindClasses } from "@/utils/style"
@@ -114,6 +115,7 @@
 			...serverAPI.iframeUi,
 			...iframeUiAPI
 		} satisfies IUiCustomServer1 & IUiCustomServer2,
+		helper: helperAPI,
 		db: new db.JarvisExtDB(extInfoInDB.extId),
 		kv: new db.KV(extInfoInDB.extId),
 		app: {

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

@@ -3,6 +3,7 @@
 	import { appState } from "@/stores/appState.js"
 	import { keys } from "@/stores/keys"
 	import { winExtMap } from "@/stores/winExtMap.js"
+	import { helperAPI } from "@/utils/helper.js"
 	import { listenToFileDrop, listenToRefreshDevExt } from "@/utils/tauri-events.js"
 	import { isInMainWindow } from "@/utils/window.js"
 	import { db } from "@kksh/api/commands"
@@ -219,6 +220,7 @@
 			...serverAPI,
 			iframeUi: undefined,
 			workerUi: extUiAPI,
+			helper: helperAPI,
 			db: new db.JarvisExtDB(extInfoInDB.extId),
 			kv: new db.KV(extInfoInDB.extId),
 			app: {

apps/desktop/src/routes/app/help/brew-install/+page.svelte

@@ -1,13 +1,13 @@
 <script lang="ts">
 	import BrewInstall from "@/components/standalone/help/brew-install.svelte"
-	import { goBackOnEscape } from "@/utils/key"
-	import { goBack } from "@/utils/route"
+	import { goBackOnEscape, goHomeOnEscape } from "@/utils/key"
+	import { goBack, goHome } from "@/utils/route"
 	import { Button } from "@kksh/svelte5"
 	import ArrowLeft from "svelte-radix/ArrowLeft.svelte"
 </script>
 
-<svelte:window on:keydown={goBackOnEscape} />
-<Button variant="outline" size="icon" onclick={goBack} class="absolute left-2 top-2">
+<svelte:window on:keydown={goHomeOnEscape} />
+<Button variant="outline" size="icon" onclick={goHome} class="absolute left-2 top-2">
 	<ArrowLeft class="size-4" />
 </Button>
 

apps/desktop/src/routes/app/help/deno-install/+page.svelte

@@ -1,13 +1,13 @@
 <script lang="ts">
 	import DenoInstall from "@/components/standalone/help/deno-install.svelte"
-	import { goBackOnEscape } from "@/utils/key"
-	import { goBack } from "@/utils/route"
+	import { goHomeOnEscape } from "@/utils/key"
+	import { goHome } from "@/utils/route"
 	import { Button } from "@kksh/svelte5"
 	import ArrowLeft from "svelte-radix/ArrowLeft.svelte"
 </script>
 
-<svelte:window on:keydown={goBackOnEscape} />
-<Button variant="outline" size="icon" onclick={goBack} class="absolute left-2 top-2">
+<svelte:window on:keydown={goHomeOnEscape} />
+<Button variant="outline" size="icon" onclick={goHome} class="absolute left-2 top-2">
 	<ArrowLeft class="size-4" />
 </Button>
 <main class="container pt-12">

apps/desktop/src/routes/app/help/ffmpeg-install/+page.svelte

@@ -1,13 +1,13 @@
 <script lang="ts">
 	import FFmpegInstall from "@/components/standalone/help/ffmpeg-install.svelte"
-	import { goBackOnEscape } from "@/utils/key"
-	import { goBack } from "@/utils/route"
+	import { goHomeOnEscape } from "@/utils/key"
+	import { goHome } from "@/utils/route"
 	import { Button } from "@kksh/svelte5"
 	import ArrowLeft from "svelte-radix/ArrowLeft.svelte"
 </script>
 
-<svelte:window on:keydown={goBackOnEscape} />
-<Button variant="outline" size="icon" onclick={goBack} class="absolute left-2 top-2">
+<svelte:window on:keydown={goHomeOnEscape} />
+<Button variant="outline" size="icon" onclick={goHome} class="absolute left-2 top-2">
 	<ArrowLeft class="size-4" />
 </Button>
 <main class="container pt-12">

packages/api/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @kksh/api
 
+## 0.1.2
+
+### Patch Changes
+
+- Add helper API
+
 ## 0.1.1
 
 ### Patch Changes

packages/api/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kksh/api",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"type": "module",
 	"repository": {
 		"type": "git",

packages/api/src/api/client.ts

@@ -300,3 +300,9 @@ export interface ISecurity {
 		checkScreenCapturePermission: () => Promise<boolean>
 	}
 }
+
+export interface IHelper {
+	guideInstallDeno: () => Promise<void>
+	guideInstallFfmpeg: () => Promise<void>
+	guideInstallHomebrew: () => Promise<void>
+}

packages/api/src/api/toast.ts

@@ -1,4 +1,3 @@
-// import { proxy as comlinkProxy, type Remote } from "@huakunshen/comlink"
 import type { GeneralToastParams, IToast } from "./client"
 
 export function constructToastAPI(api: IToast) {

packages/api/src/headless/index.ts

@@ -20,6 +20,7 @@ import type {
 	IDb,
 	IEvent,
 	IFs,
+	IHelper,
 	IKV,
 	IOpen,
 	IPath,
@@ -79,6 +80,7 @@ type API = {
 	shell: IShellServer // inherit from tauri-api-adapter
 	updownload: IUpdownload // inherit from tauri-api-adapter
 	sysInfo: ISystemInfo // inherit from tauri-api-adapter
+	helper: IHelper // for kunkun
 	network: INetwork // inherit from tauri-api-adapter
 	security: ISecurity // for kunkun
 	utils: IUtils // for kunkun

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

@@ -25,6 +25,7 @@ import type {
 	IDb,
 	IEvent,
 	IFs,
+	IHelper,
 	IKV,
 	IOpen,
 	IPath,
@@ -71,6 +72,7 @@ type API = {
 	iframeUi: IUiCustom // for kunkun
 	utils: IUtils // for kunkun
 	security: ISecurity // for kunkun
+	helper: IHelper // for kunkun
 	app: IApp
 }
 // export const api = wrap(windowEndpoint(globalThis.parent)) as unknown as API

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

@@ -30,6 +30,7 @@ import type {
 	IDb,
 	IEvent,
 	IFs,
+	IHelper,
 	IKV,
 	IOpen,
 	IPath,
@@ -83,6 +84,7 @@ type API = {
 	sysInfo: ISystemInfo // inherit from tauri-api-adapter
 	network: INetwork // inherit from tauri-api-adapter
 	workerUi: IUiTemplate // for kunkun
+	helper: IHelper
 	security: ISecurity // for kunkun
 	utils: IUtils // for kunkun
 	app: IApp
@@ -121,6 +123,7 @@ export const {
 	utils,
 	app,
 	security,
+	helper,
 	workerUi: ui
 } = api
 export { Child, RPCChannel, Command, DenoCommand } from "../../api/shell"

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

@@ -1,5 +1,12 @@
 # demo-template-extension
 
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.8
 
 ### 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.8",
+	"version": "0.0.9",
 	"type": "module",
 	"license": "MIT",
 	"kunkun": {

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

@@ -7,6 +7,7 @@ import {
 	expose,
 	Form,
 	fs,
+	helper,
 	Icon,
 	IconEnum,
 	kv,

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

@@ -1,5 +1,12 @@
 # template-ext-sveltekit
 
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.8
 
 ### 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.8",
+	"version": "0.0.9",
 	"license": "MIT",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

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

@@ -1,5 +1,12 @@
 # template-ext-worker
 
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.7
 
 ### Patch Changes

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

@@ -1,7 +1,7 @@
 {
 	"$schema": "./node_modules/@kksh/api/dist/schema.json",
 	"name": "template-ext-headless",
-	"version": "0.0.7",
+	"version": "0.0.8",
 	"license": "MIT",
 	"type": "module",
 	"kunkun": {

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

@@ -1,5 +1,12 @@
 # template-ext-next
 
+## 0.1.7
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.1.6
 
 ### 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.6",
+	"version": "0.1.7",
 	"license": "MIT",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

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

@@ -1,5 +1,12 @@
 # template-ext-nuxt
 
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.8
 
 ### 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.8",
+	"version": "0.0.9",
 	"type": "module",
 	"license": "MIT",
 	"kunkun": {

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

@@ -1,5 +1,12 @@
 # template-ext-react
 
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.7
 
 ### 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",
 	"license": "MIT",
-	"version": "0.0.7",
+	"version": "0.0.8",
 	"type": "module",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

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

@@ -1,5 +1,12 @@
 # template-ext-svelte
 
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.7
 
 ### 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",
 	"license": "MIT",
-	"version": "0.0.7",
+	"version": "0.0.8",
 	"type": "module",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

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

@@ -1,5 +1,12 @@
 # template-ext-sveltekit
 
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.8
 
 ### 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.8",
+	"version": "0.0.9",
 	"license": "MIT",
 	"kunkun": {
 		"name": "TODO: Change Display Name",

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

@@ -1,5 +1,12 @@
 # template-ext-vue
 
+## 0.0.6
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.5
 
 ### Patch Changes

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

@@ -1,7 +1,7 @@
 {
 	"name": "template-ext-vue",
 	"license": "MIT",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"type": "module",
 	"scripts": {
 		"dev": "vite",

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

@@ -1,5 +1,12 @@
 # template-ext-worker
 
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies
+  - @kksh/api@0.1.2
+
 ## 0.0.7
 
 ### Patch Changes

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.7",
+	"version": "0.0.8",
 	"license": "MIT",
 	"type": "module",
 	"kunkun": {

vendors/tauri-plugin-user-input

@@ -1 +1 @@
-Subproject commit 890edc0216f5d7d36de7dcdd1809b7551c342e06
+Subproject commit f62f393efad652dec9ec9c4c065aba637538a3ac