@aics/vole-app 2.14.0 → 3.1.1

package/es/aics-image-viewer/state/util.js

@@ -0,0 +1,71 @@
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+import { RenderMode, ViewMode } from "../shared/enums";
+
+// TODO move back to a new `types` module (?)
+
+var isRecord = function isRecord(val) {
+  return _typeof(val) === "object" && val !== null && !Array.isArray(val);
+};
+var VIEWER_SETTINGS_CHANGE_HANDLERS = {
+  // Do not allow path trace render mode in 2D view modes
+  viewMode: function viewMode(_viewMode, _ref) {
+    var renderMode = _ref.renderMode;
+    var switchToVolumetric = _viewMode !== ViewMode.threeD && renderMode === RenderMode.pathTrace;
+    return {
+      viewMode: _viewMode,
+      renderMode: switchToVolumetric ? RenderMode.volumetric : renderMode
+    };
+  },
+  // Don't switch to path trace rendering in any view mode other than 3d; if we do switch, turn off autorotate
+  renderMode: function renderMode(_renderMode, _ref2) {
+    var viewMode = _ref2.viewMode,
+      autorotate = _ref2.autorotate;
+    var willPathtrace = _renderMode === RenderMode.pathTrace;
+    if (willPathtrace && viewMode !== ViewMode.threeD) {
+      return {};
+    }
+    return {
+      renderMode: _renderMode,
+      autorotate: autorotate && !willPathtrace
+    };
+  },
+  // Do not allow autorotate while in pathtrace mode (button should be disabled, but this provides extra security)
+  autorotate: function autorotate(_autorotate, _ref3) {
+    var renderMode = _ref3.renderMode;
+    return {
+      autorotate: _autorotate && renderMode !== RenderMode.pathTrace
+    };
+  }
+};
+
+/**
+ * Accepts a `key` and a new (potentially partial) `value` for a single field of `ViewerState`, & returns a fragment of
+ * `ViewerState` that can safely be merged into `currentState` to apply that value without creating an illegal state.
+ */
+export var validateStateValue = function validateStateValue(currentState, key, value) {
+  var changeHandler = VIEWER_SETTINGS_CHANGE_HANDLERS[key];
+  if (changeHandler) {
+    // some settings have custom change handlers to avoid creating illegal states; if this one has one, call it
+    return changeHandler(value, currentState);
+  } else {
+    // if not, merge the new value to the current one (if applicable) and return
+    var currentValue = currentState[key];
+    var nextValue = isRecord(currentValue) && isRecord(value) ? _objectSpread(_objectSpread({}, currentValue), value) : value;
+    return _defineProperty({}, key, nextValue);
+  }
+};
+
+/** Ensures a fragment of `ViewerState` can be safely merged into `currentState` without creating an illegal state. */
+export var validateState = function validateState(currentState, newState) {
+  var validated = {};
+  for (var _i = 0, _arr = Object.keys(newState); _i < _arr.length; _i++) {
+    var key = _arr[_i];
+    Object.assign(validated, validateStateValue(currentState, key, newState[key]));
+  }
+  return validated;
+};

package/es/index.js

@@ -1,5 +1,5 @@
-import { parseViewerUrlParams } from "./aics-image-viewer/shared/utils/urlParsing";
 import ImageViewerApp from "./aics-image-viewer/components/App";
-import ViewerStateProvider from "./aics-image-viewer/components/ViewerStateProvider";
+export { addViewerParamsFromMessage, parseViewerUrlParams } from "./aics-image-viewer/shared/utils/urlParsing";
+export { writeMetadata, writeScenes } from "./aics-image-viewer/shared/utils/storage";
 export { ViewMode, RenderMode, ImageType } from "./aics-image-viewer/shared/enums";
-export { ImageViewerApp, ViewerStateProvider, parseViewerUrlParams };
+export { ImageViewerApp };

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@aics/vole-app",
-  "version": "2.14.0",
+  "version": "3.1.1",
   "description": "web view of cell volume images",
-  "repository": "github:allen-cell-animated/vole-app",
   "main": "es/index.js",
   "module": "es/index.js",
   "browser": "es/index.js",
