@deephaven/dashboard 0.45.2-docs.8 → 0.46.0

package/dist/DashboardPlugin.d.ts

@@ -1,7 +1,7 @@
 import type { Component, ComponentType, ForwardRefExoticComponent, PropsWithoutRef, RefAttributes } from 'react';
 import { ConnectedComponent } from 'react-redux';
 import GoldenLayout from '@deephaven/golden-layout';
-import type { ReactComponentConfig, EventEmitter, Container } from '@deephaven/golden-layout';
+import type { GLPanelProps, ReactComponentConfig } from '@deephaven/golden-layout';
 import PanelManager from './PanelManager';
 /**
  * Alias for the return type of React.forwardRef()
@@ -27,10 +27,19 @@ export type PanelFunctionComponentType<P, R> = ForwardRefComponentType<P, R> & P
 export type WrappedComponentType<P extends PanelProps, C extends ComponentType<P>> = ConnectedComponent<C, P>;
 export type PanelComponentType<P extends PanelProps = PanelProps, C extends ComponentType<P> = ComponentType<P>> = (ComponentType<P> | WrappedComponentType<P, C> | PanelFunctionComponentType<P, unknown>) & PanelStaticMetaData;
 export declare function isWrappedComponent<P extends PanelProps, C extends ComponentType<P>>(type: PanelComponentType<P, C>): type is WrappedComponentType<P, C>;
-export type PanelProps = {
-    glContainer: Container;
-    glEventHub: EventEmitter;
+export type PanelMetadata = {
+    id?: string;
+    name?: string;
+    type?: string;
 };
+export type PanelProps = GLPanelProps & {
+    metadata?: PanelMetadata;
+};
+export type DehydratedPanelProps = Omit<PanelProps, keyof GLPanelProps>;
+export type DashboardPanelProps = PanelProps & {
+    localDashboardId: string;
+};
+export type DehydratedDashboardPanelProps = Omit<DashboardPanelProps, keyof GLPanelProps>;
 export type PanelComponent<T extends PanelProps = PanelProps> = Component<T>;
 export type PanelConfig = ReactComponentConfig & {
     componentState?: Record<string, unknown> | null;
@@ -45,13 +54,13 @@ export interface DashboardPanelDefinition {
     definition: ComponentType;
 }
 export type DeregisterComponentFunction = () => void;
-export type PanelHydrateFunction<T = PanelProps> = (props: T, dashboardId: string) => PanelProps;
+export type PanelHydrateFunction<T extends DehydratedDashboardPanelProps = DehydratedDashboardPanelProps, R extends T = T> = (props: T, dashboardId: string) => R;
 export type PanelDehydrateFunction = (config: PanelConfig, dashboardId: string) => PanelConfig | null;
 export type DashboardPluginComponentProps = {
     id: string;
     layout: GoldenLayout;
     panelManager: PanelManager;
-    registerComponent: <P extends PanelProps, C extends ComponentType<P>>(name: string, ComponentType: PanelComponentType<P, C>, hydrate?: PanelHydrateFunction<P>, dehydrate?: PanelDehydrateFunction) => DeregisterComponentFunction;
+    registerComponent: <P extends DashboardPanelProps, C extends ComponentType<P>>(name: string, ComponentType: PanelComponentType<P, C>, hydrate?: PanelHydrateFunction, dehydrate?: PanelDehydrateFunction) => DeregisterComponentFunction;
 };
 export interface DashboardPlugin {
     panels?: DashboardPanelDefinition[];

package/dist/DashboardPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardPlugin.d.ts","sourceRoot":"","sources":["../src/DashboardPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,yBAAyB,EACzB,eAAe,EACf,aAAa,EACd,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,KAAK,EACV,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACV,MAAM,0BAA0B,CAAC;AAClC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,yBAAyB,CACnE,eAAe,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,EAAE,CAAC,IAAI,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1E,mBAAmB,CAAC;AAEtB,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,IACxB,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7B,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,IAC3C,CACA,aAAa,CAAC,CAAC,CAAC,GAChB,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1B,0BAA0B,CAAC,CAAC,EAAE,OAAO,CAAC,CACzC,GACC,mBAAmB,CAAC;AAEtB,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAC1B,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpE;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,SAAS,CAAC;IACvB,UAAU,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;AAE7E,MAAM,MAAM,WAAW,GAAG,oBAAoB,GAAG;IAC/C,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,aAAa,CAAC;CAC3B;AAED,MAAM,MAAM,2BAA2B,GAAG,MAAM,IAAI,CAAC;AAErD,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,UAAU,IAAI,CACjD,KAAK,EAAE,CAAC,EACR,WAAW,EAAE,MAAM,KAChB,UAAU,CAAC;AAEhB,MAAM,MAAM,sBAAsB,GAAG,CACnC,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,MAAM,KAChB,WAAW,GAAG,IAAI,CAAC;AAExB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,iBAAiB,EAAE,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAClE,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EACvC,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,EACjC,SAAS,CAAC,EAAE,sBAAsB,KAC/B,2BAA2B,CAAC;CAClC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAEpC,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,KAAK,UAAU,CAAC;IAEnE,uHAAuH;IACvH,kBAAkB,CAAC,EAAE,CACnB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,KAChB,WAAW,GAAG,IAAI,CAAC;IAExB,oEAAoE;IACpE,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;IAE/C,oFAAoF;IACpF,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;CAClD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAC5C,KAAK,IAAI,6BAA6B,CAOxC;AAED,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAC5C,OAAO,CAAC,KAAK,IAAI,6BAA6B,CAMhD"}
+{"version":3,"file":"DashboardPlugin.d.ts","sourceRoot":"","sources":["../src/DashboardPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,yBAAyB,EACzB,eAAe,EACf,aAAa,EACd,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAClC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,yBAAyB,CACnE,eAAe,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,EAAE,CAAC,IAAI,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1E,mBAAmB,CAAC;AAEtB,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,IACxB,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7B,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,IAC3C,CACA,aAAa,CAAC,CAAC,CAAC,GAChB,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1B,0BAA0B,CAAC,CAAC,EAAE,OAAO,CAAC,CACzC,GACC,mBAAmB,CAAC;AAEtB,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAC1B,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpE;AAED,MAAM,MAAM,aAAa,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1E,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG;IACtC,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,YAAY,CAAC,CAAC;AAExE,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG;IAAE,gBAAgB,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5E,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAC9C,mBAAmB,EACnB,MAAM,YAAY,CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;AAE7E,MAAM,MAAM,WAAW,GAAG,oBAAoB,GAAG;IAC/C,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,aAAa,CAAC;CAC3B;AAED,MAAM,MAAM,2BAA2B,GAAG,MAAM,IAAI,CAAC;AAErD,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,6BAA6B,GAAG,6BAA6B,EACvE,CAAC,SAAS,CAAC,GAAG,CAAC,IACb,CAAC,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC,CAAC;AAEzC,MAAM,MAAM,sBAAsB,GAAG,CACnC,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,MAAM,KAChB,WAAW,GAAG,IAAI,CAAC;AAExB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,iBAAiB,EAAE,CACjB,CAAC,SAAS,mBAAmB,EAC7B,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAE1B,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EACvC,OAAO,CAAC,EAAE,oBAAoB,EAC9B,SAAS,CAAC,EAAE,sBAAsB,KAC/B,2BAA2B,CAAC;CAClC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAEpC,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,KAAK,UAAU,CAAC;IAEnE,uHAAuH;IACvH,kBAAkB,CAAC,EAAE,CACnB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,KAChB,WAAW,GAAG,IAAI,CAAC;IAExB,oEAAoE;IACpE,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;IAE/C,oFAAoF;IACpF,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;CAClD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAC5C,KAAK,IAAI,6BAA6B,CAOxC;AAED,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAC5C,OAAO,CAAC,KAAK,IAAI,6BAA6B,CAMhD"}

package/dist/DashboardPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardPlugin.js","names":["GoldenLayout","PanelManager","isWrappedComponent","type","WrappedComponent","undefined","isDashboardPluginProps","props","id","layout","panelManager","registerComponent","assertIsDashboardPluginProps","Error"],"sources":["../src/DashboardPlugin.ts"],"sourcesContent":["import type {\n  Component,\n  ComponentType,\n  ForwardRefExoticComponent,\n  PropsWithoutRef,\n  RefAttributes,\n} from 'react';\nimport { ConnectedComponent } from 'react-redux';\nimport GoldenLayout from '@deephaven/golden-layout';\nimport type {\n  ReactComponentConfig,\n  EventEmitter,\n  Container,\n} from '@deephaven/golden-layout';\nimport PanelManager from './PanelManager';\n\n/**\n * Alias for the return type of React.forwardRef()\n */\nexport type ForwardRefComponentType<P, R> = ForwardRefExoticComponent<\n  PropsWithoutRef<P> & RefAttributes<R>\n>;\n\n/**\n * Panel components can provide static props that provide meta data about the\n * panel.\n */\nexport interface PanelStaticMetaData {\n  /**\n   * Should be set to the same name as the component type.\n   * @deprecated Use `displayName` instead.\n   */\n  COMPONENT?: string;\n\n  /** Title of the panel. */\n  TITLE?: string;\n}\n\n/**\n * Panels defined as functional components have to use React.forwardRef.\n */\nexport type PanelFunctionComponentType<P, R> = ForwardRefComponentType<P, R> &\n  PanelStaticMetaData;\n\nexport type WrappedComponentType<\n  P extends PanelProps,\n  C extends ComponentType<P>,\n> = ConnectedComponent<C, P>;\n\nexport type PanelComponentType<\n  P extends PanelProps = PanelProps,\n  C extends ComponentType<P> = ComponentType<P>,\n> = (\n  | ComponentType<P>\n  | WrappedComponentType<P, C>\n  | PanelFunctionComponentType<P, unknown>\n) &\n  PanelStaticMetaData;\n\nexport function isWrappedComponent<\n  P extends PanelProps,\n  C extends ComponentType<P>,\n>(type: PanelComponentType<P, C>): type is WrappedComponentType<P, C> {\n  return (type as WrappedComponentType<P, C>)?.WrappedComponent !== undefined;\n}\n\nexport type PanelProps = {\n  glContainer: Container;\n  glEventHub: EventEmitter;\n};\n\nexport type PanelComponent<T extends PanelProps = PanelProps> = Component<T>;\n\nexport type PanelConfig = ReactComponentConfig & {\n  componentState?: Record<string, unknown> | null;\n};\n\nexport type DashboardConfig = {\n  id: string;\n  layout: GoldenLayout;\n  panelManager: PanelManager;\n};\n\nexport interface DashboardPanelDefinition {\n  name: string;\n  definition: ComponentType;\n}\n\nexport type DeregisterComponentFunction = () => void;\n\nexport type PanelHydrateFunction<T = PanelProps> = (\n  props: T,\n  dashboardId: string\n) => PanelProps;\n\nexport type PanelDehydrateFunction = (\n  config: PanelConfig,\n  dashboardId: string\n) => PanelConfig | null;\n\nexport type DashboardPluginComponentProps = {\n  id: string;\n  layout: GoldenLayout;\n  panelManager: PanelManager;\n  registerComponent: <P extends PanelProps, C extends ComponentType<P>>(\n    name: string,\n    ComponentType: PanelComponentType<P, C>,\n    hydrate?: PanelHydrateFunction<P>,\n    dehydrate?: PanelDehydrateFunction\n  ) => DeregisterComponentFunction;\n};\n\nexport interface DashboardPlugin {\n  panels?: DashboardPanelDefinition[];\n\n  /** Hydrate the provided panel and props. Return the same object if no changes made. */\n  hydrateComponent?: (name: string, props: PanelProps) => PanelProps;\n\n  /** Dehydrate a component. Return the same object if no changes made, or `null` if the component should not be saved */\n  dehydrateComponent?: (\n    name: string,\n    config: PanelConfig\n  ) => PanelConfig | null;\n\n  /** Called when the dashboard is initialized and layout is ready. */\n  initialize?: (config: DashboardConfig) => void;\n\n  /** Called when the dashboard is unintialized and layout is about to be destroyed */\n  deinitialize?: (config: DashboardConfig) => void;\n}\n\n/**\n * Takes a partial DashboardPluginComponentProps and verifies all the dashboard component fields are filled in.\n * @param props The props to check\n * @returns True if the props are valid DashboardPluginComponentProps, false otherwise\n */\nexport function isDashboardPluginProps(\n  props: Partial<DashboardPluginComponentProps>\n): props is DashboardPluginComponentProps {\n  return (\n    typeof props.id === 'string' &&\n    props.layout instanceof GoldenLayout &&\n    props.panelManager instanceof PanelManager &&\n    typeof props.registerComponent === 'function'\n  );\n}\n\nexport function assertIsDashboardPluginProps(\n  props: Partial<DashboardPluginComponentProps>\n): asserts props is DashboardPluginComponentProps {\n  if (!isDashboardPluginProps(props)) {\n    throw new Error(\n      `Expected dashboard plugin props, but instead received ${props}`\n    );\n  }\n}\n"],"mappings":"AAQA,OAAOA,YAAY,MAAM,0BAA0B;AAAC,OAM7CC,YAAY;AAEnB;AACA;AACA;AAyCA,OAAO,SAASC,kBAAkB,CAGhCC,IAA8B,EAAsC;EACpE,OAAO,CAACA,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAiCC,gBAAgB,MAAKC,SAAS;AAC7E;AAmEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsB,CACpCC,KAA6C,EACL;EACxC,OACE,OAAOA,KAAK,CAACC,EAAE,KAAK,QAAQ,IAC5BD,KAAK,CAACE,MAAM,YAAYT,YAAY,IACpCO,KAAK,CAACG,YAAY,YAAYT,YAAY,IAC1C,OAAOM,KAAK,CAACI,iBAAiB,KAAK,UAAU;AAEjD;AAEA,OAAO,SAASC,4BAA4B,CAC1CL,KAA6C,EACG;EAChD,IAAI,CAACD,sBAAsB,CAACC,KAAK,CAAC,EAAE;IAClC,MAAM,IAAIM,KAAK,iEAC4CN,KAAK,EAC/D;EACH;AACF"}
+{"version":3,"file":"DashboardPlugin.js","names":["GoldenLayout","PanelManager","isWrappedComponent","type","WrappedComponent","undefined","isDashboardPluginProps","props","id","layout","panelManager","registerComponent","assertIsDashboardPluginProps","Error"],"sources":["../src/DashboardPlugin.ts"],"sourcesContent":["import type {\n  Component,\n  ComponentType,\n  ForwardRefExoticComponent,\n  PropsWithoutRef,\n  RefAttributes,\n} from 'react';\nimport { ConnectedComponent } from 'react-redux';\nimport GoldenLayout from '@deephaven/golden-layout';\nimport type {\n  GLPanelProps,\n  ReactComponentConfig,\n} from '@deephaven/golden-layout';\nimport PanelManager from './PanelManager';\n\n/**\n * Alias for the return type of React.forwardRef()\n */\nexport type ForwardRefComponentType<P, R> = ForwardRefExoticComponent<\n  PropsWithoutRef<P> & RefAttributes<R>\n>;\n\n/**\n * Panel components can provide static props that provide meta data about the\n * panel.\n */\nexport interface PanelStaticMetaData {\n  /**\n   * Should be set to the same name as the component type.\n   * @deprecated Use `displayName` instead.\n   */\n  COMPONENT?: string;\n\n  /** Title of the panel. */\n  TITLE?: string;\n}\n\n/**\n * Panels defined as functional components have to use React.forwardRef.\n */\nexport type PanelFunctionComponentType<P, R> = ForwardRefComponentType<P, R> &\n  PanelStaticMetaData;\n\nexport type WrappedComponentType<\n  P extends PanelProps,\n  C extends ComponentType<P>,\n> = ConnectedComponent<C, P>;\n\nexport type PanelComponentType<\n  P extends PanelProps = PanelProps,\n  C extends ComponentType<P> = ComponentType<P>,\n> = (\n  | ComponentType<P>\n  | WrappedComponentType<P, C>\n  | PanelFunctionComponentType<P, unknown>\n) &\n  PanelStaticMetaData;\n\nexport function isWrappedComponent<\n  P extends PanelProps,\n  C extends ComponentType<P>,\n>(type: PanelComponentType<P, C>): type is WrappedComponentType<P, C> {\n  return (type as WrappedComponentType<P, C>)?.WrappedComponent !== undefined;\n}\n\nexport type PanelMetadata = { id?: string; name?: string; type?: string };\n\nexport type PanelProps = GLPanelProps & {\n  metadata?: PanelMetadata;\n};\n\nexport type DehydratedPanelProps = Omit<PanelProps, keyof GLPanelProps>;\n\nexport type DashboardPanelProps = PanelProps & { localDashboardId: string };\n\nexport type DehydratedDashboardPanelProps = Omit<\n  DashboardPanelProps,\n  keyof GLPanelProps\n>;\n\nexport type PanelComponent<T extends PanelProps = PanelProps> = Component<T>;\n\nexport type PanelConfig = ReactComponentConfig & {\n  componentState?: Record<string, unknown> | null;\n};\n\nexport type DashboardConfig = {\n  id: string;\n  layout: GoldenLayout;\n  panelManager: PanelManager;\n};\n\nexport interface DashboardPanelDefinition {\n  name: string;\n  definition: ComponentType;\n}\n\nexport type DeregisterComponentFunction = () => void;\n\nexport type PanelHydrateFunction<\n  T extends DehydratedDashboardPanelProps = DehydratedDashboardPanelProps,\n  R extends T = T,\n> = (props: T, dashboardId: string) => R;\n\nexport type PanelDehydrateFunction = (\n  config: PanelConfig,\n  dashboardId: string\n) => PanelConfig | null;\n\nexport type DashboardPluginComponentProps = {\n  id: string;\n  layout: GoldenLayout;\n  panelManager: PanelManager;\n  registerComponent: <\n    P extends DashboardPanelProps,\n    C extends ComponentType<P>,\n  >(\n    name: string,\n    ComponentType: PanelComponentType<P, C>,\n    hydrate?: PanelHydrateFunction,\n    dehydrate?: PanelDehydrateFunction\n  ) => DeregisterComponentFunction;\n};\n\nexport interface DashboardPlugin {\n  panels?: DashboardPanelDefinition[];\n\n  /** Hydrate the provided panel and props. Return the same object if no changes made. */\n  hydrateComponent?: (name: string, props: PanelProps) => PanelProps;\n\n  /** Dehydrate a component. Return the same object if no changes made, or `null` if the component should not be saved */\n  dehydrateComponent?: (\n    name: string,\n    config: PanelConfig\n  ) => PanelConfig | null;\n\n  /** Called when the dashboard is initialized and layout is ready. */\n  initialize?: (config: DashboardConfig) => void;\n\n  /** Called when the dashboard is unintialized and layout is about to be destroyed */\n  deinitialize?: (config: DashboardConfig) => void;\n}\n\n/**\n * Takes a partial DashboardPluginComponentProps and verifies all the dashboard component fields are filled in.\n * @param props The props to check\n * @returns True if the props are valid DashboardPluginComponentProps, false otherwise\n */\nexport function isDashboardPluginProps(\n  props: Partial<DashboardPluginComponentProps>\n): props is DashboardPluginComponentProps {\n  return (\n    typeof props.id === 'string' &&\n    props.layout instanceof GoldenLayout &&\n    props.panelManager instanceof PanelManager &&\n    typeof props.registerComponent === 'function'\n  );\n}\n\nexport function assertIsDashboardPluginProps(\n  props: Partial<DashboardPluginComponentProps>\n): asserts props is DashboardPluginComponentProps {\n  if (!isDashboardPluginProps(props)) {\n    throw new Error(\n      `Expected dashboard plugin props, but instead received ${props}`\n    );\n  }\n}\n"],"mappings":"AAQA,OAAOA,YAAY,MAAM,0BAA0B;AAAC,OAK7CC,YAAY;AAEnB;AACA;AACA;AAyCA,OAAO,SAASC,kBAAkB,CAGhCC,IAA8B,EAAsC;EACpE,OAAO,CAACA,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAiCC,gBAAgB,MAAKC,SAAS;AAC7E;AAgFA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsB,CACpCC,KAA6C,EACL;EACxC,OACE,OAAOA,KAAK,CAACC,EAAE,KAAK,QAAQ,IAC5BD,KAAK,CAACE,MAAM,YAAYT,YAAY,IACpCO,KAAK,CAACG,YAAY,YAAYT,YAAY,IAC1C,OAAOM,KAAK,CAACI,iBAAiB,KAAK,UAAU;AAEjD;AAEA,OAAO,SAASC,4BAA4B,CAC1CL,KAA6C,EACG;EAChD,IAAI,CAACD,sBAAsB,CAACC,KAAK,CAAC,EAAE;IAClC,MAAM,IAAIM,KAAK,iEAC4CN,KAAK,EAC/D;EACH;AACF"}

