@monad-inc/embed 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to `@monad-inc/embed` will be documented in this
+file. The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-05-26
+
+### Added
+
+- Initial release of the `@monad-inc/embed/connect` host SDK
+  (`createConnectorFrame`) for embedding Monad's connector-config UI as a
+  secure cross-origin iframe.
+- Lifecycle helpers: `buildDevNullPipeline`, `findIntegrationPipeline`,
+  `setIntegrationEnabled`, `disableIntegration`, `enableIntegration`,
+  `deleteIntegration`.
+- Cleanup policy presets: `CLEANUP_FULL`, `CLEANUP_KEEP_OUTPUT`,
+  `CLEANUP_PIPELINE_ONLY`.
+- Postmessage protocol exports: `PROTOCOL_SOURCE`, `PROTOCOL_VERSION`,
+  `FrameMessage`, `HostMessage`, `InitMessage`.
+- ESM + CJS dual build with TypeScript declarations.

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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,5 @@
+Monad Embed
+Copyright 2026 Monad Inc.
+
+This product includes software developed at Monad Inc.
+(https://www.monad.com/).

package/README.md

@@ -0,0 +1,160 @@
+# @monad-inc/embed
+
+Tools for embedding Monad's UI in your own app via a secure cross-origin
+iframe. Functionality is exposed through subpath modules; the **connect**
+module — imported from `@monad-inc/embed/connect` — is the host-side SDK
+for Monad's connector-config UI.
+
+The customer's page calls `createConnectorFrame()`; the form and every
+secret typed into it run inside a Monad-hosted iframe, so the host's
+JavaScript never sees credential material — only a connector id reference
+comes back. The isolation model is analogous to Stripe Elements and Plaid
+Link.
+
+The connect module also ships a small lifecycle harness — isomorphic
+helpers for the host's backend to build, enable, disable, and delete a
+connector's pipeline against Monad's REST API.
+
+Zero runtime dependencies.
+
+## Installation
+
+```sh
+npm install @monad-inc/embed
+```
+
+The connect SDK is imported from the `@monad-inc/embed/connect` subpath
+(see below).
+
+## Quick start
+
+The session token travels in a `postMessage` after a `ready` handshake,
+never in the iframe URL, so it stays out of browser history and the
+`Referer` header. Mint it from the host's backend (`POST
+/v1/embed/sessions` with the long-lived API key) and hand it to the
+browser as `sessionToken`:
+
+```ts
+import { createConnectorFrame } from '@monad-inc/embed/connect';
+
+const frame = createConnectorFrame({
+	container: '#connector-modal-body',
+	frameOrigin: 'https://embed.monad.com', // a Monad-controlled origin
+	apiBase: 'https://api.monad.com',
+	organizationId: 'org_abc123',
+	typeId: 'aws-cloudtrail',
+	kind: 'input',
+	sessionToken,
+	appearance: { colorPrimary: '#007dc1' },
+	onSave: ({ id }) => {
+		/* connector created — id is safe to keep */
+	},
+	onCancel: () => frame.destroy(),
+	onError: (msg) => showError(msg)
+});
+```
+
+## API reference
+
+### Iframe embedder
+
+- `createConnectorFrame(options: ConnectorFrameOptions): ConnectorFrame`
+  — mounts the iframe inside `options.container` and returns a handle
+  with `destroy()`.
+- Types: `ConnectorFrameOptions`, `ConnectorFrame`, `Appearance`,
+  `ComponentKind`.
+- Protocol exports: `PROTOCOL_SOURCE`, `PROTOCOL_VERSION`,
+  `FrameMessage`, `HostMessage`, `InitMessage`.
+
+### Lifecycle harness
+
+Each helper takes a `MonadRequest` thunk the host implements once,
+wrapping its API key and base URL:
+
+```ts
+import {
+	buildDevNullPipeline,
+	findIntegrationPipeline,
+	disableIntegration,
+	enableIntegration,
+	deleteIntegration,
+	CLEANUP_FULL,
+	type MonadRequest
+} from '@monad-inc/embed/connect';
+
+const request: MonadRequest = (path, init) =>
+	fetch(`${API_BASE}${path}`, {
+		...init,
+		headers: {
+			Authorization: `ApiKey ${apiKey}`,
+			'Content-Type': 'application/json',
+			...init?.headers
+		}
+	}).then(async (r) => {
+		if (!r.ok) throw new Error(await r.text());
+		const text = await r.text();
+		return text ? JSON.parse(text) : undefined;
+	});
+
+const built = await buildDevNullPipeline({ request, org, inputId, inputName });
+const resolved = await findIntegrationPipeline({ request, org, inputId });
+
+await disableIntegration({ request, org, pipelineId: resolved.pipelineId });
+await enableIntegration({ request, org, pipelineId: resolved.pipelineId });
+await deleteIntegration({
+	request,
+	org,
+	pipelineId: resolved.pipelineId,
+	inputId,
+	outputId: resolved.outputId,
+	cleanup: CLEANUP_FULL
+});
+```
+
+Exports: `buildDevNullPipeline`, `findIntegrationPipeline`,
+`setIntegrationEnabled`, `disableIntegration`, `enableIntegration`,
+`deleteIntegration`. Cleanup presets: `CLEANUP_FULL`,
+`CLEANUP_KEEP_OUTPUT`, `CLEANUP_PIPELINE_ONLY`. Types: `MonadRequest`,
+`ResolvedIntegration`, `CleanupPolicy`, `BuiltPipeline`, and the
+per-helper option types.
+
+#### Cleanup policies
+
+| Policy                  | Pipeline | Input  | Output |
+| ----------------------- | -------- | ------ | ------ |
+| `CLEANUP_FULL`          | delete   | delete | delete |
+| `CLEANUP_KEEP_OUTPUT`   | delete   | delete | keep   |
+| `CLEANUP_PIPELINE_ONLY` | delete   | keep   | keep   |
+
+Or pass your own `{ pipeline?, input?, output? }`. A flag left
+undefined defaults to delete.
+
+## Theming
+
+The iframe accepts an `appearance` object of design tokens (e.g.
+`colorPrimary`, `colorBackground`, `borderRadius`) that the embedded
+form applies to its own styles. For deeper customization, pass
+`stylesheets: [url, …]`; the iframe loads them in order. The list is
+all-or-nothing — providing any URL replaces Monad's default stylesheet
+rather than layering on top of it, so include the full token set you
+want.
+
+## Browser support
+
+Modern evergreen browsers (Chrome, Edge, Firefox, Safari). The package
+ships both ESM and CJS builds plus `.d.ts` types. `createConnectorFrame`
+is browser-only — it injects an `<iframe>` and uses `postMessage`.
+The lifecycle helpers are isomorphic and run wherever the host holds
+its API key (almost always its backend). Importing the package in
+Node is safe; the browser code only touches `window`/`document` when
+`createConnectorFrame` is called.
+
+## Versioning
+
+`0.x` is pre-stable. Minor releases may include breaking API changes.
+The package will move to `1.0.0` once the API is committed to long-term
+compatibility. See `CHANGELOG.md` for release notes.
+
+## License
+
+Apache-2.0 © Monad Inc. See `LICENSE` and `NOTICE`.

package/USAGE.md

@@ -0,0 +1,173 @@
+# Using `@monad-inc/embed/connect`
+
+Host-side SDK for embedding Monad's connector-config UI into your own
+product. The form runs inside a Monad-hosted iframe — every secret a
+user types (AWS keys, OAuth tokens, etc.) stays on Monad's origin and
+is never visible to your application's JavaScript. Same isolation
+model as Stripe Elements and Plaid Link.
+
+---
+
+## Install
+
+```bash
+npm install @monad-inc/embed
+```
+
+ESM and CJS builds ship side-by-side, with full TypeScript types.
+Zero runtime dependencies.
+
+---
+
+## How it works
+
+Two pieces of code: a **session-mint endpoint on your backend** mints
+a short-lived, team-scoped token from your long-lived Monad API key,
+and a **`createConnectorFrame()` call on your frontend** mounts the
+iframe using that token. Both shown below.
+
+---
+
+## Step 1 — Mint a session token from your backend
+
+Your backend exchanges its long-lived Monad API key for a short-lived,
+team-scoped session token, then hands that token to your frontend.
+
+Example (any HTTP framework — shown here as a Next.js Route Handler):
+
+```ts
+// app/api/monad/session/route.ts
+export async function POST(req: Request) {
+	const { teamId } = await req.json(); // your tenant → Monad team mapping
+
+	const r = await fetch('https://app.monad.com/api/v3/sessions', {
+		method: 'POST',
+		headers: {
+			'Content-Type': 'application/json',
+			Authorization: `ApiKey ${process.env.MONAD_API_KEY}`
+		},
+		body: JSON.stringify({
+			organization_id: teamId,
+			ttl_seconds: 1800
+		})
+	});
+	const { session_token, expires_at } = await r.json();
+	return Response.json({ session_token, expires_at, organizationId: teamId });
+}
+```
+
+Returns:
+
+```json
+{
+	"session_token": "eyJhbGc…",
+	"expires_at": "2026-05-26T18:30:00Z",
+	"organizationId": "7f93b302-fdb8-40e9-83c5-f9e555b91477"
+}
+```
+
+The `session_token` is what your frontend hands to `createConnectorFrame`.
+**Never put your long-lived `MONAD_API_KEY` in browser code.**
+
+---
+
+## Step 2 — Mount the iframe on your frontend
+
+```ts
+import { createConnectorFrame } from '@monad-inc/embed/connect';
+
+// Fetch a fresh session from your own backend.
+const { session_token, organizationId } = await fetch('/api/monad/session', {
+	method: 'POST',
+	body: JSON.stringify({ teamId: currentUser.teamId })
+}).then((r) => r.json());
+
+const frame = createConnectorFrame({
+	container: '#monad-connector-mount',
+	sessionToken: session_token,
+	organizationId,
+	kind: 'input', // 'input' or 'output'
+	typeId: 'aws-cloudtrail', // see the connector catalog
+	onSave: ({ id }) => {
+		console.log('connector created', id);
+		frame.destroy();
+	},
+	onCancel: () => frame.destroy()
+});
+```
+
+That's it. The form renders inside the iframe; the user fills it in
+and clicks Save; you get a connector `id` back. The iframe handles
+its own Save / Test connection / Cancel buttons — your page only
+controls the surrounding chrome.
+
+---
+
+## `createConnectorFrame` options
+
+| Option           | Type                         | Required | Default                       | Description                                                                          |
+| ---------------- | ---------------------------- | -------- | ----------------------------- | ------------------------------------------------------------------------------------ |
+| `container`      | `HTMLElement \| string`      | ✅       | —                             | Element (or CSS selector) the iframe is appended to.                                 |
+| `sessionToken`   | `string`                     | ✅       | —                             | Short-lived token from `POST /v3/sessions` (your backend mints this).                |
+| `organizationId` | `string`                     | ✅       | —                             | Monad team org id the session is scoped to. Same value you passed to `/v3/sessions`. |
+| `kind`           | `'input' \| 'output'`        | ✅       | —                             | Which catalog the connector belongs to.                                              |
+| `typeId`         | `string`                     | ✅       | —                             | Connector type slug, e.g. `'aws-cloudtrail'`, `'okta-systemlog'`.                    |
+| `existingId`     | `string`                     | ⛔       | —                             | Pass to edit an existing connector. Omit to create a new one.                        |
+| `displayName`    | `string`                     | ⛔       | the connector type's name     | Title shown in the iframe header.                                                    |
+| `appearance`     | `Appearance`                 | ⛔       | Monad defaults                | Theming tokens (see below).                                                          |
+| `synthetic`      | `boolean`                    | ⛔       | `false`                       | Exposes Monad's internal synthetic-data toggle. Keep off in production.              |
+| `frameOrigin`    | `string`                     | ⛔       | `https://app.monad.com/embed` | Override only for non-prod testing.                                                  |
+| `apiBase`        | `string`                     | ⛔       | `https://app.monad.com/api`   | Override only for non-prod testing.                                                  |
+| `onSave`         | `(c: { id, name? }) => void` | ⛔       | —                             | Fired when the user saves successfully.                                              |
+| `onCancel`       | `() => void`                 | ⛔       | —                             | Fired when the user cancels.                                                         |
+| `onError`        | `(message: string) => void`  | ⛔       | —                             | Fired on a save / test / load failure.                                               |
+
+Returns a handle:
+
+```ts
+const frame = createConnectorFrame({ ... });
+frame.destroy();   // remove the iframe + listeners
+```
+
+---
+
+## Theming with `appearance`
+
+Six tokens, applied as CSS custom properties inside the iframe.
+
+```ts
+createConnectorFrame({
+  ...,
+  appearance: {
+    colorPrimary:    '#10b981',   // primary buttons, focus rings
+    colorText:       '#0d1b2a',   // body text + derived muted/faint shades
+    colorBackground: '#ffffff',
+    colorBorder:     '#d4d9e0',
+    fontFamily:      "'Inter', system-ui, sans-serif",
+    borderRadius:    '8px',
+  },
+});
+```
+
+These are the only theming knobs. The iframe runs cross-origin, so
+your stylesheets cannot bleed in — by design. If you need more
+control than these six tokens give, file an issue.
+
+---
+
+## Security model
+
+- **Cross-origin iframe.** The form runs on `app.monad.com`, not
+  on your domain. Browser same-origin policy means your JavaScript
+  cannot read the iframe's DOM or any value the user types.
+- **Session tokens are short-lived.** Default 30 min, scoped to a
+  single team. Compromise of a session token is bounded; compromise
+  of the long-lived API key is not — keep it on your backend.
+- **postMessage with strict origin checks.** Every message between
+  your page and the iframe is validated against the expected origin
+  in both directions.
+- **`SameSite=Lax` cookies.** Any cookies you set on your own domain
+  do not travel into the Monad iframe regardless of origin sharing.
+- **No host JavaScript in the iframe.** You cannot inject script or
+  CSS; the only customization channel is the six `appearance`
+  tokens.