@omni-co/embed 0.12.2 → 0.14.0

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;
 
@@ -227,6 +230,13 @@ type EmbedSsoDashboardProps = {
   // Optional dark mode setting. Can be one of "true", "false", or "system".
   prefersDark?: string;
 
+  /**
+   * When true, an existing content role for the embed user on the entity folder will not be overwritten
+   * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+   * the `entityFolderContentRole` value will be applied.
+   */
+  preserveEntityFolderContentRole?: boolean;
+
   // Signing secret available to Omni admins.
   secret: string;
 
@@ -346,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;
 
@@ -363,6 +376,13 @@ type EmbedSsoWorkbookProps = {
   // Optional dark mode setting. Can be one of "true", "false", or "system".
   prefersDark?: string;
 
+  /**
+   * When true, an existing content role for the embed user on the entity folder will not be overwritten
+   * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+   * the `entityFolderContentRole` value will be applied.
+   */
+  preserveEntityFolderContentRole?: boolean;
+
   // Signing secret available to Omni admins.
   secret: string;
 
@@ -474,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;
 
@@ -501,6 +524,13 @@ type EmbedSsoContentDiscoveryProps = {
   // Optional dark mode setting. Can be one of "true", "false", or "system".
   prefersDark?: string;
 
+  /**
+   * When true, an existing content role for the embed user on the entity folder will not be overwritten
+   * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+   * the `entityFolderContentRole` value will be applied.
+   */
+  preserveEntityFolderContentRole?: boolean;
+
   // Signing secret available to Omni admins.
   secret: string;
 
@@ -634,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;
 
@@ -648,6 +681,13 @@ type CreateSessionTokenProps = {
   // Port of host.
   port?: number;
 
+  /**
+   * When true, an existing content role for the embed user on the entity folder will not be overwritten
+   * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+   * the `entityFolderContentRole` value will be applied.
+   */
+  preserveEntityFolderContentRole?: boolean;
+
   // Optional UI settings object to control appearance of embed experience.
   uiSettings?: Record<EmbedUiSettings, boolean>;
 

package/lib/cjs/embed.js

@@ -54,7 +54,7 @@ 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, 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)());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
@@ -62,6 +62,7 @@ const embedSsoContent = async (props) => {
     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,
@@ -93,7 +94,9 @@ const embedSsoContent = async (props) => {
         groups,
         linkAccess,
         mode,
+        modelRoles,
         prefersDark,
+        preserveEntityFolderContentRole,
         theme,
         uiSettings,
         userAttributes,
@@ -118,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 &&
@@ -129,6 +133,8 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("entityGroupLabel", entityGroupLabel);
     entityFolderLabel &&
         url.searchParams.append("entityFolderLabel", entityFolderLabel);
+    preserveEntityFolderContentRole !== undefined &&
+        url.searchParams.append("preserveEntityFolderContentRole", preserveEntityFolderContentRole.toString());
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/cjs/signature.d.ts

@@ -86,10 +86,20 @@ 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.
      */
     prefersDark?: string;
+    /**
+     * When true, the embed will not apply a custom theme to the embedded content.
+     * This is useful when the embed is used in a context where the custom theme
+     * is already applied, such as in an Omni app.
+     */
+    preserveEntityFolderContentRole?: boolean;
     /**
      * The theme of the embed.
      */
@@ -125,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, 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

@@ -17,7 +17,7 @@ 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, 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,7 +35,11 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
+        ...(modelRoles && { modelRoles }),
         ...(prefersDark && { prefersDark }),
+        ...(preserveEntityFolderContentRole !== undefined && {
+            preserveEntityFolderContentRole: preserveEntityFolderContentRole.toString(),
+        }),
         ...(theme && { theme }),
         ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),

package/lib/cjs/types.d.ts

@@ -47,6 +47,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.
      *
@@ -79,6 +84,12 @@ type EmbedSsoBaseProps = {
      * NO_ACCESS: all entity group embed users will not have access to the entity folder.
      */
     entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * When true, an existing content role for the embed user on the entity folder will not be overwritten
+     * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+     * the `entityFolderContentRole` value will be applied.
+     */
+    preserveEntityFolderContentRole?: boolean;
     /**
      * Optional setting that customizes the generated entity folder label. This only affects the entity folder
      * corresponding to the `entity` parameter value in the relevant generated SSO embed URL.
@@ -248,16 +259,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;

package/lib/esm/embed.js

@@ -51,7 +51,7 @@ 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, 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 random32ByteString());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
@@ -59,6 +59,7 @@ const embedSsoContent = async (props) => {
     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,
@@ -90,7 +91,9 @@ const embedSsoContent = async (props) => {
         groups,
         linkAccess,
         mode,
+        modelRoles,
         prefersDark,
+        preserveEntityFolderContentRole,
         theme,
         uiSettings,
         userAttributes,
@@ -115,6 +118,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 &&
@@ -126,6 +130,8 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("entityGroupLabel", entityGroupLabel);
     entityFolderLabel &&
         url.searchParams.append("entityFolderLabel", entityFolderLabel);
+    preserveEntityFolderContentRole !== undefined &&
+        url.searchParams.append("preserveEntityFolderContentRole", preserveEntityFolderContentRole.toString());
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/esm/signature.d.ts

@@ -86,10 +86,20 @@ 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.
      */
     prefersDark?: string;
+    /**
+     * When true, the embed will not apply a custom theme to the embedded content.
+     * This is useful when the embed is used in a context where the custom theme
+     * is already applied, such as in an Omni app.
+     */
+    preserveEntityFolderContentRole?: boolean;
     /**
      * The theme of the embed.
      */
@@ -125,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, 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/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, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, prefersDark, 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 = {
@@ -28,7 +28,11 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
+        ...(modelRoles && { modelRoles }),
         ...(prefersDark && { prefersDark }),
+        ...(preserveEntityFolderContentRole !== undefined && {
+            preserveEntityFolderContentRole: preserveEntityFolderContentRole.toString(),
+        }),
         ...(theme && { theme }),
         ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),

package/lib/esm/types.d.ts

@@ -47,6 +47,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.
      *
@@ -79,6 +84,12 @@ type EmbedSsoBaseProps = {
      * NO_ACCESS: all entity group embed users will not have access to the entity folder.
      */
     entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * When true, an existing content role for the embed user on the entity folder will not be overwritten
+     * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+     * the `entityFolderContentRole` value will be applied.
+     */
+    preserveEntityFolderContentRole?: boolean;
     /**
      * Optional setting that customizes the generated entity folder label. This only affects the entity folder
      * corresponding to the `entity` parameter value in the relevant generated SSO embed URL.
@@ -248,16 +259,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;

package/package.json

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