@deephaven/plugin 1.10.2 → 1.11.0

package/dist/index.d.ts

@@ -6,7 +6,10 @@ export * from './useCustomThemes';
 export * from './useDashboardPlugins';
 export * from './usePlugins';
 export * from './WidgetView';
-export * from './PersistentStateContext';
-export * from './usePersistentState';
+export { 
+/** @deprecated Import from '@deephaven/dashboard' */
+PersistentStateProvider, 
+/** @deprecated Import from '@deephaven/dashboard' */
+usePersistentState, } from '@deephaven/dashboard';
 export * from './usePluginsElementMap';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,OAAO;AACL,qDAAqD;AACrD,uBAAuB;AACvB,qDAAqD;AACrD,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAC9B,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -6,7 +6,8 @@ export * from "./useCustomThemes.js";
 export * from "./useDashboardPlugins.js";
 export * from "./usePlugins.js";
 export * from "./WidgetView.js";
-export * from "./PersistentStateContext.js";
-export * from "./usePersistentState.js";
+export { /** @deprecated Import from '@deephaven/dashboard' */
+PersistentStateProvider, /** @deprecated Import from '@deephaven/dashboard' */
+usePersistentState } from '@deephaven/dashboard';
 export * from "./usePluginsElementMap.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './PluginsContext';\nexport * from './PluginTypes';\nexport * from './PluginUtils';\nexport * from './TablePlugin';\nexport * from './useCustomThemes';\nexport * from './useDashboardPlugins';\nexport * from './usePlugins';\nexport * from './WidgetView';\nexport * from './PersistentStateContext';\nexport * from './usePersistentState';\nexport * from './usePluginsElementMap';\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.js","names":["PersistentStateProvider","usePersistentState"],"sources":["../src/index.ts"],"sourcesContent":["export * from './PluginsContext';\nexport * from './PluginTypes';\nexport * from './PluginUtils';\nexport * from './TablePlugin';\nexport * from './useCustomThemes';\nexport * from './useDashboardPlugins';\nexport * from './usePlugins';\nexport * from './WidgetView';\nexport {\n  /** @deprecated Import from '@deephaven/dashboard' */\n  PersistentStateProvider,\n  /** @deprecated Import from '@deephaven/dashboard' */\n  usePersistentState,\n} from '@deephaven/dashboard';\nexport * from './usePluginsElementMap';\n"],"mappings":";;;;;;;;AAQA,SACE;AACAA,uBAAuB,EACvB;AACAC,kBAAkB,QACb,sBAAsB;AAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/plugin",
-  "version": "1.10.2",
+  "version": "1.11.0",
   "description": "Deephaven JS Plugin Core",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -22,11 +22,12 @@
     "build:babel": "babel ./src --out-dir ./dist --extensions \".ts,.tsx,.js,.jsx\" --source-maps --root-mode upward"
   },
   "dependencies": {
-    "@deephaven/components": "^1.10.0",
-    "@deephaven/golden-layout": "^1.10.2",
-    "@deephaven/grid": "^1.10.0",
+    "@deephaven/components": "^1.11.0",
+    "@deephaven/dashboard": "^1.11.0",
+    "@deephaven/golden-layout": "^1.11.0",
+    "@deephaven/grid": "^1.11.0",
     "@deephaven/icons": "^1.2.0",
-    "@deephaven/iris-grid": "^1.10.1",
+    "@deephaven/iris-grid": "^1.11.0",
     "@deephaven/jsapi-types": "^1.0.0-dev0.40.4",
     "@deephaven/log": "^1.8.0",
     "@deephaven/react-hooks": "^1.10.0",
@@ -43,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "39e389c481a4ec75bfed7a45d1ffaf5a98d8f98e"
+  "gitHead": "7b2a23ea3b33c11f136e7b9d44a204880c674866"
 }

package/dist/PersistentStateContext.d.ts

@@ -1,59 +0,0 @@
-import React from 'react';
-export type PersistentStateContextType = {
-    /**
-     *
-     * @param id A unique ID generated by the caller.
-     *           This identifies the specific state internally and is used to prevent duplicate state
-     * @param state The state to persist. Needs to be JSON serializable.
-     */
-    addState: (id: string, state: {
-        type: string;
-        version: number;
-        state: unknown;
-    }) => void;
-    /**
-     * Schedules a persistent state update.
-     * Will re-render the components that have persistent state to capture their current state.
-     */
-    scheduleStateUpdate: () => void;
-    /**
-     * Gets the next item from the initial state iterator.
-     * It is expected that each hook will call this once to get its initial state.
-     * @param id A unique ID generated by the caller.
-     *           This is used to prevent one caller from consuming multiple values from the initial state.
-     * @returns The iterator result containing the initial state value (state, version, type) and a done flag.
-     */
-    getInitialState: <S>(id: string) => {
-        value: {
-            state: S;
-            version: number;
-            type: string;
-        };
-        done: boolean;
-    };
-};
-/**
- * Context that holds methods to track the state of all calls to usePersistentState below this provider.
- */
-export declare const PersistentStateContext: React.Context<PersistentStateContextType | null>;
-export type PersistentStateProviderProps = React.PropsWithChildren<{
-    /**
-     * The initial state of all calls to usePersistentState.
-     * If there are more calls to usePersistentState than there are elements in this array,
-     * the state initializer of the usePersistentState call will be used for the rest.
-     */
-    initialState: unknown[];
-    /**
-     * Called when the state changes.
-     * The state is passed as an array of the values of all calls to usePersistentState.
-     * The order of the values is the same as the order of the calls to usePersistentState.
-     * @param state The state of all calls to usePersistentState.
-     */
-    onChange: (state: unknown[]) => void;
-}>;
-/**
- * Tracks all calls to the usePersistentState hook below this provider.
- * Keeps track of the state in call order so and calls onChange when the state changes.
- */
-export declare function PersistentStateProvider(props: PersistentStateProviderProps): JSX.Element;
-//# sourceMappingURL=PersistentStateContext.d.ts.map

