@basedash/embed 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Basedash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,316 @@
+# Basedash embed SDK
+
+Typed server helpers and React components for embedding
+[Basedash](https://www.basedash.com) in your product.
+
+The SDK wraps Basedash's production iframe and JWT SSO flow. Your server signs
+a short-lived token, your frontend fetches it, and the React component renders
+the correct iframe URL and feature configuration.
+
+## Install
+
+```bash
+npm install @basedash/embed
+```
+
+React 18.2 and React 19 are supported.
+
+## Quick start
+
+### 1. Create a token on your server
+
+```ts
+import { createEmbedToken } from "@basedash/embed/server";
+
+export async function GET() {
+  // Get this identity from your authenticated server session.
+  const user = {
+    email: "jane@example.com",
+    firstName: "Jane",
+    lastName: "Doe",
+  };
+
+  const token = await createEmbedToken({
+    secret: process.env.BASEDASH_EMBED_JWT_SECRET!,
+    orgId: process.env.BASEDASH_ORG_ID!,
+    user: {
+      ...user,
+      role: "MEMBER",
+    },
+  });
+
+  return new Response(token, {
+    headers: {
+      "Cache-Control": "no-store",
+      "Content-Type": "text/plain",
+    },
+  });
+}
+```
+
+`createEmbedToken` is exported from the server-only entry point. Never import it
+into browser code or expose your embed secret through a public environment
+variable.
+
+### 2. Render a Basedash component
+
+```tsx
+"use client";
+
+import { BasedashChat, BasedashProvider } from "@basedash/embed/react";
+import { useCallback } from "react";
+
+export function Analytics() {
+  const fetchToken = useCallback(async () => {
+    const response = await fetch("/api/basedash-token");
+    if (!response.ok) {
+      throw new Error("Could not create a Basedash token");
+    }
+    return response.text();
+  }, []);
+
+  return (
+    <BasedashProvider fetchToken={fetchToken} theme="auto">
+      <BasedashChat
+        loadingFallback={<p>Loading analytics…</p>}
+        style={{ height: 720 }}
+      />
+    </BasedashProvider>
+  );
+}
+```
+
+The provider fetches once per mount. Multiple components under the same
+provider reuse the token.
+
+## React components
+
+Import React APIs from `@basedash/embed/react`.
+
+### `BasedashChat`
+
+Embeds chat and hides dashboards, insights, automations, and the organization
+name by default.
+
+```tsx
+<BasedashChat hideSuggestedPrompts />
+```
+
+### `BasedashDashboards`
+
+Embeds the interactive dashboards workspace and hides all other primary
+features.
+
+```tsx
+<BasedashDashboards />
+```
+
+### `BasedashInsights`
+
+Embeds insights and hides all other primary features.
+
+```tsx
+<BasedashInsights />
+```
+
+The organization must have insights enabled.
+
+### `BasedashAutomations`
+
+Embeds automations and hides all other primary features.
+
+```tsx
+<BasedashAutomations />
+```
+
+The organization must have automations enabled.
+
+### `BasedashApp`
+
+Embeds the complete Basedash app. Feature props map to the existing Basedash
+embed configuration.
+
+```tsx
+<BasedashApp
+  hideOrgName
+  hideInsights
+  hideAutomations
+  hideSuggestedPrompts
+/>
+```
+
+At least one of chat, dashboards, insights, or automations must remain visible.
+Basedash falls back to chat if all four are hidden.
+
+### `BasedashSharedDashboard`
+
+Embeds a read-only dashboard from a public sharing link. It does not require a
+provider or a user token.
+
+```tsx
+<BasedashSharedDashboard publicSharingLinkId="abc123" />
+```
+
+To lock dashboard filters, create a server-side filter token and pass it to the
+component:
+
+```ts
+import { createDashboardFilterToken } from "@basedash/embed/server";
+
+const filterToken = await createDashboardFilterToken({
+  secret: process.env.BASEDASH_EMBED_JWT_SECRET!,
+  dashboardLinkId: "abc123",
+  params: {
+    company_id: "company_456",
+    regions: ["us", "ca"],
+  },
+});
+```
+
+```tsx
+<BasedashSharedDashboard
+  publicSharingLinkId="abc123"
+  filterToken={filterToken}
+/>
+```
+
+## Authentication options
+
+Use `fetchToken` when the browser should request the current user's token from
+your backend:
+
+```tsx
+<BasedashProvider fetchToken={fetchToken}>
+  <BasedashApp />
+</BasedashProvider>
+```
+
+If your React tree already receives a server-generated token, pass it directly:
+
+```tsx
+<BasedashProvider token={token}>
+  <BasedashDashboards />
+</BasedashProvider>
+```
+
+You can also pass `token` directly to an authenticated component without a
+provider:
+
+```tsx
+<BasedashChat token={token} />
+```
+
+`useBasedash()` exposes the current `token`, `status`, `error`, and a
+`refreshToken()` method.
+
+## Frame props
+
+All components accept:
+
+- `className` and `style` for the outer container
+- `iframeProps` for the underlying iframe
+- `loadingFallback`, shown until the iframe loads
+- `errorFallback`, shown when provider token fetching fails
+- `title` for the iframe's accessible name
+- `instanceUrl` for self-hosted Basedash
+
+The iframe defaults to full width and height, no border,
+`allow="clipboard-write"`, and eager loading.
+
+```tsx
+<BasedashDashboards
+  className="analytics"
+  style={{ minHeight: 640 }}
+  iframeProps={{
+    allow: "clipboard-write; fullscreen",
+    onLoad: () => console.log("Basedash loaded"),
+  }}
+/>
+```
+
+## Non-React usage
+
+The root entry point has zero framework dependencies and can build iframe URLs
+for any frontend:
+
+```ts
+import { buildEmbedUrl } from "@basedash/embed";
+
+const src = buildEmbedUrl({
+  token,
+  options: {
+    theme: "dark",
+    hideOrgName: true,
+    hideChat: true,
+  },
+});
+```
+
+For public dashboards:
+
+```ts
+import { buildSharedDashboardUrl } from "@basedash/embed";
+
+const src = buildSharedDashboardUrl({
+  publicSharingLinkId: "abc123",
+  filterToken,
+});
+```
+
+These helpers emit every embed option explicitly so changing or remounting an
+embed cannot inherit stale session configuration.
+
+## Self-hosted Basedash
+
+Set `instanceUrl` on the provider or component:
+
+```tsx
+<BasedashProvider
+  fetchToken={fetchToken}
+  instanceUrl="https://analytics.example.com"
+>
+  <BasedashApp />
+</BasedashProvider>
+```
+
+Server token generation is identical for cloud and self-hosted instances.
+
+## Before going to production
+
+1. Enable full app embedding in **Settings → Embedding**.
+2. Store the JWT secret from **Settings → Security** only on your backend.
+3. Configure your production domains under allowed embed origins.
+4. Verify every token request against your own authenticated user and
+   authorization rules.
+5. Connect Basedash with read-only database credentials.
+
+Tokens default to a 10-minute lifetime. Shared dashboard filter tokens default
+to one hour. A valid full-app token is only needed when the iframe establishes
+its Basedash session.
+
+## Current limitations
+
+- The SDK wraps iframes; it does not render Basedash UI natively.
+- Basedash does not yet expose an iframe `postMessage` protocol, so auto-resize,
+  navigation events, and host-triggered actions are not available.
+- Shared dashboard embeds are supported. A standalone shared-chart embed is
+  not currently available from the Basedash app.
+
+## Development
+
+```bash
+pnpm install
+pnpm check
+```
+
+The package ships ESM, CommonJS, and TypeScript declarations for:
+
+- `@basedash/embed`
+- `@basedash/embed/server`
+- `@basedash/embed/react`
+
+See `examples/nextjs` and `examples/vite` for integrations.
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,139 @@
+'use strict';
+
+// src/embed.ts
+var DEFAULT_BASEDASH_URL = "https://charts.basedash.com";
+var EMBED_QUERY_PARAMS = {
+  theme: "theme",
+  hideOrgName: "hide_org_name",
+  hideChat: "hide_chat",
+  hideDashboards: "hide_dashboards",
+  hideInsights: "hide_insights",
+  hideAutomations: "hide_automations",
+  hideSuggestedPrompts: "hide_suggested_prompts"
+};
+var DEFAULT_EMBED_OPTIONS = {
+  theme: "auto",
+  hideOrgName: false,
+  hideChat: false,
+  hideDashboards: false,
+  hideInsights: false,
+  hideAutomations: false,
+  hideSuggestedPrompts: false
+};
+var CHAT_EMBED_OPTIONS = {
+  ...DEFAULT_EMBED_OPTIONS,
+  hideOrgName: true,
+  hideDashboards: true,
+  hideInsights: true,
+  hideAutomations: true
+};
+var DASHBOARDS_EMBED_OPTIONS = {
+  ...DEFAULT_EMBED_OPTIONS,
+  hideOrgName: true,
+  hideChat: true,
+  hideInsights: true,
+  hideAutomations: true
+};
+var INSIGHTS_EMBED_OPTIONS = {
+  ...DEFAULT_EMBED_OPTIONS,
+  hideOrgName: true,
+  hideChat: true,
+  hideDashboards: true,
+  hideAutomations: true
+};
+var AUTOMATIONS_EMBED_OPTIONS = {
+  ...DEFAULT_EMBED_OPTIONS,
+  hideOrgName: true,
+  hideChat: true,
+  hideDashboards: true,
+  hideInsights: true
+};
+function buildEmbedUrl({
+  token,
+  options,
+  instanceUrl = DEFAULT_BASEDASH_URL
+}) {
+  assertNonEmpty(token, "token");
+  const url = createInstanceUrl(instanceUrl, "api/sso/jwt");
+  const resolvedOptions = {
+    theme: options?.theme ?? DEFAULT_EMBED_OPTIONS.theme,
+    hideOrgName: options?.hideOrgName ?? DEFAULT_EMBED_OPTIONS.hideOrgName,
+    hideChat: options?.hideChat ?? DEFAULT_EMBED_OPTIONS.hideChat,
+    hideDashboards: options?.hideDashboards ?? DEFAULT_EMBED_OPTIONS.hideDashboards,
+    hideInsights: options?.hideInsights ?? DEFAULT_EMBED_OPTIONS.hideInsights,
+    hideAutomations: options?.hideAutomations ?? DEFAULT_EMBED_OPTIONS.hideAutomations,
+    hideSuggestedPrompts: options?.hideSuggestedPrompts ?? DEFAULT_EMBED_OPTIONS.hideSuggestedPrompts
+  };
+  url.searchParams.set("jwt", token);
+  url.searchParams.set(EMBED_QUERY_PARAMS.theme, resolvedOptions.theme);
+  url.searchParams.set(
+    EMBED_QUERY_PARAMS.hideOrgName,
+    String(resolvedOptions.hideOrgName)
+  );
+  url.searchParams.set(
+    EMBED_QUERY_PARAMS.hideChat,
+    String(resolvedOptions.hideChat)
+  );
+  url.searchParams.set(
+    EMBED_QUERY_PARAMS.hideDashboards,
+    String(resolvedOptions.hideDashboards)
+  );
+  url.searchParams.set(
+    EMBED_QUERY_PARAMS.hideInsights,
+    String(resolvedOptions.hideInsights)
+  );
+  url.searchParams.set(
+    EMBED_QUERY_PARAMS.hideAutomations,
+    String(resolvedOptions.hideAutomations)
+  );
+  url.searchParams.set(
+    EMBED_QUERY_PARAMS.hideSuggestedPrompts,
+    String(resolvedOptions.hideSuggestedPrompts)
+  );
+  return url.toString();
+}
+function buildSharedDashboardUrl({
+  publicSharingLinkId,
+  filterToken,
+  instanceUrl = DEFAULT_BASEDASH_URL
+}) {
+  assertNonEmpty(publicSharingLinkId, "publicSharingLinkId");
+  const path = filterToken ? `shared/${encodeURIComponent(publicSharingLinkId)}/${encodeURIComponent(
+    filterToken
+  )}` : `shared/${encodeURIComponent(publicSharingLinkId)}`;
+  return createInstanceUrl(instanceUrl, path).toString();
+}
+function createInstanceUrl(instanceUrl, path) {
+  let baseUrl;
+  try {
+    baseUrl = new URL(instanceUrl);
+  } catch {
+    throw new TypeError(`instanceUrl must be a valid URL: ${instanceUrl}`);
+  }
+  if (baseUrl.protocol !== "https:" && baseUrl.protocol !== "http:") {
+    throw new TypeError("instanceUrl must use http or https");
+  }
+  baseUrl.search = "";
+  baseUrl.hash = "";
+  if (!baseUrl.pathname.endsWith("/")) {
+    baseUrl.pathname += "/";
+  }
+  return new URL(path, baseUrl);
+}
+function assertNonEmpty(value, name) {
+  if (value.trim().length === 0) {
+    throw new TypeError(`${name} must not be empty`);
+  }
+}
+
+exports.AUTOMATIONS_EMBED_OPTIONS = AUTOMATIONS_EMBED_OPTIONS;
+exports.CHAT_EMBED_OPTIONS = CHAT_EMBED_OPTIONS;
+exports.DASHBOARDS_EMBED_OPTIONS = DASHBOARDS_EMBED_OPTIONS;
+exports.DEFAULT_BASEDASH_URL = DEFAULT_BASEDASH_URL;
+exports.DEFAULT_EMBED_OPTIONS = DEFAULT_EMBED_OPTIONS;
+exports.EMBED_QUERY_PARAMS = EMBED_QUERY_PARAMS;
+exports.INSIGHTS_EMBED_OPTIONS = INSIGHTS_EMBED_OPTIONS;
+exports.buildEmbedUrl = buildEmbedUrl;
+exports.buildSharedDashboardUrl = buildSharedDashboardUrl;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/embed.ts"],"names":[],"mappings":";;;AAAO,IAAM,oBAAA,GAAuB;AAE7B,IAAM,kBAAA,GAAqB;AAAA,EAChC,KAAA,EAAO,OAAA;AAAA,EACP,WAAA,EAAa,eAAA;AAAA,EACb,QAAA,EAAU,WAAA;AAAA,EACV,cAAA,EAAgB,iBAAA;AAAA,EAChB,YAAA,EAAc,eAAA;AAAA,EACd,eAAA,EAAiB,kBAAA;AAAA,EACjB,oBAAA,EAAsB;AACxB;AAqDO,IAAM,qBAAA,GAAwB;AAAA,EACnC,KAAA,EAAO,MAAA;AAAA,EACP,WAAA,EAAa,KAAA;AAAA,EACb,QAAA,EAAU,KAAA;AAAA,EACV,cAAA,EAAgB,KAAA;AAAA,EAChB,YAAA,EAAc,KAAA;AAAA,EACd,eAAA,EAAiB,KAAA;AAAA,EACjB,oBAAA,EAAsB;AACxB;AAEO,IAAM,kBAAA,GAAqB;AAAA,EAChC,GAAG,qBAAA;AAAA,EACH,WAAA,EAAa,IAAA;AAAA,EACb,cAAA,EAAgB,IAAA;AAAA,EAChB,YAAA,EAAc,IAAA;AAAA,EACd,eAAA,EAAiB;AACnB;AAEO,IAAM,wBAAA,GAA2B;AAAA,EACtC,GAAG,qBAAA;AAAA,EACH,WAAA,EAAa,IAAA;AAAA,EACb,QAAA,EAAU,IAAA;AAAA,EACV,YAAA,EAAc,IAAA;AAAA,EACd,eAAA,EAAiB;AACnB;AAEO,IAAM,sBAAA,GAAyB;AAAA,EACpC,GAAG,qBAAA;AAAA,EACH,WAAA,EAAa,IAAA;AAAA,EACb,QAAA,EAAU,IAAA;AAAA,EACV,cAAA,EAAgB,IAAA;AAAA,EAChB,eAAA,EAAiB;AACnB;AAEO,IAAM,yBAAA,GAA4B;AAAA,EACvC,GAAG,qBAAA;AAAA,EACH,WAAA,EAAa,IAAA;AAAA,EACb,QAAA,EAAU,IAAA;AAAA,EACV,cAAA,EAAgB,IAAA;AAAA,EAChB,YAAA,EAAc;AAChB;AAEO,SAAS,aAAA,CAAc;AAAA,EAC5B,KAAA;AAAA,EACA,OAAA;AAAA,EACA,WAAA,GAAc;AAChB,CAAA,EAAiC;AAC/B,EAAA,cAAA,CAAe,OAAO,OAAO,CAAA;AAE7B,EAAA,MAAM,GAAA,GAAM,iBAAA,CAAkB,WAAA,EAAa,aAAa,CAAA;AACxD,EAAA,MAAM,eAAA,GAA0C;AAAA,IAC9C,KAAA,EAAO,OAAA,EAAS,KAAA,IAAS,qBAAA,CAAsB,KAAA;AAAA,IAC/C,WAAA,EACE,OAAA,EAAS,WAAA,IAAe,qBAAA,CAAsB,WAAA;AAAA,IAChD,QAAA,EAAU,OAAA,EAAS,QAAA,IAAY,qBAAA,CAAsB,QAAA;AAAA,IACrD,cAAA,EACE,OAAA,EAAS,cAAA,IAAkB,qBAAA,CAAsB,cAAA;AAAA,IACnD,YAAA,EACE,OAAA,EAAS,YAAA,IAAgB,qBAAA,CAAsB,YAAA;AAAA,IACjD,eAAA,EACE,OAAA,EAAS,eAAA,IAAmB,qBAAA,CAAsB,eAAA;AAAA,IACpD,oBAAA,EACE,OAAA,EAAS,oBAAA,IACT,qBAAA,CAAsB;AAAA,GAC1B;AAEA,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,KAAA,EAAO,KAAK,CAAA;AACjC,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,kBAAA,CAAmB,KAAA,EAAO,gBAAgB,KAAK,CAAA;AACpE,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA;AAAA,IACf,kBAAA,CAAmB,WAAA;AAAA,IACnB,MAAA,CAAO,gBAAgB,WAAW;AAAA,GACpC;AACA,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA;AAAA,IACf,kBAAA,CAAmB,QAAA;AAAA,IACnB,MAAA,CAAO,gBAAgB,QAAQ;AAAA,GACjC;AACA,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA;AAAA,IACf,kBAAA,CAAmB,cAAA;AAAA,IACnB,MAAA,CAAO,gBAAgB,cAAc;AAAA,GACvC;AACA,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA;AAAA,IACf,kBAAA,CAAmB,YAAA;AAAA,IACnB,MAAA,CAAO,gBAAgB,YAAY;AAAA,GACrC;AACA,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA;AAAA,IACf,kBAAA,CAAmB,eAAA;AAAA,IACnB,MAAA,CAAO,gBAAgB,eAAe;AAAA,GACxC;AACA,EAAA,GAAA,CAAI,YAAA,CAAa,GAAA;AAAA,IACf,kBAAA,CAAmB,oBAAA;AAAA,IACnB,MAAA,CAAO,gBAAgB,oBAAoB;AAAA,GAC7C;AAEA,EAAA,OAAO,IAAI,QAAA,EAAS;AACtB;AAEO,SAAS,uBAAA,CAAwB;AAAA,EACtC,mBAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA,GAAc;AAChB,CAAA,EAA2C;AACzC,EAAA,cAAA,CAAe,qBAAqB,qBAAqB,CAAA;AAEzD,EAAA,MAAM,OAAO,WAAA,GACT,CAAA,OAAA,EAAU,kBAAA,CAAmB,mBAAmB,CAAC,CAAA,CAAA,EAAI,kBAAA;AAAA,IACnD;AAAA,GACD,CAAA,CAAA,GACD,CAAA,OAAA,EAAU,kBAAA,CAAmB,mBAAmB,CAAC,CAAA,CAAA;AAErD,EAAA,OAAO,iBAAA,CAAkB,WAAA,EAAa,IAAI,CAAA,CAAE,QAAA,EAAS;AACvD;AAEA,SAAS,iBAAA,CAAkB,aAAqB,IAAA,EAAmB;AACjE,EAAA,IAAI,OAAA;AAEJ,EAAA,IAAI;AACF,IAAA,OAAA,GAAU,IAAI,IAAI,WAAW,CAAA;AAAA,EAC/B,CAAA,CAAA,MAAQ;AACN,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,iCAAA,EAAoC,WAAW,CAAA,CAAE,CAAA;AAAA,EACvE;AAEA,EAAA,IAAI,OAAA,CAAQ,QAAA,KAAa,QAAA,IAAY,OAAA,CAAQ,aAAa,OAAA,EAAS;AACjE,IAAA,MAAM,IAAI,UAAU,oCAAoC,CAAA;AAAA,EAC1D;AAEA,EAAA,OAAA,CAAQ,MAAA,GAAS,EAAA;AACjB,EAAA,OAAA,CAAQ,IAAA,GAAO,EAAA;AACf,EAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,QAAA,CAAS,GAAG,CAAA,EAAG;AACnC,IAAA,OAAA,CAAQ,QAAA,IAAY,GAAA;AAAA,EACtB;AAEA,EAAA,OAAO,IAAI,GAAA,CAAI,IAAA,EAAM,OAAO,CAAA;AAC9B;AAEA,SAAS,cAAA,CAAe,OAAe,IAAA,EAAoB;AACzD,EAAA,IAAI,KAAA,CAAM,IAAA,EAAK,CAAE,MAAA,KAAW,CAAA,EAAG;AAC7B,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,EAAG,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAAA,EACjD;AACF","file":"index.cjs","sourcesContent":["export const DEFAULT_BASEDASH_URL = \"https://charts.basedash.com\";\n\nexport const EMBED_QUERY_PARAMS = {\n  theme: \"theme\",\n  hideOrgName: \"hide_org_name\",\n  hideChat: \"hide_chat\",\n  hideDashboards: \"hide_dashboards\",\n  hideInsights: \"hide_insights\",\n  hideAutomations: \"hide_automations\",\n  hideSuggestedPrompts: \"hide_suggested_prompts\",\n} as const;\n\nexport type BasedashTheme = \"light\" | \"dark\" | \"auto\";\n\nexport type BasedashRole = \"ADMIN\" | \"MEMBER\";\n\nexport interface EmbedUser {\n  email: string;\n  firstName?: string;\n  lastName?: string;\n  role?: BasedashRole;\n  /**\n   * Reserved for future group synchronization support in Basedash.\n   */\n  groups?: string[];\n}\n\nexport interface EmbedOptions {\n  theme?: BasedashTheme;\n  hideOrgName?: boolean;\n  hideChat?: boolean;\n  hideDashboards?: boolean;\n  hideInsights?: boolean;\n  hideAutomations?: boolean;\n  hideSuggestedPrompts?: boolean;\n}\n\nexport interface BuildEmbedUrlOptions {\n  token: string;\n  options?: EmbedOptions;\n  /**\n   * Override this when embedding a self-hosted Basedash instance.\n   *\n   * @default \"https://charts.basedash.com\"\n   */\n  instanceUrl?: string;\n}\n\nexport interface BuildSharedDashboardUrlOptions {\n  publicSharingLinkId: string;\n  /**\n   * A token created with `createDashboardFilterToken` from\n   * `@basedash/embed/server`.\n   */\n  filterToken?: string;\n  /**\n   * Override this when embedding a self-hosted Basedash instance.\n   *\n   * @default \"https://charts.basedash.com\"\n   */\n  instanceUrl?: string;\n}\n\nexport const DEFAULT_EMBED_OPTIONS = {\n  theme: \"auto\",\n  hideOrgName: false,\n  hideChat: false,\n  hideDashboards: false,\n  hideInsights: false,\n  hideAutomations: false,\n  hideSuggestedPrompts: false,\n} as const satisfies Required<EmbedOptions>;\n\nexport const CHAT_EMBED_OPTIONS = {\n  ...DEFAULT_EMBED_OPTIONS,\n  hideOrgName: true,\n  hideDashboards: true,\n  hideInsights: true,\n  hideAutomations: true,\n} as const satisfies Required<EmbedOptions>;\n\nexport const DASHBOARDS_EMBED_OPTIONS = {\n  ...DEFAULT_EMBED_OPTIONS,\n  hideOrgName: true,\n  hideChat: true,\n  hideInsights: true,\n  hideAutomations: true,\n} as const satisfies Required<EmbedOptions>;\n\nexport const INSIGHTS_EMBED_OPTIONS = {\n  ...DEFAULT_EMBED_OPTIONS,\n  hideOrgName: true,\n  hideChat: true,\n  hideDashboards: true,\n  hideAutomations: true,\n} as const satisfies Required<EmbedOptions>;\n\nexport const AUTOMATIONS_EMBED_OPTIONS = {\n  ...DEFAULT_EMBED_OPTIONS,\n  hideOrgName: true,\n  hideChat: true,\n  hideDashboards: true,\n  hideInsights: true,\n} as const satisfies Required<EmbedOptions>;\n\nexport function buildEmbedUrl({\n  token,\n  options,\n  instanceUrl = DEFAULT_BASEDASH_URL,\n}: BuildEmbedUrlOptions): string {\n  assertNonEmpty(token, \"token\");\n\n  const url = createInstanceUrl(instanceUrl, \"api/sso/jwt\");\n  const resolvedOptions: Required<EmbedOptions> = {\n    theme: options?.theme ?? DEFAULT_EMBED_OPTIONS.theme,\n    hideOrgName:\n      options?.hideOrgName ?? DEFAULT_EMBED_OPTIONS.hideOrgName,\n    hideChat: options?.hideChat ?? DEFAULT_EMBED_OPTIONS.hideChat,\n    hideDashboards:\n      options?.hideDashboards ?? DEFAULT_EMBED_OPTIONS.hideDashboards,\n    hideInsights:\n      options?.hideInsights ?? DEFAULT_EMBED_OPTIONS.hideInsights,\n    hideAutomations:\n      options?.hideAutomations ?? DEFAULT_EMBED_OPTIONS.hideAutomations,\n    hideSuggestedPrompts:\n      options?.hideSuggestedPrompts ??\n      DEFAULT_EMBED_OPTIONS.hideSuggestedPrompts,\n  };\n\n  url.searchParams.set(\"jwt\", token);\n  url.searchParams.set(EMBED_QUERY_PARAMS.theme, resolvedOptions.theme);\n  url.searchParams.set(\n    EMBED_QUERY_PARAMS.hideOrgName,\n    String(resolvedOptions.hideOrgName),\n  );\n  url.searchParams.set(\n    EMBED_QUERY_PARAMS.hideChat,\n    String(resolvedOptions.hideChat),\n  );\n  url.searchParams.set(\n    EMBED_QUERY_PARAMS.hideDashboards,\n    String(resolvedOptions.hideDashboards),\n  );\n  url.searchParams.set(\n    EMBED_QUERY_PARAMS.hideInsights,\n    String(resolvedOptions.hideInsights),\n  );\n  url.searchParams.set(\n    EMBED_QUERY_PARAMS.hideAutomations,\n    String(resolvedOptions.hideAutomations),\n  );\n  url.searchParams.set(\n    EMBED_QUERY_PARAMS.hideSuggestedPrompts,\n    String(resolvedOptions.hideSuggestedPrompts),\n  );\n\n  return url.toString();\n}\n\nexport function buildSharedDashboardUrl({\n  publicSharingLinkId,\n  filterToken,\n  instanceUrl = DEFAULT_BASEDASH_URL,\n}: BuildSharedDashboardUrlOptions): string {\n  assertNonEmpty(publicSharingLinkId, \"publicSharingLinkId\");\n\n  const path = filterToken\n    ? `shared/${encodeURIComponent(publicSharingLinkId)}/${encodeURIComponent(\n        filterToken,\n      )}`\n    : `shared/${encodeURIComponent(publicSharingLinkId)}`;\n\n  return createInstanceUrl(instanceUrl, path).toString();\n}\n\nfunction createInstanceUrl(instanceUrl: string, path: string): URL {\n  let baseUrl: URL;\n\n  try {\n    baseUrl = new URL(instanceUrl);\n  } catch {\n    throw new TypeError(`instanceUrl must be a valid URL: ${instanceUrl}`);\n  }\n\n  if (baseUrl.protocol !== \"https:\" && baseUrl.protocol !== \"http:\") {\n    throw new TypeError(\"instanceUrl must use http or https\");\n  }\n\n  baseUrl.search = \"\";\n  baseUrl.hash = \"\";\n  if (!baseUrl.pathname.endsWith(\"/\")) {\n    baseUrl.pathname += \"/\";\n  }\n\n  return new URL(path, baseUrl);\n}\n\nfunction assertNonEmpty(value: string, name: string): void {\n  if (value.trim().length === 0) {\n    throw new TypeError(`${name} must not be empty`);\n  }\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,104 @@
+declare const DEFAULT_BASEDASH_URL = "https://charts.basedash.com";
+declare const EMBED_QUERY_PARAMS: {
+    readonly theme: "theme";
+    readonly hideOrgName: "hide_org_name";
+    readonly hideChat: "hide_chat";
+    readonly hideDashboards: "hide_dashboards";
+    readonly hideInsights: "hide_insights";
+    readonly hideAutomations: "hide_automations";
+    readonly hideSuggestedPrompts: "hide_suggested_prompts";
+};
+type BasedashTheme = "light" | "dark" | "auto";
+type BasedashRole = "ADMIN" | "MEMBER";
+interface EmbedUser {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    role?: BasedashRole;
+    /**
+     * Reserved for future group synchronization support in Basedash.
+     */
+    groups?: string[];
+}
+interface EmbedOptions {
+    theme?: BasedashTheme;
+    hideOrgName?: boolean;
+    hideChat?: boolean;
+    hideDashboards?: boolean;
+    hideInsights?: boolean;
+    hideAutomations?: boolean;
+    hideSuggestedPrompts?: boolean;
+}
+interface BuildEmbedUrlOptions {
+    token: string;
+    options?: EmbedOptions;
+    /**
+     * Override this when embedding a self-hosted Basedash instance.
+     *
+     * @default "https://charts.basedash.com"
+     */
+    instanceUrl?: string;
+}
+interface BuildSharedDashboardUrlOptions {
+    publicSharingLinkId: string;
+    /**
+     * A token created with `createDashboardFilterToken` from
+     * `@basedash/embed/server`.
+     */
+    filterToken?: string;
+    /**
+     * Override this when embedding a self-hosted Basedash instance.
+     *
+     * @default "https://charts.basedash.com"
+     */
+    instanceUrl?: string;
+}
+declare const DEFAULT_EMBED_OPTIONS: {
+    readonly theme: "auto";
+    readonly hideOrgName: false;
+    readonly hideChat: false;
+    readonly hideDashboards: false;
+    readonly hideInsights: false;
+    readonly hideAutomations: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const CHAT_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideDashboards: true;
+    readonly hideInsights: true;
+    readonly hideAutomations: true;
+    readonly theme: "auto";
+    readonly hideChat: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const DASHBOARDS_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideChat: true;
+    readonly hideInsights: true;
+    readonly hideAutomations: true;
+    readonly theme: "auto";
+    readonly hideDashboards: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const INSIGHTS_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideChat: true;
+    readonly hideDashboards: true;
+    readonly hideAutomations: true;
+    readonly theme: "auto";
+    readonly hideInsights: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const AUTOMATIONS_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideChat: true;
+    readonly hideDashboards: true;
+    readonly hideInsights: true;
+    readonly theme: "auto";
+    readonly hideAutomations: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare function buildEmbedUrl({ token, options, instanceUrl, }: BuildEmbedUrlOptions): string;
+declare function buildSharedDashboardUrl({ publicSharingLinkId, filterToken, instanceUrl, }: BuildSharedDashboardUrlOptions): string;
+
+export { AUTOMATIONS_EMBED_OPTIONS, type BasedashRole, type BasedashTheme, type BuildEmbedUrlOptions, type BuildSharedDashboardUrlOptions, CHAT_EMBED_OPTIONS, DASHBOARDS_EMBED_OPTIONS, DEFAULT_BASEDASH_URL, DEFAULT_EMBED_OPTIONS, EMBED_QUERY_PARAMS, type EmbedOptions, type EmbedUser, INSIGHTS_EMBED_OPTIONS, buildEmbedUrl, buildSharedDashboardUrl };

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+declare const DEFAULT_BASEDASH_URL = "https://charts.basedash.com";
+declare const EMBED_QUERY_PARAMS: {
+    readonly theme: "theme";
+    readonly hideOrgName: "hide_org_name";
+    readonly hideChat: "hide_chat";
+    readonly hideDashboards: "hide_dashboards";
+    readonly hideInsights: "hide_insights";
+    readonly hideAutomations: "hide_automations";
+    readonly hideSuggestedPrompts: "hide_suggested_prompts";
+};
+type BasedashTheme = "light" | "dark" | "auto";
+type BasedashRole = "ADMIN" | "MEMBER";
+interface EmbedUser {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    role?: BasedashRole;
+    /**
+     * Reserved for future group synchronization support in Basedash.
+     */
+    groups?: string[];
+}
+interface EmbedOptions {
+    theme?: BasedashTheme;
+    hideOrgName?: boolean;
+    hideChat?: boolean;
+    hideDashboards?: boolean;
+    hideInsights?: boolean;
+    hideAutomations?: boolean;
+    hideSuggestedPrompts?: boolean;
+}
+interface BuildEmbedUrlOptions {
+    token: string;
+    options?: EmbedOptions;
+    /**
+     * Override this when embedding a self-hosted Basedash instance.
+     *
+     * @default "https://charts.basedash.com"
+     */
+    instanceUrl?: string;
+}
+interface BuildSharedDashboardUrlOptions {
+    publicSharingLinkId: string;
+    /**
+     * A token created with `createDashboardFilterToken` from
+     * `@basedash/embed/server`.
+     */
+    filterToken?: string;
+    /**
+     * Override this when embedding a self-hosted Basedash instance.
+     *
+     * @default "https://charts.basedash.com"
+     */
+    instanceUrl?: string;
+}
+declare const DEFAULT_EMBED_OPTIONS: {
+    readonly theme: "auto";
+    readonly hideOrgName: false;
+    readonly hideChat: false;
+    readonly hideDashboards: false;
+    readonly hideInsights: false;
+    readonly hideAutomations: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const CHAT_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideDashboards: true;
+    readonly hideInsights: true;
+    readonly hideAutomations: true;
+    readonly theme: "auto";
+    readonly hideChat: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const DASHBOARDS_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideChat: true;
+    readonly hideInsights: true;
+    readonly hideAutomations: true;
+    readonly theme: "auto";
+    readonly hideDashboards: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const INSIGHTS_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideChat: true;
+    readonly hideDashboards: true;
+    readonly hideAutomations: true;
+    readonly theme: "auto";
+    readonly hideInsights: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare const AUTOMATIONS_EMBED_OPTIONS: {
+    readonly hideOrgName: true;
+    readonly hideChat: true;
+    readonly hideDashboards: true;
+    readonly hideInsights: true;
+    readonly theme: "auto";
+    readonly hideAutomations: false;
+    readonly hideSuggestedPrompts: false;
+};
+declare function buildEmbedUrl({ token, options, instanceUrl, }: BuildEmbedUrlOptions): string;
+declare function buildSharedDashboardUrl({ publicSharingLinkId, filterToken, instanceUrl, }: BuildSharedDashboardUrlOptions): string;
+
+export { AUTOMATIONS_EMBED_OPTIONS, type BasedashRole, type BasedashTheme, type BuildEmbedUrlOptions, type BuildSharedDashboardUrlOptions, CHAT_EMBED_OPTIONS, DASHBOARDS_EMBED_OPTIONS, DEFAULT_BASEDASH_URL, DEFAULT_EMBED_OPTIONS, EMBED_QUERY_PARAMS, type EmbedOptions, type EmbedUser, INSIGHTS_EMBED_OPTIONS, buildEmbedUrl, buildSharedDashboardUrl };