@jbrowse/product-core 5.0.0-beta.13 → 5.0.0-beta.14

package/esm/Session/SessionTracks.js

@@ -56,6 +56,8 @@ function perIdComputed(derive) {
 }
 /**
  * #stateModel SessionTracksManagerSessionMixin
+ * Adds session tracks to a session, and stores the user's edits to any track
+ * as a delta against its base config.
  */
 export function SessionTracksManagerSessionMixin(pluginManager) {
     // A base is the raw config-file object — shorthand `uri`, no display stubs —

package/esm/Session/Themes.d.ts

@@ -12,6 +12,8 @@ export type ThemeModeSelection = PaletteMode | 'system';
 export declare function storedThemeArgs(): SerializableThemeArgs;
 /**
  * #stateModel ThemeManagerSessionMixin
+ * Adds the UI theme to a session: the selected theme, light or dark mode or
+ * following the OS, and the themes an admin adds through `extraThemes`.
  */
 export declare function ThemeManagerSessionMixin(_pluginManager: PluginManager): import("@jbrowse/mobx-state-tree").IModelType<{}, {
     sessionThemeName: string;
@@ -35,7 +37,7 @@ export declare function ThemeManagerSessionMixin(_pluginManager: PluginManager):
      * #getter
      * Light, dark, or following the OS — the axis the palette is drawn
      * along, and what the mode picker shows. `effectiveThemeMode` is the
-     * one to read for a colour decision.
+     * one to read for a color decision.
      */
     readonly themeMode: ThemeModeSelection;
     /**
@@ -132,10 +134,10 @@ export declare function ThemeManagerSessionMixin(_pluginManager: PluginManager):
     setSystemPrefersDark(dark: boolean): void;
     /**
      * #action
-     * Hold a session that follows the system on the mode the OS is not
-     * asking for, or `undefined` to follow it again. The toolbar's sun/moon
-     * writes this, so it stays in the toolbar after a click. The OS flipping
-     * clears it, since by then the OS has come round to the held mode. The
+     * Hold a session on the mode its setting is not asking for, or
+     * `undefined` to return to the setting. The toolbar's sun/moon writes
+     * this, so it stays in the toolbar after a click. The OS flipping clears
+     * it, since by then the OS has come round to the held mode. The
      * palette is untouched: a reader on Minimal who does this keeps Minimal.
      */
     setSystemThemeOverride(mode?: PaletteMode): void;

package/esm/Session/Themes.js

@@ -56,13 +56,14 @@ export function storedThemeArgs() {
     const { sessionThemeName, sessionThemeMode, systemThemeOverride } = storedSelection();
     return {
         themeName: sessionThemeName,
-        mode: sessionThemeMode === 'system'
-            ? (systemThemeOverride ?? systemMode())
-            : sessionThemeMode,
+        mode: systemThemeOverride ??
+            (sessionThemeMode === 'system' ? systemMode() : sessionThemeMode),
     };
 }
 /**
  * #stateModel ThemeManagerSessionMixin
+ * Adds the UI theme to a session: the selected theme, light or dark mode or
+ * following the OS, and the themes an admin adds through `extraThemes`.
  */
 export function ThemeManagerSessionMixin(_pluginManager) {
     return types
@@ -95,7 +96,7 @@ export function ThemeManagerSessionMixin(_pluginManager) {
              * #getter
              * Light, dark, or following the OS — the axis the palette is drawn
              * along, and what the mode picker shows. `effectiveThemeMode` is the
-             * one to read for a colour decision.
+             * one to read for a color decision.
              */
             get themeMode() {
                 return self.sessionThemeMode;
@@ -107,9 +108,13 @@ export function ThemeManagerSessionMixin(_pluginManager) {
              * Dark Reader never touches the file.
              */
             get selectedThemeMode() {
+                if (self.systemThemeOverride) {
+                    return self.systemThemeOverride;
+                }
                 return this.themeMode === 'system'
-                    ? (self.systemThemeOverride ??
-                        (self.systemPrefersDark ? 'dark' : 'light'))
+                    ? self.systemPrefersDark
+                        ? 'dark'
+                        : 'light'
                     : this.themeMode;
             },
             /**
@@ -257,10 +262,10 @@ export function ThemeManagerSessionMixin(_pluginManager) {
         },
         /**
          * #action
-         * Hold a session that follows the system on the mode the OS is not
-         * asking for, or `undefined` to follow it again. The toolbar's sun/moon
-         * writes this, so it stays in the toolbar after a click. The OS flipping
-         * clears it, since by then the OS has come round to the held mode. The
+         * Hold a session on the mode its setting is not asking for, or
+         * `undefined` to return to the setting. The toolbar's sun/moon writes
+         * this, so it stays in the toolbar after a click. The OS flipping clears
+         * it, since by then the OS has come round to the held mode. The
          * palette is untouched: a reader on Minimal who does this keeps Minimal.
          */
         setSystemThemeOverride(mode) {

package/esm/Session/TrackMenu.d.ts

@@ -2,8 +2,7 @@ import type PluginManager from '@jbrowse/core/PluginManager';
 import type { AnyConfigurationModel, AnyTrackConfig } from '@jbrowse/core/configuration';
 import type { BaseTrackConfig } from '@jbrowse/core/pluggableElementTypes';
 import type { MenuItem } from '@jbrowse/core/ui';
-import type { DialogComponentType } from '@jbrowse/core/util';
-import type { TrackActionView } from '@jbrowse/core/util/types';
+import type { AbstractSessionModel, TrackActionView } from '@jbrowse/core/util/types';
 interface TrackActionSession<C> {
     editConfiguration: (config: AnyConfigurationModel | {
         trackId: string;
@@ -47,21 +46,18 @@ export declare function trackActionItems<C extends {
     isSessionOverride?: boolean;
     makeCopy: () => C;
 }): MenuItem[];
-export interface SessionWithDialog {
-    queueDialog: (cb: (done: () => void) => [DialogComponentType, Record<string, unknown>]) => void;
-}
 type TrackConfig = AnyConfigurationModel | Record<string, unknown>;
 /** "About track" menu item, shared by every product's track menu */
-export declare function aboutTrackMenuItem(session: SessionWithDialog, config: TrackConfig): MenuItem;
+export declare function aboutTrackMenuItem(session: AbstractSessionModel, config: TrackConfig): MenuItem;
 /**
  * flattened track menu (About + raw actions) for the hierarchical track selector
  */
-export declare function trackListMenuItems(session: SessionWithDialog, config: TrackConfig, actions: MenuItem[]): MenuItem[];
+export declare function trackListMenuItems(session: AbstractSessionModel, config: TrackConfig, actions: MenuItem[]): MenuItem[];
 /**
  * track menu with an "About track" item and a "Track actions" submenu, for the
  * in-view track label menu
  */
-export declare function trackActionMenuItems(session: SessionWithDialog, config: TrackConfig, actions: MenuItem[]): MenuItem[];
+export declare function trackActionMenuItems(session: AbstractSessionModel, config: TrackConfig, actions: MenuItem[]): MenuItem[];
 /**
  * #stateModel TrackMenuItemsSessionMixin
  *

package/esm/Session/TrackMenu.js

@@ -1,5 +1,6 @@
 import { lazy } from 'react';
 import { InfoIcon } from '@jbrowse/core/ui/Icons';
+import { TRACK_MENU_PRIORITY } from '@jbrowse/core/ui/menuItems';
 import { namesTemporaryAssembly } from '@jbrowse/core/util';
 import { types } from '@jbrowse/mobx-state-tree';
 import DeleteIcon from '@mui/icons-material/Delete';
@@ -7,6 +8,7 @@ import CopyIcon from '@mui/icons-material/FileCopy';
 import OpenInNewIcon from '@mui/icons-material/OpenInNew';
 import SettingsIcon from '@mui/icons-material/Settings';
 import SettingsBackupRestoreIcon from '@mui/icons-material/SettingsBackupRestore';
+import { asAbstractSession } from '../siblingCast.js';
 import { pluginExtraTrackItems } from './pluginExtraTrackItems.js';
 const AboutDialog = lazy(() => import('../ui/AboutDialog.js'));
 /**
@@ -124,15 +126,18 @@ export function trackActionMenuItems(session, config, actions) {
     return [
         {
             ...aboutTrackMenuItem(session, config),
-            priority: 1002,
+            priority: TRACK_MENU_PRIORITY.aboutTrack,
         },
         {
             type: 'subMenu',
             label: 'Track actions',
-            priority: 1001,
+            priority: TRACK_MENU_PRIORITY.trackActions,
             subMenu: actions,
         },
-        { type: 'divider' },
+        {
+            type: 'divider',
+            priority: TRACK_MENU_PRIORITY.trackActionsDivider,
+        },
     ];
 }
 // (TrackMenuSessionMixin — the minimal embedded-view variant — lives in its own
@@ -149,6 +154,7 @@ export function trackActionMenuItems(session, config, actions) {
 export function TrackMenuItemsSessionMixin(pluginManager) {
     return types.model('TrackMenuItemsSessionMixin', {}).views(s => {
         const self = s;
+        const session = asAbstractSession(self);
         return {
             /**
              * #method
@@ -156,8 +162,8 @@ export function TrackMenuItemsSessionMixin(pluginManager) {
              */
             getTrackListMenuItems(config, view) {
                 return [
-                    ...trackListMenuItems(self, config, self.getTrackActions(config, view)),
-                    ...pluginExtraTrackItems(pluginManager, self, config, view),
+                    ...trackListMenuItems(session, config, self.getTrackActions(config, view)),
+                    ...pluginExtraTrackItems(pluginManager, session, config, view),
                 ];
             },
             /**
@@ -165,9 +171,9 @@ export function TrackMenuItemsSessionMixin(pluginManager) {
              * track menu with About + "Track actions" submenu for the in-view label
              */
             getTrackActionMenuItems({ config, view, }) {
-                return trackActionMenuItems(self, config, [
+                return trackActionMenuItems(session, config, [
                     ...self.getTrackActions(config, view),
-                    ...pluginExtraTrackItems(pluginManager, self, config, view),
+                    ...pluginExtraTrackItems(pluginManager, session, config, view),
                 ]);
             },
         };

package/esm/Session/TrackMenuSessionMixin.js

@@ -1,5 +1,6 @@
+import { TRACK_MENU_PRIORITY } from '@jbrowse/core/ui/menuItems';
 import { types } from '@jbrowse/mobx-state-tree';
-import { asSession } from '../siblingCast.js';
+import { asAbstractSession } from '../siblingCast.js';
 import { aboutTrackMenuItem, trackListMenuItems } from './TrackMenu.js';
 import { pluginExtraTrackItems } from './pluginExtraTrackItems.js';
 /**
@@ -13,7 +14,7 @@ import { pluginExtraTrackItems } from './pluginExtraTrackItems.js';
  */
 export function TrackMenuSessionMixin(pluginManager) {
     return types.model('TrackMenuSessionMixin', {}).views(s => {
-        const self = asSession(s);
+        const self = asAbstractSession(s);
         return {
             /**
              * #method
@@ -33,7 +34,10 @@ export function TrackMenuSessionMixin(pluginManager) {
                     // priority mirrors the full TrackMenuItemsSessionMixin so "About
                     // track" sorts to the top of the in-view label menu consistently
                     // across embedded and full products
-                    { ...aboutTrackMenuItem(self, config), priority: 1002 },
+                    {
+                        ...aboutTrackMenuItem(self, config),
+                        priority: TRACK_MENU_PRIORITY.aboutTrack,
+                    },
                     ...pluginExtraTrackItems(pluginManager, self, config, view),
                 ];
             },