@omni-co/embed 0.11.0 → 0.12.2

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;
 
@@ -280,14 +295,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;
@@ -393,14 +423,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;
@@ -522,14 +567,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;
 

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, 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, 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);
@@ -86,6 +86,7 @@ const embedSsoContent = async (props) => {
         email,
         entity,
         entityFolderContentRole,
+        entityFolderGroupContentRole,
         entityFolderLabel,
         entityGroupLabel,
         filterSearchParam,
@@ -119,6 +120,8 @@ const embedSsoContent = async (props) => {
     mode && url.searchParams.append("mode", mode);
     entityFolderContentRole &&
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
+    entityFolderGroupContentRole &&
+        url.searchParams.append("entityFolderGroupContentRole", entityFolderGroupContentRole);
     groups && url.searchParams.append("groups", groups);
     email && url.searchParams.append("email", email);
     uiSettings && url.searchParams.append("uiSettings", uiSettings);

package/lib/cjs/signature.d.ts

@@ -58,6 +58,10 @@ type SignatureProps = {
      * The content role for the embed user on the entity folder.
      */
     entityFolderContentRole?: string;
+    /**
+     * The content role for the entity group on the entity folder.
+     */
+    entityFolderGroupContentRole?: string;
     /**
      * The label for the generated entity folder.
      */
@@ -121,6 +125,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, 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, 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, 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, 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,6 +28,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(email && { email }),
         ...(entity && { entity }),
         ...(entityFolderContentRole && { entityFolderContentRole }),
+        ...(entityFolderGroupContentRole && { entityFolderGroupContentRole }),
         ...(entityFolderLabel && { entityFolderLabel }),
         ...(entityGroupLabel && { entityGroupLabel }),
         ...(filterSearchParam && { filterSearchParam }),

package/lib/cjs/types.d.ts

@@ -55,15 +55,30 @@ type EmbedSsoBaseProps = {
      */
     mode?: EmbedSessionMode;
     /**
-     * Optional content role setting. Can be one of "MANAGER", "EDITOR", or "VIEWER".
+     * Optional content role setting for the embed user 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 not have access to the entity folder. Note that the group content role must
+     * also be set to NO_ACCESS for the user to not have access to the entity folder.
      */
     entityFolderContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * Optional content role setting for the entity group on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER", or "NO_ACCESS".
+     *
+     * MANAGER: all entity group embed users will have the ability to manage content and content permissions of the entity folder.
+     *
+     * EDITOR: all entity group embed users will have the ability to manage content in the entity folder.
+     *
+     * VIEWER: all entity group embed users will only be able to view content in the entity folder.
+     *
+     * NO_ACCESS: all entity group embed users will not have access to the entity folder.
+     */
+    entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
     /**
      * 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.
@@ -213,7 +228,8 @@ export declare enum EmbedConnectionRoles {
 export declare enum EmbedEntityFolderContentRoles {
     MANAGER = "MANAGER",
     EDITOR = "EDITOR",
-    VIEWER = "VIEWER"
+    VIEWER = "VIEWER",
+    NO_ACCESS = "NO_ACCESS"
 }
 /**
  * UI settings used as keys of the uiSettings sso embed parameter.

package/lib/cjs/types.js

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

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, 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, 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);
@@ -83,6 +83,7 @@ const embedSsoContent = async (props) => {
         email,
         entity,
         entityFolderContentRole,
+        entityFolderGroupContentRole,
         entityFolderLabel,
         entityGroupLabel,
         filterSearchParam,
@@ -116,6 +117,8 @@ const embedSsoContent = async (props) => {
     mode && url.searchParams.append("mode", mode);
     entityFolderContentRole &&
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
+    entityFolderGroupContentRole &&
+        url.searchParams.append("entityFolderGroupContentRole", entityFolderGroupContentRole);
     groups && url.searchParams.append("groups", groups);
     email && url.searchParams.append("email", email);
     uiSettings && url.searchParams.append("uiSettings", uiSettings);

package/lib/esm/signature.d.ts

@@ -58,6 +58,10 @@ type SignatureProps = {
      * The content role for the embed user on the entity folder.
      */
     entityFolderContentRole?: string;
+    /**
+     * The content role for the entity group on the entity folder.
+     */
+    entityFolderGroupContentRole?: string;
     /**
      * The label for the generated entity folder.
      */
@@ -121,6 +125,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, 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, 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, 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, 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 = {
@@ -21,6 +21,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(email && { email }),
         ...(entity && { entity }),
         ...(entityFolderContentRole && { entityFolderContentRole }),
+        ...(entityFolderGroupContentRole && { entityFolderGroupContentRole }),
         ...(entityFolderLabel && { entityFolderLabel }),
         ...(entityGroupLabel && { entityGroupLabel }),
         ...(filterSearchParam && { filterSearchParam }),

package/lib/esm/types.d.ts

@@ -55,15 +55,30 @@ type EmbedSsoBaseProps = {
      */
     mode?: EmbedSessionMode;
     /**
-     * Optional content role setting. Can be one of "MANAGER", "EDITOR", or "VIEWER".
+     * Optional content role setting for the embed user 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 not have access to the entity folder. Note that the group content role must
+     * also be set to NO_ACCESS for the user to not have access to the entity folder.
      */
     entityFolderContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * Optional content role setting for the entity group on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER", or "NO_ACCESS".
+     *
+     * MANAGER: all entity group embed users will have the ability to manage content and content permissions of the entity folder.
+     *
+     * EDITOR: all entity group embed users will have the ability to manage content in the entity folder.
+     *
+     * VIEWER: all entity group embed users will only be able to view content in the entity folder.
+     *
+     * NO_ACCESS: all entity group embed users will not have access to the entity folder.
+     */
+    entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
     /**
      * 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.
@@ -213,7 +228,8 @@ export declare enum EmbedConnectionRoles {
 export declare enum EmbedEntityFolderContentRoles {
     MANAGER = "MANAGER",
     EDITOR = "EDITOR",
-    VIEWER = "VIEWER"
+    VIEWER = "VIEWER",
+    NO_ACCESS = "NO_ACCESS"
 }
 /**
  * UI settings used as keys of the uiSettings sso embed parameter.

package/lib/esm/types.js

@@ -79,6 +79,7 @@ export var EmbedEntityFolderContentRoles;
     EmbedEntityFolderContentRoles["MANAGER"] = "MANAGER";
     EmbedEntityFolderContentRoles["EDITOR"] = "EDITOR";
     EmbedEntityFolderContentRoles["VIEWER"] = "VIEWER";
+    EmbedEntityFolderContentRoles["NO_ACCESS"] = "NO_ACCESS";
 })(EmbedEntityFolderContentRoles || (EmbedEntityFolderContentRoles = {}));
 /**
  * UI settings used as keys of the uiSettings sso embed parameter.

package/package.json

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