@vitessce/vit-s 2.0.3-beta.0 → 3.0.0

package/src/vitessce-grid-utils.js

@@ -0,0 +1,172 @@
+import {
+  useState, useEffect, useRef,
+} from 'react';
+import { InternMap } from 'internmap';
+import { isEqual, pick } from 'lodash-es';
+import { fromEntries } from '@vitessce/utils';
+import { DATA_TYPE_COORDINATION_VALUE_USAGE } from '@vitessce/constants-internal';
+import { getSourceAndLoaderFromFileType, getDataTypeFromFileType } from './data/loader-registry.js';
+
+/**
+ * Return the bottom coordinate of the layout.
+ * https://github.com/STRML/react-grid-layout/blob/20dac73f91274526034c00968b5bedb9c2ed36b9/lib/utils.js#L82
+ * @param  {array} layout react-grid-layout layout array.
+ * @returns {number} Bottom coordinate.
+ */
+function getNumRows(layout) {
+  let max = 0;
+  let bottomY;
+  // eslint-disable-next-line no-plusplus
+  for (let i = 0, len = layout.length; i < len; i++) {
+    bottomY = layout[i].y + layout[i].h;
+    if (bottomY > max) max = bottomY;
+  }
+  return max;
+}
+
+/**
+ * Compute the row height based on the container height, number of rows,
+ * and margin/padding. Basically the reverse of the react-grid-layout's
+ * `.containerHeight()` function.
+ * https://github.com/STRML/react-grid-layout/blob/83251e5e682abfa3252ff89d4bacf47fdc1f4270/lib/ReactGridLayout.jsx#L223
+ * @param {number} containerHeight The height of the .vitessce-container element.
+ * @param {number} numRows The number of rows in the layout.
+ * @param {number} margin The margin value that will be passed to VitessceGrid.
+ * @param {number} padding The padding value that will be passed to VitessceGrid.
+ * @returns {number} The new row height value.
+ */
+function getRowHeight(containerHeight, numRows, margin, padding) {
+  const effectiveContainerHeight = containerHeight - 2 * padding - (numRows - 1) * margin;
+  return effectiveContainerHeight / numRows;
+}
+
+export function useRowHeight(config, initialRowHeight, height, margin, padding) {
+  const [containerHeight, setContainerHeight] = useState(height);
+  const [rowHeight, setRowHeight] = useState(initialRowHeight);
+  const containerRef = useRef();
+
+  // Detect when the `config` or `containerHeight` variables
+  // have changed, and update `rowHeight` in response.
+  useEffect(() => {
+    const numRows = getNumRows(config.layout);
+    const newRowHeight = getRowHeight(containerHeight, numRows, margin, padding);
+    setRowHeight(newRowHeight);
+  }, [containerHeight, config, margin, padding]);
+
+  // Update the `containerHeight` state when the `height` prop has changed.
+  useEffect(() => {
+    if (height !== null && height !== undefined) {
+      setContainerHeight(height);
+    }
+  }, [height]);
+
+  // If no height prop has been provided, set the `containerHeight`
+  // using height of the `.vitessce-container` element.
+  // Check the container element height whenever the window has been
+  // resized, as it may change if `.vitessce-container` should be
+  // sized relative to its parent (and by extension, potentially the window).
+  useEffect(() => {
+    if (height !== null && height !== undefined) {
+      // eslint will complain if the return value is inconsistent,
+      // so return a no-op function.
+      return () => {};
+    }
+    function onWindowResize() {
+      if (!containerRef.current) return;
+      const containerRect = containerRef.current.getBoundingClientRect();
+      setContainerHeight(containerRect.height);
+    }
+    window.addEventListener('resize', onWindowResize);
+    onWindowResize();
+    return () => {
+      window.removeEventListener('resize', onWindowResize);
+    };
+  }, [containerRef, height]);
+
+
+  return [rowHeight, containerRef];
+}
+
+function withDefaults(
+  coordinationValues,
+  dataType,
+  fileType,
+  datasetUid,
+  defaultCoordinationValues,
+) {
+  const defaultKeys = DATA_TYPE_COORDINATION_VALUE_USAGE[dataType]
+    .filter(k => (
+      Object.keys(defaultCoordinationValues).includes(k)
+      && defaultCoordinationValues[k]
+      && !Object.keys(coordinationValues).includes(k)
+    ));
+  const defaultValues = pick(defaultCoordinationValues, defaultKeys);
+  const coordinationValuesWithDefaults = {
+    ...defaultValues,
+    // The user-provided values should take precedence.
+    ...coordinationValues,
+  };
+  if (!isEqual(coordinationValues, coordinationValuesWithDefaults)) {
+    // eslint-disable-next-line max-len
+    console.warn(`Using coordination value defaults for file type ${fileType} in dataset ${datasetUid}\nBefore: ${JSON.stringify(coordinationValues)}\nAfter: ${JSON.stringify(coordinationValuesWithDefaults)}`);
+  }
+  return coordinationValuesWithDefaults;
+}
+
+/**
+ * Create a mapping from dataset ID to loader objects by data type.
+ * @param {object[]} datasets The datasets array from the view config.
+ * @param {string} configDescription The top-level description in the
+ * @param {PluginFileType[]} fileTypes
+ * @param {PluginCoordinationType[]} coordinationTypes
+ * view config.
+ * @returns {object} Mapping from dataset ID to data type to loader
+ * instance.
+ */
+export function createLoaders(datasets, configDescription, fileTypes, coordinationTypes) {
+  const result = {};
+  const dataSources = {};
+  const defaultCoordinationValues = fromEntries(
+    coordinationTypes.map(ct => ([ct.name, ct.defaultValue])),
+  );
+  datasets.forEach((dataset) => {
+    const datasetLoaders = {
+      name: dataset.name,
+      description: dataset.description || configDescription,
+      loaders: {},
+    };
+    dataset.files.forEach((file) => {
+      const {
+        url,
+        options,
+        requestInit,
+        fileType,
+        coordinationValues = {},
+      } = file;
+      const dataType = getDataTypeFromFileType(fileType, fileTypes);
+      const coordinationValuesWithDefaults = withDefaults(
+        coordinationValues,
+        dataType,
+        fileType,
+        dataset.uid,
+        defaultCoordinationValues,
+      );
+      const [DataSourceClass, LoaderClass] = getSourceAndLoaderFromFileType(fileType, fileTypes);
+      // Create _one_ DataSourceClass instance per URL. Derived loaders share this object.
+      const fileId = url || JSON.stringify(options);
+      if (!(fileId in dataSources)) {
+        dataSources[fileId] = new DataSourceClass({ url, requestInit });
+      }
+      const loader = new LoaderClass(dataSources[fileId], file);
+      if (datasetLoaders.loaders[dataType]) {
+        datasetLoaders.loaders[dataType].set(coordinationValuesWithDefaults, loader);
+      } else {
+        datasetLoaders.loaders[dataType] = new InternMap([
+          [coordinationValuesWithDefaults, loader],
+        ], JSON.stringify);
+      }
+    });
+    result[dataset.uid] = datasetLoaders;
+  });
+  return result;
+}

