@omni-co/embed 0.3.19 → 0.3.20

package/lib/cjs/embed.js

@@ -31,7 +31,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, mode, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -57,6 +57,7 @@ const embedSsoContent = async (props) => {
         customTheme,
         connectionRoles,
         accessBoost,
+        mode,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -75,6 +76,7 @@ const embedSsoContent = async (props) => {
     customTheme && url.searchParams.append("customTheme", customTheme);
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
+    mode && url.searchParams.append("mode", mode);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/cjs/signature.d.ts

@@ -55,6 +55,10 @@ type SignatureProps = {
      * String denoting level of link access.
      */
     linkAccess?: string;
+    /**
+     * The mode of the embedded content.
+     */
+    mode?: string;
     /**
      * Whether the user prefers light, dark, or system theme.
      */
@@ -72,6 +76,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, 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
-connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }) => {
+accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, 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 @@ connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark
         ...(entity && { entity }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(linkAccess && { linkAccess }),
+        ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),
         ...(theme && { theme }),
         ...(userAttributes && { userAttributes }),

package/lib/cjs/types.d.ts

@@ -1,4 +1,8 @@
 type UserAttributeValue = string | string[] | number | number[];
+export declare enum EmbedSessionMode {
+    Application = "APPLICATION",
+    SingleContent = "SINGLE_CONTENT"
+}
 type EmbedSsoBaseProps = {
     externalId: string;
     name: string;
@@ -8,6 +12,17 @@ type EmbedSsoBaseProps = {
     userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    /**
+     * Optional connection roles setting. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles. At the moment, the only valid role string is "RESTRICTED_QUERIER".
+     */
+    connectionRoles?: Record<string, EmbedConnectionRoles>;
+    /**
+     * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
+     * If EmbedSessionMode.Application is selected, the entire application will be embedded. If EmbedSessionMode.SingleContent is selected,
+     * only the content specified in the contentId will be embedded.
+     */
+    mode?: EmbedSessionMode;
     domain?: string;
     nonce?: string;
     port?: number;
@@ -24,9 +39,6 @@ type EmbedContentIdProp = {
 type EmbedContentPathProp = {
     contentPath: string;
 };
-type EmbedConnectionRolesProp = {
-    connectionRoles: Record<string, EmbedConnectionRoles>;
-};
 export declare enum CustomThemeProperty {
     DASHBOARD_BACKGROUND = "dashboard-background",
     DASHBOARD_TILE_BACKGROUND = "dashboard-tile-background",
@@ -76,13 +88,18 @@ export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths
 export declare enum EmbedConnectionRoles {
     RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
 }
-export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp & Partial<EmbedConnectionRolesProp>;
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
 /**
  * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.
  */
 export type EmbedSsoDashboardProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentIdProp;
 export type EmbedSsoWorkbookProps = EmbedSsoBaseProps & EmbedContentIdProp;
-export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & EmbedConnectionRolesProp & {
+export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
+    /**
+     * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles. At the moment, the only valid role string is "RESTRICTED_QUERIER".
+     */
+    connectionRoles: Record<string, EmbedConnectionRoles>;
     /**
      * Path name of the content discovery page to embed.
      */

package/lib/cjs/types.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = exports.CustomThemeProperty = void 0;
+exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = 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";

package/lib/esm/embed.js

@@ -28,7 +28,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, mode, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -54,6 +54,7 @@ const embedSsoContent = async (props) => {
         customTheme,
         connectionRoles,
         accessBoost,
+        mode,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -72,6 +73,7 @@ const embedSsoContent = async (props) => {
     customTheme && url.searchParams.append("customTheme", customTheme);
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
+    mode && url.searchParams.append("mode", mode);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/esm/signature.d.ts

@@ -55,6 +55,10 @@ type SignatureProps = {
      * String denoting level of link access.
      */
     linkAccess?: string;
+    /**
+     * The mode of the embedded content.
+     */
+    mode?: string;
     /**
      * Whether the user prefers light, dark, or system theme.
      */
@@ -72,6 +76,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, 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
-connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }) => {
+accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, 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 = {
@@ -20,6 +20,7 @@ connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark
         ...(entity && { entity }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(linkAccess && { linkAccess }),
+        ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),
         ...(theme && { theme }),
         ...(userAttributes && { userAttributes }),

package/lib/esm/types.d.ts

@@ -1,4 +1,8 @@
 type UserAttributeValue = string | string[] | number | number[];
+export declare enum EmbedSessionMode {
+    Application = "APPLICATION",
+    SingleContent = "SINGLE_CONTENT"
+}
 type EmbedSsoBaseProps = {
     externalId: string;
     name: string;
@@ -8,6 +12,17 @@ type EmbedSsoBaseProps = {
     userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    /**
+     * Optional connection roles setting. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles. At the moment, the only valid role string is "RESTRICTED_QUERIER".
+     */
+    connectionRoles?: Record<string, EmbedConnectionRoles>;
+    /**
+     * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
+     * If EmbedSessionMode.Application is selected, the entire application will be embedded. If EmbedSessionMode.SingleContent is selected,
+     * only the content specified in the contentId will be embedded.
+     */
+    mode?: EmbedSessionMode;
     domain?: string;
     nonce?: string;
     port?: number;
@@ -24,9 +39,6 @@ type EmbedContentIdProp = {
 type EmbedContentPathProp = {
     contentPath: string;
 };
-type EmbedConnectionRolesProp = {
-    connectionRoles: Record<string, EmbedConnectionRoles>;
-};
 export declare enum CustomThemeProperty {
     DASHBOARD_BACKGROUND = "dashboard-background",
     DASHBOARD_TILE_BACKGROUND = "dashboard-tile-background",
@@ -76,13 +88,18 @@ export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths
 export declare enum EmbedConnectionRoles {
     RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
 }
-export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp & Partial<EmbedConnectionRolesProp>;
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
 /**
  * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.
  */
 export type EmbedSsoDashboardProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentIdProp;
 export type EmbedSsoWorkbookProps = EmbedSsoBaseProps & EmbedContentIdProp;
-export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & EmbedConnectionRolesProp & {
+export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
+    /**
+     * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles. At the moment, the only valid role string is "RESTRICTED_QUERIER".
+     */
+    connectionRoles: Record<string, EmbedConnectionRoles>;
     /**
      * Path name of the content discovery page to embed.
      */

package/lib/esm/types.js

@@ -1,3 +1,8 @@
+export var EmbedSessionMode;
+(function (EmbedSessionMode) {
+    EmbedSessionMode["Application"] = "APPLICATION";
+    EmbedSessionMode["SingleContent"] = "SINGLE_CONTENT";
+})(EmbedSessionMode || (EmbedSessionMode = {}));
 export var CustomThemeProperty;
 (function (CustomThemeProperty) {
     CustomThemeProperty["DASHBOARD_BACKGROUND"] = "dashboard-background";

package/package.json

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