@omni-co/embed 0.1.4 → 0.2.0

package/README.md

@@ -1 +1,28 @@
 # omni-embed-sdk
+
+## ⚠️ OmniEmbedSDK uses NPM! ⚠️
+
+Publishing to npmjs.org was complicated with Yarn. Until that issue is resolved, please use NPM to manage this package.
+
+## Installation
+
+1. git clone the repository
+2. `npm install`
+3. `npm run test`
+
+## Publishing
+
+1. Create a new branch
+2. Edit the package.json version number appropriately
+3. Open a PR
+4. Merge the PR
+5. Nav to the Releases page in Github: https://github.com/exploreomni/embed-sdk/releases
+6. Click "Draft new Release"
+7. Click "Choose a tag" and type in the new tag name. Convention is to prefix the new version with `v`. Example: `v1.0.0`
+8. Leave target as `main`
+9. Enter a title, usually just the release version eg `v1.0.0`
+10. Add a description
+11. Ensure `Set as latest release` is ticked, if that's appropriate
+12. Click `Publish release`
+
+🥳 - The [github action defined here](https://github.com/exploreomni/embed-sdk/blob/main/.github/workflows/publish.yml) should publish the new release to npmjs.org.

package/lib/cjs/embed.d.ts

@@ -8,6 +8,7 @@ type EmbedSsoProps = {
     port?: number;
     secret: string;
     userAttributes?: Record<string, string>;
+    entity?: string;
 };
 export declare const embedSsoDashboard: (props: EmbedSsoProps) => string;
 export {};

package/lib/cjs/embed.js

@@ -34,7 +34,7 @@ const validateProps = (props) => {
 };
 const embedSsoDashboard = (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, } = props;
     // Handle defaults
     nonce = nonce ?? (0, random_str_1.random32ByteString)();
     domain = domain ?? defaultEmbedDomain;
@@ -52,6 +52,7 @@ const embedSsoDashboard = (props) => {
         nonce,
         secret,
         userAttributes,
+        entity,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -60,6 +61,7 @@ const embedSsoDashboard = (props) => {
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
     userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    entity && url.searchParams.append("entity", entity);
     return url.toString();
 };
 exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/signature.d.ts

@@ -34,6 +34,14 @@ type SignatureProps = {
      * 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;
+};
+export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
+export declare const TEST_ONLY: {
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, }: Omit<SignatureProps, "secret">) => string;
 };
-export declare const getSignature: ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }: SignatureProps) => string;
 export {};

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.getSignature = exports.hmacSign = void 0;
+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);
@@ -11,17 +11,25 @@ const hmacSign = (data, secret) => {
     return hmac.digest("base64url");
 };
 exports.hmacSign = hmacSign;
-const getSignature = ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }) => {
-    const validationStr = `
-    ${loginUrl}
-    ${contentPath}
-    ${externalId}
-    ${name}
-    ${nonce}
-    ${userAttributes}
-`
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, }) => {
+    const optionalParams = [];
+    entity && optionalParams.push(entity);
+    userAttributes && optionalParams.push(userAttributes);
+    return `
+  ${loginUrl}
+  ${contentPath}
+  ${externalId}
+  ${name}
+  ${nonce}
+  ${optionalParams.join("\n")}
+  `
         .trim()
         .replace(/\n\s+/g, "\n");
-    return (0, exports.hmacSign)(validationStr, secret);
+};
+const getSignature = ({ secret, ...props }) => {
+    return (0, exports.hmacSign)(generateStringForSignature(props), secret);
 };
 exports.getSignature = getSignature;
+exports.TEST_ONLY = {
+    generateStringForSignature,
+};

package/lib/esm/embed.d.ts

@@ -8,6 +8,7 @@ type EmbedSsoProps = {
     port?: number;
     secret: string;
     userAttributes?: Record<string, string>;
+    entity?: string;
 };
 export declare const embedSsoDashboard: (props: EmbedSsoProps) => string;
 export {};

package/lib/esm/embed.js

@@ -31,7 +31,7 @@ const validateProps = (props) => {
 };
 export const embedSsoDashboard = (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, } = props;
     // Handle defaults
     nonce = nonce ?? random32ByteString();
     domain = domain ?? defaultEmbedDomain;
@@ -49,6 +49,7 @@ export const embedSsoDashboard = (props) => {
         nonce,
         secret,
         userAttributes,
+        entity,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -57,5 +58,6 @@ export const embedSsoDashboard = (props) => {
     url.searchParams.append("nonce", nonce);
     url.searchParams.append("signature", signature);
     userAttributes && url.searchParams.append("userAttributes", userAttributes);
+    entity && url.searchParams.append("entity", entity);
     return url.toString();
 };

package/lib/esm/signature.d.ts

@@ -34,6 +34,14 @@ type SignatureProps = {
      * 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;
+};
+export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
+export declare const TEST_ONLY: {
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, }: Omit<SignatureProps, "secret">) => string;
 };
-export declare const getSignature: ({ loginUrl, contentPath, externalId, name, nonce, secret, userAttributes, }: SignatureProps) => string;
 export {};

package/lib/esm/signature.js

@@ -4,16 +4,24 @@ export const hmacSign = (data, 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}
-`
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, }) => {
+    const optionalParams = [];
+    entity && optionalParams.push(entity);
+    userAttributes && optionalParams.push(userAttributes);
+    return `
+  ${loginUrl}
+  ${contentPath}
+  ${externalId}
+  ${name}
+  ${nonce}
+  ${optionalParams.join("\n")}
+  `
         .trim()
         .replace(/\n\s+/g, "\n");
-    return hmacSign(validationStr, secret);
+};
+export const getSignature = ({ secret, ...props }) => {
+    return hmacSign(generateStringForSignature(props), secret);
+};
+export const TEST_ONLY = {
+    generateStringForSignature,
 };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.4",
+  "version": "0.2.0",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",
@@ -17,7 +17,8 @@
     "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
     "clean": "rm -rf lib",
     "prepublishOnly": "npm run build",
-    "test": "vitest"
+    "test": "vitest",
+    "test:watch": "vitest --watch"
   },
   "dependencies": {
     "nanoid": "^5.0.2"