package/dist/DashboardUtils.d.ts

@@ -1,8 +1,4 @@
-import { PanelConfig, PanelProps } from './DashboardPlugin';
-export type DashboardPanelProps = PanelProps & {
-    localDashboardId: string;
-    metadata?: Record<string, unknown>;
-};
+import { DehydratedDashboardPanelProps, PanelConfig } from './DashboardPlugin';
 /**
  * Dehydrate an existing panel to allow it to be serialized/saved.
  * Just takes what's in the panels `metadata` in the props and `panelState` in
@@ -18,7 +14,7 @@ export declare function dehydrate(config: PanelConfig): PanelConfig | null;
  * @param localDashboardId The local dashboard ID to hydrate the panel with
  * @returns The hydrated panel props
  */
-export declare function hydrate(props: PanelProps & Record<string, unknown>, localDashboardId?: string): DashboardPanelProps;
+export declare function hydrate<T extends DehydratedDashboardPanelProps>(props: T, localDashboardId?: string): T;
 declare const _default: {
     dehydrate: typeof dehydrate;
     hydrate: typeof hydrate;

package/dist/DashboardUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardUtils.d.ts","sourceRoot":"","sources":["../src/DashboardUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE5D,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG;IAC7C,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,IAAI,CAqBjE;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,gBAAgB,SAAK,GACpB,mBAAmB,CAMrB;;;;;AAED,wBAGE"}
+{"version":3,"file":"DashboardUtils.d.ts","sourceRoot":"","sources":["../src/DashboardUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAE/E;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,IAAI,CAqBjE;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,6BAA6B,EAC7D,KAAK,EAAE,CAAC,EACR,gBAAgB,SAAK,GACpB,CAAC,CAMH;;;;;AAED,wBAGE"}

package/dist/DashboardUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardUtils.js","names":["dehydrate","config","props","componentState","metadata","panelState","newProps","type","hydrate","localDashboardId"],"sources":["../src/DashboardUtils.ts"],"sourcesContent":["import { PanelConfig, PanelProps } from './DashboardPlugin';\n\nexport type DashboardPanelProps = PanelProps & {\n  localDashboardId: string;\n  metadata?: Record<string, unknown>;\n};\n\n/**\n * Dehydrate an existing panel to allow it to be serialized/saved.\n * Just takes what's in the panels `metadata` in the props and `panelState` in\n * the component state, assumes it's serializable, and saves it.\n * @param config The panel config to dehydrate\n * @returns The dehydrated PanelConfig\n */\nexport function dehydrate(config: PanelConfig): PanelConfig | null {\n  const { props, componentState } = config;\n  const { metadata } = props;\n  let { panelState = null } = props;\n  if (componentState) {\n    ({ panelState } = componentState);\n  }\n  const newProps: Record<string, unknown> = {};\n  if (metadata != null) {\n    newProps.metadata = metadata;\n  }\n  if (panelState != null) {\n    newProps.panelState = panelState;\n  }\n\n  return {\n    ...config,\n    componentState: null,\n    props: newProps,\n    type: 'react-component',\n  };\n}\n\n/**\n * Default hydration function. Just applies the dashboard ID. When used with dehydrate above,\n * the panels state will be stored in `panelState` prop.\n * @param props Panel props to hydrate\n * @param localDashboardId The local dashboard ID to hydrate the panel with\n * @returns The hydrated panel props\n */\nexport function hydrate(\n  props: PanelProps & Record<string, unknown>,\n  localDashboardId = ''\n): DashboardPanelProps {\n  return {\n    metadata: {},\n    ...props,\n    localDashboardId,\n  };\n}\n\nexport default {\n  dehydrate,\n  hydrate,\n};\n"],"mappings":";;;;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,SAAS,CAACC,MAAmB,EAAsB;EACjE,IAAM;IAAEC,KAAK;IAAEC;EAAe,CAAC,GAAGF,MAAM;EACxC,IAAM;IAAEG;EAAS,CAAC,GAAGF,KAAK;EAC1B,IAAI;IAAEG,UAAU,GAAG;EAAK,CAAC,GAAGH,KAAK;EACjC,IAAIC,cAAc,EAAE;IAClB,CAAC;MAAEE;IAAW,CAAC,GAAGF,cAAc;EAClC;EACA,IAAMG,QAAiC,GAAG,CAAC,CAAC;EAC5C,IAAIF,QAAQ,IAAI,IAAI,EAAE;IACpBE,QAAQ,CAACF,QAAQ,GAAGA,QAAQ;EAC9B;EACA,IAAIC,UAAU,IAAI,IAAI,EAAE;IACtBC,QAAQ,CAACD,UAAU,GAAGA,UAAU;EAClC;EAEA,uCACKJ,MAAM;IACTE,cAAc,EAAE,IAAI;IACpBD,KAAK,EAAEI,QAAQ;IACfC,IAAI,EAAE;EAAiB;AAE3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,OAAO,CACrBN,KAA2C,EAEtB;EAAA,IADrBO,gBAAgB,uEAAG,EAAE;EAErB;IACEL,QAAQ,EAAE,CAAC;EAAC,GACTF,KAAK;IACRO;EAAgB;AAEpB;AAEA,eAAe;EACbT,SAAS;EACTQ;AACF,CAAC"}
+{"version":3,"file":"DashboardUtils.js","names":["dehydrate","config","props","componentState","metadata","panelState","newProps","type","hydrate","localDashboardId"],"sources":["../src/DashboardUtils.ts"],"sourcesContent":["import { DehydratedDashboardPanelProps, PanelConfig } from './DashboardPlugin';\n\n/**\n * Dehydrate an existing panel to allow it to be serialized/saved.\n * Just takes what's in the panels `metadata` in the props and `panelState` in\n * the component state, assumes it's serializable, and saves it.\n * @param config The panel config to dehydrate\n * @returns The dehydrated PanelConfig\n */\nexport function dehydrate(config: PanelConfig): PanelConfig | null {\n  const { props, componentState } = config;\n  const { metadata } = props;\n  let { panelState = null } = props;\n  if (componentState) {\n    ({ panelState } = componentState);\n  }\n  const newProps: Record<string, unknown> = {};\n  if (metadata != null) {\n    newProps.metadata = metadata;\n  }\n  if (panelState != null) {\n    newProps.panelState = panelState;\n  }\n\n  return {\n    ...config,\n    componentState: null,\n    props: newProps,\n    type: 'react-component',\n  };\n}\n\n/**\n * Default hydration function. Just applies the dashboard ID. When used with dehydrate above,\n * the panels state will be stored in `panelState` prop.\n * @param props Panel props to hydrate\n * @param localDashboardId The local dashboard ID to hydrate the panel with\n * @returns The hydrated panel props\n */\nexport function hydrate<T extends DehydratedDashboardPanelProps>(\n  props: T,\n  localDashboardId = ''\n): T {\n  return {\n    metadata: {},\n    ...props,\n    localDashboardId,\n  };\n}\n\nexport default {\n  dehydrate,\n  hydrate,\n};\n"],"mappings":";;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,SAAS,CAACC,MAAmB,EAAsB;EACjE,IAAM;IAAEC,KAAK;IAAEC;EAAe,CAAC,GAAGF,MAAM;EACxC,IAAM;IAAEG;EAAS,CAAC,GAAGF,KAAK;EAC1B,IAAI;IAAEG,UAAU,GAAG;EAAK,CAAC,GAAGH,KAAK;EACjC,IAAIC,cAAc,EAAE;IAClB,CAAC;MAAEE;IAAW,CAAC,GAAGF,cAAc;EAClC;EACA,IAAMG,QAAiC,GAAG,CAAC,CAAC;EAC5C,IAAIF,QAAQ,IAAI,IAAI,EAAE;IACpBE,QAAQ,CAACF,QAAQ,GAAGA,QAAQ;EAC9B;EACA,IAAIC,UAAU,IAAI,IAAI,EAAE;IACtBC,QAAQ,CAACD,UAAU,GAAGA,UAAU;EAClC;EAEA,uCACKJ,MAAM;IACTE,cAAc,EAAE,IAAI;IACpBD,KAAK,EAAEI,QAAQ;IACfC,IAAI,EAAE;EAAiB;AAE3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,OAAO,CACrBN,KAAQ,EAEL;EAAA,IADHO,gBAAgB,uEAAG,EAAE;EAErB;IACEL,QAAQ,EAAE,CAAC;EAAC,GACTF,KAAK;IACRO;EAAgB;AAEpB;AAEA,eAAe;EACbT,SAAS;EACTQ;AACF,CAAC"}

package/dist/PanelEvent.d.ts

@@ -1,3 +1,19 @@
+import { DragEvent } from 'react';
+export type WidgetDefinition = {
+    type: string;
+    /**
+     * @deprecated Use `title` instead.
+     */
+    name?: string;
+    title?: string;
+    id?: string;
+};
+export type PanelOpenEventDetail = {
+    dragEvent?: DragEvent;
+    fetch?: () => Promise<unknown>;
+    panelId?: string;
+    widget: WidgetDefinition;
+};
 /**
  * Events emitted by panels and to control panels
  */

package/dist/PanelEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PanelEvent.d.ts","sourceRoot":"","sources":["../src/PanelEvent.ts"],"names":[],"mappings":"AAAA;;GAEG;;;;;;;;;;;;;;;AACH,wBAsCG"}
+{"version":3,"file":"PanelEvent.d.ts","sourceRoot":"","sources":["../src/PanelEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF;;GAEG;;;;;;;;;;;;;;;AACH,wBAsCG"}

package/dist/PanelEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"PanelEvent.js","names":["Object","freeze","FOCUS","MOUNT","UNMOUNT","TITLE_CHANGED","REOPEN","DELETE","CLONED","CLOSED","OPEN","CLOSE","DRAGGING","DROPPED"],"sources":["../src/PanelEvent.ts"],"sourcesContent":["/**\n * Events emitted by panels and to control panels\n */\nexport default Object.freeze({\n  // Panel has received focus\n  FOCUS: 'PanelEvent.FOCUS',\n\n  // Panel has been mounted\n  MOUNT: 'PanelEvent.MOUNT',\n\n  // Panel has been unmounted\n  UNMOUNT: 'PanelEvent.UNMOUNT',\n\n  // The title of the panel has changed\n  TITLE_CHANGED: 'PanelEvent.TITLE_CHANGED',\n\n  // Panel was re-opened from a dehydrated state\n  REOPEN: 'PanelEvent.REOPEN',\n\n  // Panel was deleted\n  DELETE: 'PanelEvent.DELETE',\n\n  // Panel was cloned/copied\n  CLONED: 'PanelEvent.CLONED',\n\n  // Panel was closed\n  CLOSED: 'PanelEvent.CLOSED',\n\n  // Event to open a new panel\n  // Plugins will need to register to open based on this event.\n  // Multiple plugins could open panels for the same event if desired.\n  OPEN: 'PanelEvent.OPEN',\n\n  // Event to close a panel that's currently open\n  CLOSE: 'PanelEvent.CLOSE',\n\n  // Panel is being dragged\n  DRAGGING: 'PanelEvent.DRAGGING',\n\n  // Panel is dropped\n  DROPPED: 'PanelEvent.DROPPED',\n});\n"],"mappings":"AAAA;AACA;AACA;AACA,eAAeA,MAAM,CAACC,MAAM,CAAC;EAC3B;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,OAAO,EAAE,oBAAoB;EAE7B;EACAC,aAAa,EAAE,0BAA0B;EAEzC;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACA;EACA;EACAC,IAAI,EAAE,iBAAiB;EAEvB;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,QAAQ,EAAE,qBAAqB;EAE/B;EACAC,OAAO,EAAE;AACX,CAAC,CAAC"}
+{"version":3,"file":"PanelEvent.js","names":["Object","freeze","FOCUS","MOUNT","UNMOUNT","TITLE_CHANGED","REOPEN","DELETE","CLONED","CLOSED","OPEN","CLOSE","DRAGGING","DROPPED"],"sources":["../src/PanelEvent.ts"],"sourcesContent":["import { DragEvent } from 'react';\n\nexport type WidgetDefinition = {\n  type: string;\n\n  /**\n   * @deprecated Use `title` instead.\n   */\n  name?: string;\n\n  title?: string;\n\n  id?: string;\n};\n\nexport type PanelOpenEventDetail = {\n  dragEvent?: DragEvent;\n  fetch?: () => Promise<unknown>;\n  panelId?: string;\n  widget: WidgetDefinition;\n};\n\n/**\n * Events emitted by panels and to control panels\n */\nexport default Object.freeze({\n  // Panel has received focus\n  FOCUS: 'PanelEvent.FOCUS',\n\n  // Panel has been mounted\n  MOUNT: 'PanelEvent.MOUNT',\n\n  // Panel has been unmounted\n  UNMOUNT: 'PanelEvent.UNMOUNT',\n\n  // The title of the panel has changed\n  TITLE_CHANGED: 'PanelEvent.TITLE_CHANGED',\n\n  // Panel was re-opened from a dehydrated state\n  REOPEN: 'PanelEvent.REOPEN',\n\n  // Panel was deleted\n  DELETE: 'PanelEvent.DELETE',\n\n  // Panel was cloned/copied\n  CLONED: 'PanelEvent.CLONED',\n\n  // Panel was closed\n  CLOSED: 'PanelEvent.CLOSED',\n\n  // Event to open a new panel\n  // Plugins will need to register to open based on this event.\n  // Multiple plugins could open panels for the same event if desired.\n  OPEN: 'PanelEvent.OPEN',\n\n  // Event to close a panel that's currently open\n  CLOSE: 'PanelEvent.CLOSE',\n\n  // Panel is being dragged\n  DRAGGING: 'PanelEvent.DRAGGING',\n\n  // Panel is dropped\n  DROPPED: 'PanelEvent.DROPPED',\n});\n"],"mappings":"AAsBA;AACA;AACA;AACA,eAAeA,MAAM,CAACC,MAAM,CAAC;EAC3B;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,OAAO,EAAE,oBAAoB;EAE7B;EACAC,aAAa,EAAE,0BAA0B;EAEzC;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACA;EACA;EACAC,IAAI,EAAE,iBAAiB;EAEvB;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,QAAQ,EAAE,qBAAqB;EAE/B;EACAC,OAAO,EAAE;AACX,CAAC,CAAC"}

package/dist/PanelPlaceholder.d.ts

@@ -1,9 +1,10 @@
 import React from 'react';
 import './PanelPlaceholder.scss';
-import { PanelProps } from './DashboardPlugin';
 /**
  * Displays a placeholder for unregistered panel types.
  */
-declare const PanelPlaceholder: React.ForwardRefExoticComponent<PanelProps & React.RefAttributes<HTMLDivElement>>;
+declare const PanelPlaceholder: React.ForwardRefExoticComponent<import("@deephaven/golden-layout").GLPanelProps & {
+    metadata?: import("./DashboardPlugin").PanelMetadata | undefined;
+} & React.RefAttributes<HTMLDivElement>>;
 export default PanelPlaceholder;
 //# sourceMappingURL=PanelPlaceholder.d.ts.map

package/dist/PanelPlaceholder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PanelPlaceholder.d.ts","sourceRoot":"","sources":["../src/PanelPlaceholder.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuB,MAAM,OAAO,CAAC;AAC5C,OAAO,yBAAyB,CAAC;AAEjC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;GAEG;AACH,QAAA,MAAM,gBAAgB,mFASrB,CAAC;AAIF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"PanelPlaceholder.d.ts","sourceRoot":"","sources":["../src/PanelPlaceholder.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuB,MAAM,OAAO,CAAC;AAC5C,OAAO,yBAAyB,CAAC;AAIjC;;GAEG;AACH,QAAA,MAAM,gBAAgB;;wCASrB,CAAC;AAIF,eAAe,gBAAgB,CAAC"}

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { default as DashboardUtils } from './DashboardUtils';
 export * from './layout';
 export * from './redux';
 export * from './PanelManager';
+export * from './PanelEvent';
 export { default as PanelEvent } from './PanelEvent';
 export { default as PanelErrorBoundary } from './PanelErrorBoundary';
 export { default as PanelManager } from './PanelManager';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,eAAe,SAAS,CAAC;AAEzB,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,eAAe,SAAS,CAAC;AAEzB,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -9,6 +9,7 @@ export { default as DashboardUtils } from "./DashboardUtils.js";
 export * from "./layout/index.js";
 export * from "./redux/index.js";
 export * from "./PanelManager.js";
+export * from "./PanelEvent.js";
 export { default as PanelEvent } from "./PanelEvent.js";
 export { default as PanelErrorBoundary } from "./PanelErrorBoundary.js";
 export { default as PanelManager } from "./PanelManager.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Dashboard","default","DashboardUtils","PanelEvent","PanelErrorBoundary","PanelManager"],"sources":["../src/index.ts"],"sourcesContent":["import Dashboard from './Dashboard';\n\nexport default Dashboard;\n\nexport * from './Dashboard';\nexport * from './DashboardConstants';\nexport * from './DashboardPlugin';\nexport * from './DashboardLayout';\nexport * from './DashboardUtils';\nexport { default as DashboardUtils } from './DashboardUtils';\nexport * from './layout';\nexport * from './redux';\nexport * from './PanelManager';\nexport { default as PanelEvent } from './PanelEvent';\nexport { default as PanelErrorBoundary } from './PanelErrorBoundary';\nexport { default as PanelManager } from './PanelManager';\n"],"mappings":"OAAOA,SAAS;AAEhB,eAAeA,SAAS;AAAC;AAAA;AAAA;AAAA;AAAA;AAAA,SAOhBC,OAAO,IAAIC,cAAc;AAAA;AAAA;AAAA;AAAA,SAIzBD,OAAO,IAAIE,UAAU;AAAA,SACrBF,OAAO,IAAIG,kBAAkB;AAAA,SAC7BH,OAAO,IAAII,YAAY"}
