@omni-co/embed 0.3.0-pre.1 → 0.3.0-pre.3

package/README.md

@@ -19,7 +19,7 @@ yarn add @omni-co/embed
 
   // This creates a signed embed sso link for a dashboard
   // in the omni account named Acme.
-  const iframeUrl = embedSsoDashboard({
+  const iframeUrl = await embedSsoDashboard({
     contentId: "miU0hL6z",
     externalId: "wile.e@coyote.co",
     name: "Wile E",
@@ -35,7 +35,7 @@ yarn add @omni-co/embed
 
   // This creates a signed embed sso link for a dashboard
   // in the omni account named Acme.
-  const iframeUrl = embedSsoDashboard({
+  const iframeUrl = await embedSsoDashboard({
     contentId: "miU0hL6z",
     externalId: "wile.e@coyote.co",
     entity: "cartoon",

package/lib/{embed.d.ts → cjs/embed.d.ts}

@@ -12,5 +12,5 @@ type EmbedSsoProps = {
     nonce?: string;
     port?: number;
 };
-export declare const embedSsoDashboard: (props: EmbedSsoProps) => string;
+export declare const embedSsoDashboard: (props: EmbedSsoProps) => Promise<string>;
 export {};

package/lib/cjs/embed.js

@@ -0,0 +1,71 @@
+"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 = async (props) => {
+    validateProps(props);
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    // Handle defaults
+    nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
+    domain = domain !== null && domain !== void 0 ? 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,
+        entity,
+        prefersDark,
+        theme,
+    });
+    // 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);
+    entity && url.searchParams.append("entity", entity);
+    prefersDark && url.searchParams.append("prefersDark", prefersDark);
+    theme && url.searchParams.append("theme", theme);
+    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: () => Promise<string>;

package/lib/cjs/random-str.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.random32ByteString = void 0;
+const nanoid = import("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.
+const random32ByteString = async () => {
+    const { customAlphabet } = await nanoid;
+    return customAlphabet(humanReadableByteSpace, 32)();
+};
+exports.random32ByteString = random32ByteString;

package/lib/cjs/signature.js

@@ -0,0 +1,37 @@
+"use strict";
+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;
+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 generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }) => {
+    const optionalParams = [];
+    entity && optionalParams.push(entity);
+    prefersDark && optionalParams.push(prefersDark);
+    theme && optionalParams.push(theme);
+    userAttributes && optionalParams.push(userAttributes);
+    return `
+  ${loginUrl}
+  ${contentPath}
+  ${externalId}
+  ${name}
+  ${nonce}
+  ${optionalParams.join("\n")}
+  `
+        .trim()
+        .replace(/\n\s+/g, "\n");
+};
+const getSignature = ({ secret, ...props }) => {
+    return (0, exports.hmacSign)(generateStringForSignature(props), secret);
+};
+exports.getSignature = getSignature;
+exports.TEST_ONLY = {
+    generateStringForSignature,
+};

package/lib/esm/embed.d.ts

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

package/lib/{embed.js → esm/embed.js}

@@ -1,5 +1,5 @@
-import { random32ByteString } from "./random-str.js";
-import { getSignature } from "./signature.js";
+import { random32ByteString } from "./random-str";
+import { getSignature } from "./signature";
 const defaultEmbedDomain = "embed-omniapp.co";
 const embedLoginRoute = "/embed/login";
 const embedDashboardPath = "/embed/dashboards";
@@ -29,11 +29,11 @@ const validateProps = (props) => {
         }
     }
 };
-export const embedSsoDashboard = (props) => {
+export const embedSsoDashboard = async (props) => {
     validateProps(props);
     let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     // Handle defaults
-    nonce = nonce !== null && nonce !== void 0 ? nonce : random32ByteString();
+    nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
     const userAttributes = rawUserAttributes && JSON.stringify(rawUserAttributes);
     // Generate the url for the embed login route

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: () => Promise<string>;

package/lib/{random-str.js → esm/random-str.js}

@@ -1,8 +1,11 @@
-import { customAlphabet } from "nanoid";
+const nanoid = import("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);
+export const random32ByteString = async () => {
+    const { customAlphabet } = await nanoid;
+    return customAlphabet(humanReadableByteSpace, 32)();
+};

package/lib/esm/signature.d.ts

@@ -0,0 +1,55 @@
+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;
+    /**
+     * The entity that the created embed user will belong to. Practically speaking, the embed
+     * user will this value assigned to its omni_user_embed_entity user attribute.
+     */
+    entity?: string;
+    /**
+     * Whether the user prefers light, dark, or system theme.
+     */
+    prefersDark?: string;
+    /**
+     * The theme of the embed.
+     */
+    theme?: string;
+};
+export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
+export declare const TEST_ONLY: {
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }: Omit<SignatureProps, "secret">) => string;
+};
+export {};

package/lib/{signature.js → esm/signature.js}

@@ -1,14 +1,3 @@
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 import crypto from "crypto";
 export const hmacSign = (data, secret) => {
     const hmac = crypto.createHmac("sha256", secret);
@@ -32,8 +21,7 @@ const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, n
         .trim()
         .replace(/\n\s+/g, "\n");
 };
-export const getSignature = (_a) => {
-    var { secret } = _a, props = __rest(_a, ["secret"]);
+export const getSignature = ({ secret, ...props }) => {
     return hmacSign(generateStringForSignature(props), secret);
 };
 export const TEST_ONLY = {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.0-pre.1",
+  "version": "0.3.0-pre.3",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",
@@ -12,7 +12,7 @@
     "vitest": "^0.34.6"
   },
   "scripts": {
-    "build": "npm run clean && tsc -p tsconfig.json",
+    "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
     "clean": "rm -rf lib",
     "prepublishOnly": "npm run build",
     "test": "vitest",
@@ -21,7 +21,19 @@
   "dependencies": {
     "nanoid": "^5.0.2"
   },
-  "exports": "./lib/index.js",
-  "types": "./lib/index.d.ts",
-  "type": "module"
+  "engines": {
+    "node": ">=16"
+  },
+  "engineStrict": true,
+  "types": "./lib/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./lib/esm/index.js": "./lib/esm/index.js",
+    "./lib/cjs/index.js": "./lib/cjs/index.js",
+    "./lib/esm": "./lib/esm/index.js",
+    "./lib/cjs": "./lib/cjs/index.js"
+  }
 }

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/random-str.d.ts

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