@jbrowse/core 4.2.1 → 5.0.0-beta.1

package/esm/pluggableElementTypes/RpcMethodType.js

@@ -1,132 +1,297 @@
-import PluggableElementBase from "./PluggableElementBase.js";
-import mapObject from "../util/map-obj/index.js";
-import { isRpcResult } from "../util/rpc.js";
-import { getBlobMap, getFileFromCache, setBlobMap } from "../util/tracks.js";
-import { RetryError, isAppRootModel, isAuthNeededException, isFileHandleLocation, isUriLocation, } from "../util/types/index.js";
-export function convertFileHandleLocations(obj, blobMap, seen = new WeakSet()) {
-    const convertLocation = (loc) => {
-        const file = getFileFromCache(loc.handleId);
-        if (!file) {
-            throw new Error(`File not in cache for handleId: ${loc.handleId}. ` +
-                `The file "${loc.name}" may need to be reopened.`);
-        }
-        const blobId = `fh-blob-${loc.handleId}`;
-        blobMap[blobId] = file;
-        return { locationType: 'BlobLocation', name: loc.name, blobId };
-    };
-    const convert = (current) => {
-        if (!current || typeof current !== 'object' || seen.has(current)) {
-            return;
-        }
-        seen.add(current);
-        if (Array.isArray(current)) {
-            for (let i = 0; i < current.length; i++) {
-                const item = current[i];
-                if (isFileHandleLocation(item)) {
-                    current[i] = convertLocation(item);
-                }
-                else {
-                    convert(item);
-                }
-            }
+import { isAlive, isStateTreeNode } from '@jbrowse/mobx-state-tree';
+import { renameRegionsIfNeeded } from '../util/index.js';
+import { resolveUriLocation } from '../util/io/index.js';
+import { unwrapRpcResult } from '../util/rpc.js';
+import { getBlobMap, getFileFromCache, hasFileHandlesInCache, setBlobMap, } from '../util/tracks.js';
+import { isAppRootModel, isFileHandleLocation, isUriLocation, } from '../util/types/index.js';
+import PluggableElementBase from './PluggableElementBase.js';
+function convertFileHandleToBlob(loc, blobMap) {
+    const file = getFileFromCache(loc.handleId);
+    if (!file) {
+        throw new Error(`File not in cache for handleId: ${loc.handleId}. ` +
+            `The file "${loc.name}" may need to be reopened.`);
+    }
+    // Deterministic blobId from handleId so the same FileHandleLocation always
+    // produces the same BlobLocation — keeps adapter config hashes stable.
+    const blobId = `fh-blob-${loc.handleId}`;
+    blobMap[blobId] = file;
+    return { locationType: 'BlobLocation', name: loc.name, blobId };
+}
+/**
+ * Single recursive walker that handles both FileHandleLocation → BlobLocation
+ * conversion and UriLocation collection for auth augmentation. Either side can
+ * be disabled by omitting the corresponding option; if both are omitted the
+ * walk is a no-op and the caller should skip it entirely.
+ */
+function walkLocationObjects(obj, opts, seen = new WeakSet()) {
+    if (!obj || typeof obj !== 'object' || seen.has(obj)) {
+        return;
+    }
+    seen.add(obj);
+    const visit = (val, write) => {
+        if (opts.blobMap && isFileHandleLocation(val)) {
+            write(convertFileHandleToBlob(val, opts.blobMap));
         }
         else {
-            const record = current;
-            for (const key of Object.keys(record)) {
-                const val = record[key];
-                if (isFileHandleLocation(val)) {
-                    record[key] = convertLocation(val);
-                }
-                else {
-                    convert(val);
-                }
+            if (opts.uris && isUriLocation(val)) {
+                opts.uris.push(val);
             }
+            walkLocationObjects(val, opts, seen);
         }
     };
-    convert(obj);
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            visit(obj[i], next => {
+                obj[i] = next;
+            });
+        }
+    }
+    else {
+        const record = obj;
+        for (const key of Object.keys(record)) {
+            visit(record[key], next => {
+                record[key] = next;
+            });
+        }
+    }
+}
+// Whether structuredClone (and the worker postMessage boundary) can carry this
+// value. Functions and Errors cannot; ownArgs passes them through by reference
+// rather than recursing, and a genuine one leaking through surfaces at the
+// worker postMessage boundary in production.
+function isCloneable(thing) {
+    return !(typeof thing === 'function') && !(thing instanceof Error);
+}
+// Values that structuredClone handles natively and that must pass through
+// ownArgs unchanged: `Object.entries` on them yields `[]`, so naive cloning
+// would collapse them to plain `{}` (e.g. a SharedArrayBuffer-backed stop token
+// would silently stop working, a typed array would lose its data).
+function isStructuredClonePassthrough(thing) {
+    return (thing instanceof File ||
+        thing instanceof Blob ||
+        thing instanceof ArrayBuffer ||
+        // SharedArrayBuffer is not an ArrayBuffer subclass; without this it
+        // collapses to {} and SAB-based stop tokens silently stop working. Nothing
+        // we ship mints one (see `stopToken.ts`, "Which path runs where"), so this
+        // arm is correctness for an isolated embedding host and nothing else —
+        // keep it, but it is not a hot path and never was.
+        (typeof SharedArrayBuffer !== 'undefined' &&
+            thing instanceof SharedArrayBuffer) ||
+        ArrayBuffer.isView(thing) ||
+        thing instanceof Date ||
+        thing instanceof Map ||
+        thing instanceof Set ||
+        thing instanceof RegExp);
+}
+// Deep-clone the object/array spine of the RPC args so blob conversion and auth
+// augmentation mutate owned data, never the read-only config snapshots that flow
+// in via readConfObject.
+//
+// **`structuredClone` is not the simplification it looks like, and the reason is
+// production rather than the test realm.** These args still carry the
+// `statusCallback`: `BaseRpcDriver.call` strips it from serialization's OUTPUT,
+// deliberately and with its own comment saying so, because resolving a refName
+// map downloads an index and that download has to have somewhere to report. A
+// function is not cloneable, so a real structuredClone would throw
+// DataCloneError on every call a display makes.
+//
+// So: non-cloneable leaves (functions, Errors) and structured-clone natives
+// (typed arrays, Blobs, the SAB stop token...) pass through by reference
+// unchanged. A genuinely non-cloneable value that leaked in by mistake is still
+// caught — at the worker postMessage boundary, which is a real structuredClone.
+function ownArgs(thing, seen = new WeakMap()) {
+    if (!thing || typeof thing !== 'object') {
+        return thing;
+    }
+    if (isStructuredClonePassthrough(thing) || !isCloneable(thing)) {
+        return thing;
+    }
+    const existing = seen.get(thing);
+    if (existing) {
+        return existing;
+    }
+    if (Array.isArray(thing)) {
+        const clone = [];
+        seen.set(thing, clone);
+        for (const item of thing) {
+            clone.push(ownArgs(item, seen));
+        }
+        return clone;
+    }
+    const clone = {};
+    seen.set(thing, clone);
+    for (const [key, value] of Object.entries(thing)) {
+        clone[key] = ownArgs(value, seen);
+    }
+    return clone;
+}
+// Back-compat wrapper around the combined walker; some tests and external
+// callers import this directly.
+export function convertFileHandleLocations(obj, blobMap) {
+    walkLocationObjects(obj, { blobMap });
 }
+/**
+ * Base for an RPC method. Parameterize with the method's own registry name —
+ * `class CoreGetRegions extends RpcMethodType<'CoreGetRegions'>` — and `execute`
+ * is then checked against that entry's declared `return` (bare or wrapped in
+ * rpcResult), so the registry stays an assertion about the worker rather than a
+ * hand-maintained guess. Left unparameterized, `execute` resolves to `unknown`
+ * as before; that's the escape hatch, and it should be rare.
+ *
+ * The name is checked twice over, because parameterizing used to be a claim
+ * rather than a fact: it must be a key of the registry (a miss lands on
+ * {@link NotInRpcRegistry} instead of quietly on `unknown`), and it must be the
+ * key this class sets as its {@link name}. Both are compile errors, so the
+ * escape hatch is the only way to end up unchecked, and taking it is visible.
+ *
+ * A method whose worker sends something other than the registry `return` — a
+ * result wrapped in `rpcResult` to hand its buffers to postMessage, or one
+ * `deserializeReturn` rebuilds — says so in the registry entry, beside the
+ * `return` it has to be read against. There is deliberately no second type
+ * parameter for it. As one it was a copy of the registry rather than a
+ * reference to it, and fifteen classes kept the copy in step by hand.
+ *
+ * The name is the ONLY parameter, and that is what makes this shape uniform:
+ * a second one survives only where a base is still GENERIC over its name, since
+ * `RpcWireReturn<MethodName>` is then a conditional TypeScript will not resolve
+ * and the shared body has nothing to check against. Such a base has to pin the
+ * wire return by hand and constrain `MethodName` to keep the pin honest — which
+ * is a mechanism, and the last one that needed it was sharing a three-line
+ * delegation two subclasses could each just write (see `runDiagonalize` in
+ * @jbrowse/synteny-core). Share an RPC body as a FUNCTION, not as a base
+ * generic over the key.
+ *
+ * The way back is {@link deserializeReturn}, checked against the same entry's
+ * `return`.
+ */
 export default class RpcMethodType extends PluggableElementBase {
     pluginManager;
     constructor(pluginManager) {
         super();
         this.pluginManager = pluginManager;
     }
-    async serializeArguments(args, rpcDriverClassName) {
-        await this.augmentLocationObjects(args, rpcDriverClassName);
+    async serializeArguments(args) {
+        const augmented = await this.augmentLocationObjects(args);
         return {
-            ...args,
+            ...augmented,
             blobMap: getBlobMap(),
         };
     }
-    async serializeNewAuthArguments(loc, _rpcDriverClassName) {
+    async renameRegions(args) {
+        const { rootModel } = this.pluginManager;
+        return renameRegionsIfNeeded(rootModel.session.assemblyManager, args);
+    }
+    /**
+     * The root model to resolve internet accounts against, but only while it is
+     * still attached to its tree. An RPC's promise can settle after the session it
+     * belongs to is gone — jbrowse-web loading a new session, or a headless
+     * renderer (jbrowse-img) destroying its model once the SVG is out — and
+     * reading `internetAccounts` off a destroyed node logs an MST dead-node
+     * warning for work whose result is already discarded. A torn-down root has no
+     * accounts to consult, so it reads as "none" rather than as an error.
+     */
+    get authRootModel() {
         const rootModel = this.pluginManager.rootModel;
-        if (!isAppRootModel(rootModel) || loc.internetAccountPreAuthorization) {
+        // a non-node root (an embedded host's duck-typed object, a test fake) can't
+        // be dead, so only real nodes get the liveness check
+        const alive = !isStateTreeNode(rootModel) || isAlive(rootModel);
+        return isAppRootModel(rootModel) && alive ? rootModel : undefined;
+    }
+    async serializeNewAuthArguments(loc) {
+        const rootModel = this.authRootModel;
+        // args dont need auth or already have auth
+        if (!rootModel || loc.internetAccountPreAuthorization) {
             return loc;
         }
-        const account = rootModel.findAppropriateInternetAccount(loc);
+        // Resolved, because both halves below read the uri as a URL: the account is
+        // matched on host or URL prefix, and validating the token means probing the
+        // resource. A uri relative to a baseUri is neither until it is resolved.
+        // The pre-authorization still lands on `loc` as it stands — the worker
+        // resolves against the same baseUri when it opens the location.
+        const resolved = resolveUriLocation(loc);
+        const account = rootModel.findAppropriateInternetAccount(resolved);
         if (account) {
             loc.internetAccountPreAuthorization =
-                await account.getPreAuthorizationInformation(loc);
+                await account.getPreAuthorizationInformation(resolved);
         }
         return loc;
     }
-    async deserializeArguments(args, _rpcDriverClassName) {
-        if (args.blobMap) {
-            setBlobMap(args.blobMap);
+    /**
+     * What both drivers call: deserialize, then `execute`.
+     *
+     * Each `execute` used to open with the deserialize call itself, and eleven
+     * methods across seven plugins had silently drifted off it. `RpcExecuteArgs`
+     * describes the DESERIALIZED shape — an entry declares `filters?:
+     * SerializableFilterChain` where the wire carries a `string[]` — so skipping
+     * it made the declared type false rather than erroring. Here it is true by
+     * construction.
+     */
+    async invoke(serializedArgs) {
+        return this.execute(await this.deserializeArguments(serializedArgs));
+    }
+    /**
+     * The far side of `serializeArguments`; {@link invoke} calls it. Override to
+     * add to the step, not to call it — and **an override must tolerate running
+     * twice on the same object**, since an external plugin written against the
+     * older contract still calls it from its own `execute`.
+     */
+    async deserializeArguments(args) {
+        // read off rather than named in the parameter type: for a driver holding an
+        // unparameterized RpcMethodType, RpcExecuteArgs<string> is `unknown`, and
+        // intersecting a blobMap into that rejects everything else
+        const { blobMap } = args;
+        if (blobMap) {
+            setBlobMap(blobMap);
         }
         return args;
     }
-    async executeDirect(_args) {
-        return undefined;
-    }
-    supportsDirectExecution() {
-        return this.executeDirect !== RpcMethodType.prototype.executeDirect;
+    /**
+     * The wire shape, rebuilt into what the caller of `rpcManager.call` holds —
+     * the registry entry's `return`. Overridden by the three methods whose two
+     * differ (features travel serialized and arrive as `SimpleFeature`s); for
+     * everyone else the whole job is taking off the `rpcResult` envelope, which
+     * MainThreadRpcDriver needs because nothing stripped it on that path.
+     *
+     * The registry `return` is checked against `execute` on the way in (through
+     * {@link RpcWireReturn}) and this is what checks it on the way back out. It
+     * checks covariantly, so unlike the arguments it cannot be widened past.
+     *
+     * An override calls {@link unwrapRpcResult} rather than `super`, because the
+     * envelope is all it wants and `super` now promises the rebuilt value it is
+     * the one rebuilding. The cast below is the claim that stands for every
+     * method that does NOT override: unwrapped wire is the declared `return`.
+     * True by construction for a `transferables: true` or bare entry, since both
+     * derive their wire from that `return`; an explicit `wire:` restates, so it
+     * is the one that has to override or agree.
+     */
+    async deserializeReturn(serializedReturn, _args) {
+        return unwrapRpcResult(serializedReturn);
     }
-    async serializeReturn(originalReturn, _args, _rpcDriverClassName) {
-        return originalReturn;
-    }
-    async deserializeReturn(serializedReturn, _args, _rpcDriverClassName) {
-        let r;
-        try {
-            r = await serializedReturn;
-        }
-        catch (error) {
-            if (isAuthNeededException(error)) {
-                const retryAccount = this.pluginManager.rootModel?.createEphemeralInternetAccount(`HTTPBasicInternetAccount-${new URL(error.url).origin}`, {}, error.url);
-                throw new RetryError('Retrying with created internet account', retryAccount.internetAccountId);
-            }
-            throw error;
-        }
-        if (isRpcResult(r)) {
-            return r.value;
-        }
-        return r;
-    }
-    async augmentLocationObjects(thing, rpcDriverClassName) {
-        const rootModel = this.pluginManager.rootModel;
-        const uris = [];
-        const blobMap = getBlobMap();
-        const { renderingProps, ...rest } = thing;
-        convertFileHandleLocations(rest, blobMap);
-        mapObject(rest, (key, val) => {
-            if (isUriLocation(val)) {
-                uris.push(val);
-            }
-            if (Array.isArray(val)) {
-                for (const item of val) {
-                    if (isUriLocation(item)) {
-                        uris.push(item);
-                    }
-                }
-            }
-            return [key, val];
-        }, { deep: true });
-        if (isAppRootModel(rootModel) && rootModel.internetAccounts.length === 0) {
+    async augmentLocationObjects(thing) {
+        const needsFileHandles = hasFileHandlesInCache();
+        const needsUris = !!this.authRootModel?.internetAccounts.length;
+        // Common case (web users with no internet accounts and no desktop file
+        // handles): nothing to do, skip the tree walk entirely.
+        if (!needsFileHandles && !needsUris) {
             return thing;
         }
+        // Skip renderingProps — it may contain circular references and never has
+        // FileHandleLocations or UriLocations inside. Own the rest of the tree (see
+        // ownArgs) so blob conversion and auth augmentation mutate owned data, never
+        // the read-only config snapshots that flow in through readConfObject.
+        const { renderingProps, ...rest } = thing;
+        const owned = ownArgs(rest);
+        const uris = [];
+        walkLocationObjects(owned, {
+            blobMap: needsFileHandles ? getBlobMap() : undefined,
+            uris: needsUris ? uris : undefined,
+        });
         for (const uri of uris) {
-            await this.serializeNewAuthArguments(uri, rpcDriverClassName);
+            await this.serializeNewAuthArguments(uri);
         }
-        return thing;
+        if ('renderingProps' in thing) {
+            owned.renderingProps = renderingProps;
+        }
+        return owned;
     }
 }

package/esm/pluggableElementTypes/RpcMethodTypeWithFiltersAndRenameRegions.d.ts

@@ -1,11 +1,21 @@
-import RpcMethodType from './RpcMethodType.ts';
-import type { RenderArgs } from '@jbrowse/core/rpc/coreRpcMethods';
-export default abstract class RpcMethodTypeWithFiltersAndRenameRegions extends RpcMethodType {
+import RpcMethodTypeWithRenameRegions from './RpcMethodTypeWithRenameRegions.ts';
+import SerializableFilterChain from './renderers/util/serializableFilterChain.ts';
+import type { Region } from '../util/index.ts';
+import type { StatusCallback } from '../util/progress.ts';
+import type { StopToken } from '../util/stopToken.ts';
+interface FilterRenameArgs {
+    sessionId: string;
+    regions?: Region[];
+    adapterConfig: Record<string, unknown>;
+    filters?: SerializableFilterChain;
+}
+export default abstract class RpcMethodTypeWithFiltersAndRenameRegions<MethodName extends string = string> extends RpcMethodTypeWithRenameRegions<MethodName> {
     deserializeArguments<T>(args: T & {
-        filters?: any;
-    }, rpcDriverClassName: string): Promise<T>;
-    serializeArguments(args: RenderArgs & {
-        stopToken?: string;
-        statusCallback?: (arg: string) => void;
-    }, rpcDriverClassName: string): Promise<Record<string, unknown>>;
+        filters?: unknown;
+    }): Promise<T>;
+    serializeArguments(args: FilterRenameArgs & {
+        stopToken?: StopToken;
+        statusCallback?: StatusCallback;
+    }): Promise<Record<string, unknown>>;
 }
+export {};

package/esm/pluggableElementTypes/RpcMethodTypeWithFiltersAndRenameRegions.js

@@ -1,29 +1,35 @@
-import RpcMethodType from "./RpcMethodType.js";
-import { renameRegionsIfNeeded } from "../util/index.js";
-import SerializableFilterChain from "./renderers/util/serializableFilterChain.js";
-export default class RpcMethodTypeWithFiltersAndRenameRegions extends RpcMethodType {
-    async deserializeArguments(args, rpcDriverClassName) {
-        const l = await super.deserializeArguments(args, rpcDriverClassName);
+import RpcMethodTypeWithRenameRegions from './RpcMethodTypeWithRenameRegions.js';
+import SerializableFilterChain from './renderers/util/serializableFilterChain.js';
+export default class RpcMethodTypeWithFiltersAndRenameRegions extends RpcMethodTypeWithRenameRegions {
+    async deserializeArguments(
+    // filters is `unknown` rather than SerializedFilterChain: callers' T types
+    // it as the deserialized SerializableFilterChain, so a string[] intersection
+    // would collapse to `never` and reject every call
+    args) {
+        const l = await super.deserializeArguments(args);
         return {
             ...l,
-            filters: args.filters
-                ? new SerializableFilterChain({
-                    filters: args.filters,
-                    jexl: this.pluginManager.jexl,
-                })
-                : undefined,
+            // on the wire filters is the serialized string[] (see serializeArguments),
+            // even though T statically types it as the deserialized chain
+            //
+            // instanceof so a second pass is a no-op rather than reaching
+            // `filters.map` on a chain — see deserializeArguments on the base
+            filters: args.filters instanceof SerializableFilterChain
+                ? args.filters
+                : args.filters
+                    ? new SerializableFilterChain({
+                        filters: args.filters,
+                        jexl: this.pluginManager.jexl,
+                    })
+                    : undefined,
         };
     }
-    async serializeArguments(args, rpcDriverClassName) {
-        const pm = this.pluginManager;
-        const assemblyManager = pm.rootModel?.session?.assemblyManager;
-        if (!assemblyManager) {
-            throw new Error('no assembly manager');
-        }
-        const renamedArgs = await renameRegionsIfNeeded(assemblyManager, {
+    async serializeArguments(args) {
+        // serialize the filter chain to its on-wire string[] form, then let the
+        // base class rename region refNames and finish serialization
+        return super.serializeArguments({
             ...args,
             filters: args.filters?.toJSON().filters,
         });
-        return super.serializeArguments(renamedArgs, rpcDriverClassName);
     }
 }

package/esm/pluggableElementTypes/RpcMethodTypeWithRenameRegion.d.ts

@@ -0,0 +1,5 @@
+import RpcMethodType from './RpcMethodType.ts';
+import type { RenameRegionArgs } from './RpcMethodType.ts';
+export default abstract class RpcMethodTypeWithRenameRegion<MethodName extends string = string> extends RpcMethodType<MethodName> {
+    serializeArguments<T extends RenameRegionArgs>(args: T): Promise<Record<string, unknown>>;
+}

package/esm/pluggableElementTypes/RpcMethodTypeWithRenameRegion.js

@@ -0,0 +1,18 @@
+import RpcMethodType from './RpcMethodType.js';
+// Singular-region counterpart of RpcMethodTypeWithRenameRegions, for RPC methods
+// whose wire contract carries one `region` (e.g. block-at-a-time wiggle
+// rendering). Subclasses get region renaming for free.
+export default class RpcMethodTypeWithRenameRegion extends RpcMethodType {
+    async serializeArguments(args) {
+        // adapt the singular `region` to the plural renameRegions helper.
+        // `rest`, not `args` — spreading the ORIGINAL back over the result drops
+        // everything renaming adds beside the regions, silently. That is how
+        // `sequenceAdapter` would reach a worker undefined on exactly the
+        // single-region methods while the plural ones got it.
+        const { regions, ...rest } = await this.renameRegions({
+            ...args,
+            regions: [args.region],
+        });
+        return super.serializeArguments({ ...rest, region: regions[0] });
+    }
+}

package/esm/pluggableElementTypes/RpcMethodTypeWithRenameRegions.d.ts

@@ -0,0 +1,5 @@
+import RpcMethodType from './RpcMethodType.ts';
+import type { RenameRegionsArgs } from './RpcMethodType.ts';
+export default abstract class RpcMethodTypeWithRenameRegions<MethodName extends string = string> extends RpcMethodType<MethodName> {
+    serializeArguments<T extends RenameRegionsArgs>(args: T): Promise<Record<string, unknown>>;
+}

package/esm/pluggableElementTypes/RpcMethodTypeWithRenameRegions.js

@@ -0,0 +1,10 @@
+import RpcMethodType from './RpcMethodType.js';
+// Base for RPC methods whose serialize step just maps region refNames into the
+// data adapter's naming scheme. Subclasses get region renaming for free;
+// override serializeArguments only to add extra transforms, calling super to
+// keep the renaming.
+export default class RpcMethodTypeWithRenameRegions extends RpcMethodType {
+    async serializeArguments(args) {
+        return super.serializeArguments(await this.renameRegions(args));
+    }
+}

package/esm/pluggableElementTypes/TextSearchAdapterType.d.ts

@@ -7,12 +7,12 @@ export default class TextSearchAdapterType extends PluggableElementBase {
     description?: string;
     constructor(stuff: {
         name: string;
+        configSchema: AnyConfigurationSchemaType;
         displayName?: string;
         description?: string;
-        configSchema: AnyConfigurationSchemaType;
     } & ({
-        AdapterClass: AnyAdapter;
-    } | {
         getAdapterClass: () => Promise<AnyAdapter>;
+    } | {
+        AdapterClass: AnyAdapter;
     }));
 }

package/esm/pluggableElementTypes/TextSearchAdapterType.js

@@ -1,8 +1,10 @@
-import PluggableElementBase from "./PluggableElementBase.js";
+import PluggableElementBase from './PluggableElementBase.js';
 export default class TextSearchAdapterType extends PluggableElementBase {
     getAdapterClass;
     configSchema;
     description;
+    // `AdapterClass` is retained for backward compatibility with third-party
+    // plugins; new code should prefer `getAdapterClass` for code splitting.
     constructor(stuff) {
         super(stuff);
         this.description = stuff.description;

package/esm/pluggableElementTypes/TrackType.d.ts

@@ -1,6 +1,6 @@
 import PluggableElementBase from './PluggableElementBase.ts';
-import type DisplayType from './DisplayType.ts';
 import type { AnyConfigurationSchemaType } from '../configuration/index.ts';
+import type DisplayType from './DisplayType.ts';
 import type { IAnyModelType } from '@jbrowse/mobx-state-tree';
 export default class TrackType extends PluggableElementBase {
     stateModel: IAnyModelType;
@@ -11,6 +11,7 @@ export default class TrackType extends PluggableElementBase {
         stateModel: IAnyModelType;
         displayName?: string;
         configSchema: AnyConfigurationSchemaType;
+        aliases?: string[];
     });
     addDisplayType(display: DisplayType): void;
 }

package/esm/pluggableElementTypes/TrackType.js

@@ -1,4 +1,4 @@
-import PluggableElementBase from "./PluggableElementBase.js";
+import PluggableElementBase from './PluggableElementBase.js';
 export default class TrackType extends PluggableElementBase {
     stateModel;
     configSchema;

package/esm/pluggableElementTypes/ViewType.d.ts

@@ -1,7 +1,7 @@
-import type React from 'react';
 import PluggableElementBase from './PluggableElementBase.ts';
 import type DisplayType from './DisplayType.ts';
 import type { IAnyModelType, IAnyStateTreeNode } from '@jbrowse/mobx-state-tree';
+import type React from 'react';
 type BasicView = React.ComponentType<{
     model: any;
     session?: IAnyStateTreeNode;
@@ -23,6 +23,7 @@ export default class ViewType extends PluggableElementBase {
         extendedName?: string;
         viewMetadata?: ViewMetadata;
         ReactComponent: ViewComponentType;
+        aliases?: string[];
     });
     addDisplayType(display: DisplayType): void;
 }

package/esm/pluggableElementTypes/ViewType.js

@@ -1,14 +1,21 @@
-import PluggableElementBase from "./PluggableElementBase.js";
+import PluggableElementBase from './PluggableElementBase.js';
 export default class ViewType extends PluggableElementBase {
     ReactComponent;
     stateModel;
     displayTypes = [];
     viewMetadata = {};
+    // extendedName can be used for when you extend a given view type, and want
+    // to register all of that view types displays to yourself
+    //
+    // e.g. you create a linear-genome-view subtype, and want all the tracks that
+    // are compatible display types for the linear-genome-view to be compatible
+    // with your type also (without this, display types are only registered to a
+    // single view type)
     extendedName;
     constructor(stuff) {
         super(stuff);
         this.ReactComponent = stuff.ReactComponent;
-        this.viewMetadata = stuff.viewMetadata || {};
+        this.viewMetadata = stuff.viewMetadata ?? {};
         this.stateModel = stuff.stateModel;
         this.extendedName = stuff.extendedName;
     }

package/esm/pluggableElementTypes/WidgetType.d.ts

@@ -1,8 +1,8 @@
-import type { ComponentType, LazyExoticComponent } from 'react';
-import type React from 'react';
 import PluggableElementBase from './PluggableElementBase.ts';
 import type { AnyConfigurationSchemaType } from '../configuration/index.ts';
 import type { IAnyModelType, IAnyStateTreeNode } from '@jbrowse/mobx-state-tree';
+import type { ComponentType, LazyExoticComponent } from 'react';
+import type React from 'react';
 type WidgetComponentType = LazyExoticComponent<React.FC<any>> | React.FC<any>;
 type HeadingComponentType = ComponentType<{
     model: IAnyStateTreeNode;

package/esm/pluggableElementTypes/WidgetType.js

@@ -1,4 +1,4 @@
-import PluggableElementBase from "./PluggableElementBase.js";
+import PluggableElementBase from './PluggableElementBase.js';
 export default class WidgetType extends PluggableElementBase {
     heading;
     configSchema;