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

package/esm/ui/aboutTestUtils.d.ts

@@ -0,0 +1,140 @@
+import PluginManager from '@jbrowse/core/PluginManager';
+import type { SnapshotIn } from '@jbrowse/mobx-state-tree';
+export declare const aboutTestPluginManager: PluginManager;
+export declare const TestTrackConf: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+    readonly name: {
+        type: "string";
+    } & {
+        defaultValue: string;
+    };
+    readonly assemblyNames: {
+        type: "stringArray";
+    } & {
+        defaultValue: unknown;
+    };
+    readonly adapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly type: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        readonly bamLocation: {
+            type: "fileLocation";
+        } & {
+            defaultValue: unknown;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly metadata: {
+        type: "frozen";
+    } & {
+        defaultValue: unknown;
+    };
+    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>>;
+    trackId: {
+        type: "string";
+    } & {
+        defaultValue: string;
+    };
+}, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "trackId", undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+export declare function makeTrackConf(snapshot: SnapshotIn<typeof TestTrackConf>): import("@jbrowse/core/configuration").ConfigNodeProps<{
+    readonly name: {
+        type: "string";
+    } & {
+        defaultValue: string;
+    };
+    readonly assemblyNames: {
+        type: "stringArray";
+    } & {
+        defaultValue: unknown;
+    };
+    readonly adapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly type: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        readonly bamLocation: {
+            type: "fileLocation";
+        } & {
+            defaultValue: unknown;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly metadata: {
+        type: "frozen";
+    } & {
+        defaultValue: unknown;
+    };
+    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>>;
+    trackId: {
+        type: "string";
+    } & {
+        defaultValue: string;
+    };
+}> & import("@jbrowse/core/configuration").ConfigNodeActions & import("@jbrowse/core/configuration").ConfigNodeBrand<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+    readonly name: {
+        type: "string";
+    } & {
+        defaultValue: string;
+    };
+    readonly assemblyNames: {
+        type: "stringArray";
+    } & {
+        defaultValue: unknown;
+    };
+    readonly adapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly type: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        readonly bamLocation: {
+            type: "fileLocation";
+        } & {
+            defaultValue: unknown;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>;
+    readonly metadata: {
+        type: "frozen";
+    } & {
+        defaultValue: unknown;
+    };
+    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>>;
+    trackId: {
+        type: "string";
+    } & {
+        defaultValue: string;
+    };
+}, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "trackId", undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>>;

package/esm/ui/aboutTestUtils.js

@@ -0,0 +1,25 @@
+import PluginManager from '@jbrowse/core/PluginManager';
+import { ConfigurationSchema, FormatAboutConfigSchemaFactory, } from '@jbrowse/core/configuration';
+// a real PluginManager provides the jexl instance a callback slot evaluates with
+export const aboutTestPluginManager = new PluginManager([]).createPluggableElements();
+aboutTestPluginManager.configure();
+// the slots the About dialog reads off a track config, without registering a
+// track type to get them
+export const TestTrackConf = ConfigurationSchema('TestTrack', {
+    name: { type: 'string', defaultValue: '' },
+    assemblyNames: { type: 'stringArray', defaultValue: [] },
+    adapter: ConfigurationSchema('TestAdapter', {
+        type: { type: 'string', defaultValue: 'TestAdapter' },
+        bamLocation: {
+            type: 'fileLocation',
+            defaultValue: { uri: '', locationType: 'UriLocation' },
+        },
+    }),
+    metadata: { type: 'frozen', defaultValue: {} },
+    formatAbout: FormatAboutConfigSchemaFactory(),
+}, { explicitIdentifier: 'trackId' });
+export function makeTrackConf(snapshot) {
+    return TestTrackConf.create(snapshot, {
+        pluginManager: aboutTestPluginManager,
+    });
+}

package/esm/ui/descriptionHtml.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The URL of a track's prose description page in its `metadata`, as a UCSC
+ * track hub supplies it, and undefined for anything that is not an http(s) url
+ * — the value reaches `openLocation` and an anchor's href, so a `javascript:`
+ * or `file://` one does not become one here.
+ *
+ * Four spellings: `UCSCTrackHubConnection` spreads the trackDb stanza across
+ * `metadata`, the bulk converter behind genomes.jbrowse.org nests it under
+ * `metadata.ucsc` (~50,700 configs at permanent URLs), and the stanza key is
+ * `html` for a track and `htmlPath` for an assembly. Both producers write an
+ * escaped anchor rather than a bare url, so the href comes back through a parse
+ * rather than a regex.
+ */
+export declare function getDescriptionHtmlUrl(metadata: unknown): string | undefined;
+/**
+ * A fetched description page as markup for `SanitizedHTML`: links and images
+ * resolved against the page they came from rather than the JBrowse origin, and
+ * `<form>` dropped, which the sanitizer keeps and which in a document off a
+ * third-party origin is a credential prompt wearing the app's own chrome.
+ *
+ * Parsing rather than string-rewriting is what makes taking `body` handle the
+ * pages that are whole documents in the same pass. The parse is inert — no
+ * scripts run, no images load — and the sanitizer still sees everything after.
+ */
+export declare function rebaseDescriptionHtml(html: string, baseUrl: string): string;

package/esm/ui/descriptionHtml.js

@@ -0,0 +1,64 @@
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+function descriptionUrl(value) {
+    const href = new DOMParser()
+        .parseFromString(value, 'text/html')
+        .querySelector('a[href]')
+        ?.getAttribute('href');
+    const candidate = typeof href === 'string' ? href : value.trim();
+    return /^https?:\/\//i.test(candidate) ? candidate : undefined;
+}
+/**
+ * The URL of a track's prose description page in its `metadata`, as a UCSC
+ * track hub supplies it, and undefined for anything that is not an http(s) url
+ * — the value reaches `openLocation` and an anchor's href, so a `javascript:`
+ * or `file://` one does not become one here.
+ *
+ * Four spellings: `UCSCTrackHubConnection` spreads the trackDb stanza across
+ * `metadata`, the bulk converter behind genomes.jbrowse.org nests it under
+ * `metadata.ucsc` (~50,700 configs at permanent URLs), and the stanza key is
+ * `html` for a track and `htmlPath` for an assembly. Both producers write an
+ * escaped anchor rather than a bare url, so the href comes back through a parse
+ * rather than a regex.
+ */
+export function getDescriptionHtmlUrl(metadata) {
+    return [metadata, isRecord(metadata) ? metadata.ucsc : undefined]
+        .flatMap(record => (isRecord(record) ? [record.html, record.htmlPath] : []))
+        .filter(candidate => typeof candidate === 'string')
+        .map(candidate => descriptionUrl(candidate))
+        .find(url => url !== undefined);
+}
+function absolute(value, baseUrl) {
+    try {
+        return new URL(value, baseUrl).href;
+    }
+    catch {
+        return value;
+    }
+}
+/**
+ * A fetched description page as markup for `SanitizedHTML`: links and images
+ * resolved against the page they came from rather than the JBrowse origin, and
+ * `<form>` dropped, which the sanitizer keeps and which in a document off a
+ * third-party origin is a credential prompt wearing the app's own chrome.
+ *
+ * Parsing rather than string-rewriting is what makes taking `body` handle the
+ * pages that are whole documents in the same pass. The parse is inert — no
+ * scripts run, no images load — and the sanitizer still sees everything after.
+ */
+export function rebaseDescriptionHtml(html, baseUrl) {
+    const doc = new DOMParser().parseFromString(html, 'text/html');
+    for (const form of doc.querySelectorAll('form')) {
+        form.remove();
+    }
+    for (const el of doc.querySelectorAll('[href], [src]')) {
+        for (const attribute of ['href', 'src']) {
+            const value = el.getAttribute(attribute);
+            if (value) {
+                el.setAttribute(attribute, absolute(value, baseUrl));
+            }
+        }
+    }
+    return doc.body.innerHTML;
+}

package/esm/ui/drawerLayout.d.ts

@@ -0,0 +1,18 @@
+import type { DrawerPosition } from '@jbrowse/core/util/types';
+/**
+ * CSS `grid-template-columns` for a main content area with an optional drawer
+ * widget on the left or right. Shared by the app shell (`App.tsx`) and the
+ * embedded views so the drawer positioning stays identical across products.
+ *
+ * The `[main]`/`[drawer]` line names are the whole interface: a host renders
+ * the main container and the drawer once each, in any order, and each takes
+ * its column by name. Placing them by DOM order instead means the host has to
+ * render the drawer twice — once on each side, under opposite conditions — and
+ * any other in-flow child auto-placed between them lands in a column meant for
+ * one of the two.
+ */
+export declare function drawerGridTemplateColumns({ drawerVisible, drawerPosition, drawerWidth, }: {
+    drawerVisible: boolean;
+    drawerPosition: DrawerPosition;
+    drawerWidth: number;
+}): string;

package/esm/ui/drawerLayout.js

@@ -0,0 +1,22 @@
+/**
+ * CSS `grid-template-columns` for a main content area with an optional drawer
+ * widget on the left or right. Shared by the app shell (`App.tsx`) and the
+ * embedded views so the drawer positioning stays identical across products.
+ *
+ * The `[main]`/`[drawer]` line names are the whole interface: a host renders
+ * the main container and the drawer once each, in any order, and each takes
+ * its column by name. Placing them by DOM order instead means the host has to
+ * render the drawer twice — once on each side, under opposite conditions — and
+ * any other in-flow child auto-placed between them lands in a column meant for
+ * one of the two.
+ */
+export function drawerGridTemplateColumns({ drawerVisible, drawerPosition, drawerWidth, }) {
+    const main = '[main] minmax(0, 1fr)';
+    if (drawerVisible) {
+        const drawer = `[drawer] ${drawerWidth}px`;
+        return drawerPosition === 'right'
+            ? `${main} ${drawer}`
+            : `${drawer} ${main}`;
+    }
+    return main;
+}

package/esm/ui/index.d.ts

@@ -1 +1,15 @@
-export * from './AboutDialog.tsx';
+export { default as AppReadyMarker } from '@jbrowse/core/ui/AppReadyMarker';
+export { default as AboutDialog } from './AboutDialog.tsx';
+export type { AboutPanelProps } from './util.ts';
+export { default as Drawer } from './Drawer.tsx';
+export { default as DrawerControls } from './DrawerControls.tsx';
+export { default as DrawerHeader } from './DrawerHeader.tsx';
+export { default as DrawerWidget } from './DrawerWidget.tsx';
+export { default as DrawerWidgetSelector } from './DrawerWidgetSelector.tsx';
+export { drawerGridTemplateColumns } from './drawerLayout.ts';
+export { default as ModalWidget } from './ModalWidget.tsx';
+export { default as ModalWidgetAppBar } from './ModalWidgetAppBar.tsx';
+export { default as PreferencesDialog } from './PreferencesDialog.tsx';
+export type { PreferencesDialogSession, PreferencesPanelDescriptor, } from './PreferencesDialog.tsx';
+export { default as WidgetBody } from './WidgetBody.tsx';
+export { default as WidgetHeading } from './WidgetHeading.tsx';

package/esm/ui/index.js

@@ -1 +1,13 @@
-export * from "./AboutDialog.js";
+export { default as AppReadyMarker } from '@jbrowse/core/ui/AppReadyMarker';
+export { default as AboutDialog } from './AboutDialog.js';
+export { default as Drawer } from './Drawer.js';
+export { default as DrawerControls } from './DrawerControls.js';
+export { default as DrawerHeader } from './DrawerHeader.js';
+export { default as DrawerWidget } from './DrawerWidget.js';
+export { default as DrawerWidgetSelector } from './DrawerWidgetSelector.js';
+export { drawerGridTemplateColumns } from './drawerLayout.js';
+export { default as ModalWidget } from './ModalWidget.js';
+export { default as ModalWidgetAppBar } from './ModalWidgetAppBar.js';
+export { default as PreferencesDialog } from './PreferencesDialog.js';
+export { default as WidgetBody } from './WidgetBody.js';
+export { default as WidgetHeading } from './WidgetHeading.js';

package/esm/ui/preferencesReset.d.ts

@@ -0,0 +1,18 @@
+import type { TrackConfigChange } from '@jbrowse/core/util';
+export interface ResettablePreferencesSession {
+    themeName?: string;
+    setThemeName: (arg: string) => void;
+    themeMode: 'light' | 'dark' | 'system';
+    setThemeMode: (arg: 'light' | 'dark' | 'system') => void;
+    stickyViewHeaders: boolean;
+    setStickyViewHeaders: (sticky: boolean) => void;
+    effectiveUseWorkspaces: boolean;
+    defaultUseWorkspaces: boolean;
+    resetUseWorkspaces: () => void;
+    clearPreferenceOverrides: () => void;
+    clearPreferenceOverride: (key: string) => void;
+    getPreferenceChanges: () => TrackConfigChange[];
+}
+export declare function collectPreferenceChanges(session: ResettablePreferencesSession): TrackConfigChange[];
+export declare function resetAllPreferences(session: ResettablePreferencesSession): void;
+export declare function resetPreferenceChange(session: ResettablePreferencesSession, change: TrackConfigChange): void;

package/esm/ui/preferencesReset.js

@@ -0,0 +1,69 @@
+const NON_MAP_PREFERENCES = [
+    {
+        head: 'theme',
+        change: s => s.themeName && s.themeName !== 'default'
+            ? { path: ['theme'], from: 'default', to: s.themeName }
+            : undefined,
+        reset: s => {
+            s.setThemeName('default');
+        },
+    },
+    {
+        head: 'themeMode',
+        change: s => s.themeMode === 'light'
+            ? undefined
+            : { path: ['themeMode'], from: 'light', to: s.themeMode },
+        reset: s => {
+            s.setThemeMode('light');
+        },
+    },
+    {
+        head: 'stickyViewHeaders',
+        change: s => s.stickyViewHeaders
+            ? undefined
+            : { path: ['stickyViewHeaders'], from: true, to: false },
+        reset: s => {
+            s.setStickyViewHeaders(true);
+        },
+    },
+    {
+        head: 'useWorkspaces',
+        change: s => s.effectiveUseWorkspaces === s.defaultUseWorkspaces
+            ? undefined
+            : {
+                path: ['useWorkspaces'],
+                from: s.defaultUseWorkspaces,
+                to: s.effectiveUseWorkspaces,
+            },
+        reset: s => {
+            s.resetUseWorkspaces();
+        },
+    },
+];
+const NON_MAP_HEADS = new Set(NON_MAP_PREFERENCES.map(p => p.head));
+// Everything "Reset to defaults" reverts, as rows: the scalar overrides in the
+// preference map, and the preferences held outside it.
+export function collectPreferenceChanges(session) {
+    return [
+        ...session
+            .getPreferenceChanges()
+            .filter(c => !NON_MAP_HEADS.has(c.path[0])),
+        ...NON_MAP_PREFERENCES.map(p => p.change(session)).filter(c => c !== undefined),
+    ];
+}
+export function resetAllPreferences(session) {
+    session.clearPreferenceOverrides();
+    for (const p of NON_MAP_PREFERENCES) {
+        p.reset(session);
+    }
+}
+export function resetPreferenceChange(session, change) {
+    const [head] = change.path;
+    const pref = NON_MAP_PREFERENCES.find(p => p.head === head);
+    if (pref) {
+        pref.reset(session);
+    }
+    else if (head) {
+        session.clearPreferenceOverride(head);
+    }
+}

package/esm/ui/util.d.ts

@@ -1,15 +1,30 @@
-import type PluginManager from '@jbrowse/core/PluginManager';
 import type { AnyConfigurationModel } from '@jbrowse/core/configuration';
 import type { AbstractSessionModel } from '@jbrowse/core/util';
-export declare function removeAttr(obj: Record<string, unknown>, attr: string): Record<string, unknown>;
-export declare function readConf(config: AnyConfigurationModel | Record<string, unknown>, slotPath?: string | string[]): any;
-export declare function generateDisplayableConfig({ config, session, pluginManager, }: {
-    config: AnyConfigurationModel | Record<string, unknown>;
+export interface AboutPanelProps {
+    session: AbstractSessionModel;
+    /** the track's config, hydrated by the dialog before any panel sees it */
+    config: AnyConfigurationModel;
+}
+declare module '@jbrowse/core/PluginManager' {
+    interface ExtensionPointRegistry {
+        'Core-extraAboutPanel': ComponentList<AboutPanelProps>;
+        /** #extensionPoint Core-replaceAbout | sync | Replace or wrap a track's About dialog body */
+        'Core-replaceAbout': ComponentSlot<AboutPanelProps>;
+    }
+}
+/**
+ * What a track's About dialog shows: the config with the session's and the
+ * track's `formatAbout` callbacks merged over it, plus the resolved `hideUris`.
+ * The two slots fold differently on purpose: `config` is a merge the track can
+ * win key-by-key, `hideUris` an OR a track cannot turn back off.
+ */
+export declare function getAboutDialogConfig({ config, session, }: {
+    config: AnyConfigurationModel;
     session: AbstractSessionModel;
-    pluginManager: PluginManager;
 }): {
     config: {
-        metadata?: Record<string, unknown>;
         [key: string]: unknown;
+        metadata?: Record<string, unknown>;
     };
+    hideUris: boolean;
 };

package/esm/ui/util.js

@@ -1,42 +1,20 @@
-import { getConf, readConfObject } from '@jbrowse/core/configuration';
-import { getSnapshot, isStateTreeNode } from '@jbrowse/mobx-state-tree';
-export function removeAttr(obj, attr) {
-    for (const prop in obj) {
-        if (prop === attr) {
-            delete obj[prop];
-        }
-        else if (typeof obj[prop] === 'object') {
-            removeAttr(obj[prop], attr);
-        }
-    }
-    return obj;
-}
-export function readConf(config, slotPath) {
-    if (isStateTreeNode(config)) {
-        return slotPath
-            ? readConfObject(config, slotPath)
-            : getSnapshot(config);
-    }
-    if (!slotPath) {
-        return config;
-    }
-    if (typeof slotPath === 'string') {
-        return config[slotPath];
-    }
-    let result = config;
-    for (const key of slotPath) {
-        result = result?.[key];
-    }
-    return result;
-}
-export function generateDisplayableConfig({ config, session, pluginManager, }) {
-    const conf = isStateTreeNode(config) ? readConfObject(config) : config;
-    const formatAboutConfig = readConf(config, ['formatAbout', 'config']) || {};
-    return pluginManager.evaluateExtensionPoint('Core-customizeAbout', {
-        config: {
-            ...conf,
-            ...getConf(session, ['formatAbout', 'config'], { config: conf }),
-            ...formatAboutConfig,
-        },
-    }, { session, config });
+import { getConf, mergeFormatCallbacks, readConfObject, } from '@jbrowse/core/configuration';
+// #endregion
+/**
+ * What a track's About dialog shows: the config with the session's and the
+ * track's `formatAbout` callbacks merged over it, plus the resolved `hideUris`.
+ * The two slots fold differently on purpose: `config` is a merge the track can
+ * win key-by-key, `hideUris` an OR a track cannot turn back off.
+ */
+export function getAboutDialogConfig({ config, session, }) {
+    const conf = readConfObject(config);
+    const shown = {
+        ...conf,
+        ...mergeFormatCallbacks(getConf(session, ['formatAbout', 'config'], { config: conf }), readConfObject(config, ['formatAbout', 'config'], { config: conf })),
+    };
+    return {
+        config: shown,
+        hideUris: Boolean(getConf(session, ['formatAbout', 'hideUris']) ||
+            readConfObject(config, ['formatAbout', 'hideUris'])),
+    };
 }

package/esm/useEngineLifecycle.d.ts

@@ -0,0 +1,19 @@
+import type { EmbeddedRoot } from './destroyViewState.ts';
+export { useCreateOnce, useCreateOnceAsync } from '@jbrowse/core/util/hooks';
+/**
+ * Async `useCreateOnce` + `useDestroyOnUnmount`: undefined until the engine is
+ * ready. An engine resolving after the final unmount is destroyed on arrival
+ * instead of orphaning its worker pool and autoruns.
+ */
+export declare function useAsyncEngineLifecycle<T extends EmbeddedRoot>(create: () => Promise<T>): T | undefined;
+/**
+ * Destroy an engine when its component really unmounts — terminating its RPC
+ * worker threads and stopping its autoruns.
+ *
+ * The lifecycle rule is {@link useFinalUnmount}'s, including why the obvious
+ * `useEffect(() => () => destroyViewState(state), [state])` is wrong under
+ * StrictMode; this only names what gets torn down. Pair it with
+ * `useCreateOnce`, since the engine has to be the same one for the component's
+ * whole life.
+ */
+export declare function useDestroyOnUnmount(viewState: EmbeddedRoot): void;

package/esm/useEngineLifecycle.js

@@ -0,0 +1,44 @@
+import { useRef } from 'react';
+import { useCreateOnceAsync, useFinalUnmount } from '@jbrowse/core/util/hooks';
+import { destroyViewState } from './destroyViewState.js';
+// `useCreateOnce` is core's, and is re-exported rather than wrapped: an engine
+// is only the most expensive thing StrictMode's double-invoked state
+// initializer can build twice, not the only one. The faceted track selector's
+// MST model hit the same trap in a plugin, which cannot reach this package.
+export { useCreateOnce, useCreateOnceAsync } from '@jbrowse/core/util/hooks';
+/**
+ * Async `useCreateOnce` + `useDestroyOnUnmount`: undefined until the engine is
+ * ready. An engine resolving after the final unmount is destroyed on arrival
+ * instead of orphaning its worker pool and autoruns.
+ */
+export function useAsyncEngineLifecycle(create) {
+    const unmounted = useRef(false);
+    const engine = useCreateOnceAsync(() => create().then(built => {
+        if (unmounted.current) {
+            destroyViewState(built);
+        }
+        return built;
+    }));
+    useFinalUnmount(() => {
+        unmounted.current = true;
+        if (engine) {
+            destroyViewState(engine);
+        }
+    });
+    return engine;
+}
+/**
+ * Destroy an engine when its component really unmounts — terminating its RPC
+ * worker threads and stopping its autoruns.
+ *
+ * The lifecycle rule is {@link useFinalUnmount}'s, including why the obvious
+ * `useEffect(() => () => destroyViewState(state), [state])` is wrong under
+ * StrictMode; this only names what gets torn down. Pair it with
+ * `useCreateOnce`, since the engine has to be the same one for the component's
+ * whole life.
+ */
+export function useDestroyOnUnmount(viewState) {
+    useFinalUnmount(() => {
+        destroyViewState(viewState);
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jbrowse/product-core",
-  "version": "4.3.0",
+  "version": "5.0.0-beta.10",
   "type": "module",
   "sideEffects": false,
   "description": "JBrowse 2 code shared between products but not used by plugins",
@@ -21,37 +21,34 @@
   },
   "author": "JBrowse Team",
   "main": "esm/index.js",
+  "exports": {
+    ".": "./esm/index.js"
+  },
   "files": [
     "esm"
   ],
   "dependencies": {
-    "@jbrowse/mobx-state-tree": "^5.6.0",
-    "@mui/material": "^7.3.11",
-    "copy-to-clipboard": "^3.3.3",
-    "librpc-web-mod": "^2.1.1",
-    "mobx": "^6.15.3",
-    "mobx-react": "^9.2.1",
-    "@jbrowse/core": "^4.3.0"
+    "@jbrowse/mobx-state-tree": "^6.6.1",
+    "@mui/icons-material": "^9.4.0",
+    "@mui/material": "^9.4.0",
+    "mobx": "^7.0.5",
+    "mobx-react": "^10.0.2",
+    "@jbrowse/core": "^5.0.0-beta.10",
+    "@jbrowse/render-core": "^5.0.0-beta.10"
   },
   "peerDependencies": {
-    "react": ">=18.0.0",
-    "react-dom": ">=18.0.0"
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build:esm": "tsc -p tsconfig.build.esm.json",
+    "build:esm": "node ../../node_modules/typescript7/bin/tsc --build tsconfig.build.esm.json",
     "build": "pnpm build:esm",
     "test": "cd ../..; jest --passWithNoTests packages/product-core",
     "clean": "rimraf esm *.tsbuildinfo",
     "prebuild": "pnpm clean"
   },
-  "types": "esm/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./esm/index.d.ts",
-      "import": "./esm/index.js"
-    }
-  }
+  "types": "esm/index.d.ts"
 }