@jbrowse/core 2.7.1 → 2.8.0

package/util/index.d.ts

@@ -13,23 +13,40 @@ export * from './range';
 export * from './dedupe';
 export * from './offscreenCanvasPonyfill';
 export * from './offscreenCanvasUtils';
-export declare const inDevelopment: boolean;
-export declare const inProduction: boolean;
 export declare function useDebounce<T>(value: T, delay: number): T;
 export declare function useWidthSetter(view: {
     setWidth: (arg: number) => void;
 }, padding: string): import("react").RefObject<HTMLDivElement>;
 export declare function useDebouncedCallback<T>(callback: (...args: T[]) => void, wait?: number): (...args: T[]) => void;
-/** find the first node in the hierarchy that matches the given predicate */
+/**
+ * find the first node in the hierarchy that matches the given predicate
+ */
 export declare function findParentThat(node: IAnyStateTreeNode, predicate: (thing: IAnyStateTreeNode) => boolean): IAnyStateTreeNode;
 export declare function springAnimate(fromValue: number, toValue: number, setValue: (value: number) => void, onFinish?: () => void, precision?: number, tension?: number, friction?: number): (() => void)[];
+/**
+ * find the first node in the hierarchy that matches the given 'is' typescript
+ * type guard predicate
+ */
 export declare function findParentThatIs<T extends (a: IAnyStateTreeNode) => boolean>(node: IAnyStateTreeNode, predicate: T): TypeTestedByPredicate<T>;
-/** get the current JBrowse session model, starting at any node in the state tree */
+/**
+ * get the current JBrowse session model, starting at any node in the state
+ * tree
+ */
 export declare function getSession(node: IAnyStateTreeNode): import("./types").AbstractSessionModel;
-/** get the state model of the view in the state tree that contains the given node */
+/**
+ * get the state model of the view in the state tree that contains the given
+ * node
+ */
 export declare function getContainingView(node: IAnyStateTreeNode): import("./types").AbstractViewModel;
-/** get the state model of the view in the state tree that contains the given node */
+/**
+ * get the state model of the view in the state tree that contains the given
+ * node
+ */
 export declare function getContainingTrack(node: IAnyStateTreeNode): import("./types").AbstractTrackModel;
+/**
+ * get the state model of the display in the state tree that contains the given
+ * node
+ */
 export declare function getContainingDisplay(node: IAnyStateTreeNode): import("./types").AbstractDisplayModel;
 /**
  * Assemble a 1-based "locString" from an interbase genomic location
@@ -159,10 +176,14 @@ export declare function iterMap<T, U>(iter: Iterable<T>, func: (arg: T) => U, si
 /**
  * Returns the index of the last element in the array where predicate is true,
  * and -1 otherwise.
+ * Based on https://stackoverflow.com/a/53187807
+ *
  * @param array - The source array to search in
+ *
  * @param predicate - find calls predicate once for each element of the array, in
- * descending order, until it finds one where predicate returns true. If such an
- * element is found, findLastIndex immediately returns that element index.
+ * descending order, until it finds one where predicate returns true.
+ *
+ * @returns findLastIndex returns element index where predicate is true.
  * Otherwise, findLastIndex returns -1.
  */
 export declare function findLastIndex<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => boolean): number;

package/util/index.js

