@omni-co/embed 0.10.0 → 1.0.0-beta.2

package/README.md

@@ -1,5 +1,7 @@
 # Omni Embed SSO Typescript SDK for Server (Node, etc)
 
+Node.js only SDK for generating signed SSO embed links for Omni dashboards, workbooks, and content discovery pages.
+
 ## Server Side Only
 
 **This SDK is intented to be used in a server context.**

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, externalId, filterSearchParam, host, linkAccess, mode, name, nonce, organizationName, port, secret, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = 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;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
@@ -86,6 +86,8 @@ const embedSsoContent = async (props) => {
         email,
         entity,
         entityFolderContentRole,
+        entityFolderLabel,
+        entityGroupLabel,
         filterSearchParam,
         groups,
         linkAccess,
@@ -120,6 +122,10 @@ const embedSsoContent = async (props) => {
     groups && url.searchParams.append("groups", groups);
     email && url.searchParams.append("email", email);
     uiSettings && url.searchParams.append("uiSettings", uiSettings);
+    entityGroupLabel &&
+        url.searchParams.append("entityGroupLabel", entityGroupLabel);
+    entityFolderLabel &&
+        url.searchParams.append("entityFolderLabel", entityFolderLabel);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/cjs/signature.d.ts

@@ -58,6 +58,14 @@ type SignatureProps = {
      * The content role for the embed user on the entity folder.
      */
     entityFolderContentRole?: string;
+    /**
+     * The label for the generated entity folder.
+     */
+    entityFolderLabel?: string;
+    /**
+     * The label for the generated entity group.
+     */
+    entityGroupLabel?: string;
     /**
      * Filter search parameter.
      */
@@ -113,6 +121,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, 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, 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, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, uiSettings, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, 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,8 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(email && { email }),
         ...(entity && { entity }),
         ...(entityFolderContentRole && { entityFolderContentRole }),
+        ...(entityFolderLabel && { entityFolderLabel }),
+        ...(entityGroupLabel && { entityGroupLabel }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),

package/lib/cjs/types.d.ts

@@ -64,6 +64,16 @@ type EmbedSsoBaseProps = {
      * VIEWER: the user will only be able to view content in the entity folder.
      */
     entityFolderContentRole?: 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.
+     */
+    entityFolderLabel?: string;
+    /**
+     * Optional setting that customizes the generated entity group label. This only affects the entity group
+     * corresponding to the `entity` parameter value in the relevant generated SSO embed URL.
+     */
+    entityGroupLabel?: string;
     /**
      * Optional groups setting. An array of group names that the user will be added to.
      */

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, externalId, filterSearchParam, host, linkAccess, mode, name, nonce, organizationName, port, secret, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, entity, prefersDark, theme, entityFolderContentRole, groups: rawGroups, } = 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;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
@@ -83,6 +83,8 @@ const embedSsoContent = async (props) => {
         email,
         entity,
         entityFolderContentRole,
+        entityFolderLabel,
+        entityGroupLabel,
         filterSearchParam,
         groups,
         linkAccess,
@@ -117,6 +119,10 @@ const embedSsoContent = async (props) => {
     groups && url.searchParams.append("groups", groups);
     email && url.searchParams.append("email", email);
     uiSettings && url.searchParams.append("uiSettings", uiSettings);
+    entityGroupLabel &&
+        url.searchParams.append("entityGroupLabel", entityGroupLabel);
+    entityFolderLabel &&
+        url.searchParams.append("entityFolderLabel", entityFolderLabel);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;

package/lib/esm/signature.d.ts

@@ -58,6 +58,14 @@ type SignatureProps = {
      * The content role for the embed user on the entity folder.
      */
     entityFolderContentRole?: string;
+    /**
+     * The label for the generated entity folder.
+     */
+    entityFolderLabel?: string;
+    /**
+     * The label for the generated entity group.
+     */
+    entityGroupLabel?: string;
     /**
      * Filter search parameter.
      */
@@ -113,6 +121,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, 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, 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, filterSearchParam, groups, linkAccess, mode, prefersDark, theme, uiSettings, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, 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,8 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         ...(email && { email }),
         ...(entity && { entity }),
         ...(entityFolderContentRole && { entityFolderContentRole }),
+        ...(entityFolderLabel && { entityFolderLabel }),
+        ...(entityGroupLabel && { entityGroupLabel }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(groups && { groups }),
         ...(linkAccess && { linkAccess }),

package/lib/esm/types.d.ts

@@ -64,6 +64,16 @@ type EmbedSsoBaseProps = {
      * VIEWER: the user will only be able to view content in the entity folder.
      */
     entityFolderContentRole?: 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.
+     */
+    entityFolderLabel?: string;
+    /**
+     * Optional setting that customizes the generated entity group label. This only affects the entity group
+     * corresponding to the `entity` parameter value in the relevant generated SSO embed URL.
+     */
+    entityGroupLabel?: string;
     /**
      * Optional groups setting. An array of group names that the user will be added to.
      */

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.0",
+  "version": "1.0.0-beta.2",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",
@@ -27,6 +27,8 @@
     "node": ">=16"
   },
   "engineStrict": true,
+  "main": "./lib/cjs/index.js",
+  "type": "module",
   "types": "./lib/esm/index.d.ts",
   "exports": {
     ".": {