@omni-co/embed 0.13.0 → 0.14.1-alpha.1

package/README.md

@@ -210,6 +210,9 @@ type EmbedSsoDashboardProps = {
    */
   mode?: EmbedSessionMode;
 
+  // Optional object that determines the model permissions for the embed user.
+  modelRoles?: Record<string, EmbedConnectionRoles>;
+
   // Required name of the external user.
   name: string;
 
@@ -353,6 +356,9 @@ type EmbedSsoWorkbookProps = {
    */
   mode?: EmbedSessionMode;
 
+  // Optional object that determines the model permissions for the embed user.
+  modelRoles?: Record<string, EmbedConnectionRoles>;
+
   // Required name of the external user.
   name: string;
 
@@ -488,6 +494,9 @@ type EmbedSsoContentDiscoveryProps = {
    */
   mode?: EmbedSessionMode;
 
+  // Optional object that determines the model permissions for the embed user.
+  modelRoles?: Record<string, EmbedConnectionRoles>;
+
   // Required name of the external user.
   name: string;
 
@@ -655,6 +664,9 @@ type CreateSessionTokenProps = {
    */
   mode?: EmbedSessionMode;
 
+  // Optional object that determines the model permissions for the embed user.
+  modelRoles?: Record<string, EmbedConnectionRoles>;
+
   // Required name of the external user.
   name: string;
 

package/lib/cjs/constants.d.ts

@@ -0,0 +1,82 @@
+export declare enum EmbedSessionMode {
+    Application = "APPLICATION",
+    SingleContent = "SINGLE_CONTENT"
+}
+export declare enum CustomThemeProperty {
+    DASHBOARD_BACKGROUND = "dashboard-background",
+    DASHBOARD_PAGE_PADDING = "dashboard-page-padding",
+    DASHBOARD_TILE_MARGIN = "dashboard-tile-margin",
+    DASHBOARD_TILE_BACKGROUND = "dashboard-tile-background",
+    DASHBOARD_TILE_SHADOW = "dashboard-tile-shadow",
+    DASHBOARD_TILE_TEXT_BODY_COLOR = "dashboard-tile-text-body-color",
+    DASHBOARD_TILE_TEXT_SECONDARY_COLOR = "dashboard-tile-text-secondary-color",
+    DASHBOARD_TILE_BORDER_COLOR = "dashboard-tile-border-color",
+    DASHBOARD_TILE_BORDER_RADIUS = "dashboard-tile-border-radius",
+    DASHBOARD_TILE_BORDER_STYLE = "dashboard-tile-border-style",
+    DASHBOARD_TILE_BORDER_WIDTH = "dashboard-tile-border-width",
+    DASHBOARD_TILE_TITLE_FONT_SIZE = "dashboard-tile-title-font-size",
+    DASHBOARD_TILE_TITLE_FONT_WEIGHT = "dashboard-tile-title-font-weight",
+    DASHBOARD_TILE_TITLE_TEXT_COLOR = "dashboard-tile-title-text-color",
+    DASHBOARD_TILE_TITLE_FONT_FAMILY = "dashboard-tile-title-font-family",
+    DASHBOARD_TILE_TEXT_BODY_FONT_FAMILY = "dashboard-tile-text-body-font-family",
+    DASHBOARD_TILE_TEXT_CODE_FONT_FAMILY = "dashboard-tile-text-code-font-family",
+    DASHBOARD_KEY_COLOR = "dashboard-key-color",
+    DASHBOARD_KEY_TEXT_COLOR = "dashboard-key-text-color",
+    DASHBOARD_BUTTON_RADIUS = "dashboard-button-radius",
+    DASHBOARD_BUTTON_TRANSPARENT_TEXT_COLOR = "dashboard-button-transparent-text-color",
+    DASHBOARD_BUTTON_TRANSPARENT_INTERACTIVE_COLOR = "dashboard-button-transparent-interactive-color",
+    DASHBOARD_MENU_ITEM_INTERACTIVE_COLOR = "dashboard-menu-item-interactive-color",
+    DASHBOARD_CONTROL_BACKGROUND = "dashboard-control-background",
+    DASHBOARD_CONTROL_RADIUS = "dashboard-control-radius",
+    DASHBOARD_CONTROL_BORDER_COLOR = "dashboard-control-border-color",
+    DASHBOARD_CONTROL_TEXT_COLOR = "dashboard-control-text-color",
+    DASHBOARD_CONTROL_PLACEHOLDER_COLOR = "dashboard-control-placeholder-color",
+    DASHBOARD_CONTROL_LABEL_COLOR = "dashboard-control-label-color",
+    DASHBOARD_CONTROL_OUTLINE_COLOR = "dashboard-control-outline-color",
+    DASHBOARD_CONTROL_POPOVER_BACKGROUND = "dashboard-control-popover-background",
+    DASHBOARD_CONTROL_POPOVER_TEXT_COLOR = "dashboard-control-popover-text-color",
+    DASHBOARD_CONTROL_POPOVER_SECONDARY_TEXT_COLOR = "dashboard-control-popover-secondary-text-color",
+    DASHBOARD_CONTROL_POPOVER_LINK_COLOR = "dashboard-control-popover-link-color",
+    DASHBOARD_CONTROL_POPOVER_DIVIDER_COLOR = "dashboard-control-popover-divider-color",
+    DASHBOARD_CONTROL_POPOVER_RADIUS = "dashboard-control-popover-radius",
+    DASHBOARD_CONTROL_POPOVER_BORDER_COLOR = "dashboard-control-popover-border-color",
+    DASHBOARD_FILTER_INPUT_BACKGROUND = "dashboard-filter-input-background",
+    DASHBOARD_FILTER_INPUT_RADIUS = "dashboard-filter-input-radius",
+    DASHBOARD_FILTER_INPUT_BORDER_COLOR = "dashboard-filter-input-border-color",
+    DASHBOARD_FILTER_INPUT_TEXT_COLOR = "dashboard-filter-input-text-color",
+    DASHBOARD_FILTER_INPUT_PLACEHOLDER_COLOR = "dashboard-filter-input-placeholder-color",
+    DASHBOARD_FILTER_INPUT_ICON_COLOR = "dashboard-filter-input-icon-color",
+    DASHBOARD_FILTER_INPUT_OUTLINE_COLOR = "dashboard-filter-input-outline-color",
+    DASHBOARD_FILTER_INPUT_ACCENT_COLOR = "dashboard-filter-input-accent-color",
+    DASHBOARD_FILTER_INPUT_ACCENT_INVERT_COLOR = "dashboard-filter-input-accent-invert-color",
+    DASHBOARD_FILTER_INPUT_TOKEN_COLOR = "dashboard-filter-input-token-color",
+    DASHBOARD_FILTER_INPUT_TOKEN_TEXT_COLOR = "dashboard-filter-input-token-text-color"
+}
+export declare enum EmbeddedContent {
+    Dashboard = "dashboards",
+    Workbook = "w"
+}
+export declare enum EmbedConnectionRoles {
+    RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
+    VIEWER = "VIEWER",
+    QUERIER = "QUERIER"
+}
+/**
+ * Levels of access a user can have to their associated embed entity folder.
+ */
+export declare enum EmbedEntityFolderContentRoles {
+    MANAGER = "MANAGER",
+    EDITOR = "EDITOR",
+    VIEWER = "VIEWER",
+    NO_ACCESS = "NO_ACCESS"
+}
+/**
+ * UI settings used as keys of the uiSettings sso embed parameter.
+ */
+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"
+}

package/lib/cjs/constants.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmbedUiSettings = exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
+var EmbedSessionMode;
+(function (EmbedSessionMode) {
+    EmbedSessionMode["Application"] = "APPLICATION";
+    EmbedSessionMode["SingleContent"] = "SINGLE_CONTENT";
+})(EmbedSessionMode || (exports.EmbedSessionMode = EmbedSessionMode = {}));
+var CustomThemeProperty;
+(function (CustomThemeProperty) {
+    CustomThemeProperty["DASHBOARD_BACKGROUND"] = "dashboard-background";
+    CustomThemeProperty["DASHBOARD_PAGE_PADDING"] = "dashboard-page-padding";
+    CustomThemeProperty["DASHBOARD_TILE_MARGIN"] = "dashboard-tile-margin";
+    CustomThemeProperty["DASHBOARD_TILE_BACKGROUND"] = "dashboard-tile-background";
+    CustomThemeProperty["DASHBOARD_TILE_SHADOW"] = "dashboard-tile-shadow";
+    CustomThemeProperty["DASHBOARD_TILE_TEXT_BODY_COLOR"] = "dashboard-tile-text-body-color";
+    CustomThemeProperty["DASHBOARD_TILE_TEXT_SECONDARY_COLOR"] = "dashboard-tile-text-secondary-color";
+    CustomThemeProperty["DASHBOARD_TILE_BORDER_COLOR"] = "dashboard-tile-border-color";
+    CustomThemeProperty["DASHBOARD_TILE_BORDER_RADIUS"] = "dashboard-tile-border-radius";
+    CustomThemeProperty["DASHBOARD_TILE_BORDER_STYLE"] = "dashboard-tile-border-style";
+    CustomThemeProperty["DASHBOARD_TILE_BORDER_WIDTH"] = "dashboard-tile-border-width";
+    CustomThemeProperty["DASHBOARD_TILE_TITLE_FONT_SIZE"] = "dashboard-tile-title-font-size";
+    CustomThemeProperty["DASHBOARD_TILE_TITLE_FONT_WEIGHT"] = "dashboard-tile-title-font-weight";
+    CustomThemeProperty["DASHBOARD_TILE_TITLE_TEXT_COLOR"] = "dashboard-tile-title-text-color";
+    CustomThemeProperty["DASHBOARD_TILE_TITLE_FONT_FAMILY"] = "dashboard-tile-title-font-family";
+    CustomThemeProperty["DASHBOARD_TILE_TEXT_BODY_FONT_FAMILY"] = "dashboard-tile-text-body-font-family";
+    CustomThemeProperty["DASHBOARD_TILE_TEXT_CODE_FONT_FAMILY"] = "dashboard-tile-text-code-font-family";
+    CustomThemeProperty["DASHBOARD_KEY_COLOR"] = "dashboard-key-color";
+    CustomThemeProperty["DASHBOARD_KEY_TEXT_COLOR"] = "dashboard-key-text-color";
+    CustomThemeProperty["DASHBOARD_BUTTON_RADIUS"] = "dashboard-button-radius";
+    CustomThemeProperty["DASHBOARD_BUTTON_TRANSPARENT_TEXT_COLOR"] = "dashboard-button-transparent-text-color";
+    CustomThemeProperty["DASHBOARD_BUTTON_TRANSPARENT_INTERACTIVE_COLOR"] = "dashboard-button-transparent-interactive-color";
+    CustomThemeProperty["DASHBOARD_MENU_ITEM_INTERACTIVE_COLOR"] = "dashboard-menu-item-interactive-color";
+    // These styles are applied to controls directly on the dashboard,
+    // typically these are single select control,
+    // period-over-period control or advanced filter controls
+    CustomThemeProperty["DASHBOARD_CONTROL_BACKGROUND"] = "dashboard-control-background";
+    CustomThemeProperty["DASHBOARD_CONTROL_RADIUS"] = "dashboard-control-radius";
+    CustomThemeProperty["DASHBOARD_CONTROL_BORDER_COLOR"] = "dashboard-control-border-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_TEXT_COLOR"] = "dashboard-control-text-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_PLACEHOLDER_COLOR"] = "dashboard-control-placeholder-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_LABEL_COLOR"] = "dashboard-control-label-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_OUTLINE_COLOR"] = "dashboard-control-outline-color";
+    // These styles are applied the popover container
+    // that is triggered when clicking a dashboard control
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_BACKGROUND"] = "dashboard-control-popover-background";
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_TEXT_COLOR"] = "dashboard-control-popover-text-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_SECONDARY_TEXT_COLOR"] = "dashboard-control-popover-secondary-text-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_LINK_COLOR"] = "dashboard-control-popover-link-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_DIVIDER_COLOR"] = "dashboard-control-popover-divider-color";
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_RADIUS"] = "dashboard-control-popover-radius";
+    CustomThemeProperty["DASHBOARD_CONTROL_POPOVER_BORDER_COLOR"] = "dashboard-control-popover-border-color";
+    // These styles are applied to filter inputs inside the control popover
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_BACKGROUND"] = "dashboard-filter-input-background";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_RADIUS"] = "dashboard-filter-input-radius";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_BORDER_COLOR"] = "dashboard-filter-input-border-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_TEXT_COLOR"] = "dashboard-filter-input-text-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_PLACEHOLDER_COLOR"] = "dashboard-filter-input-placeholder-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_ICON_COLOR"] = "dashboard-filter-input-icon-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_OUTLINE_COLOR"] = "dashboard-filter-input-outline-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_ACCENT_COLOR"] = "dashboard-filter-input-accent-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_ACCENT_INVERT_COLOR"] = "dashboard-filter-input-accent-invert-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_TOKEN_COLOR"] = "dashboard-filter-input-token-color";
+    CustomThemeProperty["DASHBOARD_FILTER_INPUT_TOKEN_TEXT_COLOR"] = "dashboard-filter-input-token-text-color";
+})(CustomThemeProperty || (exports.CustomThemeProperty = CustomThemeProperty = {}));
+var EmbeddedContent;
+(function (EmbeddedContent) {
+    EmbeddedContent["Dashboard"] = "dashboards";
+    EmbeddedContent["Workbook"] = "w";
+})(EmbeddedContent || (exports.EmbeddedContent = EmbeddedContent = {}));
+var EmbedConnectionRoles;
+(function (EmbedConnectionRoles) {
+    EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
+    EmbedConnectionRoles["VIEWER"] = "VIEWER";
+    EmbedConnectionRoles["QUERIER"] = "QUERIER";
+})(EmbedConnectionRoles || (exports.EmbedConnectionRoles = EmbedConnectionRoles = {}));
+/**
+ * Levels of access a user can have to their associated embed entity folder.
+ */
+var EmbedEntityFolderContentRoles;
+(function (EmbedEntityFolderContentRoles) {
+    EmbedEntityFolderContentRoles["MANAGER"] = "MANAGER";
+    EmbedEntityFolderContentRoles["EDITOR"] = "EDITOR";
+    EmbedEntityFolderContentRoles["VIEWER"] = "VIEWER";
+    EmbedEntityFolderContentRoles["NO_ACCESS"] = "NO_ACCESS";
+})(EmbedEntityFolderContentRoles || (exports.EmbedEntityFolderContentRoles = EmbedEntityFolderContentRoles = {}));
+/**
+ * UI settings used as keys of the uiSettings sso embed parameter.
+ */
+var EmbedUiSettings;
+(function (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.
+     */
+    EmbedUiSettings["SHOW_NAVIGATION"] = "showNavigation";
+})(EmbedUiSettings || (exports.EmbedUiSettings = EmbedUiSettings = {}));

