@omni-co/embed 0.14.1-alpha.3 → 0.15.0

package/lib/cjs/omni_internal_browser.d.ts

@@ -2,3 +2,4 @@
  * Client / browser entrypoint for the Omni Embed SDK.
  */
 export * from "./constants.js";
+export * from "./types.js";

package/lib/cjs/omni_internal_browser.js

@@ -18,3 +18,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Client / browser entrypoint for the Omni Embed SDK.
  */
 __exportStar(require("./constants.js"), exports);
+__exportStar(require("./types.js"), exports);

package/lib/esm/omni_internal_browser.d.ts

@@ -2,3 +2,4 @@
  * Client / browser entrypoint for the Omni Embed SDK.
  */
 export * from "./constants.js";
+export * from "./types.js";

package/lib/esm/omni_internal_browser.js

@@ -2,3 +2,4 @@
  * Client / browser entrypoint for the Omni Embed SDK.
  */
 export * from "./constants.js";
+export * from "./types.js";

package/lib/omni_internal_browser/omni_internal_browser.d.ts

@@ -2,3 +2,4 @@
  * Client / browser entrypoint for the Omni Embed SDK.
  */
 export * from "./constants.js";
+export * from "./types.js";

package/lib/omni_internal_browser/omni_internal_browser.js

@@ -2,3 +2,4 @@
  * Client / browser entrypoint for the Omni Embed SDK.
  */
 export * from "./constants.js";
+export * from "./types.js";

package/lib/omni_internal_browser/types.d.ts

