@omni-co/embed 0.7.0 → 0.8.0

package/lib/cjs/embed.js

@@ -23,7 +23,7 @@ const createEmbedRequestUrl = (props) => {
     return url;
 };
 const validateProps = (props) => {
-    const { externalId, name, nonce, secret, userAttributes, customTheme, customThemeId, } = props;
+    const { externalId, name, nonce, secret, uiSettings, userAttributes, customTheme, customThemeId, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -47,14 +47,17 @@ const validateProps = (props) => {
         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");
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, externalId, filterSearchParam, host, linkAccess, mode, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, externalId, filterSearchParam, host, linkAccess, mode, name, nonce, organizationName, port, secret, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_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);
@@ -89,6 +92,7 @@ const embedSsoContent = async (props) => {
         mode,
         prefersDark,
         theme,
+        uiSettings,
         userAttributes,
     });
     // Build and return the signed url
@@ -115,6 +119,7 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
     groups && url.searchParams.append("groups", groups);
     email && url.searchParams.append("email", email);
+    uiSettings && url.searchParams.append("uiSettings", uiSettings);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/cjs/signature.d.ts

@@ -82,6 +82,10 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * The UI settings for the embedded content.
+     */
+    uiSettings?: string;
     /**
      * The user attributes to be sent with the request. Expected to be a stringified JSON object.
      *
@@ -106,7 +110,7 @@ type GenerateSessionSignatureProps = Omit<SignatureProps, "loginUrl" | "prefersD
  * validated by the Omni app server to ensure the request is authentic.
  */
 export declare const signSessionRequest: ({ requestUrl, secret, ...props }: GenerateSessionSignatureProps) => string;
-type UseSessionSignatureProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
+type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
     sessionId: string;
 };
 /**
@@ -117,8 +121,8 @@ type UseSessionSignatureProps = Pick<SignatureProps, "nonce" | "prefersDark" | "
  * that is generated based on all other request parameters. That signature is
  * validated by the Omni app server to ensure the request is authentic.
  */
-export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: UseSessionSignatureProps) => string;
+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, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -17,7 +17,7 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, linkAccess, mode, prefersDark, 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 = {
@@ -34,6 +34,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),
         ...(theme && { theme }),
+        ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),
     };
     const optionalParams = Object.keys(optionalParamsMap)

package/lib/cjs/types.d.ts

@@ -72,6 +72,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
+    uiSettings?: Record<EmbedUiSettings, boolean>;
     nonce?: string;
     port?: number;
 } & HostProps;
@@ -202,6 +203,16 @@ export declare enum EmbedEntityFolderContentRoles {
     EDITOR = "EDITOR",
     VIEWER = "VIEWER"
 }
+/**
+ * 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.

package/lib/cjs/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
+exports.EmbedUiSettings = exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
 var EmbedSessionMode;
 (function (EmbedSessionMode) {
     EmbedSessionMode["Application"] = "APPLICATION";
@@ -83,3 +83,14 @@ var EmbedEntityFolderContentRoles;
     EmbedEntityFolderContentRoles["EDITOR"] = "EDITOR";
     EmbedEntityFolderContentRoles["VIEWER"] = "VIEWER";
 })(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/esm/embed.js

@@ -20,7 +20,7 @@ const createEmbedRequestUrl = (props) => {
     return url;
 };
 const validateProps = (props) => {
-    const { externalId, name, nonce, secret, userAttributes, customTheme, customThemeId, } = props;
+    const { externalId, name, nonce, secret, uiSettings, userAttributes, customTheme, customThemeId, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -44,14 +44,17 @@ const validateProps = (props) => {
         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");
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, externalId, filterSearchParam, host, linkAccess, mode, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, externalId, filterSearchParam, host, linkAccess, mode, name, nonce, organizationName, port, secret, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await 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);
@@ -86,6 +89,7 @@ const embedSsoContent = async (props) => {
         mode,
         prefersDark,
         theme,
+        uiSettings,
         userAttributes,
     });
     // Build and return the signed url
@@ -112,6 +116,7 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
     groups && url.searchParams.append("groups", groups);
     email && url.searchParams.append("email", email);
+    uiSettings && url.searchParams.append("uiSettings", uiSettings);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/esm/signature.d.ts

@@ -82,6 +82,10 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * The UI settings for the embedded content.
+     */
+    uiSettings?: string;
     /**
      * The user attributes to be sent with the request. Expected to be a stringified JSON object.
      *
@@ -106,7 +110,7 @@ type GenerateSessionSignatureProps = Omit<SignatureProps, "loginUrl" | "prefersD
  * validated by the Omni app server to ensure the request is authentic.
  */
 export declare const signSessionRequest: ({ requestUrl, secret, ...props }: GenerateSessionSignatureProps) => string;
-type UseSessionSignatureProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
+type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
     sessionId: string;
 };
 /**
@@ -117,8 +121,8 @@ type UseSessionSignatureProps = Pick<SignatureProps, "nonce" | "prefersDark" | "
  * that is generated based on all other request parameters. That signature is
  * validated by the Omni app server to ensure the request is authentic.
  */
-export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: UseSessionSignatureProps) => string;
+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, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -10,7 +10,7 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, linkAccess, mode, prefersDark, 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 = {
@@ -27,6 +27,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),
         ...(theme && { theme }),
+        ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),
     };
     const optionalParams = Object.keys(optionalParamsMap)

package/lib/esm/types.d.ts

@@ -72,6 +72,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
+    uiSettings?: Record<EmbedUiSettings, boolean>;
     nonce?: string;
     port?: number;
 } & HostProps;
@@ -202,6 +203,16 @@ export declare enum EmbedEntityFolderContentRoles {
     EDITOR = "EDITOR",
     VIEWER = "VIEWER"
 }
+/**
+ * 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.

package/lib/esm/types.js

@@ -80,3 +80,14 @@ export var EmbedEntityFolderContentRoles;
     EmbedEntityFolderContentRoles["EDITOR"] = "EDITOR";
     EmbedEntityFolderContentRoles["VIEWER"] = "VIEWER";
 })(EmbedEntityFolderContentRoles || (EmbedEntityFolderContentRoles = {}));
+/**
+ * UI settings used as keys of the uiSettings sso embed parameter.
+ */
+export 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 || (EmbedUiSettings = {}));

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",