@omni-co/embed 0.1.3 → 0.1.4

package/lib/cjs/embed.d.ts

@@ -5,6 +5,7 @@ type EmbedSsoProps = {
     name: string;
     nonce?: string;
     organizationName: string;
+    port?: number;
     secret: string;
     userAttributes?: Record<string, string>;
 };

package/lib/cjs/embed.js

@@ -1,16 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.embedSsoDashboard = void 0;
-const crypto_1 = __importDefault(require("crypto"));
 const random_str_1 = require("./random-str");
-const hmacSign = (data, secret) => {
-    const hmac = crypto_1.default.createHmac("sha256", secret);
-    hmac.update(data);
-    return hmac.digest("base64url");
-};
+const signature_1 = require("./signature");
+const defaultEmbedDomain = "embed-omniapp.co";
 const embedLoginRoute = "/embed/login";
 const embedDashboardPath = "/embed/dashboards";
 const validateProps = (props) => {
@@ -41,32 +34,32 @@ const validateProps = (props) => {
 };
 const embedSsoDashboard = (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, secret, userAttributes, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, } = props;
     // Handle defaults
     nonce = nonce ?? (0, random_str_1.random32ByteString)();
-    domain = domain ?? "embed-omniapp.co";
-    const encodedUserAttributes = userAttributes
-        ? JSON.stringify(userAttributes)
-        : "";
-    const url = new URL(embedLoginRoute, `https://${organizationName.toLocaleLowerCase()}.${domain}`);
+    domain = domain ?? defaultEmbedDomain;
+    const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
+    // 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 validationStr = `
-      ${url.hostname}${embedLoginRoute}
-      ${contentPath}
-      ${externalId}
-      ${name}
-      ${nonce}
-      ${encodedUserAttributes}
-    `
-        .trim()
-        .replace(/\n\s+/g, "\n");
-    const signature = hmacSign(validationStr, secret);
+    // Get a signature for the request
+    const signature = (0, signature_1.getSignature)({
+        loginUrl: url.toString(),
+        contentPath,
+        externalId,
+        name,
+        nonce,
+        secret,
+        userAttributes,
+    });
+    // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
     url.searchParams.append("externalId", externalId);
     url.searchParams.append("name", name);
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
-    url.searchParams.append("userAttributes", encodedUserAttributes);
+    userAttributes && url.searchParams.append("userAttributes", userAttributes);
     return url.toString();
 };
 exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/index.d.ts

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

package/lib/cjs/index.js

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

package/lib/cjs/signature.d.ts

@@ -0,0 +1,39 @@
+export declare const hmacSign: (data: string, secret: string) => string;
+type SignatureProps = {
+    /**
+     * The protocol, domain, optional port and /embed/login route of the request.
+     *
+     * Example: `https://example.embed-omniapp.com/embed/login`
+     */
+    loginUrl: string;
+    /**
+     * The path to the content being embedded.
+     *
+     * Example: /embed/dashboards/123abc
+     */
+    contentPath: string;
+    /**
+     * The external id of the user.
+     */
+    externalId: string;
+    /**
+     * The name of the user.
+     */
+    name: string;
+    /**
+     * The nonce of the request.
+     */
+    nonce: string;
+    /**
+     * The secret used to sign the request
+     */
+    secret: string;
+    /**
+     * The user attributes to be sent with the request. Expected to be a stringified JSON object.
+     *
+     * Example: '{ "team": "Lakers" }'
+     */
+    userAttributes?: string;
+};
+export declare const getSignature: ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }: SignatureProps) => string;
+export {};

package/lib/cjs/signature.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignature = exports.hmacSign = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const hmacSign = (data, secret) => {
+    const hmac = crypto_1.default.createHmac("sha256", secret);
+    hmac.update(data);
+    return hmac.digest("base64url");
+};
+exports.hmacSign = hmacSign;
+const getSignature = ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }) => {
+    const validationStr = `
+    ${loginUrl}
+    ${contentPath}
+    ${externalId}
+    ${name}
+    ${nonce}
+    ${userAttributes}
+`
+        .trim()
+        .replace(/\n\s+/g, "\n");
+    return (0, exports.hmacSign)(validationStr, secret);
+};
+exports.getSignature = getSignature;

