@omni-co/embed 0.4.0 → 0.4.1

package/lib/cjs/embed.js

@@ -7,7 +7,7 @@ const types_1 = require("./types");
 const defaultEmbedDomain = "embed-omniapp.co";
 const embedLoginPath = "/embed/login";
 const validateProps = (props) => {
-    const { externalId, name, nonce, secret, userAttributes } = props;
+    const { externalId, name, nonce, secret, userAttributes, customTheme, customThemeId, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -25,6 +25,8 @@ const validateProps = (props) => {
         throw new Error("Must specify either `host` or `organizationName`");
     if (host && (organizationName || domain))
         throw new Error("`host` must be used exclusively and cannot be combined with `organizationName` or `domain` (domain is deprecated)");
+    if (customThemeId && customTheme)
+        console.warn("If you use a `customThemeId` any theme styles passed in via `customTheme` will be ignored.");
     if (domain)
         console.warn("`domain` is deprecated and will be removed in a future v1.0.0 release. Use `host` to specify your vanity domain instead (eg `host: 'omni.my-company.com'`).");
     if (nonce && nonce.length !== 32)
@@ -34,7 +36,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -66,6 +68,7 @@ const embedSsoContent = async (props) => {
         filterSearchParam,
         linkAccess,
         customTheme,
+        customThemeId,
         connectionRoles,
         accessBoost,
         mode,
@@ -85,6 +88,7 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("filterSearchParam", filterSearchParam);
     linkAccess && url.searchParams.append("linkAccess", linkAccess);
     customTheme && url.searchParams.append("customTheme", customTheme);
+    customThemeId && url.searchParams.append("customThemeId", customThemeId);
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
     mode && url.searchParams.append("mode", mode);

package/lib/cjs/signature.d.ts

@@ -42,6 +42,10 @@ type SignatureProps = {
      * Example: '{ "dashboard-background-color": "hotpink" }'
      */
     customTheme?: string;
+    /**
+     * The custom theme id to be sent with the request. This Id refers to an Custom Theme created in the Omni App.
+     */
+    customThemeId?: 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.
@@ -76,6 +80,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -17,13 +17,14 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
     // We create a map of optional params and convert it to an array
     // to ensure that the order of the optional params is alphabetical and consistent.
     const optionalParamsMap = {
         ...(accessBoost && { accessBoost: accessBoost === null || accessBoost === void 0 ? void 0 : accessBoost.toString() }),
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
+        ...(customThemeId && { customThemeId }),
         ...(entity && { entity }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(linkAccess && { linkAccess }),

package/lib/cjs/types.d.ts

@@ -58,6 +58,7 @@ type EmbedSsoDashboardOnlyProps = {
     filterSearchParam?: string;
     linkAccess?: string;
     customTheme?: CustomThemeProperties;
+    customThemeId?: string;
 };
 type EmbedContentIdProp = {
     contentId: string;

package/lib/esm/embed.js

@@ -4,7 +4,7 @@ import { EmbeddedContent, } from "./types";
 const defaultEmbedDomain = "embed-omniapp.co";
 const embedLoginPath = "/embed/login";
 const validateProps = (props) => {
-    const { externalId, name, nonce, secret, userAttributes } = props;
+    const { externalId, name, nonce, secret, userAttributes, customTheme, customThemeId, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -22,6 +22,8 @@ const validateProps = (props) => {
         throw new Error("Must specify either `host` or `organizationName`");
     if (host && (organizationName || domain))
         throw new Error("`host` must be used exclusively and cannot be combined with `organizationName` or `domain` (domain is deprecated)");
+    if (customThemeId && customTheme)
+        console.warn("If you use a `customThemeId` any theme styles passed in via `customTheme` will be ignored.");
     if (domain)
         console.warn("`domain` is deprecated and will be removed in a future v1.0.0 release. Use `host` to specify your vanity domain instead (eg `host: 'omni.my-company.com'`).");
     if (nonce && nonce.length !== 32)
@@ -31,7 +33,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, externalId, filterSearchParam, linkAccess, mode, name, nonce, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
     let host, domain, organizationName;
     if ("host" in props)
         host = props.host;
@@ -63,6 +65,7 @@ const embedSsoContent = async (props) => {
         filterSearchParam,
         linkAccess,
         customTheme,
+        customThemeId,
         connectionRoles,
         accessBoost,
         mode,
@@ -82,6 +85,7 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("filterSearchParam", filterSearchParam);
     linkAccess && url.searchParams.append("linkAccess", linkAccess);
     customTheme && url.searchParams.append("customTheme", customTheme);
+    customThemeId && url.searchParams.append("customThemeId", customThemeId);
     connectionRoles &&
         url.searchParams.append("connectionRoles", connectionRoles);
     mode && url.searchParams.append("mode", mode);

package/lib/esm/signature.d.ts

@@ -42,6 +42,10 @@ type SignatureProps = {
      * Example: '{ "dashboard-background-color": "hotpink" }'
      */
     customTheme?: string;
+    /**
+     * The custom theme id to be sent with the request. This Id refers to an Custom Theme created in the Omni App.
+     */
+    customThemeId?: 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.
@@ -76,6 +80,6 @@ type SignatureProps = {
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -10,13 +10,14 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
+accessBoost, connectionRoles, customTheme, customThemeId, entity, filterSearchParam, linkAccess, mode, prefersDark, theme, userAttributes, }) => {
     // We create a map of optional params and convert it to an array
     // to ensure that the order of the optional params is alphabetical and consistent.
     const optionalParamsMap = {
         ...(accessBoost && { accessBoost: accessBoost === null || accessBoost === void 0 ? void 0 : accessBoost.toString() }),
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
+        ...(customThemeId && { customThemeId }),
         ...(entity && { entity }),
         ...(filterSearchParam && { filterSearchParam }),
         ...(linkAccess && { linkAccess }),

package/lib/esm/types.d.ts

@@ -58,6 +58,7 @@ type EmbedSsoDashboardOnlyProps = {
     filterSearchParam?: string;
     linkAccess?: string;
     customTheme?: CustomThemeProperties;
+    customThemeId?: string;
 };
 type EmbedContentIdProp = {
     contentId: string;

package/package.json

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