@perspective-dev/viewer 4.5.2 → 5.0.0

package/src/ts/ts-rs/GetTableOptions.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The `getTable` argument: whether to `wait` for a `Table`, and the target
+ * panel.
+ */
+export type GetTableOptions = { wait?: boolean, panel?: string, };

package/src/ts/ts-rs/Layout.ts

@@ -0,0 +1,9 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { SplitLayout } from "./SplitLayout.js";
+import type { TabLayout } from "./TabLayout.js";
+
+/**
+ * A serde mirror of `regular-layout`'s serialized layout tree, as returned by
+ * [`RegularLayout::save`] and accepted by [`RegularLayout::restore`].
+ */
+export type Layout = { "type": "split-layout" } & SplitLayout | { "type": "tab-layout" } & TabLayout;

package/src/ts/ts-rs/Orientation.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The orientation of a [`SplitLayout`].
+ */
+export type Orientation = "horizontal" | "vertical";

package/src/ts/ts-rs/PanelOptions.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Selects the target panel of a panel-scoped `<perspective-viewer>` method;
+ * the active panel when `panel` is omitted.
+ */
+export type PanelOptions = { panel?: string, };

package/src/ts/ts-rs/PanelViewerConfig.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Aggregate } from "./Aggregate.js";
+import type { Expressions } from "./Expressions.js";
+import type { Filter } from "./Filter.js";
+import type { FilterReducer } from "./FilterReducer.js";
+import type { GroupRollupMode } from "./GroupRollupMode.js";
+import type { Sort } from "./Sort.js";
+import type { JsonValue } from "./serde_json/JsonValue.js";
+
+/**
+ * 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.
+ */
+export type PanelViewerConfig<V = string> = { version: V, columns_config: { [key in string]?: { [key in string]?: JsonValue } }, plugin: string, plugin_config: { [key in string]?: JsonValue }, table: string | null, theme: string | null, title: string | null, group_by: Array<string>, split_by: Array<string>, sort: Array<Sort>, filter: Array<Filter>, group_rollup_mode: GroupRollupMode, filter_op?: FilterReducer, expressions: Expressions, columns: Array<string | null>, aggregates: { [key in string]?: Aggregate }, group_by_depth?: number | null, };

package/src/ts/ts-rs/SplitLayout.ts

@@ -0,0 +1,5 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Layout } from "./Layout.js";
+import type { Orientation } from "./Orientation.js";
+
+export type SplitLayout = { children: Array<Layout>, sizes: Array<number>, orientation: Orientation, };

package/src/ts/ts-rs/TabLayout.ts

@@ -0,0 +1,11 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type TabLayout = { 
+/**
+ * Panel ids (slot names) in this stack.
+ */
+tabs: Array<string>, 
+/**
+ * Index of the selected tab within `tabs`.
+ */
+selected?: number, };

package/src/ts/ts-rs/ViewerConfig.ts

@@ -9,6 +9,10 @@ import type { JsonValue } from "./serde_json/JsonValue.js";
 
 /**
  * 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.
  */
-export type ViewerConfig<V = string> = { version: V, columns_config: { [key in string]?: { [key in string]?: JsonValue } }, plugin: string, plugin_config: { [key in string]?: JsonValue }, settings: boolean, table: string | null, theme: string | null, title: string | null, group_by: Array<string>, split_by: Array<string>, sort: Array<Sort>, filter: Array<Filter>, group_rollup_mode: GroupRollupMode, filter_op?: FilterReducer, expressions: Expressions, columns: Array<string | null>, aggregates: { [key in string]?: Aggregate }, group_by_depth?: number | null, };
+export type ViewerConfig<V = string> = { settings: boolean, version: V, columns_config: { [key in string]?: { [key in string]?: JsonValue } }, plugin: string, plugin_config: { [key in string]?: JsonValue }, table: string | null, theme: string | null, title: string | null, group_by: Array<string>, split_by: Array<string>, sort: Array<Sort>, filter: Array<Filter>, group_rollup_mode: GroupRollupMode, filter_op?: FilterReducer, expressions: Expressions, columns: Array<string | null>, aggregates: { [key in string]?: Aggregate }, group_by_depth?: number | null, };