package/dist/VitS.js

@@ -1,117 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-/* eslint-disable camelcase */
-import React, { useEffect, useMemo } from 'react';
-import { ThemeProvider, StylesProvider, createGenerateClassName, } from '@material-ui/core/styles';
-import isEqual from 'lodash/isEqual';
-import { META_VERSION } from '@vitessce/constants-internal';
-import { muiTheme } from './shared-mui/styles';
-import { ViewConfigProvider, createViewConfigStore, AuxiliaryProvider, createAuxiliaryStore, } from './state/hooks';
-import VitessceGrid from './VitessceGrid';
-import { Warning } from './Warning';
-import CallbackPublisher from './CallbackPublisher';
-import { getComponent } from './component-registry';
-import { checkTypes, initialize, upgradeAndValidate, } from './view-config-utils';
-function logConfig(config, name) {
-    console.groupCollapsed(`🚄 Vitessce (${META_VERSION.version}) ${name}`);
-    console.info(`data:,${JSON.stringify(config)}`);
-    console.info(JSON.stringify(config, null, 2));
-    console.groupEnd();
-}
-/**
- * The Vitessce component.
- * @param {object} props
- * @param {object} props.config A Vitessce view config.
- * If the config is valid, the VitessceGrid will be rendered as a child.
- * If the config is invalid, a Warning will be rendered instead.
- * @param {number} props.rowHeight Row height for grid layout. Optional.
- * @param {number} props.height Total height for grid layout. Optional.
- * @param {string} props.theme The theme, used for styling as
- * light or dark. Optional. By default, "dark"
- * @param {function} props.onWarn A callback for warning messages. Optional.
- * @param {function} props.onConfigChange A callback for view config
- * updates. Optional.
- * @param {function} props.onLoaderChange A callback for loader
- * updates. Optional.
- * @param {boolean} props.validateOnConfigChange Whether to validate
- * against the view config schema when publishing changes. Use for debugging
- * purposes, as this may have a performance impact. By default, false.
- * @param {undefined|string} props.uid A unique identifier for this Vitessce instance,
- * for the purpose of avoiding CSS autogenerated class name conflicts. Must be valid as part
- * of a CSS class name string.
- */
-export function VitS(props) {
-    const { config, rowHeight, height, theme, onWarn, onConfigChange, onLoaderChange, validateOnConfigChange = false, onConfigUpgrade, isBounded = false, uid, } = props;
-    const generateClassName = useMemo(() => createGenerateClassName({
-        disableGlobal: false,
-        // Avoid conflicts with portal-ui MUI class names,
-        // and allow setting a UID.
-        productionPrefix: (uid ? `vit${uid}` : 'vit'),
-    }), [uid]);
-    // Process the view config and memoize the result:
-    // - Validate.
-    // - Upgrade, if legacy schema.
-    // - Validate after upgrade, if legacy schema.
-    // - Initialize (based on initStrategy).
-    const [configOrWarning, success] = useMemo(() => {
-        // If the config value is undefined, show a warning message.
-        if (!config) {
-            return [
-                {
-                    title: 'No such dataset',
-                    unformatted: 'The dataset configuration could not be found.',
-                },
-                false,
-            ];
-        }
-        // If the view config is missing a version, show a warning message.
-        if (!config.version) {
-            return [
-                {
-                    title: 'Missing version',
-                    unformatted: 'The dataset configuration is missing a version, preventing validation.',
-                },
-                false,
-            ];
-        }
-        logConfig(config, 'input view config');
-        // Check if this is a "legacy" view config.
-        const [upgradedConfig, upgradeSuccess] = upgradeAndValidate(config, onConfigUpgrade);
-        if (upgradeSuccess) {
-            logConfig(upgradedConfig, 'upgraded view config');
-            // Initialize the view config according to the initStrategy.
-            const [typeCheckSuccess, typeCheckMessage] = checkTypes(upgradedConfig);
-            if (typeCheckSuccess) {
-                try {
-                    const initializedConfig = initialize(upgradedConfig);
-                    logConfig(initializedConfig, 'initialized view config');
-                    return [initializedConfig, true];
-                }
-                catch (e) {
-                    return [
-                        {
-                            title: 'View config initialization failed.',
-                            unformatted: e.message,
-                        },
-                        false,
-                    ];
-                }
-            }
-            return [
-                {
-                    title: 'View config checks failed.',
-                    unformatted: typeCheckMessage,
-                },
-                false,
-            ];
-        }
-        return [upgradedConfig, false];
-    }, [config, onConfigUpgrade]);
-    // Emit the upgraded/initialized view config
-    // to onConfigChange if necessary.
-    useEffect(() => {
-        if (success && !isEqual(configOrWarning, config) && onConfigChange) {
-            onConfigChange(configOrWarning);
-        }
-    }, [success, config, configOrWarning, onConfigChange]);
-    return success ? (_jsx(StylesProvider, { generateClassName: generateClassName, children: _jsx(ThemeProvider, { theme: muiTheme[theme], children: _jsx(ViewConfigProvider, { createStore: createViewConfigStore, children: _jsxs(AuxiliaryProvider, { createStore: createAuxiliaryStore, children: [_jsx(VitessceGrid, { config: configOrWarning, getComponent: getComponent, rowHeight: rowHeight, height: height, theme: theme, isBounded: isBounded }), _jsx(CallbackPublisher, { onWarn: onWarn, onConfigChange: onConfigChange, onLoaderChange: onLoaderChange, validateOnConfigChange: validateOnConfigChange })] }) }) }) })) : (_jsx(StylesProvider, { generateClassName: generateClassName, children: _jsx(ThemeProvider, { theme: muiTheme[theme], children: _jsx(Warning, { ...configOrWarning }) }) }));
-}

