@omni-co/embed 0.3.0 → 0.3.2

package/README.md

@@ -3,11 +3,13 @@
 ## Install
 
 npm:
+
 ```
 npm install @omni-co/embed
 ```
 
 yarn:
+
 ```
 yarn add @omni-co/embed
 ```
@@ -15,37 +17,37 @@ yarn add @omni-co/embed
 ## Basic Example
 
 ```ts
-  import { embedSsoDashboard } from '@omni-co/embed'
-
-  // This creates a signed embed sso link for a dashboard
-  // in the omni account named Acme.
-  const iframeUrl = await embedSsoDashboard({
-    contentId: "miU0hL6z",
-    externalId: "wile.e@coyote.co",
-    name: "Wile E",
-    organizationName: "acme",
-    secret: "abcdefghijklmnopqrstuvwxyz123456",
-  });
+import { embedSsoDashboard } from "@omni-co/embed";
+
+// This creates a signed embed sso link for a dashboard
+// in the omni account named Acme.
+const iframeUrl = await embedSsoDashboard({
+  contentId: "miU0hL6z",
+  externalId: "wile.e@coyote.co",
+  name: "Wile E",
+  organizationName: "acme",
+  secret: "abcdefghijklmnopqrstuvwxyz123456",
+});
 ```
 
 ## Kitchen Sink Example
 
 ```ts
-  import { embedSsoDashboard } from '@omni-co/embed'
-
-  // This creates a signed embed sso link for a dashboard
-  // in the omni account named Acme.
-  const iframeUrl = await embedSsoDashboard({
-    contentId: "miU0hL6z",
-    externalId: "wile.e@coyote.co",
-    entity: "cartoon",
-    name: "Wile E",
-    organizationName: "acme",
-    secret: "abcdefghijklmnopqrstuvwxyz123456",
-    prefersDark: "system",
-    theme: "vibes",
-    userAttributes: { tool: "anvil" }
-  });
+import { embedSsoDashboard } from "@omni-co/embed";
+
+// This creates a signed embed sso link for a dashboard
+// in the omni account named Acme.
+const iframeUrl = await embedSsoDashboard({
+  contentId: "miU0hL6z",
+  externalId: "wile.e@coyote.co",
+  entity: "cartoon",
+  name: "Wile E",
+  organizationName: "acme",
+  secret: "abcdefghijklmnopqrstuvwxyz123456",
+  prefersDark: "system",
+  theme: "vibes",
+  userAttributes: { tool: "anvil" },
+});
 ```
 
 ## embedSsoDashboard
@@ -57,7 +59,7 @@ type EmbedSsoDashboardProps = {
   // Short GUID of the dashboard. Can be obtained via the dashboard's url.
   contentId: string;
 
-  // Required identifier to associate the external user with an 
+  // Required identifier to associate the external user with an
   // automatically generated internal Omni user.
   externalId: string;
 
@@ -70,14 +72,14 @@ type EmbedSsoDashboardProps = {
   // Signing secret available to Omni admins.
   secret: string;
 
-  // Optional identifier to associate the user with an external 
+  // Optional identifier to associate the user with an external
   // organization or system.
   entity?: string;
 
   // Optional user attributes to be passed to user associated with the
   // externalId. User attributes must be created in Omni before being
   // defined and given a value here.
-  userAttributes?: Record<string, string>;
+  userAttributes?: Record<string, string | string[] | number | number[]>;
 
   // Optional dark mode setting. Can be one of "true", "false", or "system".
   prefersDark?: string;
@@ -85,5 +87,4 @@ type EmbedSsoDashboardProps = {
   // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
   theme?: string;
 };
-
 ```

package/lib/cjs/embed.d.ts

@@ -1,3 +1,4 @@
+type UserAttributeValue = string | string[] | number | number[];
 type EmbedSsoProps = {
     contentId: string;
     externalId: string;
@@ -5,9 +6,10 @@ type EmbedSsoProps = {
     organizationName: string;
     secret: string;
     entity?: string;
-    userAttributes?: Record<string, string>;
+    userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    filterSearchParam?: string;
     domain?: string;
     nonce?: string;
     port?: number;

package/lib/cjs/embed.js

@@ -34,7 +34,7 @@ const validateProps = (props) => {
 };
 const embedSsoDashboard = async (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, filterSearchParam, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -55,6 +55,7 @@ const embedSsoDashboard = async (props) => {
         entity,
         prefersDark,
         theme,
+        filterSearchParam,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -66,6 +67,8 @@ const embedSsoDashboard = async (props) => {
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);
+    filterSearchParam &&
+        url.searchParams.append("filterSearchParam", filterSearchParam);
     return url.toString();
 };
 exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/signature.d.ts

@@ -47,9 +47,13 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * Filter search parameter.
+     */
+    filterSearchParam?: 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;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -13,9 +13,10 @@ const hmacSign = (data, secret) => {
     return base64url_1.default.fromBase64(b64);
 };
 exports.hmacSign = hmacSign;
-const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }) => {
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }) => {
     const optionalParams = [];
     entity && optionalParams.push(entity);
+    filterSearchParam && optionalParams.push(filterSearchParam);
     prefersDark && optionalParams.push(prefersDark);
     theme && optionalParams.push(theme);
     userAttributes && optionalParams.push(userAttributes);

package/lib/esm/embed.d.ts

@@ -1,3 +1,4 @@
+type UserAttributeValue = string | string[] | number | number[];
 type EmbedSsoProps = {
     contentId: string;
     externalId: string;
@@ -5,9 +6,10 @@ type EmbedSsoProps = {
     organizationName: string;
     secret: string;
     entity?: string;
-    userAttributes?: Record<string, string>;
+    userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    filterSearchParam?: string;
     domain?: string;
     nonce?: string;
     port?: number;

package/lib/esm/embed.js

@@ -31,7 +31,7 @@ const validateProps = (props) => {
 };
 export const embedSsoDashboard = async (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, filterSearchParam, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -52,6 +52,7 @@ export const embedSsoDashboard = async (props) => {
         entity,
         prefersDark,
         theme,
+        filterSearchParam,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -63,5 +64,7 @@ export const embedSsoDashboard = async (props) => {
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);
+    filterSearchParam &&
+        url.searchParams.append("filterSearchParam", filterSearchParam);
     return url.toString();
 };

package/lib/esm/signature.d.ts

@@ -47,9 +47,13 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * Filter search parameter.
+     */
+    filterSearchParam?: 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;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -6,9 +6,10 @@ export const hmacSign = (data, secret) => {
     const b64 = hmac.digest("base64");
     return base64url.fromBase64(b64);
 };
-const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }) => {
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }) => {
     const optionalParams = [];
     entity && optionalParams.push(entity);
+    filterSearchParam && optionalParams.push(filterSearchParam);
     prefersDark && optionalParams.push(prefersDark);
     theme && optionalParams.push(theme);
     userAttributes && optionalParams.push(userAttributes);

package/package.json

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