@omni-co/embed 0.1.2 → 0.1.4

package/lib/cjs/embed.d.ts

@@ -0,0 +1,13 @@
+type EmbedSsoProps = {
+    contentId: string;
+    domain?: string;
+    externalId: string;
+    name: string;
+    nonce?: string;
+    organizationName: string;
+    port?: number;
+    secret: string;
+    userAttributes?: Record<string, string>;
+};
+export declare const embedSsoDashboard: (props: EmbedSsoProps) => string;
+export {};

package/lib/cjs/embed.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.embedSsoDashboard = void 0;
+const random_str_1 = require("./random-str");
+const signature_1 = require("./signature");
+const defaultEmbedDomain = "embed-omniapp.co";
+const embedLoginRoute = "/embed/login";
+const embedDashboardPath = "/embed/dashboards";
+const validateProps = (props) => {
+    const { contentId, externalId, name, nonce, organizationName, secret, userAttributes, } = props;
+    if (!contentId) {
+        throw new Error("contentId is required");
+    }
+    if (!externalId) {
+        throw new Error("externalId is required");
+    }
+    if (!name) {
+        throw new Error("name is required");
+    }
+    if (!organizationName) {
+        throw new Error("organizationName is required");
+    }
+    if (!secret) {
+        throw new Error("secret is required");
+    }
+    if (nonce && nonce.length !== 32) {
+        throw new Error("nonce must be 32 characters");
+    }
+    if (typeof userAttributes !== "object") {
+        if (userAttributes) {
+            throw new Error("userAttributes must be an object");
+        }
+    }
+};
+const embedSsoDashboard = (props) => {
+    validateProps(props);
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, } = props;
+    // Handle defaults
+    nonce = nonce ?? (0, random_str_1.random32ByteString)();
+    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}`;
+    // 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);
+    userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    return url.toString();
+};
+exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/index.d.ts

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

package/lib/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./embed"), exports);
+__exportStar(require("./signature"), exports);

package/lib/cjs/random-str.d.ts

@@ -0,0 +1 @@
+export declare const random32ByteString: (size?: number | undefined) => string;

package/lib/cjs/random-str.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.random32ByteString = void 0;
+const nanoid_1 = require("nanoid");
+const humanReadableByteSpace = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+// Generates a random 32 byte, human readable string.
+// Based on math at https://zelark.github.io/nano-id-cc/
+// at 1000 Ids/s it would take more than 1 quadrillion years or
+// 8,730,800,738,924,245T IDs, in order to have a 1% probability
+// of at least one collision.
+exports.random32ByteString = (0, nanoid_1.customAlphabet)(humanReadableByteSpace, 32);

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

@@ -0,0 +1,13 @@
+type EmbedSsoProps = {
+    contentId: string;
+    domain?: string;
+    externalId: string;
+    name: string;
+    nonce?: string;
+    organizationName: string;
+    port?: number;
+    secret: string;
+    userAttributes?: Record<string, string>;
+};
+export declare const embedSsoDashboard: (props: EmbedSsoProps) => string;
+export {};

package/lib/esm/embed.js

@@ -0,0 +1,61 @@
+import { random32ByteString } from "./random-str";
+import { getSignature } from "./signature";
+const defaultEmbedDomain = "embed-omniapp.co";
+const embedLoginRoute = "/embed/login";
+const embedDashboardPath = "/embed/dashboards";
+const validateProps = (props) => {
+    const { contentId, externalId, name, nonce, organizationName, secret, userAttributes, } = props;
+    if (!contentId) {
+        throw new Error("contentId is required");
+    }
+    if (!externalId) {
+        throw new Error("externalId is required");
+    }
+    if (!name) {
+        throw new Error("name is required");
+    }
+    if (!organizationName) {
+        throw new Error("organizationName is required");
+    }
+    if (!secret) {
+        throw new Error("secret is required");
+    }
+    if (nonce && nonce.length !== 32) {
+        throw new Error("nonce must be 32 characters");
+    }
+    if (typeof userAttributes !== "object") {
+        if (userAttributes) {
+            throw new Error("userAttributes must be an object");
+        }
+    }
+};
+export const embedSsoDashboard = (props) => {
+    validateProps(props);
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, } = props;
+    // Handle defaults
+    nonce = nonce ?? random32ByteString();
+    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}`;
+    // 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);
+    userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    return url.toString();
+};

package/lib/esm/index.d.ts

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

package/lib/esm/index.js

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

package/lib/esm/random-str.d.ts

@@ -0,0 +1 @@
+export declare const random32ByteString: (size?: number | undefined) => string;

package/lib/esm/random-str.js

@@ -0,0 +1,8 @@
+import { customAlphabet } from "nanoid";
+const humanReadableByteSpace = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+// Generates a random 32 byte, human readable string.
+// Based on math at https://zelark.github.io/nano-id-cc/
+// at 1000 Ids/s it would take more than 1 quadrillion years or
+// 8,730,800,738,924,245T IDs, in order to have a 1% probability
+// of at least one collision.
+export const random32ByteString = customAlphabet(humanReadableByteSpace, 32);

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,14 +1,13 @@
 {
-  "version": "0.1.2",
+  "version": "0.1.4",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",
   "files": [
-    "lib/"
+    "lib/**/*"
   ],
-  "prepublishOnly": "npm run build",
   "devDependencies": {
     "@types/node": "^20.8.9",
     "typescript": "^5.2.2",
@@ -17,6 +16,7 @@
   "scripts": {
     "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
     "clean": "rm -rf lib",
+    "prepublishOnly": "npm run build",
     "test": "vitest"
   },
   "dependencies": {