@omni-co/embed 0.3.12 → 0.3.14

package/lib/cjs/embed.d.ts

@@ -1,3 +1,9 @@
-import { EmbedSsoDashboardProps, EmbedSsoWorkbookProps } from "./types";
+import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbookProps } from "./types";
 export declare const embedSsoDashboard: (props: EmbedSsoDashboardProps) => Promise<string>;
 export declare const embedSsoWorkbook: (props: EmbedSsoWorkbookProps) => Promise<string>;
+/**
+ * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
+ * @param EmbedSsoContentDiscoveryProps
+ * @returns Promise wrapped around a generated embed login url.
+ */
+export declare const embedSsoContentDiscovery: (props: EmbedSsoContentDiscoveryProps) => Promise<string>;

package/lib/cjs/embed.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.embedSsoWorkbook = exports.embedSsoDashboard = void 0;
+exports.embedSsoContentDiscovery = exports.embedSsoWorkbook = exports.embedSsoDashboard = void 0;
 const random_str_1 = require("./random-str");
 const signature_1 = require("./signature");
 const types_1 = require("./types");
 const defaultEmbedDomain = "embed-omniapp.co";
-const embedLoginPath = '/embed/login';
+const embedLoginPath = "/embed/login";
 const validateProps = (props) => {
-    const { externalId, name, nonce, organizationName, secret, userAttributes, } = props;
+    const { externalId, name, nonce, organizationName, secret, userAttributes } = props;
     if (!externalId) {
         throw new Error("externalId is required");
     }
@@ -31,12 +31,13 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { 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;
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     const customTheme = rawCustomTheme && JSON.stringify(rawCustomTheme);
+    const connectionRoles = rawConnectionRoles && JSON.stringify(rawConnectionRoles);
     // Generate the url for the embed login route
     const url = new URL(embedLoginPath, `https://${organizationName.toLocaleLowerCase()}.${domain}${port ? `:${port}` : ""}`);
     // Get a signature for the request
@@ -54,6 +55,7 @@ const embedSsoContent = async (props) => {
         filterSearchParam,
         linkAccess,
         customTheme,
+        connectionRoles,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -69,6 +71,8 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("filterSearchParam", filterSearchParam);
     linkAccess && url.searchParams.append("linkAccess", linkAccess);
     customTheme && url.searchParams.append("customTheme", customTheme);
+    connectionRoles &&
+        url.searchParams.append("connectionRoles", connectionRoles);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
@@ -82,3 +86,16 @@ const embedSsoWorkbook = async (props) => {
     return embedSsoContent({ ...props, contentPath });
 };
 exports.embedSsoWorkbook = embedSsoWorkbook;
+/**
+ * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
+ * @param EmbedSsoContentDiscoveryProps
+ * @returns Promise wrapped around a generated embed login url.
+ */
+const embedSsoContentDiscovery = async (props) => {
+    const contentPath = `/${props.path}`;
+    return embedSsoContent({
+        ...props,
+        contentPath,
+    });
+};
+exports.embedSsoContentDiscovery = embedSsoContentDiscovery;

package/lib/cjs/signature.d.ts

@@ -29,24 +29,20 @@ type SignatureProps = {
      */
     secret: string;
     /**
-     * The user attributes to be sent with the request. Expected to be a stringified JSON object.
+     * The connection roles to be associated with the embed user. Expected to be a stringified JSON object.
+     */
+    connectionRoles?: string;
+    /**
+     * The custom theme to be sent with the request. Expected to be a stringified JSON object.
      *
-     * Example: '{ "team": "Lakers" }'
+     * Example: '{ "dashboard-background-color": "hotpink" }'
      */
-    userAttributes?: string;
+    customTheme?: 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.
      */
     entity?: string;
-    /**
-     * Whether the user prefers light, dark, or system theme.
-     */
-    prefersDark?: string;
-    /**
-     * The theme of the embed.
-     */
-    theme?: string;
     /**
      * Filter search parameter.
      */
@@ -56,14 +52,22 @@ type SignatureProps = {
      */
     linkAccess?: string;
     /**
-     * The custom theme to be sent with the request. Expected to be a stringified JSON object.
+     * Whether the user prefers light, dark, or system theme.
+     */
+    prefersDark?: string;
+    /**
+     * The theme of the embed.
+     */
+    theme?: string;
+    /**
+     * The user attributes to be sent with the request. Expected to be a stringified JSON object.
      *
-     * Example: '{ "dashboard-background-color": "hotpink" }'
+     * Example: '{ "team": "Lakers" }'
      */
-    customTheme?: string;
+    userAttributes?: string;
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, customTheme, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -13,10 +13,17 @@ const hmacSign = (data, secret) => {
     return base64url_1.default.fromBase64(b64);
 };
 exports.hmacSign = hmacSign;
-const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, customTheme, }) => {
+const generateStringForSignature = ({ 
+// Required parameters
+loginUrl, contentPath, externalId, name, nonce, 
+// Optional parameters
+connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }) => {
     const optionalParams = [];
-    entity && optionalParams.push(entity);
+    // 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);

package/lib/cjs/types.d.ts

@@ -1,6 +1,5 @@
 type UserAttributeValue = string | string[] | number | number[];
 type EmbedSsoBaseProps = {
-    contentId: string;
     externalId: string;
     name: string;
     organizationName: string;
@@ -21,6 +20,12 @@ type EmbedSsoDashboardOnlyProps = {
 type EmbedContentIdProp = {
     contentId: string;
 };
+type EmbedContentPathProp = {
+    contentPath: string;
+};
+type EmbedConnectionRolesProp = {
+    connectionRoles: Record<string, EmbedConnectionRoles>;
+};
 export type CustomThemeProperties = {
     "dashboard-background"?: string;
     "dashboard-tile-background"?: string;
@@ -43,9 +48,21 @@ export declare enum EmbeddedContent {
     Dashboard = "dashboards",
     Workbook = "w"
 }
+export declare const EmbedSsoContentDiscoveryPaths: readonly ["my"];
+export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
+export declare enum EmbedConnectionRoles {
+    RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
+}
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp & Partial<EmbedConnectionRolesProp>;
 /**
- * Consumers of this SDK will rely on these two types to embed workbooks and dashboards.
+ * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.
  */
 export type EmbedSsoDashboardProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentIdProp;
 export type EmbedSsoWorkbookProps = EmbedSsoBaseProps & EmbedContentIdProp;
+export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & EmbedConnectionRolesProp & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: EmbedSsoContentDiscoveryPath;
+};
 export {};

package/lib/cjs/types.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbeddedContent = void 0;
+exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = void 0;
 var EmbeddedContent;
 (function (EmbeddedContent) {
     EmbeddedContent["Dashboard"] = "dashboards";
     EmbeddedContent["Workbook"] = "w";
 })(EmbeddedContent || (exports.EmbeddedContent = EmbeddedContent = {}));
+exports.EmbedSsoContentDiscoveryPaths = ["my"];
+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 || (exports.EmbedConnectionRoles = EmbedConnectionRoles = {}));

package/lib/esm/embed.d.ts

@@ -1,3 +1,9 @@
-import { EmbedSsoDashboardProps, EmbedSsoWorkbookProps } from "./types";
+import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbookProps } from "./types";
 export declare const embedSsoDashboard: (props: EmbedSsoDashboardProps) => Promise<string>;
 export declare const embedSsoWorkbook: (props: EmbedSsoWorkbookProps) => Promise<string>;
+/**
+ * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
+ * @param EmbedSsoContentDiscoveryProps
+ * @returns Promise wrapped around a generated embed login url.
+ */
+export declare const embedSsoContentDiscovery: (props: EmbedSsoContentDiscoveryProps) => Promise<string>;

package/lib/esm/embed.js

@@ -1,10 +1,10 @@
 import { random32ByteString } from "./random-str";
 import { getSignature } from "./signature";
-import { EmbeddedContent } from "./types";
+import { EmbeddedContent, } from "./types";
 const defaultEmbedDomain = "embed-omniapp.co";
-const embedLoginPath = '/embed/login';
+const embedLoginPath = "/embed/login";
 const validateProps = (props) => {
-    const { externalId, name, nonce, organizationName, secret, userAttributes, } = props;
+    const { externalId, name, nonce, organizationName, secret, userAttributes } = props;
     if (!externalId) {
         throw new Error("externalId is required");
     }
@@ -28,12 +28,13 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { contentPath, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { 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;
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     const customTheme = rawCustomTheme && JSON.stringify(rawCustomTheme);
+    const connectionRoles = rawConnectionRoles && JSON.stringify(rawConnectionRoles);
     // Generate the url for the embed login route
     const url = new URL(embedLoginPath, `https://${organizationName.toLocaleLowerCase()}.${domain}${port ? `:${port}` : ""}`);
     // Get a signature for the request
@@ -51,6 +52,7 @@ const embedSsoContent = async (props) => {
         filterSearchParam,
         linkAccess,
         customTheme,
+        connectionRoles,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -66,6 +68,8 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("filterSearchParam", filterSearchParam);
     linkAccess && url.searchParams.append("linkAccess", linkAccess);
     customTheme && url.searchParams.append("customTheme", customTheme);
+    connectionRoles &&
+        url.searchParams.append("connectionRoles", connectionRoles);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
@@ -77,3 +81,15 @@ export const embedSsoWorkbook = async (props) => {
     const contentPath = `${buildContentPath(EmbeddedContent.Workbook, props.contentId)}/duplicate`;
     return embedSsoContent({ ...props, contentPath });
 };
+/**
+ * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
+ * @param EmbedSsoContentDiscoveryProps
+ * @returns Promise wrapped around a generated embed login url.
+ */
+export const embedSsoContentDiscovery = async (props) => {
+    const contentPath = `/${props.path}`;
+    return embedSsoContent({
+        ...props,
+        contentPath,
+    });
+};

package/lib/esm/signature.d.ts

@@ -29,24 +29,20 @@ type SignatureProps = {
      */
     secret: string;
     /**
-     * The user attributes to be sent with the request. Expected to be a stringified JSON object.
+     * The connection roles to be associated with the embed user. Expected to be a stringified JSON object.
+     */
+    connectionRoles?: string;
+    /**
+     * The custom theme to be sent with the request. Expected to be a stringified JSON object.
      *
-     * Example: '{ "team": "Lakers" }'
+     * Example: '{ "dashboard-background-color": "hotpink" }'
      */
-    userAttributes?: string;
+    customTheme?: 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.
      */
     entity?: string;
-    /**
-     * Whether the user prefers light, dark, or system theme.
-     */
-    prefersDark?: string;
-    /**
-     * The theme of the embed.
-     */
-    theme?: string;
     /**
      * Filter search parameter.
      */
@@ -56,14 +52,22 @@ type SignatureProps = {
      */
     linkAccess?: string;
     /**
-     * The custom theme to be sent with the request. Expected to be a stringified JSON object.
+     * Whether the user prefers light, dark, or system theme.
+     */
+    prefersDark?: string;
+    /**
+     * The theme of the embed.
+     */
+    theme?: string;
+    /**
+     * The user attributes to be sent with the request. Expected to be a stringified JSON object.
      *
-     * Example: '{ "dashboard-background-color": "hotpink" }'
+     * Example: '{ "team": "Lakers" }'
      */
-    customTheme?: string;
+    userAttributes?: string;
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, customTheme, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -6,10 +6,17 @@ export const hmacSign = (data, secret) => {
     const b64 = hmac.digest("base64");
     return base64url.fromBase64(b64);
 };
-const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, customTheme, }) => {
+const generateStringForSignature = ({ 
+// Required parameters
+loginUrl, contentPath, externalId, name, nonce, 
+// Optional parameters
+connectionRoles, customTheme, entity, filterSearchParam, linkAccess, prefersDark, theme, userAttributes, }) => {
     const optionalParams = [];
-    entity && optionalParams.push(entity);
+    // 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);

package/lib/esm/types.d.ts

@@ -1,6 +1,5 @@
 type UserAttributeValue = string | string[] | number | number[];
 type EmbedSsoBaseProps = {
-    contentId: string;
     externalId: string;
     name: string;
     organizationName: string;
@@ -21,6 +20,12 @@ type EmbedSsoDashboardOnlyProps = {
 type EmbedContentIdProp = {
     contentId: string;
 };
+type EmbedContentPathProp = {
+    contentPath: string;
+};
+type EmbedConnectionRolesProp = {
+    connectionRoles: Record<string, EmbedConnectionRoles>;
+};
 export type CustomThemeProperties = {
     "dashboard-background"?: string;
     "dashboard-tile-background"?: string;
@@ -43,9 +48,21 @@ export declare enum EmbeddedContent {
     Dashboard = "dashboards",
     Workbook = "w"
 }
+export declare const EmbedSsoContentDiscoveryPaths: readonly ["my"];
+export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
+export declare enum EmbedConnectionRoles {
+    RESTRICTED_QUERIER = "RESTRICTED_QUERIER"
+}
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp & Partial<EmbedConnectionRolesProp>;
 /**
- * Consumers of this SDK will rely on these two types to embed workbooks and dashboards.
+ * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.
  */
 export type EmbedSsoDashboardProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentIdProp;
 export type EmbedSsoWorkbookProps = EmbedSsoBaseProps & EmbedContentIdProp;
+export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & EmbedConnectionRolesProp & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: EmbedSsoContentDiscoveryPath;
+};
 export {};

package/lib/esm/types.js

@@ -3,3 +3,11 @@ export var EmbeddedContent;
     EmbeddedContent["Dashboard"] = "dashboards";
     EmbeddedContent["Workbook"] = "w";
 })(EmbeddedContent || (EmbeddedContent = {}));
+export const EmbedSsoContentDiscoveryPaths = ["my"];
+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 || (EmbedConnectionRoles = {}));

package/package.json

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