mirror of
https://github.com/tiddly-gittly/TidGi-Desktop.git
synced 2026-03-09 00:10:31 -07:00
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# TidGi Service API Usage
|
|
|
|
This document explains how TW plugins can call TidGi services and how the API is exposed across front-end and back-end.
|
|
|
|
## Where services are exposed
|
|
|
|
TidGi exposes the same service proxies in two places:
|
|
|
|
- Plugin runtime (TW sandbox): `$tw.tidgi.service`
|
|
- Frontend runtime (renderer): `window.service`
|
|
|
|
## Usage in plugins (TiddlyWiki modules)
|
|
|
|
TiddlyWiki modules should use `$tw.tidgi.service`. In the BrowserView (renderer) build, it is mounted during boot by a startup module. In the wiki worker build, it is attached before boot.
|
|
|
|
Example:
|
|
|
|
```ts
|
|
import type { ITidGiGlobalService } from 'tidgi-shared';
|
|
|
|
const tidgiService = ($tw as typeof $tw & { tidgi?: { service?: ITidGiGlobalService } }).tidgi?.service;
|
|
```
|
|
|
|
## Usage in renderer / WebView
|
|
|
|
Frontend UI code should keep using `window.service`.
|
|
|
|
```ts
|
|
await window.service.workspace.getActiveWorkspace();
|
|
```
|
|
|
|
## How the API is wired
|
|
|
|
- Service proxies are created in the wiki worker and preload using `electron-ipc-cat`.
|
|
- Renderer (BrowserView): `src/preload/common/exportServices.ts` exposes proxies via `contextBridge` and assigns `window.service`.
|
|
- Renderer (BrowserView): `src/services/wiki/plugin/ipcSyncAdaptor/Startup/mount-tidgi-service.ts` (published as a startup module) mounts `window.service` to `$tw.tidgi.service` during TiddlyWiki boot.
|
|
- Wiki worker: `src/services/wiki/wikiWorker/startNodeJSWiki.ts` attaches the same proxies to `$tw.tidgi.service` before TiddlyWiki boot, so modules can access them inside the worker.
|
|
|
|
## Types for plugins
|
|
|
|
Use `tidgi-shared` for type-safe access. It also augments the global `$tw` shape so editors can resolve `$tw.tidgi.service`:
|
|
|
|
```ts
|
|
import type { IWorkspaceService } from 'tidgi-shared';
|
|
```
|
|
|
|
This package re-exports all service interfaces and IPC descriptors used by TidGi.
|