drukscode-v2/docs/extensions/api-reference.md
OpenCode AI e9899d2e6d
Some checks failed
Android CI Build / check (push) Has been cancelled
Android CI Build / package-apks (push) Has been cancelled
Docs Deploy / build (push) Has been cancelled
Module Market Check / Validate modules/ (push) Has been cancelled
Module Market Publish / Generate submissions.json (push) Has been cancelled
Docs Deploy / deploy (push) Has been cancelled
Initial DruksCode V2: fresh fork of web-to-app (f3b488e) with DruksCode identity
- Package rename com.webtoapp -> br.com.drukstech.codeapp
- Product rename WebToApp/web-to-app -> DruksCode/drukscode
- Design system Wta* -> Dkc*
- applicationId br.com.drukstech.codeapp (.play for gplay flavor)
- rootProject.name DruksCode
- Fresh git history (upstream kept as remote for sync)
2026-09-12 02:42:02 +02:00

53 lines
2.3 KiB
Markdown

# API Reference
A consolidated reference for the extension APIs. Status legend:
- ✅ **Functional** — works as expected.
- 🟡 **Partial** — works with caveats (see notes).
- ⬜ **Stub** — present but returns defaults / no-op.
## Userscript `GM_*`
| API | Status | Notes |
| --- | --- | --- |
| `GM_getValue` / `GM_setValue` / `GM_deleteValue` / `GM_listValues` | ✅ | SharedPreferences-backed, per-script namespace |
| `GM_xmlhttpRequest` | ✅ | Via OkHttp; full callback set |
| `GM_addStyle` | ✅ | |
| `GM_setClipboard` | ✅ | |
| `GM_openInTab` | ✅ | |
| `GM_log` | ✅ | |
| `GM_getResourceText` / `GM_getResourceURL` | ✅ | |
| `GM_registerMenuCommand` / `GM_unregisterMenuCommand` | ✅ | Floating-window menu |
| `GM_openScriptWindow` / `GM_updateScriptWindow` / `GM_closeScriptWindow` | ✅ | DruksCode-specific |
| `GM_info` | ✅ | |
| `unsafeWindow` | ✅ | Equals `window` (no sandbox) |
| `GM_notification` | 🟡 | Logs only; no system notification |
| `@grant` gating | ⬜ | All APIs exposed regardless of declared grants |
| `GM.*` (Promise) | ✅ | Mirrors all of the above |
## Chrome `chrome.*`
| Namespace | Status | Notes |
| --- | --- | --- |
| `runtime` | ✅ | Messaging, lifecycle, `getURL`, `getManifest` |
| `storage` | ✅ | `local`/`sync`/`session`; `managed` no-op |
| `tabs` | ✅ | Core CRUD + events |
| `scripting` | ✅ | Dynamic content script registration |
| `cookies` | ✅ | |
| `alarms` | ✅ | |
| `declarativeNetRequest` | ✅ | block/allow/redirect/modifyHeaders/upgradeScheme |
| `downloads` | 🟡 | `download` functional |
| `webRequest` | 🟡 | `onBeforeRequest` filtering via native bridge |
| `i18n` / `notifications` / `permissions` / `contextMenus` / `commands` | ✅ | |
| `webNavigation` / `extension` / `idle` / `tabGroups` | 🟡 | |
| `action` / `sidePanel` | 🟡 | |
| `windows` / `management` / `topSites` / `fontSettings` | ⬜ | Stubs |
| `identity` / `history` / `proxy` / `privacy` | ⬜ | Stubs |
| `system.cpu/memory/display/storage` | ⬜ | Stubs |
| `bookmarks` / `offscreen` / `tts` | ⬜ | Stubs |
| `browserAction` / `pageAction` (MV2) | 🟡 | Compatibility aliases |
::: tip This table is a living document
The functional/stub status is being verified API-by-API. When in doubt, test against the current build.
:::