@jbrowse/core 2.16.1 → 2.18.0

package/TextSearch/TextSearchManager.d.ts

@@ -1,8 +1,8 @@
-import BaseResult from './BaseResults';
-import PluginManager from '../PluginManager';
 import QuickLRU from '../util/QuickLRU';
-import { BaseTextSearchAdapter, BaseTextSearchArgs } from '../data_adapters/BaseAdapter';
-import { AnyConfigurationModel } from '../configuration';
+import type BaseResult from './BaseResults';
+import type PluginManager from '../PluginManager';
+import type { AnyConfigurationModel } from '../configuration';
+import type { BaseTextSearchAdapter, BaseTextSearchArgs } from '../data_adapters/BaseAdapter';
 export interface SearchScope {
     includeAggregateIndexes: boolean;
     assemblyName: string;
@@ -28,18 +28,6 @@ export default class TextSearchManager {
             [x: string]: any;
         } & import("mobx-state-tree/dist/internal").NonEmptyObject & any & import("mobx-state-tree").IStateTreeNode<import("../configuration").AnyConfigurationSchemaType>);
     } & import("mobx-state-tree").IStateTreeNode<import("../configuration").AnyConfigurationSchemaType>)[];
-    /**
-     * Returns list of relevant results given a search query and options
-     *
-     * @param args - search options/arguments include: search query limit of
-     * results to return, searchType...prefix | full | exact", etc.
-     */
     search(args: BaseTextSearchArgs, searchScope: SearchScope, rankFn: (results: BaseResult[]) => BaseResult[]): Promise<BaseResult[]>;
-    /**
-     * Returns array of revelevant and sorted results
-     * @param results - array of results from all text search adapters
-     * @param rankFn - function that updates results scores
-     * based on more relevance
-     */
     sortResults(results: BaseResult[], rankFn: (results: BaseResult[]) => BaseResult[]): BaseResult[];
 }

package/TextSearch/TextSearchManager.js

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const QuickLRU_1 = __importDefault(require("../util/QuickLRU"));
 const configuration_1 = require("../configuration");
+const QuickLRU_1 = __importDefault(require("../util/QuickLRU"));
 class TextSearchManager {
     constructor(pluginManager) {
         this.pluginManager = pluginManager;
@@ -53,23 +53,11 @@ class TextSearchManager {
         })
             .map(conf => conf.textSearching.textSearchAdapter);
     }
-    /**
-     * Returns list of relevant results given a search query and options
-     *
-     * @param args - search options/arguments include: search query limit of
-     * results to return, searchType...prefix | full | exact", etc.
-     */
     async search(args, searchScope, rankFn) {
         const adapters = await this.loadTextSearchAdapters(searchScope);
         const results = await Promise.all(adapters.map(a => a.searchIndex(args)));
         return this.sortResults(results.flat(), rankFn);
     }
-    /**
-     * Returns array of revelevant and sorted results
-     * @param results - array of results from all text search adapters
-     * @param rankFn - function that updates results scores
-     * based on more relevance
-     */
     sortResults(results, rankFn) {
         return rankFn(results.sort((a, b) => -b.getLabel().localeCompare(a.getLabel()))).sort((r1, r2) => r1.getScore() - r2.getScore());
     }

package/assemblyManager/assembly.d.ts