@@ -17,8 +17,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSupportedIndexingAdapter = exports.bytesForRegions = exports.objectHash = exports.hashCode = exports.updateStatus = exports.generateCodonTable = exports.defaultCodonTable = exports.defaultStops = exports.defaultStarts = exports.measureText = exports.rIC = exports.complement = exports.reverse = exports.revcom = exports.isElectron = exports.stringify = exports.shorten = exports.minmax = exports.renameRegionsIfNeeded = exports.renameRegionIfNeeded = exports.makeAbortableReaction = exports.findLast = exports.findLastIndex = exports.iterMap = exports.bpSpanPx = exports.featureSpanPx = exports.cartesianToPolar = exports.polarToCartesian = exports.degToRad = exports.radToDeg = exports.bpToPx = exports.clamp = exports.compareLocStrings = exports.compareLocs = exports.parseLocString = exports.parseLocStringOneBased = exports.assembleLocStringFast = exports.assembleLocString = exports.getContainingDisplay = exports.getContainingTrack = exports.getContainingView = exports.getSession = exports.findParentThatIs = exports.springAnimate = exports.findParentThat = exports.useDebouncedCallback = exports.useWidthSetter = exports.useDebounce = exports.inProduction = exports.inDevelopment = void 0;
-exports.blobToDataURL = exports.stripAlpha = exports.isFeature = exports.SimpleFeature = exports.gatherOverlaps = exports.mergeIntervals = exports.notEmpty = exports.groupBy = exports.avg = exports.sum = exports.min = exports.max = exports.localStorageSetItem = exports.localStorageGetItem = exports.getEnv = exports.measureGridWidth = exports.linkify = exports.coarseStripHTML = exports.getStr = exports.getUriLink = exports.useLocalStorage = exports.getLayoutId = exports.getViewParams = exports.getTickDisplayStr = exports.toLocale = exports.getBpDisplayStr = void 0;
+exports.toLocale = exports.getBpDisplayStr = exports.isSupportedIndexingAdapter = exports.bytesForRegions = exports.objectHash = exports.hashCode = exports.updateStatus = exports.generateCodonTable = exports.defaultCodonTable = exports.defaultStops = exports.defaultStarts = exports.measureText = exports.rIC = exports.complement = exports.reverse = exports.revcom = exports.isElectron = exports.stringify = exports.shorten = exports.minmax = exports.renameRegionsIfNeeded = exports.renameRegionIfNeeded = exports.makeAbortableReaction = exports.findLast = exports.findLastIndex = exports.iterMap = exports.bpSpanPx = exports.featureSpanPx = exports.cartesianToPolar = exports.polarToCartesian = exports.degToRad = exports.radToDeg = exports.bpToPx = exports.clamp = exports.compareLocStrings = exports.compareLocs = exports.parseLocString = exports.parseLocStringOneBased = exports.assembleLocStringFast = exports.assembleLocString = exports.getContainingDisplay = exports.getContainingTrack = exports.getContainingView = exports.getSession = exports.findParentThatIs = exports.springAnimate = exports.findParentThat = exports.useDebouncedCallback = exports.useWidthSetter = exports.useDebounce = void 0;
+exports.blobToDataURL = exports.stripAlpha = exports.isFeature = exports.SimpleFeature = exports.gatherOverlaps = exports.mergeIntervals = exports.notEmpty = exports.groupBy = exports.avg = exports.sum = exports.min = exports.max = exports.localStorageSetItem = exports.localStorageGetItem = exports.getEnv = exports.measureGridWidth = exports.linkify = exports.coarseStripHTML = exports.getStr = exports.getUriLink = exports.useLocalStorage = exports.getLayoutId = exports.getViewParams = exports.getTickDisplayStr = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const react_1 = require("react");
 const is_object_1 = __importDefault(require("is-object"));
@@ -37,10 +37,6 @@ __exportStar(require("./range"), exports);
 __exportStar(require("./dedupe"), exports);
 __exportStar(require("./offscreenCanvasPonyfill"), exports);
 __exportStar(require("./offscreenCanvasUtils"), exports);
