@omni-co/embed 0.3.12 → 0.3.13

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");
     }
@@ -82,3 +82,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/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,9 @@ type EmbedSsoDashboardOnlyProps = {
 type EmbedContentIdProp = {
     contentId: string;
 };
+type EmbedContentPathProp = {
+    contentPath: string;
+};
 export type CustomThemeProperties = {
     "dashboard-background"?: string;
     "dashboard-tile-background"?: string;
@@ -43,9 +45,18 @@ 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 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 & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: EmbedSsoContentDiscoveryPath;
+};
 export {};

package/lib/cjs/types.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbeddedContent = void 0;
+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,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");
     }
@@ -77,3 +77,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/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,9 @@ type EmbedSsoDashboardOnlyProps = {
 type EmbedContentIdProp = {
     contentId: string;
 };
+type EmbedContentPathProp = {
+    contentPath: string;
+};
 export type CustomThemeProperties = {
     "dashboard-background"?: string;
     "dashboard-tile-background"?: string;
@@ -43,9 +45,18 @@ 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 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 & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: EmbedSsoContentDiscoveryPath;
+};
 export {};

package/lib/esm/types.js

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

package/package.json

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