@omni-co/embed 0.2.1 → 0.2.3

package/README.md

@@ -1,28 +1,89 @@
-# omni-embed-sdk
+# Omni Embed SSO Typescript SDK
 
-## ⚠️ OmniEmbedSDK uses NPM! ⚠️
+## Install
 
-Publishing to npmjs.org was complicated with Yarn. Until that issue is resolved, please use NPM to manage this package.
+npm:
+```
+npm install @omni-co/embed
+```
 
-## Installation
+yarn:
+```
+yarn add @omni-co/embed
+```
 
-1. git clone the repository
-2. `npm install`
-3. `npm run test`
+## Basic Example
 
-## Publishing
+```ts
+  import { embedSsoDashboard } from '@omni-co/embed'
 
-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`
+  // This creates a signed embed sso link for a dashboard
+  // in the omni account named Acme.
+  const iframeUrl = embedSsoDashboard({
+    contentId: "miU0hL6z",
+    externalId: "wile.e@coyote.co",
+    name: "Wile E",
+    organizationName: "acme",
+    secret: "abcdefghijklmnopqrstuvwxyz123456",
+  });
+```
 
-🥳 - 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.
+## 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 = 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
+
+This is the type signature for the embedSsoDashboard function:
+
+```ts
+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 
+  // automatically generated internal Omni user.
+  externalId: string;
+
+  // Required name of the external user.
+  name: string;
+
+  // Required Omni organization which contains the dashboard.
+  organizationName: string;
+
+  // Signing secret available to Omni admins.
+  secret: string;
+
+  // 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>;
+
+  // Optional dark mode setting. Can be one of "true", "false", or "system".
+  prefersDark?: string;
+
+  // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
+  theme?: string;
+};
+
+```

package/lib/cjs/embed.d.ts

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

package/lib/esm/embed.d.ts

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

package/package.json

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