@jbrowse/product-core 4.3.0 → 5.0.0-beta.10

package/esm/Session/TrackMenu.js

@@ -0,0 +1,175 @@
+import { lazy } from 'react';
+import { InfoIcon } from '@jbrowse/core/ui/Icons';
+import { namesTemporaryAssembly } from '@jbrowse/core/util';
+import { types } from '@jbrowse/mobx-state-tree';
+import DeleteIcon from '@mui/icons-material/Delete';
+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 { pluginExtraTrackItems } from './pluginExtraTrackItems.js';
+const AboutDialog = lazy(() => import('../ui/AboutDialog.js'));
+/**
+ * The shared Settings / Copy / Copy-and-open / Delete track actions. Each
+ * product supplies `makeCopy` (its own session-track/category rules) and
+ * `canEdit`; reference sequence tracks can't be copied or deleted. When
+ * `isSessionOverride` is set the track carries session edits over its base
+ * config, so a Reset is offered, and it replaces Delete for a user who cannot
+ * delete the base.
+ */
+export function trackActionItems({ session, config, view, canEdit, isSessionOverride, makeCopy, }) {
+    const isRefSeq = config.type === 'ReferenceSequenceTrack';
+    // A copy of a track drawn on an assembly this view synthesized is dead on
+    // arrival: the assembly goes back when the view closes, and the copy is left
+    // naming one that never existed anywhere else. Both destinations were wrong
+    // for it — `publishTrackConf` writes an admin's into the config.json every
+    // visitor is served, one per click since the copy's stamped trackId defeats
+    // the dedupe, and a non-admin's lands as the dead `sessionTracks` entry
+    // ADR-084 removed the sweep for. Neither is worth offering, so the item says
+    // so instead of producing garbage; the contract check on the adders
+    // is what found this.
+    //
+    // Greying a row tells nobody anything, and this reason is one nobody guesses:
+    // a refseq track explains its own greyed Copy, a synteny band that looks like
+    // every other track does not. `disabledHelpText` is what says it.
+    const isTemporary = namesTemporaryAssembly(session, config);
+    const copyRefusal = isRefSeq
+        ? 'A reference sequence track cannot be copied.'
+        : isTemporary
+            ? 'This track is drawn on an assembly this view synthesized, which goes away with the view — a copy of it would name an assembly nothing can resolve.'
+            : undefined;
+    // the display active in this view expands in the config editor, so the
+    // track's other (incompatible/inactive) displays start collapsed
+    const expandedDisplayId = view?.getActiveDisplayId?.(config.trackId);
+    return [
+        {
+            // always available: editing a non-session (admin-owned) track applies
+            // in-memory for the current session even when the user can't persist it
+            label: 'Settings',
+            icon: SettingsIcon,
+            onClick: () => {
+                session.editConfiguration(config, { expandedDisplayId });
+            },
+        },
+        {
+            label: 'Copy track',
+            icon: CopyIcon,
+            disabled: isRefSeq || isTemporary,
+            disabledHelpText: copyRefusal,
+            onClick: () => {
+                session.publishTrackConf(makeCopy());
+            },
+        },
+        {
+            label: 'Copy and open track',
+            icon: OpenInNewIcon,
+            disabled: isRefSeq || isTemporary || !view,
+            disabledHelpText: copyRefusal ?? (view ? undefined : 'No view to open the copy in.'),
+            onClick: () => {
+                const snap = makeCopy();
+                if (session.publishTrackConf(snap)) {
+                    void view.launchTrack(snap.trackId);
+                }
+            },
+        },
+        ...(isSessionOverride
+            ? [
+                {
+                    label: 'Reset track settings',
+                    icon: SettingsBackupRestoreIcon,
+                    onClick: () => {
+                        session.resetTrackConfiguration?.(config.trackId);
+                    },
+                },
+            ]
+            : []),
+        ...(isSessionOverride && !canEdit
+            ? []
+            : [
+                {
+                    label: 'Delete track',
+                    icon: DeleteIcon,
+                    disabled: !canEdit || isRefSeq,
+                    onClick: () => {
+                        session.deleteTrackConf(config);
+                    },
+                },
+            ]),
+    ];
+}
+/** "About track" menu item, shared by every product's track menu */
+export function aboutTrackMenuItem(session, config) {
+    return {
+        label: 'About track',
+        icon: InfoIcon,
+        onClick: () => {
+            session.queueDialog(handleClose => [
+                AboutDialog,
+                { config, session, handleClose },
+            ]);
+        },
+    };
+}
+/**
+ * flattened track menu (About + raw actions) for the hierarchical track selector
+ */
+export function trackListMenuItems(session, config, actions) {
+    return [aboutTrackMenuItem(session, config), ...actions];
+}
+/**
+ * track menu with an "About track" item and a "Track actions" submenu, for the
+ * in-view track label menu
+ */
+export function trackActionMenuItems(session, config, actions) {
+    return [
+        {
+            ...aboutTrackMenuItem(session, config),
+            priority: 1002,
+        },
+        {
+            type: 'subMenu',
+            label: 'Track actions',
+            priority: 1001,
+            subMenu: actions,
+        },
+        { type: 'divider' },
+    ];
+}
+// (TrackMenuSessionMixin — the minimal embedded-view variant — lives in its own
+// file so each documented state model is the sole one in its file, which the
+// autogen docs generator requires.)
+/**
+ * #stateModel TrackMenuItemsSessionMixin
+ *
+ * The two track-menu wrappers (`getTrackListMenuItems` for the hierarchical
+ * selector, `getTrackActionMenuItems` for the in-view label menu) shared by the
+ * full web and desktop sessions. Both are pure functions of `getTrackActions`,
+ * which each session supplies (web gates on edit rights; desktop adds indexing).
+ */
+export function TrackMenuItemsSessionMixin(pluginManager) {
+    return types.model('TrackMenuItemsSessionMixin', {}).views(s => {
+        const self = s;
+        return {
+            /**
+             * #method
+             * flattened menu items for use in hierarchical track selector
+             */
+            getTrackListMenuItems(config, view) {
+                return [
+                    ...trackListMenuItems(self, config, self.getTrackActions(config, view)),
+                    ...pluginExtraTrackItems(pluginManager, self, config, view),
+                ];
+            },
+            /**
+             * #method
+             * track menu with About + "Track actions" submenu for the in-view label
+             */
+            getTrackActionMenuItems({ config, view, }) {
+                return trackActionMenuItems(self, config, [
+                    ...self.getTrackActions(config, view),
+                    ...pluginExtraTrackItems(pluginManager, self, config, view),
+                ]);
+            },
+        };
+    });
+}