package/lib/cjs/embed.d.ts

@@ -1,4 +1,4 @@
-import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbookProps, CreateSessionTokenProps, RedeemSessionTokenProps } from "./types";
+import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbookProps, CreateSessionTokenProps, RedeemSessionTokenProps } from "./types.js";
 export declare const embedSsoDashboard: (props: EmbedSsoDashboardProps) => Promise<string>;
 export declare const embedSsoWorkbook: (props: EmbedSsoWorkbookProps) => Promise<string>;
 /**

package/lib/cjs/embed.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.redeemSessionToken = exports.createSessionToken = exports.embedSsoContentDiscovery = exports.embedSsoWorkbook = exports.embedSsoDashboard = void 0;
-const random_str_1 = require("./random-str");
-const signature_1 = require("./signature");
-const types_1 = require("./types");
+const random_str_js_1 = require("./random-str.js");
+const signature_js_1 = require("./signature.js");
+const constants_js_1 = require("./constants.js");
 const defaultEmbedDomain = "embed-omniapp.co";
 const embedLoginPath = "/embed/login";
 const generateSsoEmbedSessionPath = "/api/unstable/embed/sso/generate-session";
@@ -18,7 +18,7 @@ const createEmbedRequestUrl = (props) => {
     }
     // Generate the url for the embed login route
     if (!host)
-        host = `${organizationName}.${domain !== null && domain !== void 0 ? domain : defaultEmbedDomain}`;
+        host = `${organizationName}.${domain ?? defaultEmbedDomain}`;
     const url = new URL(props.requestPath, `https://${host}${props.port ? `:${props.port}` : ""}`);
     return url;
 };
@@ -54,14 +54,15 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, name, nonce, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
+    let { accessBoost, 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;
     // Handle defaults
-    nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
+    nonce = nonce ?? (await (0, random_str_js_1.random32ByteString)());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     const customTheme = rawCustomTheme && JSON.stringify(rawCustomTheme);
     const connectionRoles = rawConnectionRoles && JSON.stringify(rawConnectionRoles);
     const groups = rawGroups && JSON.stringify(rawGroups);
+    const modelRoles = rawModelRoles && JSON.stringify(rawModelRoles);
     const url = createEmbedRequestUrl({
         domain,
         host,
@@ -70,7 +71,7 @@ const embedSsoContent = async (props) => {
         requestPath: embedLoginPath,
     });
     // Get a signature for the request
-    const signature = (0, signature_1.getSignature)({
+    const signature = (0, signature_js_1.getSignature)({
         // Required parameters
         loginUrl: url.toString(),
         contentPath,
@@ -93,6 +94,7 @@ const embedSsoContent = async (props) => {
         groups,
         linkAccess,
         mode,
+        modelRoles,
         prefersDark,
         preserveEntityFolderContentRole,
         theme,
@@ -119,6 +121,7 @@ const embedSsoContent = async (props) => {
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
     mode && url.searchParams.append("mode", mode);
+    modelRoles && url.searchParams.append("modelRoles", modelRoles);
     entityFolderContentRole &&
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
     entityFolderGroupContentRole &&
@@ -136,12 +139,12 @@ const embedSsoContent = async (props) => {
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
 const embedSsoDashboard = async (props) => {
-    const contentPath = buildContentPath(types_1.EmbeddedContent.Dashboard, props.contentId);
+    const contentPath = buildContentPath(constants_js_1.EmbeddedContent.Dashboard, props.contentId);
     return embedSsoContent({ ...props, contentPath });
 };
 exports.embedSsoDashboard = embedSsoDashboard;
 const embedSsoWorkbook = async (props) => {
-    const contentPath = `${buildContentPath(types_1.EmbeddedContent.Workbook, props.contentId)}/duplicate`;
+    const contentPath = `${buildContentPath(constants_js_1.EmbeddedContent.Workbook, props.contentId)}/duplicate`;
     return embedSsoContent({ ...props, contentPath });
 };
 exports.embedSsoWorkbook = embedSsoWorkbook;
@@ -194,7 +197,7 @@ const createSessionToken = async ({ apiKey, domain, host, organizationName, port
             error: `Failed to generate embed session: ${fetchResponse.statusText}`,
             success: false,
         };
-    const fetchData = await fetchResponse.json();
+    const fetchData = (await fetchResponse.json());
     if (!fetchData.sessionId)
         return { error: "No session ID returned from endpoint.", success: false };
     return { sessionToken: fetchData.sessionId, success: true };
@@ -214,8 +217,8 @@ theme, }) => {
         port,
         requestPath: redeemSsoEmbedSessionPath,
     });
-    const nonce = propsNonce !== null && propsNonce !== void 0 ? propsNonce : (await (0, random_str_1.random32ByteString)());
-    const signature = (0, signature_1.signSessionRedemption)({
+    const nonce = propsNonce ?? (await (0, random_str_js_1.random32ByteString)());
+    const signature = (0, signature_js_1.signSessionRedemption)({
         requestUrl: redeemRequestUrl.toString(),
         nonce,
         prefersDark,

package/lib/cjs/index.d.ts

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

package/lib/cjs/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./embed"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./signature"), exports);
+__exportStar(require("./embed.js"), exports);
+__exportStar(require("./types.js"), exports);
+__exportStar(require("./signature.js"), exports);
+__exportStar(require("./constants.js"), exports);

package/lib/cjs/omni_internal_browser.d.ts

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

package/lib/cjs/omni_internal_browser.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Client / browser entrypoint for the Omni Embed SDK.
+ */
+__exportStar(require("./constants.js"), exports);

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{"type": "commonjs"}

