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

package/esm/RootModel/createConfigModel.d.ts

@@ -0,0 +1,257 @@
+import RpcManager from '@jbrowse/core/rpc/RpcManager';
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { ConfigurationSnapshot } from '@jbrowse/core/configuration';
+import type { IAnyType } from '@jbrowse/mobx-state-tree';
+declare function rootConfigurationSchema(): import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+    readonly rpc: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly defaultDriver: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        readonly workerCount: {
+            type: "number";
+        } & {
+            defaultValue: number;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly hierarchical: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly sort: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly trackNames: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+            readonly categories: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        readonly defaultFolderCategories: {
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
+        };
+        readonly defaultCollapsed: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly categoryNames: {
+                type: "stringArray";
+            } & {
+                defaultValue: unknown;
+            };
+            readonly topLevelCategories: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+            readonly subCategories: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly preferences: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly animationMode: {
+            type: "stringEnum";
+        } & {
+            model: import("@jbrowse/mobx-state-tree").ISimpleType<"disabled" | "enabled" | "system">;
+        } & {
+            defaultValue: string;
+        };
+        readonly scrollZoom: {
+            type: "boolean";
+        } & {
+            defaultValue: boolean;
+        };
+        readonly numberGrouping: {
+            type: "boolean";
+        } & {
+            defaultValue: boolean;
+        };
+        readonly useWorkspaces: {
+            type: "boolean";
+        } & {
+            defaultValue: boolean;
+        };
+        readonly developerMode: {
+            type: "boolean";
+        } & {
+            defaultValue: boolean;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly formatDetails: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly feature: {
+            type: "frozen";
+        } & {
+            defaultValue: unknown;
+        };
+        readonly subfeatures: {
+            type: "frozen";
+        } & {
+            defaultValue: unknown;
+        };
+        readonly depth: {
+            type: "maybeNumber";
+        };
+        readonly maxDepth: {
+            type: "maybeNumber";
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly formatAbout: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly config: {
+            type: "frozen";
+        } & {
+            defaultValue: unknown;
+        };
+        readonly hideUris: {
+            type: "boolean";
+        } & {
+            defaultValue: boolean;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly theme: {
+        type: "frozen";
+    } & {
+        defaultValue: unknown;
+    };
+}, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+/**
+ * What an embedder may put in `createViewState`'s `configuration` option: every
+ * root slot and sub-schema by name, values unchecked. Derived from the schema
+ * above rather than restated, so a slot added there is spellable here the same
+ * day.
+ */
+export type RootConfigurationSnapshot = ConfigurationSnapshot<ReturnType<typeof rootConfigurationSchema>>;
+export declare function createConfigModel(pluginManager: PluginManager, assemblyConfigSchemasType: IAnyType): import("@jbrowse/mobx-state-tree").IModelType<{
+    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly rpc: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly defaultDriver: {
+                type: "string";
+            } & {
+                defaultValue: string;
+            };
+            readonly workerCount: {
+                type: "number";
+            } & {
+                defaultValue: number;
+            };
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        readonly hierarchical: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly sort: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+                readonly trackNames: {
+                    type: "boolean";
+                } & {
+                    defaultValue: boolean;
+                };
+                readonly categories: {
+                    type: "boolean";
+                } & {
+                    defaultValue: boolean;
+                };
+            }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+            readonly defaultFolderCategories: {
+                type: "stringArray";
+            } & {
+                defaultValue: unknown;
+            };
+            readonly defaultCollapsed: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+                readonly categoryNames: {
+                    type: "stringArray";
+                } & {
+                    defaultValue: unknown;
+                };
+                readonly topLevelCategories: {
+                    type: "boolean";
+                } & {
+                    defaultValue: boolean;
+                };
+                readonly subCategories: {
+                    type: "boolean";
+                } & {
+                    defaultValue: boolean;
+                };
+            }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        readonly preferences: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly animationMode: {
+                type: "stringEnum";
+            } & {
+                model: import("@jbrowse/mobx-state-tree").ISimpleType<"disabled" | "enabled" | "system">;
+            } & {
+                defaultValue: string;
+            };
+            readonly scrollZoom: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+            readonly numberGrouping: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+            readonly useWorkspaces: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+            readonly developerMode: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        readonly formatDetails: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly feature: {
+                type: "frozen";
+            } & {
+                defaultValue: unknown;
+            };
+            readonly subfeatures: {
+                type: "frozen";
+            } & {
+                defaultValue: unknown;
+            };
+            readonly depth: {
+                type: "maybeNumber";
+            };
+            readonly maxDepth: {
+                type: "maybeNumber";
+            };
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        readonly formatAbout: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            readonly config: {
+                type: "frozen";
+            } & {
+                defaultValue: unknown;
+            };
+            readonly hideUris: {
+                type: "boolean";
+            } & {
+                defaultValue: boolean;
+            };
+        }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+        readonly theme: {
+            type: "frozen";
+        } & {
+            defaultValue: unknown;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    /**
+     * One genome in the ordinary case, several where the view draws them
+     * together — a circular view's synteny ribbons need both ends of an
+     * alignment on the circle. The order is the order a view lays them out
+     * in.
+     */
+    assemblies: import("@jbrowse/mobx-state-tree").IArrayType<IAnyType>;
+    tracks: import("@jbrowse/mobx-state-tree").IType<Record<string, unknown>[] | null | undefined, Record<string, unknown>[], Record<string, unknown>[]>;
+    internetAccounts: import("@jbrowse/mobx-state-tree").IArrayType<import("@jbrowse/core/PluginManager").PluggableConfigSchemaType>;
+    connections: import("@jbrowse/mobx-state-tree").IArrayType<import("@jbrowse/core/PluginManager").PluggableConfigSchemaType>;
+    aggregateTextSearchAdapters: import("@jbrowse/mobx-state-tree").IArrayType<import("@jbrowse/core/PluginManager").PluggableConfigSchemaType>;
+    plugins: import("@jbrowse/mobx-state-tree").IType<any, any, any>;
+}, {
+    readonly assemblyNames: string[];
+    readonly rpcManager: RpcManager;
+}, import("@jbrowse/mobx-state-tree")._NotCustomized, import("@jbrowse/mobx-state-tree")._NotCustomized>;
+export {};

package/esm/RootModel/createConfigModel.js

@@ -0,0 +1,77 @@
+import { ConfigurationSchema, FormatAboutConfigSchemaFactory, FormatDetailsConfigSchemaFactory, readConfObject, } from '@jbrowse/core/configuration';
+import { migrateRetiredDisplays } from '@jbrowse/core/pluggableElementTypes/models';
+import RpcManager from '@jbrowse/core/rpc/RpcManager';
+import { expandLooseSearchIndex } from '@jbrowse/core/util/expandLooseSearchIndex';
+import { expandLooseTrackConfig } from '@jbrowse/core/util/tracks';
+import { getParent, types } from '@jbrowse/mobx-state-tree';
+import { HierarchicalConfigSchemaFactory } from './HierarchicalConfig.js';
+import { PreferencesConfigSchemaFactory } from './PreferencesConfig.js';
+// A function rather than a module constant so it is still built once per
+// createConfigModel call, as it was inline — what the function buys is a name
+// for its type, since `SnapshotIn` of the model erases every slot name (a
+// schema's MST props are assembled as a `Record<string, any>`).
+function rootConfigurationSchema() {
+    return ConfigurationSchema('Root', {
+        rpc: RpcManager.configSchema,
+        hierarchical: HierarchicalConfigSchemaFactory(),
+        preferences: PreferencesConfigSchemaFactory(),
+        formatDetails: FormatDetailsConfigSchemaFactory(),
+        formatAbout: FormatAboutConfigSchemaFactory(),
+        theme: { type: 'frozen', defaultValue: {} },
+    });
+}
+export function createConfigModel(pluginManager, assemblyConfigSchemasType) {
+    return (types
+        .model('Configuration', {
+        configuration: rootConfigurationSchema(),
+        /**
+         * One genome in the ordinary case, several where the view draws them
+         * together — a circular view's synteny ribbons need both ends of an
+         * alignment on the circle. The order is the order a view lays them out
+         * in.
+         */
+        assemblies: types.array(assemblyConfigSchemasType),
+        tracks: types.frozen([]),
+        internetAccounts: types.array(pluginManager.pluggableConfigSchemaType('internet account')),
+        connections: types.array(pluginManager.pluggableConfigSchemaType('connection')),
+        aggregateTextSearchAdapters: types.array(pluginManager.pluggableConfigSchemaType('text search adapter')),
+        plugins: types.frozen(),
+    })
+        // The first assembly is what every loose `{ trackId, uri }` track is on,
+        // so a snapshot need not repeat its name per track. `tracks` is frozen,
+        // so a retired display type stays spelt as written until the track
+        // hydrates — and the track selector reads these entries before that, so
+        // they carry the current name here as they do in app-core's JBrowseModel.
+        .preProcessSnapshot((snap) => {
+        const { tracks, aggregateTextSearchAdapters: indexes } = snap ?? {};
+        const assemblyName = snap?.assemblies?.[0]?.name;
+        return snap
+            ? {
+                ...snap,
+                ...(Array.isArray(tracks)
+                    ? {
+                        tracks: tracks.map(t => {
+                            const track = expandLooseTrackConfig(t, pluginManager, assemblyName);
+                            return track && typeof track === 'object'
+                                ? migrateRetiredDisplays(pluginManager, track)
+                                : track;
+                        }),
+                    }
+                    : {}),
+                ...(Array.isArray(indexes)
+                    ? {
+                        aggregateTextSearchAdapters: indexes.map(i => expandLooseSearchIndex(i, assemblyName ? [assemblyName] : undefined)),
+                    }
+                    : {}),
+            }
+            : snap;
+    })
+        .views(self => ({
+        get assemblyNames() {
+            return self.assemblies.map(a => readConfObject(a, 'name'));
+        },
+        get rpcManager() {
+            return getParent(self).rpcManager;
+        },
+    })));
+}

package/esm/RootModel/index.d.ts

@@ -1,5 +1,10 @@
-export * from './BaseRootModel.ts';
-export * from './InternetAccounts.ts';
-export * from './FormatAbout.ts';
-export * from './FormatDetails.ts';
-export * from './HierarchicalConfig.ts';
+export { BaseRootModelFactory, isRootModel } from './BaseRootModel.ts';
+export type { BaseRootModel, BaseRootModelType } from './BaseRootModel.ts';
+export { InternetAccountsRootModelMixin } from './InternetAccounts.ts';
+export type { RootModelWithInternetAccounts, RootModelWithInternetAccountsType, } from './InternetAccounts.ts';
+export { FormatAboutConfigSchemaFactory, FormatDetailsConfigSchemaFactory, } from '@jbrowse/core/configuration';
+export { HierarchicalConfigSchemaFactory } from './HierarchicalConfig.ts';
+export { PreferencesConfigSchemaFactory } from './PreferencesConfig.ts';
+export { createConfigModel } from './createConfigModel.ts';
+export type { RootConfigurationSnapshot } from './createConfigModel.ts';
+export { exportSessionMenuItem, importSessionMenuItem, newSessionMenuItem, openConnectionMenuItem, openTrackMenuItem, pluginStoreMenuItem, preferencesMenuItem, redoMenuItem, undoMenuItem, workspacesMenuItem, } from './menuItems.ts';

package/esm/RootModel/index.js

@@ -1,5 +1,10 @@
-export * from "./BaseRootModel.js";
-export * from "./InternetAccounts.js";
-export * from "./FormatAbout.js";
-export * from "./FormatDetails.js";
-export * from "./HierarchicalConfig.js";
+export { BaseRootModelFactory, isRootModel } from './BaseRootModel.js';
+export { InternetAccountsRootModelMixin } from './InternetAccounts.js';
+// re-exported rather than declared here: the same two schemas hang off every
+// track config, so they live in core next to `createBaseTrackConfig` and this
+// keeps the long-published `@jbrowse/product-core` spelling working
+export { FormatAboutConfigSchemaFactory, FormatDetailsConfigSchemaFactory, } from '@jbrowse/core/configuration';
+export { HierarchicalConfigSchemaFactory } from './HierarchicalConfig.js';
+export { PreferencesConfigSchemaFactory } from './PreferencesConfig.js';
+export { createConfigModel } from './createConfigModel.js';
+export { exportSessionMenuItem, importSessionMenuItem, newSessionMenuItem, openConnectionMenuItem, openTrackMenuItem, pluginStoreMenuItem, preferencesMenuItem, redoMenuItem, undoMenuItem, workspacesMenuItem, } from './menuItems.js';

package/esm/RootModel/menuItems.d.ts

@@ -0,0 +1,24 @@
+import type { SessionWithMultipleViews } from '../Session/index.ts';
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { MenuItem } from '@jbrowse/core/ui';
+import type { DialogComponentType } from '@jbrowse/core/util';
+interface RootWithDefaultSession {
+    setDefaultSession: () => void;
+}
+export declare function newSessionMenuItem(root: RootWithDefaultSession): MenuItem;
+export declare function importSessionMenuItem(): MenuItem;
+export declare function exportSessionMenuItem(): MenuItem;
+export declare function openTrackMenuItem(): MenuItem;
+export declare function openConnectionMenuItem(): MenuItem;
+export declare function pluginStoreMenuItem(): MenuItem;
+export declare function preferencesMenuItem(pluginManager: PluginManager, PreferencesDialog: DialogComponentType): MenuItem;
+interface HistoryManager {
+    canUndo: boolean;
+    canRedo: boolean;
+    undo(): void;
+    redo(): void;
+}
+export declare function undoMenuItem(history: HistoryManager): MenuItem;
+export declare function redoMenuItem(history: HistoryManager): MenuItem;
+export declare function workspacesMenuItem(session: SessionWithMultipleViews | undefined): MenuItem;
+export {};

package/esm/RootModel/menuItems.js

@@ -0,0 +1,141 @@
+import { Cable } from '@jbrowse/core/ui/Icons';
+import AddIcon from '@mui/icons-material/Add';
+import ExtensionIcon from '@mui/icons-material/Extension';
+import GetAppIcon from '@mui/icons-material/GetApp';
+import PublishIcon from '@mui/icons-material/Publish';
+import RedoIcon from '@mui/icons-material/Redo';
+import SettingsIcon from '@mui/icons-material/Settings';
+import SpaceDashboardIcon from '@mui/icons-material/SpaceDashboard';
+import StorageIcon from '@mui/icons-material/Storage';
+import UndoIcon from '@mui/icons-material/Undo';
+import { getShareableSessionSnapshot } from '../Session/index.js';
+// the renderer binds the active session into each onClick (see AppToolbar's
+// wrapMenuItems), so these handlers receive it as their argument
+const MULTI_VIEW_WARNING = 'This will add a track to the first view. Note: if you want to open a track in a specific view open the track selector for that view and use the add track (plus icon) in the bottom right';
+const WORKSPACES_HELP_TEXT = 'Workspaces allow you to organize views into tabs and tiles. There are a variety of unique features, for instance, you can drag views between tabs or split them side-by-side. Try clicking and dragging the tab header to create a new split';
+export function newSessionMenuItem(root) {
+    return {
+        label: 'New session',
+        icon: AddIcon,
+        onClick: () => {
+            root.setDefaultSession();
+        },
+    };
+}
+export function importSessionMenuItem() {
+    return {
+        label: 'Import session...',
+        icon: PublishIcon,
+        onClick: (session) => {
+            session.openWidget('ImportSessionWidget', 'importSessionWidget');
+        },
+    };
+}
+export function exportSessionMenuItem() {
+    return {
+        label: 'Export session',
+        icon: GetAppIcon,
+        onClick: async (session) => {
+            const { saveAs } = await import('@jbrowse/core/util/FileSaver');
+            saveAs(new Blob([
+                JSON.stringify({
+                    // an exported file is read by someone whose own preferences
+                    // differ, so stamp what the live session resolves at read
+                    // time (same rule as ShareDialog)
+                    session: getShareableSessionSnapshot(session),
+                }, null, 2),
+            ], { type: 'text/plain;charset=utf-8' }), 'session.json');
+        },
+    };
+}
+export function openTrackMenuItem() {
+    return {
+        label: 'Open track...',
+        icon: StorageIcon,
+        onClick: (session) => {
+            const firstView = session.views[0];
+            if (!firstView) {
+                session.notify('Please open a view to add a track first');
+            }
+            else {
+                session.openWidget('AddTrackWidget', 'addTrackWidget', {
+                    view: firstView.id,
+                });
+                if (session.views.length > 1) {
+                    session.notify(MULTI_VIEW_WARNING);
+                }
+            }
+        },
+    };
+}
+export function openConnectionMenuItem() {
+    return {
+        label: 'Open connection...',
+        icon: Cable,
+        onClick: (session) => {
+            session.openWidget('AddConnectionWidget', 'addConnectionWidget');
+        },
+    };
+}
+export function pluginStoreMenuItem() {
+    return {
+        label: 'Plugin store',
+        icon: ExtensionIcon,
+        onClick: (session) => {
+            session.openWidget('PluginStoreWidget', 'pluginStoreWidget');
+        },
+    };
+}
+// the dialog component differs per product, so it is passed in rather than
+// imported; typing it as DialogComponentType lets queueDialog accept it with no
+// cast (the inline call sites needed `as BaseSession` to reach queueDialog)
+export function preferencesMenuItem(pluginManager, PreferencesDialog) {
+    return {
+        label: 'Preferences',
+        icon: SettingsIcon,
+        onClick: (session) => {
+            session.queueDialog(handleClose => [
+                PreferencesDialog,
+                { session, pluginManager, handleClose },
+            ]);
+        },
+    };
+}
+export function undoMenuItem(history) {
+    return {
+        label: 'Undo',
+        icon: UndoIcon,
+        onClick: () => {
+            if (history.canUndo) {
+                history.undo();
+            }
+        },
+    };
+}
+export function redoMenuItem(history) {
+    return {
+        label: 'Redo',
+        icon: RedoIcon,
+        onClick: () => {
+            if (history.canRedo) {
+                history.redo();
+            }
+        },
+    };
+}
+export function workspacesMenuItem(session) {
+    return {
+        label: 'Use workspaces',
+        icon: SpaceDashboardIcon,
+        type: 'checkbox',
+        checked: session?.effectiveUseWorkspaces ?? false,
+        helpText: WORKSPACES_HELP_TEXT,
+        // opts out of the checkbox "stay open" default: this re-lays out the whole
+        // app (classic stack <-> tiled workspace), so it's a one-shot mode switch
+        // rather than a setting to flip repeatedly with the menu up
+        keepMenuOpen: false,
+        onClick: () => {
+            session?.setUseWorkspacesPreference(!session.effectiveUseWorkspaces);
+        },
+    };
+}