package/dist/PersistentStateContext.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PersistentStateContext.d.ts","sourceRoot":"","sources":["../src/PersistentStateContext.tsx"],"names":[],"mappings":"AAAA,OAAO,KAMN,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;;OAKG;IACH,QAAQ,EAAE,CACR,EAAE,EAAE,MAAM,EACV,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,KACrD,IAAI,CAAC;IAEV;;;OAGG;IACH,mBAAmB,EAAE,MAAM,IAAI,CAAC;IAEhC;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,KAAK;QAClC,KAAK,EAAE;YAAE,KAAK,EAAE,CAAC,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QACnD,IAAI,EAAE,OAAO,CAAC;KACf,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,kDACqB,CAAC;AAGzD,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC,iBAAiB,CAAC;IACjE;;;;OAIG;IACH,YAAY,EAAE,OAAO,EAAE,CAAC;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACtC,CAAC,CAAC;AAEH;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,4BAA4B,GAClC,GAAG,CAAC,OAAO,CA2Eb"}

package/dist/PersistentStateContext.js

@@ -1,79 +0,0 @@
-import React, { createContext, useCallback, useEffect, useMemo, useRef } from 'react';
-import { jsx as _jsx } from "react/jsx-runtime";
-/**
- * Context that holds methods to track the state of all calls to usePersistentState below this provider.
- */
-export var PersistentStateContext = /*#__PURE__*/createContext(null);
-PersistentStateContext.displayName = 'PersistentStateContext';
-/**
- * Tracks all calls to the usePersistentState hook below this provider.
- * Keeps track of the state in call order so and calls onChange when the state changes.
- */
-export function PersistentStateProvider(props) {
-  var {
-    initialState,
-    onChange,
-    children
-  } = props;
-  var [updateId, setUpdateId] = React.useState(0);
-
-  // We store the previous and next state in a map in case a component calls setState in its render function.
-  // This would cause an immediate re-render and usePersistentState may be called multiple times from 1 component
-  // before the render finishes and we run the effect to persist the state.
-  // JS Maps iterate based on insertion order, so if a component renders multiple times its original position will be maintained
-  // while updating its state if it changed in that re-render.
-  var persistentData = useRef({
-    initial: initialState,
-    initialStateMap: new Map(),
-    state: new Map(),
-    isTracking: true // We want to start tracking on the first render
-  });
-  var addState = useCallback((id, state) => {
-    if (persistentData.current.isTracking) {
-      persistentData.current.state.set(id, state);
-    }
-  }, []);
-  var scheduleStateUpdate = useCallback(() => {
-    // Don't trigger again if we are already tracking a render
-    if (!persistentData.current.isTracking) {
-      persistentData.current.isTracking = true;
-      persistentData.current.state = new Map();
-      setUpdateId(prev => prev + 1);
-    }
-  }, []);
-  var initialStateIterator = useRef(persistentData.current.initial[Symbol.iterator]());
-  var getInitialState = useCallback(function getState(id) {
-    // Prevents a component re-rendering multiple times in the same render cycle from taking multiple values from the iterator
-    var initialStateForId = persistentData.current.initialStateMap.get(id);
-    if (initialStateForId) {
-      return initialStateForId;
-    }
-    var {
-      value,
-      done
-    } = initialStateIterator.current.next();
-    var stateVal = {
-      value: value,
-      done: done !== null && done !== void 0 ? done : false
-    };
-    persistentData.current.initialStateMap.set(id, stateVal);
-    return stateVal;
-  }, []);
-  useEffect(function persistState() {
-    if (persistentData.current.isTracking) {
-      onChange([...persistentData.current.state.values()]);
-      persistentData.current.isTracking = false;
-    }
-  }, [updateId, onChange]);
-  var contextValue = useMemo(() => ({
-    addState,
-    scheduleStateUpdate,
-    getInitialState,
-    updateId
-  }), [addState, getInitialState, scheduleStateUpdate, updateId]);
-  return /*#__PURE__*/_jsx(PersistentStateContext.Provider, {
-    value: contextValue,
-    children: children
-  });
-}
-//# sourceMappingURL=PersistentStateContext.js.map

