@omni-co/embed 0.19.0 → 0.21.0

package/README.md

@@ -244,7 +244,7 @@ type EmbedSsoDashboardProps = {
   theme?: string
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
@@ -390,7 +390,7 @@ type EmbedSsoWorkbookProps = {
   theme?: string
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
@@ -538,7 +538,7 @@ type EmbedSsoContentDiscoveryProps = {
   theme?: string
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
@@ -689,7 +689,7 @@ type CreateSessionTokenProps = {
   preserveEntityFolderContentRole?: boolean
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the

package/lib/cjs/constants.d.ts

@@ -78,5 +78,34 @@ export declare enum EmbedUiSettings {
      * When false, hides all in-app navigation elements. Note that in-app navigation
      * is only visible when the embed session is in APPLICATION mode.
      */
-    SHOW_NAVIGATION = "showNavigation"
+    SHOW_NAVIGATION = "showNavigation",
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    DASHBOARD_CHART_CONTEXT_MENU = "dashboardChartContextMenu",
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    DOCUMENT_BREADCRUMB = "documentBreadcrumb",
+    /**
+     * When false, hides the `Generated <timestamp>` stamp in the dashboard footer.
+     * Defaults to true.
+     */
+    DASHBOARD_GENERATED_AT = "dashboardGeneratedAt",
+    /**
+     * When false, hides the "Query ran <timestamp>" entry in a dashboard tile's
+     * menu. Defaults to true.
+     */
+    TILE_RAN_TIMESTAMP = "tileRanTimestamp"
 }
+/**
+ * Display modes for the `documentBreadcrumb` UI setting.
+ *
+ * "link": breadcrumb shown as clickable links (default behavior).
+ * "display": breadcrumb text stays visible but is not a hyperlink.
+ * "none": breadcrumb is hidden entirely.
+ */
+export type BreadcrumbDisplayMode = 'display' | 'link' | 'none';

package/lib/cjs/constants.js

@@ -94,4 +94,25 @@ var EmbedUiSettings;
      * is only visible when the embed session is in APPLICATION mode.
      */
     EmbedUiSettings["SHOW_NAVIGATION"] = "showNavigation";
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_CHART_CONTEXT_MENU"] = "dashboardChartContextMenu";
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    EmbedUiSettings["DOCUMENT_BREADCRUMB"] = "documentBreadcrumb";
+    /**
+     * When false, hides the `Generated <timestamp>` stamp in the dashboard footer.
+     * Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_GENERATED_AT"] = "dashboardGeneratedAt";
+    /**
+     * When false, hides the "Query ran <timestamp>" entry in a dashboard tile's
+     * menu. Defaults to true.
+     */
+    EmbedUiSettings["TILE_RAN_TIMESTAMP"] = "tileRanTimestamp";
 })(EmbedUiSettings || (exports.EmbedUiSettings = EmbedUiSettings = {}));

package/lib/cjs/types.d.ts

@@ -1,4 +1,17 @@
-import type { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from './constants.js';
+import { EmbedUiSettings } from './constants.js';
+import type { BreadcrumbDisplayMode, CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode } from './constants.js';
+/**
+ * UI settings object controlling appearance settings of the embed session.
+ * Each key is optional; values are booleans except `documentBreadcrumb`, which
+ * takes a `BreadcrumbDisplayMode`.
+ */
+export type EmbedUiSettingsObject = {
+    [EmbedUiSettings.SHOW_NAVIGATION]?: boolean;
+    [EmbedUiSettings.DASHBOARD_CHART_CONTEXT_MENU]?: boolean;
+    [EmbedUiSettings.DOCUMENT_BREADCRUMB]?: BreadcrumbDisplayMode;
+    [EmbedUiSettings.DASHBOARD_GENERATED_AT]?: boolean;
+    [EmbedUiSettings.TILE_RAN_TIMESTAMP]?: boolean;
+};
 type UserAttributeValue = string | string[] | number | number[];
 type HostProps = ({
     host?: never;
@@ -110,7 +123,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
-    uiSettings?: Record<EmbedUiSettings, boolean>;
+    uiSettings?: EmbedUiSettingsObject;
     /**
      * Optional branch setting that sets the model branch of the embed session.
      */

package/lib/cjs/types.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const constants_js_1 = require("./constants.js");

package/lib/esm/constants.d.ts

@@ -78,5 +78,34 @@ export declare enum EmbedUiSettings {
      * When false, hides all in-app navigation elements. Note that in-app navigation
      * is only visible when the embed session is in APPLICATION mode.
      */
-    SHOW_NAVIGATION = "showNavigation"
+    SHOW_NAVIGATION = "showNavigation",
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    DASHBOARD_CHART_CONTEXT_MENU = "dashboardChartContextMenu",
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    DOCUMENT_BREADCRUMB = "documentBreadcrumb",
+    /**
+     * When false, hides the `Generated <timestamp>` stamp in the dashboard footer.
+     * Defaults to true.
+     */
+    DASHBOARD_GENERATED_AT = "dashboardGeneratedAt",
+    /**
+     * When false, hides the "Query ran <timestamp>" entry in a dashboard tile's
+     * menu. Defaults to true.
+     */
+    TILE_RAN_TIMESTAMP = "tileRanTimestamp"
 }
+/**
+ * Display modes for the `documentBreadcrumb` UI setting.
+ *
+ * "link": breadcrumb shown as clickable links (default behavior).
+ * "display": breadcrumb text stays visible but is not a hyperlink.
+ * "none": breadcrumb is hidden entirely.
+ */
+export type BreadcrumbDisplayMode = 'display' | 'link' | 'none';

package/lib/esm/constants.js

@@ -91,4 +91,25 @@ export var EmbedUiSettings;
      * is only visible when the embed session is in APPLICATION mode.
      */
     EmbedUiSettings["SHOW_NAVIGATION"] = "showNavigation";
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_CHART_CONTEXT_MENU"] = "dashboardChartContextMenu";
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    EmbedUiSettings["DOCUMENT_BREADCRUMB"] = "documentBreadcrumb";
+    /**
+     * When false, hides the `Generated <timestamp>` stamp in the dashboard footer.
+     * Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_GENERATED_AT"] = "dashboardGeneratedAt";
+    /**
+     * When false, hides the "Query ran <timestamp>" entry in a dashboard tile's
+     * menu. Defaults to true.
+     */
+    EmbedUiSettings["TILE_RAN_TIMESTAMP"] = "tileRanTimestamp";
 })(EmbedUiSettings || (EmbedUiSettings = {}));

package/lib/esm/types.d.ts

@@ -1,4 +1,17 @@
-import type { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from './constants.js';
+import { EmbedUiSettings } from './constants.js';
+import type { BreadcrumbDisplayMode, CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode } from './constants.js';
+/**
+ * UI settings object controlling appearance settings of the embed session.
+ * Each key is optional; values are booleans except `documentBreadcrumb`, which
+ * takes a `BreadcrumbDisplayMode`.
+ */
+export type EmbedUiSettingsObject = {
+    [EmbedUiSettings.SHOW_NAVIGATION]?: boolean;
+    [EmbedUiSettings.DASHBOARD_CHART_CONTEXT_MENU]?: boolean;
+    [EmbedUiSettings.DOCUMENT_BREADCRUMB]?: BreadcrumbDisplayMode;
+    [EmbedUiSettings.DASHBOARD_GENERATED_AT]?: boolean;
+    [EmbedUiSettings.TILE_RAN_TIMESTAMP]?: boolean;
+};
 type UserAttributeValue = string | string[] | number | number[];
 type HostProps = ({
     host?: never;
@@ -110,7 +123,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
-    uiSettings?: Record<EmbedUiSettings, boolean>;
+    uiSettings?: EmbedUiSettingsObject;
     /**
      * Optional branch setting that sets the model branch of the embed session.
      */

package/lib/esm/types.js

@@ -1 +1 @@
-export {};
+import { EmbedUiSettings } from './constants.js';

package/lib/omni_internal_browser/constants.d.ts

@@ -78,5 +78,34 @@ export declare enum EmbedUiSettings {
      * When false, hides all in-app navigation elements. Note that in-app navigation
      * is only visible when the embed session is in APPLICATION mode.
      */
-    SHOW_NAVIGATION = "showNavigation"
+    SHOW_NAVIGATION = "showNavigation",
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    DASHBOARD_CHART_CONTEXT_MENU = "dashboardChartContextMenu",
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    DOCUMENT_BREADCRUMB = "documentBreadcrumb",
+    /**
+     * When false, hides the `Generated <timestamp>` stamp in the dashboard footer.
+     * Defaults to true.
+     */
+    DASHBOARD_GENERATED_AT = "dashboardGeneratedAt",
+    /**
+     * When false, hides the "Query ran <timestamp>" entry in a dashboard tile's
+     * menu. Defaults to true.
+     */
+    TILE_RAN_TIMESTAMP = "tileRanTimestamp"
 }
+/**
+ * Display modes for the `documentBreadcrumb` UI setting.
+ *
+ * "link": breadcrumb shown as clickable links (default behavior).
+ * "display": breadcrumb text stays visible but is not a hyperlink.
+ * "none": breadcrumb is hidden entirely.
+ */
+export type BreadcrumbDisplayMode = 'display' | 'link' | 'none';

package/lib/omni_internal_browser/constants.js

@@ -91,4 +91,25 @@ export var EmbedUiSettings;
      * is only visible when the embed session is in APPLICATION mode.
      */
     EmbedUiSettings["SHOW_NAVIGATION"] = "showNavigation";
+    /**
+     * When false, hides the chart context menu (the per-tile "..." / right-click menu)
+     * on advanced-layout dashboards. The menu is hidden in view mode but kept in
+     * draft/edit mode so authors can still edit tiles. Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_CHART_CONTEXT_MENU"] = "dashboardChartContextMenu";
+    /**
+     * Controls the folder-path breadcrumb in the document title header when in
+     * APPLICATION mode. Accepts a `BreadcrumbDisplayMode` value. Defaults to "link".
+     */
+    EmbedUiSettings["DOCUMENT_BREADCRUMB"] = "documentBreadcrumb";
+    /**
+     * When false, hides the `Generated <timestamp>` stamp in the dashboard footer.
+     * Defaults to true.
+     */
+    EmbedUiSettings["DASHBOARD_GENERATED_AT"] = "dashboardGeneratedAt";
+    /**
+     * When false, hides the "Query ran <timestamp>" entry in a dashboard tile's
+     * menu. Defaults to true.
+     */
+    EmbedUiSettings["TILE_RAN_TIMESTAMP"] = "tileRanTimestamp";
 })(EmbedUiSettings || (EmbedUiSettings = {}));

package/lib/omni_internal_browser/types.d.ts

@@ -1,4 +1,17 @@
-import type { CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode, EmbedUiSettings } from './constants.js';
+import { EmbedUiSettings } from './constants.js';
+import type { BreadcrumbDisplayMode, CustomThemeProperty, EmbedEntityFolderContentRoles, EmbedSessionMode } from './constants.js';
+/**
+ * UI settings object controlling appearance settings of the embed session.
+ * Each key is optional; values are booleans except `documentBreadcrumb`, which
+ * takes a `BreadcrumbDisplayMode`.
+ */
+export type EmbedUiSettingsObject = {
+    [EmbedUiSettings.SHOW_NAVIGATION]?: boolean;
+    [EmbedUiSettings.DASHBOARD_CHART_CONTEXT_MENU]?: boolean;
+    [EmbedUiSettings.DOCUMENT_BREADCRUMB]?: BreadcrumbDisplayMode;
+    [EmbedUiSettings.DASHBOARD_GENERATED_AT]?: boolean;
+    [EmbedUiSettings.TILE_RAN_TIMESTAMP]?: boolean;
+};
 type UserAttributeValue = string | string[] | number | number[];
 type HostProps = ({
     host?: never;
@@ -110,7 +123,7 @@ type EmbedSsoBaseProps = {
     email?: string;
     filterSearchParam?: string;
     linkAccess?: string;
-    uiSettings?: Record<EmbedUiSettings, boolean>;
+    uiSettings?: EmbedUiSettingsObject;
     /**
      * Optional branch setting that sets the model branch of the embed session.
      */

package/lib/omni_internal_browser/types.js

@@ -1 +1 @@
-export {};
+import { EmbedUiSettings } from './constants.js';

package/package.json

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