@omni-co/embed 0.4.11 → 0.5.0

package/lib/cjs/embed.d.ts

@@ -2,7 +2,7 @@ import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbook
 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.
+ * Generates an embed login URL using the passed-in content discovery page id.
  * @param EmbedSsoContentDiscoveryProps
  * @returns Promise wrapped around a generated embed login url.
  */

package/lib/cjs/embed.js

@@ -86,7 +86,8 @@ const embedSsoContent = async (props) => {
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
     userAttributes && url.searchParams.append("userAttributes", userAttributes);
-    accessBoost !== undefined && url.searchParams.append("accessBoost", accessBoost.toString());
+    accessBoost !== undefined &&
+        url.searchParams.append("accessBoost", accessBoost.toString());
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);
@@ -116,12 +117,14 @@ const embedSsoWorkbook = async (props) => {
 };
 exports.embedSsoWorkbook = embedSsoWorkbook;
 /**
- * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
+ * 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}`;
+    // Entity paths for the Content Discovery embed no longer require stripping the leading `/`.
+    // This check maintains backwards compatibility with the old behavior.
+    const contentPath = props.path.startsWith('/') ? props.path : `/${props.path}`;
     return embedSsoContent({
         ...props,
         contentPath,

package/lib/cjs/signature.d.ts

@@ -89,7 +89,35 @@ type SignatureProps = {
      */
     userAttributes?: string;
 };
+/**
+ * Creates a signature value for the /embed/login endpoint.
+ */
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
+type RequestUrl = {
+    requestUrl: string;
+};
+type GenerateSessionSignatureProps = Omit<SignatureProps, "loginUrl" | "prefersDark" | "theme"> & RequestUrl;
+/**
+ * Creates a signature value for the /embed/sso/generate-session endpoint.
+ *
+ * For context, the /embed/sso/generate-session endpoint is step 1 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+export declare const signSessionRequest: ({ requestUrl, secret, ...props }: GenerateSessionSignatureProps) => string;
+type UseSessionSignatureProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
+    sessionId: string;
+};
+/**
+ * Creates a signature value for the /embed/sso/redeem-session endpoint.
+ *
+ * For context, the /embed/sso/redeem-session endpoint is step 2 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: UseSessionSignatureProps) => 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, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };

package/lib/cjs/signature.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_ONLY = exports.getSignature = exports.hmacSign = void 0;
+exports.TEST_ONLY = exports.signSessionRedemption = exports.signSessionRequest = exports.getSignature = exports.hmacSign = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 const base64url_1 = __importDefault(require("base64url"));
 const hmacSign = (data, secret) => {
@@ -52,10 +52,54 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         .trim()
         .replace(/\n\s+/g, "\n");
 };
+/**
+ * Creates a signature value for the /embed/login endpoint.
+ */
 const getSignature = ({ secret, ...props }) => {
     return (0, exports.hmacSign)(generateStringForSignature(props), secret);
 };
 exports.getSignature = getSignature;
+/**
+ * Creates a signature value for the /embed/sso/generate-session endpoint.
+ *
+ * For context, the /embed/sso/generate-session endpoint is step 1 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+const signSessionRequest = ({ requestUrl, secret, ...props }) => {
+    return (0, exports.getSignature)({ secret, loginUrl: requestUrl, ...props });
+};
+exports.signSessionRequest = signSessionRequest;
+/**
+ * Creates a signature value for the /embed/sso/redeem-session endpoint.
+ *
+ * For context, the /embed/sso/redeem-session endpoint is step 2 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }) => {
+    const optionalParamsMap = {
+        ...(prefersDark && { prefersDark }),
+        ...(theme && { theme }),
+    };
+    const optionalParams = Object.keys(optionalParamsMap)
+        .sort() // guarantees the order of the optional params is Alphabetical
+        .map((key) => {
+        return optionalParamsMap[key];
+    });
+    const signatureString = `
+    ${requestUrl}
+    ${nonce}
+    ${sessionId}
+    ${optionalParams.join("\n")}
+`
+        .trim()
+        .replace(/\n\s+/g, "\n");
+    return (0, exports.hmacSign)(signatureString, secret);
+};
+exports.signSessionRedemption = signSessionRedemption;
 exports.TEST_ONLY = {
     generateStringForSignature,
 };

package/lib/cjs/types.d.ts

@@ -188,8 +188,6 @@ export declare enum EmbeddedContent {
     Dashboard = "dashboards",
     Workbook = "w"
 }
-export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
-export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
 export declare enum EmbedConnectionRoles {
     RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
     VIEWER = "VIEWER",
@@ -218,6 +216,6 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
     /**
      * Path name of the content discovery page to embed.
      */
-    path: EmbedSsoContentDiscoveryPath;
+    path: string;
 };
 export {};

package/lib/cjs/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
+exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
 var EmbedSessionMode;
 (function (EmbedSessionMode) {
     EmbedSessionMode["Application"] = "APPLICATION";
@@ -68,11 +68,6 @@ var EmbeddedContent;
     EmbeddedContent["Dashboard"] = "dashboards";
     EmbeddedContent["Workbook"] = "w";
 })(EmbeddedContent || (exports.EmbeddedContent = EmbeddedContent = {}));