package/dist/PersistentStateContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PersistentStateContext.js","names":["React","createContext","useCallback","useEffect","useMemo","useRef","jsx","_jsx","PersistentStateContext","displayName","PersistentStateProvider","props","initialState","onChange","children","updateId","setUpdateId","useState","persistentData","initial","initialStateMap","Map","state","isTracking","addState","id","current","set","scheduleStateUpdate","prev","initialStateIterator","Symbol","iterator","getInitialState","getState","initialStateForId","get","value","done","next","stateVal","persistState","values","contextValue","Provider"],"sources":["../src/PersistentStateContext.tsx"],"sourcesContent":["import React, {\n  createContext,\n  useCallback,\n  useEffect,\n  useMemo,\n  useRef,\n} from 'react';\n\nexport type PersistentStateContextType = {\n  /**\n   *\n   * @param id A unique ID generated by the caller.\n   *           This identifies the specific state internally and is used to prevent duplicate state\n   * @param state The state to persist. Needs to be JSON serializable.\n   */\n  addState: (\n    id: string,\n    state: { type: string; version: number; state: unknown }\n  ) => void;\n\n  /**\n   * Schedules a persistent state update.\n   * Will re-render the components that have persistent state to capture their current state.\n   */\n  scheduleStateUpdate: () => void;\n\n  /**\n   * Gets the next item from the initial state iterator.\n   * It is expected that each hook will call this once to get its initial state.\n   * @param id A unique ID generated by the caller.\n   *           This is used to prevent one caller from consuming multiple values from the initial state.\n   * @returns The iterator result containing the initial state value (state, version, type) and a done flag.\n   */\n  getInitialState: <S>(id: string) => {\n    value: { state: S; version: number; type: string };\n    done: boolean;\n  };\n};\n\n/**\n * Context that holds methods to track the state of all calls to usePersistentState below this provider.\n */\nexport const PersistentStateContext =\n  createContext<PersistentStateContextType | null>(null);\nPersistentStateContext.displayName = 'PersistentStateContext';\n\nexport type PersistentStateProviderProps = React.PropsWithChildren<{\n  /**\n   * The initial state of all calls to usePersistentState.\n   * If there are more calls to usePersistentState than there are elements in this array,\n   * the state initializer of the usePersistentState call will be used for the rest.\n   */\n  initialState: unknown[];\n\n  /**\n   * Called when the state changes.\n   * The state is passed as an array of the values of all calls to usePersistentState.\n   * The order of the values is the same as the order of the calls to usePersistentState.\n   * @param state The state of all calls to usePersistentState.\n   */\n  onChange: (state: unknown[]) => void;\n}>;\n\n/**\n * Tracks all calls to the usePersistentState hook below this provider.\n * Keeps track of the state in call order so and calls onChange when the state changes.\n */\nexport function PersistentStateProvider(\n  props: PersistentStateProviderProps\n): JSX.Element {\n  const { initialState, onChange, children } = props;\n  const [updateId, setUpdateId] = React.useState(0);\n\n  // We store the previous and next state in a map in case a component calls setState in its render function.\n  // This would cause an immediate re-render and usePersistentState may be called multiple times from 1 component\n  // before the render finishes and we run the effect to persist the state.\n  // JS Maps iterate based on insertion order, so if a component renders multiple times its original position will be maintained\n  // while updating its state if it changed in that re-render.\n  const persistentData = useRef({\n    initial: initialState,\n    initialStateMap: new Map<string, { value: unknown; done: boolean }>(),\n    state: new Map<string, unknown>(),\n    isTracking: true, // We want to start tracking on the first render\n  });\n\n  const addState = useCallback((id: string, state: unknown) => {\n    if (persistentData.current.isTracking) {\n      persistentData.current.state.set(id, state);\n    }\n  }, []);\n\n  const scheduleStateUpdate = useCallback(() => {\n    // Don't trigger again if we are already tracking a render\n    if (!persistentData.current.isTracking) {\n      persistentData.current.isTracking = true;\n      persistentData.current.state = new Map<string, unknown>();\n      setUpdateId(prev => prev + 1);\n    }\n  }, []);\n\n  const initialStateIterator = useRef(\n    persistentData.current.initial[Symbol.iterator]()\n  );\n\n  const getInitialState = useCallback(function getState<S>(id: string): {\n    value: S;\n    done: boolean;\n  } {\n    // Prevents a component re-rendering multiple times in the same render cycle from taking multiple values from the iterator\n    const initialStateForId = persistentData.current.initialStateMap.get(id);\n    if (initialStateForId) {\n      return initialStateForId as { value: S; done: boolean };\n    }\n    const { value, done } = initialStateIterator.current.next();\n    const stateVal = { value: value as S, done: done ?? false };\n    persistentData.current.initialStateMap.set(id, stateVal);\n    return stateVal;\n  }, []);\n\n  useEffect(\n    function persistState() {\n      if (persistentData.current.isTracking) {\n        onChange([...persistentData.current.state.values()]);\n        persistentData.current.isTracking = false;\n      }\n    },\n    [updateId, onChange]\n  );\n\n  const contextValue = useMemo(\n    () => ({\n      addState,\n      scheduleStateUpdate,\n      getInitialState,\n      updateId,\n    }),\n    [addState, getInitialState, scheduleStateUpdate, updateId]\n  );\n\n  return (\n    <PersistentStateContext.Provider value={contextValue}>\n      {children}\n    </PersistentStateContext.Provider>\n  );\n}\n"],"mappings":"AAAA,OAAOA,KAAK,IACVC,aAAa,EACbC,WAAW,EACXC,SAAS,EACTC,OAAO,EACPC,MAAM,QACD,OAAO;AAAC,SAAAC,GAAA,IAAAC,IAAA;AAiCf;AACA;AACA;AACA,OAAO,IAAMC,sBAAsB,gBACjCP,aAAa,CAAoC,IAAI,CAAC;AACxDO,sBAAsB,CAACC,WAAW,GAAG,wBAAwB;AAmB7D;AACA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CACrCC,KAAmC,EACtB;EACb,IAAM;IAAEC,YAAY;IAAEC,QAAQ;IAAEC;EAAS,CAAC,GAAGH,KAAK;EAClD,IAAM,CAACI,QAAQ,EAAEC,WAAW,CAAC,GAAGhB,KAAK,CAACiB,QAAQ,CAAC,CAAC,CAAC;;EAEjD;EACA;EACA;EACA;EACA;EACA,IAAMC,cAAc,GAAGb,MAAM,CAAC;IAC5Bc,OAAO,EAAEP,YAAY;IACrBQ,eAAe,EAAE,IAAIC,GAAG,CAA4C,CAAC;IACrEC,KAAK,EAAE,IAAID,GAAG,CAAkB,CAAC;IACjCE,UAAU,EAAE,IAAI,CAAE;EACpB,CAAC,CAAC;EAEF,IAAMC,QAAQ,GAAGtB,WAAW,CAAC,CAACuB,EAAU,EAAEH,KAAc,KAAK;IAC3D,IAAIJ,cAAc,CAACQ,OAAO,CAACH,UAAU,EAAE;MACrCL,cAAc,CAACQ,OAAO,CAACJ,KAAK,CAACK,GAAG,CAACF,EAAE,EAAEH,KAAK,CAAC;IAC7C;EACF,CAAC,EAAE,EAAE,CAAC;EAEN,IAAMM,mBAAmB,GAAG1B,WAAW,CAAC,MAAM;IAC5C;IACA,IAAI,CAACgB,cAAc,CAACQ,OAAO,CAACH,UAAU,EAAE;MACtCL,cAAc,CAACQ,OAAO,CAACH,UAAU,GAAG,IAAI;MACxCL,cAAc,CAACQ,OAAO,CAACJ,KAAK,GAAG,IAAID,GAAG,CAAkB,CAAC;MACzDL,WAAW,CAACa,IAAI,IAAIA,IAAI,GAAG,CAAC,CAAC;IAC/B;EACF,CAAC,EAAE,EAAE,CAAC;EAEN,IAAMC,oBAAoB,GAAGzB,MAAM,CACjCa,cAAc,CAACQ,OAAO,CAACP,OAAO,CAACY,MAAM,CAACC,QAAQ,CAAC,CAAC,CAClD,CAAC;EAED,IAAMC,eAAe,GAAG/B,WAAW,CAAC,SAASgC,QAAQA,CAAIT,EAAU,EAGjE;IACA;IACA,IAAMU,iBAAiB,GAAGjB,cAAc,CAACQ,OAAO,CAACN,eAAe,CAACgB,GAAG,CAACX,EAAE,CAAC;IACxE,IAAIU,iBAAiB,EAAE;MACrB,OAAOA,iBAAiB;IAC1B;IACA,IAAM;MAAEE,KAAK;MAAEC;IAAK,CAAC,GAAGR,oBAAoB,CAACJ,OAAO,CAACa,IAAI,CAAC,CAAC;IAC3D,IAAMC,QAAQ,GAAG;MAAEH,KAAK,EAAEA,KAAU;MAAEC,IAAI,EAAEA,IAAI,aAAJA,IAAI,cAAJA,IAAI,GAAI;IAAM,CAAC;IAC3DpB,cAAc,CAACQ,OAAO,CAACN,eAAe,CAACO,GAAG,CAACF,EAAE,EAAEe,QAAQ,CAAC;IACxD,OAAOA,QAAQ;EACjB,CAAC,EAAE,EAAE,CAAC;EAENrC,SAAS,CACP,SAASsC,YAAYA,CAAA,EAAG;IACtB,IAAIvB,cAAc,CAACQ,OAAO,CAACH,UAAU,EAAE;MACrCV,QAAQ,CAAC,CAAC,GAAGK,cAAc,CAACQ,OAAO,CAACJ,KAAK,CAACoB,MAAM,CAAC,CAAC,CAAC,CAAC;MACpDxB,cAAc,CAACQ,OAAO,CAACH,UAAU,GAAG,KAAK;IAC3C;EACF,CAAC,EACD,CAACR,QAAQ,EAAEF,QAAQ,CACrB,CAAC;EAED,IAAM8B,YAAY,GAAGvC,OAAO,CAC1B,OAAO;IACLoB,QAAQ;IACRI,mBAAmB;IACnBK,eAAe;IACflB;EACF,CAAC,CAAC,EACF,CAACS,QAAQ,EAAES,eAAe,EAAEL,mBAAmB,EAAEb,QAAQ,CAC3D,CAAC;EAED,oBACER,IAAA,CAACC,sBAAsB,CAACoC,QAAQ;IAACP,KAAK,EAAEM,YAAa;IAAA7B,QAAA,EAClDA;EAAQ,CACsB,CAAC;AAEtC","ignoreList":[]}

package/dist/usePersistentState.d.ts

@@ -1,25 +0,0 @@
-import { type Dispatch, type SetStateAction } from 'react';
-export type PersistentStateMigration = {
-    from: number;
-    migrate: (state: unknown) => unknown;
-};
-/**
- * Functions identically to useState except that a PersistentStateProvider can be used to
- * track all calls to this hook and persist the value for future page loads.
- * Primarily used in Deephaven UI so we can persist state of multiple components within a panel.
- *
- * @param initialState The initial state if there is no previously persisted state.
- * @param config.type The type of the state. This identifier is used to validate the state being rehydrated. Should be unique to your component.
- * @param config.version The version of the state. This should be an integer, and is used to determine if the state needs to be migrated. Value should be incremented when data structure changes for this type.
- * @param config.migrations An array of migrations to apply to the state if the version of the persisted state is below the current version. Each migration increments the version by 1.
- * @param config.migrations.from The starting version of the migration. The migration will increment the version by 1.
- * @param config.migrations.migrate The function to call to migrate the state.
- * @returns [state, setState] tuple just like useState.
- */
-export declare function usePersistentState<S>(initialState: S | (() => S), config: {
-    type: string;
-    version: number;
-    migrations?: PersistentStateMigration[];
-}): [state: S, setState: Dispatch<SetStateAction<S>>];
-export default usePersistentState;
-//# sourceMappingURL=usePersistentState.d.ts.map

package/dist/usePersistentState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePersistentState.d.ts","sourceRoot":"","sources":["../src/usePersistentState.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,QAAQ,EACb,KAAK,cAAc,EACpB,MAAM,OAAO,CAAC;AAIf,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;CACtC,CAAC;AA+CF;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,YAAY,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAC3B,MAAM,EAAE;IACN,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACzC,GACA,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAiEnD;AAED,eAAe,kBAAkB,CAAC"}

package/dist/usePersistentState.js

@@ -1,97 +0,0 @@
-import { useContext, useDebugValue, useEffect, useState } from 'react';
-import { nanoid } from 'nanoid';
-import { PersistentStateContext } from "./PersistentStateContext.js";
-function migrateState(state, from, to, migrations, type) {
-  if (from > to) {
-    throw new Error("Persisted state ".concat(type, " is a newer version than the current version. Persisted version: ").concat(from, ". Current version: ").concat(to));
-  }
-  var migratedState = state;
-  var currentVersion = from;
-  while (currentVersion < to) {
-    // eslint-disable-next-line no-loop-func
-    var possibleMigration = migrations.filter(m => m.from === currentVersion);
-    if (possibleMigration.length === 0) {
-      throw new Error("No migration found for persisted state ".concat(type, " from version ").concat(currentVersion));
-    }
-    if (possibleMigration.length > 1) {
-      throw new Error("Multiple migrations found for persisted state ".concat(type, " from version ").concat(currentVersion));
-    }
-    var migration = possibleMigration[0];
-    try {
-      migratedState = migration.migrate(migratedState);
-      currentVersion += 1;
-    } catch (e) {
-      throw new Error("Error migrating persisted state ".concat(type, " from version ").concat(migration.from, ": ").concat(e), {
-        cause: e
-      });
-    }
-  }
-  return migratedState;
-}
-
-/**
- * Functions identically to useState except that a PersistentStateProvider can be used to
- * track all calls to this hook and persist the value for future page loads.
- * Primarily used in Deephaven UI so we can persist state of multiple components within a panel.
- *
- * @param initialState The initial state if there is no previously persisted state.
- * @param config.type The type of the state. This identifier is used to validate the state being rehydrated. Should be unique to your component.
- * @param config.version The version of the state. This should be an integer, and is used to determine if the state needs to be migrated. Value should be incremented when data structure changes for this type.
- * @param config.migrations An array of migrations to apply to the state if the version of the persisted state is below the current version. Each migration increments the version by 1.
- * @param config.migrations.from The starting version of the migration. The migration will increment the version by 1.
- * @param config.migrations.migrate The function to call to migrate the state.
- * @returns [state, setState] tuple just like useState.
- */
-export function usePersistentState(initialState, config) {
-  var _context$getInitialSt;
-  // We use this id to track if the component re-renders due to calling setState in its render function.
-  // Otherwise, usePersistentState might be called twice by the same component in the same render cycle before flushing in the provider.
-  var [id] = useState(() => nanoid());
-  var context = useContext(PersistentStateContext);
-  var {
-    value: persistedData,
-    done
-  } = (_context$getInitialSt = context === null || context === void 0 ? void 0 : context.getInitialState(id)) !== null && _context$getInitialSt !== void 0 ? _context$getInitialSt : {
-    value: undefined,
-    done: true
-  };
-
-  // If not done, then we can use the persisted state
-  // Otherwise, we have exhausted the persisted state
-  // By checking done, we are able to explicitly save undefined as a state value
-  var [state, setState] = useState(() => {
-    if (persistedData == null || done) {
-      return typeof initialState === 'function' ? initialState() : initialState;
-    }
-    if (persistedData.type !== config.type) {
-      throw new Error("usePersistentState type mismatch. Expected ".concat(config.type, " but got ").concat(persistedData.type, "."));
-    }
-    if (persistedData.version !== config.version) {
-      var _config$migrations;
-      return migrateState(persistedData.state, persistedData.version, config.version, (_config$migrations = config.migrations) !== null && _config$migrations !== void 0 ? _config$migrations : [], config.type);
-    }
-    return persistedData.state;
-  });
-  var stateWithConfig = {
-    type: config.type,
-    version: config.version,
-    state
-  };
-  useDebugValue(stateWithConfig);
-  context === null || context === void 0 || context.addState(id, stateWithConfig);
-
-  // This won't cause unnecessary renders on initial mount because the state is already tracking,
-  // so calls to scheduleStateUpdate will be no-ops since tracking finishes in an effect at the provider after this effect.
-  // When a component mounts after the parents have already rendered, this will trigger a re-render to track the new state immediately.
-  useEffect(function scheduleUpdateOnMountAndChange() {
-    context === null || context === void 0 || context.scheduleStateUpdate();
-  }, [context, state]);
-  useEffect(function scheduleUpdateOnUnmount() {
-    return () => {
-      context === null || context === void 0 || context.scheduleStateUpdate();
-    };
-  }, [context]);
-  return [state, setState];
-}
-export default usePersistentState;
-//# sourceMappingURL=usePersistentState.js.map

package/dist/usePersistentState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePersistentState.js","names":["useContext","useDebugValue","useEffect","useState","nanoid","PersistentStateContext","migrateState","state","from","to","migrations","type","Error","concat","migratedState","currentVersion","possibleMigration","filter","m","length","migration","migrate","e","cause","usePersistentState","initialState","config","_context$getInitialSt","id","context","value","persistedData","done","getInitialState","undefined","setState","version","_config$migrations","stateWithConfig","addState","scheduleUpdateOnMountAndChange","scheduleStateUpdate","scheduleUpdateOnUnmount"],"sources":["../src/usePersistentState.ts"],"sourcesContent":["import {\n  useContext,\n  useDebugValue,\n  useEffect,\n  useState,\n  type Dispatch,\n  type SetStateAction,\n} from 'react';\nimport { nanoid } from 'nanoid';\nimport { PersistentStateContext } from './PersistentStateContext';\n\nexport type PersistentStateMigration = {\n  from: number;\n  migrate: (state: unknown) => unknown;\n};\n\nfunction migrateState(\n  state: unknown,\n  from: number,\n  to: number,\n  migrations: PersistentStateMigration[],\n  type: string\n): unknown {\n  if (from > to) {\n    throw new Error(\n      `Persisted state ${type} is a newer version than the current version. Persisted version: ${from}. Current version: ${to}`\n    );\n  }\n\n  let migratedState = state;\n  let currentVersion = from;\n  while (currentVersion < to) {\n    // eslint-disable-next-line no-loop-func\n    const possibleMigration = migrations.filter(m => m.from === currentVersion);\n    if (possibleMigration.length === 0) {\n      throw new Error(\n        `No migration found for persisted state ${type} from version ${currentVersion}`\n      );\n    }\n\n    if (possibleMigration.length > 1) {\n      throw new Error(\n        `Multiple migrations found for persisted state ${type} from version ${currentVersion}`\n      );\n    }\n\n    const migration = possibleMigration[0];\n\n    try {\n      migratedState = migration.migrate(migratedState);\n      currentVersion += 1;\n    } catch (e) {\n      throw new Error(\n        `Error migrating persisted state ${type} from version ${migration.from}: ${e}`,\n        { cause: e }\n      );\n    }\n  }\n  return migratedState;\n}\n\n/**\n * Functions identically to useState except that a PersistentStateProvider can be used to\n * track all calls to this hook and persist the value for future page loads.\n * Primarily used in Deephaven UI so we can persist state of multiple components within a panel.\n *\n * @param initialState The initial state if there is no previously persisted state.\n * @param config.type The type of the state. This identifier is used to validate the state being rehydrated. Should be unique to your component.\n * @param config.version The version of the state. This should be an integer, and is used to determine if the state needs to be migrated. Value should be incremented when data structure changes for this type.\n * @param config.migrations An array of migrations to apply to the state if the version of the persisted state is below the current version. Each migration increments the version by 1.\n * @param config.migrations.from The starting version of the migration. The migration will increment the version by 1.\n * @param config.migrations.migrate The function to call to migrate the state.\n * @returns [state, setState] tuple just like useState.\n */\nexport function usePersistentState<S>(\n  initialState: S | (() => S),\n  config: {\n    type: string;\n    version: number;\n    migrations?: PersistentStateMigration[];\n  }\n): [state: S, setState: Dispatch<SetStateAction<S>>] {\n  // We use this id to track if the component re-renders due to calling setState in its render function.\n  // Otherwise, usePersistentState might be called twice by the same component in the same render cycle before flushing in the provider.\n  const [id] = useState(() => nanoid());\n  const context = useContext(PersistentStateContext);\n  const { value: persistedData, done } = context?.getInitialState<S>(id) ?? {\n    value: undefined,\n    done: true,\n  };\n\n  // If not done, then we can use the persisted state\n  // Otherwise, we have exhausted the persisted state\n  // By checking done, we are able to explicitly save undefined as a state value\n  const [state, setState] = useState<S>(() => {\n    if (persistedData == null || done) {\n      return typeof initialState === 'function'\n        ? (initialState as () => S)()\n        : initialState;\n    }\n\n    if (persistedData.type !== config.type) {\n      throw new Error(\n        `usePersistentState type mismatch. Expected ${config.type} but got ${persistedData.type}.`\n      );\n    }\n\n    if (persistedData.version !== config.version) {\n      return migrateState(\n        persistedData.state,\n        persistedData.version,\n        config.version,\n        config.migrations ?? [],\n        config.type\n      ) as S;\n    }\n\n    return persistedData.state;\n  });\n\n  const stateWithConfig = { type: config.type, version: config.version, state };\n\n  useDebugValue(stateWithConfig);\n\n  context?.addState(id, stateWithConfig);\n\n  // This won't cause unnecessary renders on initial mount because the state is already tracking,\n  // so calls to scheduleStateUpdate will be no-ops since tracking finishes in an effect at the provider after this effect.\n  // When a component mounts after the parents have already rendered, this will trigger a re-render to track the new state immediately.\n  useEffect(\n    function scheduleUpdateOnMountAndChange() {\n      context?.scheduleStateUpdate();\n    },\n    [context, state]\n  );\n\n  useEffect(\n    function scheduleUpdateOnUnmount() {\n      return () => {\n        context?.scheduleStateUpdate();\n      };\n    },\n    [context]\n  );\n\n  return [state, setState];\n}\n\nexport default usePersistentState;\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,aAAa,EACbC,SAAS,EACTC,QAAQ,QAGH,OAAO;AACd,SAASC,MAAM,QAAQ,QAAQ;AAAC,SACvBC,sBAAsB;AAO/B,SAASC,YAAYA,CACnBC,KAAc,EACdC,IAAY,EACZC,EAAU,EACVC,UAAsC,EACtCC,IAAY,EACH;EACT,IAAIH,IAAI,GAAGC,EAAE,EAAE;IACb,MAAM,IAAIG,KAAK,oBAAAC,MAAA,CACMF,IAAI,uEAAAE,MAAA,CAAoEL,IAAI,yBAAAK,MAAA,CAAsBJ,EAAE,CACzH,CAAC;EACH;EAEA,IAAIK,aAAa,GAAGP,KAAK;EACzB,IAAIQ,cAAc,GAAGP,IAAI;EACzB,OAAOO,cAAc,GAAGN,EAAE,EAAE;IAC1B;IACA,IAAMO,iBAAiB,GAAGN,UAAU,CAACO,MAAM,CAACC,CAAC,IAAIA,CAAC,CAACV,IAAI,KAAKO,cAAc,CAAC;IAC3E,IAAIC,iBAAiB,CAACG,MAAM,KAAK,CAAC,EAAE;MAClC,MAAM,IAAIP,KAAK,2CAAAC,MAAA,CAC6BF,IAAI,oBAAAE,MAAA,CAAiBE,cAAc,CAC/E,CAAC;IACH;IAEA,IAAIC,iBAAiB,CAACG,MAAM,GAAG,CAAC,EAAE;MAChC,MAAM,IAAIP,KAAK,kDAAAC,MAAA,CACoCF,IAAI,oBAAAE,MAAA,CAAiBE,cAAc,CACtF,CAAC;IACH;IAEA,IAAMK,SAAS,GAAGJ,iBAAiB,CAAC,CAAC,CAAC;IAEtC,IAAI;MACFF,aAAa,GAAGM,SAAS,CAACC,OAAO,CAACP,aAAa,CAAC;MAChDC,cAAc,IAAI,CAAC;IACrB,CAAC,CAAC,OAAOO,CAAC,EAAE;MACV,MAAM,IAAIV,KAAK,oCAAAC,MAAA,CACsBF,IAAI,oBAAAE,MAAA,CAAiBO,SAAS,CAACZ,IAAI,QAAAK,MAAA,CAAKS,CAAC,GAC5E;QAAEC,KAAK,EAAED;MAAE,CACb,CAAC;IACH;EACF;EACA,OAAOR,aAAa;AACtB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASU,kBAAkBA,CAChCC,YAA2B,EAC3BC,MAIC,EACkD;EAAA,IAAAC,qBAAA;EACnD;EACA;EACA,IAAM,CAACC,EAAE,CAAC,GAAGzB,QAAQ,CAAC,MAAMC,MAAM,CAAC,CAAC,CAAC;EACrC,IAAMyB,OAAO,GAAG7B,UAAU,CAACK,sBAAsB,CAAC;EAClD,IAAM;IAAEyB,KAAK,EAAEC,aAAa;IAAEC;EAAK,CAAC,IAAAL,qBAAA,GAAGE,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEI,eAAe,CAAIL,EAAE,CAAC,cAAAD,qBAAA,cAAAA,qBAAA,GAAI;IACxEG,KAAK,EAAEI,SAAS;IAChBF,IAAI,EAAE;EACR,CAAC;;EAED;EACA;EACA;EACA,IAAM,CAACzB,KAAK,EAAE4B,QAAQ,CAAC,GAAGhC,QAAQ,CAAI,MAAM;IAC1C,IAAI4B,aAAa,IAAI,IAAI,IAAIC,IAAI,EAAE;MACjC,OAAO,OAAOP,YAAY,KAAK,UAAU,GACpCA,YAAY,CAAa,CAAC,GAC3BA,YAAY;IAClB;IAEA,IAAIM,aAAa,CAACpB,IAAI,KAAKe,MAAM,CAACf,IAAI,EAAE;MACtC,MAAM,IAAIC,KAAK,+CAAAC,MAAA,CACiCa,MAAM,CAACf,IAAI,eAAAE,MAAA,CAAYkB,aAAa,CAACpB,IAAI,MACzF,CAAC;IACH;IAEA,IAAIoB,aAAa,CAACK,OAAO,KAAKV,MAAM,CAACU,OAAO,EAAE;MAAA,IAAAC,kBAAA;MAC5C,OAAO/B,YAAY,CACjByB,aAAa,CAACxB,KAAK,EACnBwB,aAAa,CAACK,OAAO,EACrBV,MAAM,CAACU,OAAO,GAAAC,kBAAA,GACdX,MAAM,CAAChB,UAAU,cAAA2B,kBAAA,cAAAA,kBAAA,GAAI,EAAE,EACvBX,MAAM,CAACf,IACT,CAAC;IACH;IAEA,OAAOoB,aAAa,CAACxB,KAAK;EAC5B,CAAC,CAAC;EAEF,IAAM+B,eAAe,GAAG;IAAE3B,IAAI,EAAEe,MAAM,CAACf,IAAI;IAAEyB,OAAO,EAAEV,MAAM,CAACU,OAAO;IAAE7B;EAAM,CAAC;EAE7EN,aAAa,CAACqC,eAAe,CAAC;EAE9BT,OAAO,aAAPA,OAAO,eAAPA,OAAO,CAAEU,QAAQ,CAACX,EAAE,EAAEU,eAAe,CAAC;;EAEtC;EACA;EACA;EACApC,SAAS,CACP,SAASsC,8BAA8BA,CAAA,EAAG;IACxCX,OAAO,aAAPA,OAAO,eAAPA,OAAO,CAAEY,mBAAmB,CAAC,CAAC;EAChC,CAAC,EACD,CAACZ,OAAO,EAAEtB,KAAK,CACjB,CAAC;EAEDL,SAAS,CACP,SAASwC,uBAAuBA,CAAA,EAAG;IACjC,OAAO,MAAM;MACXb,OAAO,aAAPA,OAAO,eAAPA,OAAO,CAAEY,mBAAmB,CAAC,CAAC;IAChC,CAAC;EACH,CAAC,EACD,CAACZ,OAAO,CACV,CAAC;EAED,OAAO,CAACtB,KAAK,EAAE4B,QAAQ,CAAC;AAC1B;AAEA,eAAeX,kBAAkB","ignoreList":[]}