@onaio/akuko-embed-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ona
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,204 @@
+# @onaio/akuko-embed-sdk
+
+Framework-agnostic SDK for embedding [Akuko](https://akuko.io) dashboards and
+storytelling content into any web page. It mounts a sandboxed `<iframe>` and
+talks to it over a versioned `postMessage` bridge — themes, filters, visibility,
+member re-sync, and lifecycle events all flow through one small, typed API.
+
+- **Zero runtime dependencies.** Ships as ESM + UMD with TypeScript types.
+- **Framework-agnostic.** Use it from vanilla JS, or via the React wrapper
+  [`@onaio/akuko-embed-react`](https://www.npmjs.com/package/@onaio/akuko-embed-react).
+- **Auth-aware.** Public dashboards embed with no login; private/federated
+  dashboards use redirect-based Keycloak brokering (Path D), so they keep
+  working even when third-party cookies are blocked.
+
+## Install
+
+```bash
+pnpm add @onaio/akuko-embed-sdk
+# or: npm install @onaio/akuko-embed-sdk
+# or: yarn add @onaio/akuko-embed-sdk
+```
+
+## Quick start (vanilla)
+
+```html
+<div id="mount"></div>
+<script type="module">
+  import { AkukoDashboard } from "@onaio/akuko-embed-sdk";
+
+  const dashboard = new AkukoDashboard({
+    container: "#mount",
+    dashboardId: "your-dashboard-id",
+    baseUrl: "https://akuko.io",
+  });
+
+  dashboard.on("akuko:ready", () => console.log("dashboard ready"));
+  // …later: dashboard.destroy();
+</script>
+```
+
+`container` accepts a CSS selector string or an `HTMLElement`. The constructor
+throws if the container can't be found.
+
+## Entry modes
+
+Pass **exactly one** of these mutually-exclusive entry props (the constructor
+throws `must pass exactly one of …` otherwise):
+
+| Prop | Loads | Use when |
+|------|-------|----------|
+| `dashboardId` | a single published dashboard (post) | you have a specific dashboard/post id |
+| `spaceUuid` | a whole Akuko space | you want the full space surface |
+| `onadataOrgId` | resolves an OnaData org → its linked space, brokered | embedding from an OnaData-authenticated host |
+| `onadataProjectId` | resolves an OnaData project → its linked folder, brokered | per-project analytics in an OnaData host |
+| `onadataFormId` | resolves a single OnaData form → its generated dashboard, brokered | embedding one form's auto-generated dashboard |
+| `linkProjectsOrgId` | the standalone "link projects" picker surface | rendering the admin link-projects modal |
+
+The `onadata*` and `linkProjects*` modes run Akuko's brokered OIDC login
+*inside* the iframe (same-origin), call `/v1/embed/resolve`, then redirect
+themselves to the resolved space/onboarding and emit
+[`akuko:resolved`](#events) back over the bridge. The host never makes a
+cross-origin API call.
+
+When the host knows the owning org (and, for a form, its project) but the current
+user hasn't completed a personal OnaData grant, pass `resolveOnadataOrgId` (and
+`resolveOnadataProjectId` for a form) alongside the entry prop. These are
+**companions**, not entry props — they let akuko resolve role-appropriate content
+for every authenticated org user, not just the admin who provisioned analytics.
+
+## Options
+
+All options are passed to the `AkukoDashboard` constructor (`AkukoSDKOptions`):
+
+| Option | Type | Default | Notes |
+|--------|------|---------|-------|
+| `container` | `string \| HTMLElement` | — | **Required.** Mount point. |
+| `dashboardId` | `string` | — | Entry mode (see above). |
+| `spaceUuid` | `string` | — | Entry mode. |
+| `onadataOrgId` | `string` | — | Entry mode. |
+| `onadataProjectId` | `string` | — | Entry mode. |
+| `onadataFormId` | `string` | — | Entry mode — a single OnaData form's generated dashboard. |
+| `linkProjectsOrgId` | `string` | — | Entry mode (org slug). |
+| `resolveOnadataOrgId` | `string` | — | Grant-independent **companion** (not an entry prop): owning org slug, so akuko can derive the embed's state without the caller's personal OnaData grant. Pairs with `onadataProjectId` / `onadataFormId`. Does not count toward "exactly one entry prop". |
+| `resolveOnadataProjectId` | `string` | — | Companion: the form's project id. Pairs with `onadataFormId`. |
+| `baseUrl` | `string` | `https://akuko.io` | Origin serving the embed `/embed/*` routes. |
+| `apiBaseUrl` | `string` | — | Accepted for back/forward-compat but **no longer used** — resolve/resync run inside the iframe. Safe to keep passing. |
+| `idpHint` | `string` | — | Keycloak `kc_idp_hint` alias for silent federation (see [SSO](#sso-federated-login)). |
+| `initialPostId` | `string` | — | Post/dashboard to open on mount, overriding the configured default. For host deep-linking/sharing (forwarded as `?post=`). |
+| `theme` | `AkukoTheme` | — | Initial theme (see below). |
+| `visibility` | `AkukoVisibility` | — | Initial chrome visibility. |
+| `filters` | `Record<string, unknown>` | — | Initial filter values. |
+| `hostIsAdmin` | `boolean` | — | Hint that the current user can administer the embedded org/project; gates the in-iframe onboarding consent for an unlinked org. UX-only — the backend re-verifies ownership at provisioning. |
+| `hostUser` | `{ email: string }` | — | The host's current signed-in OnaData user; lets the embed detect a host user-switch and tear down a stale session. Untrusted — only forces a re-auth on mismatch. |
+| `allowedOrigin` | `string` | origin of `baseUrl` | Origin the bridge accepts messages from. |
+| `sandbox` | `string` | `allow-scripts allow-same-origin allow-popups allow-forms allow-downloads` | iframe `sandbox` attribute. The iframe is also granted `fullscreen; clipboard-write` via the `allow` attribute (so the embed can enter OS fullscreen and the in-embed Share can copy the post URL). |
+| `layout` | `"content" \| "fill"` | `content` | `content` auto-resizes to the embed height; `fill` makes the embed fill a host-sized container (host owns height). |
+| `minHeight` | `number \| string` | — | `content` layout only: a minimum height floor (px number or CSS length) so a short/empty dashboard still fills down to the host footer. Ignored in `fill`. |
+| `iframeLoadTimeoutMs` | `number` | `30000` | Watchdog before `akuko:error{code:'IFRAME_LOAD_FAILED'}`. `0` disables; `<5000` not recommended. |
+| `logoutTimeoutMs` | `number` | `2000` | How long `logout()` waits for `akuko:logoutComplete` before resolving anyway. |
+
+### `AkukoTheme`
+
+`primary`, `background`, `foreground`, `card`, `border`, `radius`,
+`fontFamily`, `darkMode` (`boolean`), and `chart1`–`chart5`. All optional.
+
+### `AkukoVisibility`
+
+Booleans to show/hide chrome: `header`, `breadcrumbs`, `footer`, `undoRedo`,
+`chartActions`, `filterBar`.
+
+## Methods
+
+```ts
+const d = new AkukoDashboard({ /* … */ });
+```
+
+| Method | Description |
+|--------|-------------|
+| `setTheme(theme)` | Apply an `AkukoTheme`. Cached and re-applied on every `akuko:ready`. |
+| `setVisibility(v)` | Show/hide chrome. Cached and replayed on ready. |
+| `setViewport(viewport)` | Report the iframe's currently-visible vertical band (`{ top, height }`) so in-iframe floating UI can center itself under `content` layout. The React wrapper does this automatically. Cached and replayed. |
+| `setFilters(filters)` | Push filter values into the dashboard. Cached and replayed. |
+| `clearFilters(keys?)` | Clear specific filter keys, or all filters when called with no args. |
+| `refresh()` | Ask the dashboard to reload its data. |
+| `getState()` | Request current state; response arrives via `akuko:stateResponse`. |
+| `resyncMembers(opts)` | Re-sync OnaData members into the linked space/folder. `opts.scope` is `"org"` or `"project"`. Progress via `akuko:provisioningStatus`. |
+| `linkProjects()` | Navigate the iframe to the org's project-picker. Throws unless constructed with `onadataOrgId`. |
+| `logout()` | Tear down the in-iframe Akuko session (RP-initiated end-session). Resolves on `akuko:logoutComplete` or after `logoutTimeoutMs`. Never rejects, never hangs. |
+| `destroy()` | Remove the iframe and tear down the bridge. |
+
+State pushed via `setTheme` / `setVisibility` / `setFilters` / `setViewport`
+(and the `hostUser` identity) is replayed automatically on each `akuko:ready`, so
+it survives the iframe's full-document replacements during brokered OIDC + SPA
+navigation.
+
+## Events
+
+Subscribe with `on(type, handler)` and unsubscribe with `off(type, handler)`:
+
+```ts
+const onResize = (p) => console.log("height", p.height);
+d.on("akuko:resize", onResize);
+d.off("akuko:resize", onResize);
+```
+
+The `AkukoEventType` union:
+
+| Event | Fires when |
+|-------|------------|
+| `akuko:ready` | a surface inside the iframe has mounted and is ready. |
+| `akuko:resolved` | brokered resolve completed; payload is `ResolveResponse` (`linked` / `unlinked` / `provisioning` / `reauth_required`). |
+| `akuko:resize` | content height changed (`{ height }`); ignored in `fill` layout. |
+| `akuko:filterChange` | the user changed a filter inside the dashboard. |
+| `akuko:cellClick` | a chart/table cell was clicked. |
+| `akuko:dashboardChange` | the active dashboard changed. |
+| `akuko:provisioningStatus` | JIT member-sync progress. |
+| `akuko:stateResponse` | response to `getState()`. |
+| `akuko:linkProjects` / `akuko:linkProjectsDone` | link-projects surface opened / finished. |
+| `akuko:navigate` | the embed asks the host to navigate to a project's analytics page (payload `{ scope, onadataProjectId, ownerUsername? }`). |
+| `akuko:share` | the embed asks the host to copy a shareable post URL (payload `{ postId, scope, url? }`); the embed also copies it itself, so handling is optional. |
+| `akuko:logout` / `akuko:logoutComplete` | logout requested / acknowledged. |
+| `akuko:error` | an error occurred (e.g. `{ code: 'IFRAME_LOAD_FAILED' }`). |
+| `akuko:close` | the embed asked the host to close it (e.g. a modal surface). |
+
+The bridge only accepts messages from `allowedOrigin` (default: the origin of
+`baseUrl`) and scopes them to *this* iframe, so multiple embeds on one page
+don't cross-talk.
+
+## SSO (federated login)
+
+For private or federated dashboards, Akuko authenticates users via Keycloak
+**identity brokering (Path D)** — a redirect-based OIDC flow, so it works
+cross-domain and survives third-party-cookie blocking. Your host passes the
+brokered IdP alias as `idpHint`; first-time users go straight from your app →
+Akuko iframe → your IdP → back → dashboard, with no broker-selection UI.
+
+See [`./docs/sso-path-d-brokering.md`](./docs/sso-path-d-brokering.md) for the
+full setup, and [`./examples/keycloak-path-d-setup.sh`](./examples/keycloak-path-d-setup.sh)
+for a sanitized `kcadm.sh` reference.
+
+## Host recipes
+
+Concrete WordPress and Directus integration recipes live in
+[`./docs/host-recipes.md`](./docs/host-recipes.md).
+
+## Testing with canary builds
+
+Branch builds are published under the `canary` dist-tag so you can test an
+unreleased change in a consumer before it ships:
+
+```bash
+pnpm add @onaio/akuko-embed-sdk@canary
+```
+
+## Browser support
+
+Modern evergreen browsers. Note that browsers with third-party-cookie blocking
+(Safari ITP, Firefox ETP) restrict cross-site cookies — but Akuko's federated
+login (Path D) is **redirect-based**, not cookie-shared, so embedded private
+dashboards keep working under those restrictions.
+
+## License
+
+Apache-2.0

package/dist/AkukoDashboard.d.ts

@@ -0,0 +1,116 @@
+import type { AkukoSDKOptions, AkukoTheme, AkukoViewport, AkukoVisibility } from "./types";
+import type { AkukoEventType } from "./PostMessageBridge";
+export type ResyncMembersOpts = {
+    scope: "org";
+    /**
+     * Optional escape-hatch fields for hosts that need to override the
+     * server's session-derived account context. Standard zonkey-style
+     * hosts call `resyncMembers({scope: 'org'})` and let akuko-api derive
+     * account_id/space_id/onadata_org_slug from the authenticated user's
+     * cookie. See docs/plans/2026-05-26-zonkey-embed-ui-design.md §3.5.
+     */
+    account_id?: string;
+    space_id?: string;
+    onadata_org_slug?: string;
+    onadata_api_token?: string;
+} | {
+    scope: "project";
+    /**
+     * Optional escape-hatch fields. Standard hosts call
+     * `resyncMembers({scope: 'project'})` against an SDK constructed with
+     * `onadataProjectId` and let akuko-api derive account_id/space_id/
+     * folder_id from the authenticated user's cookie. See
+     * docs/plans/2026-05-26-zonkey-embed-ui-design.md §3.5.
+     */
+    account_id?: string;
+    space_id?: string;
+    folder_id?: string;
+    onadata_project_id?: number;
+    onadata_api_token?: string;
+};
+export declare class AkukoDashboard {
+    private opts;
+    private iframe;
+    private container;
+    private baseUrl;
+    private bridge;
+    private localListeners;
+    private loadWatchdog;
+    private lastTheme?;
+    private lastVisibility?;
+    private lastViewport?;
+    private lastFilters?;
+    private lastHostUser?;
+    constructor(opts: AkukoSDKOptions);
+    private startLoadWatchdog;
+    private createIframe;
+    private computeInitialUrl;
+    private queryString;
+    on(type: AkukoEventType, handler: (p: unknown) => void): void;
+    off(type: AkukoEventType, handler: (p: unknown) => void): void;
+    /**
+     * Dispatch an event originated host-side (e.g. the iframe load watchdog) to
+     * any subscribers registered via on(). The bridge is unaffected — its
+     * handlers only fire on iframe → host messages. Note: akuko:resolved now
+     * arrives from the iframe over the bridge (the iframe owns resolve), so
+     * on('akuko:resolved') keeps working without a host-side emit.
+     */
+    private emitLocal;
+    private replayState;
+    /** Apply a theme to the embedded dashboard. */
+    setTheme(theme: AkukoTheme): void;
+    /** Show or hide dashboard UI chrome (header, footer, filter bar, etc.). */
+    setVisibility(v: AkukoVisibility): void;
+    /**
+     * Report the iframe's currently-visible vertical band (host→iframe), so
+     * in-iframe floating UI can center itself in view even when the host page owns
+     * the scrollbar (`layout: "content"`). The React wrapper computes and pushes
+     * this automatically on scroll/resize; hosts using the vanilla SDK can call it
+     * directly.
+     */
+    setViewport(viewport: AkukoViewport): void;
+    /** Push filter values into the embedded dashboard. */
+    setFilters(filters: Record<string, unknown>): void;
+    /**
+     * Clear specific filter keys, or all filters when called with no arguments.
+     * @param keys - Optional list of filter keys to clear. Omit to clear all.
+     */
+    clearFilters(keys?: string[]): void;
+    /** Ask the embedded dashboard to reload its data. */
+    refresh(): void;
+    /**
+     * Navigate the iframe to the org's onboarding / project-picker URL so
+     * an admin can link more projects to an already-linked org. Throws when
+     * the SDK was constructed without `onadataOrgId` — the call has no
+     * unambiguous org context to act on.
+     */
+    linkProjects(): void;
+    /**
+     * Request the current state of the embedded dashboard.
+     * The response arrives via the `akuko:stateResponse` event on the bridge.
+     */
+    getState(): void;
+    /**
+     * Trigger a background re-sync of Onadata members into the linked Akuko
+     * space or folder.
+     *
+     * The backend derives `account_id`/`space_id`/`onadata_org_slug` (and
+     * `folder_id` for project scope) from the authenticated user's session
+     * when those fields aren't passed explicitly. Hosts that need to override
+     * the derivation may supply them on `opts`. Progress events arrive via
+     * `akuko:provisioningStatus` on the bridge.
+     */
+    resyncMembers(opts: ResyncMembersOpts): Promise<{
+        workflow_id: string;
+    }>;
+    /**
+     * Tear down the embedded akuko session: asks the in-iframe akuko app to run
+     * an RP-initiated end-session (clears akuko.io localStorage tokens AND ends
+     * the akuko-keycloak SSO session), then resolves on the iframe's
+     * `akuko:logoutComplete` acknowledgement — or after `logoutTimeoutMs`
+     * (default 2000ms), whichever comes first. Never rejects; never hangs, so a
+     * host can `await dashboard.logout()` in its own logout path safely.
+     */
+    logout(): Promise<void>;
+    destroy(): void;
+}

package/dist/PostMessageBridge.d.ts

@@ -0,0 +1,18 @@
+export type AkukoEventType = "akuko:ready" | "akuko:filterChange" | "akuko:cellClick" | "akuko:resize" | "akuko:error" | "akuko:stateResponse" | "akuko:dashboardChange" | "akuko:provisioningStatus" | "akuko:resolved" | "akuko:linkProjects" | "akuko:linkProjectsDone" | "akuko:logout" | "akuko:logoutComplete" | "akuko:navigate" | "akuko:share" | "akuko:viewport" | "akuko:close";
+export interface AkukoMessage<T = unknown> {
+    type: string;
+    payload: T;
+    messageId: string;
+    version: 1;
+}
+export declare class PostMessageBridge {
+    private iframe;
+    private expectedOrigin;
+    private handlers;
+    constructor(iframe: HTMLIFrameElement, expectedOrigin: string);
+    private onMessage;
+    on(type: AkukoEventType, handler: (p: unknown) => void): void;
+    off(type: AkukoEventType, handler: (p: unknown) => void): void;
+    send(type: string, payload: unknown): void;
+    destroy(): void;
+}