From 7b6c0934ab0635423fdbca9d34d122dd7dff7428 Mon Sep 17 00:00:00 2001 From: Huakun Shen Date: Fri, 7 Feb 2025 02:41:50 -0500 Subject: [PATCH] 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 | 7 +++++++ apps/cli/package.json | 2 +- apps/create-kunkun/CHANGELOG.md | 7 +++++++ apps/create-kunkun/package.json | 2 +- apps/desktop/src/lib/cmds/builtin.ts | 13 ++++++------- apps/desktop/src/lib/cmds/ext.ts | 2 ++ .../standalone/help/brew-install.svelte | 10 +--------- apps/desktop/src/lib/utils/helper.ts | 19 +++++++++++++++++++ apps/desktop/src/routes/app/+page.svelte | 2 +- .../app/extension/ui-iframe/+page.svelte | 2 ++ .../app/extension/ui-worker/+page.svelte | 2 ++ .../routes/app/help/brew-install/+page.svelte | 8 ++++---- .../routes/app/help/deno-install/+page.svelte | 8 ++++---- .../app/help/ffmpeg-install/+page.svelte | 8 ++++---- packages/api/CHANGELOG.md | 6 ++++++ packages/api/package.json | 2 +- packages/api/src/api/client.ts | 6 ++++++ packages/api/src/api/toast.ts | 1 - packages/api/src/headless/index.ts | 2 ++ packages/api/src/ui/custom/index.ts | 2 ++ packages/api/src/ui/template/index.ts | 3 +++ .../demo-worker-template-ext/CHANGELOG.md | 7 +++++++ .../demo-worker-template-ext/package.json | 2 +- .../demo-worker-template-ext/src/index.ts | 1 + .../extensions/ext-sveltekit-exp/CHANGELOG.md | 7 +++++++ .../extensions/ext-sveltekit-exp/package.json | 2 +- .../template-ext-headless/CHANGELOG.md | 7 +++++++ .../template-ext-headless/package.json | 2 +- .../templates/template-ext-next/CHANGELOG.md | 7 +++++++ .../templates/template-ext-next/package.json | 2 +- .../templates/template-ext-nuxt/CHANGELOG.md | 7 +++++++ .../templates/template-ext-nuxt/package.json | 2 +- .../templates/template-ext-react/CHANGELOG.md | 7 +++++++ .../templates/template-ext-react/package.json | 2 +- .../template-ext-svelte/CHANGELOG.md | 7 +++++++ .../template-ext-svelte/package.json | 2 +- .../template-ext-sveltekit/CHANGELOG.md | 7 +++++++ .../template-ext-sveltekit/package.json | 2 +- .../templates/template-ext-vue/CHANGELOG.md | 7 +++++++ .../templates/template-ext-vue/package.json | 2 +- .../template-ext-worker/CHANGELOG.md | 7 +++++++ .../template-ext-worker/package.json | 2 +- vendors/tauri-plugin-user-input | 2 +- 43 files changed, 163 insertions(+), 44 deletions(-) create mode 100644 apps/desktop/src/lib/utils/helper.ts diff --git a/apps/cli/CHANGELOG.md b/apps/cli/CHANGELOG.md index 345914b..00fedfb 100644 --- a/apps/cli/CHANGELOG.md +++ b/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 diff --git a/apps/cli/package.json b/apps/cli/package.json index fe61b4f..63670d1 100644 --- a/apps/cli/package.json +++ b/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", diff --git a/apps/create-kunkun/CHANGELOG.md b/apps/create-kunkun/CHANGELOG.md index a295b4b..7a911f2 100644 --- a/apps/create-kunkun/CHANGELOG.md +++ b/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 diff --git a/apps/create-kunkun/package.json b/apps/create-kunkun/package.json index 29ab9b9..004016d 100644 --- a/apps/create-kunkun/package.json +++ b/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" }, diff --git a/apps/desktop/src/lib/cmds/builtin.ts b/apps/desktop/src/lib/cmds/builtin.ts index ab8928c..eac0fa3 100644 --- a/apps/desktop/src/lib/cmds/builtin.ts +++ b/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) }) diff --git a/apps/desktop/src/lib/cmds/ext.ts b/apps/desktop/src/lib/cmds/ext.ts index 4169fb4..fe49456 100644 --- a/apps/desktop/src/lib/cmds/ext.ts +++ b/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), diff --git a/apps/desktop/src/lib/components/standalone/help/brew-install.svelte b/apps/desktop/src/lib/components/standalone/help/brew-install.svelte index f9c0693..c930726 100644 --- a/apps/desktop/src/lib/components/standalone/help/brew-install.svelte +++ b/apps/desktop/src/lib/components/standalone/help/brew-install.svelte @@ -1,12 +1,9 @@

Install Homebrew

- + Homebrew Website diff --git a/apps/desktop/src/lib/utils/helper.ts b/apps/desktop/src/lib/utils/helper.ts new file mode 100644 index 0000000..f079102 --- /dev/null +++ b/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 { + return goto(i18n.resolveRoute("/app/help/deno-install")) + }, + guideInstallFfmpeg: function (): Promise { + return goto(i18n.resolveRoute("/app/help/ffmpeg-install")) + }, + guideInstallHomebrew: function (): Promise { + return goto(i18n.resolveRoute("/app/help/brew-install")) + } +} diff --git a/apps/desktop/src/routes/app/+page.svelte b/apps/desktop/src/routes/app/+page.svelte index dad96c0..e9deaf2 100644 --- a/apps/desktop/src/routes/app/+page.svelte +++ b/apps/desktop/src/routes/app/+page.svelte @@ -225,10 +225,10 @@ onExtCmdSelect={commandLaunchers.onExtCmdSelect} /> {/if} - +