@jbrowse/plugin-data-management 2.8.0 → 2.10.0

package/esm/ucsc-trackhub/doConnect.js

@@ -0,0 +1,127 @@
+import { HubFile, SingleFileHub } from '@gmod/ucsc-hub';
+import { generateTracks, fetchGenomesFile, fetchTrackDbFile, } from './ucscTrackHub';
+import { getConf } from '@jbrowse/core/configuration';
+import { getSession } from '@jbrowse/core/util';
+import { openLocation } from '@jbrowse/core/util/io';
+import { nanoid } from '@jbrowse/core/util/nanoid';
+function resolve(uri, baseUri) {
+    return new URL(uri, baseUri).href;
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export async function doConnect(self) {
+    var _a;
+    const session = getSession(self);
+    const notLoadedAssemblies = [];
+    try {
+        const hubFileLocation = getConf(self, 'hubTxtLocation');
+        const hubFileText = await openLocation(hubFileLocation).readFile('utf8');
+        // @ts-expect-error
+        const hubUri = resolve(hubFileLocation.uri, hubFileLocation.baseUri);
+        const { assemblyManager } = session;
+        if (hubFileText.includes('useOneFile on')) {
+            const hub = new SingleFileHub(hubFileText);
+            const { genome, tracks } = hub;
+            const genomeName = genome.name;
+            const asm = assemblyManager.get(genomeName);
+            if (!asm) {
+                // @ts-expect-error
+                session.addSessionAssembly({
+                    name: genomeName,
+                    sequence: {
+                        type: 'ReferenceSequenceTrack',
+                        trackId: `${genomeName}-${nanoid()}`,
+                        adapter: {
+                            type: 'TwoBitAdapter',
+                            twoBitLocation: {
+                                uri: resolve(genome.data.twoBitPath, hubUri),
+                            },
+                            chromSizesLocation: {
+                                uri: resolve(genome.data.chromSizes, hubUri),
+                            },
+                        },
+                    },
+                });
+            }
+            const asm2 = assemblyManager.get(genomeName);
+            const sequenceAdapter = getConf(asm2, ['sequence', 'adapter']);
+            const tracksNew = generateTracks({
+                trackDb: tracks,
+                trackDbLoc: hubFileLocation,
+                assemblyName: genomeName,
+                sequenceAdapter,
+            });
+            self.addTrackConfs(tracksNew);
+        }
+        else {
+            const hubFile = new HubFile(hubFileText);
+            const genomeFile = hubFile.data.genomesFile;
+            if (!genomeFile) {
+                throw new Error('genomesFile not found on hub');
+            }
+            // @ts-expect-error
+            const hubUri = resolve(hubFileLocation.uri, hubFileLocation.baseUri);
+            const genomesFileLocation = hubUri
+                ? {
+                    uri: resolve(genomeFile, hubUri),
+                    locationType: 'UriLocation',
+                }
+                : {
+                    localPath: genomeFile,
+                    locationType: 'LocalPathLocation',
+                };
+            const genomesFile = await fetchGenomesFile(genomesFileLocation);
+            const map = {};
+            for (const [genomeName, genome] of Object.entries(genomesFile.data)) {
+                const assemblyNames = getConf(self, 'assemblyNames');
+                if (assemblyNames.length > 0 && !assemblyNames.includes(genomeName)) {
+                    continue;
+                }
+                const asm = assemblyManager.get(genomeName);
+                if (!asm) {
+                    notLoadedAssemblies.push(genomeName);
+                    continue;
+                }
+                // @ts-expect-error
+                const db = genome.data.trackDb;
+                if (!db) {
+                    throw new Error('genomesFile not found on hub');
+                }
+                const base = new URL(genomeFile, hubUri);
+                const loc = hubUri
+                    ? {
+                        uri: new URL(db, base).href,
+                        locationType: 'UriLocation',
+                    }
+                    : {
+                        localPath: db,
+                        locationType: 'LocalPathLocation',
+                    };
+                const trackDb = await fetchTrackDbFile(loc);
+                const sequenceAdapter = getConf(asm, ['sequence', 'adapter']);
+                const tracks = generateTracks({
+                    trackDb,
+                    trackDbLoc: loc,
+                    assemblyName: genomeName,
+                    sequenceAdapter,
+                });
+                self.addTrackConfs(tracks);
+                map[genomeName] = tracks.length;
+            }
+            const loadedAssemblies = Object.entries(map);
+            const str1 = loadedAssemblies.length
+                ? `Loaded data from these assemblies: ${loadedAssemblies
+                    .map(([key, val]) => `${key} (${val} tracks)`)
+                    .join(', ')}`
+                : '';
+            const str2 = notLoadedAssemblies.length
+                ? `Skipped data from these assemblies: ${notLoadedAssemblies.join(', ')}`
+                : '';
+            session.notify([str1, str2].filter(f => !!f).join('. '), 'success');
+        }
+    }
+    catch (e) {
+        console.error(e);
+        session.notify(`${getConf(self, 'name')}: "${e}"`, 'error');
+        (_a = session.breakConnection) === null || _a === void 0 ? void 0 : _a.call(session, self.configuration);
+    }
+}

package/esm/ucsc-trackhub/model.d.ts

@@ -1,4 +1,8 @@
 import PluginManager from '@jbrowse/core/PluginManager';
+/**
+ * #stateModel UCSCTrackHubConnection
+ * extends BaseConnectionModel
+ */
 export default function UCSCTrackHubConnection(pluginManager: PluginManager): import("mobx-state-tree").IModelType<{
     name: import("mobx-state-tree").ISimpleType<string>;
     tracks: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>;
@@ -10,11 +14,16 @@ export default function UCSCTrackHubConnection(pluginManager: PluginManager): im
         };
         assemblyNames: {
             type: string;
-            defaultValue: never[];
+            defaultValue: never[]; /**
+             * #action
+             */
             description: string;
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "connectionId">>;
 } & {
+    /**
+     * #property
+     */
     configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         hubTxtLocation: {
             type: string;
@@ -25,7 +34,9 @@ export default function UCSCTrackHubConnection(pluginManager: PluginManager): im
             description: string;
         };
         assemblyNames: {
-            type: string;
+            type: string; /**
+             * #property
+             */
             defaultValue: never[];
             description: string;
         };
@@ -41,6 +52,9 @@ export default function UCSCTrackHubConnection(pluginManager: PluginManager): im
             description: string;
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "connectionId">>, undefined>>;
+    /**
+     * #property
+     */
     type: import("mobx-state-tree").ISimpleType<"UCSCTrackHubConnection">;
 }, {
     connect(_arg: {
@@ -67,5 +81,8 @@ export default function UCSCTrackHubConnection(pluginManager: PluginManager): im
     } & import("mobx-state-tree").IStateTreeNode<import("@jbrowse/core/configuration").AnyConfigurationSchemaType>)[]): 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>>;
     clear(): void;
 } & {
+    /**
+     * #action
+     */
     connect(): Promise<void>;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;

package/esm/ucsc-trackhub/model.js

@@ -1,87 +1,32 @@
 import { BaseConnectionModelFactory } from '@jbrowse/core/pluggableElementTypes/models';
-import { ConfigurationReference, readConfObject, getConf, } from '@jbrowse/core/configuration';
-import { getSession } from '@jbrowse/core/util';
+import { ConfigurationReference } from '@jbrowse/core/configuration';
 import { types } from 'mobx-state-tree';
 // locals
 import configSchema from './configSchema';
+/**
+ * #stateModel UCSCTrackHubConnection
+ * extends BaseConnectionModel
+ */
 export default function UCSCTrackHubConnection(pluginManager) {
     return types
         .compose('UCSCTrackHubConnection', BaseConnectionModelFactory(pluginManager), types.model({
+        /**
+         * #property
+         */
         configuration: ConfigurationReference(configSchema),
+        /**
+         * #property
+         */
         type: types.literal('UCSCTrackHubConnection'),
     }))
         .actions(self => ({
+        /**
+         * #action
+         */
         async connect() {
-            var _a, _b;
-            const session = getSession(self);
-            const notLoadedAssemblies = [];
-            try {
-                const hubFileLocation = getConf(self, 'hubTxtLocation');
-                const { generateTracks, fetchGenomesFile, fetchTrackDbFile, fetchHubFile, } = await import('./ucscTrackHub');
-                const hubFile = await fetchHubFile(hubFileLocation);
-                const genomeFile = hubFile.get('genomesFile');
-                if (!genomeFile) {
-                    throw new Error('genomesFile not found on hub');
-                }
-                const hubUri = new URL(hubFileLocation.uri, hubFileLocation.baseUri);
-                const genomesFileLocation = hubUri
-                    ? {
-                        uri: new URL(genomeFile, hubUri).href,
-                        locationType: 'UriLocation',
-                    }
-                    : {
-                        localPath: genomeFile,
-                        locationType: 'LocalPathLocation',
-                    };
-                const genomesFile = await fetchGenomesFile(genomesFileLocation);
-                const map = {};
-                for (const [genomeName, genome] of genomesFile) {
-                    const assemblyNames = getConf(self, 'assemblyNames');
-                    if (assemblyNames.length > 0 &&
-                        !assemblyNames.includes(genomeName)) {
-                        continue;
-                    }
-                    const conf = (_a = session.assemblyManager.get(genomeName)) === null || _a === void 0 ? void 0 : _a.configuration;
-                    if (!conf) {
-                        notLoadedAssemblies.push(genomeName);
-                        continue;
-                    }
-                    const db = genome.get('trackDb');
-                    if (!db) {
-                        throw new Error('genomesFile not found on hub');
-                    }
-                    const base = new URL(genomeFile, hubUri);
-                    const loc = hubUri
-                        ? {
-                            uri: new URL(db, base).href,
-                            locationType: 'UriLocation',
-                        }
-                        : {
-                            localPath: db,
-                            locationType: 'LocalPathLocation',
-                        };
-                    const trackDb = await fetchTrackDbFile(loc);
-                    const seqAdapter = readConfObject(conf, ['sequence', 'adapter']);
-                    const tracks = generateTracks(trackDb, loc, genomeName, seqAdapter);
-                    self.addTrackConfs(tracks);
-                    map[genomeName] = tracks.length;
-                }
-                const loadedAssemblies = Object.entries(map);
-                const str1 = loadedAssemblies.length
-                    ? `Loaded data from these assemblies: ${loadedAssemblies
-                        .map(([key, val]) => `${key} (${val} tracks)`)
-                        .join(', ')}`
-                    : '';
-                const str2 = notLoadedAssemblies.length
-                    ? `Skipped data from these assemblies: ${notLoadedAssemblies.join(', ')}`
-                    : '';
-                session.notify([str1, str2].filter(f => !!f).join('. '), 'success');
-            }
-            catch (e) {
-                console.error(e);
-                session.notify(`There was a problem connecting to the UCSC Track Hub "${self.configuration.name}". Please make sure you have entered a valid hub.txt file. The error that was thrown is: "${e}"`, 'error');
-                (_b = session.breakConnection) === null || _b === void 0 ? void 0 : _b.call(session, self.configuration);
-            }
+            const { doConnect } = await import('./doConnect');
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            doConnect(self);
         },
     }));
 }

package/esm/ucsc-trackhub/ucscTrackHub.d.ts

@@ -1,10 +1,10 @@
-import { TrackDbFile } from '@gmod/ucsc-hub';
 import { FileLocation } from '@jbrowse/core/util';
-export declare function fetchHubFile(hubLocation: FileLocation): Promise<import("@gmod/ucsc-hub").HubFile>;
-export declare function fetchGenomesFile(genomesLoc: FileLocation): Promise<import("@gmod/ucsc-hub").GenomesFile>;
+import { GenomesFile, TrackDbFile } from '@gmod/ucsc-hub';
+export declare function fetchGenomesFile(genomesLoc: FileLocation): Promise<GenomesFile>;
 export declare function fetchTrackDbFile(trackDbLoc: FileLocation): Promise<TrackDbFile>;
 export declare function makeLoc(first: string, base: {
     uri: string;
+    baseUri?: string;
 }): {
     uri: string;
     locationType: string;
@@ -19,5 +19,162 @@ export declare function makeLoc2(first: string, alt?: string): {
     uri: string | undefined;
     locationType: string;
 };
-export declare function generateTracks(trackDb: TrackDbFile, trackDbLoc: FileLocation, assemblyName: string, sequenceAdapter: any): any;
+export declare function generateTracks({ trackDb, trackDbLoc, assemblyName, sequenceAdapter, }: {
+    trackDb: TrackDbFile;
+    trackDbLoc: FileLocation;
+    assemblyName: string;
+    sequenceAdapter: any;
+}): ({
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[] | undefined;
+} | {
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[];
+    adapter: {
+        type: string;
+        bamLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        index: {
+            location: {
+                uri: string | undefined;
+                locationType: string;
+            };
+        };
+        cramLocation?: undefined;
+        craiLocation?: undefined;
+        sequenceAdapter?: undefined;
+        bigBedLocation?: undefined;
+        bigWigLocation?: undefined;
+        vcfGzLocation?: undefined;
+        hicLocation?: undefined;
+    };
+} | {
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[];
+    adapter: {
+        type: string;
+        cramLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        craiLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        sequenceAdapter: any;
+        bamLocation?: undefined;
+        index?: undefined;
+        bigBedLocation?: undefined;
+        bigWigLocation?: undefined;
+        vcfGzLocation?: undefined;
+        hicLocation?: undefined;
+    };
+} | {
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[];
+    adapter: {
+        type: string;
+        bigBedLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        bamLocation?: undefined;
+        index?: undefined;
+        cramLocation?: undefined;
+        craiLocation?: undefined;
+        sequenceAdapter?: undefined;
+        bigWigLocation?: undefined;
+        vcfGzLocation?: undefined;
+        hicLocation?: undefined;
+    };
+} | {
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[];
+    adapter: {
+        type: string;
+        bigWigLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        bamLocation?: undefined;
+        index?: undefined;
+        cramLocation?: undefined;
+        craiLocation?: undefined;
+        sequenceAdapter?: undefined;
+        bigBedLocation?: undefined;
+        vcfGzLocation?: undefined;
+        hicLocation?: undefined;
+    };
+} | {
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[];
+    adapter: {
+        type: string;
+        vcfGzLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        index: {
+            location: {
+                uri: string | undefined;
+                locationType: string;
+            };
+        };
+        bamLocation?: undefined;
+        cramLocation?: undefined;
+        craiLocation?: undefined;
+        sequenceAdapter?: undefined;
+        bigBedLocation?: undefined;
+        bigWigLocation?: undefined;
+        hicLocation?: undefined;
+    };
+} | {
+    trackId: string;
+    assemblyNames: string[];
+    type: string;
+    name: string;
+    description: string;
+    category: string[];
+    adapter: {
+        type: string;
+        hicLocation: {
+            uri: string | undefined;
+            locationType: string;
+        };
+        bamLocation?: undefined;
+        index?: undefined;
+        cramLocation?: undefined;
+        craiLocation?: undefined;
+        sequenceAdapter?: undefined;
+        bigBedLocation?: undefined;
+        bigWigLocation?: undefined;
+        vcfGzLocation?: undefined;
+    };
+})[];
 export { default as ucscAssemblies } from './ucscAssemblies';