@jbrowse/plugin-sequence 2.17.0 → 3.0.0

package/esm/TwoBitAdapter/TwoBitAdapter.d.ts

@@ -1,26 +1,29 @@
+import { TwoBitFile } from '@gmod/twobit';
 import { BaseSequenceAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
-import { NoAssemblyRegion } from '@jbrowse/core/util/types';
-import { Feature } from '@jbrowse/core/util/simpleFeature';
-import { AnyConfigurationModel } from '@jbrowse/core/configuration';
-import PluginManager from '@jbrowse/core/PluginManager';
-import { getSubAdapterType } from '@jbrowse/core/data_adapters/dataAdapterCache';
+import type { Feature } from '@jbrowse/core/util/simpleFeature';
+import type { NoAssemblyRegion } from '@jbrowse/core/util/types';
 export default class TwoBitAdapter extends BaseSequenceAdapter {
-    private twobit;
-    protected chromSizesData: Promise<Record<string, number> | undefined>;
+    protected setupP?: Promise<{
+        twobit: TwoBitFile;
+        chromSizesData: Record<string, number> | undefined;
+    }>;
     private initChromSizes;
-    constructor(config: AnyConfigurationModel, getSubAdapter?: getSubAdapterType, pluginManager?: PluginManager);
+    setupPre(): Promise<{
+        twobit: TwoBitFile;
+        chromSizesData: {
+            [k: string]: number;
+        } | undefined;
+    }>;
+    setup(): Promise<{
+        twobit: TwoBitFile;
+        chromSizesData: Record<string, number> | undefined;
+    }>;
     getRefNames(): Promise<string[]>;
-    getRegions(): Promise<NoAssemblyRegion[]>;
-    /**
-     * Fetch features for a certain region
-     * @param param -
-     * @returns Observable of Feature objects in the region
-     */
+    getRegions(): Promise<{
+        refName: string;
+        start: number;
+        end: number;
+    }[]>;
     getFeatures({ refName, start, end }: NoAssemblyRegion): import("rxjs").Observable<Feature>;
-    /**
-     * called to provide a hint that data tied to a certain region
-     * will not be needed for the foreseeable future and can be purged
-     * from caches, etc
-     */
     freeResources(): void;
 }

package/esm/TwoBitAdapter/TwoBitAdapter.js

@@ -1,15 +1,12 @@
+import { TwoBitFile } from '@gmod/twobit';
+import { readConfObject } from '@jbrowse/core/configuration';
 import { BaseSequenceAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
 import { openLocation } from '@jbrowse/core/util/io';
 import { ObservableCreate } from '@jbrowse/core/util/rxjs';
 import SimpleFeature from '@jbrowse/core/util/simpleFeature';
-import { TwoBitFile } from '@gmod/twobit';
-import { readConfObject } from '@jbrowse/core/configuration';
 export default class TwoBitAdapter extends BaseSequenceAdapter {
     async initChromSizes() {
         const conf = readConfObject(this.config, 'chromSizesLocation');
-        // check against default and empty in case someone makes the field blank in
-        // config editor, may want better way to check "optional config slots" in
-        // future
         if (conf.uri !== '/path/to/default.chrom.sizes' && conf.uri !== '') {
             const file = openLocation(conf, this.pluginManager);
             const data = await file.readFile('utf8');
@@ -23,23 +20,31 @@ export default class TwoBitAdapter extends BaseSequenceAdapter {
         }
         return undefined;
     }
-    constructor(config, getSubAdapter, pluginManager) {
-        super(config, getSubAdapter, pluginManager);
-        const pm = this.pluginManager;
-        this.chromSizesData = this.initChromSizes();
-        this.twobit = new TwoBitFile({
-            filehandle: openLocation(this.getConf('twoBitLocation'), pm),
-        });
+    async setupPre() {
+        return {
+            twobit: new TwoBitFile({
+                filehandle: openLocation(this.getConf('twoBitLocation'), this.pluginManager),
+            }),
+            chromSizesData: await this.initChromSizes(),
+        };
     }
-    async getRefNames() {
-        const chromSizesData = await this.chromSizesData;
-        if (chromSizesData) {
-            return Object.keys(chromSizesData);
+    async setup() {
+        if (!this.setupP) {
+            this.setupP = this.setupPre().catch((e) => {
+                this.setupP = undefined;
+                throw e;
+            });
         }
-        return this.twobit.getSequenceNames();
+        return this.setupP;
+    }
+    async getRefNames() {
+        const { chromSizesData, twobit } = await this.setup();
+        return chromSizesData
+            ? Object.keys(chromSizesData)
+            : twobit.getSequenceNames();
     }
     async getRegions() {
-        const chromSizesData = await this.chromSizesData;
+        const { chromSizesData, twobit } = await this.setup();
         if (chromSizesData) {
             return Object.keys(chromSizesData).map(refName => ({
                 refName,
@@ -47,23 +52,21 @@ export default class TwoBitAdapter extends BaseSequenceAdapter {
                 end: chromSizesData[refName],
             }));
         }
-        const refSizes = await this.twobit.getSequenceSizes();
-        return Object.keys(refSizes).map(refName => ({
-            refName,
-            start: 0,
-            end: refSizes[refName],
-        }));
+        else {
+            const refSizes = await twobit.getSequenceSizes();
+            return Object.keys(refSizes).map(refName => ({
+                refName,
+                start: 0,
+                end: refSizes[refName],
+            }));
+        }
     }
-    /**
-     * Fetch features for a certain region
-     * @param param -
-     * @returns Observable of Feature objects in the region
-     */
     getFeatures({ refName, start, end }) {
         return ObservableCreate(async (observer) => {
-            const size = await this.twobit.getSequenceSize(refName);
+            const { twobit } = await this.setup();
+            const size = await twobit.getSequenceSize(refName);
             const regionEnd = size !== undefined ? Math.min(size, end) : end;
-            const seq = await this.twobit.getSequence(refName, start, regionEnd);
+            const seq = await twobit.getSequence(refName, start, regionEnd);
             if (seq) {
                 observer.next(new SimpleFeature({
                     id: `${refName} ${start}-${regionEnd}`,
@@ -73,10 +76,5 @@ export default class TwoBitAdapter extends BaseSequenceAdapter {
             observer.complete();
         });
     }
-    /**
-     * called to provide a hint that data tied to a certain region
-     * will not be needed for the foreseeable future and can be purged
-     * from caches, etc
-     */
-    freeResources( /* { region } */) { }
+    freeResources() { }
 }

package/esm/TwoBitAdapter/configSchema.d.ts

@@ -1,7 +1,4 @@
 declare const TwoBitAdapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-    /**
-     * #slot
-     */
     twoBitLocation: {
         type: string;
         defaultValue: {
@@ -9,9 +6,6 @@ declare const TwoBitAdapter: import("@jbrowse/core/configuration/configurationSc
             locationType: string;
         };
     };
-    /**
-     * #slot
-     */
     chromSizesLocation: {
         type: string;
         defaultValue: {

package/esm/TwoBitAdapter/configSchema.js

@@ -1,19 +1,10 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
-/**
- * #config TwoBitAdapter
- */
-function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+function x() { }
 const TwoBitAdapter = ConfigurationSchema('TwoBitAdapter', {
-    /**
-     * #slot
-     */
     twoBitLocation: {
         type: 'fileLocation',
         defaultValue: { uri: '/path/to/my.2bit', locationType: 'UriLocation' },
     },
-    /**
-     * #slot
-     */
     chromSizesLocation: {
         type: 'fileLocation',
         defaultValue: {

package/esm/TwoBitAdapter/index.d.ts

@@ -1,2 +1,2 @@
-import PluginManager from '@jbrowse/core/PluginManager';
+import type PluginManager from '@jbrowse/core/PluginManager';
 export default function TwoBitAdapterF(pluginManager: PluginManager): void;

package/esm/UnindexedFastaAdapter/UnindexedFastaAdapter.d.ts

@@ -1,6 +1,7 @@
-import { BaseSequenceAdapter, BaseOptions } from '@jbrowse/core/data_adapters/BaseAdapter';
-import { NoAssemblyRegion } from '@jbrowse/core/util/types';
-import { Feature } from '@jbrowse/core/util';
+import { BaseSequenceAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { BaseOptions } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { Feature } from '@jbrowse/core/util';
+import type { NoAssemblyRegion } from '@jbrowse/core/util/types';
 declare function parseSmallFasta(text: string): Map<string, {
     readonly description: string;
     readonly sequence: string;

package/esm/UnindexedFastaAdapter/UnindexedFastaAdapter.js

@@ -1,8 +1,8 @@
-import { BaseSequenceAdapter, } from '@jbrowse/core/data_adapters/BaseAdapter';
+import { readConfObject } from '@jbrowse/core/configuration';
+import { BaseSequenceAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import { SimpleFeature } from '@jbrowse/core/util';
 import { openLocation } from '@jbrowse/core/util/io';
 import { ObservableCreate } from '@jbrowse/core/util/rxjs';
-import { SimpleFeature } from '@jbrowse/core/util';
-import { readConfObject } from '@jbrowse/core/configuration';
 function parseSmallFasta(text) {
     return new Map(text
         .split('>')
@@ -80,5 +80,5 @@ export default class UnindexedFastaAdapter extends BaseSequenceAdapter {
             observer.complete();
         });
     }
-    freeResources( /* { region } */) { }
+    freeResources() { }
 }

package/esm/UnindexedFastaAdapter/configSchema.d.ts

@@ -4,9 +4,6 @@ declare const UnindexedFastaAdapter: import("@jbrowse/core/configuration/configu
         defaultValue: string;
         contextVariable: string[];
     };
-    /**
-     * #slot
-     */
     fastaLocation: {
         type: string;
         defaultValue: {
@@ -14,9 +11,6 @@ declare const UnindexedFastaAdapter: import("@jbrowse/core/configuration/configu
             locationType: string;
         };
     };
-    /**
-     * #slot
-     */
     metadataLocation: {
         description: string;
         type: string;

package/esm/UnindexedFastaAdapter/configSchema.js

@@ -1,17 +1,11 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
-/**
- * #config UnindexedFastaAdapter
- */
-function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+function x() { }
 const UnindexedFastaAdapter = ConfigurationSchema('UnindexedFastaAdapter', {
     rewriteRefNames: {
         type: 'string',
         defaultValue: '',
         contextVariable: ['refName'],
     },
-    /**
-     * #slot
-     */
     fastaLocation: {
         type: 'fileLocation',
         defaultValue: {
@@ -19,9 +13,6 @@ const UnindexedFastaAdapter = ConfigurationSchema('UnindexedFastaAdapter', {
             locationType: 'UriLocation',
         },
     },
-    /**
-     * #slot
-     */
     metadataLocation: {
         description: 'Optional metadata file',
         type: 'fileLocation',

package/esm/UnindexedFastaAdapter/index.d.ts

@@ -1,2 +1,2 @@
-import PluginManager from '@jbrowse/core/PluginManager';
+import type PluginManager from '@jbrowse/core/PluginManager';
 export default function UnindexedFastaAdapterF(pluginManager: PluginManager): void;

package/esm/UnindexedFastaAdapter/index.js

@@ -1,13 +1,15 @@
 import AdapterType from '@jbrowse/core/pluggableElementTypes/AdapterType';
 import configSchema from './configSchema';
 export default function UnindexedFastaAdapterF(pluginManager) {
-    pluginManager.addAdapterType(() => new AdapterType({
-        name: 'UnindexedFastaAdapter',
-        displayName: 'Unindexed FASTA adapter',
-        configSchema,
-        adapterMetadata: {
-            hiddenFromGUI: true,
-        },
-        getAdapterClass: () => import('./UnindexedFastaAdapter').then(r => r.default),
-    }));
+    pluginManager.addAdapterType(() => {
+        return new AdapterType({
+            name: 'UnindexedFastaAdapter',
+            displayName: 'Unindexed FASTA adapter',
+            configSchema,
+            adapterMetadata: {
+                hiddenFromGUI: true,
+            },
+            getAdapterClass: () => import('./UnindexedFastaAdapter').then(r => r.default),
+        });
+    });
 }

package/esm/createExtensionPoints.d.ts

@@ -1,2 +1,2 @@
-import PluginManager from '@jbrowse/core/PluginManager';
+import type PluginManager from '@jbrowse/core/PluginManager';
 export default function ExtensionPointsF(pluginManager: PluginManager): void;

package/esm/createExtensionPoints.js

@@ -1,4 +1,4 @@
-import { makeIndex, getFileName, } from '@jbrowse/core/util/tracks';
+import { getFileName, makeIndex } from '@jbrowse/core/util/tracks';
 export default function ExtensionPointsF(pluginManager) {
     pluginManager.addToExtensionPoint('Core-guessAdapterForLocation', (adapterGuesser) => {
         return (file, index, adapterHint) => {

package/esm/index.d.ts

@@ -1,5 +1,5 @@
 import Plugin from '@jbrowse/core/Plugin';
-import PluginManager from '@jbrowse/core/PluginManager';
+import type PluginManager from '@jbrowse/core/PluginManager';
 export default class SequencePlugin extends Plugin {
     name: string;
     install(pluginManager: PluginManager): void;

package/esm/index.js

@@ -1,13 +1,13 @@
 import Plugin from '@jbrowse/core/Plugin';
-import TwoBitAdapterF from './TwoBitAdapter';
-import DivSequenceRendererF from './DivSequenceRenderer';
 import BgzipFastaAdapterF from './BgzipFastaAdapter';
 import ChromSizesAdapterF from './ChromSizesAdapter';
+import DivSequenceRendererF from './DivSequenceRenderer';
 import IndexedFastaAdapterF from './IndexedFastaAdapter';
-import UnindexedFastaAdapterF from './UnindexedFastaAdapter';
-import SequenceSearchAdapterF from './SequenceSearchAdapter';
-import ReferenceSequenceTrackF from './ReferenceSequenceTrack';
 import LinearReferenceSequenceDisplayF from './LinearReferenceSequenceDisplay';
+import ReferenceSequenceTrackF from './ReferenceSequenceTrack';
+import SequenceSearchAdapterF from './SequenceSearchAdapter';
+import TwoBitAdapterF from './TwoBitAdapter';
+import UnindexedFastaAdapterF from './UnindexedFastaAdapter';
 import createExtensionPoints from './createExtensionPoints';
 export default class SequencePlugin extends Plugin {
     constructor() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jbrowse/plugin-sequence",
-  "version": "2.17.0",
+  "version": "3.0.0",
   "description": "JBrowse 2 sequence adapters, tracks, etc.",
   "keywords": [
     "jbrowse",
@@ -37,8 +37,8 @@
   },
   "dependencies": {
     "@gmod/abortable-promise-cache": "^2.0.0",
-    "@gmod/indexedfasta": "^2.0.2",
-    "@gmod/twobit": "^3.0.1"
+    "@gmod/indexedfasta": "^3.0.0",
+    "@gmod/twobit": "^4.0.1"
   },
   "peerDependencies": {
     "@jbrowse/core": "^2.0.0",
@@ -57,5 +57,5 @@
   "distModule": "esm/index.js",
   "srcModule": "src/index.ts",
   "module": "esm/index.js",
-  "gitHead": "eed30b5e671f8f7823652d7cecc51aa89226de46"
+  "gitHead": "2c6897f1fa732b1db5b094d1dca197e333e95319"
 }