@@ -0,0 +1,204 @@
+import { CustomThemeProperty, EmbedConnectionRoles, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from "./constants.js";
+type UserAttributeValue = string | string[] | number | number[];
+type HostProps = {
+    host?: never;
+    /**
+     * @deprecated Introduced for internal testing only. For vanity domains, use the `host` prop instead.
+     *
+     * @throws Error if `host` is provided.
+     */
+    domain?: string;
+    /**
+     * Name of the organization the content belongs to. If provided, generates a default embed host
+     * URL in the form of `https://<organizationName>.embed-omniapp.co`.
+     *
+     * @throws Error if `host` is provided.
+     */
+    organizationName: string;
+} | {
+    domain?: never;
+    organizationName?: never;
+    /**
+     * Used to set the host of signed embed URL, required when using vanity domains.
+     * Protocol is not required, as https is assumed.
+     * Port is not accepted. If required, use the `port` prop.
+     *
+     * @throws Error if `domain` or `organizationName` are provided.
+     * @example "omni.example.com"
+     * @example "omni.another-example.app"
+     */
+    host: string;
+};
+type EmbedSsoBaseProps = {
+    externalId: string;
+    name: string;
+    secret: string;
+    entity?: string;
+    userAttributes?: Record<string, UserAttributeValue>;
+    prefersDark?: string;
+    theme?: string;
+    customTheme?: CustomThemeProperties;
+    customThemeId?: string;
+    /**
+     * Optional connection roles setting. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles.
+     */
+    connectionRoles?: Record<string, EmbedConnectionRoles>;
+    /**
+     * Optional model roles setting. Object keys should be model IDs from the embedded Omni instance.
+     * Object values should be connection roles.
+     */
+    modelRoles?: Record<string, EmbedConnectionRoles>;
+    /**
+     * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
+     *
+     * APPLICATION: the entire application will be embedded, meaning in-app navigation and document header options will be available.
+     * SINGLE_CONTENT: only the content specified in the contentId will be embedded and application mode features will be hidden.
+     */
+    mode?: EmbedSessionMode;
+    /**
+     * Optional content role setting for the embed user on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER", or "NO_ACCESS".
+     *
+     * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
+     *
+     * EDITOR: the user will have the ability to manage content in the entity folder.
+     *
+     * VIEWER: the user will only be able to view content in the entity folder.
+     *
+     * NO_ACCESS: the user will not have access to the entity folder. Note that the group content role must
+     * also be set to NO_ACCESS for the user to not have access to the entity folder.
+     */
+    entityFolderContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * Optional content role setting for the entity group on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER", or "NO_ACCESS".
+     *
+     * MANAGER: all entity group embed users will have the ability to manage content and content permissions of the entity folder.
+     *
+     * EDITOR: all entity group embed users will have the ability to manage content in the entity folder.
+     *
+     * VIEWER: all entity group embed users will only be able to view content in the entity folder.
+     *
+     * NO_ACCESS: all entity group embed users will not have access to the entity folder.
+     */
+    entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+    /**
+     * When true, an existing content role for the embed user on the entity folder will not be overwritten
+     * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
+     * the `entityFolderContentRole` value will be applied.
+     */
+    preserveEntityFolderContentRole?: boolean;
+    /**
+     * Optional setting that customizes the generated entity folder label. This only affects the entity folder
+     * corresponding to the `entity` parameter value in the relevant generated SSO embed URL.
+     */
+    entityFolderLabel?: string;
+    /**
+     * Optional setting that customizes the generated entity group label. This only affects the entity group
+     * corresponding to the `entity` parameter value in the relevant generated SSO embed URL.
+     */
+    entityGroupLabel?: string;
+    /**
+     * Optional groups setting. An array of group names that the user will be added to.
+     */
+    groups?: string[];
+    /**
+     * Optional email setting for the generated embed user.
+     */
+    email?: string;
+    filterSearchParam?: string;
+    linkAccess?: string;
+    uiSettings?: Record<EmbedUiSettings, boolean>;
+    nonce?: string;
+    port?: number;
+} & HostProps;
+type EmbedSsoDashboardOnlyProps = {
+    accessBoost?: boolean;
+};
+type EmbedContentIdProp = {
+    contentId: string;
+};
+type EmbedContentPathProp = {
+    contentPath: string;
+};
+export type CustomThemeProperties = {
+    [CustomThemeProperty.DASHBOARD_BACKGROUND]?: string;
+    [CustomThemeProperty.DASHBOARD_PAGE_PADDING]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_MARGIN]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_BACKGROUND]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_SHADOW]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TEXT_BODY_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TEXT_SECONDARY_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_BORDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_BORDER_RADIUS]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_BORDER_STYLE]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_BORDER_WIDTH]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TITLE_FONT_SIZE]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TITLE_FONT_WEIGHT]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TITLE_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TITLE_FONT_FAMILY]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TEXT_BODY_FONT_FAMILY]?: string;
+    [CustomThemeProperty.DASHBOARD_TILE_TEXT_CODE_FONT_FAMILY]?: string;
+    [CustomThemeProperty.DASHBOARD_KEY_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_KEY_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_BUTTON_TRANSPARENT_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_BUTTON_TRANSPARENT_INTERACTIVE_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_MENU_ITEM_INTERACTIVE_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_BACKGROUND]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_BORDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_PLACEHOLDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_LABEL_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_BACKGROUND]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_SECONDARY_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_LINK_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_DIVIDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_BORDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_OUTLINE_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_POPOVER_RADIUS]?: string;
+    [CustomThemeProperty.DASHBOARD_CONTROL_RADIUS]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_BORDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_PLACEHOLDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_BACKGROUND]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_RADIUS]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_PLACEHOLDER_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_ICON_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_OUTLINE_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_ACCENT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_ACCENT_INVERT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_TOKEN_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_FILTER_INPUT_TOKEN_TEXT_COLOR]?: string;
+    [CustomThemeProperty.DASHBOARD_BUTTON_RADIUS]?: string;
+};
+export type EmbedSsoContentProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentPathProp;
+/**
+ * Consumers of this SDK will rely on these three types to embed workbooks and dashboards.
+ */
+export type EmbedSsoDashboardProps = EmbedSsoBaseProps & EmbedSsoDashboardOnlyProps & EmbedContentIdProp;
+export type EmbedSsoWorkbookProps = EmbedSsoBaseProps & EmbedContentIdProp;
+export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
+    /**
+     * Path name of the content discovery page to embed.
+     */
+    path: string;
+} & ({
+    /**
+     * Required connection roles object. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles.
+     */
+    connectionRoles: Record<string, EmbedConnectionRoles>;
+} | {
+    /**
+     * Required model roles object. Object keys should be connection IDs from the embedded Omni instance.
+     * Object values should be connection roles.
+     */
+    modelRoles: Record<string, EmbedConnectionRoles>;
+});
+export type CreateSessionTokenProps = Omit<EmbedSsoContentProps, "prefersDark" | "theme" | "secret" | "nonce"> & {
+    apiKey: string;
+} & HostProps;
+export type RedeemSessionTokenProps = Pick<EmbedSsoContentProps, "nonce" | "prefersDark" | "secret" | "theme" | "port"> & {
+    sessionToken: string;
+} & HostProps;
+export {};

package/lib/omni_internal_browser/types.js

@@ -0,0 +1 @@
+import { CustomThemeProperty, } from "./constants.js";

package/package.json

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