@omni-co/embed 0.12.0 → 0.13.0

package/README.md

@@ -143,14 +143,29 @@ type EmbedSsoDashboardProps = {
   entity?: string;
 
   /**
-   * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
+   * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
    *
    * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
    * EDITOR: the user will have the ability to manage content in the entity folder.
    * VIEWER: the user will only be able to view content in the entity folder.
+   * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
+   *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
+   *  to the top-level entity folder.
    */
   entityFolderContentRole?: EmbedEntityFolderContentRoles;
 
+  /**
+   * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
+   *
+   * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
+   * EDITOR: all users in the group have the ability to manage content in the entity folder.
+   * VIEWER: all users in the group are restricted to just view content in the entity folder.
+   * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
+   */
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+
   // Required identifier to associate the external user with an automatically generated internal Omni user.
   externalId: string;
 
@@ -212,6 +227,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;
 
@@ -280,14 +302,29 @@ type EmbedSsoWorkbookProps = {
   entity?: string;
 
   /**
-   * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
+   * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
    *
    * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
    * EDITOR: the user will have the ability to manage content in the entity folder.
    * VIEWER: the user will only be able to view content in the entity folder.
+   * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
+   *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
+   *  to the top-level entity folder.
    */
   entityFolderContentRole?: EmbedEntityFolderContentRoles;
 
+  /**
+   * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
+   *
+   * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
+   * EDITOR: all users in the group have the ability to manage content in the entity folder.
+   * VIEWER: all users in the group are restricted to just view content in the entity folder.
+   * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
+   */
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+
   // Required identifier to associate the external user with an
   // automatically generated internal Omni user.
   externalId: string;
@@ -333,6 +370,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;
 
@@ -393,14 +437,29 @@ type EmbedSsoContentDiscoveryProps = {
   entity?: string;
 
   /**
-   * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
+   * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
    *
    * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
    * EDITOR: the user will have the ability to manage content in the entity folder.
    * VIEWER: the user will only be able to view content in the entity folder.
+   * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
+   *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
+   *  to the top-level entity folder.
    */
   entityFolderContentRole?: EmbedEntityFolderContentRoles;
 
+  /**
+   * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
+   *
+   * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
+   * EDITOR: all users in the group have the ability to manage content in the entity folder.
+   * VIEWER: all users in the group are restricted to just view content in the entity folder.
+   * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
+   */
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+
   // Required identifier to associate the external user with an
   // automatically generated internal Omni user.
   externalId: string;
@@ -456,6 +515,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;
 
@@ -522,14 +588,29 @@ type CreateSessionTokenProps = {
   entity?: string;
 
   /**
-   * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
+   * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
    *
    * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
    * EDITOR: the user will have the ability to manage content in the entity folder.
    * VIEWER: the user will only be able to view content in the entity folder.
+   * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
+   *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
+   *  to the top-level entity folder.
    */
   entityFolderContentRole?: EmbedEntityFolderContentRoles;
 
+  /**
+   * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
+   * or "NO_ACCESS".
+   *
+   * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
+   * EDITOR: all users in the group have the ability to manage content in the entity folder.
+   * VIEWER: all users in the group are restricted to just view content in the entity folder.
+   * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
+   */
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+
   // Required identifier to associate the external user with an automatically generated internal Omni user.
   externalId: string;
 
@@ -588,6 +669,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, 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);
@@ -94,6 +94,7 @@ const embedSsoContent = async (props) => {
         linkAccess,
         mode,
         prefersDark,
+        preserveEntityFolderContentRole,
         theme,
         uiSettings,
         userAttributes,
@@ -129,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/cjs/signature.d.ts

@@ -90,6 +90,12 @@ type SignatureProps = {
      * 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 +131,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, 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, 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 = {
@@ -36,6 +36,9 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),
+        ...(preserveEntityFolderContentRole !== undefined && {
+            preserveEntityFolderContentRole: preserveEntityFolderContentRole.toString(),
+        }),
         ...(theme && { theme }),
         ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),

package/lib/cjs/types.d.ts

@@ -79,6 +79,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.

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, 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);
@@ -91,6 +91,7 @@ const embedSsoContent = async (props) => {
         linkAccess,
         mode,
         prefersDark,
+        preserveEntityFolderContentRole,
         theme,
         uiSettings,
         userAttributes,
@@ -126,6 +127,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

@@ -90,6 +90,12 @@ type SignatureProps = {
      * 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 +131,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, 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, 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 = {
@@ -29,6 +29,9 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),
+        ...(preserveEntityFolderContentRole !== undefined && {
+            preserveEntityFolderContentRole: preserveEntityFolderContentRole.toString(),
+        }),
         ...(theme && { theme }),
         ...(uiSettings && { uiSettings }),
         ...(userAttributes && { userAttributes }),

package/lib/esm/types.d.ts

@@ -79,6 +79,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.

package/package.json

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