package/src/ts/ts-rs/WorkspaceConfig.ts

@@ -0,0 +1,36 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Filter } from "./Filter.js";
+import type { Layout } from "./Layout.js";
+import type { PanelViewerConfig } from "./PanelViewerConfig.js";
+
+/**
+ * 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.
+ */
+export type WorkspaceConfig = { version: string, active?: string, layout: Layout | null, 
+/**
+ * `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.
+ */
+panels: { [key in string]?: PanelViewerConfig<string> }, 
+/**
+ * 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.
+ */
+global_filters?: Array<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.
+ */
+masters?: Array<string>, };

package/src/ts/ts-rs/WorkspaceConfigUpdate.ts

@@ -0,0 +1,24 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Filter } from "./Filter.js";
+import type { Layout } from "./Layout.js";
+import type { ViewerConfigUpdate } from "./ViewerConfigUpdate.js";
+
+/**
+ * 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).
+ */
+export type WorkspaceConfigUpdate = { active?: string, layout?: Layout, panels: { [key in 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.
+ */
+global_filters?: Array<Filter>, 
+/**
+ * The master (filter-source) panels, by saved `panels` key. An id not in
+ * `panels` warns and is dropped.
+ */
+masters?: Array<string>, };

package/src/rust/tasks/intersection_observer.rs

@@ -1,98 +0,0 @@
-// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
-// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
-// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
-// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
-// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
-// ┃ 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 wasm_bindgen::JsCast;
-use wasm_bindgen::prelude::*;
-use web_sys::*;
-
-use crate::config::ViewerConfigUpdate;
-use crate::js::*;
-use crate::presentation::Presentation;
-use crate::renderer::*;
-use crate::session::Session;
-use crate::utils::*;
-use crate::*;
-
-pub struct IntersectionObserverHandle {
-    elem: HtmlElement,
-    observer: IntersectionObserver,
-    _callback: Closure<dyn FnMut(js_sys::Array)>,
-}
-
-impl IntersectionObserverHandle {
-    pub fn new(
-        elem: &HtmlElement,
-        presentation: &Presentation,
-        session: &Session,
-        renderer: &Renderer,
-    ) -> Self {
-        clone!(session, renderer, presentation);
-        let _callback = Closure::new(move |xs: js_sys::Array| {
-            // https://stackoverflow.com/questions/53862160/intersectionobserver-multiple-entries
-            let intersect = xs
-                .pop()
-                .unchecked_into::<IntersectionObserverEntry>()
-                .is_intersecting();
-
-            clone!(session, renderer, presentation);
-            let state = IntersectionObserverState {
-                presentation,
-                session,
-                renderer,
-            };
-
-            ApiFuture::spawn(state.set_pause(intersect));
-        });
-
-        let func = _callback.as_ref().unchecked_ref::<js_sys::Function>();
-        let observer = IntersectionObserver::new(func);
-        observer.observe(elem);
-        Self {
-            elem: elem.clone(),
-            _callback,
-            observer,
-        }
-    }
-}
-
-impl Drop for IntersectionObserverHandle {
-    fn drop(&mut self) {
-        self.observer.unobserve(&self.elem);
-    }
-}
-
-struct IntersectionObserverState {
-    session: Session,
-    renderer: Renderer,
-    presentation: Presentation,
-}
-
-impl IntersectionObserverState {
-    async fn set_pause(self, intersect: bool) -> ApiResult<()> {
-        if intersect {
-            if self.session.set_pause(false) {
-                super::restore_and_render(
-                    &self.session,
-                    &self.renderer,
-                    &self.presentation,
-                    ViewerConfigUpdate::default(),
-                    async move { Ok(()) },
-                )
-                .await?;
-            }
-        } else {
-            self.session.set_pause(true);
-        };
-
-        Ok(())
-    }
-}

package/src/rust/tasks/update_and_render.rs

@@ -1,110 +0,0 @@
-// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
-// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
-// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
-// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
-// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
-// ┃ 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). ┃
-// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-
-//! Apply a [`ViewConfigUpdate`] to the active [`Session`], validate it, then
-//! draw with the active [`Renderer`].  The companion `*_callback` helpers
-//! return [`yew::Callback`]s suitable for wiring as Yew child-component
-//! props.
-
-use perspective_client::config::ViewConfigUpdate;
-use yew::prelude::*;
-
-use crate::renderer::Renderer;
-use crate::session::Session;
-use crate::utils::*;
-use crate::*;
-
-/// Create a [`Callback`] that renders from the current `View` and `Plugin`.
-pub fn render_callback(session: &Session, renderer: &Renderer) -> Callback<()> {
-    clone!(session, renderer);
-    Callback::from(move |_| {
-        clone!(session, renderer);
-        ApiFuture::spawn(async move {
-            renderer.draw(async { Ok(session.get_view()) }).await?;
-            Ok(())
-        })
-    })
-}
-
-/// Create a [`Callback`] that resizes from the current `View` and `Plugin`.
-pub fn resize_callback(session: &Session, renderer: &Renderer) -> Callback<()> {
-    clone!(session, renderer);
-    Callback::from(move |_| {
-        clone!(renderer, session);
-        ApiFuture::spawn(async move {
-            if !renderer.is_plugin_activated()? {
-                update_and_render_inner(session, renderer).await?
-            } else {
-                renderer.resize().await?;
-            }
-
-            Ok(())
-        })
-    })
-}
-
-/// Apply a `ViewConfigUpdate` to the current `View` and render.
-pub fn update_and_render(
-    session: &Session,
-    renderer: &Renderer,
-    update: ViewConfigUpdate,
-) -> ApiResult<ApiFuture<()>> {
-    session.update_view_config(update)?;
-    clone!(session, renderer);
-    Ok(ApiFuture::new(update_and_render_inner(session, renderer)))
-}
-
-/// Re-render the current `View` and `Plugin` without applying a new
-/// `ViewConfigUpdate`.
-pub fn just_render(session: &Session, renderer: &Renderer) -> ApiResult<ApiFuture<()>> {
-    clone!(session, renderer);
-    Ok(ApiFuture::new(update_and_render_inner(session, renderer)))
-}
-
-#[tracing::instrument(level = "debug", skip(session, renderer))]
-async fn update_and_render_inner(session: Session, renderer: Renderer) -> ApiResult<()> {
-    // The previous call which acquired the lock errored, so skip this render
-    if session.get_error().is_some() {
-        return Ok(());
-    }
-
-    let plugin_swapped = renderer.apply_pending_plugin()?;
-
-    // Validate + create the view BEFORE the plugin-swap materialize
-    // so the schema query sees fresh `expression_schema` /
-    // `view_schema` and `resolve_abs_max` has a bound view that
-    // knows about any new expression columns.
-    let view = session.validate().await?.create_view().await?;
-
-    if plugin_swapped {
-        // `commit_plugin_idx` already restored the new plugin from its
-        // raw bucket; re-run with the materialized snapshot so any
-        // `include: true` schema defaults (e.g. Datagrid's
-        // `fg_gradient` when `number_fg_mode = "bar"`) make it into
-        // the plugin's state before the first draw. The Session is in
-        // scope here but not at `commit_plugin_idx`'s call sites in
-        // the column-selector tree, so we do the second restore at
-        // the caller instead of plumbing `&Session` through every
-        // `apply_pending_plugin` site.
-        let view_config_snapshot = session.get_view_config().clone();
-        let plugin_token = wasm_bindgen::JsValue::from_serde_ext(&renderer.get_plugin_config())
-            .unwrap_or(wasm_bindgen::JsValue::NULL);
-        let columns_config = renderer
-            .all_columns_configs_materialized(&view_config_snapshot, &session)
-            .await;
-        renderer
-            .get_active_plugin()?
-            .restore(&plugin_token, Some(&columns_config))?;
-    }
-
-    renderer.draw(async { Ok(view) }).await
-}