package/dist/Vitessce.integration.test.js

@@ -1,36 +0,0 @@
-"use strict";
-/* eslint-disable max-len */
-// import React from 'react';
-// import Adapter from 'enzyme-adapter-react-16';
-// import { mount, configure } from 'enzyme';
-// import Ajv from 'ajv';
-// import expect from 'expect';
-// import Vitessce from './Vitessce';
-// import { configs } from './api';
-// import configSchema from '../schemas/config.schema.json';
-// configure({ adapter: new Adapter() });
-// describe('Vitessce.js', () => {
-//   describe('<Vitessce />', () => {
-//     it('Produces valid view config', (done) => {
-//       const config = configs['linnarsson-2018'];
-//       let updatedConfig = {};
-//       // eslint-disable-next-line no-return-assign
-//       const wrapper = mount(<Vitessce config={config} onConfigChange={c => updatedConfig = c} />);
-//       setTimeout(() => {
-//         // Simulate usage of some of the app
-//         wrapper.find('[id^="deckgl-overlay-"]').at(0).simulate('wheel', { deltaY: 1000, deltaX: 1000 });
-//         wrapper.find('[id^="deckgl-overlay-"]').at(1).simulate('wheel', { deltaY: 1000, deltaX: 1000 });
-//         wrapper.find('[id^="deckgl-overlay-"]').at(2).simulate('wheel', { deltaY: 1000, deltaX: 1000 });
-//         const validate = new Ajv().compile(configSchema);
-//         const valid = validate(updatedConfig);
-//         if (!valid) {
-//           const failureReason = JSON.stringify(validate.errors, null, 2);
-//           console.error(failureReason);
-//         }
-//         expect(valid).toEqual(true);
-//         wrapper.unmount();
-//         done();
-//       }, 20000);
-//     }).timeout(30000);
-//   });
-// });

