@omni-co/embed 0.18.0 → 0.20.0

package/lib/esm/embed.js

@@ -1,59 +1,59 @@
-import { random32ByteString } from "./random-str.server.js";
-import { getSignature, signSessionRedemption } from "./signature.js";
-import { EmbeddedContent } from "./constants.js";
-const defaultEmbedDomain = "embed-omniapp.co";
-const embedLoginPath = "/embed/login";
-const generateSsoEmbedSessionPath = "/api/unstable/embed/sso/generate-session";
-const redeemSsoEmbedSessionPath = "/embed/sso/redeem-session";
+import { random32ByteString } from './random-str.server.js';
+import { getSignature, signSessionRedemption } from './signature.js';
+import { EmbeddedContent } from './constants.js';
+const defaultEmbedDomain = 'embed-omniapp.co';
+const embedLoginPath = '/embed/login';
+const generateSsoEmbedSessionPath = '/api/unstable/embed/sso/generate-session';
+const redeemSsoEmbedSessionPath = '/embed/sso/redeem-session';
 const createEmbedRequestUrl = (props) => {
     let host, domain, organizationName;
-    if ("host" in props)
+    if ('host' in props)
         host = props.host;
-    if ("organizationName" in props) {
+    if ('organizationName' in props) {
         domain = props.domain;
         organizationName = props.organizationName;
     }
     // Generate the url for the embed login route
     if (!host)
         host = `${organizationName}.${domain ?? defaultEmbedDomain}`;
-    const url = new URL(props.requestPath, `https://${host}${props.port ? `:${props.port}` : ""}`);
+    const url = new URL(props.requestPath, `https://${host}${props.port ? `:${props.port}` : ''}`);
     return url;
 };
 const validateProps = (props) => {
     const { externalId, name, nonce, secret, uiSettings, userAttributes, customTheme, customThemeId, } = props;
     let host, domain, organizationName;
-    if ("host" in props)
+    if ('host' in props)
         host = props.host;
-    if ("organizationName" in props)
+    if ('organizationName' in props)
         organizationName = props.organizationName;
-    if ("domain" in props)
+    if ('domain' in props)
         domain = props.domain;
     if (!externalId)
-        throw new Error("externalId is required");
+        throw new Error('externalId is required');
     if (!name)
-        throw new Error("name is required");
+        throw new Error('name is required');
     if (!secret)
-        throw new Error("secret is required");
+        throw new Error('secret is required');
     if (!host && !organizationName)
-        throw new Error("Must specify either `host` or `organizationName`");
+        throw new Error('Must specify either `host` or `organizationName`');
     if (host && (organizationName || domain))
-        throw new Error("`host` must be used exclusively and cannot be combined with `organizationName` or `domain` (domain is deprecated)");
+        throw new Error('`host` must be used exclusively and cannot be combined with `organizationName` or `domain` (domain is deprecated)');
     if (customThemeId && customTheme)
-        console.warn("If you use a `customThemeId` any theme styles passed in via `customTheme` will be ignored.");
+        console.warn('If you use a `customThemeId` any theme styles passed in via `customTheme` will be ignored.');
     if (domain)
         console.warn("`domain` is deprecated and will be removed in a future v1.0.0 release. Use `host` to specify your vanity domain instead (eg `host: 'omni.my-company.com'`).");
     if (nonce && nonce.length !== 32)
-        throw new Error("nonce must be 32 characters");
-    if (typeof uiSettings !== "object" && uiSettings)
-        throw new Error("uiSettings must be an object");
-    if (typeof userAttributes !== "object" && userAttributes)
-        throw new Error("userAttributes must be an object");
+        throw new Error('nonce must be 32 characters');
+    if (typeof uiSettings !== 'object' && uiSettings)
+        throw new Error('uiSettings must be an object');
+    if (typeof userAttributes !== 'object' && userAttributes)
+        throw new Error('userAttributes must be an object');
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, branch, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, modelRoles: rawModelRoles, name, nonce, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
+    const { accessBoost, branch, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, modelRoles: rawModelRoles, name, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, timezone, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
     // Handle defaults
-    nonce = nonce ?? (await random32ByteString());
+    const nonce = props.nonce ?? (await random32ByteString());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     const customTheme = rawCustomTheme && JSON.stringify(rawCustomTheme);
@@ -96,44 +96,45 @@ const embedSsoContent = async (props) => {
         prefersDark,
         preserveEntityFolderContentRole,
         theme,
+        timezone,
         uiSettings,
         userAttributes,
     });
     // Build and return the signed url
-    url.searchParams.append("contentPath", contentPath);
-    url.searchParams.append("externalId", externalId);
-    url.searchParams.append("name", name);
-    url.searchParams.append("nonce", nonce);
-    url.searchParams.append("signature", signature);
-    userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    url.searchParams.append('contentPath', contentPath);
+    url.searchParams.append('externalId', externalId);
+    url.searchParams.append('name', name);
+    url.searchParams.append('nonce', nonce);
+    url.searchParams.append('signature', signature);
+    userAttributes && url.searchParams.append('userAttributes', userAttributes);
     accessBoost !== undefined &&
-        url.searchParams.append("accessBoost", accessBoost.toString());
-    entity && url.searchParams.append("entity", entity);
-    prefersDark && url.searchParams.append("prefersDark", prefersDark);
-    theme && url.searchParams.append("theme", theme);
+        url.searchParams.append('accessBoost', accessBoost.toString());
+    entity && url.searchParams.append('entity', entity);
+    prefersDark && url.searchParams.append('prefersDark', prefersDark);
+    theme && url.searchParams.append('theme', theme);
+    timezone && url.searchParams.append('timezone', timezone);
     filterSearchParam &&
-        url.searchParams.append("filterSearchParam", filterSearchParam);
-    linkAccess && url.searchParams.append("linkAccess", linkAccess);
-    customTheme && url.searchParams.append("customTheme", customTheme);
-    customThemeId && url.searchParams.append("customThemeId", customThemeId);
-    connectionRoles &&
-        url.searchParams.append("connectionRoles", connectionRoles);
-    mode && url.searchParams.append("mode", mode);
-    modelRoles && url.searchParams.append("modelRoles", modelRoles);
+        url.searchParams.append('filterSearchParam', filterSearchParam);
+    linkAccess && url.searchParams.append('linkAccess', linkAccess);
+    customTheme && url.searchParams.append('customTheme', customTheme);
+    customThemeId && url.searchParams.append('customThemeId', customThemeId);
+    connectionRoles && url.searchParams.append('connectionRoles', connectionRoles);
+    mode && url.searchParams.append('mode', mode);
+    modelRoles && url.searchParams.append('modelRoles', modelRoles);
     entityFolderContentRole &&
-        url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
+        url.searchParams.append('entityFolderContentRole', entityFolderContentRole);
     entityFolderGroupContentRole &&
-        url.searchParams.append("entityFolderGroupContentRole", entityFolderGroupContentRole);
-    groups && url.searchParams.append("groups", groups);
-    email && url.searchParams.append("email", email);
-    uiSettings && url.searchParams.append("uiSettings", uiSettings);
+        url.searchParams.append('entityFolderGroupContentRole', entityFolderGroupContentRole);
+    groups && url.searchParams.append('groups', groups);
+    email && url.searchParams.append('email', email);
+    uiSettings && url.searchParams.append('uiSettings', uiSettings);
     entityGroupLabel &&
-        url.searchParams.append("entityGroupLabel", entityGroupLabel);
+        url.searchParams.append('entityGroupLabel', entityGroupLabel);
     entityFolderLabel &&
-        url.searchParams.append("entityFolderLabel", entityFolderLabel);
+        url.searchParams.append('entityFolderLabel', entityFolderLabel);
     preserveEntityFolderContentRole !== undefined &&
-        url.searchParams.append("preserveEntityFolderContentRole", preserveEntityFolderContentRole.toString());
-    branch && url.searchParams.append("branch", branch);
+        url.searchParams.append('preserveEntityFolderContentRole', preserveEntityFolderContentRole.toString());
+    branch && url.searchParams.append('branch', branch);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
@@ -153,9 +154,7 @@ export const embedSsoWorkbook = async (props) => {
 export const embedSsoContentDiscovery = async (props) => {
     // Entity paths for the Content Discovery embed no longer require stripping the leading `/`.
     // This check maintains backwards compatibility with the old behavior.
-    const contentPath = props.path.startsWith("/")
-        ? props.path
-        : `/${props.path}`;
+    const contentPath = props.path.startsWith('/') ? props.path : `/${props.path}`;
     return embedSsoContent({
         ...props,
         contentPath,
@@ -179,13 +178,13 @@ export const createSessionToken = async ({ apiKey, domain, host, organizationNam
     });
     // Hit the endpoint with the endpoint params + signature
     const fetchResponse = await fetch(generateRequestUrl, {
-        method: "POST",
+        method: 'POST',
         body: JSON.stringify({
             ...restProps,
         }),
         headers: {
             Authorization: `Bearer ${apiKey}`,
-            "Content-type": "application/json",
+            'Content-type': 'application/json',
         },
     });
     if (!fetchResponse.ok)
@@ -195,7 +194,7 @@ export const createSessionToken = async ({ apiKey, domain, host, organizationNam
         };
     const fetchData = (await fetchResponse.json());
     if (!fetchData.sessionId)
-        return { error: "No session ID returned from endpoint.", success: false };
+        return { error: 'No session ID returned from endpoint.', success: false };
     return { sessionToken: fetchData.sessionId, success: true };
 };
 /**
@@ -222,13 +221,12 @@ theme, }) => {
         theme,
         branch,
     });
-    branch !== undefined &&
-        redeemRequestUrl.searchParams.append("branch", branch);
+    branch !== undefined && redeemRequestUrl.searchParams.append('branch', branch);
     prefersDark !== undefined &&
-        redeemRequestUrl.searchParams.append("prefersDark", prefersDark);
-    theme !== undefined && redeemRequestUrl.searchParams.append("theme", theme);
-    redeemRequestUrl.searchParams.append("nonce", nonce);
-    redeemRequestUrl.searchParams.append("sessionId", sessionId);
-    redeemRequestUrl.searchParams.append("signature", signature);
+        redeemRequestUrl.searchParams.append('prefersDark', prefersDark);
+    theme !== undefined && redeemRequestUrl.searchParams.append('theme', theme);
+    redeemRequestUrl.searchParams.append('nonce', nonce);
+    redeemRequestUrl.searchParams.append('sessionId', sessionId);
+    redeemRequestUrl.searchParams.append('signature', signature);
     return redeemRequestUrl.toString();
 };

package/lib/esm/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./embed.js";
-export * from "./types.js";
-export * from "./signature.js";
-export * from "./constants.js";
+export * from './embed.js';
+export * from './types.js';
+export * from './signature.js';
+export * from './constants.js';

package/lib/esm/index.js

@@ -1,4 +1,4 @@
-export * from "./embed.js";
-export * from "./types.js";
-export * from "./signature.js";
-export * from "./constants.js";
+export * from './embed.js';
+export * from './types.js';
+export * from './signature.js';
+export * from './constants.js';

package/lib/esm/omni_internal_browser.d.ts

@@ -1,5 +1,5 @@
 /**
  * Client / browser entrypoint for the Omni Embed SDK.
  */
-export * from "./constants.js";
-export * from "./types.js";
+export * from './constants.js';
+export * from './types.js';

package/lib/esm/omni_internal_browser.js

@@ -1,5 +1,5 @@
 /**
  * Client / browser entrypoint for the Omni Embed SDK.
  */
-export * from "./constants.js";
-export * from "./types.js";
+export * from './constants.js';
+export * from './types.js';

package/lib/esm/random-str.server.js

@@ -1,4 +1,4 @@
-import crypto from "crypto";
+import crypto from 'crypto';
 /**
  * Generates a random 32 byte, human readable string.
  * Based on math at https://zelark.github.io/nano-id-cc/
@@ -7,8 +7,8 @@ import crypto from "crypto";
  * of at least one collision.
  */
 export const random32ByteString = async () => {
-    const humanReadableByteSpace = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
-    let randomString = "";
+    const humanReadableByteSpace = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
+    let randomString = '';
     for (let i = 0; i < 32; i++) {
         // Generate a random number between 0 and humanReadableByteSpace.length - 1
         // and return the corresponding character from humanReadableByteSpace.

package/lib/esm/signature.d.ts

@@ -1,4 +1,4 @@
-import { RedeemSessionExclusiveProps } from "./types.js";
+import { RedeemSessionExclusiveProps } from './types.js';
 export declare const hmacSign: (data: string, secret: string) => string;
 type SignatureProps = {
     /**
@@ -109,6 +109,12 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * IANA timezone override applied to the embed session's query execution.
+     *
+     * Example: "America/New_York"
+     */
+    timezone?: string;
     /**
      * The UI settings for the embedded content.
      */
@@ -140,6 +146,6 @@ type SignSessionRedemptionProps = Pick<SignatureProps, RedeemSessionExclusivePro
  */
 export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, branch, prefersDark, theme, }: SignSessionRedemptionProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, timezone, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -1,18 +1,18 @@
-import crypto from "crypto";
+import crypto from 'crypto';
 export const hmacSign = (data, secret) => {
-    const hmac = crypto.createHmac("sha256", secret);
+    const hmac = crypto.createHmac('sha256', secret);
     hmac.update(data);
-    return hmac.digest("base64url");
+    return hmac.digest('base64url');
 };
 const generateStringForSignature = ({ 
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }) => {
+accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, timezone, uiSettings, userAttributes, }) => {
     // We create a map of optional params and convert it to an array
     // to ensure that the order of the optional params is alphabetical and consistent.
     const optionalParamsMap = {
-        ...(accessBoost !== undefined && { accessBoost: accessBoost.toString() }),
+        ...(accessBoost !== undefined && { accessBoost: accessBoost.toString() }), // need to support accessBoost=false
         ...(branch && { branch }),
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
@@ -33,6 +33,7 @@ accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity,
             preserveEntityFolderContentRole: preserveEntityFolderContentRole.toString(),
         }),
         ...(theme && { theme }),
+        ...(timezone && { timezone }),
         ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),
     };
@@ -47,10 +48,10 @@ accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity,
   ${externalId}
   ${name}
   ${nonce}
-  ${optionalParams.join("\n")}
+  ${optionalParams.join('\n')}
   `
         .trim()
-        .replace(/\n\s+/g, "\n");
+        .replace(/\n\s+/g, '\n');
 };
 /**
  * Creates a signature value for the /embed/login endpoint.
@@ -81,10 +82,10 @@ export const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, br
     ${requestUrl}
     ${nonce}
     ${sessionId}
-    ${optionalParams.join("\n")}
+    ${optionalParams.join('\n')}
 `
         .trim()
-        .replace(/\n\s+/g, "\n");
+        .replace(/\n\s+/g, '\n');
     return hmacSign(signatureString, secret);
 };
 export const TEST_ONLY = {

package/lib/esm/types.d.ts

@@ -1,4 +1,15 @@
-import { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
+import { EmbedUiSettings } from './constants.js';
+import type { BreadcrumbDisplayMode, CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode } from './constants.js';
+/**
+ * UI settings object controlling appearance settings of the embed session.
+ * Each key is optional; values are booleans except `documentBreadcrumb`, which
+ * takes a `BreadcrumbDisplayMode`.
+ */
+export type EmbedUiSettingsObject = {
+    [EmbedUiSettings.SHOW_NAVIGATION]?: boolean;
+    [EmbedUiSettings.DASHBOARD_CHART_CONTEXT_MENU]?: boolean;
+    [EmbedUiSettings.DOCUMENT_BREADCRUMB]?: BreadcrumbDisplayMode;
+};
 type UserAttributeValue = string | string[] | number | number[];
 type HostProps = ({
     host?: never;
@@ -39,6 +50,7 @@ type EmbedSsoBaseProps = {
     userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    timezone?: string;
     customTheme?: CustomThemeProperties;
     customThemeId?: string;
     /**
@@ -109,7 +121,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
-    uiSettings?: Record<EmbedUiSettings, boolean>;
+    uiSettings?: EmbedUiSettingsObject;
     /**
      * Optional branch setting that sets the model branch of the embed session.
      */
@@ -188,7 +200,7 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
      */
     path: string;
 };
-export type RedeemSessionExclusiveProps = "branch" | "nonce" | "prefersDark" | "secret" | "theme";
+export type RedeemSessionExclusiveProps = 'branch' | 'nonce' | 'prefersDark' | 'secret' | 'theme';
 export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     apiKey: string;
 } & HostProps;

package/lib/esm/types.js

@@ -1 +1 @@
-import { CustomThemeProperty, } from "./constants.js";
+import { EmbedUiSettings } from './constants.js';

package/lib/omni_internal_browser/constants.d.ts

@@ -78,5 +78,24 @@ export declare enum EmbedUiSettings {
      * When false, hides all in-app navigation elements. Note that in-app navigation
      * is only visible when the embed session is in APPLICATION mode.
      */
-    SHOW_NAVIGATION = "showNavigation"
+    SHOW_NAVIGATION = "showNavigation",
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    DASHBOARD_CHART_CONTEXT_MENU = "dashboardChartContextMenu",
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    DOCUMENT_BREADCRUMB = "documentBreadcrumb"
 }
+/**
+ * Display modes for the `documentBreadcrumb` UI setting.
+ *
+ * "link": breadcrumb shown as clickable links (default behavior).
+ * "display": breadcrumb text stays visible but is not a hyperlink.
+ * "none": breadcrumb is hidden entirely.
+ */
+export type BreadcrumbDisplayMode = 'display' | 'link' | 'none';

package/lib/omni_internal_browser/constants.js

@@ -91,4 +91,15 @@ export var EmbedUiSettings;
      * is only visible when the embed session is in APPLICATION mode.
      */
     EmbedUiSettings["SHOW_NAVIGATION"] = "showNavigation";
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_CHART_CONTEXT_MENU"] = "dashboardChartContextMenu";
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    EmbedUiSettings["DOCUMENT_BREADCRUMB"] = "documentBreadcrumb";
 })(EmbedUiSettings || (EmbedUiSettings = {}));

package/lib/omni_internal_browser/omni_internal_browser.d.ts

@@ -1,5 +1,5 @@
 /**
  * Client / browser entrypoint for the Omni Embed SDK.
  */
-export * from "./constants.js";
-export * from "./types.js";
+export * from './constants.js';
+export * from './types.js';

package/lib/omni_internal_browser/omni_internal_browser.js

@@ -1,5 +1,5 @@
 /**
  * Client / browser entrypoint for the Omni Embed SDK.
  */
-export * from "./constants.js";
-export * from "./types.js";
+export * from './constants.js';
+export * from './types.js';

package/lib/omni_internal_browser/types.d.ts

@@ -1,4 +1,15 @@
-import { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
+import { EmbedUiSettings } from './constants.js';
+import type { BreadcrumbDisplayMode, CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode } from './constants.js';
+/**
+ * UI settings object controlling appearance settings of the embed session.
+ * Each key is optional; values are booleans except `documentBreadcrumb`, which
+ * takes a `BreadcrumbDisplayMode`.
+ */
+export type EmbedUiSettingsObject = {
+    [EmbedUiSettings.SHOW_NAVIGATION]?: boolean;
+    [EmbedUiSettings.DASHBOARD_CHART_CONTEXT_MENU]?: boolean;
+    [EmbedUiSettings.DOCUMENT_BREADCRUMB]?: BreadcrumbDisplayMode;
+};
 type UserAttributeValue = string | string[] | number | number[];
 type HostProps = ({
     host?: never;
@@ -39,6 +50,7 @@ type EmbedSsoBaseProps = {
     userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    timezone?: string;
     customTheme?: CustomThemeProperties;
     customThemeId?: string;
     /**
@@ -109,7 +121,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
-    uiSettings?: Record<EmbedUiSettings, boolean>;
+    uiSettings?: EmbedUiSettingsObject;
     /**
      * Optional branch setting that sets the model branch of the embed session.
      */
@@ -188,7 +200,7 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
      */
     path: string;
 };
-export type RedeemSessionExclusiveProps = "branch" | "nonce" | "prefersDark" | "secret" | "theme";
+export type RedeemSessionExclusiveProps = 'branch' | 'nonce' | 'prefersDark' | 'secret' | 'theme';
 export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     apiKey: string;
 } & HostProps;

package/lib/omni_internal_browser/types.js

@@ -1 +1 @@
-import { CustomThemeProperty, } from "./constants.js";
+import { EmbedUiSettings } from './constants.js';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.18.0",
+  "version": "0.20.0",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",
@@ -7,10 +7,16 @@
     "lib/**/*"
   ],
   "devDependencies": {
+    "@eslint/js": "^10.0.1",
     "@types/node": "^20.8.9",
+    "eslint": "^10.3.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.6.0",
+    "prettier": "^3.8.3",
     "semantic-release": "^25.0.2",
     "typescript": "^5.2.2",
-    "vitest": "^0.34.6"
+    "typescript-eslint": "^8.59.3",
+    "vitest": "^4.1.6"
   },
   "scripts": {
     "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:omni_internal_browser",
@@ -18,9 +24,15 @@
     "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/cjs/package.json",
     "build:omni_internal_browser": "tsc -p tsconfig.omni_internal_browser.json && echo '{\"type\": \"module\"}' > ./lib/omni_internal_browser/package.json",
     "clean": "rm -rf lib",
+    "eslint": "eslint .",
+    "eslint:fix": "eslint . --fix",
+    "fix": "npm run eslint:fix && npm run prettier:fix",
+    "lint": "npm run eslint && npm run prettier",
     "lint:ts": "tsc -p tsconfig.json --noEmit",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --write .",
     "prepublishOnly": "npm run build",
-    "test": "vitest",
+    "test": "vitest run",
     "test:watch": "vitest --watch"
   },
   "engines": {