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

package/esm/Session/BaseSession.d.ts

@@ -6,12 +6,12 @@ import type { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
 import type { AnimationMode, DialogComponentType, TrackConfigChange } from '@jbrowse/core/util';
 import type { HighlightType } from '@jbrowse/core/util/highlights';
 import type { IAnyStateTreeNode, Instance } from '@jbrowse/mobx-state-tree';
-type DoneCallback = (doneCallback: () => void) => [DialogComponentType, Record<string, unknown>];
+import type React from 'react';
 /**
  * #stateModel BaseSessionModel
  *
- * base session shared by all JBrowse products. Be careful what you include
- * here, everything will use it.
+ * Holds a session's name, focused view, highlights and notifications. Every
+ * product's session composes this model, so add to it with care.
  */
 export declare function BaseSessionModel<ROOT_MODEL_TYPE extends BaseRootModelType, JB_CONFIG_SCHEMA extends AnyConfigurationSchemaType>(_pluginManager: PluginManager): import("@jbrowse/mobx-state-tree").IModelType<Omit<{
     /**
@@ -270,12 +270,15 @@ export declare function BaseSessionModel<ROOT_MODEL_TYPE extends BaseRootModelTy
     setFocusedViewId(viewId: string | undefined): void;
     /**
      * #action
+     * Dismiss the dialog on screen as its own close button would, so a
+     * dialog that settles a promise on close (an internet account's token
+     * prompt) settles it, and drop it from the queue if it did not.
      */
     removeActiveDialog(): void;
     /**
      * #action
      */
-    queueDialog(doneCallback: DoneCallback): void;
+    queueDialog<T extends DialogComponentType>(callback: (doneCallback: () => void) => [T, React.ComponentProps<T>]): void;
     /**
      * #action
      */
@@ -303,4 +306,3 @@ export type BaseSession = Instance<BaseSessionType>;
 export declare function isBaseSession(thing: IAnyStateTreeNode): thing is BaseSession;
 /** Type guard for whether a thing is JBrowse session */
 export declare function isSession(thing: unknown): thing is BaseSession;
-export {};

package/esm/Session/BaseSession.js

@@ -14,8 +14,8 @@ function isAnimationMode(val) {
 /**
  * #stateModel BaseSessionModel
  *
- * base session shared by all JBrowse products. Be careful what you include
- * here, everything will use it.
+ * Holds a session's name, focused view, highlights and notifications. Every
+ * product's session composes this model, so add to it with care.
  */
 export function BaseSessionModel(_pluginManager) {
     const baseModel = types
@@ -390,17 +390,27 @@ export function BaseSessionModel(_pluginManager) {
         },
         /**
          * #action
+         * Dismiss the dialog on screen as its own close button would, so a
+         * dialog that settles a promise on close (an internet account's token
+         * prompt) settles it, and drop it from the queue if it did not.
          */
         removeActiveDialog() {
-            self.queueOfDialogs = self.queueOfDialogs.slice(1);
+            const active = self.queueOfDialogs[0];
+            const close = active?.[1].handleClose;
+            if (typeof close === 'function') {
+                close();
+            }
+            if (self.queueOfDialogs[0] === active) {
+                self.queueOfDialogs = self.queueOfDialogs.slice(1);
+            }
         },
         /**
          * #action
          */
-        queueDialog(doneCallback) {
+        queueDialog(callback) {
             // its own entry, not the head: a late second call must not close the
             // dialog queued behind it
-            const entry = doneCallback(() => {
+            const entry = callback(() => {
                 this.removeDialog(entry);
             });
             self.queueOfDialogs = [...self.queueOfDialogs, entry];

package/esm/Session/Connections.d.ts

@@ -13,6 +13,9 @@ export interface ConnectionTrackConfigEntry {
 }
 /**
  * #stateModel ConnectionManagementSessionMixin
+ * Adds connections to a session: the connection instances it has made, and
+ * the configs of the connection tracks the user opened, so those tracks load
+ * on session restore without reconnecting.
  */
 export declare function ConnectionManagementSessionMixin(pluginManager: PluginManager): import("@jbrowse/mobx-state-tree").IModelType<{
     /**

package/esm/Session/Connections.js

@@ -3,6 +3,9 @@ import { asSession } from '../siblingCast.js';
 import { isBaseSession } from './BaseSession.js';
 /**
  * #stateModel ConnectionManagementSessionMixin
+ * Adds connections to a session: the connection instances it has made, and
+ * the configs of the connection tracks the user opened, so those tracks load
+ * on session restore without reconnecting.
  */
 export function ConnectionManagementSessionMixin(pluginManager) {
     return types

package/esm/Session/DrawerWidgets.d.ts

@@ -4,6 +4,8 @@ import type { DrawerPosition, Widget } from '@jbrowse/core/util/types';
 import type { IAnyStateTreeNode, Instance } from '@jbrowse/mobx-state-tree';
 /**
  * #stateModel DrawerWidgetSessionMixin
+ * Adds the widget drawer to a session: the open widgets, which one is
+ * showing, and the drawer's side, width and minimized state.
  */
 export declare function DrawerWidgetSessionMixin(pluginManager: PluginManager): import("@jbrowse/mobx-state-tree").IModelType<{
     /**

package/esm/Session/DrawerWidgets.js

@@ -36,6 +36,8 @@ function clampDrawerWidth(width, availableWidth) {
 }
 /**
  * #stateModel DrawerWidgetSessionMixin
+ * Adds the widget drawer to a session: the open widgets, which one is
+ * showing, and the drawer's side, width and minimized state.
  */
 export function DrawerWidgetSessionMixin(pluginManager) {
     const widgetStateModelType = pluginManager.pluggableMstType('widget', 'stateModel');