@jbrowse/product-core 2.17.0 → 2.18.0

package/esm/RootModel/HierarchicalConfig.js

@@ -1,44 +1,25 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
-/**
- * #config HierarchicalConfigSchema
- * generally exists on the config.json or root config as configuration.hierarchical
- */
 export function HierarchicalConfigSchemaFactory() {
     return ConfigurationSchema('hierarchical', {
         sort: ConfigurationSchema('hierarchicalSort', {
-            /**
-             * #slot configuration.hierarchical.sort.trackNames
-             */
             trackNames: {
                 type: 'boolean',
                 defaultValue: false,
             },
-            /**
-             * #slot configuration.hierarchical.sort.categories
-             */
             categories: {
                 type: 'boolean',
                 defaultValue: false,
             },
         }),
         defaultCollapsed: ConfigurationSchema('defaultCollapsed', {
-            /**
-             * #slot configuration.hierarchical.defaultCollapsed.categoryNames
-             */
             categoryNames: {
                 type: 'stringArray',
                 defaultValue: [],
             },
-            /**
-             * #slot configuration.hierarchical.defaultCollapsed.topLevelCategories
-             */
             topLevelCategories: {
                 type: 'boolean',
                 defaultValue: false,
             },
-            /**
-             * #slot configuration.hierarchical.defaultCollapsed.subCategories
-             */
             subCategories: {
                 type: 'boolean',
                 defaultValue: false,

package/esm/RootModel/InternetAccounts.d.ts

@@ -1,28 +1,12 @@
-import PluginManager from '@jbrowse/core/PluginManager';
-import { AnyConfigurationModel } from '@jbrowse/core/configuration';
-import { UriLocation } from '@jbrowse/core/util';
-import { Instance } from 'mobx-state-tree';
-/**
- * #stateModel InternetAccountsMixin
- * #category root
- */
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { AnyConfigurationModel } from '@jbrowse/core/configuration';
+import type { UriLocation } from '@jbrowse/core/util';
+import type { Instance } from 'mobx-state-tree';
 export declare function InternetAccountsRootModelMixin(pluginManager: PluginManager): import("mobx-state-tree").IModelType<{
-    /**
-     * #property
-     */
     internetAccounts: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyType>;
 }, {
-    /**
-     * #action
-     */
     initializeInternetAccount(internetAccountConfig: AnyConfigurationModel, initialSnapshot?: {}): any;
-    /**
-     * #action
-     */
     createEphemeralInternetAccount(internetAccountId: string, initialSnapshot: Record<string, unknown>, url: string): any;
-    /**
-     * #action
-     */
     findAppropriateInternetAccount(location: UriLocation): any;
 } & {
     afterCreate(): void;

package/esm/RootModel/InternetAccounts.js

@@ -1,21 +1,11 @@
 import { autorun } from 'mobx';
 import { addDisposer, types } from 'mobx-state-tree';
-/**
- * #stateModel InternetAccountsMixin
- * #category root
- */
 export function InternetAccountsRootModelMixin(pluginManager) {
     return types
         .model({
-        /**
-         * #property
-         */
         internetAccounts: types.array(pluginManager.pluggableMstType('internet account', 'stateModel')),
     })
         .actions(self => ({
-        /**
-         * #action
-         */
         initializeInternetAccount(internetAccountConfig, initialSnapshot = {}) {
             const internetAccountType = pluginManager.getInternetAccountType(internetAccountConfig.type);
             if (!internetAccountType) {
@@ -28,16 +18,12 @@ export function InternetAccountsRootModelMixin(pluginManager) {
             });
             return self.internetAccounts[length - 1];
         },
-        /**
-         * #action
-         */
         createEphemeralInternetAccount(internetAccountId, initialSnapshot, url) {
             let hostUri;
             try {
                 hostUri = new URL(url).origin;
             }
             catch (e) {
-                // ignore
             }
             const internetAccountSplit = internetAccountId.split('-');
             const configuration = {
@@ -56,11 +42,7 @@ export function InternetAccountsRootModelMixin(pluginManager) {
             self.internetAccounts.push(internetAccount);
             return internetAccount;
         },
-        /**
-         * #action
-         */
         findAppropriateInternetAccount(location) {
-            // find the existing account selected from menu
             const selectedId = location.internetAccountId;
             if (selectedId) {
                 const selectedAccount = self.internetAccounts.find(account => {
@@ -70,14 +52,12 @@ export function InternetAccountsRootModelMixin(pluginManager) {
                     return selectedAccount;
                 }
             }
-            // if no existing account or not found, try to find working account
             for (const account of self.internetAccounts) {
                 const handleResult = account.handlesLocation(location);
                 if (handleResult) {
                     return account;
                 }
             }
-            // if still no existing account, create ephemeral config to use
             return selectedId
                 ? this.createEphemeralInternetAccount(selectedId, {}, location.uri)
                 : null;

package/esm/Session/BaseSession.d.ts

@@ -1,62 +1,23 @@
-import PluginManager from '@jbrowse/core/PluginManager';
-import { IAnyStateTreeNode, Instance } from 'mobx-state-tree';
-import { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
 import type { BaseRootModelType } from '../RootModel/BaseRootModel';
-/**
- * #stateModel BaseSessionModel
- *
- * base session shared by all JBrowse products. Be careful what you include
- * here, everything will use it.
- */
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
+import type { IAnyStateTreeNode, Instance } from 'mobx-state-tree';
 export declare function BaseSessionModel<ROOT_MODEL_TYPE extends BaseRootModelType, JB_CONFIG_SCHEMA extends AnyConfigurationSchemaType>(_pluginManager: PluginManager): import("mobx-state-tree").IModelType<{
     id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
     name: import("mobx-state-tree").ISimpleType<string>;
     margin: import("mobx-state-tree").IType<number | undefined, number, number>;
 }, {
-    /**
-     * #volatile
-     * this is the globally "selected" object. can be anything. code that
-     * wants to deal with this should examine it to see what kind of thing it
-     * is.
-     */
     selection: unknown;
-    /**
-     * #volatile
-     * this is the globally "hovered" object. can be anything. code that
-     * wants to deal with this should examine it to see what kind of thing it
-     * is.
-     */
     hovered: unknown;
 } & {
-    /**
-     * #getter
-     */
     readonly root: import("mobx-state-tree").TypeOrStateTreeNodeToStateTreeNode<ROOT_MODEL_TYPE>;
 } & {
-    /**
-     * #getter
-     */
     readonly jbrowse: any;
-    /**
-     * #getter
-     */
     readonly rpcManager: import("@jbrowse/core/rpc/RpcManager").default;
-    /**
-     * #getter
-     */
     readonly configuration: Instance<JB_CONFIG_SCHEMA>;
-    /**
-     * #getter
-     */
     readonly adminMode: boolean;
-    /**
-     * #getter
-     */
     readonly textSearchManager: import("@jbrowse/core/util").TextSearchManager;
 } & {
-    /**
-     * #getter
-     */
     readonly assemblies: ({
         [x: string]: any;
     } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
@@ -82,12 +43,8 @@ export declare function BaseSessionModel<ROOT_MODEL_TYPE extends BaseRootModelTy
         refNameAliases: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
             adapter: import("mobx-state-tree").IAnyModelType;
         }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
-        cytobands: import("@jbrowse/core/configuration/configurationSchema" /**
-         * #getter
-         */).ConfigurationSchemaType<{
-            adapter: import("mobx-state-tree" /**
-             * #getter
-             */).IAnyModelType;
+        cytobands: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+            adapter: import("mobx-state-tree").IAnyModelType;
         }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
         displayName: {
             type: string;
@@ -96,27 +53,11 @@ export declare function BaseSessionModel<ROOT_MODEL_TYPE extends BaseRootModelTy
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "name">>>)[];
 } & {
-    /**
-     * #action
-     * set the global selection, i.e. the globally-selected object. can be a
-     * feature, a view, just about anything
-     */
     setSelection(thing: unknown): void;
-    /**
-     * #action
-     * clears the global selection
-     */
     clearSelection(): void;
-    /**
-     * #action
-     */
     setHovered(thing: unknown): void;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
-/** Session mixin MST type for the most basic session */
 export type BaseSessionType = ReturnType<typeof BaseSessionModel>;
-/** Instance of the most basic possible session */
 export type BaseSession = Instance<BaseSessionType>;
-/** Type guard for BaseSession */
 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;

package/esm/Session/BaseSession.js

@@ -1,120 +1,58 @@
-import { getParent, isStateTreeNode, types, } from 'mobx-state-tree';
 import { ElementId } from '@jbrowse/core/util/types/mst';
-/**
- * #stateModel BaseSessionModel
- *
- * base session shared by all JBrowse products. Be careful what you include
- * here, everything will use it.
- */
+import { getParent, isStateTreeNode, types } from 'mobx-state-tree';
 export function BaseSessionModel(_pluginManager) {
     return types
         .model({
-        /**
-         * #property
-         */
         id: ElementId,
-        /**
-         * #property
-         */
         name: types.string,
-        /**
-         * #property
-         */
         margin: 0,
     })
         .volatile(() => ({
-        /**
-         * #volatile
-         * this is the globally "selected" object. can be anything. code that
-         * wants to deal with this should examine it to see what kind of thing it
-         * is.
-         */
         selection: undefined,
-        /**
-         * #volatile
-         * this is the globally "hovered" object. can be anything. code that
-         * wants to deal with this should examine it to see what kind of thing it
-         * is.
-         */
         hovered: undefined,
     }))
         .views(self => ({
-        /**
-         * #getter
-         */
         get root() {
             return getParent(self);
         },
     }))
         .views(self => ({
-        /**
-         * #getter
-         */
         get jbrowse() {
             return self.root.jbrowse;
         },
-        /**
-         * #getter
-         */
         get rpcManager() {
             return self.root.rpcManager;
         },
-        /**
-         * #getter
-         */
         get configuration() {
             return this.jbrowse.configuration;
         },
-        /**
-         * #getter
-         */
         get adminMode() {
             return self.root.adminMode;
         },
-        /**
-         * #getter
-         */
         get textSearchManager() {
             return self.root.textSearchManager;
         },
     }))
         .views(self => ({
-        /**
-         * #getter
-         */
         get assemblies() {
             return self.jbrowse.assemblies;
         },
     }))
         .actions(self => ({
-        /**
-         * #action
-         * set the global selection, i.e. the globally-selected object. can be a
-         * feature, a view, just about anything
-         */
         setSelection(thing) {
             self.selection = thing;
         },
-        /**
-         * #action
-         * clears the global selection
-         */
         clearSelection() {
             self.selection = undefined;
         },
-        /**
-         * #action
-         */
         setHovered(thing) {
             self.hovered = thing;
         },
     }));
 }
-/** Type guard for BaseSession */
 export function isBaseSession(thing) {
     return 'id' in thing && 'name' in thing && 'root' in thing;
 }
-/** Type guard for whether a thing is JBrowse session */
 export function isSession(thing) {
     return isStateTreeNode(thing) && isBaseSession(thing);
 }

package/esm/Session/Connections.d.ts

@@ -1,13 +1,7 @@
-import PluginManager from '@jbrowse/core/PluginManager';
-import { AnyConfigurationModel } from '@jbrowse/core/configuration';
-import { IAnyStateTreeNode, Instance } from 'mobx-state-tree';
-/**
- * #stateModel ConnectionManagementSessionMixin
- */
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { AnyConfigurationModel } from '@jbrowse/core/configuration';
+import type { IAnyStateTreeNode, Instance } from 'mobx-state-tree';
 export declare function ConnectionManagementSessionMixin(pluginManager: PluginManager): import("mobx-state-tree").IModelType<{
-    /**
-     * #property
-     */
     connectionInstances: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
         name: import("mobx-state-tree").ISimpleType<string>;
         tracks: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>;
@@ -53,9 +47,6 @@ export declare function ConnectionManagementSessionMixin(pluginManager: PluginMa
         clear(): void;
     }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
 }, {
-    /**
-     * #getter
-     */
     readonly connections: ({
         [x: string]: any;
     } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
@@ -79,9 +70,6 @@ export declare function ConnectionManagementSessionMixin(pluginManager: PluginMa
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "connectionId">>>)[];
 } & {
-    /**
-     * #action
-     */
     makeConnection(configuration: AnyConfigurationModel, initialSnapshot?: {}): ({
         name: string;
         tracks: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>>;
@@ -179,31 +167,12 @@ export declare function ConnectionManagementSessionMixin(pluginManager: PluginMa
         setTrackConfs(trackConfs: AnyConfigurationModel[]): void;
         clear(): void;
     }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>) | undefined;
-    /**
-     * #action
-     */
     prepareToBreakConnection(configuration: AnyConfigurationModel): (Record<string, number> | (() => void))[] | undefined;
-    /**
-     * #action
-     */
     breakConnection(configuration: AnyConfigurationModel): void;
-    /**
-     * #action
-     */
     deleteConnection(configuration: AnyConfigurationModel): any;
-    /**
-     * #action
-     */
     addConnectionConf(connectionConf: AnyConfigurationModel): any;
-    /**
-     * #action
-     */
     clearConnections(): void;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
-/** Session mixin MST type for a session that has connections */
 export type SessionWithConnectionsType = ReturnType<typeof ConnectionManagementSessionMixin>;
-/** Instance of a session that has connections: `connectionInstances`,
- * `makeConnection()`, etc. */
 export type SessionWithConnections = Instance<SessionWithConnectionsType>;
-/** Type guard for SessionWithConnections */
 export declare function isSessionWithConnections(session: IAnyStateTreeNode): session is SessionWithConnections;

package/esm/Session/Connections.js

@@ -1,30 +1,18 @@
-import { readConfObject, } from '@jbrowse/core/configuration';
+import { readConfObject } from '@jbrowse/core/configuration';
 import { types } from 'mobx-state-tree';
 import { isBaseSession } from './BaseSession';
-/**
- * #stateModel ConnectionManagementSessionMixin
- */
 export function ConnectionManagementSessionMixin(pluginManager) {
     return types
         .model({
-        /**
-         * #property
-         */
         connectionInstances: types.array(pluginManager.pluggableMstType('connection', 'stateModel')),
     })
         .views(self => ({
-        /**
-         * #getter
-         */
         get connections() {
             const { jbrowse } = self;
             return jbrowse.connections;
         },
     }))
         .actions(self => ({
-        /**
-         * #action
-         */
         makeConnection(configuration, initialSnapshot = {}) {
             const type = configuration.type;
             if (!type) {
@@ -38,16 +26,11 @@ export function ConnectionManagementSessionMixin(pluginManager) {
             const length = self.connectionInstances.push({
                 ...initialSnapshot,
                 name,
-                // @ts-expect-error unsure why ts doesn't like `type` here, but is
-                // needed
                 type,
                 configuration,
             });
             return self.connectionInstances[length - 1];
         },
-        /**
-         * #action
-         */
         prepareToBreakConnection(configuration) {
             const root = self;
             const callbacksToDeref = [];
@@ -71,9 +54,6 @@ export function ConnectionManagementSessionMixin(pluginManager) {
                 derefTypeCount,
             ];
         },
-        /**
-         * #action
-         */
         breakConnection(configuration) {
             const name = readConfObject(configuration, 'name');
             const connection = self.connectionInstances.find(c => c.name === name);
@@ -82,29 +62,19 @@ export function ConnectionManagementSessionMixin(pluginManager) {
             }
             self.connectionInstances.remove(connection);
         },
-        /**
-         * #action
-         */
         deleteConnection(configuration) {
             const { jbrowse } = self;
             return jbrowse.deleteConnectionConf(configuration);
         },
-        /**
-         * #action
-         */
         addConnectionConf(connectionConf) {
             const { jbrowse } = self;
             return jbrowse.addConnectionConf(connectionConf);
         },
-        /**
-         * #action
-         */
         clearConnections() {
             self.connectionInstances.clear();
         },
     }));
 }
-/** Type guard for SessionWithConnections */
 export function isSessionWithConnections(session) {
     return isBaseSession(session) && 'connectionInstances' in session;
 }

package/esm/Session/DialogQueue.d.ts

@@ -1,34 +1,15 @@
-/** MST mixin for managing a queue of dialogs at the level of the session */
-import PluginManager from '@jbrowse/core/PluginManager';
-import { DialogComponentType } from '@jbrowse/core/util';
-import { IAnyStateTreeNode, Instance } from 'mobx-state-tree';
-/**
- * #stateModel DialogQueueSessionMixin
- */
+import type PluginManager from '@jbrowse/core/PluginManager';
+import type { DialogComponentType } from '@jbrowse/core/util';
+import type { IAnyStateTreeNode, Instance } from 'mobx-state-tree';
 export declare function DialogQueueSessionMixin(_pluginManager: PluginManager): import("mobx-state-tree").IModelType<{}, {
     queueOfDialogs: [DialogComponentType, unknown][];
 } & {
-    /**
-     * #getter
-     */
     readonly DialogComponent: DialogComponentType | undefined;
-    /**
-     * #getter
-     */
     readonly DialogProps: unknown;
 } & {
-    /**
-     * #action
-     */
     removeActiveDialog(): void;
-    /**
-     * #action
-     */
     queueDialog(cb: (doneCallback: () => void) => [DialogComponentType, unknown]): void;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
-/** Session mixin MST type for a session that has `queueOfDialogs`, etc. */
 export type SessionWithDialogsType = ReturnType<typeof DialogQueueSessionMixin>;
-/** Instance of a session that has dialogs */
 export type SessionWithDialogs = Instance<SessionWithDialogsType>;
-/** Type guard for SessionWithDialogs */
 export declare function isSessionWithDialogs(session: IAnyStateTreeNode): session is SessionWithDialogs;

package/esm/Session/DialogQueue.js

@@ -1,9 +1,5 @@
-/** MST mixin for managing a queue of dialogs at the level of the session */
 import { types } from 'mobx-state-tree';
 import { isBaseSession } from './BaseSession';
-/**
- * #stateModel DialogQueueSessionMixin
- */
 export function DialogQueueSessionMixin(_pluginManager) {
     return types
         .model('DialogQueueSessionMixin', {})
@@ -11,31 +7,19 @@ export function DialogQueueSessionMixin(_pluginManager) {
         queueOfDialogs: [],
     }))
         .views(self => ({
-        /**
-         * #getter
-         */
         get DialogComponent() {
             var _a;
             return (_a = self.queueOfDialogs[0]) === null || _a === void 0 ? void 0 : _a[0];
         },
-        /**
-         * #getter
-         */
         get DialogProps() {
             var _a;
             return (_a = self.queueOfDialogs[0]) === null || _a === void 0 ? void 0 : _a[1];
         },
     }))
         .actions(self => ({
-        /**
-         * #action
-         */
         removeActiveDialog() {
             self.queueOfDialogs = self.queueOfDialogs.slice(1);
         },
-        /**
-         * #action
-         */
         queueDialog(cb) {
             const [component, props] = cb(() => {
                 this.removeActiveDialog();
@@ -44,7 +28,6 @@ export function DialogQueueSessionMixin(_pluginManager) {
         },
     }));
 }
-/** Type guard for SessionWithDialogs */
 export function isSessionWithDialogs(session) {
     return isBaseSession(session) && 'queueOfDialogs' in session;
 }