+{"version":3,"file":"index.js","names":["Dashboard","default","DashboardUtils","PanelEvent","PanelErrorBoundary","PanelManager"],"sources":["../src/index.ts"],"sourcesContent":["import Dashboard from './Dashboard';\n\nexport default Dashboard;\n\nexport * from './Dashboard';\nexport * from './DashboardConstants';\nexport * from './DashboardPlugin';\nexport * from './DashboardLayout';\nexport * from './DashboardUtils';\nexport { default as DashboardUtils } from './DashboardUtils';\nexport * from './layout';\nexport * from './redux';\nexport * from './PanelManager';\nexport * from './PanelEvent';\nexport { default as PanelEvent } from './PanelEvent';\nexport { default as PanelErrorBoundary } from './PanelErrorBoundary';\nexport { default as PanelManager } from './PanelManager';\n"],"mappings":"OAAOA,SAAS;AAEhB,eAAeA,SAAS;AAAC;AAAA;AAAA;AAAA;AAAA;AAAA,SAOhBC,OAAO,IAAIC,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA,SAKzBD,OAAO,IAAIE,UAAU;AAAA,SACrBF,OAAO,IAAIG,kBAAkB;AAAA,SAC7BH,OAAO,IAAII,YAAY"}

package/dist/layout/index.d.ts