package/lib/cjs/signature.d.ts

@@ -86,6 +86,10 @@ type SignatureProps = {
      * The mode of the embedded content.
      */
     mode?: string;
+    /**
+     * The model roles to be associated with the embed user. Expected to be a stringified JSON object.
+     */
+    modelRoles?: string;
     /**
      * Whether the user prefers light, dark, or system theme.
      */
@@ -131,6 +135,6 @@ type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" |
  */
 export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: SignSessionRedemptionProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -5,19 +5,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TEST_ONLY = exports.signSessionRedemption = exports.getSignature = exports.hmacSign = void 0;
 const crypto_1 = __importDefault(require("crypto"));
-const base64url_1 = __importDefault(require("base64url"));
 const hmacSign = (data, secret) => {
     const hmac = crypto_1.default.createHmac("sha256", secret);
     hmac.update(data);
     const b64 = hmac.digest("base64");
-    return base64url_1.default.fromBase64(b64);
+    return Buffer.from(b64, "base64").toString("base64url");
 };
 exports.hmacSign = hmacSign;
 const generateStringForSignature = ({ 
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, 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 = {
@@ -35,6 +34,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
+        ...(modelRoles && { modelRoles }),
         ...(prefersDark && { prefersDark }),
         ...(preserveEntityFolderContentRole !== undefined && {
             preserveEntityFolderContentRole: preserveEntityFolderContentRole.toString(),

package/lib/cjs/types.d.ts

@@ -1,8 +1,5 @@
+import { CustomThemeProperty, EmbedConnectionRoles, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
 type UserAttributeValue = string | string[] | number | number[];
-export declare enum EmbedSessionMode {
-    Application = "APPLICATION",
-    SingleContent = "SINGLE_CONTENT"
-}
 type HostProps = {
     host?: never;
     /**
@@ -47,6 +44,11 @@ type EmbedSsoBaseProps = {
      * Object values should be connection roles.
      */
     connectionRoles?: Record<string, EmbedConnectionRoles>;
+    /**
+     * Optional model roles setting. Object keys should be model IDs from the embedded Omni instance.
+     * Object values should be connection roles.
+     */
+    modelRoles?: Record<string, EmbedConnectionRoles>;
     /**
      * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
      *
@@ -118,56 +120,6 @@ type EmbedContentIdProp = {
 type EmbedContentPathProp = {
     contentPath: string;
 };
-export declare enum CustomThemeProperty {
-    DASHBOARD_BACKGROUND = "dashboard-background",
-    DASHBOARD_PAGE_PADDING = "dashboard-page-padding",
-    DASHBOARD_TILE_MARGIN = "dashboard-tile-margin",
-    DASHBOARD_TILE_BACKGROUND = "dashboard-tile-background",
-    DASHBOARD_TILE_SHADOW = "dashboard-tile-shadow",
-    DASHBOARD_TILE_TEXT_BODY_COLOR = "dashboard-tile-text-body-color",
-    DASHBOARD_TILE_TEXT_SECONDARY_COLOR = "dashboard-tile-text-secondary-color",
-    DASHBOARD_TILE_BORDER_COLOR = "dashboard-tile-border-color",
-    DASHBOARD_TILE_BORDER_RADIUS = "dashboard-tile-border-radius",
-    DASHBOARD_TILE_BORDER_STYLE = "dashboard-tile-border-style",
-    DASHBOARD_TILE_BORDER_WIDTH = "dashboard-tile-border-width",
-    DASHBOARD_TILE_TITLE_FONT_SIZE = "dashboard-tile-title-font-size",
-    DASHBOARD_TILE_TITLE_FONT_WEIGHT = "dashboard-tile-title-font-weight",
-    DASHBOARD_TILE_TITLE_TEXT_COLOR = "dashboard-tile-title-text-color",
-    DASHBOARD_TILE_TITLE_FONT_FAMILY = "dashboard-tile-title-font-family",
-    DASHBOARD_TILE_TEXT_BODY_FONT_FAMILY = "dashboard-tile-text-body-font-family",
-    DASHBOARD_TILE_TEXT_CODE_FONT_FAMILY = "dashboard-tile-text-code-font-family",
-    DASHBOARD_KEY_COLOR = "dashboard-key-color",
-    DASHBOARD_KEY_TEXT_COLOR = "dashboard-key-text-color",
-    DASHBOARD_BUTTON_RADIUS = "dashboard-button-radius",
-    DASHBOARD_BUTTON_TRANSPARENT_TEXT_COLOR = "dashboard-button-transparent-text-color",
-    DASHBOARD_BUTTON_TRANSPARENT_INTERACTIVE_COLOR = "dashboard-button-transparent-interactive-color",
-    DASHBOARD_MENU_ITEM_INTERACTIVE_COLOR = "dashboard-menu-item-interactive-color",
-    DASHBOARD_CONTROL_BACKGROUND = "dashboard-control-background",
-    DASHBOARD_CONTROL_RADIUS = "dashboard-control-radius",
-    DASHBOARD_CONTROL_BORDER_COLOR = "dashboard-control-border-color",
-    DASHBOARD_CONTROL_TEXT_COLOR = "dashboard-control-text-color",
-    DASHBOARD_CONTROL_PLACEHOLDER_COLOR = "dashboard-control-placeholder-color",
-    DASHBOARD_CONTROL_LABEL_COLOR = "dashboard-control-label-color",
-    DASHBOARD_CONTROL_OUTLINE_COLOR = "dashboard-control-outline-color",
-    DASHBOARD_CONTROL_POPOVER_BACKGROUND = "dashboard-control-popover-background",
-    DASHBOARD_CONTROL_POPOVER_TEXT_COLOR = "dashboard-control-popover-text-color",
-    DASHBOARD_CONTROL_POPOVER_SECONDARY_TEXT_COLOR = "dashboard-control-popover-secondary-text-color",
-    DASHBOARD_CONTROL_POPOVER_LINK_COLOR = "dashboard-control-popover-link-color",
-    DASHBOARD_CONTROL_POPOVER_DIVIDER_COLOR = "dashboard-control-popover-divider-color",
-    DASHBOARD_CONTROL_POPOVER_RADIUS = "dashboard-control-popover-radius",
-    DASHBOARD_CONTROL_POPOVER_BORDER_COLOR = "dashboard-control-popover-border-color",
-    DASHBOARD_FILTER_INPUT_BACKGROUND = "dashboard-filter-input-background",
-    DASHBOARD_FILTER_INPUT_RADIUS = "dashboard-filter-input-radius",
-    DASHBOARD_FILTER_INPUT_BORDER_COLOR = "dashboard-filter-input-border-color",
-    DASHBOARD_FILTER_INPUT_TEXT_COLOR = "dashboard-filter-input-text-color",
-    DASHBOARD_FILTER_INPUT_PLACEHOLDER_COLOR = "dashboard-filter-input-placeholder-color",
-    DASHBOARD_FILTER_INPUT_ICON_COLOR = "dashboard-filter-input-icon-color",
-    DASHBOARD_FILTER_INPUT_OUTLINE_COLOR = "dashboard-filter-input-outline-color",
-    DASHBOARD_FILTER_INPUT_ACCENT_COLOR = "dashboard-filter-input-accent-color",
-    DASHBOARD_FILTER_INPUT_ACCENT_INVERT_COLOR = "dashboard-filter-input-accent-invert-color",
-    DASHBOARD_FILTER_INPUT_TOKEN_COLOR = "dashboard-filter-input-token-color",
-    DASHBOARD_FILTER_INPUT_TOKEN_TEXT_COLOR = "dashboard-filter-input-token-text-color"
-}
 export type CustomThemeProperties = {
     [CustomThemeProperty.DASHBOARD_BACKGROUND]?: string;
     [CustomThemeProperty.DASHBOARD_PAGE_PADDING]?: string;
@@ -219,34 +171,6 @@ export type CustomThemeProperties = {
     [CustomThemeProperty.DASHBOARD_FILTER_INPUT_TOKEN_TEXT_COLOR]?: string;
     [CustomThemeProperty.DASHBOARD_BUTTON_RADIUS]?: string;
 };
-export declare enum EmbeddedContent {
-    Dashboard = "dashboards",
-    Workbook = "w"
-}
-export declare enum EmbedConnectionRoles {
-    RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
-    VIEWER = "VIEWER",
-    QUERIER = "QUERIER"
-}
-/**
- * Levels of access a user can have to their associated embed entity folder.
- */
-export declare enum EmbedEntityFolderContentRoles {
-    MANAGER = "MANAGER",
-    EDITOR = "EDITOR",
-    VIEWER = "VIEWER",
-    NO_ACCESS = "NO_ACCESS"
-}
-/**
- * UI settings used as keys of the uiSettings sso embed parameter.
- */
-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"
-}
 export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
 /**
  * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.
@@ -254,16 +178,23 @@ export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProp
 export type EmbedSsoDashboardProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentIdProp;
 export type EmbedSsoWorkbookProps = EmbedSsoBaseProps & EmbedContentIdProp;
 export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: string;
+} & ({
     /**
      * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
      * Object values should be connection roles.
      */
     connectionRoles: Record<string, EmbedConnectionRoles>;
+} | {
     /**
-     * Path name of the content discovery page to embed.
+     * Required model roles object. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles.
      */
-    path: string;
-};
+    modelRoles: Record<string, EmbedConnectionRoles>;
+});
 export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, "prefersDark" | "theme" | "secret" | "nonce"> & {
     apiKey: string;
 } & HostProps;