@omni-co/embed 0.4.1 → 0.4.3

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, } = 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 host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -72,6 +72,7 @@ const embedSsoContent = async (props) => {
         connectionRoles,
         accessBoost,
         mode,
+        entityFolderContentRole,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -92,6 +93,8 @@ const embedSsoContent = async (props) => {
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
     mode && url.searchParams.append("mode", mode);
+    entityFolderContentRole &&
+        url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/cjs/signature.d.ts

@@ -47,10 +47,13 @@ type SignatureProps = {
      */
     customThemeId?: string;
     /**
-     * The entity that the created embed user will belong to. Practically speaking, the embed
-     * user will this value assigned to its omni_user_embed_entity user attribute.
+     * An associated entity / group for the embed user.
      */
     entity?: string;
+    /**
+     * The content role for the embed user on the entity folder.
+     */
+    entityFolderContentRole?: string;
     /**
      * Filter search parameter.
      */
@@ -80,6 +83,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, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderContentRole, 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
-accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderContentRole, 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 = {
@@ -26,6 +26,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchPa
         ...(customTheme && { customTheme }),
         ...(customThemeId && { customThemeId }),
         ...(entity && { entity }),
+        ...(entityFolderContentRole && { entityFolderContentRole }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),

package/lib/cjs/types.d.ts

@@ -22,6 +22,12 @@ type EmbedSsoBaseProps = {
      * only the content specified in the contentId will be embedded.
      */
     mode?: EmbedSessionMode;
+    /**
+     * Optional content role setting. Can be one of "EDITOR" or "VIEWER". If set to "EDITOR", the user will have the ability to manage
+     * content in their associated embed entity folder. If set to "VIEWER", the user will only be able to view content in
+     * their associated embed entity folder.
+     */
+    entityFolderContentRole?: EmbedEntityFolderContentRoles;
     nonce?: string;
     port?: number;
 } & ({
@@ -110,11 +116,18 @@ export declare enum EmbeddedContent {
     Dashboard = "dashboards",
     Workbook = "w"
 }
-export declare const EmbedSsoContentDiscoveryPaths: readonly ["my"];
+export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
 export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
 export declare enum EmbedConnectionRoles {
     RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
 }
+/**
+ * Levels of access a user can have to their associated embed entity folder.
+ */
+export declare enum EmbedEntityFolderContentRoles {
+    EDITOR = "EDITOR",
+    VIEWER = "VIEWER"
+}
 export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
 /**
  * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.

package/lib/cjs/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
+exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
 var EmbedSessionMode;
 (function (EmbedSessionMode) {
     EmbedSessionMode["Application"] = "APPLICATION";
@@ -32,7 +32,11 @@ var EmbeddedContent;
     EmbeddedContent["Dashboard"] = "dashboards";
     EmbeddedContent["Workbook"] = "w";
 })(EmbeddedContent || (exports.EmbeddedContent = EmbeddedContent = {}));
-exports.EmbedSsoContentDiscoveryPaths = ["my"];
+exports.EmbedSsoContentDiscoveryPaths = [
+    "my",
+    "entity-folder",
+    "root",
+];
 var EmbedConnectionRoles;
 (function (EmbedConnectionRoles) {
     // TODO: Eventually we'll want to add VIEWER. Currently though, since the sole use case of the
@@ -40,3 +44,11 @@ var EmbedConnectionRoles;
     // keep scope as limited as possible.
     EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
 })(EmbedConnectionRoles || (exports.EmbedConnectionRoles = EmbedConnectionRoles = {}));
+/**
+ * Levels of access a user can have to their associated embed entity folder.
+ */
+var EmbedEntityFolderContentRoles;
+(function (EmbedEntityFolderContentRoles) {
+    EmbedEntityFolderContentRoles["EDITOR"] = "EDITOR";
+    EmbedEntityFolderContentRoles["VIEWER"] = "VIEWER";
+})(EmbedEntityFolderContentRoles || (exports.EmbedEntityFolderContentRoles = EmbedEntityFolderContentRoles = {}));

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, } = 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 host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -69,6 +69,7 @@ const embedSsoContent = async (props) => {
         connectionRoles,
         accessBoost,
         mode,
+        entityFolderContentRole,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -89,6 +90,8 @@ const embedSsoContent = async (props) => {
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
     mode && url.searchParams.append("mode", mode);
+    entityFolderContentRole &&
+        url.searchParams.append("entityFolderContentRole", entityFolderContentRole);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/esm/signature.d.ts

@@ -47,10 +47,13 @@ type SignatureProps = {
      */
     customThemeId?: string;
     /**
-     * The entity that the created embed user will belong to. Practically speaking, the embed
-     * user will this value assigned to its omni_user_embed_entity user attribute.
+     * An associated entity / group for the embed user.
      */
     entity?: string;
+    /**
+     * The content role for the embed user on the entity folder.
+     */
+    entityFolderContentRole?: string;
     /**
      * Filter search parameter.
      */
@@ -80,6 +83,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, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderContentRole, 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
-accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, entity, entityFolderContentRole, 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 = {
@@ -19,6 +19,7 @@ accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchPa
         ...(customTheme && { customTheme }),
         ...(customThemeId && { customThemeId }),
         ...(entity && { entity }),
+        ...(entityFolderContentRole && { entityFolderContentRole }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(linkAccess && { linkAccess }),
         ...(mode && { mode }),

package/lib/esm/types.d.ts

@@ -22,6 +22,12 @@ type EmbedSsoBaseProps = {
      * only the content specified in the contentId will be embedded.
      */
     mode?: EmbedSessionMode;
+    /**
+     * Optional content role setting. Can be one of "EDITOR" or "VIEWER". If set to "EDITOR", the user will have the ability to manage
+     * content in their associated embed entity folder. If set to "VIEWER", the user will only be able to view content in
+     * their associated embed entity folder.
+     */
+    entityFolderContentRole?: EmbedEntityFolderContentRoles;
     nonce?: string;
     port?: number;
 } & ({
@@ -110,11 +116,18 @@ export declare enum EmbeddedContent {
     Dashboard = "dashboards",
     Workbook = "w"
 }
-export declare const EmbedSsoContentDiscoveryPaths: readonly ["my"];
+export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
 export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
 export declare enum EmbedConnectionRoles {
     RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
 }
+/**
+ * Levels of access a user can have to their associated embed entity folder.
+ */
+export declare enum EmbedEntityFolderContentRoles {
+    EDITOR = "EDITOR",
+    VIEWER = "VIEWER"
+}
 export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
 /**
  * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.

package/lib/esm/types.js

@@ -29,7 +29,11 @@ export var EmbeddedContent;
     EmbeddedContent["Dashboard"] = "dashboards";
     EmbeddedContent["Workbook"] = "w";
 })(EmbeddedContent || (EmbeddedContent = {}));
-export const EmbedSsoContentDiscoveryPaths = ["my"];
+export const EmbedSsoContentDiscoveryPaths = [
+    "my",
+    "entity-folder",
+    "root",
+];
 export var EmbedConnectionRoles;
 (function (EmbedConnectionRoles) {
     // TODO: Eventually we'll want to add VIEWER. Currently though, since the sole use case of the
@@ -37,3 +41,11 @@ export var EmbedConnectionRoles;
     // keep scope as limited as possible.
     EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
 })(EmbedConnectionRoles || (EmbedConnectionRoles = {}));
+/**
+ * Levels of access a user can have to their associated embed entity folder.
+ */
+export var EmbedEntityFolderContentRoles;
+(function (EmbedEntityFolderContentRoles) {
+    EmbedEntityFolderContentRoles["EDITOR"] = "EDITOR";
+    EmbedEntityFolderContentRoles["VIEWER"] = "VIEWER";
+})(EmbedEntityFolderContentRoles || (EmbedEntityFolderContentRoles = {}));

package/package.json

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