-exports.EmbedSsoContentDiscoveryPaths = [
-    "my",
-    "entity-folder",
-    "root",
-];
 var EmbedConnectionRoles;
 (function (EmbedConnectionRoles) {
     EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";

package/lib/esm/embed.d.ts

@@ -2,7 +2,7 @@ import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbook
 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.
+ * Generates an embed login URL using the passed-in content discovery page id.
  * @param EmbedSsoContentDiscoveryProps
  * @returns Promise wrapped around a generated embed login url.
  */

package/lib/esm/embed.js

@@ -83,7 +83,8 @@ const embedSsoContent = async (props) => {
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
     userAttributes && url.searchParams.append("userAttributes", userAttributes);
-    accessBoost !== undefined && url.searchParams.append("accessBoost", accessBoost.toString());
+    accessBoost !== undefined &&
+        url.searchParams.append("accessBoost", accessBoost.toString());
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);
@@ -111,12 +112,14 @@ export const embedSsoWorkbook = async (props) => {
     return embedSsoContent({ ...props, contentPath });
 };
 /**
- * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
+ * 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}`;
+    // Entity paths for the Content Discovery embed no longer require stripping the leading `/`.
+    // This check maintains backwards compatibility with the old behavior.
+    const contentPath = props.path.startsWith('/') ? props.path : `/${props.path}`;
     return embedSsoContent({
         ...props,
         contentPath,

package/lib/esm/signature.d.ts

@@ -89,7 +89,35 @@ type SignatureProps = {
      */
     userAttributes?: string;
 };
+/**
+ * Creates a signature value for the /embed/login endpoint.
+ */
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
+type RequestUrl = {
+    requestUrl: string;
+};
+type GenerateSessionSignatureProps = Omit<SignatureProps, "loginUrl" | "prefersDark" | "theme"> & RequestUrl;
+/**
+ * Creates a signature value for the /embed/sso/generate-session endpoint.
+ *
+ * For context, the /embed/sso/generate-session endpoint is step 1 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+export declare const signSessionRequest: ({ requestUrl, secret, ...props }: GenerateSessionSignatureProps) => string;
+type UseSessionSignatureProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
+    sessionId: string;
+};
+/**
+ * Creates a signature value for the /embed/sso/redeem-session endpoint.
+ *
+ * For context, the /embed/sso/redeem-session endpoint is step 2 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: UseSessionSignatureProps) => 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, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };

package/lib/esm/signature.js

@@ -45,9 +45,51 @@ accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityF
         .trim()
         .replace(/\n\s+/g, "\n");
 };
+/**
+ * Creates a signature value for the /embed/login endpoint.
+ */
 export const getSignature = ({ secret, ...props }) => {
     return hmacSign(generateStringForSignature(props), secret);
 };
+/**
+ * Creates a signature value for the /embed/sso/generate-session endpoint.
+ *
+ * For context, the /embed/sso/generate-session endpoint is step 1 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+export const signSessionRequest = ({ requestUrl, secret, ...props }) => {
+    return getSignature({ secret, loginUrl: requestUrl, ...props });
+};
+/**
+ * Creates a signature value for the /embed/sso/redeem-session endpoint.
+ *
+ * For context, the /embed/sso/redeem-session endpoint is step 2 of the
+ * embed 2-step login flow. All requests to this endpoint require a signature
+ * that is generated based on all other request parameters. That signature is
+ * validated by the Omni app server to ensure the request is authentic.
+ */
+export const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }) => {
+    const optionalParamsMap = {
+        ...(prefersDark && { prefersDark }),
+        ...(theme && { theme }),
+    };
+    const optionalParams = Object.keys(optionalParamsMap)
+        .sort() // guarantees the order of the optional params is Alphabetical
+        .map((key) => {
+        return optionalParamsMap[key];
+    });
+    const signatureString = `
+    ${requestUrl}
+    ${nonce}
+    ${sessionId}
+    ${optionalParams.join("\n")}
+`
+        .trim()
+        .replace(/\n\s+/g, "\n");
+    return hmacSign(signatureString, secret);
+};
 export const TEST_ONLY = {
     generateStringForSignature,
 };

package/lib/esm/types.d.ts

@@ -188,8 +188,6 @@ export declare enum EmbeddedContent {
     Dashboard = "dashboards",
     Workbook = "w"
 }
-export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
-export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
 export declare enum EmbedConnectionRoles {
     RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
     VIEWER = "VIEWER",
@@ -218,6 +216,6 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
     /**
      * Path name of the content discovery page to embed.
      */
-    path: EmbedSsoContentDiscoveryPath;
+    path: string;
 };
 export {};

package/lib/esm/types.js

@@ -65,11 +65,6 @@ export var EmbeddedContent;
     EmbeddedContent["Dashboard"] = "dashboards";
     EmbeddedContent["Workbook"] = "w";
 })(EmbeddedContent || (EmbeddedContent = {}));
-export const EmbedSsoContentDiscoveryPaths = [
-    "my",
-    "entity-folder",
-    "root",
-];
 export var EmbedConnectionRoles;
 (function (EmbedConnectionRoles) {
     EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.4.11",
+  "version": "0.5.0",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",
@@ -8,6 +8,7 @@
   ],
   "devDependencies": {
     "@types/node": "^20.8.9",
+    "semantic-release": "^24.2.1",
     "typescript": "^5.2.2",
     "vitest": "^0.34.6"
   },