package/dist/Vitessce.js

@@ -1,101 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-/* eslint-disable camelcase */
-import React, { useEffect, useMemo } from 'react';
-import { ThemeProvider, StylesProvider, createGenerateClassName, } from '@material-ui/core/styles';
-import isEqual from 'lodash/isEqual';
-import { muiTheme } from './shared-mui/styles';
-import { ViewConfigProvider, createViewConfigStore, AuxiliaryProvider, createAuxiliaryStore, } from './state/hooks';
-import VitessceGrid from './VitessceGrid';
-import { Warning } from './Warning';
-import CallbackPublisher from './CallbackPublisher';
-import { getComponent } from './component-registry';
-import { checkTypes, initialize, upgradeAndValidate } from './view-config-utils';
-// TODO(monorepo): figure out how to get the current package version from package.json
-// import packageJson from '../package.json';
-const packageJson = { version: 'unk' };
-const generateClassName = createGenerateClassName({
-    disableGlobal: true,
-});
-function logConfig(config, name) {
-    console.groupCollapsed(`🚄 Vitessce (${packageJson.version}) ${name}`);
-    console.info(`data:,${JSON.stringify(config)}`);
-    console.info(JSON.stringify(config, null, 2));
-    console.groupEnd();
-}
-/**
- * The Vitessce component.
- * @param {object} props
- * @param {object} props.config A Vitessce view config.
- * If the config is valid, the VitessceGrid will be rendered as a child.
- * If the config is invalid, a Warning will be rendered instead.
- * @param {number} props.rowHeight Row height for grid layout. Optional.
- * @param {number} props.height Total height for grid layout. Optional.
- * @param {string} props.theme The theme, used for styling as
- * light or dark. Optional. By default, "dark"
- * @param {function} props.onWarn A callback for warning messages. Optional.
- * @param {function} props.onConfigChange A callback for view config
- * updates. Optional.
- * @param {function} props.onLoaderChange A callback for loader
- * updates. Optional.
- * @param {boolean} props.validateOnConfigChange Whether to validate
- * against the view config schema when publishing changes. Use for debugging
- * purposes, as this may have a performance impact. By default, false.
- */
-export function Vitessce(props) {
-    const { config, rowHeight, height, theme, onWarn, onConfigChange, onLoaderChange, validateOnConfigChange = false, onConfigUpgrade, isBounded = false, } = props;
-    // Process the view config and memoize the result:
-    // - Validate.
-    // - Upgrade, if legacy schema.
-    // - Validate after upgrade, if legacy schema.
-    // - Initialize (based on initStrategy).
-    const [configOrWarning, success] = useMemo(() => {
-        // If the config value is undefined, show a warning message.
-        if (!config) {
-            return [{
-                    title: 'No such dataset',
-                    unformatted: 'The dataset configuration could not be found.',
-                }, false];
-        }
-        // If the view config is missing a version, show a warning message.
-        if (!config.version) {
-            return [{
-                    title: 'Missing version',
-                    unformatted: 'The dataset configuration is missing a version, preventing validation.',
-                }, false];
-        }
-        logConfig(config, 'input view config');
-        // Check if this is a "legacy" view config.
-        const [upgradedConfig, upgradeSuccess] = upgradeAndValidate(config, onConfigUpgrade);
-        if (upgradeSuccess) {
-            logConfig(upgradedConfig, 'upgraded view config');
-            // Initialize the view config according to the initStrategy.
-            const [typeCheckSuccess, typeCheckMessage] = checkTypes(upgradedConfig);
-            if (typeCheckSuccess) {
-                try {
-                    const initializedConfig = initialize(upgradedConfig);
-                    logConfig(initializedConfig, 'initialized view config');
-                    return [initializedConfig, true];
-                }
-                catch (e) {
-                    return [{
-                            title: 'View config initialization failed.',
-                            unformatted: e.message,
-                        }, false];
-                }
-            }
-            return [{
-                    title: 'View config checks failed.',
-                    unformatted: typeCheckMessage,
-                }, false];
-        }
-        return [upgradedConfig, false];
-    }, [config, onConfigUpgrade]);
-    // Emit the upgraded/initialized view config
-    // to onConfigChange if necessary.
-    useEffect(() => {
-        if (success && !isEqual(configOrWarning, config) && onConfigChange) {
-            onConfigChange(configOrWarning);
-        }
-    }, [success, config, configOrWarning, onConfigChange]);
-    return success ? (_jsx(StylesProvider, { generateClassName: generateClassName, children: _jsx(ThemeProvider, { theme: muiTheme[theme], children: _jsx(ViewConfigProvider, { createStore: createViewConfigStore, children: _jsxs(AuxiliaryProvider, { createStore: createAuxiliaryStore, children: [_jsx(VitessceGrid, { config: configOrWarning, getComponent: getComponent, rowHeight: rowHeight, height: height, theme: theme, isBounded: isBounded }), _jsx(CallbackPublisher, { onWarn: onWarn, onConfigChange: onConfigChange, onLoaderChange: onLoaderChange, validateOnConfigChange: validateOnConfigChange })] }) }) }) })) : (_jsx(StylesProvider, { generateClassName: generateClassName, children: _jsx(ThemeProvider, { theme: muiTheme[theme], children: _jsx(Warning, { ...configOrWarning }) }) }));
-}

