kunkun/packages/api/README.md
Huakun Shen ed87fc6c12
App Setup (#2)
* chore: add vendor submodules

* feat: add packages for db,ci,schema,api,jarvis cmds

* feat: add tauri-jarvis-plugin

* feat: implement extension commands list

* fix(desktop): import path errors after packages refactor

* chore: add self signed cert

* fix: prevent prerender for desktop

* fix(desktop): desktop sveltekit static build, use csr for dynamic route

* feat: add error handling page and components

* refactor: component lib

* refactor: move more types, functions and components out of desktop

* refactor(ui): more refactor

* refactor(ui): move store components to @kksh/ui

* ci: add CI for build & test

* refactor: rename @kksh/extensions to @kksh/extension

* ci: add 2 more ci

* ci: fix

* fix: CI env var

* chore: add changeset

* feat: implement extension store item detail view

* feat: implement extension store install, uninstall, upgrade

* format

* revert: upgradable logic, the new one doesn't work yet

* refactor: make @kksh/ui dependent only on @kksh/api

Reason: @kksh/ui may be published later for building website, all its dependency packages must be also published. To avoid trouble it should be standalone, depend only on packages already published

* refactor: cleanup

* fixed: some typescript error

* chore: got typedoc working on @kksh/api

* ci: disable manifest schema upload CI on push
2024-11-03 13:54:44 -05:00

44 lines
860 B
Markdown

# @kksh/api
![NPM Version](https://img.shields.io/npm/v/%40kksh%2Fapi)
[Kunkun API](https://www.npmjs.com/package/@kksh/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
```bash
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
```