package/lib/esm/embed.d.ts

@@ -5,6 +5,7 @@ type EmbedSsoProps = {
     name: string;
     nonce?: string;
     organizationName: string;
+    port?: number;
     secret: string;
     userAttributes?: Record<string, string>;
 };

package/lib/esm/embed.js

@@ -1,10 +1,6 @@
-import crypto from "crypto";
 import { random32ByteString } from "./random-str";
-const hmacSign = (data, secret) => {
-    const hmac = crypto.createHmac("sha256", secret);
-    hmac.update(data);
-    return hmac.digest("base64url");
-};
+import { getSignature } from "./signature";
+const defaultEmbedDomain = "embed-omniapp.co";
 const embedLoginRoute = "/embed/login";
 const embedDashboardPath = "/embed/dashboards";
 const validateProps = (props) => {
@@ -35,31 +31,31 @@ const validateProps = (props) => {
 };
 export const embedSsoDashboard = (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, secret, userAttributes, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, } = props;
     // Handle defaults
     nonce = nonce ?? random32ByteString();
-    domain = domain ?? "embed-omniapp.co";
-    const encodedUserAttributes = userAttributes
-        ? JSON.stringify(userAttributes)
-        : "";
-    const url = new URL(embedLoginRoute, `https://${organizationName.toLocaleLowerCase()}.${domain}`);
+    domain = domain ?? defaultEmbedDomain;
+    const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
+    // 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 validationStr = `
-      ${url.hostname}${embedLoginRoute}
-      ${contentPath}
-      ${externalId}
-      ${name}
-      ${nonce}
-      ${encodedUserAttributes}
-    `
-        .trim()
-        .replace(/\n\s+/g, "\n");
-    const signature = hmacSign(validationStr, secret);
+    // Get a signature for the request
+    const signature = getSignature({
+        loginUrl: url.toString(),
+        contentPath,
+        externalId,
+        name,
+        nonce,
+        secret,
+        userAttributes,
+    });
+    // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
     url.searchParams.append("externalId", externalId);
     url.searchParams.append("name", name);
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
-    url.searchParams.append("userAttributes", encodedUserAttributes);
+    userAttributes && url.searchParams.append("userAttributes", userAttributes);
     return url.toString();
 };

package/lib/esm/index.d.ts

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

package/lib/esm/index.js

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

package/lib/esm/signature.d.ts

@@ -0,0 +1,39 @@
+export declare const hmacSign: (data: string, secret: string) => string;
+type SignatureProps = {
+    /**
+     * The protocol, domain, optional port and /embed/login route of the request.
+     *
+     * Example: `https://example.embed-omniapp.com/embed/login`
+     */
+    loginUrl: string;
+    /**
+     * The path to the content being embedded.
+     *
+     * Example: /embed/dashboards/123abc
+     */
+    contentPath: string;
+    /**
+     * The external id of the user.
+     */
+    externalId: string;
+    /**
+     * The name of the user.
+     */
+    name: string;
+    /**
+     * The nonce of the request.
+     */
+    nonce: string;
+    /**
+     * The secret used to sign the request
+     */
+    secret: string;
+    /**
+     * The user attributes to be sent with the request. Expected to be a stringified JSON object.
+     *
+     * Example: '{ "team": "Lakers" }'
+     */
+    userAttributes?: string;
+};
+export declare const getSignature: ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }: SignatureProps) => string;
+export {};

package/lib/esm/signature.js

@@ -0,0 +1,19 @@
+import crypto from "crypto";
+export const hmacSign = (data, secret) => {
+    const hmac = crypto.createHmac("sha256", secret);
+    hmac.update(data);
+    return hmac.digest("base64url");
+};
+export const getSignature = ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }) => {
+    const validationStr = `
+    ${loginUrl}
+    ${contentPath}
+    ${externalId}
+    ${name}
+    ${nonce}
+    ${userAttributes}
+`
+        .trim()
+        .replace(/\n\s+/g, "\n");
+    return hmacSign(validationStr, secret);
+};

package/package.json

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