@jbrowse/core 2.2.0 → 2.2.2

package/pluggableElementTypes/models/InternetAccountModel.js

@@ -6,37 +6,67 @@ const configuration_1 = require("../../configuration");
 const io_1 = require("../../util/io");
 const mst_1 = require("../../util/types/mst");
 const inWebWorker = typeof sessionStorage === 'undefined';
+/**
+ * #stateModel BaseInternetAccountModel
+ */
+function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
 exports.InternetAccount = mobx_state_tree_1.types
     .model('InternetAccount', {
+    /**
+     * #property
+     */
     id: mst_1.ElementId,
+    /**
+     * #property
+     */
     type: mobx_state_tree_1.types.string,
 })
     .views(self => ({
+    /**
+     * #getter
+     */
     get name() {
         return (0, configuration_1.getConf)(self, 'name');
     },
+    /**
+     * #getter
+     */
     get description() {
         return (0, configuration_1.getConf)(self, 'description');
     },
+    /**
+     * #getter
+     */
     get internetAccountId() {
         return (0, configuration_1.getConf)(self, 'internetAccountId');
     },
+    /**
+     * #getter
+     */
     get authHeader() {
         return (0, configuration_1.getConf)(self, 'authHeader');
     },
+    /**
+     * #getter
+     */
     get tokenType() {
         return (0, configuration_1.getConf)(self, 'tokenType');
     },
+    /**
+     * #getter
+     */
     get domains() {
         return (0, configuration_1.getConf)(self, 'domains');
     },
     /**
+     * #getter
      * Can use this to customize what is displayed in fileSelector's toggle box
      */
     get toggleContents() {
         return null;
     },
     /**
+     * #getter
      * Can use this to customize what the fileSelector. It takes a prop called
      * `setLocation` that should be used to set a UriLocation
      */
@@ -44,6 +74,7 @@ exports.InternetAccount = mobx_state_tree_1.types
         return undefined;
     },
     /**
+     * #getter
      * Can use this to add a label to the UrlChooser. Has no effect if a custom
      * SelectorComponent is supplied
      */
@@ -53,14 +84,16 @@ exports.InternetAccount = mobx_state_tree_1.types
 }))
     .views(self => ({
     /**
+     * #method
      * Determine whether this internetAccount provides credentials for a URL
      * @param location  - UriLocation of resource
      * @returns true or false
      */
     handlesLocation(location) {
-        return self.domains.some((domain) => location === null || location === void 0 ? void 0 : location.uri.includes(domain));
+        return self.domains.some(domain => location === null || location === void 0 ? void 0 : location.uri.includes(domain));
     },
     /**
+     * #getter
      * The key used to store this internetAccount's token in sessionStorage
      */
     get tokenKey() {
@@ -69,6 +102,7 @@ exports.InternetAccount = mobx_state_tree_1.types
 }))
     .actions(self => ({
     /**
+     * #action
      * Must be implemented by a model extending or composing this one. Pass the
      * user's token to `resolve`.
      * @param resolve - Pass the token to this function
@@ -77,16 +111,26 @@ exports.InternetAccount = mobx_state_tree_1.types
     getTokenFromUser(resolve, reject) {
         throw new Error('getTokenFromUser must be implemented by extending model');
     },
+    /**
+     * #action
+     */
     storeToken(token) {
         sessionStorage.setItem(self.tokenKey, token);
     },
+    /**
+     * #action
+     */
     removeToken() {
         sessionStorage.removeItem(self.tokenKey);
     },
+    /**
+     * #action
+     */
     retrieveToken() {
         return sessionStorage.getItem(self.tokenKey);
     },
     /**
+     * #action
      * This can be used by an internetAccount to validate a token works before
      * it is used. This is run when preAuthorizationInformation is requested, so
      * it can be used to check that a token is valid before sending it to a
@@ -95,10 +139,10 @@ exports.InternetAccount = mobx_state_tree_1.types
      * if the original one was invalid. Should throw an error if a token is
      * invalid.
      * @param token - Auth token
-     * @param location - UriLocation of the resource
+     * @param loc - UriLocation of the resource
      * @returns - Valid auth token
      */
-    async validateToken(token, location) {
+    async validateToken(token, loc) {
         return token;
     },
 }))
@@ -106,6 +150,7 @@ exports.InternetAccount = mobx_state_tree_1.types
     let tokenPromise = undefined;
     return {
         /**
+         * #action
          * Try to get the token from the location pre-auth, from local storage,
          * or from a previously cached promise. If token is not available, uses
          * `getTokenFromUser`.
@@ -146,6 +191,9 @@ exports.InternetAccount = mobx_state_tree_1.types
     };
 })
     .actions(self => ({
+    /**
+     * #action
+     */
     addAuthHeaderToInit(init = {}, token) {
         const tokenInfoString = self.tokenType
             ? `${self.tokenType} ${token}`
@@ -155,6 +203,7 @@ exports.InternetAccount = mobx_state_tree_1.types
         return { ...init, headers: newHeaders };
     },
     /**
+     * #action
      * Gets the token and returns it along with the information needed to
      * create a new internetAccount.
      * @param location - UriLocation of the resource
@@ -178,15 +227,16 @@ exports.InternetAccount = mobx_state_tree_1.types
 }))
     .actions(self => ({
     /**
+     * #action
      * Get a fetch method that will add any needed authentication headers to
      * the request before sending it. If location is provided, it will be
      * checked to see if it includes a token in it pre-auth information.
-     * @param location - UriLocation of the resource
+     * @param loc - UriLocation of the resource
      * @returns A function that can be used to fetch
      */
-    getFetcher(location) {
+    getFetcher(loc) {
         return async (input, init) => {
-            const authToken = await self.getToken(location);
+            const authToken = await self.getToken(loc);
             const newInit = self.addAuthHeaderToInit(init, authToken);
             return fetch(input, newInit);
         };
@@ -194,6 +244,7 @@ exports.InternetAccount = mobx_state_tree_1.types
 }))
     .actions(self => ({
     /**
+     * #action
      * Gets a filehandle that uses a fetch that adds auth headers
      * @param location - UriLocation of the resource
      * @returns A filehandle

package/pluggableElementTypes/models/baseInternetAccountConfig.d.ts

@@ -1,4 +1 @@
-import { Instance } from 'mobx-state-tree';
 export declare const BaseInternetAccountConfig: import("../../configuration").AnyConfigurationSchemaType;
-export declare type BaseInternetAccountConfigModel = typeof BaseInternetAccountConfig;
-export declare type BaseInternetAccountConfig = Instance<BaseInternetAccountConfigModel>;

package/pluggableElementTypes/models/baseTrackConfig.d.ts

@@ -4,5 +4,5 @@ import PluginManager from '../../PluginManager';
  * #config BaseTrack
  */
 export declare function createBaseTrackConfig(pluginManager: PluginManager): import("../../configuration").AnyConfigurationSchemaType;
-export declare type BaseTrackConfigModel = ReturnType<typeof createBaseTrackConfig>;
-export declare type BaseTrackConfig = Instance<BaseTrackConfigModel>;
+export type BaseTrackConfigModel = ReturnType<typeof createBaseTrackConfig>;
+export type BaseTrackConfig = Instance<BaseTrackConfigModel>;

package/pluggableElementTypes/models/baseTrackConfig.js

@@ -108,12 +108,18 @@ function createBaseTrackConfig(pluginManager) {
             },
         }),
         formatAbout: (0, configuration_1.ConfigurationSchema)('FormatAbout', {
+            /**
+             * #slot formatAbout.config
+             */
             config: {
                 type: 'frozen',
                 description: 'formats configuration object in about dialog',
                 defaultValue: {},
                 contextVariable: ['config'],
             },
+            /**
+             * #slot formatAbout.hideUris
+             */
             hideUris: {
                 type: 'boolean',
                 defaultValue: false,
@@ -141,6 +147,9 @@ function createBaseTrackConfig(pluginManager) {
             }
             return { ...snap, displays };
         },
+        /**
+         * #identifier
+         */
         explicitIdentifier: 'trackId',
         explicitlyTyped: true,
         actions: (self) => ({

package/pluggableElementTypes/renderers/BoxRendererType.d.ts

@@ -12,7 +12,7 @@ export interface LayoutSessionProps {
     bpPerPx: number;
     filters: SerializableFilterChain;
 }
-export declare type MyMultiLayout = MultiLayout<GranularRectLayout<unknown>, unknown>;
+export type MyMultiLayout = MultiLayout<GranularRectLayout<unknown>, unknown>;
 export interface CachedLayout {
     layout: MyMultiLayout;
     config: AnyConfigurationModel;

package/pluggableElementTypes/renderers/ComparativeServerSideRendererType.d.ts

@@ -14,7 +14,7 @@ export interface RenderArgsDeserialized extends ServerSideRenderArgsDeserialized
     blockKey: string;
 }
 export type { RenderResults };
-export declare type ResultsSerialized = ServerSideResultsSerialized;
+export type ResultsSerialized = ServerSideResultsSerialized;
 export interface ResultsDeserialized extends ServerSideResultsDeserialized {
     blockKey: string;
 }

package/pluggableElementTypes/renderers/RendererType.d.ts

@@ -3,7 +3,7 @@ import PluggableElementBase from '../PluggableElementBase';
 import { AnyConfigurationSchemaType } from '../../configuration/configurationSchema';
 import { AnyReactComponentType } from '../../util';
 import PluginManager from '../../PluginManager';
-export declare type RenderProps = Record<string, unknown>;
+export type RenderProps = Record<string, unknown>;
 export interface RenderResults {
     reactElement?: ReactElement;
     html?: string;

package/pluggableElementTypes/renderers/ServerSideRendererType.d.ts

@@ -35,7 +35,7 @@ export interface ResultsSerializedSvgExport extends ResultsSerialized {
     height: number;
     reactElement: unknown;
 }
-export declare type ResultsDeserialized = RenderResults;
+export type ResultsDeserialized = RenderResults;
 export default class ServerSideRenderer extends RendererType {
     /**
      * directly modifies the render arguments to prepare them to be serialized and
@@ -74,7 +74,7 @@ export default class ServerSideRenderer extends RendererType {
      * Render method called on the client. Serializes args, then calls
      * "CoreRender" with the RPC manager.
      *
-     * @param rpcManager - RPC mananger
+     * @param rpcManager - RPC manager
      * @param args - render args
      */
     renderInClient(rpcManager: RpcManager, args: RenderArgs): Promise<ResultsSerialized>;

package/pluggableElementTypes/renderers/ServerSideRendererType.js

@@ -117,7 +117,7 @@ class ServerSideRenderer extends RendererType_1.default {
      * Render method called on the client. Serializes args, then calls
      * "CoreRender" with the RPC manager.
      *
-     * @param rpcManager - RPC mananger
+     * @param rpcManager - RPC manager
      * @param args - render args
      */
     async renderInClient(rpcManager, args) {

package/pluggableElementTypes/renderers/util/serializableFilterChain.d.ts

@@ -1,9 +1,9 @@
-declare type FilterExpression = (...args: Record<string, any>[] | any[]) => boolean;
+type FilterExpression = (...args: Record<string, any>[] | any[]) => boolean;
 interface Filter {
     string: string;
     expr: FilterExpression;
 }
-export declare type SerializedFilterChain = string[];
+export type SerializedFilterChain = string[];
 export default class SerializableFilterChain {
     filterChain: Filter[];
     constructor({ filters }: {

package/rpc/BaseRpcDriver.js

@@ -110,7 +110,7 @@ class BaseRpcDriver {
     }
     async remoteAbort(sessionId, functionName, signalId) {
         const worker = await this.getWorker(sessionId);
-        worker.call(functionName, { signalId }, { timeout: 1000000, rpcDriverClassName: this.name });
+        await worker.call(functionName, { signalId }, { timeout: 1000000, rpcDriverClassName: this.name });
     }
     createWorkerPool() {
         const hardwareConcurrency = detectHardwareConcurrency();

package/rpc/RpcManager.d.ts

@@ -2,8 +2,8 @@ import PluginManager from '../PluginManager';
 import { AnyConfigurationModel } from '../configuration';
 import WebWorkerRpcDriver from './WebWorkerRpcDriver';
 import MainThreadRpcDriver from './MainThreadRpcDriver';
-declare type DriverClass = WebWorkerRpcDriver | MainThreadRpcDriver;
-declare type BackendConfigurations = {
+type DriverClass = WebWorkerRpcDriver | MainThreadRpcDriver;
+type BackendConfigurations = {
     WebWorkerRpcDriver?: Omit<ConstructorParameters<typeof WebWorkerRpcDriver>[0], 'config'>;
     MainThreadRpcDriver?: Omit<ConstructorParameters<typeof MainThreadRpcDriver>[0], 'config'>;
 };

package/rpc/remoteAbortSignals.d.ts

@@ -1,4 +1,4 @@
-export declare type RemoteAbortSignal = {
+export type RemoteAbortSignal = {
     abortSignalId: number;
 };
 /**