package/esm/Session/TrackMenuSessionMixin.d.ts

@@ -0,0 +1,27 @@
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { AnyConfigurationModel } from '@jbrowse/core/configuration';
+import type { MenuItem } from '@jbrowse/core/ui';
+import type { TrackActionView } from '@jbrowse/core/util/types';
+/**
+ * #stateModel TrackMenuSessionMixin
+ *
+ * The minimal track menus used by the embedded react views, which have no
+ * track-editing actions to offer: just "About track" plus any plugin-contributed
+ * items (`Core-extraTrackMenuItems`). Mirrors the shape of the full
+ * `TrackMenuItemsSessionMixin` so both menu surfaces stay consistent across
+ * products, minus the Settings/Copy/Delete actions.
+ */
+export declare function TrackMenuSessionMixin(pluginManager: PluginManager): import("@jbrowse/mobx-state-tree").IModelType<{}, {
+    /**
+     * #method
+     * flattened menu items for use in hierarchical track selector
+     */
+    getTrackListMenuItems(config: AnyConfigurationModel, view?: TrackActionView): MenuItem[];
+    /**
+     * #method
+     */
+    getTrackActionMenuItems({ config, view, }: {
+        config: AnyConfigurationModel;
+        view?: TrackActionView;
+    }): MenuItem[];
+}, import("@jbrowse/mobx-state-tree")._NotCustomized, import("@jbrowse/mobx-state-tree")._NotCustomized>;

package/esm/Session/TrackMenuSessionMixin.js

@@ -0,0 +1,42 @@
+import { types } from '@jbrowse/mobx-state-tree';
+import { asSession } from '../siblingCast.js';
+import { aboutTrackMenuItem, trackListMenuItems } from './TrackMenu.js';
+import { pluginExtraTrackItems } from './pluginExtraTrackItems.js';
+/**
+ * #stateModel TrackMenuSessionMixin
+ *
+ * The minimal track menus used by the embedded react views, which have no
+ * track-editing actions to offer: just "About track" plus any plugin-contributed
+ * items (`Core-extraTrackMenuItems`). Mirrors the shape of the full
+ * `TrackMenuItemsSessionMixin` so both menu surfaces stay consistent across
+ * products, minus the Settings/Copy/Delete actions.
+ */
+export function TrackMenuSessionMixin(pluginManager) {
+    return types.model('TrackMenuSessionMixin', {}).views(s => {
+        const self = asSession(s);
+        return {
+            /**
+             * #method
+             * flattened menu items for use in hierarchical track selector
+             */
+            getTrackListMenuItems(config, view) {
+                return [
+                    ...trackListMenuItems(self, config, []),
+                    ...pluginExtraTrackItems(pluginManager, self, config, view),
+                ];
+            },
+            /**
+             * #method
+             */
+            getTrackActionMenuItems({ config, view, }) {
+                return [
+                    // 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 },
+                    ...pluginExtraTrackItems(pluginManager, self, config, view),
+                ];
+            },
+        };
+    });
+}