@@ -17,6 +16,10 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/allen-cell-animated/vole-app.git"
+  },
   "scripts": {
     "start": "webpack serve --config webpack.dev.js  --env env=dev",
     "gh-build-nightly": "webpack --config webpack.dev.js --env env=production basename=/vole-app/",
@@ -36,12 +39,13 @@
     "postpublish-patch": "git push origin main",
     "prepare": "cross-env DEPLOYMENT_ENV=production npm run build",
     "predeploy": "cross-env DEPLOYMENT_ENV=production npm run dev",
-    "deploy": "gh-pages -d imageviewer -t true"
+    "deploy": "gh-pages -d imageviewer -t true",
+    "checks": "npm run lint && npm run typeCheck && npm run test"
   },
   "author": "Megan Riel-Mehan",
   "license": "ISC",
   "dependencies": {
-    "@aics/vole-core": "^4.1.0",
+    "@aics/vole-core": "^4.5.0",
     "@ant-design/icons": "^5.2.5",
     "@fortawesome/fontawesome-svg-core": "^6.5.2",
     "@fortawesome/free-solid-svg-icons": "^6.5.2",
@@ -54,7 +58,9 @@
     "react-color": "^2.19.3",
     "react-router-dom": "^6.26.2",
     "styled-components": "^6.1.13",
-    "usehooks-ts": "^3.1.0"
+    "usehooks-ts": "^3.1.0",
+    "uuid": "^13.0.0",
+    "zustand": "^5.0.6"
   },
   "peerDependencies": {
     "antd": "^5.16.2",
@@ -73,14 +79,14 @@
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/color-string": "^1.5.2",
     "@types/d3": "^7.4.3",
-    "@types/jest": "^27.4.0",
+    "@types/jest": "^29.5.14",
     "@types/lodash": "^4.14.185",
     "@types/react": "^18.x",
     "@types/react-color": "^3.0.12",
     "@types/react-dom": "^18.x",
     "@types/three": "^0.171.0",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.2",
+    "@typescript-eslint/parser": "^8.46.2",
     "antd": "^5.16.2",
     "axios": "^0.21.1",
     "babel-loader": "^8.2.2",
@@ -99,7 +105,8 @@
     "firebase": "^7.x",
     "gh-pages": "^4.0.0",
     "html-webpack-plugin": "^5.3.2",
-    "jest": "^27.0.6",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^30.2.0",
     "mini-css-extract-plugin": "^2.9.1",
     "morgan": "^1.9.1",
     "npm-run-all": "^4.1.5",
@@ -119,8 +126,8 @@
     "react-dom": "^18.3.1",
     "resolve-url-loader": "^5.0.0",
     "style-loader": "^4.0.0",
-    "ts-jest": "^27.1.2",
-    "typescript": "^4.3.5",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3",
     "url-loader": "^4.1.1",
     "webpack": "^5.89.0",
     "webpack-cli": "^4.7.2",

package/type-declarations/aics-image-viewer/components/App/ChannelUpdater.d.ts

@@ -1,9 +1,7 @@
-import { View3d, Volume } from "@aics/vole-core";
-import React from "react";
-import { ChannelState } from "../ViewerStateProvider/types";
+import { type View3d, type Volume } from "@aics/vole-core";
+import type React from "react";
 interface ChannelUpdaterProps {
     index: number;
-    channelState: ChannelState;
     view3d: View3d;
     image: Volume | null;
     version: number;

package/type-declarations/aics-image-viewer/components/App/types.d.ts

@@ -1,8 +1,8 @@
 import type { RawArrayData, RawArrayInfo, View3d, Volume } from "@aics/vole-core";
-import { MutableRefObject } from "react";
+import type { MutableRefObject } from "react";
 import type { MetadataRecord } from "../../shared/types";
 import type { ViewerChannelSettings } from "../../shared/utils/viewerChannelSettings";
-import type { ViewerState } from "../ViewerStateProvider/types";
+import type { ViewerState } from "../../state/types";
 /** `typeof useEffect`, but the effect handler takes a `Volume` as an argument */
 export type UseImageEffectType = (effect: (image: Volume) => void | (() => void), deps: React.DependencyList) => void;
 type ControlNames = "alphaMaskSlider" | "autoRotateButton" | "axisClipSliders" | "brightnessSlider" | "backgroundColorPicker" | "boundingBoxColorPicker" | "colorPresetsDropdown" | "densitySlider" | "levelsSliders" | "interpolationControl" | "saveSurfaceButtons" | "fovCellSwitchControls" | "viewModeRadioButtons" | "resetCameraButton" | "showAxesButton" | "showBoundingBoxButton" | "metadataViewer";
@@ -37,7 +37,7 @@ export interface AppProps {
         translation: [number, number, number];
         rotation: [number, number, number];
     };
-    metadata?: MetadataRecord | MetadataRecord[];
+    metadata?: MetadataRecord | (MetadataRecord | undefined)[];
     view3dRef?: MutableRefObject<View3d | null>;
     metadataFormatter?: (metadata: MetadataRecord) => MetadataRecord;
     onControlPanelToggle?: (collapsed: boolean) => void;

package/type-declarations/aics-image-viewer/components/AxisClipSliders/index.d.ts

@@ -1,14 +1,14 @@
-import { Volume } from "@aics/vole-core";
+import type { Volume } from "@aics/vole-core";
 import React from "react";
-import { ViewMode } from "../../shared/enums";
-import { AxisName, PerAxis } from "../../shared/types";
-import PlayControls from "../../shared/utils/playControls";
-import { ViewerSettingUpdater } from "../ViewerStateProvider/types";
+import type { ViewMode } from "../../shared/enums";
+import { type AxisName, type PerAxis } from "../../shared/types";
+import type PlayControls from "../../shared/utils/playControls";
+import type { ViewerStateActions } from "../../state/store";
 import "./styles.css";
 type AxisClipSlidersProps = {
     mode: ViewMode;
     image: Volume | null;
-    changeViewerSetting: ViewerSettingUpdater;
+    changeViewerSetting: ViewerStateActions["changeViewerSetting"];
     numSlices: PerAxis<number>;
     numSlicesLoaded: PerAxis<number>;
     numScenes: number;

package/type-declarations/aics-image-viewer/components/CellViewerCanvasWrapper/index.d.ts

@@ -1,9 +1,7 @@
-import { View3d, Volume } from "@aics/vole-core";
+import type { View3d, Volume } from "@aics/vole-core";
 import React from "react";
-import { ViewMode } from "../../shared/enums";
-import { AxisName, PerAxis } from "../../shared/types";
-import PlayControls from "../../shared/utils/playControls";
-import { ViewerSettingUpdater } from "../ViewerStateProvider/types";
+import type { AxisName, PerAxis } from "../../shared/types";
+import type PlayControls from "../../shared/utils/playControls";
 import "./styles.css";
 type ViewerWrapperProps = {
     view3d: View3d;
@@ -21,13 +19,6 @@ type ViewerWrapperProps = {
     };
     clippingPanelOpen?: boolean;
     onClippingPanelOpenChange?: (visible: boolean) => void;
-    autorotate: boolean;
-    viewMode: ViewMode;
-    region: PerAxis<[number, number]>;
-    slice: PerAxis<number>;
-    time: number;
-    scene: number;
-    changeViewerSetting: ViewerSettingUpdater;
 };
-declare const _default: React.FC<Omit<ViewerWrapperProps, "viewMode" | "autorotate" | "region" | "slice" | "time" | "scene" | "changeViewerSetting">>;
-export default _default;
+declare const ViewerWrapper: React.FC<ViewerWrapperProps>;
+export default ViewerWrapper;

package/type-declarations/aics-image-viewer/components/ChannelsWidget.d.ts

@@ -1,9 +1,8 @@
-import { Channel } from "@aics/vole-core";
+import type { Channel } from "@aics/vole-core";
 import React from "react";
 import type { IsosurfaceFormat } from "../shared/types";
 import type { ColorArray, ColorObject } from "../shared/utils/colorRepresentations";
 import type { ChannelGrouping, ViewerChannelSettings } from "../shared/utils/viewerChannelSettings";
-import type { ChannelSettingUpdater, ChannelState } from "./ViewerStateProvider/types";
 export type ChannelsWidgetProps = {
     channelDataChannels: Channel[] | undefined;
     channelGroupedByType: ChannelGrouping;
@@ -12,8 +11,6 @@ export type ChannelsWidgetProps = {
     onApplyColorPresets: (presets: ColorArray[]) => void;
     filterFunc?: (key: string) => boolean;
     onColorChangeComplete?: (newRGB: ColorObject, oldRGB?: ColorObject, index?: number) => void;
-    channelSettings: ChannelState[];
-    changeChannelSetting: ChannelSettingUpdater;
 };
-declare const _default: React.FC<Omit<ChannelsWidgetProps, "channelSettings" | "changeChannelSetting">>;
-export default _default;
+declare const ChannelsWidget: React.FC<ChannelsWidgetProps>;
+export default ChannelsWidget;

package/type-declarations/aics-image-viewer/components/ChannelsWidgetRow/index.d.ts

@@ -1,15 +1,12 @@
-import { Channel } from "@aics/vole-core";
+import type { Channel } from "@aics/vole-core";
 import React from "react";
-import { IsosurfaceFormat } from "../../shared/types";
-import { ColorObject } from "../../shared/utils/colorRepresentations";
-import { type ChannelSettingUpdater, type ChannelState } from "../ViewerStateProvider/types";
+import type { IsosurfaceFormat } from "../../shared/types";
+import { type ColorObject } from "../../shared/utils/colorRepresentations";
 import "./styles.css";
 interface ChannelsWidgetRowProps {
     index: number;
     name: string;
-    channelState: ChannelState;
     channelDataForChannel: Channel;
-    changeChannelSetting: ChannelSettingUpdater;
     saveIsosurface: (channelIndex: number, type: IsosurfaceFormat) => void;
     onColorChangeComplete?: (newRGB: ColorObject, oldRGB?: ColorObject, index?: number) => void;
 }

package/type-declarations/aics-image-viewer/components/ColorPicker.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { ColorObject } from "../shared/utils/colorRepresentations";
+import type { ColorObject } from "../shared/utils/colorRepresentations";
 type ColorChangeHandler = (currentColor: ColorObject, prevColor?: ColorObject, idx?: number) => void;
 interface ColorPickerProps {
     color: ColorObject;

package/type-declarations/aics-image-viewer/components/ControlPanel/index.d.ts

@@ -1,8 +1,8 @@
 import React from "react";
-import { MetadataRecord } from "../../shared/types";
+import type { MetadataRecord } from "../../shared/types";
 import ChannelsWidget from "../ChannelsWidget";
-import CustomizeWidget, { CustomizeWidgetProps } from "../CustomizeWidget";
-import GlobalVolumeControls, { GlobalVolumeControlsProps } from "../GlobalVolumeControls";
+import CustomizeWidget, { type CustomizeWidgetProps } from "../CustomizeWidget";
+import GlobalVolumeControls, { type GlobalVolumeControlsProps } from "../GlobalVolumeControls";
 import "./styles.css";
 type PropsOf<T> = T extends React.ComponentType<infer P> ? P : never;
 interface ControlPanelProps extends PropsOf<typeof ChannelsWidget>, PropsOf<typeof GlobalVolumeControls>, PropsOf<typeof CustomizeWidget> {
@@ -11,10 +11,9 @@ interface ControlPanelProps extends PropsOf<typeof ChannelsWidget>, PropsOf<type
         colorPresetsDropdown: boolean;
         metadataViewer: boolean;
     };
-    getMetadata: () => MetadataRecord;
+    metadata: MetadataRecord;
     collapsed: boolean;
     setCollapsed: (value: boolean) => void;
-    resetToDefaultViewerState: () => void;
 }
-declare const _default: React.FC<Omit<ControlPanelProps, "resetToDefaultViewerState">>;
-export default _default;
+declare function ControlPanel(props: ControlPanelProps): React.ReactElement;
+export default ControlPanel;

package/type-declarations/aics-image-viewer/components/CustomizeWidget.d.ts

@@ -1,15 +1,9 @@
 import React from "react";
-import { ColorArray } from "../shared/utils/colorRepresentations";
-import { ViewerSettingUpdater } from "./ViewerStateProvider/types";
 export interface CustomizeWidgetProps {
     visibleControls: {
         backgroundColorPicker: boolean;
         boundingBoxColorPicker: boolean;
     };
-    showBoundingBox: boolean;
-    backgroundColor: ColorArray;
-    boundingBoxColor: ColorArray;
-    changeViewerSetting: ViewerSettingUpdater;
 }
-declare const _default: React.FC<Omit<CustomizeWidgetProps, "showBoundingBox" | "boundingBoxColor" | "backgroundColor" | "changeViewerSetting">>;
-export default _default;
+declare const CustomizeWidget: React.FC<CustomizeWidgetProps>;
+export default CustomizeWidget;

package/type-declarations/aics-image-viewer/components/ErrorAlert/index.d.ts

@@ -1,5 +1,9 @@
 import React from "react";
 import "./styles.css";
+export type ErrorAlertDescription = {
+    title: string;
+    description: React.ReactNode;
+};
 export type ErrorAlertProps = {
     errors: unknown;
     /** The number of times we've seen an error of the type that is currently being displayed before */

package/type-declarations/aics-image-viewer/components/GlobalVolumeControls.d.ts

@@ -1,5 +1,4 @@
 import React from "react";
-import { ViewerSettingUpdater } from "./ViewerStateProvider/types";
 export interface GlobalVolumeControlsProps {
     imageName: string | undefined;
     pixelSize: [number, number, number];
@@ -10,12 +9,6 @@ export interface GlobalVolumeControlsProps {
         levelsSliders: boolean;
         interpolationControl: boolean;
     };
-    maskAlpha: number;
-    brightness: number;
-    density: number;
-    levels: [number, number, number];
-    interpolationEnabled: boolean;
-    changeViewerSetting: ViewerSettingUpdater;
 }
-declare const _default: React.FC<Omit<GlobalVolumeControlsProps, "maskAlpha" | "brightness" | "density" | "levels" | "interpolationEnabled" | "changeViewerSetting">>;
-export default _default;
+declare const GlobalVolumeControls: React.FC<GlobalVolumeControlsProps>;
+export default GlobalVolumeControls;

package/type-declarations/aics-image-viewer/components/MetadataViewer/index.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { MetadataRecord } from "../../shared/types";
+import type { MetadataRecord } from "../../shared/types";
 import "./styles.css";
 declare const MetadataViewer: React.FC<{
     metadata: MetadataRecord;

package/type-declarations/aics-image-viewer/components/StyleProvider/index.d.ts

@@ -1,4 +1,4 @@
-import { PropsWithChildren, ReactElement } from "react";
+import type { PropsWithChildren, ReactElement } from "react";
 /**
  * Provides CSS variables and global styling for the image viewer.
  */

package/type-declarations/aics-image-viewer/components/TfEditor/index.d.ts

@@ -1,21 +1,28 @@
-import { Channel, ControlPoint } from "@aics/vole-core";
+import { type Channel, type ControlPoint } from "@aics/vole-core";
 import "nouislider/distribute/nouislider.css";
 import React from "react";
-import type { SingleChannelSettingUpdater } from "../ViewerStateProvider/types";
+import type { IsosurfaceFormat } from "../../shared/types";
+import type { ChannelState } from "../../state/types";
 import "./styles.css";
 type TfEditorProps = {
     id: string;
     width: number;
     height: number;
     channelData: Channel;
-    changeChannelSetting: SingleChannelSettingUpdater;
+    changeChannelSetting: (value: Partial<ChannelState>) => void;
+    volumeEnabled: boolean;
+    isosurfaceEnabled: boolean;
     colorizeEnabled: boolean;
     colorizeAlpha: number;
     useControlPoints: boolean;
     controlPoints: ControlPoint[];
     ramp: [number, number];
+    isovalue: number;
+    opacity: number;
     plotMin: number;
     plotMax: number;
+    keepIntensityRange: boolean;
+    saveIsosurface: (format: IsosurfaceFormat) => void;
 };
 declare const TfEditor: React.FC<TfEditorProps>;
 export default TfEditor;

package/type-declarations/aics-image-viewer/components/Toolbar/index.d.ts

@@ -1,6 +1,4 @@
 import React from "react";
-import { ImageType, RenderMode, ViewMode } from "../../shared/enums";
-import { ViewerSettingUpdater } from "../ViewerStateProvider/types";
 import "./styles.css";
 type ToolbarProps = {
     cellDownloadHref: string;
@@ -10,6 +8,7 @@ type ToolbarProps = {
     canPathTrace: boolean;
     resetCamera: () => void;
     downloadScreenshot: () => void;
+    resetToSavedViewerState: () => void;
     visibleControls: {
         autoRotateButton: boolean;
         viewModeRadioButtons: boolean;
@@ -18,14 +17,6 @@ type ToolbarProps = {
         showAxesButton: boolean;
         showBoundingBoxButton: boolean;
     };
-    imageType: ImageType;
-    renderMode: RenderMode;
-    viewMode: ViewMode;
-    autorotate: boolean;
-    showAxes: boolean;
-    showBoundingBox: boolean;
-    changeViewerSetting: ViewerSettingUpdater;
-    resetToSavedViewerState: () => void;
 };
-declare const _default: React.FC<Omit<ToolbarProps, "viewMode" | "renderMode" | "imageType" | "showAxes" | "showBoundingBox" | "autorotate" | "resetToSavedViewerState" | "changeViewerSetting">>;
-export default _default;
+declare const Toolbar: React.FC<ToolbarProps>;
+export default Toolbar;

package/type-declarations/aics-image-viewer/components/shared/SliderRow/index.d.ts

@@ -1,11 +1,12 @@
+import type { NouisliderProps } from "nouislider-react";
 import React from "react";
-import { NouisliderProps } from "nouislider-react";
 import "./styles.css";
 type SliderRowProps = {
     label: React.ReactNode;
     start?: number | number[];
     step?: number;
     formatInteger?: boolean;
+    min?: number;
     max?: number;
     onUpdate?: NouisliderProps["onUpdate"];
     onChange?: NouisliderProps["onChange"];

package/type-declarations/aics-image-viewer/components/shared/SmarterSlider.d.ts

@@ -1,5 +1,5 @@
+import { type NouisliderProps } from "nouislider-react";
 import React from "react";
-import { NouisliderProps } from "nouislider-react";
 /** A wrapper around `Nouislider` that prevents updates while the slider is being dragged. */
 declare const SmarterSlider: React.FC<NouisliderProps>;
 export default SmarterSlider;

package/type-declarations/aics-image-viewer/components/shared/ViewerIcon.d.ts

@@ -1,5 +1,5 @@
+import type { IconComponentProps } from "@ant-design/icons/lib/components/Icon";
 import React from "react";
-import { IconComponentProps } from "@ant-design/icons/lib/components/Icon";
 import ICONS from "../../assets/icons";
 type ViewerIconProps = {
     type: keyof typeof ICONS;

package/type-declarations/aics-image-viewer/components/useVolume.d.ts

@@ -1,10 +1,13 @@
-import { RawArrayLoaderOptions, View3d, Volume } from "@aics/vole-core";
-import { AxisName } from "../shared/types";
+import { type RawArrayLoaderOptions, type View3d, type Volume } from "@aics/vole-core";
+import type { AxisName } from "../shared/types";
 import PlayControls from "../shared/utils/playControls";
-import { ChannelGrouping } from "../shared/utils/viewerChannelSettings";
+import type { ChannelGrouping, ViewerChannelSettings } from "../shared/utils/viewerChannelSettings";
 export type UseVolumeOptions = {
-    /** Callback for when the volume is created. */
+    viewerChannelSettings?: ViewerChannelSettings;
+    /** Callback called just once when the volume is created. */
     onCreateImage?: (image: Volume) => void;
+    /** Callback called on any scene change, including the initial image load. */
+    onChangeScene?: (image: Volume, sceneIndex: number) => void;
     /** Callback for when a single channel of the volume has loaded. */
     onChannelLoaded?: (image: Volume, channelIndex: number, isInitialLoad: boolean) => void;
     /** Callback for when image loading encounters an error. */

package/type-declarations/aics-image-viewer/shared/constants.d.ts

@@ -1,11 +1,11 @@
 import { type CameraState, type Channel, PrefetchDirection } from "@aics/vole-core";
-import { ChannelState, ViewerState } from "../components/ViewerStateProvider/types";
+import type { ChannelState, ViewerState } from "../state/types";
 import { ViewMode } from "./enums";
-import { AxisName } from "./types";
-import { ColorArray } from "./utils/colorRepresentations";
-import { ViewerChannelSettings } from "./utils/viewerChannelSettings";
+import type { AxisName } from "./types";
+import type { ColorArray } from "./utils/colorRepresentations";
+import type { ViewerChannelSettings } from "./utils/viewerChannelSettings";
 export declare const // Control panel will automatically close if viewport is less than this width
-CONTROL_PANEL_CLOSE_WIDTH = 970, CLIPPING_PANEL_HEIGHT_DEFAULT = 200, CLIPPING_PANEL_HEIGHT_TALL = 235, BACKGROUND_COLOR_DEFAULT: ColorArray, BOUNDING_BOX_COLOR_DEFAULT: ColorArray, AXIS_MARGIN_DEFAULT: [number, number], SCALE_BAR_MARGIN_DEFAULT: [number, number], LUT_MIN_PERCENTILE = 0.5, LUT_MAX_PERCENTILE = 0.983, ISOSURFACE_OPACITY_SLIDER_MAX = 255, ALPHA_MASK_SLIDER_DEFAULT = 0, BRIGHTNESS_SLIDER_LEVEL_DEFAULT = 70, DENSITY_SLIDER_LEVEL_DEFAULT = 50, LEVELS_SLIDER_DEFAULT: ColorArray, INTERPOLATION_ENABLED_DEFAULT = true, OTHER_CHANNEL_KEY = "Other", SINGLE_GROUP_CHANNEL_KEY = "Channels";
+CONTROL_PANEL_CLOSE_WIDTH = 970, CLIPPING_PANEL_HEIGHT_DEFAULT = 200, CLIPPING_PANEL_HEIGHT_TALL = 235, BACKGROUND_COLOR_DEFAULT: ColorArray, BOUNDING_BOX_COLOR_DEFAULT: ColorArray, AXIS_MARGIN_DEFAULT: [number, number], SCALE_BAR_MARGIN_DEFAULT: [number, number], LUT_MIN_PERCENTILE = 0.5, LUT_MAX_PERCENTILE = 0.983, ALPHA_MASK_SLIDER_DEFAULT = 0, BRIGHTNESS_SLIDER_LEVEL_DEFAULT = 70, DENSITY_SLIDER_LEVEL_DEFAULT = 50, LEVELS_SLIDER_DEFAULT: ColorArray, INTERPOLATION_ENABLED_DEFAULT = true, OTHER_CHANNEL_KEY = "Other", SINGLE_GROUP_CHANNEL_KEY = "Channels";
 export declare const TFEDITOR_DEFAULT_COLOR: ColorArray;
 export declare const TFEDITOR_MAX_BIN = 255;
 export declare const CACHE_MAX_SIZE = 1000000000;

package/type-declarations/aics-image-viewer/shared/types.d.ts

@@ -1,4 +1,4 @@
-import { CSSProperties } from "react";
+import type { CSSProperties } from "react";
 import { ViewMode } from "./enums";
 export type AxisName = "x" | "y" | "z";
 export type PerAxis<T> = Record<AxisName, T>;

package/type-declarations/aics-image-viewer/shared/utils/controlPointsToLut.d.ts

@@ -1,6 +1,12 @@
-import { Channel, ControlPoint, Histogram, Lut, Volume } from "@aics/vole-core";
-import { ViewerChannelSetting, ViewerChannelSettings } from "./viewerChannelSettings";
-export declare function controlPointsToLut(controlPoints: ControlPoint[]): Lut;
+import { type ControlPoint, type Histogram, Lut, type Volume } from "@aics/vole-core";
+import { type ViewerChannelSetting, type ViewerChannelSettings } from "./viewerChannelSettings";
+/**
+ * @param {Object[]} controlPoints - array of `{x:number, opacity:number,
+ * color:string}`, where `x` is a histogram bin index.
+ * @returns {Uint8Array} array of length 256*4 representing the rgba values of
+ * the gradient
+ */
+export declare function binIndexedControlPointsToLut(controlPoints: ControlPoint[]): Lut;
 /** Returns a default lookup table based on a min/max percentile of the current volume's data. */
 export declare function getDefaultLut(histogram: Histogram): Lut;
 /**
@@ -54,5 +60,3 @@ export declare function initializeLut(aimg: Volume, channelIndex: number, channe
 };
 export declare function controlPointsToRamp(controlPoints: ControlPoint[]): [number, number];
 export declare function rampToControlPoints([min, max]: [number, number]): ControlPoint[];
-/** Remaps an array of control points from an old range (as a 2-tuple) to a new one (extracted from a `Channel`) */
-export declare function remapControlPointsForChannel(controlPoints: ControlPoint[], oldRange: [number, number] | undefined, { rawMin, rawMax }: Channel): ControlPoint[];

package/type-declarations/aics-image-viewer/shared/utils/firebase/index.d.ts

@@ -1,4 +1,4 @@
-import { DocumentData, FirebaseFirestore } from "@firebase/firestore-types";
+import type { DocumentData, FirebaseFirestore } from "@firebase/firestore-types";
 export interface DatasetMetaData {
     name: string;
     version: string;

package/type-declarations/aics-image-viewer/shared/utils/hooks.d.ts

@@ -1,4 +1,4 @@
-import { MutableRefObject } from "react";
+import { type MutableRefObject } from "react";
 /**
  * Wraps a setter function and keeps a ref updated to follow the set value. Useful for making the most up-to-date value
  * of some state accessible to a closure that might be called after the value is updated.

package/type-declarations/aics-image-viewer/shared/utils/playControls.d.ts

@@ -1,4 +1,4 @@
-import { AxisName } from "../types";
+import type { AxisName } from "../types";
 type PlayAxisName = AxisName | "t";
 export default class PlayControls {
     playingAxis: PlayAxisName | null;

package/type-declarations/aics-image-viewer/shared/utils/sceneStore.d.ts

@@ -1,5 +1,9 @@
-import { LoadSpec, PerChannelCallback, PrefetchDirection, RawArrayLoaderOptions, Volume, VolumeLoaderContext } from "@aics/vole-core";
-import { ThreadableVolumeLoader } from "@aics/vole-core/es/types/loaders/IVolumeLoader";
+import type { LoadSpec, PrefetchDirection, RawArrayLoaderOptions, Volume, VolumeLoaderContext } from "@aics/vole-core";
+import type { ThreadableVolumeLoader } from "@aics/vole-core/es/types/loaders/IVolumeLoader";
+export type LoadSceneOptions = {
+    onCreateScene?: (volume: Volume, sceneIndex: number) => void;
+    onChannelLoaded?: (volume: Volume, channelIndex: number) => void;
+};
 export default class SceneStore {
     context: VolumeLoaderContext;
     loaders: (ThreadableVolumeLoader | undefined)[];
@@ -10,8 +14,8 @@ export default class SceneStore {
     constructor(context: VolumeLoaderContext, paths: (string | string[] | RawArrayLoaderOptions)[]);
     /** Get the loader associated with the given scene index, or create it if it doesn't exist */
     private getLoader;
-    loadScene(scene: number, image: Volume, loadSpec?: LoadSpec, onChannelLoaded?: PerChannelCallback): Promise<void>;
-    createVolume(scene: number, loadSpec: LoadSpec, onChannelLoaded?: PerChannelCallback): Promise<Volume>;
+    loadScene(scene: number, image: Volume, loadSpec?: LoadSpec, options?: LoadSceneOptions): Promise<void>;
+    createVolume(scene: number, loadSpec: LoadSpec, onChannelLoaded?: (volume: Volume, channelIndex: number) => void): Promise<Volume>;
     syncMultichannelLoading(sync: boolean): void;
     setPrefetchPriority(priority: PrefetchDirection[]): void;
 }

package/type-declarations/aics-image-viewer/shared/utils/storage.d.ts

@@ -0,0 +1,15 @@
+import type { MetadataRecord } from "../types";
+/**
+ * Writes a bundle of metadata records keyed by image URL to local storage.
+ *
+ * Returns `true` if all records fit into local storage, or `false` if at least one did not.
+ */
+export declare function writeMetadata(meta: Record<string, MetadataRecord>): boolean;
+/**
+ * Writes a scene `url` to local storage at the given `key`.
+ *
+ * Returns `false` if the entry did not fit in local storage, or `true` if it did.
+ */
+export declare function writeScenes(key: string, url: string): boolean;
+export declare function readStoredMetadata(scenes: (string | string[])[], skipCacheUpdate?: boolean): (MetadataRecord | undefined)[];
+export declare function readStoredScenes(key: string, skipCacheUpdate?: boolean): string | undefined;