PSA/docs/client-sdk/usage.md
Hermes 284313f908
Some checks are pending
Bidi Control Character Guard / bidi-control-guard (push) Waiting to run
Circular Dependency Check / Check for new circular dependencies (push) Waiting to run
Citus Migration Smoke / Combined migrations on single-node Citus (push) Waiting to run
E2E Fresh Install Tests / fresh-install-e2e (push) Waiting to run
ext-v2 guardrails / Run ext-v2 guard and ESLint (push) Waiting to run
Integration Tests / Check for relevant changes (push) Waiting to run
Integration Tests / ${{ (github.event_name == 'schedule' || github.event.inputs.suite == 'full') && 'Full integration suite' || 'Tier-1 integration subset' }} (push) Blocked by required conditions
Mobile checks / Mobile lint + typecheck (push) Waiting to run
Mobile checks / Mobile unit tests (push) Waiting to run
Mobile checks / Mobile dependency audit (report) (push) Waiting to run
Mobile checks / Mobile reproducibility checks (push) Waiting to run
Secrets guard (env backups) / Ensure no tracked env backup files (push) Waiting to run
Temporal Readiness / fast-readiness (push) Waiting to run
Temporal Readiness / docker-parity (push) Waiting to run
TypeScript Type Check / Nx affected typecheck (push) Waiting to run
Unit Tests / Skipped-test budget (push) Waiting to run
Unit Tests / Nx affected unit tests (push) Waiting to run
Unit Tests / Server unit coverage (informational) (push) Waiting to run
Validate Tenant Management Schema / Check for relevant changes (push) Waiting to run
Validate Tenant Management Schema / Validate Tenant Management Schema (push) Blocked by required conditions
EE Workflows Build Guard / ee-workflows-build-guard (push) Waiting to run
Initial import of AlgaPSA codebase from PSA server
Excluded: .git, node_modules, secrets/, compose.env, assemblyscript tgz

Source: /opt/alga-psa on psa.joliet.tech
2026-06-22 16:12:17 -05:00

40 lines
1.1 KiB
Markdown

# Usage
## Install (external project)
```bash
npm i @alga/extension-iframe-sdk
# optional if you have the UI kit
npm i @alga/ui-kit
```
## Child (iframe app)
```tsx
import React, { useEffect } from 'react';
import { useBridge, useTheme, useAuthToken, useResize } from '@alga/extension-iframe-sdk';
export default function App() {
const bridge = useBridge();
const theme = useTheme(bridge);
const token = useAuthToken(bridge);
const reportResize = useResize(bridge);
useEffect(() => {
reportResize(document.documentElement.scrollHeight);
}, [theme, token, reportResize]);
return <div>Hello from an Alga extension!</div>;
}
```
## Parent (host)
The host bootstraps the iframe and posts the `bootstrap` message. See `ee/server/src/lib/extensions/ui/iframeBridge.ts` for a reference implementation, including URL building via `buildExtUiSrc()` and origin validation.
Key points:
- Use `sandbox="allow-scripts"` on the iframe
- Enforce `targetOrigin` when posting messages
- Provide short-lived `session.token` and `theme_tokens` in the bootstrap payload