@@ -1,5 +1,6 @@
 export { default as LayoutUtils } from './LayoutUtils';
 export { default as GLPropTypes } from './GLPropTypes';
-export * from './hooks';
+export { default as useDashboardPanel } from './useDashboardPanel';
+export { default as useListener } from './useListener';
 export { default as usePanelRegistration } from './usePanelRegistration';
 //# sourceMappingURL=index.d.ts.map

package/dist/layout/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/layout/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AAEvD,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/layout/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/layout/index.js

@@ -1,5 +1,6 @@
 export { default as LayoutUtils } from "./LayoutUtils.js";
 export { default as GLPropTypes } from "./GLPropTypes.js";
-export * from "./hooks.js";
+export { default as useDashboardPanel } from "./useDashboardPanel.js";
+export { default as useListener } from "./useListener.js";
 export { default as usePanelRegistration } from "./usePanelRegistration.js";
 //# sourceMappingURL=index.js.map

package/dist/layout/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["default","LayoutUtils","GLPropTypes","usePanelRegistration"],"sources":["../../src/layout/index.ts"],"sourcesContent":["export { default as LayoutUtils } from './LayoutUtils';\nexport { default as GLPropTypes } from './GLPropTypes';\n\nexport * from './hooks';\nexport { default as usePanelRegistration } from './usePanelRegistration';\n"],"mappings":"SAASA,OAAO,IAAIC,WAAW;AAAA,SACtBD,OAAO,IAAIE,WAAW;AAAA;AAAA,SAGtBF,OAAO,IAAIG,oBAAoB"}
+{"version":3,"file":"index.js","names":["default","LayoutUtils","GLPropTypes","useDashboardPanel","useListener","usePanelRegistration"],"sources":["../../src/layout/index.ts"],"sourcesContent":["export { default as LayoutUtils } from './LayoutUtils';\nexport { default as GLPropTypes } from './GLPropTypes';\nexport { default as useDashboardPanel } from './useDashboardPanel';\nexport { default as useListener } from './useListener';\nexport { default as usePanelRegistration } from './usePanelRegistration';\n"],"mappings":"SAASA,OAAO,IAAIC,WAAW;AAAA,SACtBD,OAAO,IAAIE,WAAW;AAAA,SACtBF,OAAO,IAAIG,iBAAiB;AAAA,SAC5BH,OAAO,IAAII,WAAW;AAAA,SACtBJ,OAAO,IAAIK,oBAAoB"}