@@ -1,8 +1,8 @@
-import { Instance, IAnyType } from 'mobx-state-tree';
-import { BaseOptions } from '../data_adapters/BaseAdapter';
-import PluginManager from '../PluginManager';
-import { Region, Feature } from '../util';
-import RpcManager from '../rpc/RpcManager';
+import type PluginManager from '../PluginManager';
+import type { BaseOptions } from '../data_adapters/BaseAdapter';
+import type RpcManager from '../rpc/RpcManager';
+import type { Feature, Region } from '../util';
+import type { IAnyType, Instance } from 'mobx-state-tree';
 type AdapterConf = Record<string, unknown>;
 type RefNameAliases = Record<string, string>;
 export interface RefNameMap {
@@ -15,13 +15,7 @@ export interface BasicRegion {
     refName: string;
     assemblyName: string;
 }
-/**
- * #stateModel Assembly
- */
 export default function assemblyFactory(assemblyConfigType: IAnyType, pluginManager: PluginManager): import("mobx-state-tree").IModelType<{
-    /**
-     * #property
-     */
     configuration: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IReferenceType<IAnyType>>;
 }, {
     error: unknown;
@@ -31,132 +25,43 @@ export default function assemblyFactory(assemblyConfigType: IAnyType, pluginMana
     lowerCaseRefNameAliases: RefNameAliases | undefined;
     cytobands: Feature[] | undefined;
 } & {
-    /**
-     * #method
-     */
     getConf(arg: string): any;
 } & {
-    /**
-     * #getter
-     */
     readonly initialized: boolean;
-    /**
-     * #getter
-     */
     readonly name: string;
-    /**
-     * #getter
-     */
     readonly regions: BasicRegion[] | undefined;
-    /**
-     * #getter
-     */
     readonly aliases: string[];
-    /**
-     * #getter
-     */
     readonly displayName: string | undefined;
-    /**
-     * #getter
-     */
     hasName(name: string): boolean;
-    /**
-     * #getter
-     */
     readonly allAliases: string[];
-    /**
-     * #getter
-     * note: lowerCaseRefNameAliases not included here: this allows the list
-     * of refnames to be just the "normal casing", but things like
-     * getCanonicalRefName can resolve a lower-case name if needed
-     */
     readonly allRefNames: string[] | undefined;
-    /**
-     * #getter
-     */
     readonly lowerCaseRefNames: string[] | undefined;
-    /**
-     * #getter
-     */
     readonly allRefNamesWithLowerCase: string[] | undefined;
-    /**
-     * #getter
-     */
     readonly rpcManager: RpcManager;
-    /**
-     * #getter
-     */
     readonly refNameColors: string[];
 } & {
-    /**
-     * #getter
-     */
     readonly refNames: string[] | undefined;
 } & {
-    /**
-     * #method
-     */
     getCanonicalRefName(refName: string): string | undefined;
-    /**
-     * #method
-     */
     getRefNameColor(refName: string): string | undefined;
-    /**
-     * #method
-     */
     isValidRefName(refName: string): boolean;
 } & {
-    /**
-     * #action
-     */
     setLoaded({ regions, refNameAliases, lowerCaseRefNameAliases, cytobands, }: {
         regions: Region[];
         refNameAliases: RefNameAliases;
         lowerCaseRefNameAliases: RefNameAliases;
         cytobands: Feature[];
     }): void;
-    /**
-     * #action
-     */
     setError(e: unknown): void;
-    /**
-     * #action
-     */
     setRegions(regions: Region[]): void;
-    /**
-     * #action
-     */
     setRefNameAliases(aliases: RefNameAliases, lowerCaseAliases: RefNameAliases): void;
-    /**
-     * #action
-     */
     setCytobands(cytobands: Feature[]): void;
-    /**
-     * #action
-     */
     setLoadingP(p?: Promise<void>): void;
-    /**
-     * #action
-     */
     load(): Promise<void>;
-    /**
-     * #action
-     */
     loadPre(): Promise<void>;
 } & {
-    /**
-     * #method
-     */
     getAdapterMapEntry(adapterConf: AdapterConf, options: BaseOptions): Promise<RefNameMap>;
-    /**
-     * #method
-     * get Map of `canonical-name -> adapter-specific-name`
-     */
     getRefNameMapForAdapter(adapterConf: AdapterConf, opts: BaseOptions): Promise<RefNameAliases>;
-    /**
-     * #method
-     * get Map of `adapter-specific-name -> canonical-name`
-     */
     getReverseRefNameMapForAdapter(adapterConf: AdapterConf, opts: BaseOptions): Promise<RefNameAliases>;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
 export type AssemblyModel = ReturnType<typeof assemblyFactory>;

package/assemblyManager/assembly.js

@@ -4,19 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = assemblyFactory;
-const mobx_state_tree_1 = require("mobx-state-tree");
 const abortable_promise_cache_1 = __importDefault(require("@gmod/abortable-promise-cache"));
-// locals
+const mobx_state_tree_1 = require("mobx-state-tree");
 const configuration_1 = require("../configuration");
+const dataAdapterCache_1 = require("../data_adapters/dataAdapterCache");
 const util_1 = require("../util");
 const QuickLRU_1 = __importDefault(require("../util/QuickLRU"));
-const dataAdapterCache_1 = require("../data_adapters/dataAdapterCache");
-/* biome-ignore lint/complexity/useRegexLiterals: */
 const refNameRegex = new RegExp('[0-9A-Za-z!#$%&+./:;?@^_|~-][0-9A-Za-z!#$%&*+./:;=?@^_|~-]*');
-// Based on the UCSC Genome Browser chromosome color palette:
-// https://github.com/ucscGenomeBrowser/kent/blob/a50ed53aff81d6fb3e34e6913ce18578292bc24e/src/hg/inc/chromColors.h
-// Some colors darkened to have at least a 3:1 contrast ratio on a white
-// background
 const refNameColors = [
     'rgb(153, 102, 0)',
     'rgb(102, 102, 0)',
@@ -24,36 +18,35 @@ const refNameColors = [
     'rgb(204, 0, 0)',
     'rgb(255, 0, 0)',
     'rgb(255, 0, 204)',
-    'rgb(165, 132, 132)', // originally 'rgb(255, 204, 204)'
-    'rgb(204, 122, 0)', // originally rgb(255, 153, 0)'
-    'rgb(178, 142, 0)', // originally 'rgb(255, 204, 0)'
-    'rgb(153, 153, 0)', // originally 'rgb(255, 255, 0)'
-    'rgb(122, 153, 0)', // originally 'rgb(204, 255, 0)'
-    'rgb(0, 165, 0)', // originally 'rgb(0, 255, 0)'
+    'rgb(165, 132, 132)',
+    'rgb(204, 122, 0)',
+    'rgb(178, 142, 0)',
+    'rgb(153, 153, 0)',
+    'rgb(122, 153, 0)',
+    'rgb(0, 165, 0)',
     'rgb(53, 128, 0)',
     'rgb(0, 0, 204)',
-    'rgb(96, 145, 242)', // originally 'rgb(102, 153, 255)'
-    'rgb(107, 142, 178)', // originally 'rgb(153, 204, 255)'
-    'rgb(0, 165, 165)', // originally 'rgb(0, 255, 255)'
-    'rgb(122, 153, 153)', // originally 'rgb(204, 255, 255)'
+    'rgb(96, 145, 242)',
+    'rgb(107, 142, 178)',
+    'rgb(0, 165, 165)',
+    'rgb(122, 153, 153)',
     'rgb(153, 0, 204)',
     'rgb(204, 51, 255)',
-    'rgb(173, 130, 216)', // originally 'rgb(204, 153, 255)'
+    'rgb(173, 130, 216)',
     'rgb(102, 102, 102)',
-    'rgb(145, 145, 145)', // originally 'rgb(153, 153, 153)'
-    'rgb(142, 142, 142)', // originally 'rgb(204, 204, 204)'
-    'rgb(142, 142, 107)', // originally 'rgb(204, 204, 153)'
-    'rgb(96, 163, 48)', // originally 'rgb(121, 204, 61)'
+    'rgb(145, 145, 145)',
+    'rgb(142, 142, 142)',
+    'rgb(142, 142, 107)',
+    'rgb(96, 163, 48)',
 ];
-async function loadRefNameMap(assembly, adapterConfig, options, signal) {
+async function loadRefNameMap(assembly, adapterConfig, options, stopToken) {
     const { sessionId } = options;
     await (0, util_1.when)(() => !!(assembly.regions && assembly.refNameAliases), {
-        signal,
         name: 'when assembly ready',
     });
     const refNames = (await assembly.rpcManager.call(sessionId || 'assemblyRpc', 'CoreGetRefNames', {
         adapterConfig,
-        signal,
+        stopToken,
         ...options,
     }, { timeout: 1000000 }));
     const { refNameAliases } = assembly;
@@ -72,29 +65,21 @@ async function loadRefNameMap(assembly, adapterConfig, options, signal) {
         ])),
     };
 }
-// Valid refName pattern from https://samtools.github.io/hts-specs/SAMv1.pdf
 function checkRefName(refName) {
     if (!refNameRegex.test(refName)) {
         throw new Error(`Encountered invalid refName: "${refName}"`);
     }
 }
-/**
- * #stateModel Assembly
- */
 function assemblyFactory(assemblyConfigType, pluginManager) {
     const adapterLoads = new abortable_promise_cache_1.default({
         cache: new QuickLRU_1.default({ maxSize: 1000 }),
-        // @ts-expect-error
-        async fill(args, signal, statusCallback) {
+        async fill(args, _stopToken, statusCallback) {
             const { adapterConf, self, options } = args;
-            return loadRefNameMap(self, adapterConf, { ...options, statusCallback }, signal);
+            return loadRefNameMap(self, adapterConf, { ...options, statusCallback });
         },
     });
     return mobx_state_tree_1.types
         .model({
-        /**
-         * #property
-         */
         configuration: mobx_state_tree_1.types.safeReference(assemblyConfigType),
     })
         .volatile(() => ({
@@ -106,123 +91,70 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
         cytobands: undefined,
     }))
         .views(self => ({
-        /**
-         * #method
-         */
         getConf(arg) {
             return self.configuration ? (0, configuration_1.getConf)(self, arg) : undefined;
         },
     }))
         .views(self => ({
-        /**
-         * #getter
-         */
         get initialized() {
-            // @ts-expect-error
             self.load();
             return !!self.refNameAliases;
         },
-        /**
-         * #getter
-         */
         get name() {
             return self.getConf('name') || '';
         },
-        /**
-         * #getter
-         */
         get regions() {
-            // @ts-expect-error
             self.load();
             return self.volatileRegions;
         },
-        /**
-         * #getter
-         */
         get aliases() {
             return self.getConf('aliases') || [];
         },
-        /**
-         * #getter
-         */
         get displayName() {
             return self.getConf('displayName');
         },
-        /**
-         * #getter
-         */
         hasName(name) {
             return this.allAliases.includes(name);
         },
-        /**
-         * #getter
-         */
         get allAliases() {
             return [this.name, ...this.aliases];
         },
-        /**
-         * #getter
-         * note: lowerCaseRefNameAliases not included here: this allows the list
-         * of refnames to be just the "normal casing", but things like
-         * getCanonicalRefName can resolve a lower-case name if needed
-         */
         get allRefNames() {
             return !self.refNameAliases
                 ? undefined
                 : Object.keys(self.refNameAliases);
         },
-        /**
-         * #getter
-         */
         get lowerCaseRefNames() {
             return !self.lowerCaseRefNameAliases
                 ? undefined
                 : Object.keys(self.lowerCaseRefNameAliases);
         },
-        /**
-         * #getter
-         */
         get allRefNamesWithLowerCase() {
             return this.allRefNames && this.lowerCaseRefNames
                 ? [...new Set([...this.allRefNames, ...this.lowerCaseRefNames])]
                 : undefined;
         },
-        /**
-         * #getter
-         */
         get rpcManager() {
             return (0, mobx_state_tree_1.getParent)(self, 2).rpcManager;
         },
-        /**
-         * #getter
-         */
         get refNameColors() {
             const colors = self.getConf('refNameColors') || [];
             return colors.length === 0 ? refNameColors : colors;
         },
     }))
         .views(self => ({
-        /**
-         * #getter
-         */
         get refNames() {
             var _a;
             return (_a = self.regions) === null || _a === void 0 ? void 0 : _a.map(region => region.refName);
         },
     }))
         .views(self => ({
-        /**
-         * #method
-         */
         getCanonicalRefName(refName) {
             if (!self.refNameAliases || !self.lowerCaseRefNameAliases) {
                 throw new Error('aliases not loaded, we expect them to be loaded before getCanonicalRefName can be called');
             }
             return (self.refNameAliases[refName] || self.lowerCaseRefNameAliases[refName]);
         },
-        /**
-         * #method
-         */
         getRefNameColor(refName) {
             if (!self.refNames) {
                 return undefined;
@@ -232,9 +164,6 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
                 ? undefined
                 : self.refNameColors[idx % self.refNameColors.length];
         },
-        /**
-         * #method
-         */
         isValidRefName(refName) {
             if (!self.refNameAliases) {
                 throw new Error('isValidRefName cannot be called yet, the assembly has not finished loading');
@@ -243,48 +172,27 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
         },
     }))
         .actions(self => ({
-        /**
-         * #action
-         */
         setLoaded({ regions, refNameAliases, lowerCaseRefNameAliases, cytobands, }) {
             this.setRegions(regions);
             this.setRefNameAliases(refNameAliases, lowerCaseRefNameAliases);
             this.setCytobands(cytobands);
         },
-        /**
-         * #action
-         */
         setError(e) {
             self.error = e;
         },
-        /**
-         * #action
-         */
         setRegions(regions) {
             self.volatileRegions = regions;
         },
-        /**
-         * #action
-         */
         setRefNameAliases(aliases, lowerCaseAliases) {
             self.refNameAliases = aliases;
             self.lowerCaseRefNameAliases = lowerCaseAliases;
         },
-        /**
-         * #action
-         */
         setCytobands(cytobands) {
             self.cytobands = cytobands;
         },
-        /**
-         * #action
-         */
         setLoadingP(p) {
             self.loadingP = p;
         },
-        /**
-         * #action
-         */
         load() {
             if (!self.loadingP) {
                 self.loadingP = this.loadPre().catch((e) => {
@@ -294,9 +202,6 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
             }
             return self.loadingP;
         },
-        /**
-         * #action
-         */
         async loadPre() {
             var _a, _b;
             var _c;
@@ -323,17 +228,11 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
                     checkRefName(alias);
                     refNameAliases[alias] = refName;
                 }
-                // the override field is supplied by a RefNameAliasAdapter to make
-                // the refName field returned by the adapter to be used as the
-                // primary names for this assembly
                 if (override) {
                     refNameAliases[refName] = refName;
                 }
             }
-            // add identity to the refNameAliases list
             for (const region of adapterRegionsWithAssembly) {
-                // this ||= means that if the refNameAliasAdapter already set a
-                // mapping for the primary region to be an alias
                 refNameAliases[_c = region.refName] || (refNameAliases[_c] = region.refName);
             }
             const lowerCaseRefNameAliases = Object.fromEntries(Object.entries(refNameAliases).map(([key, val]) => [
@@ -355,11 +254,8 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
         },
     }))
         .views(self => ({
-        /**
-         * #method
-         */
         getAdapterMapEntry(adapterConf, options) {
-            const { signal, statusCallback, ...rest } = options;
+            const { stopToken, statusCallback, ...rest } = options;
             if (!options.sessionId) {
                 throw new Error('sessionId is required');
             }
@@ -367,15 +263,8 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
                 adapterConf,
                 self,
                 options: rest,
-            }, 
-            // signal intentionally not passed here, fixes issues like #2221.
-            // alternative fix #2540 was proposed but non-working currently
-            undefined, statusCallback);
+            }, undefined, statusCallback);
         },
-        /**
-         * #method
-         * get Map of `canonical-name -> adapter-specific-name`
-         */
         async getRefNameMapForAdapter(adapterConf, opts) {
             if (!opts.sessionId) {
                 throw new Error('sessionId is required');
@@ -383,32 +272,27 @@ function assemblyFactory(assemblyConfigType, pluginManager) {
             const map = await this.getAdapterMapEntry(adapterConf, opts);
             return map.forwardMap;
         },
-        /**
-         * #method
-         * get Map of `adapter-specific-name -> canonical-name`
-         */
         async getReverseRefNameMapForAdapter(adapterConf, opts) {
             const map = await this.getAdapterMapEntry(adapterConf, opts);
             return map.reverseMap;
         },
     }));
 }
-async function getRefNameAliases({ config, pluginManager, signal, }) {
+async function getRefNameAliases({ config, pluginManager, stopToken, }) {
     const type = pluginManager.getAdapterType(config.type);
     const CLASS = await type.getAdapterClass();
     const adapter = new CLASS(config, undefined, pluginManager);
-    return adapter.getRefNameAliases({ signal });
+    return adapter.getRefNameAliases({ stopToken });
 }
 async function getCytobands({ config, pluginManager, }) {
     const type = pluginManager.getAdapterType(config.type);
     const CLASS = await type.getAdapterClass();
     const adapter = new CLASS(config, undefined, pluginManager);
-    // @ts-expect-error
     return adapter.getData();
 }
-async function getAssemblyRegions({ config, pluginManager, signal, }) {
+async function getAssemblyRegions({ config, pluginManager, stopToken, }) {
     const type = pluginManager.getAdapterType(config.type);
     const CLASS = await type.getAdapterClass();
     const adapter = new CLASS(config, undefined, pluginManager);
-    return adapter.getRegions({ signal });
+    return adapter.getRegions({ stopToken });
 }

package/assemblyManager/assemblyConfigSchema.d.ts

@@ -1,55 +1,22 @@
-import PluginManager from '../PluginManager';
-/**
- * #config BaseAssembly
- * #category assemblyManagement
- * This corresponds to the assemblies section of the config
- */
+import type PluginManager from '../PluginManager';
 declare function assemblyConfigSchema(pluginManager: PluginManager): import("../configuration/configurationSchema").ConfigurationSchemaType<{
-    /**
-     * #slot
-     * aliases are "reference name aliases" e.g. aliases for hg38 might be
-     * "GRCh38"
-     */
     aliases: {
         type: string;
         defaultValue: never[];
         description: string;
     };
-    /**
-     * #slot
-     * sequence refers to a reference sequence track that has an adapter
-     * containing, importantly, a sequence adapter such as
-     * IndexedFastaAdapter
-     */
     sequence: import("../configuration").AnyConfigurationSchemaType;
-    /**
-     * #slot
-     */
     refNameColors: {
         type: string;
         defaultValue: never[];
         description: string;
     };
     refNameAliases: import("../configuration/configurationSchema").ConfigurationSchemaType<{
-        /**
-         * #slot refNameAliases.adapter
-         * refNameAliases help resolve e.g. chr1 and 1 as the same entity the
-         * data for refNameAliases are fetched from an adapter, that is
-         * commonly a tsv like chromAliases.txt from UCSC or similar
-         */
         adapter: import("mobx-state-tree").IAnyModelType;
     }, import("../configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
     cytobands: import("../configuration/configurationSchema").ConfigurationSchemaType<{
-        /**
-         * #slot cytobands.adapter
-         * cytoband data is fetched from an adapter, and can be displayed by
-         * a view type as ideograms
-         */
         adapter: import("mobx-state-tree").IAnyModelType;
     }, import("../configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
-    /**
-     * #slot
-     */
     displayName: {
         type: string;
         defaultValue: string;