@jbrowse/product-core 5.0.0-beta.1 → 5.0.0-beta.3

package/esm/ui/preferencesReset.d.ts

@@ -0,0 +1,18 @@
+import type { DisplayDefaultsSession } from './displayDefaultChanges.ts';
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { TrackConfigChange } from '@jbrowse/core/util';
+export interface ResettablePreferencesSession extends DisplayDefaultsSession {
+    themeName?: string;
+    setThemeName: (arg: string) => 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, pluginManager: PluginManager): 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,64 @@
+import { displayDefaultChanges, resetDisplayDefault, } from './displayDefaultChanges.js';
+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: '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, the promoted display-type defaults (same map, listed through
+// the builder the Display defaults section uses so both surfaces read alike),
+// and the preferences held outside the map.
+export function collectPreferenceChanges(session, pluginManager) {
+    return [
+        ...session
+            .getPreferenceChanges()
+            .filter(c => !NON_MAP_HEADS.has(c.path[0])),
+        ...displayDefaultChanges(session, pluginManager),
+        ...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 (!resetDisplayDefault(session, change) && head) {
+        session.clearPreferenceOverride(head);
+    }
+}

package/esm/useEngineLifecycle.d.ts

@@ -1,5 +1,11 @@
 import type { EmbeddedRoot } from './destroyViewState.ts';
-export { useCreateOnce } from '@jbrowse/core/util/hooks';
+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.

package/esm/useEngineLifecycle.js

@@ -1,10 +1,32 @@
-import { useFinalUnmount } from '@jbrowse/core/util/hooks';
+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 } from '@jbrowse/core/util/hooks';
+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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jbrowse/product-core",
-  "version": "5.0.0-beta.1",
+  "version": "5.0.0-beta.3",
   "type": "module",
   "sideEffects": false,
   "description": "JBrowse 2 code shared between products but not used by plugins",
@@ -26,11 +26,12 @@
   ],
   "dependencies": {
     "@jbrowse/mobx-state-tree": "^6.5.1",
-    "@mui/icons-material": "^9.3.1",
-    "@mui/material": "^9.3.1",
+    "@mui/icons-material": "^9.4.0",
+    "@mui/material": "^9.4.0",
     "mobx": "^7.0.3",
     "mobx-react": "^10.0.2",
-    "@jbrowse/core": "^5.0.0-beta.1"
+    "@jbrowse/core": "^5.0.0-beta.3",
+    "@jbrowse/render-core": "^5.0.0-beta.3"
   },
   "peerDependencies": {
     "react": ">=19.0.0",

package/esm/scheduleDetachedDestroy.d.ts

@@ -1,18 +0,0 @@
-import type { IAnyStateTreeNode } from '@jbrowse/mobx-state-tree';
-/**
- * Free a tree an action has already let go of — a superseded session, a view
- * taken out of one, a superseded rootModel the React host has detached.
- *
- * A task rather than a microtask: the wait is for React to unmount the
- * components rendering it, which happens on the re-render that the action's own
- * reactions schedule. Deferring is acceptable here, and is not elsewhere,
- * because the node stays alive and detached until it fires — a late read gets a
- * live tree nobody is rendering. ADR-069.
- *
- * The destroy itself is not optional. `beforeDestroy` is a plugin-facing
- * contract (jbrowse-plugin-apollo aborts its in-flight fetches there) and core's
- * `BaseTrackModel` releases the `rpcSessionId` claim that lets
- * `CoreFreeResources` evict a parsed adapter from the worker — so detaching and
- * forgetting would trade a console warning for an unbounded leak.
- */
-export declare function scheduleDetachedDestroy(node: IAnyStateTreeNode): void;

package/esm/scheduleDetachedDestroy.js

@@ -1,24 +0,0 @@
-import { destroy, isAlive } from '@jbrowse/mobx-state-tree';
-/**
- * Free a tree an action has already let go of — a superseded session, a view
- * taken out of one, a superseded rootModel the React host has detached.
- *
- * A task rather than a microtask: the wait is for React to unmount the
- * components rendering it, which happens on the re-render that the action's own
- * reactions schedule. Deferring is acceptable here, and is not elsewhere,
- * because the node stays alive and detached until it fires — a late read gets a
- * live tree nobody is rendering. ADR-069.
- *
- * The destroy itself is not optional. `beforeDestroy` is a plugin-facing
- * contract (jbrowse-plugin-apollo aborts its in-flight fetches there) and core's
- * `BaseTrackModel` releases the `rpcSessionId` claim that lets
- * `CoreFreeResources` evict a parsed adapter from the worker — so detaching and
- * forgetting would trade a console warning for an unbounded leak.
- */
-export function scheduleDetachedDestroy(node) {
-    setTimeout(() => {
-        if (isAlive(node)) {
-            destroy(node);
-        }
-    }, 0);
-}