package/dist/layout/useDashboardPanel.d.ts

@@ -0,0 +1,21 @@
+import { ComponentType } from 'react';
+import { DashboardPanelProps, DashboardPluginComponentProps, PanelComponentType, PanelDehydrateFunction, PanelHydrateFunction } from '../DashboardPlugin';
+/**
+ * Register a panel that will be opened when one of the `supportedTypes` objects is triggered.
+ */
+export declare function useDashboardPanel<P extends DashboardPanelProps, C extends ComponentType<P>>({ dashboardProps, componentName, component, supportedTypes, hydrate, dehydrate, }: {
+    /** Props from the dashboard this panel is being registered in */
+    dashboardProps: DashboardPluginComponentProps;
+    /** Name of the component to register */
+    componentName: string;
+    /** Component type to register */
+    component: PanelComponentType<P, C>;
+    /** Names of the supported variable types this panel opens for */
+    supportedTypes: string | string[];
+    /** Custom hydration function to call when opening a panel */
+    hydrate?: PanelHydrateFunction;
+    /** Custom dehydration function to call when saving a panel's state to the layout */
+    dehydrate?: PanelDehydrateFunction;
+}): void;
+export default useDashboardPanel;
+//# sourceMappingURL=useDashboardPanel.d.ts.map

package/dist/layout/useDashboardPanel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDashboardPanel.d.ts","sourceRoot":"","sources":["../../src/layout/useDashboardPanel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAe,MAAM,OAAO,CAAC;AAGnD,OAAO,EACL,mBAAmB,EACnB,6BAA6B,EAE7B,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAM5B;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,mBAAmB,EAC7B,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAC1B,EACA,cAAc,EACd,aAAa,EACb,SAAS,EACT,cAAc,EACd,OAAO,EACP,SAAS,GACV,EAAE;IACD,iEAAiE;IACjE,cAAc,EAAE,6BAA6B,CAAC;IAE9C,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAC;IAEtB,iCAAiC;IACjC,SAAS,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEpC,iEAAiE;IACjE,cAAc,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAElC,6DAA6D;IAC7D,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAE/B,oFAAoF;IACpF,SAAS,CAAC,EAAE,sBAAsB,CAAC;CACpC,QAmDA;AAED,eAAe,iBAAiB,CAAC"}

