@omni-co/embed 0.3.11 → 0.3.13

package/README.md

@@ -55,7 +55,7 @@ const iframeUrl = await embedSsoDashboard({
 This is the type signature for the embedSsoDashboard function:
 
 ```ts
-type EmbedSsoDashboardProps = {
+type EmbedSsoProps = {
   // Short GUID of the dashboard. Can be obtained via the dashboard's url.
   contentId: string;
 

package/lib/cjs/embed.d.ts

@@ -1,38 +1,9 @@
-type UserAttributeValue = string | string[] | number | number[];
-export type CustomThemeProperties = {
-    "dashboard-background"?: string;
-    "dashboard-tile-background"?: string;
-    "dashboard-tile-text-body-color"?: string;
-    "dashboard-tile-text-secondary-color"?: string;
-    "dashboard-tile-border-color"?: string;
-    "dashboard-tile-border-radius"?: string;
-    "dashboard-tile-border-style"?: string;
-    "dashboard-tile-border-width"?: string;
-    "dashboard-tile-title-font-size"?: string;
-    "dashboard-tile-title-font-weight"?: string;
-    "dashboard-tile-title-text-color"?: string;
-    "dashboard-tile-title-font-family"?: string;
-    "dashboard-tile-text-body-font-family"?: string;
-    "dashboard-tile-text-code-font-family"?: string;
-    "dashboard-key-color"?: string;
-    "dashboard-key-text-color"?: string;
-};
-type EmbedSsoProps = {
-    contentId: string;
-    externalId: string;
-    name: string;
-    organizationName: string;
-    secret: string;
-    entity?: string;
-    userAttributes?: Record<string, UserAttributeValue>;
-    prefersDark?: string;
-    theme?: string;
-    filterSearchParam?: string;
-    linkAccess?: string;
-    customTheme?: CustomThemeProperties;
-    domain?: string;
-    nonce?: string;
-    port?: number;
-};
-export declare const embedSsoDashboard: (props: EmbedSsoProps) => Promise<string>;
-export {};
+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,16 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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 embedLoginRoute = "/embed/login";
-const embedDashboardPath = "/embed/dashboards";
+const embedLoginPath = "/embed/login";
 const validateProps = (props) => {
-    const { contentId, externalId, name, nonce, organizationName, secret, userAttributes, } = props;
-    if (!contentId) {
-        throw new Error("contentId is required");
-    }
+    const { externalId, name, nonce, organizationName, secret, userAttributes } = props;
     if (!externalId) {
         throw new Error("externalId is required");
     }
@@ -32,18 +29,16 @@ const validateProps = (props) => {
         }
     }
 };
-const embedSsoDashboard = async (props) => {
+const embedSsoContent = async (props) => {
     validateProps(props);
-    let { contentId, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { 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);
     // Generate the url for the embed login route
-    const url = new URL(embedLoginRoute, `https://${organizationName.toLocaleLowerCase()}.${domain}${port ? `:${port}` : ""}`);
-    // Generate the content path
-    const contentPath = `${embedDashboardPath}/${contentId}`;
+    const url = new URL(embedLoginPath, `https://${organizationName.toLocaleLowerCase()}.${domain}${port ? `:${port}` : ""}`);
     // Get a signature for the request
     const signature = (0, signature_1.getSignature)({
         loginUrl: url.toString(),
@@ -76,4 +71,27 @@ const embedSsoDashboard = async (props) => {
     customTheme && url.searchParams.append("customTheme", customTheme);
     return url.toString();
 };
+const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
+const embedSsoDashboard = async (props) => {
+    const contentPath = buildContentPath(types_1.EmbeddedContent.Dashboard, props.contentId);
+    return embedSsoContent({ ...props, contentPath });
+};
 exports.embedSsoDashboard = embedSsoDashboard;
+const embedSsoWorkbook = async (props) => {
+    const contentPath = `${buildContentPath(types_1.EmbeddedContent.Workbook, props.contentId)}/duplicate`;
+    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/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./embed";
+export * from "./types";
 export * from "./signature";

package/lib/cjs/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./embed"), exports);
+__exportStar(require("./types"), exports);
 __exportStar(require("./signature"), exports);

package/lib/cjs/types.d.ts

@@ -0,0 +1,62 @@
+type UserAttributeValue = string | string[] | number | number[];
+type EmbedSsoBaseProps = {
+    externalId: string;
+    name: string;
+    organizationName: string;
+    secret: string;
+    entity?: string;
+    userAttributes?: Record<string, UserAttributeValue>;
+    prefersDark?: string;
+    theme?: string;
+    domain?: string;
+    nonce?: string;
+    port?: number;
+};
+type EmbedSsoDashboardOnlyProps = {
+    filterSearchParam?: string;
+    linkAccess?: string;
+    customTheme?: CustomThemeProperties;
+};
+type EmbedContentIdProp = {
+    contentId: string;
+};
+type EmbedContentPathProp = {
+    contentPath: string;
+};
+export type CustomThemeProperties = {
+    "dashboard-background"?: string;
+    "dashboard-tile-background"?: string;
+    "dashboard-tile-text-body-color"?: string;
+    "dashboard-tile-text-secondary-color"?: string;
+    "dashboard-tile-border-color"?: string;
+    "dashboard-tile-border-radius"?: string;
+    "dashboard-tile-border-style"?: string;
+    "dashboard-tile-border-width"?: string;
+    "dashboard-tile-title-font-size"?: string;
+    "dashboard-tile-title-font-weight"?: string;
+    "dashboard-tile-title-text-color"?: string;
+    "dashboard-tile-title-font-family"?: string;
+    "dashboard-tile-text-body-font-family"?: string;
+    "dashboard-tile-text-code-font-family"?: string;
+    "dashboard-key-color"?: string;
+    "dashboard-key-text-color"?: string;
+};
+export declare enum EmbeddedContent {
+    Dashboard = "dashboards",
+    Workbook = "w"
+}
+export declare const EmbedSsoContentDiscoveryPaths: readonly ["my"];
+export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
+/**
+ * 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 & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: EmbedSsoContentDiscoveryPath;
+};
+export {};

package/lib/cjs/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = void 0;
+var EmbeddedContent;
+(function (EmbeddedContent) {
+    EmbeddedContent["Dashboard"] = "dashboards";
+    EmbeddedContent["Workbook"] = "w";
+})(EmbeddedContent || (exports.EmbeddedContent = EmbeddedContent = {}));
+exports.EmbedSsoContentDiscoveryPaths = ["my"];

package/lib/esm/embed.d.ts

@@ -1,38 +1,9 @@
-type UserAttributeValue = string | string[] | number | number[];
-export type CustomThemeProperties = {
-    "dashboard-background"?: string;
-    "dashboard-tile-background"?: string;
-    "dashboard-tile-text-body-color"?: string;
-    "dashboard-tile-text-secondary-color"?: string;
-    "dashboard-tile-border-color"?: string;
-    "dashboard-tile-border-radius"?: string;
-    "dashboard-tile-border-style"?: string;
-    "dashboard-tile-border-width"?: string;
-    "dashboard-tile-title-font-size"?: string;
-    "dashboard-tile-title-font-weight"?: string;
-    "dashboard-tile-title-text-color"?: string;
-    "dashboard-tile-title-font-family"?: string;
-    "dashboard-tile-text-body-font-family"?: string;
-    "dashboard-tile-text-code-font-family"?: string;
-    "dashboard-key-color"?: string;
-    "dashboard-key-text-color"?: string;
-};
-type EmbedSsoProps = {
-    contentId: string;
-    externalId: string;
-    name: string;
-    organizationName: string;
-    secret: string;
-    entity?: string;
-    userAttributes?: Record<string, UserAttributeValue>;
-    prefersDark?: string;
-    theme?: string;
-    filterSearchParam?: string;
-    linkAccess?: string;
-    customTheme?: CustomThemeProperties;
-    domain?: string;
-    nonce?: string;
-    port?: number;
-};
-export declare const embedSsoDashboard: (props: EmbedSsoProps) => Promise<string>;
-export {};
+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,13 +1,10 @@
 import { random32ByteString } from "./random-str";
 import { getSignature } from "./signature";
+import { EmbeddedContent, } from "./types";
 const defaultEmbedDomain = "embed-omniapp.co";
-const embedLoginRoute = "/embed/login";
-const embedDashboardPath = "/embed/dashboards";
+const embedLoginPath = "/embed/login";
 const validateProps = (props) => {
-    const { contentId, externalId, name, nonce, organizationName, secret, userAttributes, } = props;
-    if (!contentId) {
-        throw new Error("contentId is required");
-    }
+    const { externalId, name, nonce, organizationName, secret, userAttributes } = props;
     if (!externalId) {
         throw new Error("externalId is required");
     }
@@ -29,18 +26,16 @@ const validateProps = (props) => {
         }
     }
 };
-export const embedSsoDashboard = async (props) => {
+const embedSsoContent = async (props) => {
     validateProps(props);
-    let { contentId, customTheme: rawCustomTheme, domain, externalId, filterSearchParam, linkAccess, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { 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);
     // Generate the url for the embed login route
-    const url = new URL(embedLoginRoute, `https://${organizationName.toLocaleLowerCase()}.${domain}${port ? `:${port}` : ""}`);
-    // Generate the content path
-    const contentPath = `${embedDashboardPath}/${contentId}`;
+    const url = new URL(embedLoginPath, `https://${organizationName.toLocaleLowerCase()}.${domain}${port ? `:${port}` : ""}`);
     // Get a signature for the request
     const signature = getSignature({
         loginUrl: url.toString(),
@@ -73,3 +68,24 @@ export const embedSsoDashboard = async (props) => {
     customTheme && url.searchParams.append("customTheme", customTheme);
     return url.toString();
 };
+const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
+export const embedSsoDashboard = async (props) => {
+    const contentPath = buildContentPath(EmbeddedContent.Dashboard, props.contentId);
+    return embedSsoContent({ ...props, contentPath });
+};
+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/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./embed";
+export * from "./types";
 export * from "./signature";

package/lib/esm/index.js

@@ -1,2 +1,3 @@
 export * from "./embed";
+export * from "./types";
 export * from "./signature";

package/lib/esm/types.d.ts

@@ -0,0 +1,62 @@
+type UserAttributeValue = string | string[] | number | number[];
+type EmbedSsoBaseProps = {
+    externalId: string;
+    name: string;
+    organizationName: string;
+    secret: string;
+    entity?: string;
+    userAttributes?: Record<string, UserAttributeValue>;
+    prefersDark?: string;
+    theme?: string;
+    domain?: string;
+    nonce?: string;
+    port?: number;
+};
+type EmbedSsoDashboardOnlyProps = {
+    filterSearchParam?: string;
+    linkAccess?: string;
+    customTheme?: CustomThemeProperties;
+};
+type EmbedContentIdProp = {
+    contentId: string;
+};
+type EmbedContentPathProp = {
+    contentPath: string;
+};
+export type CustomThemeProperties = {
+    "dashboard-background"?: string;
+    "dashboard-tile-background"?: string;
+    "dashboard-tile-text-body-color"?: string;
+    "dashboard-tile-text-secondary-color"?: string;
+    "dashboard-tile-border-color"?: string;
+    "dashboard-tile-border-radius"?: string;
+    "dashboard-tile-border-style"?: string;
+    "dashboard-tile-border-width"?: string;
+    "dashboard-tile-title-font-size"?: string;
+    "dashboard-tile-title-font-weight"?: string;
+    "dashboard-tile-title-text-color"?: string;
+    "dashboard-tile-title-font-family"?: string;
+    "dashboard-tile-text-body-font-family"?: string;
+    "dashboard-tile-text-code-font-family"?: string;
+    "dashboard-key-color"?: string;
+    "dashboard-key-text-color"?: string;
+};
+export declare enum EmbeddedContent {
+    Dashboard = "dashboards",
+    Workbook = "w"
+}
+export declare const EmbedSsoContentDiscoveryPaths: readonly ["my"];
+export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
+/**
+ * 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 & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: EmbedSsoContentDiscoveryPath;
+};
+export {};

package/lib/esm/types.js

@@ -0,0 +1,6 @@
+export var EmbeddedContent;
+(function (EmbeddedContent) {
+    EmbeddedContent["Dashboard"] = "dashboards";
+    EmbeddedContent["Workbook"] = "w";
+})(EmbeddedContent || (EmbeddedContent = {}));
+export const EmbedSsoContentDiscoveryPaths = ["my"];

package/package.json

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