@omni-co/embed 0.3.0 → 0.3.1

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,7 +6,7 @@ type EmbedSsoProps = {
     organizationName: string;
     secret: string;
     entity?: string;
-    userAttributes?: Record<string, string>;
+    userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
     domain?: string;

package/lib/esm/embed.d.ts

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

package/package.json

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