@omni-co/embed 0.3.14 → 0.3.15

package/README.md

@@ -17,7 +17,7 @@ yarn add @omni-co/embed
 ## Basic Example
 
 ```ts
-import { embedSsoDashboard } from "@omni-co/embed";
+import { embedSsoDashboard, embedSsoWorkbook } from "@omni-co/embed";
 
 // This creates a signed embed sso link for a dashboard
 // in the omni account named Acme.
@@ -28,12 +28,21 @@ const iframeUrl = await embedSsoDashboard({
   organizationName: "acme",
   secret: "abcdefghijklmnopqrstuvwxyz123456",
 });
+
+// Alternatively you can create a signed embed sso link for a workbook
+onst iframeUrl = await embedSsoWorkbook({
+  contentId: "miU0hL6z",
+  externalId: "wile.e@coyote.co",
+  name: "Wile E",
+  organizationName: "acme",
+  secret: "abcdefghijklmnopqrstuvwxyz123456",
+});
 ```
 
 ## Kitchen Sink Example
 
 ```ts
-import { embedSsoDashboard } from "@omni-co/embed";
+import { embedSsoDashboard, embedSsoWorkbook } from "@omni-co/embed";
 
 // This creates a signed embed sso link for a dashboard
 // in the omni account named Acme.
@@ -52,7 +61,7 @@ const iframeUrl = await embedSsoDashboard({
 
 ## embedSsoDashboard
 
-This is the type signature for the embedSsoDashboard function:
+This is the type signature for the `embedSsoDashboard` function:
 
 ```ts
 type EmbedSsoProps = {
@@ -102,3 +111,42 @@ type EmbedSsoProps = {
   customTheme?: CustomThemeProperties;
 };
 ```
+
+## embedSsoWorkbook
+
+This is the type signature for the `embedSsoWorkbook` function:
+
+```ts
+type EmbedSsoProps = {
+  // Short GUID of the workbook. Can be obtained via the workbook's share -> embed -> iframe url or via the dashboard url (will embed the workbook associated with the dashboard id)
+  contentId: string;
+
+  // Required identifier to associate the external user with an
+  // automatically generated internal Omni user.
+  externalId: string;
+
+  // Required name of the external user.
+  name: string;
+
+  // Required Omni organization which contains the workbook.
+  organizationName: string;
+
+  // Signing secret available to Omni admins.
+  secret: string;
+
+  // Optional identifier to associate the user with an external
+  // organization or system.
+  entity?: string;
+
+  // Optional user attributes to be passed to user associated with the
+  // externalId. User attributes must be created in Omni before being
+  // defined and given a value here.
+  userAttributes?: Record<string, string | string[] | number | number[]>;
+
+  // Optional dark mode setting. Can be one of "true", "false", or "system".
+  prefersDark?: string;
+
+  // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
+  theme?: string;
+};
+```

package/lib/cjs/embed.js

@@ -31,7 +31,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -56,6 +56,7 @@ const embedSsoContent = async (props) => {
         linkAccess,
         customTheme,
         connectionRoles,
+        accessBoost,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -64,6 +65,7 @@ const embedSsoContent = async (props) => {
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
     userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    accessBoost && url.searchParams.append("accessBoost", accessBoost.toString());
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);

package/lib/cjs/signature.d.ts

@@ -28,6 +28,10 @@ type SignatureProps = {
      * The secret used to sign the request
      */
     secret: string;
+    /**
+     * The access boost setting for content specified in this Embed SSO URL.
+     */
+    accessBoost?: boolean;
     /**
      * The connection roles to be associated with the embed user. Expected to be a stringified JSON object.
      */
@@ -68,6 +72,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -17,18 +17,25 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }) => {
-    const optionalParams = [];
-    // Optional parameters should be pushed into the optionalParams array in ALPHABETICAL order
-    // for customers producing embed login URLs.
-    connectionRoles && optionalParams.push(connectionRoles);
-    customTheme && optionalParams.push(customTheme);
-    entity && optionalParams.push(entity);
-    filterSearchParam && optionalParams.push(filterSearchParam);
-    linkAccess && optionalParams.push(linkAccess);
-    prefersDark && optionalParams.push(prefersDark);
-    theme && optionalParams.push(theme);
-    userAttributes && optionalParams.push(userAttributes);
+connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }) => {
+    // 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 = {
+        ...(accessBoost && { accessBoost: accessBoost === null || accessBoost === void 0 ? void 0 : accessBoost.toString() }),
+        ...(connectionRoles && { connectionRoles }),
+        ...(customTheme && { customTheme }),
+        ...(entity && { entity }),
+        ...(filterSearchParam && { filterSearchParam }),
+        ...(linkAccess && { linkAccess }),
+        ...(prefersDark && { prefersDark }),
+        ...(theme && { theme }),
+        ...(userAttributes && { userAttributes }),
+    };
+    const optionalParams = Object.keys(optionalParamsMap)
+        .sort() // guarantees the order of the optional params is Alphabetical
+        .map((key) => {
+        return optionalParamsMap[key];
+    });
     return `
   ${loginUrl}
   ${contentPath}

package/lib/cjs/types.d.ts

@@ -13,6 +13,7 @@ type EmbedSsoBaseProps = {
     port?: number;
 };
 type EmbedSsoDashboardOnlyProps = {
+    accessBoost?: boolean;
     filterSearchParam?: string;
     linkAccess?: string;
     customTheme?: CustomThemeProperties;

package/lib/esm/embed.js

@@ -28,7 +28,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -53,6 +53,7 @@ const embedSsoContent = async (props) => {
         linkAccess,
         customTheme,
         connectionRoles,
+        accessBoost,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -61,6 +62,7 @@ const embedSsoContent = async (props) => {
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
     userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    accessBoost && url.searchParams.append("accessBoost", accessBoost.toString());
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);

package/lib/esm/signature.d.ts

@@ -28,6 +28,10 @@ type SignatureProps = {
      * The secret used to sign the request
      */
     secret: string;
+    /**
+     * The access boost setting for content specified in this Embed SSO URL.
+     */
+    accessBoost?: boolean;
     /**
      * The connection roles to be associated with the embed user. Expected to be a stringified JSON object.
      */
@@ -68,6 +72,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -10,18 +10,25 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }) => {
-    const optionalParams = [];
-    // Optional parameters should be pushed into the optionalParams array in ALPHABETICAL order
-    // for customers producing embed login URLs.
-    connectionRoles && optionalParams.push(connectionRoles);
-    customTheme && optionalParams.push(customTheme);
-    entity && optionalParams.push(entity);
-    filterSearchParam && optionalParams.push(filterSearchParam);
-    linkAccess && optionalParams.push(linkAccess);
-    prefersDark && optionalParams.push(prefersDark);
-    theme && optionalParams.push(theme);
-    userAttributes && optionalParams.push(userAttributes);
+connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, accessBoost, }) => {
+    // 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 = {
+        ...(accessBoost && { accessBoost: accessBoost === null || accessBoost === void 0 ? void 0 : accessBoost.toString() }),
+        ...(connectionRoles && { connectionRoles }),
+        ...(customTheme && { customTheme }),
+        ...(entity && { entity }),
+        ...(filterSearchParam && { filterSearchParam }),
+        ...(linkAccess && { linkAccess }),
+        ...(prefersDark && { prefersDark }),
+        ...(theme && { theme }),
+        ...(userAttributes && { userAttributes }),
+    };
+    const optionalParams = Object.keys(optionalParamsMap)
+        .sort() // guarantees the order of the optional params is Alphabetical
+        .map((key) => {
+        return optionalParamsMap[key];
+    });
     return `
   ${loginUrl}
   ${contentPath}

package/lib/esm/types.d.ts

@@ -13,6 +13,7 @@ type EmbedSsoBaseProps = {
     port?: number;
 };
 type EmbedSsoDashboardOnlyProps = {
+    accessBoost?: boolean;
     filterSearchParam?: string;
     linkAccess?: string;
     customTheme?: CustomThemeProperties;

package/package.json

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