@omni-co/embed 0.1.0-beta7 → 0.1.0

package/lib/cjs/embed.d.ts

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

package/lib/cjs/embed.js

@@ -0,0 +1,72 @@
+"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 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 (userAttributes) {
+        if (!Array.isArray(userAttributes)) {
+            throw new Error("userAttributes must be an array");
+        }
+    }
+};
+const embedSsoDashboard = (props) => {
+    validateProps(props);
+    let { contentId, domain, externalId, name, nonce, organizationName, secret, userAttributes, } = 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}`);
+    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);
+    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);
+    return url.toString();
+};
+exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/index.d.ts

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

package/lib/cjs/index.js

@@ -0,0 +1,17 @@
+"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);

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/esm/embed.d.ts

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

package/lib/esm/embed.js

@@ -0,0 +1,65 @@
+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");
+};
+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 (userAttributes) {
+        if (!Array.isArray(userAttributes)) {
+            throw new Error("userAttributes must be an array");
+        }
+    }
+};
+export const embedSsoDashboard = (props) => {
+    validateProps(props);
+    let { contentId, domain, externalId, name, nonce, organizationName, secret, userAttributes, } = 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}`);
+    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);
+    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);
+    return url.toString();
+};

package/lib/esm/index.d.ts

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

package/lib/esm/index.js

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

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/package.json

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