package/dist/component-registry.js

@@ -1,16 +0,0 @@
-import { getPluginViewType, getPluginViewTypes } from './plugins';
-// TODO(monorepo): this code can be simplified
-const registry = {};
-export function getComponent(name) {
-    let component = registry[name];
-    if (component === undefined) {
-        component = getPluginViewType(name);
-        if (component === undefined) {
-            throw new Error(`Could not find definition for "${name}" in the core registry nor the plugin registry.`);
-        }
-    }
-    return component;
-}
-export function getViewTypes() {
-    return [...Object.keys(registry), ...getPluginViewTypes()];
-}

package/dist/data/AbstractLoader.js

@@ -1,35 +0,0 @@
-import Ajv from 'ajv';
-import { OptionsValidationError } from '../errors/index';
-import { emptySchema } from '../file-options-schemas';
-/**
- * A loader ancestor class containing a default constructor
- * and a stub for the required load() method.
- */
-export default class AbstractLoader {
-    constructor({ type, fileType, url, requestInit, options, coordinationValues, }) {
-        this.fileType = fileType;
-        this.type = type;
-        this.url = url;
-        this.requestInit = requestInit;
-        this.options = options;
-        this.coordinationValues = coordinationValues;
-        this.optionsSchema = emptySchema;
-    }
-    validateOptions() {
-        const { optionsSchema, options } = this;
-        const validate = new Ajv().compile(optionsSchema);
-        const valid = validate(options || null);
-        if (!valid) {
-            return [false, validate.errors];
-        }
-        return [true, null];
-    }
-    load() {
-        const { fileType, url, options, } = this;
-        const [optionsAreValid, optionsFailureReason] = this.validateOptions();
-        if (!optionsAreValid) {
-            return Promise.reject(new OptionsValidationError(fileType, url, options, optionsFailureReason));
-        }
-        return Promise.resolve(optionsAreValid);
-    }
-}

