@perspective-dev/viewer 4.5.2 → 5.0.0

package/src/rust/config/export_method.rs

@@ -17,7 +17,7 @@ use yew::prelude::*;
 
 use crate::js::*;
 
-#[derive(Clone, Copy, Eq, PartialEq, Deserialize)]
+#[derive(Clone, Copy, Eq, PartialEq, Deserialize, ts_rs::TS)]
 pub enum ExportMethod {
     #[serde(rename = "csv")]
     Csv,

package/src/rust/config/mod.rs

@@ -20,10 +20,12 @@ mod export_method;
 mod kvpair;
 mod number_series_style;
 mod number_string_format;
+mod options;
 mod plugin_static_config;
 mod string_column_style;
 pub mod view_config;
 mod viewer_config;
+mod workspace_config;
 
 pub use column_config_schema::*;
 pub use columns_config::*;
@@ -31,7 +33,9 @@ pub use datetime_column_style::*;
 pub use export_method::*;
 pub use number_series_style::*;
 pub use number_string_format::*;
+pub use options::*;
 pub use plugin_static_config::*;
 pub use string_column_style::*;
 pub use view_config::*;
 pub use viewer_config::*;
+pub use workspace_config::*;

package/src/rust/config/options.rs

@@ -0,0 +1,71 @@
+// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
+// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
+// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
+// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
+// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
+// ┃ Copyright (c) 2017, the Perspective Authors.                              ┃
+// ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
+// ┃ This file is part of the Perspective library, distributed under the terms ┃
+// ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
+// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+//! Argument dictionaries for the public `PerspectiveViewerElement` methods.
+//! Each derives `ts_rs::TS` so its TypeScript type is generated (and
+//! re-exported from the crate's `typescript_custom_section`) alongside the
+//! config types, rather than hand-maintained.
+
+use serde::Deserialize;
+use ts_rs::TS;
+
+use crate::config::ExportMethod;
+
+/// Selects the target panel of a panel-scoped `<perspective-viewer>` method;
+/// the active panel when `panel` is omitted.
+#[derive(Deserialize, Default, TS)]
+pub struct PanelOptions {
+    #[ts(optional)]
+    pub panel: Option<String>,
+}
+
+/// The `eject` argument: the loaded client to remove by name; the active
+/// panel's client when omitted.
+#[derive(Deserialize, Default, TS)]
+pub struct ClientOptions {
+    #[ts(optional)]
+    pub client: Option<String>,
+}
+
+/// The `download` / `export` / `copy` argument: the `ExportMethod` and target
+/// panel.
+#[derive(Deserialize, Default, TS)]
+pub struct ExportOptions {
+    #[ts(as = "Option<ExportMethod>")]
+    #[ts(optional)]
+    pub method: Option<String>,
+
+    #[ts(optional)]
+    pub panel: Option<String>,
+}
+
+/// The `getTable` argument: whether to `wait` for a `Table`, and the target
+/// panel.
+#[derive(Deserialize, Default, TS)]
+pub struct GetTableOptions {
+    #[ts(optional)]
+    pub wait: Option<bool>,
+
+    #[ts(optional)]
+    pub panel: Option<String>,
+}
+
+/// The `getClient` argument: whether to `wait` for a `Client`, and the target
+/// panel.
+#[derive(Deserialize, Default, TS)]
+pub struct GetClientOptions {
+    #[ts(optional)]
+    pub wait: Option<bool>,
+
+    #[ts(optional)]
+    pub panel: Option<String>,
+}

package/src/rust/config/viewer_config.rs

@@ -23,15 +23,29 @@ use wasm_bindgen::prelude::*;
 use crate::renderer::ColumnConfigMap;
 
 /// The state of an entire `custom_elements::PerspectiveViewerElement` component
-/// and its `Plugin`.
+/// and its `Plugin`: the element-level `settings` flag plus the per-panel
+/// [`PanelViewerConfig`]. The split exists so the whole-element config format
+/// can serialize panel entries *without* a `settings` key (it is element-level
+/// state there, carried by the top-level `active` field instead), while the
+/// single-panel format flattens back to the legacy shape.
 #[derive(Debug, Default, Serialize, PartialEq, TS)]
 #[serde(deny_unknown_fields)]
 pub struct ViewerConfig<V: TS = String> {
+    pub settings: bool,
+
+    #[serde(flatten)]
+    pub panel: PanelViewerConfig<V>,
+}
+
+/// The per-panel state of a [`ViewerConfig`] — everything except the
+/// element-level `settings` flag. This is the `panels` entry type of the
+/// whole-element config format.
+#[derive(Debug, Default, Serialize, PartialEq, TS)]
+pub struct PanelViewerConfig<V: TS = String> {
     pub version: V,
     pub columns_config: ColumnConfigMap,
     pub plugin: String,
     pub plugin_config: serde_json::Map<String, Value>,
-    pub settings: bool,
     pub table: Option<String>,
     pub theme: Option<String>,
     pub title: Option<String>,
@@ -40,6 +54,14 @@ pub struct ViewerConfig<V: TS = String> {
     pub view_config: ViewConfig,
 }
 
+impl<V: TS> Deref for ViewerConfig<V> {
+    type Target = PanelViewerConfig<V>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.panel
+    }
+}
+
 pub static API_VERSION: LazyLock<&'static str> = LazyLock::new(|| {
     #[derive(Deserialize)]
     struct Package {

package/src/rust/config/workspace_config.rs

@@ -0,0 +1,92 @@
+// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
+// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
+// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
+// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
+// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
+// ┃ Copyright (c) 2017, the Perspective Authors.                              ┃
+// ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
+// ┃ This file is part of the Perspective library, distributed under the terms ┃
+// ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
+// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+use std::collections::BTreeMap;
+
+use perspective_client::config::Filter;
+
+use crate::config::{PanelViewerConfig, ViewerConfigUpdate};
+
+/// The whole-element config format (`{version, active?, layout, panels}`) —
+/// the multi-panel counterpart of the single-panel [`ViewerConfig`] — as
+/// emitted by [`PerspectiveViewerElement::save`].
+///
+/// - `panels` entries are [`PanelViewerConfig`]s: per-panel state only, no
+///   `settings` key (element-level state).
+/// - `active` names the panel targeted by the *open* settings sidebar; it is
+///   omitted when the sidebar is closed.
+#[derive(serde::Serialize, ts_rs::TS)]
+pub struct WorkspaceConfig {
+    pub version: String,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[ts(optional)]
+    pub active: Option<String>,
+
+    pub layout: Option<crate::js::Layout>,
+
+    /// `BTreeMap` (not `HashMap`) so `save()` serializes panels in a
+    /// DETERMINISTIC (sorted) key order — a fresh `HashMap` per call
+    /// iterates in a per-instance random order, which made consecutive
+    /// `save()` outputs byte-unstable.
+    pub panels: BTreeMap<String, PanelViewerConfig>,
+
+    /// The element-level global (master/detail cross-) filters. A transient
+    /// overlay on every detail panel's view — persisted here, never in a
+    /// per-panel entry. Omitted when empty.
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    #[ts(as = "Option<_>")]
+    #[ts(optional)]
+    pub global_filters: Vec<Filter>,
+
+    /// The MASTER (filter-source) panels' ids, referencing `panels` keys.
+    /// Roles are layout state (like the panel arrangement), so they persist;
+    /// which master contributed which clause does not — restored
+    /// `global_filters` are one unattributed bucket. Omitted when empty.
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    #[ts(as = "Option<_>")]
+    #[ts(optional)]
+    pub masters: Vec<String>,
+}
+
+/// The parse target of a whole-element config in
+/// [`PerspectiveViewerElement::restore`]. Mirrors [`WorkspaceConfig`],
+/// but `panels` entries are full [`ViewerConfigUpdate`]s so a stray per-panel
+/// `settings` can be detected (warned, then ignored — `create_panel` strips
+/// it).
+#[derive(serde::Deserialize, ts_rs::TS)]
+pub struct WorkspaceConfigUpdate {
+    #[serde(default)]
+    #[ts(optional)]
+    pub active: Option<String>,
+
+    #[serde(default)]
+    #[ts(optional)]
+    pub layout: Option<crate::js::Layout>,
+
+    pub panels: BTreeMap<String, ViewerConfigUpdate>,
+
+    /// The element-level global (master/detail cross-) filters to re-apply as
+    /// a transient overlay on every DETAIL panel. Restored as one
+    /// unattributed bucket: the next selection on any master replaces it.
+    #[serde(default)]
+    #[ts(as = "Option<_>")]
+    #[ts(optional)]
+    pub global_filters: Vec<Filter>,
+
+    /// The master (filter-source) panels, by saved `panels` key. An id not in
+    /// `panels` warns and is dropped.
+    #[serde(default)]
+    #[ts(as = "Option<_>")]
+    #[ts(optional)]
+    pub masters: Vec<String>,
+}

package/src/rust/custom_elements/copy_dropdown.rs

@@ -137,7 +137,9 @@ impl CopyDropDownMenuElement {
     }
 
     pub fn __set_model(&self, parent: &PerspectiveViewerElement) {
-        self.set_config_model(&parent.session, &parent.renderer, &parent.presentation)
+        if let Some(panel) = parent.workspace.active_panel() {
+            self.set_config_model(&panel.session, &panel.renderer, &parent.presentation);
+        }
     }
 
     pub fn connected_callback(&self) {}

package/src/rust/custom_elements/debug_plugin.rs

@@ -65,8 +65,27 @@ impl PerspectiveDebugPluginElement {
         JsValue::UNDEFINED
     }
 
+    /// Delegates to `draw()` VIRTUALLY — through the JS element's `draw`
+    /// property, never `self.draw(view)` (Rust static dispatch). This
+    /// element is the documented base class for custom plugins
+    /// (`class MyPlugin extends
+    /// customElements.get("perspective-viewer-plugin")`), whose contract is
+    /// "`update()` defaults to dispatch to `draw()`" — a
+    /// subclass overriding only `draw` must receive `update`-path repaints
+    /// (`BindDisposition::Unchanged`/`Adopted` runs,
+    /// `PLUGIN_DRAW_INVARIANT_PLAN.md`); the static call bypassed the
+    /// override and repainted the Debug CSV instead (the
+    /// `view_lifecycle.spec` regression).
     pub fn update(&self, view: &perspective_js::View) -> ApiFuture<()> {
-        self.draw(view)
+        clone!(self.elem, view);
+        ApiFuture::new(async move {
+            let draw = js_sys::Reflect::get(&elem, &JsValue::from_str("draw"))?
+                .dyn_into::<js_sys::Function>()?;
+
+            let task = draw.call1(&elem, &JsValue::from(view))?;
+            wasm_bindgen_futures::JsFuture::from(js_sys::Promise::resolve(&task)).await?;
+            Ok(())
+        })
     }
 
     /// # Notes

package/src/rust/custom_elements/export_dropdown.rs

@@ -138,7 +138,9 @@ impl ExportDropDownMenuElement {
     }
 
     pub fn __set_model(&self, parent: &PerspectiveViewerElement) {
-        self.set_config_model(&parent.session, &parent.renderer, &parent.presentation)
+        if let Some(panel) = parent.workspace.active_panel() {
+            self.set_config_model(&panel.session, &panel.renderer, &parent.presentation);
+        }
     }
 
     pub fn connected_callback(&self) {}