package/dist/layout/useDashboardPanel.js

@@ -0,0 +1,83 @@
+import { useCallback } from 'react';
+import shortid from 'shortid';
+import PanelEvent from "../PanelEvent.js";
+import LayoutUtils from "./LayoutUtils.js";
+import useListener from "./useListener.js";
+import usePanelRegistration from "./usePanelRegistration.js";
+/**
+ * Register a panel that will be opened when one of the `supportedTypes` objects is triggered.
+ */
+export function useDashboardPanel(_ref) {
+  var {
+    dashboardProps,
+    componentName,
+    component,
+    supportedTypes,
+    hydrate,
+    dehydrate
+  } = _ref;
+  var {
+    id,
+    layout,
+    registerComponent
+  } = dashboardProps;
+  var handlePanelOpen = useCallback(_ref2 => {
+    var _widget$title;
+    var {
+      dragEvent,
+      fetch,
+      panelId = shortid.generate(),
+      widget
+    } = _ref2;
+    var {
+      id: widgetId,
+      type
+    } = widget;
+    var name = (_widget$title = widget.title) !== null && _widget$title !== void 0 ? _widget$title : widget.name;
+    var isSupportedType = Array.isArray(supportedTypes) && supportedTypes.includes(type) || type === supportedTypes;
+    if (!isSupportedType) {
+      // Only want to listen for your custom variable types
+      return;
+    }
+    var metadata = {
+      id: widgetId,
+      name,
+      type
+    };
+    var props = {
+      localDashboardId: id,
+      metadata,
+      fetch
+    };
+    if (hydrate != null) {
+      props = hydrate(props, id);
+    }
+    var config = {
+      type: 'react-component',
+      component: componentName,
+      props,
+      title: name,
+      id: panelId
+    };
+    var {
+      root
+    } = layout;
+    LayoutUtils.openComponent({
+      root,
+      config,
+      dragEvent
+    });
+  }, [componentName, hydrate, id, layout, supportedTypes]);
+
+  /**
+   * Register our custom component type so the layout know hows to open it
+   */
+  usePanelRegistration(registerComponent, component, hydrate, dehydrate);
+
+  /**
+   * Listen for panel open events so we know when to open a panel
+   */
+  useListener(layout.eventHub, PanelEvent.OPEN, handlePanelOpen);
+}
+export default useDashboardPanel;
+//# sourceMappingURL=useDashboardPanel.js.map