package/dist/data/index.js

@@ -1,3 +0,0 @@
-export { default as AbstractLoader } from './AbstractLoader';
-export { default as AbstractTwoStepLoader } from './AbstractTwoStepLoader';
-export { default as LoaderResult } from './LoaderResult';

package/dist/data/loader-registry.js

@@ -1,15 +0,0 @@
-import { getLoaderClassesForPluginFileType, } from '../plugins';
-export const fileTypeToLoaderAndSource = {};
-export function getSourceAndLoaderFromFileType(type) {
-    if (fileTypeToLoaderAndSource[type]) {
-        return fileTypeToLoaderAndSource[type];
-    }
-    const pluginFileType = getLoaderClassesForPluginFileType(type);
-    if (pluginFileType) {
-        return pluginFileType;
-    }
-    // Fallback to JSON.
-    // TODO(monorepo)
-    // return [JsonSource, JsonLoader];
-    return [null, null];
-}

package/dist/errors/OptionsValidationError.js

@@ -1,15 +0,0 @@
-import AbstractLoaderError from './AbstractLoaderError';
-export default class OptionsValidationError extends AbstractLoaderError {
-    constructor(fileType, url, options, reason) {
-        super(`Error while validating file definition options: ${fileType} from ${url}.`);
-        this.name = 'OptionsValidationError';
-        this.fileType = fileType;
-        this.url = url;
-        this.options = options;
-        this.reason = reason;
-    }
-    warnInConsole() {
-        const { options, reason, } = this;
-        console.warn('Received options\n', JSON.stringify(options, null, 2), 'JSON schema validation failure reason\n', JSON.stringify(reason, null, 2));
-    }
-}

package/dist/export-utils.js

