@jbrowse/core 2.17.0 → 3.0.0

package/data_adapters/BaseAdapter/BaseFeatureDataAdapter.d.ts

@@ -1,129 +1,20 @@
-import { Observable } from 'rxjs';
 import { BaseAdapter } from './BaseAdapter';
-import { BaseOptions } from './BaseOptions';
-import { FeatureDensityStats } from './types';
-import { Feature } from '../../util/simpleFeature';
-import { AugmentedRegion as Region } from '../../util/types';
-/**
- * Base class for feature adapters to extend. Defines some methods that
- * subclasses must implement.
- */
+import type { BaseOptions } from './BaseOptions';
+import type { FeatureDensityStats } from './types';
+import type { Feature } from '../../util/simpleFeature';
+import type { AugmentedRegion as Region } from '../../util/types';
+import type { Observable } from 'rxjs';
 export declare abstract class BaseFeatureDataAdapter extends BaseAdapter {
-    /**
-     * Get all reference sequence names used in the data source
-     * Example:
-     * public async getRefNames(opts?: BaseOptions): Promise\<string[]\> \}
-     *   await this.setup()
-     *   const \{ refNames \} = this.metadata
-     *   return refNames
-     * \}
-     *
-     *
-     * NOTE: If an adapter is unable to determine the reference sequence names,
-     * the array will be empty
-     * @param opts - Feature adapter options
-     */
     abstract getRefNames(opts?: BaseOptions): Promise<string[]>;
-    /**
-     * Get features from the data source that overlap a region
-     * Example:
-     * public getFeatures(
-     *   region: Region,
-     *   opts: BaseOptions,
-     * ): Observable<Feature> \{
-     *   return ObservableCreate(observer =\> \{
-     *     const records = getRecords(assembly, refName, start, end)
-     *     records.forEach(record =\> \{
-     *       observer.next(this.recordToFeature(record))
-     *     \})
-     *     observer.complete()
-     *   \})
-     * \}
-     * @param region - Region
-     * @param opts - Feature adapter options
-     * @returns Observable of Feature objects in the region
-     */
     abstract getFeatures(region: Region, opts?: BaseOptions): Observable<Feature>;
-    /**
-     * Return "header info" that is fetched from the data file, or other info
-     * that would not simply be in the config of the file. The return value can
-     * be `{tag:string, data: any}[]` e.g. list of tags with their values which
-     * is how VCF,BAM,CRAM return values for getInfo or it can be a nested JSON
-     * object
-     */
     getHeader(_opts?: BaseOptions): Promise<unknown>;
-    /**
-     * Return info that is primarily used for interpreting the data that is there,
-     * primarily in reference to being used for augmenting feature details panels
-     */
     getMetadata(_opts?: BaseOptions): Promise<unknown>;
-    /**
-     * Checks if the store has data for the given assembly and reference
-     * sequence, and then gets the features in the region if it does.
-     */
     getFeaturesInRegion(region: Region, opts?: BaseOptions): Observable<Feature>;
-    /**
-     * Checks if the store has data for the given assembly and reference
-     * sequence, and then gets the features in the region if it does.
-     *
-     * Currently this just calls getFeatureInRegion for each region. Adapters that
-     * are frequently called on multiple regions simultaneously may want to
-     * implement a more efficient custom version of this method.
-     *
-     * Currently this just calls getFeatureInRegion for each region. Adapters that
-     * are frequently called on multiple regions simultaneously may want to
-     * implement a more efficient custom version of this method.
-     *
-     * @param regions - Regions
-     * @param opts - Feature adapter options
-     * @returns Observable of Feature objects in the regions
-     */
     getFeaturesInMultipleRegions(regions: Region[], opts?: BaseOptions): Observable<Feature>;
-    /**
-     * Check if the store has data for the given reference name.
-     * @param refName - Name of the reference sequence
-     * @returns Whether data source has data for the given reference name
-     */
     hasDataForRefName(refName: string, opts?: BaseOptions): Promise<boolean>;
-    /**
-     * Calculates the minimum score, maximum score, and other statistics from
-     * features over a region, primarily used for quantitative tracks
-     */
     getRegionQuantitativeStats(region: Region, opts?: BaseOptions): Promise<import("../../util/stats").QuantitativeStats>;
-    /**
-     * Calculates the minimum score, maximum score, and other statistics from
-     * features over multiple regions, primarily used for quantitative tracks
-     */
     getMultiRegionQuantitativeStats(regions?: Region[], opts?: BaseOptions): Promise<import("../../util/stats").QuantitativeStats>;
-    /**
-     * Calculates the "feature density" of a region. The primary purpose of this
-     * API is to alert the user if they are going to be downloading too much
-     * information, and give them a hint to zoom in to see more. The default
-     * implementation samples from the regions, downloads feature data with
-     * getFeatures, and returns an object with the form \{featureDensity:number\}
-     *
-     * Derived classes can override this to return alternative calculations for
-     * featureDensity, or they can also return an object containing a byte size
-     * calculation with the format \{bytes:number, fetchSizeLimit:number\} where
-     * fetchSizeLimit is the adapter-defined limit for what it thinks is 'too
-     * much data' (e.g. CRAM and BAM may vary on what they think too much data
-     * is)
-     */
     getRegionFeatureDensityStats(region: Region, opts?: BaseOptions): Promise<FeatureDensityStats>;
-    /**
-     * Calculates the "feature density" of a set of regions. The primary purpose
-     * of this API is to alert the user if they are going to be downloading too
-     * much information, and give them a hint to zoom in to see more. The default
-     * implementation samples from the regions, downloads feature data with
-     * getFeatures, and returns an object with the form \{featureDensity:number\}
-     *
-     * Derived classes can override this to return alternative calculations for
-     * featureDensity, or they can also return an object containing a byte size
-     * calculation with the format \{bytes:number, fetchSizeLimit:number\} where
-     * fetchSizeLimit is the adapter-defined limit for what it thinks is 'too
-     * much data' (e.g. CRAM and BAM may vary on what they think too much data
-     * is)
-     */
     getMultiRegionFeatureDensityStats(regions: Region[], opts?: BaseOptions): Promise<FeatureDensityStats>;
     getSources(regions: Region[]): Promise<{
         name: string;

package/data_adapters/BaseAdapter/BaseFeatureDataAdapter.js

@@ -3,41 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseFeatureDataAdapter = void 0;
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
-// locals
 const BaseAdapter_1 = require("./BaseAdapter");
-const rxjs_2 = require("../../util/rxjs");
 const util_1 = require("../../util");
+const rxjs_2 = require("../../util/rxjs");
 const stats_1 = require("../../util/stats");
-/**
- * Base class for feature adapters to extend. Defines some methods that
- * subclasses must implement.
- */
+const stopToken_1 = require("../../util/stopToken");
 class BaseFeatureDataAdapter extends BaseAdapter_1.BaseAdapter {
-    /**
-     * Return "header info" that is fetched from the data file, or other info
-     * that would not simply be in the config of the file. The return value can
-     * be `{tag:string, data: any}[]` e.g. list of tags with their values which
-     * is how VCF,BAM,CRAM return values for getInfo or it can be a nested JSON
-     * object
-     */
     async getHeader(_opts) {
         return null;
     }
-    /**
-     * Return info that is primarily used for interpreting the data that is there,
-     * primarily in reference to being used for augmenting feature details panels
-     */
     async getMetadata(_opts) {
         return null;
     }
-    /**
-     * Checks if the store has data for the given assembly and reference
-     * sequence, and then gets the features in the region if it does.
-     */
     getFeaturesInRegion(region, opts = {}) {
         return (0, rxjs_2.ObservableCreate)(async (observer) => {
             const hasData = await this.hasDataForRefName(region.refName, opts);
-            (0, util_1.checkAbortSignal)(opts.signal);
+            (0, stopToken_1.checkStopToken)(opts.stopToken);
             if (!hasData) {
                 observer.complete();
             }
@@ -46,46 +27,17 @@ class BaseFeatureDataAdapter extends BaseAdapter_1.BaseAdapter {
             }
         });
     }
-    /**
-     * Checks if the store has data for the given assembly and reference
-     * sequence, and then gets the features in the region if it does.
-     *
-     * Currently this just calls getFeatureInRegion for each region. Adapters that
-     * are frequently called on multiple regions simultaneously may want to
-     * implement a more efficient custom version of this method.
-     *
-     * Currently this just calls getFeatureInRegion for each region. Adapters that
-     * are frequently called on multiple regions simultaneously may want to
-     * implement a more efficient custom version of this method.
-     *
-     * @param regions - Regions
-     * @param opts - Feature adapter options
-     * @returns Observable of Feature objects in the regions
-     */
     getFeaturesInMultipleRegions(regions, opts = {}) {
         return (0, rxjs_1.merge)(...regions.map(region => this.getFeaturesInRegion(region, opts)));
     }
-    /**
-     * Check if the store has data for the given reference name.
-     * @param refName - Name of the reference sequence
-     * @returns Whether data source has data for the given reference name
-     */
     async hasDataForRefName(refName, opts = {}) {
         const refNames = await this.getRefNames(opts);
         return refNames.includes(refName);
     }
-    /**
-     * Calculates the minimum score, maximum score, and other statistics from
-     * features over a region, primarily used for quantitative tracks
-     */
     async getRegionQuantitativeStats(region, opts) {
         const feats = this.getFeatures(region, opts);
         return (0, stats_1.scoresToStats)(region, feats);
     }
-    /**
-     * Calculates the minimum score, maximum score, and other statistics from
-     * features over multiple regions, primarily used for quantitative tracks
-     */
     async getMultiRegionQuantitativeStats(regions = [], opts) {
         if (!regions.length) {
             return (0, stats_1.blankStats)();
@@ -106,20 +58,6 @@ class BaseFeatureDataAdapter extends BaseAdapter_1.BaseAdapter {
             scoreSum,
         });
     }
-    /**
-     * Calculates the "feature density" of a region. The primary purpose of this
-     * API is to alert the user if they are going to be downloading too much
-     * information, and give them a hint to zoom in to see more. The default
-     * implementation samples from the regions, downloads feature data with
-     * getFeatures, and returns an object with the form \{featureDensity:number\}
-     *
-     * Derived classes can override this to return alternative calculations for
-     * featureDensity, or they can also return an object containing a byte size
-     * calculation with the format \{bytes:number, fetchSizeLimit:number\} where
-     * fetchSizeLimit is the adapter-defined limit for what it thinks is 'too
-     * much data' (e.g. CRAM and BAM may vary on what they think too much data
-     * is)
-     */
     getRegionFeatureDensityStats(region, opts) {
         let lastTime = +Date.now();
         const statsFromInterval = async (length, expansionTime) => {
@@ -150,20 +88,6 @@ class BaseFeatureDataAdapter extends BaseAdapter_1.BaseAdapter {
         };
         return statsFromInterval(1000, 0);
     }
-    /**
-     * Calculates the "feature density" of a set of regions. The primary purpose
-     * of this API is to alert the user if they are going to be downloading too
-     * much information, and give them a hint to zoom in to see more. The default
-     * implementation samples from the regions, downloads feature data with
-     * getFeatures, and returns an object with the form \{featureDensity:number\}
-     *
-     * Derived classes can override this to return alternative calculations for
-     * featureDensity, or they can also return an object containing a byte size
-     * calculation with the format \{bytes:number, fetchSizeLimit:number\} where
-     * fetchSizeLimit is the adapter-defined limit for what it thinks is 'too
-     * much data' (e.g. CRAM and BAM may vary on what they think too much data
-     * is)
-     */
     async getMultiRegionFeatureDensityStats(regions, opts) {
         if (!regions.length) {
             throw new Error('No regions supplied');

package/data_adapters/BaseAdapter/BaseOptions.d.ts

@@ -1,5 +1,5 @@
 export interface BaseOptions {
-    signal?: AbortSignal;
+    stopToken?: string;
     bpPerPx?: number;
     sessionId?: string;
     statusCallback?: (message: string) => void;
@@ -10,7 +10,7 @@ export type SearchType = 'full' | 'prefix' | 'exact';
 export interface BaseTextSearchArgs {
     queryString: string;
     searchType?: SearchType;
-    signal?: AbortSignal;
+    stopToken?: string;
     limit?: number;
     pageNumber?: number;
 }

package/data_adapters/BaseAdapter/BaseRefNameAliasAdapter.d.ts

@@ -1,5 +1,5 @@
-import { BaseAdapter } from './BaseAdapter';
-import { BaseOptions } from './types';
+import type { BaseAdapter } from './BaseAdapter';
+import type { BaseOptions } from './types';
 export interface Alias {
     refName: string;
     aliases: string[];

package/data_adapters/BaseAdapter/BaseSequenceAdapter.d.ts

@@ -1,13 +1,10 @@
-import { NoAssemblyRegion } from '../../util';
-import { BaseOptions } from './types';
-import { RegionsAdapter } from '../BaseAdapter';
 import { BaseFeatureDataAdapter } from './BaseFeatureDataAdapter';
+import type { BaseOptions } from './types';
+import type { NoAssemblyRegion } from '../../util';
+import type { RegionsAdapter } from '../BaseAdapter';
 export declare abstract class BaseSequenceAdapter extends BaseFeatureDataAdapter implements RegionsAdapter {
     getMultiRegionFeatureDensityStats(): Promise<{
         featureDensity: number;
     }>;
-    /**
-     * Fetches a list of 'regions' with refName, start, and extends
-     */
     abstract getRegions(opts: BaseOptions): Promise<NoAssemblyRegion[]>;
 }

package/data_adapters/BaseAdapter/BaseTextSearchAdapter.d.ts

@@ -1,6 +1,6 @@
-import BaseResult from '../../TextSearch/BaseResults';
-import { BaseTextSearchArgs } from './types';
-import { BaseAdapter } from './BaseAdapter';
+import type { BaseAdapter } from './BaseAdapter';
+import type { BaseTextSearchArgs } from './types';
+import type BaseResult from '../../TextSearch/BaseResults';
 export interface BaseTextSearchAdapter extends BaseAdapter {
     searchIndex(args: BaseTextSearchArgs): Promise<BaseResult[]>;
 }

package/data_adapters/BaseAdapter/RegionsAdapter.d.ts

@@ -1,6 +1,6 @@
-import { NoAssemblyRegion } from '../../util';
-import { BaseAdapter } from './BaseAdapter';
-import { BaseOptions } from './types';
+import type { BaseAdapter } from './BaseAdapter';
+import type { BaseOptions } from './types';
+import type { NoAssemblyRegion } from '../../util';
 export interface RegionsAdapter extends BaseAdapter {
     getRegions(opts: BaseOptions): Promise<NoAssemblyRegion[]>;
 }

package/data_adapters/BaseAdapter/index.d.ts

@@ -1,7 +1,7 @@
-import { AnyConfigurationModel } from '../../configuration';
-import PluginManager from '../../PluginManager';
-import { getSubAdapterType } from '../dataAdapterCache';
-import { AnyDataAdapter } from './util';
+import type PluginManager from '../../PluginManager';
+import type { AnyConfigurationModel } from '../../configuration';
+import type { getSubAdapterType } from '../dataAdapterCache';
+import type { AnyDataAdapter } from './util';
 export * from './util';
 export * from './types';
 export { BaseAdapter } from './BaseAdapter';

package/data_adapters/BaseAdapter/types.d.ts

@@ -1,5 +1,5 @@
 export interface BaseOptions {
-    signal?: AbortSignal;
+    stopToken?: string;
     bpPerPx?: number;
     sessionId?: string;
     statusCallback?: (message: string) => void;
@@ -10,7 +10,7 @@ export type SearchType = 'full' | 'prefix' | 'exact';
 export interface BaseTextSearchArgs {
     queryString: string;
     searchType?: SearchType;
-    signal?: AbortSignal;
+    stopToken?: string;
     limit?: number;
     pageNumber?: number;
 }

package/data_adapters/BaseAdapter/util.d.ts

@@ -1,9 +1,9 @@
-import { BaseAdapter } from './BaseAdapter';
-import { BaseFeatureDataAdapter } from './BaseFeatureDataAdapter';
-import { BaseRefNameAliasAdapter } from './BaseRefNameAliasAdapter';
-import { BaseSequenceAdapter } from './BaseSequenceAdapter';
-import { BaseTextSearchAdapter } from './BaseTextSearchAdapter';
-import { RegionsAdapter } from './RegionsAdapter';
+import type { BaseAdapter } from './BaseAdapter';
+import type { BaseFeatureDataAdapter } from './BaseFeatureDataAdapter';
+import type { BaseRefNameAliasAdapter } from './BaseRefNameAliasAdapter';
+import type { BaseSequenceAdapter } from './BaseSequenceAdapter';
+import type { BaseTextSearchAdapter } from './BaseTextSearchAdapter';
+import type { RegionsAdapter } from './RegionsAdapter';
 export type AnyDataAdapter = BaseAdapter | BaseFeatureDataAdapter | BaseRefNameAliasAdapter | BaseTextSearchAdapter | RegionsAdapter | BaseSequenceAdapter;
 export declare function isSequenceAdapter(t: AnyDataAdapter): t is BaseSequenceAdapter;
 export declare function isRegionsAdapter(t: AnyDataAdapter): t is RegionsAdapter;

package/data_adapters/CytobandAdapter/CytobandAdapter.d.ts

@@ -1,6 +1,6 @@
 import { SimpleFeature } from '../../util';
 import { BaseAdapter } from '../BaseAdapter';
-import { BaseOptions } from '../BaseAdapter/BaseOptions';
+import type { BaseOptions } from '../BaseAdapter/BaseOptions';
 export default class CytobandAdapter extends BaseAdapter {
     getData(opts?: BaseOptions): Promise<SimpleFeature[]>;
     freeResources(): void;

package/data_adapters/CytobandAdapter/CytobandAdapter.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// locals
 const util_1 = require("../../util");
 const io_1 = require("../../util/io");
 const BaseAdapter_1 = require("../BaseAdapter");
@@ -10,10 +9,7 @@ class CytobandAdapter extends BaseAdapter_1.BaseAdapter {
         if (conf.uri === '' || conf.uri === '/path/to/cytoband.txt.gz') {
             return [];
         }
-        const pm = this.pluginManager;
-        const buf = await (0, util_1.fetchAndMaybeUnzip)((0, io_1.openLocation)(conf, pm), opts);
-        const decoder = new TextDecoder('utf8', { fatal: true });
-        const text = decoder.decode(buf);
+        const text = await (0, util_1.fetchAndMaybeUnzipText)((0, io_1.openLocation)(conf, this.pluginManager), opts);
         return text
             .split(/\n|\r\n|\r/)
             .filter(f => !!f.trim())
@@ -30,6 +26,6 @@ class CytobandAdapter extends BaseAdapter_1.BaseAdapter {
             });
         });
     }
-    freeResources( /* { region } */) { }
+    freeResources() { }
 }
 exports.default = CytobandAdapter;

package/data_adapters/CytobandAdapter/configSchema.d.ts

@@ -1,7 +1,4 @@
 declare const configSchema: import("../../configuration/configurationSchema").ConfigurationSchemaType<{
-    /**
-     * #slot
-     */
     cytobandLocation: {
         type: string;
         defaultValue: {

package/data_adapters/CytobandAdapter/configSchema.js

@@ -1,14 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const configuration_1 = require("../../configuration");
-/**
- * #config CytobandAdapter
- */
-function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+function x() { }
 const configSchema = (0, configuration_1.ConfigurationSchema)('CytobandAdapter', {
-    /**
-     * #slot
-     */
     cytobandLocation: {
         type: 'fileLocation',
         defaultValue: { uri: '/path/to/cytoband.txt.gz' },

package/data_adapters/CytobandAdapter/index.d.ts

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

package/data_adapters/CytobandAdapter/index.js

@@ -15,24 +15,37 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = CytobandAdapterF;
-const pluggableElementTypes_1 = require("../../pluggableElementTypes");
 const configSchema_1 = __importDefault(require("./configSchema"));
+const pluggableElementTypes_1 = require("../../pluggableElementTypes");
 function CytobandAdapterF(pluginManager) {
     pluginManager.addAdapterType(() => new pluggableElementTypes_1.AdapterType({
         name: 'CytobandAdapter',
         configSchema: configSchema_1.default,
+        adapterMetadata: {
+            hiddenFromGUI: true,
+        },
         getAdapterClass: () => Promise.resolve().then(() => __importStar(require('./CytobandAdapter'))).then(f => f.default),
     }));
 }

package/data_adapters/dataAdapterCache.d.ts

@@ -1,31 +1,13 @@
-import { SnapshotIn } from 'mobx-state-tree';
-import PluginManager from '../PluginManager';
-import { AnyConfigurationSchemaType } from '../configuration';
-import { AnyDataAdapter } from './BaseAdapter';
+import type PluginManager from '../PluginManager';
+import type { AnyConfigurationSchemaType } from '../configuration';
+import type { AnyDataAdapter } from './BaseAdapter';
+import type { SnapshotIn } from 'mobx-state-tree';
 type ConfigSnap = SnapshotIn<AnyConfigurationSchemaType>;
-export declare function adapterConfigCacheKey(conf?: Record<string, unknown>): string;
 interface AdapterCacheEntry {
     dataAdapter: AnyDataAdapter;
     sessionIds: Set<string>;
 }
-/**
- * instantiate a data adapter, or return an already-instantiated one if we have
- * one with the same configuration
- *
- * @param pluginManager
- *
- * @param sessionId - session ID of the associated worker session. used for
- * reference counting
- *
- * @param adapterConfigSnapshot - plain-JS configuration snapshot for the
- * adapter
- */
 export declare function getAdapter(pluginManager: PluginManager, sessionId: string, adapterConfigSnapshot: SnapshotIn<AnyConfigurationSchemaType>): Promise<AdapterCacheEntry>;
-/**
- * this is a callback that is passed to adapters that
- * allows them to get any sub-adapters that they need
- * internally, staying with the same worker session ID
- */
 export type getSubAdapterType = (adapterConfigSnap: ConfigSnap) => ReturnType<typeof getAdapter>;
 export declare function freeAdapterResources(specification: Record<string, any>): number;
 export declare function clearAdapterCache(): void;

package/data_adapters/dataAdapterCache.js

@@ -1,32 +1,12 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adapterConfigCacheKey = adapterConfigCacheKey;
 exports.getAdapter = getAdapter;
 exports.freeAdapterResources = freeAdapterResources;
 exports.clearAdapterCache = clearAdapterCache;
-const idMaker_1 = __importDefault(require("../util/idMaker"));
-function adapterConfigCacheKey(conf = {}) {
-    return `${(0, idMaker_1.default)(conf)}`;
-}
+const util_1 = require("./util");
 let adapterCache = {};
-/**
- * instantiate a data adapter, or return an already-instantiated one if we have
- * one with the same configuration
- *
- * @param pluginManager
- *
- * @param sessionId - session ID of the associated worker session. used for
- * reference counting
- *
- * @param adapterConfigSnapshot - plain-JS configuration snapshot for the
- * adapter
- */
 async function getAdapter(pluginManager, sessionId, adapterConfigSnapshot) {
-    // cache the adapter object
-    const cacheKey = adapterConfigCacheKey(adapterConfigSnapshot);
+    const cacheKey = (0, util_1.adapterConfigCacheKey)(adapterConfigSnapshot);
     if (!adapterCache[cacheKey]) {
         const adapterType = adapterConfigSnapshot === null || adapterConfigSnapshot === void 0 ? void 0 : adapterConfigSnapshot.type;
         if (!adapterType) {
@@ -36,13 +16,10 @@ async function getAdapter(pluginManager, sessionId, adapterConfigSnapshot) {
         if (!dataAdapterType) {
             throw new Error(`unknown data adapter type ${adapterType}`);
         }
-        // instantiate the data adapter's config schema so it gets its defaults,
-        // callbacks, etc
         const adapterConfig = dataAdapterType.configSchema.create(adapterConfigSnapshot, { pluginManager });
         const getSubAdapter = getAdapter.bind(null, pluginManager, sessionId);
         const CLASS = await dataAdapterType.getAdapterClass();
         const dataAdapter = new CLASS(adapterConfig, getSubAdapter, pluginManager);
-        // store it in our cache
         adapterCache[cacheKey] = {
             dataAdapter,
             sessionIds: new Set([sessionId]),
@@ -55,8 +32,6 @@ async function getAdapter(pluginManager, sessionId, adapterConfigSnapshot) {
 function freeAdapterResources(specification) {
     let deleteCount = 0;
     const specKeys = Object.keys(specification);
-    // if we don't specify a range, delete any adapters that are only associated
-    // with that session
     if (specKeys.length === 1 && specKeys[0] === 'sessionId') {
         const { sessionId } = specification;
         Object.entries(adapterCache).forEach(([cacheKey, cacheEntry]) => {
@@ -68,7 +43,6 @@ function freeAdapterResources(specification) {
         });
     }
     else {
-        // otherwise call freeResources on all the cached data adapters
         Object.values(adapterCache).forEach(cacheEntry => {
             const regions = specification.regions ||
                 (specification.region ? [specification.region] : []);

package/data_adapters/util.d.ts

@@ -0,0 +1 @@
+export declare function adapterConfigCacheKey(conf?: Record<string, unknown>): string;

package/data_adapters/util.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adapterConfigCacheKey = adapterConfigCacheKey;
+const idMaker_1 = __importDefault(require("../util/idMaker"));
+function adapterConfigCacheKey(conf = {}) {
+    return `${(0, idMaker_1.default)(conf)}`;
+}