@omni-co/embed 0.4.4 → 0.4.6-alpha.1

package/lib/cjs/embed.js

@@ -36,7 +36,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, email, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -49,30 +49,35 @@ const embedSsoContent = async (props) => {
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     const customTheme = rawCustomTheme && JSON.stringify(rawCustomTheme);
     const connectionRoles = rawConnectionRoles && JSON.stringify(rawConnectionRoles);
+    const groups = rawGroups && JSON.stringify(rawGroups);
     // Generate the url for the embed login route
     if (!host)
         host = `${organizationName}.${domain !== null && domain !== void 0 ? domain : defaultEmbedDomain}`;
     const url = new URL(embedLoginPath, `https://${host}${port ? `:${port}` : ""}`);
     // Get a signature for the request
     const signature = (0, signature_1.getSignature)({
+        // Required parameters
         loginUrl: url.toString(),
         contentPath,
         externalId,
         name,
         nonce,
         secret,
-        userAttributes,
+        // Optional parameters
+        accessBoost,
+        connectionRoles,
+        customTheme,
+        customThemeId,
+        email,
         entity,
-        prefersDark,
-        theme,
+        entityFolderContentRole,
         filterSearchParam,
+        groups,
         linkAccess,
-        customTheme,
-        customThemeId,
-        connectionRoles,
-        accessBoost,
         mode,
-        entityFolderContentRole,
+        prefersDark,
+        theme,
+        userAttributes,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -95,6 +100,8 @@ const embedSsoContent = async (props) => {
     mode && url.searchParams.append("mode", mode);
     entityFolderContentRole &&
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
+    groups && url.searchParams.append("groups", groups);
+    email && url.searchParams.append("email", email);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/cjs/signature.d.ts

@@ -46,6 +46,10 @@ type SignatureProps = {
      * The custom theme id to be sent with the request. This Id refers to an Custom Theme created in the Omni App.
      */
     customThemeId?: string;
+    /**
+     * The email of the embed user.
+     */
+    email?: string;
     /**
      * An associated entity / group for the embed user.
      */
@@ -58,6 +62,10 @@ type SignatureProps = {
      * Filter search parameter.
      */
     filterSearchParam?: string;
+    /**
+     * Stringified string array of group names.
+     */
+    groups?: string;
     /**
      * String denoting level of link access.
      */
@@ -83,6 +91,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderContentRole, filterSearchParam, 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, 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, entity, entityFolderContentRole, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, 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 = {
@@ -25,9 +25,11 @@ accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderCo
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
         ...(customThemeId && { customThemeId }),
+        ...(email && { email }),
         ...(entity && { entity }),
         ...(entityFolderContentRole && { entityFolderContentRole }),
         ...(filterSearchParam && { filterSearchParam }),
+        ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),

package/lib/cjs/types.d.ts

@@ -28,6 +28,14 @@ type EmbedSsoBaseProps = {
      * their associated embed entity folder.
      */
     entityFolderContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * Optional groups setting. An array of group names that the user will be added to.
+     */
+    groups?: string[];
+    /**
+     * Optional email setting for the generated embed user.
+     */
+    email?: string;
     nonce?: string;
     port?: number;
 } & ({
@@ -119,7 +127,8 @@ export declare enum EmbeddedContent {
 export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
 export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
 export declare enum EmbedConnectionRoles {
-    RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
+    RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
+    VIEWER = "VIEWER"
 }
 /**
  * Levels of access a user can have to their associated embed entity folder.

package/lib/cjs/types.js

@@ -39,10 +39,8 @@ exports.EmbedSsoContentDiscoveryPaths = [
 ];
 var EmbedConnectionRoles;
 (function (EmbedConnectionRoles) {
-    // TODO: Eventually we'll want to add VIEWER. Currently though, since the sole use case of the
-    // connectionRoles parameter is personal content creation, I'm refraining from adding "VIEWER" to
-    // keep scope as limited as possible.
     EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
+    EmbedConnectionRoles["VIEWER"] = "VIEWER";
 })(EmbedConnectionRoles || (exports.EmbedConnectionRoles = EmbedConnectionRoles = {}));
 /**
  * Levels of access a user can have to their associated embed entity folder.

package/lib/esm/embed.js

@@ -33,7 +33,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, email, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -46,30 +46,35 @@ const embedSsoContent = async (props) => {
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     const customTheme = rawCustomTheme && JSON.stringify(rawCustomTheme);
     const connectionRoles = rawConnectionRoles && JSON.stringify(rawConnectionRoles);
+    const groups = rawGroups && JSON.stringify(rawGroups);
     // Generate the url for the embed login route
     if (!host)
         host = `${organizationName}.${domain !== null && domain !== void 0 ? domain : defaultEmbedDomain}`;
     const url = new URL(embedLoginPath, `https://${host}${port ? `:${port}` : ""}`);
     // Get a signature for the request
     const signature = getSignature({
+        // Required parameters
         loginUrl: url.toString(),
         contentPath,
         externalId,
         name,
         nonce,
         secret,
-        userAttributes,
+        // Optional parameters
+        accessBoost,
+        connectionRoles,
+        customTheme,
+        customThemeId,
+        email,
         entity,
-        prefersDark,
-        theme,
+        entityFolderContentRole,
         filterSearchParam,
+        groups,
         linkAccess,
-        customTheme,
-        customThemeId,
-        connectionRoles,
-        accessBoost,
         mode,
-        entityFolderContentRole,
+        prefersDark,
+        theme,
+        userAttributes,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -92,6 +97,8 @@ const embedSsoContent = async (props) => {
     mode && url.searchParams.append("mode", mode);
     entityFolderContentRole &&
         url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
+    groups && url.searchParams.append("groups", groups);
+    email && url.searchParams.append("email", email);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/esm/signature.d.ts

@@ -46,6 +46,10 @@ type SignatureProps = {
      * The custom theme id to be sent with the request. This Id refers to an Custom Theme created in the Omni App.
      */
     customThemeId?: string;
+    /**
+     * The email of the embed user.
+     */
+    email?: string;
     /**
      * An associated entity / group for the embed user.
      */
@@ -58,6 +62,10 @@ type SignatureProps = {
      * Filter search parameter.
      */
     filterSearchParam?: string;
+    /**
+     * Stringified string array of group names.
+     */
+    groups?: string;
     /**
      * String denoting level of link access.
      */
@@ -83,6 +91,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderContentRole, filterSearchParam, 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, 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, entity, entityFolderContentRole, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, filterSearchParam, groups, 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 = {
@@ -18,9 +18,11 @@ accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderCo
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
         ...(customThemeId && { customThemeId }),
+        ...(email && { email }),
         ...(entity && { entity }),
         ...(entityFolderContentRole && { entityFolderContentRole }),
         ...(filterSearchParam && { filterSearchParam }),
+        ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),
         ...(prefersDark && { prefersDark }),

package/lib/esm/types.d.ts

@@ -28,6 +28,14 @@ type EmbedSsoBaseProps = {
      * their associated embed entity folder.
      */
     entityFolderContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * Optional groups setting. An array of group names that the user will be added to.
+     */
+    groups?: string[];
+    /**
+     * Optional email setting for the generated embed user.
+     */
+    email?: string;
     nonce?: string;
     port?: number;
 } & ({
@@ -119,7 +127,8 @@ export declare enum EmbeddedContent {
 export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
 export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
 export declare enum EmbedConnectionRoles {
-    RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
+    RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
+    VIEWER = "VIEWER"
 }
 /**
  * Levels of access a user can have to their associated embed entity folder.

package/lib/esm/types.js

@@ -36,10 +36,8 @@ export const EmbedSsoContentDiscoveryPaths = [
 ];
 export var EmbedConnectionRoles;
 (function (EmbedConnectionRoles) {
-    // TODO: Eventually we'll want to add VIEWER. Currently though, since the sole use case of the
-    // connectionRoles parameter is personal content creation, I'm refraining from adding "VIEWER" to
-    // keep scope as limited as possible.
     EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
+    EmbedConnectionRoles["VIEWER"] = "VIEWER";
 })(EmbedConnectionRoles || (EmbedConnectionRoles = {}));
 /**
  * Levels of access a user can have to their associated embed entity folder.

package/package.json

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