@@ -1,70 +0,0 @@
-import Bowser from 'bowser';
-import { compressToEncodedURIComponent, decompressFromEncodedURIComponent } from 'lz-string';
-const CURRENT_VERSION = '0.0.1';
-const VITESSCE_CONF_QUERY_STRING = 'vitessce_conf';
-const VERSION_QUERY_STRING = 'vitessce_conf_version';
-const LENGTH_QUERY_STRING = 'vitessce_conf_length';
-function sniffBrowser() {
-    const { browser } = Bowser.parse(window.navigator.userAgent);
-    return browser.name;
-}
-// https://stackoverflow.com/questions/417142/what-is-the-maximum-length-of-a-url-in-different-browsers
-const MAX_BROWSER_URL_LENGTHS = {
-    Chrome: 32779,
-    'Internet Explorer': 2047,
-    Edge: 2047,
-    Safari: 65000,
-    Firefox: 65000,
-};
-export default class CompressedConfLengthError {
-    constructor(message) {
-        this.message = message;
-    }
-}
-/**
- * Encode a configuration as url params with a version and an lz-compressed conf.
- * @param {Object} params
- * @param {Object} params.conf Previous scope names.
- * @param {function} params.onOverMaximumUrlLength Callback for when new url
- * is over max length for your browser - takes two arguments: { message, willWorkOn }
- * for the error message and the browsers for which the url will work (optional).
- * @returns {string} The new params like
- * vitessce_conf_length=10&vitessce_conf_version=0.0.1&vitessce_conf=fksdfasdfjkl
- */
-export function encodeConfInUrl({ conf, onOverMaximumUrlLength = () => { }, }) {
-    const compressedConf = compressToEncodedURIComponent(JSON.stringify(conf));
-    const newParams = `${LENGTH_QUERY_STRING}=${compressedConf.length}&${VERSION_QUERY_STRING}=${CURRENT_VERSION}&${VITESSCE_CONF_QUERY_STRING}=${compressedConf}`;
-    const browser = sniffBrowser();
-    const maxLength = MAX_BROWSER_URL_LENGTHS[browser];
-    if (newParams.length > maxLength) {
-        const willWorkOn = Object.entries(MAX_BROWSER_URL_LENGTHS)
-            .filter(entry => entry[1] > newParams.length)
-            .map(entry => entry[0]);
-        const message = `Configuration is ${compressedConf.length} characters; max URL for ${browser} is ${maxLength}: it will work on ${willWorkOn.join(', ') || 'no browser'}.`;
-        console.error(message);
-        onOverMaximumUrlLength({ message, willWorkOn });
-    }
-    return newParams;
-}
-/**
- * Decode URL params to a Vitessce configuration.
- * The URL params must have version and vitessce_conf params,
- * like vitessce_conf_length=10&vitessce_conf_version=0.0.1&vitessce_conf=fksdfasdfjkl.
- * @param {Object} queryString The URL params,
- * like vitessce_conf_length=10&vitessce_conf_version=0.0.1&vitessce_conf=fksdfasdfjkl.
- * @returns {string} A vitessce configuration.
- */
-export function decodeURLParamsToConf(queryString) {
-    const params = new URLSearchParams(queryString.replace('#', '&'));
-    const compressedConfString = params.get(VITESSCE_CONF_QUERY_STRING);
-    const expectedConfLength = Number(params.get(LENGTH_QUERY_STRING));
-    if (expectedConfLength !== compressedConfString.length) {
-        throw new CompressedConfLengthError(`Compressed conf length (${compressedConfString.length}) != expected (${expectedConfLength}). URL truncated?`);
-    }
-    const version = params.get(VERSION_QUERY_STRING);
-    if (version === CURRENT_VERSION) {
-        const conf = JSON.parse(decompressFromEncodedURIComponent(compressedConfString));
-        return conf;
-    }
-    throw new Error('Unrecognized URL Param Version');
-}

package/dist/export-utils.test.js