package/dist/layout/useDashboardPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDashboardPanel.js","names":["useCallback","shortid","PanelEvent","LayoutUtils","useListener","usePanelRegistration","useDashboardPanel","dashboardProps","componentName","component","supportedTypes","hydrate","dehydrate","id","layout","registerComponent","handlePanelOpen","dragEvent","fetch","panelId","generate","widget","widgetId","type","name","title","isSupportedType","Array","isArray","includes","metadata","props","localDashboardId","config","root","openComponent","eventHub","OPEN"],"sources":["../../src/layout/useDashboardPanel.ts"],"sourcesContent":["import { ComponentType, useCallback } from 'react';\nimport type { ReactComponentConfig } from '@deephaven/golden-layout';\nimport shortid from 'shortid';\nimport {\n  DashboardPanelProps,\n  DashboardPluginComponentProps,\n  DehydratedDashboardPanelProps,\n  PanelComponentType,\n  PanelDehydrateFunction,\n  PanelHydrateFunction,\n} from '../DashboardPlugin';\nimport PanelEvent, { PanelOpenEventDetail } from '../PanelEvent';\nimport LayoutUtils from './LayoutUtils';\nimport useListener from './useListener';\nimport usePanelRegistration from './usePanelRegistration';\n\n/**\n * Register a panel that will be opened when one of the `supportedTypes` objects is triggered.\n */\nexport function useDashboardPanel<\n  P extends DashboardPanelProps,\n  C extends ComponentType<P>,\n>({\n  dashboardProps,\n  componentName,\n  component,\n  supportedTypes,\n  hydrate,\n  dehydrate,\n}: {\n  /** Props from the dashboard this panel is being registered in */\n  dashboardProps: DashboardPluginComponentProps;\n\n  /** Name of the component to register */\n  componentName: string;\n\n  /** Component type to register */\n  component: PanelComponentType<P, C>;\n\n  /** Names of the supported variable types this panel opens for */\n  supportedTypes: string | string[];\n\n  /** Custom hydration function to call when opening a panel */\n  hydrate?: PanelHydrateFunction;\n\n  /** Custom dehydration function to call when saving a panel's state to the layout */\n  dehydrate?: PanelDehydrateFunction;\n}) {\n  const { id, layout, registerComponent } = dashboardProps;\n\n  const handlePanelOpen = useCallback(\n    ({\n      dragEvent,\n      fetch,\n      panelId = shortid.generate(),\n      widget,\n    }: PanelOpenEventDetail) => {\n      const { id: widgetId, type } = widget;\n      const name = widget.title ?? widget.name;\n      const isSupportedType =\n        (Array.isArray(supportedTypes) && supportedTypes.includes(type)) ||\n        type === supportedTypes;\n      if (!isSupportedType) {\n        // Only want to listen for your custom variable types\n        return;\n      }\n      const metadata = { id: widgetId, name, type };\n      let props: DehydratedDashboardPanelProps & { fetch?: typeof fetch } = {\n        localDashboardId: id,\n        metadata,\n        fetch,\n      };\n      if (hydrate != null) {\n        props = hydrate(props, id);\n      }\n      const config: ReactComponentConfig = {\n        type: 'react-component',\n        component: componentName,\n        props,\n        title: name,\n        id: panelId,\n      };\n\n      const { root } = layout;\n      LayoutUtils.openComponent({ root, config, dragEvent });\n    },\n    [componentName, hydrate, id, layout, supportedTypes]\n  );\n\n  /**\n   * Register our custom component type so the layout know hows to open it\n   */\n  usePanelRegistration(registerComponent, component, hydrate, dehydrate);\n\n  /**\n   * Listen for panel open events so we know when to open a panel\n   */\n  useListener(layout.eventHub, PanelEvent.OPEN, handlePanelOpen);\n}\n\nexport default useDashboardPanel;\n"],"mappings":"AAAA,SAAwBA,WAAW,QAAQ,OAAO;AAElD,OAAOC,OAAO,MAAM,SAAS;AAAC,OASvBC,UAAU;AAAA,OACVC,WAAW;AAAA,OACXC,WAAW;AAAA,OACXC,oBAAoB;AAE3B;AACA;AACA;AACA,OAAO,SAASC,iBAAiB,OA4B9B;EAAA,IAzBD;IACAC,cAAc;IACdC,aAAa;IACbC,SAAS;IACTC,cAAc;IACdC,OAAO;IACPC;EAmBF,CAAC;EACC,IAAM;IAAEC,EAAE;IAAEC,MAAM;IAAEC;EAAkB,CAAC,GAAGR,cAAc;EAExD,IAAMS,eAAe,GAAGhB,WAAW,CACjC,SAK4B;IAAA;IAAA,IAL3B;MACCiB,SAAS;MACTC,KAAK;MACLC,OAAO,GAAGlB,OAAO,CAACmB,QAAQ,EAAE;MAC5BC;IACoB,CAAC;IACrB,IAAM;MAAER,EAAE,EAAES,QAAQ;MAAEC;IAAK,CAAC,GAAGF,MAAM;IACrC,IAAMG,IAAI,oBAAGH,MAAM,CAACI,KAAK,yDAAIJ,MAAM,CAACG,IAAI;IACxC,IAAME,eAAe,GAClBC,KAAK,CAACC,OAAO,CAAClB,cAAc,CAAC,IAAIA,cAAc,CAACmB,QAAQ,CAACN,IAAI,CAAC,IAC/DA,IAAI,KAAKb,cAAc;IACzB,IAAI,CAACgB,eAAe,EAAE;MACpB;MACA;IACF;IACA,IAAMI,QAAQ,GAAG;MAAEjB,EAAE,EAAES,QAAQ;MAAEE,IAAI;MAAED;IAAK,CAAC;IAC7C,IAAIQ,KAA+D,GAAG;MACpEC,gBAAgB,EAAEnB,EAAE;MACpBiB,QAAQ;MACRZ;IACF,CAAC;IACD,IAAIP,OAAO,IAAI,IAAI,EAAE;MACnBoB,KAAK,GAAGpB,OAAO,CAACoB,KAAK,EAAElB,EAAE,CAAC;IAC5B;IACA,IAAMoB,MAA4B,GAAG;MACnCV,IAAI,EAAE,iBAAiB;MACvBd,SAAS,EAAED,aAAa;MACxBuB,KAAK;MACLN,KAAK,EAAED,IAAI;MACXX,EAAE,EAAEM;IACN,CAAC;IAED,IAAM;MAAEe;IAAK,CAAC,GAAGpB,MAAM;IACvBX,WAAW,CAACgC,aAAa,CAAC;MAAED,IAAI;MAAED,MAAM;MAAEhB;IAAU,CAAC,CAAC;EACxD,CAAC,EACD,CAACT,aAAa,EAAEG,OAAO,EAAEE,EAAE,EAAEC,MAAM,EAAEJ,cAAc,CAAC,CACrD;;EAED;AACF;AACA;EACEL,oBAAoB,CAACU,iBAAiB,EAAEN,SAAS,EAAEE,OAAO,EAAEC,SAAS,CAAC;;EAEtE;AACF;AACA;EACER,WAAW,CAACU,MAAM,CAACsB,QAAQ,EAAElC,UAAU,CAACmC,IAAI,EAAErB,eAAe,CAAC;AAChE;AAEA,eAAeV,iBAAiB"}

package/dist/layout/useListener.d.ts

@@ -0,0 +1,10 @@
+import type { EventEmitter } from '@deephaven/golden-layout';
+/**
+ * Listen for a specific event on an EventEmitter
+ * @param eventEmitter EventEmitter to listen to
+ * @param eventName Name of the event to listen to
+ * @param callback Callback to call when the event is triggered
+ */
+export declare function useListener(eventEmitter: EventEmitter, eventName: string, callback: Function): void;
+export default useListener;
+//# sourceMappingURL=useListener.d.ts.map

package/dist/layout/useListener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListener.d.ts","sourceRoot":"","sources":["../../src/layout/useListener.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,MAAM,EAEjB,QAAQ,EAAE,QAAQ,GACjB,IAAI,CAWN;AAED,eAAe,WAAW,CAAC"}

package/dist/layout/useListener.js

@@ -0,0 +1,19 @@
+import { useEffect } from 'react';
+/**
+ * Listen for a specific event on an EventEmitter
+ * @param eventEmitter EventEmitter to listen to
+ * @param eventName Name of the event to listen to
+ * @param callback Callback to call when the event is triggered
+ */
+export function useListener(eventEmitter, eventName,
+// eslint-disable-next-line @typescript-eslint/ban-types
+callback) {
+  useEffect(function initEventEmitter() {
+    eventEmitter.on(eventName, callback);
+    return () => {
+      eventEmitter.off(eventName, callback);
+    };
+  }, [eventEmitter, eventName, callback]);
+}
+export default useListener;
+//# sourceMappingURL=useListener.js.map

package/dist/layout/useListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListener.js","names":["useEffect","useListener","eventEmitter","eventName","callback","initEventEmitter","on","off"],"sources":["../../src/layout/useListener.ts"],"sourcesContent":["import { useEffect } from 'react';\nimport type { EventEmitter } from '@deephaven/golden-layout';\n\n/**\n * Listen for a specific event on an EventEmitter\n * @param eventEmitter EventEmitter to listen to\n * @param eventName Name of the event to listen to\n * @param callback Callback to call when the event is triggered\n */\nexport function useListener(\n  eventEmitter: EventEmitter,\n  eventName: string,\n  // eslint-disable-next-line @typescript-eslint/ban-types\n  callback: Function\n): void {\n  useEffect(\n    function initEventEmitter() {\n      eventEmitter.on(eventName, callback);\n\n      return () => {\n        eventEmitter.off(eventName, callback);\n      };\n    },\n    [eventEmitter, eventName, callback]\n  );\n}\n\nexport default useListener;\n"],"mappings":"AAAA,SAASA,SAAS,QAAQ,OAAO;AAGjC;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,WAAW,CACzBC,YAA0B,EAC1BC,SAAiB;AACjB;AACAC,QAAkB,EACZ;EACNJ,SAAS,CACP,SAASK,gBAAgB,GAAG;IAC1BH,YAAY,CAACI,EAAE,CAACH,SAAS,EAAEC,QAAQ,CAAC;IAEpC,OAAO,MAAM;MACXF,YAAY,CAACK,GAAG,CAACJ,SAAS,EAAEC,QAAQ,CAAC;IACvC,CAAC;EACH,CAAC,EACD,CAACF,YAAY,EAAEC,SAAS,EAAEC,QAAQ,CAAC,CACpC;AACH;AAEA,eAAeH,WAAW"}

package/dist/layout/usePanelRegistration.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { DashboardPluginComponentProps, PanelComponentType, PanelDehydrateFunction, PanelHydrateFunction, PanelProps } from '../DashboardPlugin';
+import { DashboardPanelProps, DashboardPluginComponentProps, PanelComponentType, PanelDehydrateFunction, PanelHydrateFunction } from '../DashboardPlugin';
 /**
  * Registers a given panel component. Also runs a `useEffect` that will
  * automatically de-register then panel on unmount.
@@ -8,5 +8,5 @@ import { DashboardPluginComponentProps, PanelComponentType, PanelDehydrateFuncti
  * @param hydrate
  * @param dehydrate
  */
-export default function usePanelRegistration<P extends PanelProps, C extends React.ComponentType<P>>(registerComponent: DashboardPluginComponentProps['registerComponent'], ComponentType: PanelComponentType<P, C>, hydrate?: PanelHydrateFunction<P>, dehydrate?: PanelDehydrateFunction): void;
+export default function usePanelRegistration<P extends DashboardPanelProps, C extends React.ComponentType<P>>(registerComponent: DashboardPluginComponentProps['registerComponent'], ComponentType: PanelComponentType<P, C>, hydrate?: PanelHydrateFunction, dehydrate?: PanelDehydrateFunction): void;
 //# sourceMappingURL=usePanelRegistration.d.ts.map

package/dist/layout/usePanelRegistration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usePanelRegistration.d.ts","sourceRoot":"","sources":["../../src/layout/usePanelRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACL,6BAA6B,EAC7B,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,UAAU,EACX,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAC1C,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAEhC,iBAAiB,EAAE,6BAA6B,CAAC,mBAAmB,CAAC,EACrE,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EACvC,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,EACjC,SAAS,CAAC,EAAE,sBAAsB,QAsBnC"}
+{"version":3,"file":"usePanelRegistration.d.ts","sourceRoot":"","sources":["../../src/layout/usePanelRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACL,mBAAmB,EACnB,6BAA6B,EAC7B,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAC1C,CAAC,SAAS,mBAAmB,EAC7B,CAAC,SAAS,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAEhC,iBAAiB,EAAE,6BAA6B,CAAC,mBAAmB,CAAC,EACrE,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EACvC,OAAO,CAAC,EAAE,oBAAoB,EAC9B,SAAS,CAAC,EAAE,sBAAsB,QAsBnC"}

package/dist/layout/usePanelRegistration.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePanelRegistration.js","names":["React","usePanelRegistration","registerComponent","ComponentType","hydrate","dehydrate","name","COMPONENT","displayName","Error","useEffect","deregister"],"sources":["../../src/layout/usePanelRegistration.ts"],"sourcesContent":["import React from 'react';\nimport {\n  DashboardPluginComponentProps,\n  PanelComponentType,\n  PanelDehydrateFunction,\n  PanelHydrateFunction,\n  PanelProps,\n} from '../DashboardPlugin';\n\n/**\n * Registers a given panel component. Also runs a `useEffect` that will\n * automatically de-register then panel on unmount.\n * @param registerComponent\n * @param ComponentType\n * @param hydrate\n * @param dehydrate\n */\nexport default function usePanelRegistration<\n  P extends PanelProps,\n  C extends React.ComponentType<P>,\n>(\n  registerComponent: DashboardPluginComponentProps['registerComponent'],\n  ComponentType: PanelComponentType<P, C>,\n  hydrate?: PanelHydrateFunction<P>,\n  dehydrate?: PanelDehydrateFunction\n) {\n  const name = ComponentType.COMPONENT ?? ComponentType.displayName;\n\n  if (name == null) {\n    throw new Error(\n      'ComponentType must have a `COMPONENT` or `displayName` attribute.'\n    );\n  }\n\n  React.useEffect(() => {\n    const deregister = registerComponent(\n      name,\n      ComponentType,\n      hydrate,\n      dehydrate\n    );\n\n    return () => {\n      deregister();\n    };\n  }, [ComponentType, dehydrate, hydrate, name, registerComponent]);\n}\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AASzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,oBAAoB,CAI1CC,iBAAqE,EACrEC,aAAuC,EACvCC,OAAiC,EACjCC,SAAkC,EAClC;EAAA;EACA,IAAMC,IAAI,4BAAGH,aAAa,CAACI,SAAS,yEAAIJ,aAAa,CAACK,WAAW;EAEjE,IAAIF,IAAI,IAAI,IAAI,EAAE;IAChB,MAAM,IAAIG,KAAK,CACb,mEAAmE,CACpE;EACH;EAEAT,KAAK,CAACU,SAAS,CAAC,MAAM;IACpB,IAAMC,UAAU,GAAGT,iBAAiB,CAClCI,IAAI,EACJH,aAAa,EACbC,OAAO,EACPC,SAAS,CACV;IAED,OAAO,MAAM;MACXM,UAAU,EAAE;IACd,CAAC;EACH,CAAC,EAAE,CAACR,aAAa,EAAEE,SAAS,EAAED,OAAO,EAAEE,IAAI,EAAEJ,iBAAiB,CAAC,CAAC;AAClE"}
+{"version":3,"file":"usePanelRegistration.js","names":["React","usePanelRegistration","registerComponent","ComponentType","hydrate","dehydrate","name","COMPONENT","displayName","Error","useEffect","deregister"],"sources":["../../src/layout/usePanelRegistration.ts"],"sourcesContent":["import React from 'react';\nimport {\n  DashboardPanelProps,\n  DashboardPluginComponentProps,\n  PanelComponentType,\n  PanelDehydrateFunction,\n  PanelHydrateFunction,\n} from '../DashboardPlugin';\n\n/**\n * Registers a given panel component. Also runs a `useEffect` that will\n * automatically de-register then panel on unmount.\n * @param registerComponent\n * @param ComponentType\n * @param hydrate\n * @param dehydrate\n */\nexport default function usePanelRegistration<\n  P extends DashboardPanelProps,\n  C extends React.ComponentType<P>,\n>(\n  registerComponent: DashboardPluginComponentProps['registerComponent'],\n  ComponentType: PanelComponentType<P, C>,\n  hydrate?: PanelHydrateFunction,\n  dehydrate?: PanelDehydrateFunction\n) {\n  const name = ComponentType.COMPONENT ?? ComponentType.displayName;\n\n  if (name == null) {\n    throw new Error(\n      'ComponentType must have a `COMPONENT` or `displayName` attribute.'\n    );\n  }\n\n  React.useEffect(() => {\n    const deregister = registerComponent(\n      name,\n      ComponentType,\n      hydrate,\n      dehydrate\n    );\n\n    return () => {\n      deregister();\n    };\n  }, [ComponentType, dehydrate, hydrate, name, registerComponent]);\n}\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AASzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,oBAAoB,CAI1CC,iBAAqE,EACrEC,aAAuC,EACvCC,OAA8B,EAC9BC,SAAkC,EAClC;EAAA;EACA,IAAMC,IAAI,4BAAGH,aAAa,CAACI,SAAS,yEAAIJ,aAAa,CAACK,WAAW;EAEjE,IAAIF,IAAI,IAAI,IAAI,EAAE;IAChB,MAAM,IAAIG,KAAK,CACb,mEAAmE,CACpE;EACH;EAEAT,KAAK,CAACU,SAAS,CAAC,MAAM;IACpB,IAAMC,UAAU,GAAGT,iBAAiB,CAClCI,IAAI,EACJH,aAAa,EACbC,OAAO,EACPC,SAAS,CACV;IAED,OAAO,MAAM;MACXM,UAAU,EAAE;IACd,CAAC;EACH,CAAC,EAAE,CAACR,aAAa,EAAEE,SAAS,EAAED,OAAO,EAAEE,IAAI,EAAEJ,iBAAiB,CAAC,CAAC;AAClE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/dashboard",
-  "version": "0.45.2-docs.8+9c63e6af",
+  "version": "0.46.0",
   "description": "Deephaven Dashboard",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -22,13 +22,13 @@
     "build:sass": "sass --embed-sources --load-path=../../node_modules ./src:./dist"
   },
   "dependencies": {
-    "@deephaven/components": "^0.45.2-docs.8+9c63e6af",
-    "@deephaven/golden-layout": "^0.45.2-docs.8+9c63e6af",
-    "@deephaven/jsapi-bootstrap": "^0.45.2-docs.8+9c63e6af",
-    "@deephaven/log": "^0.45.2-docs.8+9c63e6af",
-    "@deephaven/react-hooks": "^0.45.2-docs.8+9c63e6af",
-    "@deephaven/redux": "^0.45.2-docs.8+9c63e6af",
-    "@deephaven/utils": "^0.45.2-docs.8+9c63e6af",
+    "@deephaven/components": "^0.46.0",
+    "@deephaven/golden-layout": "^0.46.0",
+    "@deephaven/jsapi-bootstrap": "^0.46.0",
+    "@deephaven/log": "^0.46.0",
+    "@deephaven/react-hooks": "^0.46.0",
+    "@deephaven/redux": "^0.46.0",
+    "@deephaven/utils": "^0.46.0",
     "deep-equal": "^2.0.5",
     "lodash.ismatch": "^4.1.1",
     "lodash.throttle": "^4.1.1",
@@ -41,7 +41,7 @@
     "react-redux": "^7.2.4"
   },
   "devDependencies": {
-    "@deephaven/mocks": "^0.45.2-docs.8+9c63e6af",
+    "@deephaven/mocks": "^0.46.0",
     "@types/lodash.ismatch": "^4.4.0"
   },
   "files": [
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9c63e6af38e9e4bec83f5c611aff153caf876003"
+  "gitHead": "2a4ec0dc2720f38236aa2da2e70a2f321fea1c35"
 }

package/dist/layout/hooks.d.ts

@@ -1,7 +0,0 @@
-import type { EventEmitter } from '@deephaven/golden-layout';
-export declare const useListener: (eventEmitter: EventEmitter, eventName: string, callback: Function) => void;
-declare const _default: {
-    useListener: (eventEmitter: EventEmitter, eventName: string, callback: Function) => void;
-};
-export default _default;
-//# sourceMappingURL=hooks.d.ts.map

package/dist/layout/hooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/layout/hooks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D,eAAO,MAAM,WAAW,iBACR,YAAY,aACf,MAAM,YAEP,QAAQ,KACjB,IAUA,CAAC;;;;AAEJ,wBAA+B"}

package/dist/layout/hooks.js

@@ -1,11 +0,0 @@
-import { useEffect } from 'react';
-export var useListener = (eventEmitter, eventName, callback) => useEffect(function initEventEmitter() {
-  eventEmitter.on(eventName, callback);
-  return () => {
-    eventEmitter.off(eventName, callback);
-  };
-}, [eventEmitter, eventName, callback]);
-export default {
-  useListener
-};
-//# sourceMappingURL=hooks.js.map

package/dist/layout/hooks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks.js","names":["useEffect","useListener","eventEmitter","eventName","callback","initEventEmitter","on","off"],"sources":["../../src/layout/hooks.ts"],"sourcesContent":["import { useEffect } from 'react';\nimport type { EventEmitter } from '@deephaven/golden-layout';\n\nexport const useListener = (\n  eventEmitter: EventEmitter,\n  eventName: string,\n  // eslint-disable-next-line @typescript-eslint/ban-types\n  callback: Function\n): void =>\n  useEffect(\n    function initEventEmitter() {\n      eventEmitter.on(eventName, callback);\n\n      return () => {\n        eventEmitter.off(eventName, callback);\n      };\n    },\n    [eventEmitter, eventName, callback]\n  );\n\nexport default { useListener };\n"],"mappings":"AAAA,SAASA,SAAS,QAAQ,OAAO;AAGjC,OAAO,IAAMC,WAAW,GAAG,CACzBC,YAA0B,EAC1BC,SAAiB,EAEjBC,QAAkB,KAElBJ,SAAS,CACP,SAASK,gBAAgB,GAAG;EAC1BH,YAAY,CAACI,EAAE,CAACH,SAAS,EAAEC,QAAQ,CAAC;EAEpC,OAAO,MAAM;IACXF,YAAY,CAACK,GAAG,CAACJ,SAAS,EAAEC,QAAQ,CAAC;EACvC,CAAC;AACH,CAAC,EACD,CAACF,YAAY,EAAEC,SAAS,EAAEC,QAAQ,CAAC,CACpC;AAEH,eAAe;EAAEH;AAAY,CAAC"}