@perspective-dev/viewer 4.0.0 → 4.1.0

package/src/rust/config/columns_config.rs

@@ -13,7 +13,6 @@
 use std::collections::HashMap;
 
 use serde::{Deserialize, Serialize};
-use serde_with::skip_serializing_none;
 use ts_rs::TS;
 
 use super::{
@@ -28,7 +27,6 @@ fn is_zero(x: &u32) -> bool {
 
 /// The value de/serialized and stored in the viewer config.
 /// Also passed to the plugin via `plugin.save()`.
-#[skip_serializing_none]
 #[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize, TS)]
 pub struct ColumnConfigValues {
     #[serde(default)]
@@ -130,3 +128,5 @@ pub struct KeyValueOpts {
     pub keys: KvPairKeys,
     pub values: Vec<String>,
 }
+
+pub type SymbolKVPair = super::kvpair::KVPair<Option<String>, String>;

package/src/rust/config/datetime_column_style.rs

@@ -24,8 +24,6 @@ pub use simple::*;
 pub use simple_format::*;
 use ts_rs::TS;
 
-use crate::*;
-
 /// `Simple` case has all default-able keys and must be last!
 #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TS)]
 // #[serde(tag = "format", content = "date_format")]
@@ -65,6 +63,7 @@ impl DatetimeFormatType {
 /// A model for the JSON serialized style configuration for a column of type
 /// `datetime`.
 #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TS)]
+// #[derive(WasmDescribe!, FromWasmAbi!)]
 pub struct DatetimeColumnStyleConfig {
     #[serde(default)]
     #[serde(skip_serializing_if = "DatetimeFormatType::is_simple")]
@@ -94,11 +93,7 @@ impl Default for DatetimeColumnStyleConfig {
     }
 }
 
-derive_wasm_abi!(DatetimeColumnStyleConfig, FromWasmAbi, IntoWasmAbi);
-
 #[derive(Clone, Default, Deserialize, Eq, PartialEq, Serialize, Debug)]
 pub struct DatetimeColumnStyleDefaultConfig {
     pub color: String,
 }
-
-derive_wasm_abi!(DatetimeColumnStyleDefaultConfig, FromWasmAbi);

package/src/rust/config/mod.rs

@@ -15,6 +15,7 @@
 
 mod columns_config;
 mod datetime_column_style;
+mod kvpair;
 mod number_column_style;
 mod number_string_format;
 mod string_column_style;

package/src/rust/config/number_column_style.rs

@@ -16,8 +16,6 @@ use serde::{Deserialize, Serialize};
 use strum::{Display, EnumIter};
 use ts_rs::TS;
 
-use crate::*;
-
 #[derive(
     Clone, Copy, Debug, Default, Deserialize, Display, EnumIter, Eq, PartialEq, Serialize, TS,
 )]
@@ -116,8 +114,6 @@ pub struct NumberColumnStyleConfig {
     pub bg_gradient: Option<f64>,
 }
 
-derive_wasm_abi!(NumberColumnStyleConfig, FromWasmAbi, IntoWasmAbi);
-
 /// Exactly like a `ColumnStyleConfig`, except without `Option<>` fields.
 ///
 /// Necessary because this struct represents the default values we should use in
@@ -134,5 +130,3 @@ pub struct NumberColumnStyleDefaultConfig {
     pub number_fg_mode: NumberForegroundMode,
     pub number_bg_mode: NumberBackgroundMode,
 }
-
-derive_wasm_abi!(NumberColumnStyleDefaultConfig, FromWasmAbi);

package/src/rust/config/number_string_format.rs

@@ -13,7 +13,6 @@
 mod enums;
 pub use enums::*;
 use serde::{Deserialize, Serialize};
-use serde_with::skip_serializing_none;
 use strum::{Display, EnumIter};
 use ts_rs::TS;
 
@@ -45,13 +44,16 @@ pub enum CurrencySign {
     Accounting,
 }
 
-#[skip_serializing_none]
 #[derive(Default, Serialize, Deserialize, Debug, PartialEq, Clone, TS)]
 #[serde(rename_all = "camelCase")]
 pub struct CurrencyNumberFormatStyle {
     #[serde(default)]
     pub currency: CurrencyCode,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub currency_display: Option<CurrencyDisplay>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub currency_sign: Option<CurrencySign>,
 }
 
@@ -64,12 +66,13 @@ pub enum UnitDisplay {
     Long,
 }
 
-#[skip_serializing_none]
 #[derive(Serialize, Deserialize, Debug, PartialEq, Clone, TS)]
 #[serde(rename_all = "camelCase")]
 pub struct UnitNumberFormatStyle {
     #[serde(default)]
     pub unit: Unit,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub unit_display: Option<UnitDisplay>,
 }
 
@@ -166,7 +169,6 @@ pub enum SignDisplay {
     Never,
 }
 
-#[skip_serializing_none]
 #[derive(Serialize, Deserialize, Debug, Default, PartialEq, Clone, TS)]
 #[serde(rename_all = "camelCase")]
 pub struct CustomNumberFormatConfig {
@@ -178,24 +180,45 @@ pub struct CustomNumberFormatConfig {
     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#minimumintegerdigits
     // these min/max props can all be specified but it results in possible conflicts
     // may consider making them distinct options
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub minimum_integer_digits: Option<f64>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub minimum_fraction_digits: Option<f64>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub maximum_fraction_digits: Option<f64>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub minimum_significant_digits: Option<f64>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub maximum_significant_digits: Option<f64>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub rounding_priority: Option<RoundingPriority>,
 
     // specific values https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#roundingincrement
     // Only available with automatic rounding priority
     // Cannot be mixed with sigfig rounding. (Does this mean max/min sigfig must be unset?)
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub rounding_increment: Option<f64>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub rounding_mode: Option<RoundingMode>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub trailing_zero_display: Option<TrailingZeroDisplay>,
 
     #[serde(flatten)]
     #[ts(skip)]
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub _notation: Option<Notation>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub use_grouping: Option<UseGrouping>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub sign_display: Option<SignDisplay>,
 }
 

package/src/rust/config/viewer_config.rs

@@ -11,55 +11,30 @@
 // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
 use std::collections::HashMap;
-use std::io::{Read, Write};
 use std::ops::Deref;
-use std::str::FromStr;
 use std::sync::LazyLock;
 
-use flate2::Compression;
-use flate2::read::ZlibDecoder;
-use flate2::write::ZlibEncoder;
 use perspective_client::config::*;
 use perspective_js::utils::*;
 use serde::{Deserialize, Deserializer, Serialize};
 use serde_json::Value;
 use ts_rs::TS;
-use wasm_bindgen::JsCast;
 use wasm_bindgen::prelude::*;
 
 use super::ColumnConfigValues;
 use crate::presentation::ColumnConfigMap;
 
-pub enum ViewerConfigEncoding {
-    Json,
-    String,
-    ArrayBuffer,
-    JSONString,
-}
-
-impl FromStr for ViewerConfigEncoding {
-    type Err = JsValue;
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        match s {
-            "json" => Ok(Self::Json),
-            "string" => Ok(Self::String),
-            "arraybuffer" => Ok(Self::ArrayBuffer),
-            x => Err(format!("Unknown format \"{x}\"").into()),
-        }
-    }
-}
-
 /// The state of an entire `custom_elements::PerspectiveViewerElement` component
 /// and its `Plugin`.
-#[derive(Serialize, PartialEq)]
+#[derive(Debug, Default, Serialize, PartialEq)]
 #[serde(deny_unknown_fields)]
-pub struct ViewerConfig {
-    pub version: String,
+pub struct ViewerConfig<V = String> {
+    pub version: V,
+    pub columns_config: ColumnConfigMap,
     pub plugin: String,
     pub plugin_config: Value,
-    pub columns_config: ColumnConfigMap,
     pub settings: bool,
+    pub table: Option<String>,
     pub theme: Option<String>,
     pub title: Option<String>,
 
@@ -67,30 +42,6 @@ pub struct ViewerConfig {
     pub view_config: ViewConfig,
 }
 
-// `#[serde(flatten)]` makes messagepack 2x as big as they can no longer be
-// struct fields, so make a tuple alternative for serialization in binary.
-type ViewerConfigBinarySerialFormat<'a> = (
-    &'a String,
-    &'a ColumnConfigMap,
-    &'a String,
-    &'a Value,
-    bool,
-    &'a Option<String>,
-    &'a Option<String>,
-    &'a ViewConfig,
-);
-
-type ViewerConfigBinaryDeserialFormat = (
-    VersionUpdate,
-    ColumnConfigUpdate,
-    PluginUpdate,
-    Option<Value>,
-    SettingsUpdate,
-    ThemeUpdate,
-    TitleUpdate,
-    ViewConfigUpdate,
-);
-
 pub static API_VERSION: LazyLock<&'static str> = LazyLock::new(|| {
     #[derive(Deserialize)]
     struct Package {
@@ -102,76 +53,16 @@ pub static API_VERSION: LazyLock<&'static str> = LazyLock::new(|| {
 });
 
 impl ViewerConfig {
-    fn token(&self) -> ViewerConfigBinarySerialFormat<'_> {
-        (
-            &self.version,
-            &self.columns_config,
-            &self.plugin,
-            &self.plugin_config,
-            self.settings,
-            &self.theme,
-            &self.title,
-            &self.view_config,
-        )
-    }
-
     /// Encode a `ViewerConfig` to a `JsValue` in a supported type.
-    pub fn encode(&self, format: &Option<ViewerConfigEncoding>) -> ApiResult<JsValue> {
-        match format {
-            Some(ViewerConfigEncoding::String) => {
-                let mut encoder = ZlibEncoder::new(Vec::new(), Compression::default());
-                let bytes = rmp_serde::to_vec_named(&self.token())?;
-                encoder.write_all(&bytes)?;
-                let encoded = encoder.finish()?;
-                Ok(JsValue::from(base64::encode(encoded)))
-            },
-            Some(ViewerConfigEncoding::ArrayBuffer) => {
-                let mut encoder = ZlibEncoder::new(Vec::new(), Compression::default());
-                let bytes = rmp_serde::to_vec_named(&self.token())?;
-                encoder.write_all(&bytes)?;
-                let encoded = encoder.finish()?;
-                let array = js_sys::Uint8Array::from(&encoded[..]);
-                let start = array.byte_offset();
-                let len = array.byte_length();
-                Ok(array
-                    .buffer()
-                    .slice_with_end(start, start + len)
-                    .unchecked_into())
-            },
-            Some(ViewerConfigEncoding::JSONString) => {
-                Ok(JsValue::from(serde_json::to_string(self)?))
-            },
-            None | Some(ViewerConfigEncoding::Json) => Ok(JsValue::from_serde_ext(self)?),
-        }
+    pub fn encode(&self) -> ApiResult<JsValue> {
+        Ok(JsValue::from_serde_ext(self)?)
     }
 }
 
-#[derive(Clone, TS, Deserialize)]
+#[derive(Clone, Debug, TS, Deserialize, PartialEq, Serialize)]
 #[serde(transparent)]
 pub struct PluginConfig(serde_json::Value);
 
-// impl Type for PluginConfig {
-//     fn inline(type_map: &mut specta::TypeMap, generics: specta::Generics) ->
-// specta::DataType {         specta::Map::from(());
-//         // specta::Map {
-//         //     key_ty:
-//         // specta::DataType::Primitive(specta::PrimitiveType::String),
-//         //     value_ty: specta::DataType::Any,
-//         // }
-
-//         // specta::DataType::Map(specta::Map { Box::new((
-//         //     specta::DataType::Primitive(specta::PrimitiveType::String),
-//         //     specta::DataType::Any,
-//         // )))
-//     }
-//     // fn inline(_type_map: &mut specta::TypeMap, _generics:
-// &[specta::DataType]) ->     // specta::DataType {
-// specta::DataType::Map(Box::new((     //
-// specta::DataType::Primitive(specta::PrimitiveType::String),     //
-// specta::DataType::Any,     //     )))
-//     // }
-// }
-
 impl Deref for PluginConfig {
     type Target = Value;
 
@@ -180,8 +71,7 @@ impl Deref for PluginConfig {
     }
 }
 
-#[derive(Clone, Deserialize, TS)]
-// #[serde(deny_unknown_fields)]
+#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize, TS)]
 pub struct ViewerConfigUpdate {
     #[serde(default)]
     #[ts(as = "Option<_>")]
@@ -198,6 +88,11 @@ pub struct ViewerConfigUpdate {
     #[ts(optional)]
     pub title: TitleUpdate,
 
+    #[serde(default)]
+    #[ts(as = "Option<_>")]
+    #[ts(optional)]
+    pub table: TableUpdate,
+
     #[serde(default)]
     #[ts(as = "Option<_>")]
     #[ts(optional)]
@@ -223,44 +118,10 @@ pub struct ViewerConfigUpdate {
 }
 
 impl ViewerConfigUpdate {
-    fn from_token(
-        (version, columns_config, plugin, plugin_config, settings, theme, title, view_config): ViewerConfigBinaryDeserialFormat,
-    ) -> ViewerConfigUpdate {
-        ViewerConfigUpdate {
-            version,
-            columns_config,
-            plugin,
-            plugin_config: plugin_config.map(PluginConfig),
-            settings,
-            theme,
-            title,
-            view_config,
-        }
-    }
-
     /// Decode a `JsValue` into a `ViewerConfigUpdate` by auto-detecting format
     /// from JavaScript type.
     pub fn decode(update: &JsValue) -> ApiResult<Self> {
-        if update.is_string() {
-            let js_str = update.as_string().into_apierror()?;
-            let bytes = base64::decode(js_str)?;
-            let mut decoder = ZlibDecoder::new(&*bytes);
-            let mut decoded = vec![];
-            decoder.read_to_end(&mut decoded)?;
-            let token = rmp_serde::from_slice(&decoded[..])?;
-            Ok(ViewerConfigUpdate::from_token(token))
-        } else if update.is_instance_of::<js_sys::ArrayBuffer>() {
-            let uint8array = js_sys::Uint8Array::new(update);
-            let mut slice = vec![0; uint8array.length() as usize];
-            uint8array.copy_to(&mut slice[..]);
-            let mut decoder = ZlibDecoder::new(&*slice);
-            let mut decoded = vec![];
-            decoder.read_to_end(&mut decoded)?;
-            let token = rmp_serde::from_slice(&decoded[..])?;
-            Ok(ViewerConfigUpdate::from_token(token))
-        } else {
-            Ok(update.into_serde_ext()?)
-        }
+        Ok(update.into_serde_ext()?)
     }
 
     pub fn migrate(&self) -> ApiResult<Self> {
@@ -269,7 +130,17 @@ impl ViewerConfigUpdate {
     }
 }
 
-#[derive(Clone, Debug, Serialize, TS)]
+impl std::fmt::Display for ViewerConfigUpdate {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(
+            f,
+            "{}",
+            serde_json::to_string(self).map_err(|_| std::fmt::Error)?
+        )
+    }
+}
+
+#[derive(Clone, Debug, Serialize, PartialEq, TS)]
 #[serde(untagged)]
 // #[ts(untagged)]
 pub enum OptionalUpdate<T: Clone> {
@@ -285,22 +156,11 @@ pub enum OptionalUpdate<T: Clone> {
     Update(T),
 }
 
-// #[derive(Clone, Debug, Serialize, TS)]
-// #[serde(flatten)]
-// pub struct OptionalUpdate<T: Clone> {
-//     #[ts(optional)]
-//     inner: Option<OptionalUpdateInner<T>>,
-// }
-
-// // #[ts(optional = nullable)]
-
-// #[derive(Clone, Debug, Serialize, TS)]
-// pub struct OptionalUpdateInner<T: Clone>(Option<T>);
-
 pub type PluginUpdate = OptionalUpdate<String>;
 pub type SettingsUpdate = OptionalUpdate<bool>;
 pub type ThemeUpdate = OptionalUpdate<String>;
 pub type TitleUpdate = OptionalUpdate<String>;
+pub type TableUpdate = OptionalUpdate<String>;
 pub type VersionUpdate = OptionalUpdate<String>;
 pub type ColumnConfigUpdate = OptionalUpdate<HashMap<String, ColumnConfigValues>>;
 

package/src/rust/custom_elements/copy_dropdown.rs

@@ -61,7 +61,7 @@ impl CopyDropDownMenuElement {
     /// Internal Only.
     ///
     /// Set this custom element model's raw pointer.
-    pub fn set_model(&self, parent: &PerspectiveViewerElement) {
+    pub fn __set_model(&self, parent: &PerspectiveViewerElement) {
         self.set_config_model(parent)
     }
 
@@ -69,7 +69,11 @@ impl CopyDropDownMenuElement {
 }
 
 impl CopyDropDownMenuElement {
-    pub fn new_from_model<A: GetViewerConfigModel>(model: &A) -> Self {
+    pub fn new_from_model<A>(model: &A) -> Self
+    where
+        A: GetViewerConfigModel + StateProvider,
+        <A as StateProvider>::State: HasPresentation + HasRenderer + HasSession,
+    {
         let dropdown = global::document()
             .create_element("perspective-copy-menu")
             .unwrap()
@@ -80,18 +84,22 @@ impl CopyDropDownMenuElement {
         elem
     }
 
-    pub fn set_config_model<A: GetViewerConfigModel>(&self, model: &A) {
+    pub fn set_config_model<A>(&self, model: &A)
+    where
+        A: GetViewerConfigModel + StateProvider,
+        <A as StateProvider>::State: HasPresentation + HasRenderer + HasSession,
+    {
         let callback = Callback::from({
-            let model = model.cloned();
+            let model = model.clone_state();
             let modal_rc = self.modal.clone();
             move |x: ExportFile| {
                 let model = model.clone();
                 let modal = modal_rc.borrow().clone().unwrap();
                 spawn_local(async move {
                     let mime = x.method.mimetype(x.is_chart);
-                    let task = model.export_method_to_jsvalue(x.method);
+                    let task = model.export_method_to_blob(x.method);
                     let result = copy_to_clipboard(task, mime).await;
-                    crate::js_log_maybe!({
+                    crate::maybe_log!({
                         result?;
                         modal.hide()?;
                     })

package/src/rust/custom_elements/export_dropdown.rs

@@ -61,7 +61,7 @@ impl ExportDropDownMenuElement {
     /// Internal Only.
     ///
     /// Set this custom element model's raw pointer.
-    pub fn set_model(&self, parent: &PerspectiveViewerElement) {
+    pub fn __set_model(&self, parent: &PerspectiveViewerElement) {
         self.set_config_model(parent)
     }
 
@@ -69,7 +69,11 @@ impl ExportDropDownMenuElement {
 }
 
 impl ExportDropDownMenuElement {
-    pub fn new_from_model<A: GetViewerConfigModel>(model: &A) -> Self {
+    pub fn new_from_model<A>(model: &A) -> Self
+    where
+        A: GetViewerConfigModel + StateProvider,
+        <A as StateProvider>::State: HasPresentation + HasRenderer + HasSession,
+    {
         let dropdown = global::document()
             .create_element("perspective-export-menu")
             .unwrap()
@@ -80,15 +84,19 @@ impl ExportDropDownMenuElement {
         elem
     }
 
-    fn set_config_model<A: GetViewerConfigModel>(&self, model: &A) {
+    fn set_config_model<A>(&self, model: &A)
+    where
+        A: GetViewerConfigModel + StateProvider,
+        <A as StateProvider>::State: HasPresentation + HasRenderer + HasSession,
+    {
         let callback = Callback::from({
-            let model = model.cloned();
+            let model = model.clone_state();
             let modal_rc = self.modal.clone();
             move |x: ExportFile| {
                 if !x.name.is_empty() {
                     clone!(modal_rc, model);
                     spawn_local(async move {
-                        let val = model.export_method_to_jsvalue(x.method).await.unwrap();
+                        let val = model.export_method_to_blob(x.method).await.unwrap();
                         let is_chart = model.renderer().is_chart();
                         download(&x.as_filename(is_chart), &val).unwrap();
                         modal_rc.borrow().clone().unwrap().hide().unwrap();
@@ -98,10 +106,10 @@ impl ExportDropDownMenuElement {
         });
 
         let renderer = model.renderer().clone();
-        let presentation = model.presentation().clone();
+        let session = model.session().clone();
         let props = props!(ExportDropDownMenuProps {
             renderer,
-            presentation,
+            session,
             callback,
             root: self.elem.clone()
         });

package/src/rust/custom_elements/filter_dropdown.rs

@@ -93,10 +93,10 @@ impl FilterDropDownElement {
                         FilterDropDownMsg::SetValues(values),
                     ]);
 
-                    if let Some(x) = self.target.borrow().clone()
-                        && !self.modal.is_open()
-                    {
-                        ApiFuture::spawn(self.modal.clone().open(x, None))
+                    if let Some(x) = self.target.borrow().clone() {
+                        if !self.modal.is_open() {
+                            ApiFuture::spawn(self.modal.clone().open(x, None))
+                        }
                     }
                 }
             },

package/src/rust/custom_elements/mod.rs

@@ -10,6 +10,9 @@
 // ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
 // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
+//! Each file in `custom_elements` exports a single struct which will be the
+//! public [`wasm_bindgen`] API to a JavaScript Custom Element.
+
 mod column_dropdown;
 pub mod copy_dropdown;
 pub mod debug_plugin;