@@ -1,66 +0,0 @@
-import expect from 'expect';
-import { encodeConfInUrl, decodeURLParamsToConf, } from './export-utils';
-const fakeConfig = {
-    version: '0.1.0',
-    public: false,
-    layers: [
-        {
-            name: 'cells',
-            type: 'CELLS',
-            fileType: 'cells.json',
-            url: 'http://example.com/cells.json',
-        },
-    ],
-    name: 'Just scatterplot',
-    staticLayout: [
-        {
-            component: 'scatterplot',
-            props: {
-                mapping: 't-SNE',
-                view: {
-                    zoom: 0.75,
-                    target: [0, 0, 0],
-                },
-            },
-            x: 0,
-            y: 0,
-            w: 12,
-            h: 2,
-        },
-    ],
-};
-function makeLongString(length) {
-    let result = '';
-    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-    const charactersLength = characters.length;
-    // eslint-disable-next-line no-plusplus
-    for (let i = 0; i < length; i++) {
-        result += characters.charAt(Math.floor(Math.random() * charactersLength));
-    }
-    return result;
-}
-describe('src/app/export-utils.js', () => {
-    describe('encodeConfInUrl', () => {
-        it('encodes a view config for a URL', () => {
-            const urlParams1 = encodeConfInUrl({ conf: {} });
-            expect(urlParams1).toEqual('vitessce_conf_length=5&vitessce_conf_version=0.0.1&vitessce_conf=N4XyA');
-            const urlParams2 = encodeConfInUrl({ conf: fakeConfig });
-            expect(urlParams2).toEqual('vitessce_conf_length=327&vitessce_conf_version=0.0.1&vitessce_conf=N4IgbgpgTgzglgewHYgFwgAwDoCMWMgA0IADgK4BGANnAMZoBmAhlTBMVUwJ7QxoDaoJEwC2ENCFoQqrIiAAuXEuPQBhAKIAZTQGU5DOFQgAVJSsnTWWAFYxkcslCoSAFvPklUAei8QAHqIkRli0CCJeUjIwNnYoAL4AusTCYhIAUmQw8gAEMLRM7tBBCPJyWQV0mtwIZKWogpJhJMgQSHUgeQXyRVQlciRQCCR8qKAiTCQkcEgA5hLyALQ6AHLqcmBwEADuaKAAXghhaNgA7ACsxPJMUDMQdfwYhI8YCXFxxH7HxFxfIDuoOAATMQXGhAYk4kA');
-        });
-        it('Calls onOverMaximumUrlLength for conf too long', () => {
-            let browsers;
-            // eslint-disable-next-line no-return-assign
-            const onOverMaximumUrlLength = ({ willWorkOn }) => browsers = willWorkOn;
-            encodeConfInUrl({ conf: { foo: makeLongString(69000) }, onOverMaximumUrlLength });
-            expect(browsers).toEqual([]);
-            encodeConfInUrl({ conf: { foo: makeLongString(37000) }, onOverMaximumUrlLength });
-            expect(browsers).toEqual(['Safari', 'Firefox']);
-        });
-        it('decodes a view config for a URL', () => {
-            const viewConfig1 = decodeURLParamsToConf('vitessce_conf_length=5&vitessce_conf_version=0.0.1&vitessce_conf=N4XyA');
-            expect(viewConfig1).toEqual({});
-            const viewConfig2 = decodeURLParamsToConf('vitessce_conf_length=327&vitessce_conf_version=0.0.1&vitessce_conf=N4IgbgpgTgzglgewHYgFwgAwDoCMWMgA0IADgK4BGANnAMZoBmAhlTBMVUwJ7QxoDaoJEwC2ENCFoQqrIiAAuXEuPQBhAKIAZTQGU5DOFQgAVJSsnTWWAFYxkcslCoSAFvPklUAei8QAHqIkRli0CCJeUjIwNnYoAL4AusTCYhIAUmQw8gAEMLRM7tBBCPJyWQV0mtwIZKWogpJhJMgQSHUgeQXyRVQlciRQCCR8qKAiTCQkcEgA5hLyALQ6AHLqcmBwEADuaKAAXghhaNgA7ACsxPJMUDMQdfwYhI8YCXFxxH7HxFxfIDuoOAATMQXGhAYk4kA');
-            expect(viewConfig2).toEqual(fakeConfig);
-        });
-    });
-});