@omni-co/embed 0.15.0 → 0.16.0

package/lib/cjs/embed.d.ts

@@ -29,4 +29,4 @@ export declare const createSessionToken: ({ apiKey, domain, host, organizationNa
  * to output an session redemption URL that can be used to display embedded content.
  * The returned URL should be passed into an `iframe`'s src attribute.
  */
-export declare const redeemSessionToken: ({ domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, theme, }: RedeemSessionTokenProps) => Promise<string>;
+export declare const redeemSessionToken: ({ branch, domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, theme, }: RedeemSessionTokenProps) => Promise<string>;

package/lib/cjs/embed.js

@@ -54,7 +54,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, modelRoles: rawModelRoles, name, nonce, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
+    let { accessBoost, branch, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, modelRoles: rawModelRoles, name, nonce, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
     // Handle defaults
     nonce = nonce ?? (await (0, random_str_js_1.random32ByteString)());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
@@ -81,6 +81,7 @@ const embedSsoContent = async (props) => {
         secret,
         // Optional parameters
         accessBoost,
+        branch,
         connectionRoles,
         customTheme,
         customThemeId,
@@ -135,6 +136,7 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("entityFolderLabel", entityFolderLabel);
     preserveEntityFolderContentRole !== undefined &&
         url.searchParams.append("preserveEntityFolderContentRole", preserveEntityFolderContentRole.toString());
+    branch && url.searchParams.append("branch", branch);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
@@ -208,7 +210,7 @@ exports.createSessionToken = createSessionToken;
  * to output an session redemption URL that can be used to display embedded content.
  * The returned URL should be passed into an `iframe`'s src attribute.
  */
-const redeemSessionToken = async ({ domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, // sessionToken is just a facade for the sessionId
+const redeemSessionToken = async ({ branch, domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, // sessionToken is just a facade for the sessionId
 theme, }) => {
     const redeemRequestUrl = createEmbedRequestUrl({
         domain,
@@ -225,7 +227,10 @@ theme, }) => {
         sessionId,
         secret,
         theme,
+        branch,
     });
+    branch !== undefined &&
+        redeemRequestUrl.searchParams.append("branch", branch);
     prefersDark !== undefined &&
         redeemRequestUrl.searchParams.append("prefersDark", prefersDark);
     theme !== undefined && redeemRequestUrl.searchParams.append("theme", theme);

package/lib/cjs/signature.d.ts

@@ -1,3 +1,4 @@
+import { RedeemSessionExclusiveProps } from "./types.js";
 export declare const hmacSign: (data: string, secret: string) => string;
 type SignatureProps = {
     /**
@@ -32,6 +33,10 @@ type SignatureProps = {
      * The access boost setting for content specified in this Embed SSO URL.
      */
     accessBoost?: boolean;
+    /**
+     * The branch setting that sets the model branch of the embed session.
+     */
+    branch?: string;
     /**
      * The connection roles to be associated with the embed user. Expected to be a stringified JSON object.
      */
@@ -122,7 +127,7 @@ export declare const getSignature: ({ secret, ...props }: SignatureProps) => str
 type RequestUrl = {
     requestUrl: string;
 };
-type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
+type SignSessionRedemptionProps = Pick<SignatureProps, RedeemSessionExclusiveProps> & RequestUrl & {
     sessionId: string;
 };
 /**
@@ -133,8 +138,8 @@ type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" |
  * that is generated based on all other request parameters. That signature is
  * validated by the Omni app server to ensure the request is authentic.
  */
-export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: SignSessionRedemptionProps) => string;
+export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, branch, prefersDark, theme, }: SignSessionRedemptionProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -15,11 +15,12 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }) => {
+accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, 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 !== undefined && { accessBoost: accessBoost.toString() }),
+        ...(branch && { branch }),
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
         ...(customThemeId && { customThemeId }),
@@ -73,8 +74,9 @@ exports.getSignature = getSignature;
  * that is generated based on all other request parameters. That signature is
  * validated by the Omni app server to ensure the request is authentic.
  */
-const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }) => {
+const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, branch, prefersDark, theme, }) => {
     const optionalParamsMap = {
+        ...(branch && { branch }),
         ...(prefersDark && { prefersDark }),
         ...(theme && { theme }),
     };

package/lib/cjs/types.d.ts

@@ -1,6 +1,6 @@
-import { CustomThemeProperty, EmbedConnectionRoles, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
+import { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
 type UserAttributeValue = string | string[] | number | number[];
-type HostProps = {
+type HostProps = ({
     host?: never;
     /**
      * @deprecated Introduced for internal testing only. For vanity domains, use the `host` prop instead.
@@ -28,6 +28,8 @@ type HostProps = {
      * @example "omni.another-example.app"
      */
     host: string;
+}) & {
+    port?: number;
 };
 type EmbedSsoBaseProps = {
     externalId: string;
@@ -41,14 +43,14 @@ type EmbedSsoBaseProps = {
     customThemeId?: string;
     /**
      * Optional connection roles setting. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be connection roles (base roles or custom role names).
      */
-    connectionRoles?: Record<string, EmbedConnectionRoles>;
+    connectionRoles?: Record<string, string>;
     /**
      * Optional model roles setting. Object keys should be model IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be model roles (base roles or custom role names).
      */
-    modelRoles?: Record<string, EmbedConnectionRoles>;
+    modelRoles?: Record<string, string>;
     /**
      * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
      *
@@ -108,8 +110,11 @@ type EmbedSsoBaseProps = {
     filterSearchParam?: string;
     linkAccess?: string;
     uiSettings?: Record<EmbedUiSettings, boolean>;
+    /**
+     * Optional branch setting that sets the model branch of the embed session.
+     */
+    branch?: string;
     nonce?: string;
-    port?: number;
 } & HostProps;
 type EmbedSsoDashboardOnlyProps = {
     accessBoost?: boolean;
@@ -185,20 +190,21 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
 } & ({
     /**
      * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be connection roles (base roles or custom role names).
      */
-    connectionRoles: Record<string, EmbedConnectionRoles>;
+    connectionRoles: Record<string, string>;
 } | {
     /**
-     * Required model roles object. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Required model roles object. Object keys should be model IDs from the embedded Omni instance.
+     * Object values should be model roles (base roles or custom role names).
      */
-    modelRoles: Record<string, EmbedConnectionRoles>;
+    modelRoles: Record<string, string>;
 });
-export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, "prefersDark" | "theme" | "secret" | "nonce"> & {
+export type RedeemSessionExclusiveProps = "branch" | "nonce" | "prefersDark" | "secret" | "theme";
+export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     apiKey: string;
 } & HostProps;
-export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, "nonce" | "prefersDark" | "secret" | "theme" | "port"> & {
+export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     sessionToken: string;
 } & HostProps;
 export {};

package/lib/esm/embed.d.ts

@@ -29,4 +29,4 @@ export declare const createSessionToken: ({ apiKey, domain, host, organizationNa
  * to output an session redemption URL that can be used to display embedded content.
  * The returned URL should be passed into an `iframe`'s src attribute.
  */
-export declare const redeemSessionToken: ({ domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, theme, }: RedeemSessionTokenProps) => Promise<string>;
+export declare const redeemSessionToken: ({ branch, domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, theme, }: RedeemSessionTokenProps) => Promise<string>;

package/lib/esm/embed.js

@@ -51,7 +51,7 @@ const validateProps = (props) => {
 };
 const embedSsoContent = async (props) => {
     validateProps(props);
-    let { accessBoost, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, modelRoles: rawModelRoles, name, nonce, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
+    let { accessBoost, branch, connectionRoles: rawConnectionRoles, contentPath, customTheme: rawCustomTheme, customThemeId, domain, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, externalId, filterSearchParam, groups: rawGroups, host, linkAccess, mode, modelRoles: rawModelRoles, name, nonce, organizationName, preserveEntityFolderContentRole, prefersDark, port, secret, theme, uiSettings: rawUiSettings, userAttributes: rawUserAttributes, } = props;
     // Handle defaults
     nonce = nonce ?? (await random32ByteString());
     const uiSettings = rawUiSettings && JSON.stringify(rawUiSettings);
@@ -78,6 +78,7 @@ const embedSsoContent = async (props) => {
         secret,
         // Optional parameters
         accessBoost,
+        branch,
         connectionRoles,
         customTheme,
         customThemeId,
@@ -132,6 +133,7 @@ const embedSsoContent = async (props) => {
         url.searchParams.append("entityFolderLabel", entityFolderLabel);
     preserveEntityFolderContentRole !== undefined &&
         url.searchParams.append("preserveEntityFolderContentRole", preserveEntityFolderContentRole.toString());
+    branch && url.searchParams.append("branch", branch);
     return url.toString();
 };
 const buildContentPath = (contentType, contentId) => `/${contentType}/${contentId}`;
@@ -201,7 +203,7 @@ export const createSessionToken = async ({ apiKey, domain, host, organizationNam
  * to output an session redemption URL that can be used to display embedded content.
  * The returned URL should be passed into an `iframe`'s src attribute.
  */
-export const redeemSessionToken = async ({ domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, // sessionToken is just a facade for the sessionId
+export const redeemSessionToken = async ({ branch, domain, host, organizationName, port, nonce: propsNonce, secret, prefersDark, sessionToken: sessionId, // sessionToken is just a facade for the sessionId
 theme, }) => {
     const redeemRequestUrl = createEmbedRequestUrl({
         domain,
@@ -218,7 +220,10 @@ theme, }) => {
         sessionId,
         secret,
         theme,
+        branch,
     });
+    branch !== undefined &&
+        redeemRequestUrl.searchParams.append("branch", branch);
     prefersDark !== undefined &&
         redeemRequestUrl.searchParams.append("prefersDark", prefersDark);
     theme !== undefined && redeemRequestUrl.searchParams.append("theme", theme);

package/lib/esm/signature.d.ts

@@ -1,3 +1,4 @@
+import { RedeemSessionExclusiveProps } from "./types.js";
 export declare const hmacSign: (data: string, secret: string) => string;
 type SignatureProps = {
     /**
@@ -32,6 +33,10 @@ type SignatureProps = {
      * The access boost setting for content specified in this Embed SSO URL.
      */
     accessBoost?: boolean;
+    /**
+     * The branch setting that sets the model branch of the embed session.
+     */
+    branch?: string;
     /**
      * The connection roles to be associated with the embed user. Expected to be a stringified JSON object.
      */
@@ -122,7 +127,7 @@ export declare const getSignature: ({ secret, ...props }: SignatureProps) => str
 type RequestUrl = {
     requestUrl: string;
 };
-type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" | "theme" | "secret"> & RequestUrl & {
+type SignSessionRedemptionProps = Pick<SignatureProps, RedeemSessionExclusiveProps> & RequestUrl & {
     sessionId: string;
 };
 /**
@@ -133,8 +138,8 @@ type SignSessionRedemptionProps = Pick<SignatureProps, "nonce" | "prefersDark" |
  * that is generated based on all other request parameters. That signature is
  * validated by the Omni app server to ensure the request is authentic.
  */
-export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }: SignSessionRedemptionProps) => string;
+export declare const signSessionRedemption: ({ requestUrl, nonce, sessionId, secret, branch, prefersDark, theme, }: SignSessionRedemptionProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -8,11 +8,12 @@ const generateStringForSignature = ({
 // Required parameters
 loginUrl, contentPath, externalId, name, nonce, 
 // Optional parameters
-accessBoost, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, userAttributes, }) => {
+accessBoost, branch, connectionRoles, customTheme, customThemeId, email, entity, entityFolderContentRole, entityFolderGroupContentRole, entityFolderLabel, entityGroupLabel, filterSearchParam, groups, linkAccess, mode, modelRoles, prefersDark, preserveEntityFolderContentRole, theme, uiSettings, 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 !== undefined && { accessBoost: accessBoost.toString() }),
+        ...(branch && { branch }),
         ...(connectionRoles && { connectionRoles }),
         ...(customTheme && { customTheme }),
         ...(customThemeId && { customThemeId }),
@@ -65,8 +66,9 @@ export const getSignature = ({ secret, ...props }) => {
  * that is generated based on all other request parameters. That signature is
  * validated by the Omni app server to ensure the request is authentic.
  */
-export const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, prefersDark, theme, }) => {
+export const signSessionRedemption = ({ requestUrl, nonce, sessionId, secret, branch, prefersDark, theme, }) => {
     const optionalParamsMap = {
+        ...(branch && { branch }),
         ...(prefersDark && { prefersDark }),
         ...(theme && { theme }),
     };

package/lib/esm/types.d.ts

@@ -1,6 +1,6 @@
-import { CustomThemeProperty, EmbedConnectionRoles, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
+import { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
 type UserAttributeValue = string | string[] | number | number[];
-type HostProps = {
+type HostProps = ({
     host?: never;
     /**
      * @deprecated Introduced for internal testing only. For vanity domains, use the `host` prop instead.
@@ -28,6 +28,8 @@ type HostProps = {
      * @example "omni.another-example.app"
      */
     host: string;
+}) & {
+    port?: number;
 };
 type EmbedSsoBaseProps = {
     externalId: string;
@@ -41,14 +43,14 @@ type EmbedSsoBaseProps = {
     customThemeId?: string;
     /**
      * Optional connection roles setting. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be connection roles (base roles or custom role names).
      */
-    connectionRoles?: Record<string, EmbedConnectionRoles>;
+    connectionRoles?: Record<string, string>;
     /**
      * Optional model roles setting. Object keys should be model IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be model roles (base roles or custom role names).
      */
-    modelRoles?: Record<string, EmbedConnectionRoles>;
+    modelRoles?: Record<string, string>;
     /**
      * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
      *
@@ -108,8 +110,11 @@ type EmbedSsoBaseProps = {
     filterSearchParam?: string;
     linkAccess?: string;
     uiSettings?: Record<EmbedUiSettings, boolean>;
+    /**
+     * Optional branch setting that sets the model branch of the embed session.
+     */
+    branch?: string;
     nonce?: string;
-    port?: number;
 } & HostProps;
 type EmbedSsoDashboardOnlyProps = {
     accessBoost?: boolean;
@@ -185,20 +190,21 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
 } & ({
     /**
      * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be connection roles (base roles or custom role names).
      */
-    connectionRoles: Record<string, EmbedConnectionRoles>;
+    connectionRoles: Record<string, string>;
 } | {
     /**
-     * Required model roles object. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Required model roles object. Object keys should be model IDs from the embedded Omni instance.
+     * Object values should be model roles (base roles or custom role names).
      */
-    modelRoles: Record<string, EmbedConnectionRoles>;
+    modelRoles: Record<string, string>;
 });
-export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, "prefersDark" | "theme" | "secret" | "nonce"> & {
+export type RedeemSessionExclusiveProps = "branch" | "nonce" | "prefersDark" | "secret" | "theme";
+export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     apiKey: string;
 } & HostProps;
-export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, "nonce" | "prefersDark" | "secret" | "theme" | "port"> & {
+export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     sessionToken: string;
 } & HostProps;
 export {};

package/lib/omni_internal_browser/types.d.ts

@@ -1,6 +1,6 @@
-import { CustomThemeProperty, EmbedConnectionRoles, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
+import { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
 type UserAttributeValue = string | string[] | number | number[];
-type HostProps = {
+type HostProps = ({
     host?: never;
     /**
      * @deprecated Introduced for internal testing only. For vanity domains, use the `host` prop instead.
@@ -28,6 +28,8 @@ type HostProps = {
      * @example "omni.another-example.app"
      */
     host: string;
+}) & {
+    port?: number;
 };
 type EmbedSsoBaseProps = {
     externalId: string;
@@ -41,14 +43,14 @@ type EmbedSsoBaseProps = {
     customThemeId?: string;
     /**
      * Optional connection roles setting. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be connection roles (base roles or custom role names).
      */
-    connectionRoles?: Record<string, EmbedConnectionRoles>;
+    connectionRoles?: Record<string, string>;
     /**
      * Optional model roles setting. Object keys should be model IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be model roles (base roles or custom role names).
      */
-    modelRoles?: Record<string, EmbedConnectionRoles>;
+    modelRoles?: Record<string, string>;
     /**
      * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
      *
@@ -108,8 +110,11 @@ type EmbedSsoBaseProps = {
     filterSearchParam?: string;
     linkAccess?: string;
     uiSettings?: Record<EmbedUiSettings, boolean>;
+    /**
+     * Optional branch setting that sets the model branch of the embed session.
+     */
+    branch?: string;
     nonce?: string;
-    port?: number;
 } & HostProps;
 type EmbedSsoDashboardOnlyProps = {
     accessBoost?: boolean;
@@ -185,20 +190,21 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
 } & ({
     /**
      * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Object values should be connection roles (base roles or custom role names).
      */
-    connectionRoles: Record<string, EmbedConnectionRoles>;
+    connectionRoles: Record<string, string>;
 } | {
     /**
-     * Required model roles object. Object keys should be connection IDs from the embedded Omni instance.
-     * Object values should be connection roles.
+     * Required model roles object. Object keys should be model IDs from the embedded Omni instance.
+     * Object values should be model roles (base roles or custom role names).
      */
-    modelRoles: Record<string, EmbedConnectionRoles>;
+    modelRoles: Record<string, string>;
 });
-export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, "prefersDark" | "theme" | "secret" | "nonce"> & {
+export type RedeemSessionExclusiveProps = "branch" | "nonce" | "prefersDark" | "secret" | "theme";
+export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     apiKey: string;
 } & HostProps;
-export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, "nonce" | "prefersDark" | "secret" | "theme" | "port"> & {
+export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, RedeemSessionExclusiveProps> & {
     sessionToken: string;
 } & HostProps;
 export {};

package/package.json

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