@aics/vole-app 3.4.4 → 3.5.0

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

@@ -1,7 +1,21 @@
 import type { CameraState, ControlPoint } from "@aics/vole-core";
-import type { ImageType, RenderMode, ViewMode } from "../shared/enums";
-import type { PerAxis } from "../shared/types";
+import type { XYZ } from "../shared/types";
 import type { ColorArray } from "../shared/utils/colorRepresentations";
+export declare enum ViewMode {
+    threeD = "3D",
+    xy = "XY",
+    xz = "XZ",
+    yz = "YZ"
+}
+export declare enum RenderMode {
+    volumetric = "volumetric",
+    maxProject = "maxproject",
+    pathTrace = "pathtrace"
+}
+export declare enum ImageType {
+    segmentedCell = "cell",
+    fullField = "fov"
+}
 /** Global (not per-channel) viewer state which may be changed in the UI */
 export type ViewerState = {
     viewMode: ViewMode;
@@ -17,8 +31,8 @@ export type ViewerState = {
     density: number;
     levels: [number, number, number];
     interpolationEnabled: boolean;
-    region: PerAxis<[number, number]>;
-    slice: PerAxis<number>;
+    region: XYZ<[number, number]>;
+    slice: XYZ<number>;
     time: number;
     scene: number;
     cameraState: Partial<CameraState> | undefined;
@@ -27,6 +41,7 @@ export type ViewerState = {
     useExactScaleLevel: boolean;
     scaleLevelIndex: number;
 };
+/** Settings for a single channel which may be changed in the UI */
 export type ChannelState = {
     name: string;
     displayName: string;
@@ -49,32 +64,43 @@ export type ChannelState = {
     keepIntensityRange: boolean;
 };
 /**
- * Enum keys for serialized viewer settings. These are stored as enums for
- * better readability, and are mapped to types in `ViewerStateParams`.
+ * The variants of `ViewMode` that appear in serialized representations of state
+ * (`ViewerStateSnapshot`, `ViewerStateStringified`).
+ *
+ * **IMPORTANT:** Changing the values of this enum will BREAK existing image sharing links and exported app state.
+ * It should not be done without introducing code to handle the previous values. This enum must not have values that
+ * collide when `toLowerCase` is applied to them.
  */
-export declare enum ViewerStateKeys {
-    View = "view",
-    Mode = "mode",
-    Mask = "mask",
-    Image = "image",
-    Axes = "axes",
-    BoundingBox = "bb",
-    BoundingBoxColor = "bbcol",
-    BackgroundColor = "bgcol",
-    Autorotate = "rot",
-    Brightness = "bright",
-    Density = "dens",
-    Levels = "lvl",
-    Interpolation = "interp",
-    Region = "reg",
-    Slice = "slice",
-    Time = "t",
-    Scene = "scene",
-    CameraState = "cam",
-    SingleChannelMode = "scm",
-    SingleChannelIndex = "sci",
-    UseExactScaleLevel = "esl",
-    ScaleLevelIndex = "scl"
+export declare enum ViewModeSnapshot {
+    threeD = "3D",
+    xy = "Z",
+    xz = "Y",
+    yz = "X"
+}
+/**
+ * The variants of `RenderMode` that appear in serialized representations of state
+ * (`ViewerStateSnapshot`, `ViewerStateStringified`).
+ *
+ * **IMPORTANT:** Changing the values of this enum will BREAK existing image sharing links and exported app state.
+ * It should not be done without introducing code to handle the previous values. This enum must not have values that
+ * collide when `toLowerCase` is applied to them.
+ */
+export declare enum RenderModeSnapshot {
+    volumetric = "volumetric",
+    maxProject = "maxproject",
+    pathTrace = "pathtrace"
+}
+/**
+ * The variants of `ImageType` that appear in serialized representations of state
+ * (`ViewerStateSnapshot`, `ViewerStateStringified`).
+ *
+ * **IMPORTANT:** Changing the values of this enum will BREAK existing image sharing links and exported app state.
+ * It should not be done without introducing code to handle the previous values. This enum must not have values that
+ * collide when `toLowerCase` is applied to them.
+ */
+export declare enum ImageTypeSnapshot {
+    segmentedCell = "cell",
+    fullField = "fov"
 }
 export declare enum CameraTransformKeys {
     /** Camera position in 3D coordinates. */
@@ -88,123 +114,114 @@ export declare enum CameraTransformKeys {
     /** Vertical FOV of the camera view frustum, from top to bottom, in degrees. */
     Fov = "fov"
 }
-/** Serialized version of `ViewerState`. */
-export declare class ViewerStateParams {
-    /** Axis to view. Valid values are "3D", "X", "Y", and "Z". Defaults to "3D". */
-    [ViewerStateKeys.View]?: string;
-    /**
-     * Render mode. Valid values are "volumetric", "maxproject", and "pathtrace".
-     * Defaults to "volumetric".
-     */
-    [ViewerStateKeys.Mode]?: string;
-    /** The opacity of the mask channel, an integer in the range [0, 100]. Defaults to 50. */
-    [ViewerStateKeys.Mask]?: string;
-    /** The type of image to display. Valid values are "cell" and "fov". Defaults to "cell". */
-    [ViewerStateKeys.Image]?: string;
-    /** Whether to show the axes helper. "1" is enabled. Disabled by default. */
-    [ViewerStateKeys.Axes]?: string;
-    /** Whether to show the bounding box. "1" is enabled. Disabled by default. */
-    [ViewerStateKeys.BoundingBox]?: string;
-    /** Whether single-channel mode is active. "1" is active. Inactive by default. */
-    [ViewerStateKeys.SingleChannelMode]?: string;
-    /** If single-channel mode is active, which channel index is shown. Defaults to 0. */
-    [ViewerStateKeys.SingleChannelIndex]?: string;
+export type CameraStateSnapshot = {
+    [CameraTransformKeys.Position]?: [number, number, number];
+    [CameraTransformKeys.Target]?: [number, number, number];
+    [CameraTransformKeys.Up]?: [number, number, number];
+    [CameraTransformKeys.OrthoScale]?: number;
+    [CameraTransformKeys.Fov]?: number;
+};
+export type CameraStateStringified = {
+    [K in CameraTransformKeys]?: string;
+};
+/**
+ * Property keys for the "snapshot" variants of `ViewerState`. These keys are shorter, for contexts that need brevity
+ * (like URLs), and have a stronger guarantee of stability than the keys of `ViewerState`.
+ *
+ * **IMPORTANT:** Changing the values of this enum will BREAK existing image sharing links and exported app state.
+ * Ideally, you should never do it. If you must, you must also add code to version-check and handle previous values.
+ */
+export declare enum ViewerStateSnapshotKeys {
+    /** Axis to view. Snapshot values are `3D`, `Z`, `Y`, `X` (from `ViewModeSnapshot`). */
+    View = "view",
+    /** Render mode. Possible values are `volumetric`, `maxproject`, or `pathtrace` (from `RenderModeSnapshot`). */
+    Mode = "mode",
+    /** The opacity of the mask channel, an integer in the range `[0, 100]`. Defaults to `50`. */
+    MaskOpacity = "mask",
+    /** The type of image to display. Valid values are `cell` and `fov` (from `ImageTypeSnapshot`). Default `cell`. */
+    ImageType = "image",
+    /** Whether to show the axes helper. Boolean, or `0`/`1` when stringified. Default `false`. */
+    ShowAxes = "axes",
+    /** Whether to show the bounding box. Boolean, or `0`/`1` when stringified. Default `false`. */
+    ShowBoundingBox = "bb",
     /** The color of the bounding box, as a 6-digit hex color. */
-    [ViewerStateKeys.BoundingBoxColor]?: string;
+    BoundingBoxColor = "bbcol",
     /** The background color, as a 6-digit hex color. */
-    [ViewerStateKeys.BackgroundColor]?: string;
-    /** Whether to autorotate the view. "1" is enabled. Disabled by default. */
-    [ViewerStateKeys.Autorotate]?: string;
-    /** The brightness of the image, an float in the range [0, 100]. Defaults to 70. */
-    [ViewerStateKeys.Brightness]?: string;
-    /** Density, a float in the range [0, 100]. Defaults to 50. */
-    [ViewerStateKeys.Density]?: string;
+    BackgroundColor = "bgcol",
+    /** Whether to autorotate the view. Boolean, or `0`/`1` when stringified. Default `false`. */
+    Autorotate = "rot",
+    /** The brightness of the image, a float in the range `[0, 100]`. Default `70`. */
+    Brightness = "bright",
+    /** Density, a float in the range `[0, 100]`. Default `50`. */
+    Density = "dens",
     /**
-     * Levels for image intensity adjustment. Should be three numeric values separated
-     * by commas, representing the low, middle, and high values in a [0, 255] range.
-     * Values will be sorted in ascending order; empty values will be parsed as 0.
+     * Levels for image intensity adjustment. Should be a three-element array of numbers (comma-separated when
+     * stringified), representing the low, middle, and high values in the range `[0, 255]`. Values will be sorted in
+     * ascending order. Empty values in stringified form will be parsed as `0`.
      */
-    [ViewerStateKeys.Levels]?: string;
-    /** Whether to enable interpolation. "1" is enabled. Enabled by default. */
-    [ViewerStateKeys.Interpolation]?: string;
-    /** Subregions per axis, as min:max pairs separated by commas.
-     * Defaults to full range (`0:1`) for each axis.
+    Levels = "lvl",
+    /** Whether to enable interpolation. Boolean, or `0`/`1` when stringified. Default `true`. */
+    Interpolation = "interp",
+    /**
+     * Size of the clipped subregion, in the form `[[xmin, xmax], [ymin, ymax], [zmin, zmax]]`.
+     * Stringifies to the form `xmin:xmax,ymin:ymax,zmin:zmax`. Default full range (`[0, 1]`) for each axis.
      */
-    [ViewerStateKeys.Region]?: string;
-    /** Slice position per X, Y, and Z axes, as a list of comma-separated floats.
-     * 0.5 for all axes by default (e.g. `0.5,0.5,0.5`)
+    Region = "reg",
+    /**
+     * Slice position per X, Y, and Z axes, as a three-element array of floats (comma-separated when stringified).
+     * Default `0.5` for all axes (e.g. `[0.5, 0.5, 0.5]`).
      */
-    [ViewerStateKeys.Slice]?: string;
-    /** Frame number, for time-series volumes. 0 by default. */
-    [ViewerStateKeys.Time]?: string;
-    /** Scene number, for multiscene images. 0 by default. */
-    [ViewerStateKeys.Scene]?: string;
-    /** Whether to use an exact scale level index. 0 by default. */
-    [ViewerStateKeys.UseExactScaleLevel]?: string;
-    /** The exact scale level index to use, if `UseExactScaleLevel` is 1. 0 by default. */
-    [ViewerStateKeys.ScaleLevelIndex]?: string;
+    Slice = "slice",
+    /** Frame number, for time-series volumes. `0` by default. */
+    Time = "t",
+    /** Scene number, for multiscene images. `0` by default. */
+    Scene = "scene",
     /**
-     * Camera transform settings, as a list of `key:value` pairs separated by commas.
-     * Valid keys are defined in `CameraTransformKeys`:
-     * - `pos`: position
-     * - `tar`: target
-     * - `up`: up
-     * - `ort`: orthographic scale
-     * - `fov`: field of view
+     * Camera transform settings. An object with type `CameraTransformSnapshot`; see `CameraTransformKeys` for more.
      *
-     * Vector values are encoded as three floats separated by colons (e.g. `1:2:3`) and
-     * encoded using `encodeURIComponent`.
+     * Stringifies to a list of `key:value` pairs separated by commas. Vector values are encoded as three floats
+     * separated by colons (e.g. `1:2:3`) and encoded using `encodeURIComponent`.
      */
-    [ViewerStateKeys.CameraState]?: string;
+    CameraState = "cam",
+    /** Whether single-channel mode is active. Boolean, or `0`/`1` when stringified. Default `false`. */
+    SingleChannelMode = "scm",
+    /** If single-channel mode is active, which channel index is shown. Default `0`. */
+    SingleChannelIndex = "sci",
+    /** Whether to use an exact scale level index. Boolean, or `0`/`1` when stringified. Default `false`. */
+    UseExactScaleLevel = "esl",
+    /** The exact scale level index to use, if `UseExactScaleLevel` is `true`. Default `0`. */
+    ScaleLevelIndex = "scl"
 }
 /**
- * Mapped to types in `ViewerChannelStateParams`.
+ * Property keys for the "snapshot" variants of `ChannelState`/`ViewerChannelSettings`. These keys are shorter, for
+ * contexts that need brevity (like URLs), and have a stronger guarantee of stability than the keys of `ChannelState`.
+ *
+ * **IMPORTANT:** Changing the values of this enum will BREAK existing image sharing links and exported app state.
+ * Ideally, you should never do it. If you must, you must also add code to version-check and handle previous values.
  */
-export declare enum ViewerChannelSettingKeys {
+export declare enum ChannelStateSnapshotKeys {
+    /** Color, as a 6-digit hex color.  */
     Color = "col",
+    /** Whether colorize is enabled. Boolean, or `0`/`1` when stringified. Default `false`. */
     Colorize = "clz",
+    /** Colorize alpha, in the range `[0, 1]`. Default `1.0`. */
     ColorizeAlpha = "cza",
+    /** Isosurface alpha, in the range `[0, 1]`. Set to `1.0` by default.*/
     IsosurfaceAlpha = "isa",
-    Lut = "lut",
-    ControlPoints = "cpt",
-    ControlPointsLegacy = "cps",
-    Ramp = "ram",
-    RampLegacy = "rmp",
-    ControlPointsEnabled = "cpe",
-    VolumeEnabled = "ven",
-    SurfaceEnabled = "sen",
-    IsosurfaceValue = "isv",
-    KeepRange = "pin"
-}
-/**
- * The serialized form of a ViewerChannelSetting, as a dictionary object.
- */
-export declare class ViewerChannelStateParams {
-    /** Color, as a 6-digit hex color.  */
-    [ViewerChannelSettingKeys.Color]?: string;
-    /** Colorize. "1" is enabled. Disabled by default. */
-    [ViewerChannelSettingKeys.Colorize]?: "1" | "0";
-    /** Colorize alpha, in the [0, 1] range. Set to `1.0` by default. */
-    [ViewerChannelSettingKeys.ColorizeAlpha]?: string;
-    /** Isosurface alpha, in the [0, 1 range]. Set to `1.0` by default.*/
-    [ViewerChannelSettingKeys.IsosurfaceAlpha]?: string;
     /**
-     * Lookup table (LUT) to map from volume intensity to opacity. Should be two
-     * alphanumeric values separated by a colon, where the first value is the
-     * minimum and the second is the maximum. Defaults to [0, 255].
+     * Lookup table (LUT) to map from volume intensity to opacity. A two-element array of alphanumeric values
+     * (colon-separated when stringified), where the first value is the minimum and the second is the maximum.
+     * Default `[0, 255]`.
      *
      * Min and max values are determined as following:
-     * - Plain numbers are indices of histogram bins, typically in the range [0,
-     *   255].
+     * - Plain numbers are indices of histogram bins, typically in the range `[0, 255]`.
      * - `v{n}` represents a raw intensity value, where `n` is a number.
-     * - `p{n}` represents a percentile, where `n` is a percentile in the [0, 100]
-     *   range.
+     * - `p{n}` represents a percentile, where `n` is a percentile in the range `[0, 100]`.
      * - `m{n}` represents the median multiplied by `n / 100`.
-     * - `autoij` in either the min or max fields will use the "auto" algorithm
-     *   from ImageJ to select the min AND max.
+     * - `autoij` in either the min or max fields will use the "auto" algorithm from ImageJ to select the min AND max.
      *
-     * Values will be used to determine the initial control points and ramp if
-     * those fields are not provided.
+     * This field has no counterpart in `ChannelState`. It will be used to determine the initial values of
+     * `ControlPoints` and `Ramp` if those fields are not provided.
      *
      * @example
      * ```
@@ -214,53 +231,142 @@ export declare class ViewerChannelStateParams {
      * "autoij:0" // use Auto-IJ to calculate min and max.
      * ```
      */
-    [ViewerChannelSettingKeys.Lut]?: string;
+    Lut = "lut",
     /**
-     * Legacy specifier for control points for the transfer function as a list of
-     * `x:opacity:color` triplets, separated by colon. Uses histogram bin indices
-     * instead of intensity values.
-     * - `x` is a histogram bin index in the [0, 255] range.
-     * - `opacity` is a float in the [0, 1] range.
-     * - `color` is a 6-digit hex color, e.g. `ff0000`.
+     * Control points for the transfer function, formatted as a list of objects of type `ControlPointSnapshot` with the
+     * following keys:
+     * - `x` is a numeric intensity value.
+     * - `opacity` is a float in the range `[0, 1]`.
+     * - `color` is a 6-digit hex color, e.g. `"ff0000"`. For the extremely common default case where the control point is
+     *   white (`"ffffff"`), `color` is shortened to just `"1"`.
      *
-     * Will be overridden by the ControlPoints field (`cpt`) if provided.
+     * Stringifies to a colon-separated list: `x1:opacity1:color1:x2:opacity2:color2:...`
+     *
+     * If provided, overrides the `lut` field when calculating control points.
      */
-    [ViewerChannelSettingKeys.ControlPointsLegacy]?: string;
+    ControlPoints = "cpt",
     /**
-     * Control points for the transfer function, formatted as a list of
-     * `x:opacity:color` triplets, separated by colons.
-     * - `x` is a numeric intensity value.
-     * - `opacity` is a float in the [0, 1] range.
-     * - `color` is a 6-digit hex color, e.g. `ff0000`.
+     * Legacy specifier for control points for the transfer function. Formatted exactly like `ControlPoints`,
+     * except `x` represents histogram bin indices (in the range `[0, 255]`), not raw intensities.
      *
-     * If provided, overrides the `lut` field when calculating the control points.
+     * Will be overridden by the `ControlPoints` field (`cpt`) if provided.
      */
-    [ViewerChannelSettingKeys.ControlPoints]?: string;
+    ControlPointsLegacy = "cps",
     /**
-     * Whether to show advanced mode, which will show control points instead of
-     * ramp values defined by the LUT. "1" is enabled, disabled by default.
+     * Ramp min and max intensity values. Two-element array, colon-separated when stringified (`min:max`).
+     *
+     * If provided, overrides the `lut` field when calculating the ramp.
      */
-    [ViewerChannelSettingKeys.ControlPointsEnabled]?: "1" | "0";
+    Ramp = "ram",
     /**
-     * Legacy specifier for the transfer function ramp which uses histogram bin
-     * indices instead of intensity values, formatted as `min:max`. Will be
-     * overridden by the Ramp field (`ram`) if provided.
+     * Legacy specifier for the transfer function ramp. Formatted exactly like `Ramp`, except values represent histogram
+     * bin indices (in the range `[0, 255]`), not raw intensities.
+     *
+     * Will be overridden by the Ramp field (`ram`) if provided.
      */
-    [ViewerChannelSettingKeys.RampLegacy]?: string;
+    RampLegacy = "rmp",
     /**
-     * Ramp min and max intensity values (`min:max`). If provided, overrides the
-     * `lut` field when calculating the ramp.
+     * Whether this channel's settings are in "advanced mode" and using control points rather than min/max ramp to derive
+     * the transfer function. Boolean, or `0`/`1` when stringified. Default `false`.
      */
-    [ViewerChannelSettingKeys.Ramp]?: string;
-    /** Volume enabled. "1" is enabled. Disabled by default. */
-    [ViewerChannelSettingKeys.VolumeEnabled]?: "1" | "0";
-    /** Isosurface enabled. "1" is enabled. Disabled by default. */
-    [ViewerChannelSettingKeys.SurfaceEnabled]?: "1" | "0";
-    /** Isosurface value, in the [0, 255] range. Set to `128` by default. */
-    [ViewerChannelSettingKeys.IsosurfaceValue]?: string;
+    ControlPointsEnabled = "cpe",
+    /** Whether volume is enabled. Boolean, or `0`/`1` when stringified. Default `false`. */
+    VolumeEnabled = "ven",
+    /** Whether isosurface is enabled. Boolean, or `0`/`1` when stringified. Default `false`. */
+    SurfaceEnabled = "sen",
+    /** Isosurface value, in the range `[0, 255]`. Default `128`. */
+    IsosurfaceValue = "isv",
     /**
-     * Whether to keep the current contrast settings when loading a new volume.
-     * "1" is enabled. Disabled by default.
+     * Whether to keep the current contrast settings when loading a new volume. Boolean, or `0`/`1` when stringified.
+     * Default `false`.
      */
-    [ViewerChannelSettingKeys.KeepRange]?: "1" | "0";
+    KeepRange = "pin"
 }
+type ViewerStateSnapshotTypes = {
+    [ViewerStateSnapshotKeys.View]: ViewModeSnapshot;
+    [ViewerStateSnapshotKeys.Mode]: RenderModeSnapshot;
+    [ViewerStateSnapshotKeys.MaskOpacity]: number;
+    [ViewerStateSnapshotKeys.ImageType]: ImageTypeSnapshot;
+    [ViewerStateSnapshotKeys.ShowAxes]: boolean;
+    [ViewerStateSnapshotKeys.ShowBoundingBox]: boolean;
+    [ViewerStateSnapshotKeys.BoundingBoxColor]: string;
+    [ViewerStateSnapshotKeys.BackgroundColor]: string;
+    [ViewerStateSnapshotKeys.Autorotate]: boolean;
+    [ViewerStateSnapshotKeys.Brightness]: number;
+    [ViewerStateSnapshotKeys.Density]: number;
+    [ViewerStateSnapshotKeys.Levels]: [number, number, number];
+    [ViewerStateSnapshotKeys.Interpolation]: boolean;
+    [ViewerStateSnapshotKeys.Region]: [[number, number], [number, number], [number, number]];
+    [ViewerStateSnapshotKeys.Slice]: [number, number, number];
+    [ViewerStateSnapshotKeys.Time]: number;
+    [ViewerStateSnapshotKeys.Scene]: number;
+    [ViewerStateSnapshotKeys.CameraState]: CameraStateSnapshot;
+    [ViewerStateSnapshotKeys.SingleChannelMode]: boolean;
+    [ViewerStateSnapshotKeys.SingleChannelIndex]: number;
+    [ViewerStateSnapshotKeys.UseExactScaleLevel]: boolean;
+    [ViewerStateSnapshotKeys.ScaleLevelIndex]: number;
+};
+/**
+ * A "snapshot" of a `ViewerState`.
+ *
+ * This type is a variant representation of `ViewerState`, specialized for saving/restoring state to/from some
+ * serialized representation. It has the following desirable properties for this purpose:
+ * - Its keys are *shorter*, for formats where that's desirable (mostly URL parameters)
+ * - Its keys are reasonably *stable*, so that settings exported from older app versions can be imported by newer ones
+ * - Some values, notably colors, are converted to alternate representations for compactness and/or clarity
+ */
+export type ViewerStateSnapshot = {
+    [K in ViewerStateSnapshotKeys]?: ViewerStateSnapshotTypes[K];
+};
+/**
+ * A `ViewerStateSnapshot` with all its keys converted to compact string representations. Useful for (de)serializing
+ * viewer state to/from URL parameters.
+ */
+export type ViewerStateStringified = {
+    [K in ViewerStateSnapshotKeys]?: string;
+};
+/**
+ * A `ControlPoint` where `color` is a six-digit hex string, or gets shortened to `"1"` in the overwhelming majority of
+ * cases where the control point is white to save space in sharing URLs. Used by `ChannelStateSnapshot`.
+ */
+export type ControlPointSnapshot = {
+    x: number;
+    opacity: number;
+    color: string;
+};
+type ChannelStateSnapshotTypes = {
+    [ChannelStateSnapshotKeys.Color]: string;
+    [ChannelStateSnapshotKeys.Colorize]: boolean;
+    [ChannelStateSnapshotKeys.ColorizeAlpha]: number;
+    [ChannelStateSnapshotKeys.IsosurfaceAlpha]: number;
+    [ChannelStateSnapshotKeys.Lut]: [string | number, string | number];
+    [ChannelStateSnapshotKeys.ControlPointsLegacy]: ControlPointSnapshot[];
+    [ChannelStateSnapshotKeys.ControlPoints]: ControlPointSnapshot[];
+    [ChannelStateSnapshotKeys.ControlPointsEnabled]: boolean;
+    [ChannelStateSnapshotKeys.RampLegacy]: [number, number];
+    [ChannelStateSnapshotKeys.Ramp]: [number, number];
+    [ChannelStateSnapshotKeys.VolumeEnabled]: boolean;
+    [ChannelStateSnapshotKeys.SurfaceEnabled]: boolean;
+    [ChannelStateSnapshotKeys.IsosurfaceValue]: number;
+    [ChannelStateSnapshotKeys.KeepRange]: boolean;
+};
+/**
+ * A "snapshot" of a `ChannelState` or `ViewerChannelSetting`.
+ *
+ * This type is a variant representation of `ChannelState`/`ViewerChannelSetting`, specialized for saving/restoring
+ * channel state to/from some serialized representation. It has the following desirable properties for this purpose:
+ * - Its keys are *shorter*, for formats where that's desirable (mostly URL parameters)
+ * - Its keys are reasonably *stable*, so that settings exported from older app versions can be imported by newer ones
+ * - Some values, notably colors, are converted to alternate representations for compactness and/or clarity
+ */
+export type ChannelStateSnapshot = {
+    [K in ChannelStateSnapshotKeys]?: ChannelStateSnapshotTypes[K];
+};
+/**
+ * A `ChannelStateSnapshot` with all its keys converted to compact string representations. Useful for (de)serializing
+ * channel state to/from URL parameters.
+ */
+export type ChannelStateStringified = {
+    [K in ChannelStateSnapshotKeys]?: string;
+};
+export {};

package/type-declarations/aics-image-viewer/state/util.d.ts

@@ -1,4 +1,4 @@
-import type { ViewerState } from "../state/types";
+import type { ChannelState, ViewerState } from "../state/types";
 /**
  * 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.
@@ -6,3 +6,5 @@ import type { ViewerState } from "../state/types";
 export declare const validateStateValue: <K extends keyof ViewerState>(currentState: ViewerState, key: K, value: Partial<ViewerState[K]>) => Partial<ViewerState>;
 /** Ensures a fragment of `ViewerState` can be safely merged into `currentState` without creating an illegal state. */
 export declare const validateState: (currentState: ViewerState, newState: Partial<{ [K in keyof ViewerState]: Partial<ViewerState[K]>; }>) => Partial<ViewerState>;
+/** Creates a deep copy of a `ChannelState` */
+export declare const cloneChannelState: (setting: ChannelState) => ChannelState;

package/type-declarations/index.d.ts

@@ -1,9 +1,11 @@
 import ImageViewerApp from "./aics-image-viewer/components/App";
-export { addViewerParamsFromMessage, parseViewerUrlParams } from "./aics-image-viewer/shared/utils/urlParsing";
+export { parseViewerUrlParams } from "./aics-image-viewer/shared/utils/parseUrl";
 export { writeMetadata, writeScenes } from "./aics-image-viewer/shared/utils/storage";
+export { type ViewerMessage, type StoreSnapshot, viewerMessageToParams, isStoreSnapshot, snapshotToViewerChannelSettings, } from "./aics-image-viewer/shared/utils/parseSnapshot";
+export { snapshotToViewerState } from "./aics-image-viewer/state/deserialize";
 export type { ViewerChannelSettings, ViewerChannelGroup, ViewerChannelSetting, } from "./aics-image-viewer/shared/utils/viewerChannelSettings";
-export type { ViewerState } from "./aics-image-viewer/state/types";
-export { ViewMode, RenderMode, ImageType } from "./aics-image-viewer/shared/enums";
+export { ViewMode, RenderMode, ImageType } from "./aics-image-viewer/state/types";
+export type { ViewerState, ViewerStateSnapshot, ChannelStateSnapshot } from "./aics-image-viewer/state/types";
 export type { AppProps } from "./aics-image-viewer/components/App/types";
 export type { RawArrayData, RawArrayInfo } from "@aics/vole-core";
 export { ImageViewerApp };

package/es/aics-image-viewer/shared/enums.js

@@ -1,18 +0,0 @@
-export var ViewMode = /*#__PURE__*/function (ViewMode) {
-  ViewMode["threeD"] = "3D";
-  ViewMode["xy"] = "XY";
-  ViewMode["xz"] = "XZ";
-  ViewMode["yz"] = "YZ";
-  return ViewMode;
-}({});
-export var RenderMode = /*#__PURE__*/function (RenderMode) {
-  RenderMode["volumetric"] = "volumetric";
-  RenderMode["maxProject"] = "maxproject";
-  RenderMode["pathTrace"] = "pathtrace";
-  return RenderMode;
-}({});
-export var ImageType = /*#__PURE__*/function (ImageType) {
-  ImageType["segmentedCell"] = "cell";
-  ImageType["fullField"] = "fov";
-  return ImageType;
-}({});

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

@@ -1,15 +0,0 @@
-export declare enum ViewMode {
-    threeD = "3D",
-    xy = "XY",
-    xz = "XZ",
-    yz = "YZ"
-}
-export declare enum RenderMode {
-    volumetric = "volumetric",
-    maxProject = "maxproject",
-    pathTrace = "pathtrace"
-}
-export declare enum ImageType {
-    segmentedCell = "cell",
-    fullField = "fov"
-}

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

@@ -1 +0,0 @@
-export declare function clamp(value: number, min: number, max: number): number;