kunkun/packages/api
Huakun Shen f89cf8fe6a
Some checks are pending
CI / build-test (macos-14) (push) Waiting to run
CI / build-test (ubuntu-24.04) (push) Waiting to run
CI / build-test (windows-latest) (push) Waiting to run
Feature: Headless Command (#44)
* chore: add check-types

* refactor: api package file structure update

* feat: add headless worker extension API

* feat: add HeadlessCmd to manifest schema

* feat: make each type of cmds optional in manifest

There may be more types of cmds in the future, this makes backward compatibility easier.

* feat: implement headless extension command in app

A demo cmd implemented as well.

* refactor: move api package's API server files

* refactor: reformat all
2025-01-05 21:12:56 -05:00
..
__tests__ App Setup (#2) 2024-11-03 13:54:44 -05:00
src Feature: Headless Command (#44) 2025-01-05 21:12:56 -05:00
.gitignore App Setup (#2) 2024-11-03 13:54:44 -05:00
.npmrc App Setup (#2) 2024-11-03 13:54:44 -05:00
build.ts Feature: Headless Command (#44) 2025-01-05 21:12:56 -05:00
CHANGELOG.md Feature: KV API (#43) 2025-01-05 17:19:21 -05:00
deno.lock chore: update README and pnpm lock, deno lock 2024-11-09 07:32:21 -05:00
jsr.json Feature: KV API (#43) 2025-01-05 17:19:21 -05:00
package.json Feature: Headless Command (#44) 2025-01-05 21:12:56 -05:00
patch-version.ts App Setup (#2) 2024-11-03 13:54:44 -05:00
README.md App Setup (#2) 2024-11-03 13:54:44 -05:00
setup.ts docs: support cloudflare API docs building without Deno 2024-11-03 14:57:49 -05:00
tsconfig.json File Transfer (Local Network) (#34) 2024-12-11 08:14:40 -05:00
typedoc.json App Setup (#2) 2024-11-03 13:54:44 -05:00

@kksh/api

NPM Version

Kunkun API is an NPM package designed for developers to create extensions for Kunkun.

@kksh/api provides a set of APIs for extensions to interact with Kunkun and System APIs. The APIs include:

  • Clipboard
  • Database
  • Dialog
  • Event
  • Fetch
  • File System
  • Logger
  • Network
  • Notification
  • Open
  • OS
  • Path
  • Shell
  • System Info
  • System Commands
  • Toast
  • UI
  • etc.

Read more details in documentation at https://docs.kunkun.sh, and generated docs at https://docs.api.kunkun.sh/

Dev

Dependency Graph

To detect circular dependencies

pnpm madge ./src/ui/worker/index.ts --circular # detect circular dependencies
pnpm dep-tree ./src/ui/worker/index.ts


pnpm test # this will detect circular dependencies in all files