-exports.inDevelopment = typeof process === 'object' &&
-    process.env &&
-    process.env.NODE_ENV === 'development';
-exports.inProduction = !exports.inDevelopment;
 function useDebounce(value, delay) {
     const [debouncedValue, setDebouncedValue] = (0, react_1.useState)(value);
     (0, react_1.useEffect)(() => {
@@ -78,7 +74,8 @@ function useDebouncedCallback(callback, wait = 400) {
             clearTimeout(timeout.current);
         }
     }
-    // make sure our timeout gets cleared if our consuming component gets unmounted
+    // make sure our timeout gets cleared if our consuming component gets
+    // unmounted
     (0, react_1.useEffect)(() => cleanup, []);
     return function debouncedCallback(...args) {
         // capture latest args
@@ -94,7 +91,9 @@ function useDebouncedCallback(callback, wait = 400) {
     };
 }
 exports.useDebouncedCallback = useDebouncedCallback;
-/** find the first node in the hierarchy that matches the given predicate */
+/**
+ * find the first node in the hierarchy that matches the given predicate
+ */
 function findParentThat(node, predicate) {
     if (!(0, mobx_state_tree_1.hasParent)(node)) {
         throw new Error('node does not have parent');
@@ -161,12 +160,18 @@ function springAnimate(fromValue, toValue, setValue, onFinish = () => { }, preci
     ];
 }
 exports.springAnimate = springAnimate;
-// find the first node in the hierarchy that matches the given 'is' typescript type guard predicate
+/**
+ * find the first node in the hierarchy that matches the given 'is' typescript
+ * type guard predicate
+ */
 function findParentThatIs(node, predicate) {
     return findParentThat(node, predicate);
 }
 exports.findParentThatIs = findParentThatIs;
-/** get the current JBrowse session model, starting at any node in the state tree */
+/**
+ * get the current JBrowse session model, starting at any node in the state
+ * tree
+ */
 function getSession(node) {
     try {
         return findParentThatIs(node, types_1.isSessionModel);
@@ -176,7 +181,10 @@ function getSession(node) {
     }
 }
 exports.getSession = getSession;
-/** get the state model of the view in the state tree that contains the given node */
+/**
+ * get the state model of the view in the state tree that contains the given
+ * node
+ */
 function getContainingView(node) {
     try {
         return findParentThatIs(node, types_1.isViewModel);
@@ -186,7 +194,10 @@ function getContainingView(node) {
     }
 }
 exports.getContainingView = getContainingView;
-/** get the state model of the view in the state tree that contains the given node */
+/**
+ * get the state model of the view in the state tree that contains the given
+ * node
+ */
 function getContainingTrack(node) {
     try {
         return findParentThatIs(node, types_1.isTrackModel);
@@ -196,6 +207,10 @@ function getContainingTrack(node) {
     }
 }
 exports.getContainingTrack = getContainingTrack;
+/**
+ * get the state model of the display in the state tree that contains the given
+ * node
+ */
 function getContainingDisplay(node) {
     try {
         return findParentThatIs(node, types_1.isDisplayModel);
@@ -516,14 +531,17 @@ function iterMap(iter, func, sizeHint) {
     return results;
 }
 exports.iterMap = iterMap;
-// https://stackoverflow.com/a/53187807
 /**
  * Returns the index of the last element in the array where predicate is true,
  * and -1 otherwise.
+ * Based on https://stackoverflow.com/a/53187807
+ *
  * @param array - The source array to search in
+ *
  * @param predicate - find calls predicate once for each element of the array, in
- * descending order, until it finds one where predicate returns true. If such an
- * element is found, findLastIndex immediately returns that element index.
+ * descending order, until it finds one where predicate returns true.
+ *
+ * @returns findLastIndex returns element index where predicate is true.
  * Otherwise, findLastIndex returns -1.
  */
 function findLastIndex(array, predicate) {

package/util/layouts/SceneGraph.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = require("..");
 class SceneGraph {
     /**
      * note: all coordinates are inter-base or inter-pixel coordinates
@@ -14,18 +13,6 @@ class SceneGraph {
         this.width = width;
         this.height = height;
         this.data = data;
-        if (__1.inDevelopment &&
-            (typeof name !== 'string' ||
-                typeof left !== 'number' ||
-                Number.isNaN(left) ||
-                typeof top !== 'number' ||
-                Number.isNaN(top) ||
-                typeof width !== 'number' ||
-                Number.isNaN(width) ||
-                typeof height !== 'number' ||
-                Number.isNaN(height))) {
-            throw new TypeError('invalid SceneGraph arguments');
-        }
         this.children = new Map();
         this.absoluteCache = { dirty: true };
     }

package/util/types/index.d.ts

@@ -52,6 +52,8 @@ export interface AbstractSessionModel extends AbstractViewContainer {
     selection?: unknown;
     focusedViewId?: string;
     themeName?: string;
+    hovered: unknown;
+    setHovered: (arg: unknown) => void;
     setFocusedViewId?: (id: string) => void;
     allThemes?: () => Record<string, ThemeOptions | undefined>;
     setSelection: (feature: Feature) => void;
@@ -117,9 +119,9 @@ export interface Widget {
 export interface SessionWithWidgets extends AbstractSessionModel {
     minimized: boolean;
     visibleWidget?: Widget;
-    widgets: Map<string, Widget>;
+    widgets: Map<string | number, Widget>;
     hideAllWidgets: () => void;
-    activeWidgets: Map<string, Widget>;
+    activeWidgets: Map<string | number, Widget>;
     addWidget(typeName: string, id: string, initialState?: Record<string, unknown>, configuration?: {
         type: string;
     }): Widget;