@perspective-dev/viewer 4.3.0 → 4.4.1

package/dist/esm/plugin.d.ts

@@ -132,12 +132,12 @@ export interface IPerspectiveViewerPlugin {
      * Like `update()`, but for when the dimensions of the plugin have changed
      * and the underlying data has not.
      */
-    resize(): Promise<void>;
+    resize(view: View): Promise<void>;
     /**
      * Notify the plugin that the style environment has changed.  Useful for
      * plugins which read CSS styles via `window.getComputedStyle()`.
      */
-    restyle(): Promise<void>;
+    restyle(view: View): Promise<void>;
     /**
      * Save this plugin's state to a JSON-serializable value.  While this value
      * can be anything, it should work reciprocally with `restore()` to return
@@ -149,15 +149,15 @@ export interface IPerspectiveViewerPlugin {
      * reload.  For example, `@perspective-dev/viewer-d3fc` uses
      * `plugin_config` to remember the user-repositionable legend coordinates.
      */
-    save(): Promise<any>;
+    save(): any;
     /**
      * Restore this plugin to a state previously returned by `save()`.
      */
-    restore(config: any): Promise<void>;
+    restore(config: any): void;
     /**
      * Free any resources acquired by this plugin and prepare to be deleted.
      */
-    delete(): Promise<void>;
+    delete(): void;
 }
 /**
  * The `<perspective-viewer-plugin>` element, the default perspective plugin
@@ -187,9 +187,9 @@ export declare class HTMLPerspectiveViewerPluginElement extends HTMLElement impl
     update(view: View): Promise<void>;
     draw(view: View): Promise<void>;
     clear(): Promise<void>;
-    resize(): Promise<void>;
-    restyle(): Promise<void>;
-    save(): Promise<any>;
-    restore(): Promise<void>;
+    resize(view: View): Promise<void>;
+    restyle(view: View): Promise<void>;
+    save(): any;
+    restore(): void;
     delete(): Promise<void>;
 }

package/dist/esm/ts-rs/NumberForegroundMode.d.ts

@@ -1 +1 @@
-export type NumberForegroundMode = "disabled" | "color" | "bar";
+export type NumberForegroundMode = "disabled" | "color" | "bar" | "label-bar";

package/dist/esm/ts-rs/ViewerConfig.d.ts

@@ -0,0 +1,36 @@
+import type { Aggregate } from "./Aggregate.js";
+import type { ColumnConfigValues } from "./ColumnConfigValues.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 state of an entire `custom_elements::PerspectiveViewerElement` component
+ * and its `Plugin`.
+ */
+export type ViewerConfig<V = string> = {
+    version: V;
+    columns_config: {
+        [key in string]?: ColumnConfigValues;
+    };
+    plugin: string;
+    plugin_config: 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;
+};

package/dist/wasm/perspective-viewer.d.ts

@@ -7,12 +7,18 @@ import type {
     ColumnWindow,
     ViewWindow,
     OnUpdateOptions,
+    JoinOptions,
     UpdateOptions,
     DeleteOptions,
     ViewConfigUpdate,
     SystemInfo,
 } from "@perspective-dev/client";
 
+export type * from "../../src/ts/ts-rs/ViewerConfig.d.ts";
+export type * from "../../src/ts/ts-rs/ViewerConfigUpdate.d.ts";
+import type {ViewerConfig} from "../../src/ts/ts-rs/ViewerConfig.d.ts";
+import type {ViewerConfigUpdate} from "../../src/ts/ts-rs/ViewerConfigUpdate.d.ts";
+
 
 
 /**
@@ -74,6 +80,30 @@ export class Client {
     get_hosted_table_names(): Promise<string[]>;
     handle_error(error: string, reconnect?: Function | null): Promise<void>;
     handle_response(value: any): Promise<void>;
+    /**
+     * Creates a new read-only [`Table`] by performing an INNER JOIN on two
+     * source tables. The resulting table is reactive: when either source
+     * table is updated, the join is automatically recomputed.
+     *
+     * # Arguments
+     *
+     * - `left` - The left source table (a [`Table`] instance or a table name
+     *   string).
+     * - `right` - The right source table (a [`Table`] instance or a table name
+     *   string).
+     * - `on` - The column name to join on. Must exist in both tables with the
+     *   same type.
+     * - `options` - Optional join configuration: `{ join_type?: "inner" |
+     *   "left" | "outer", name?: string }`.
+     *
+     * # JavaScript Examples
+     *
+     * ```javascript
+     * const joined = await client.join(orders_table, products_table, "Product ID", { join_type: "left" });
+     * const joined = await client.join("orders", "products", "Product ID", { join_type: "left" });
+     * ```
+     */
+    join(left: any, right: any, on: string, options?: JoinOptions | null): Promise<Table>;
     constructor(send_request: Function, close?: Function | null);
     new_proxy_session(on_response: Function): ProxySession;
     on_error(callback: Function): Promise<number>;
@@ -202,20 +232,9 @@ export class Client {
     terminate(): any;
 }
 
-export class ColumnDropDownElement {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-}
-
 export class CopyDropDownMenuElement {
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Internal Only.
-     *
-     * Set this custom element model's raw pointer.
-     */
     __set_model(parent: PerspectiveViewerElement): void;
     connected_callback(): void;
     hide(): void;
@@ -226,11 +245,6 @@ export class CopyDropDownMenuElement {
 export class ExportDropDownMenuElement {
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Internal Only.
-     *
-     * Set this custom element model's raw pointer.
-     */
     __set_model(parent: PerspectiveViewerElement): void;
     connected_callback(): void;
     hide(): void;
@@ -238,18 +252,6 @@ export class ExportDropDownMenuElement {
     open(target: HTMLElement): void;
 }
 
-export class FilterDropDownElement {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-}
-
-export class FunctionDropDownElement {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-}
-
 /**
  * JavaScript-facing DuckDB SQL query builder.
  *
@@ -296,6 +298,10 @@ export class GenericSQLVirtualServerModel {
      * Returns the SQL query to fetch data from a view with the given viewport.
      */
     viewGetData(view_id: string, config: any, viewport: any, schema: any): string;
+    /**
+     * Returns the SQL query to get the min and max values of a column.
+     */
+    viewGetMinMax(view_id: string, column_name: string, config: any): string;
     /**
      * Returns the SQL query to describe a view's schema.
      */
@@ -338,9 +344,9 @@ export class PerspectiveDebugPluginElement {
     draw(view: View): Promise<any>;
     constructor(elem: HTMLElement);
     resize(): Promise<any>;
-    restore(): Promise<any>;
+    restore(_config?: any | null): void;
     restyle(): Promise<any>;
-    save(): Promise<any>;
+    save(): any;
     update(view: View): Promise<any>;
     readonly config_column_names: any;
     readonly min_config_columns: any;
@@ -727,17 +733,20 @@ export class PerspectiveViewerElement {
      *
      * # Arguments
      *
-     * - `force` - If [`Self::resize`] is called with `false` or without an
-     *   argument, and _auto-size_ mode is enabled via [`Self::setAutoSize`],
-     *   [`Self::resize`] will log a warning and auto-disable auto-size mode.
+     * - `options` - An optional object with the following fields:
+     *   - `dimensions` - An optional object `{width, height}` providing
+     *     explicit size hints (in pixels) for the plugin container. When
+     *     provided, the plugin element will be temporarily sized to these
+     *     dimensions during resize, then reset.
      *
      * # JavaScript Examples
      *
      * ```javascript
-     * await viewer.resize(true)
+     * await viewer.resize()
+     * await viewer.resize({dimensions: {width: 800, height: 600}})
      * ```
      */
-    resize(force?: boolean | null): Promise<any>;
+    resize(options?: any | null): Promise<any>;
     /**
      * Restores this element from a full/partial
      * [`perspective_js::JsViewConfig`] (this element's user-configurable
@@ -769,7 +778,7 @@ export class PerspectiveViewerElement {
      * await viewer.restore({group_by: ["State"]});
      * ```
      */
-    restore(update: any): Promise<any>;
+    restore(update: ViewerConfigUpdate): Promise<any>;
     /**
      * Restyle all plugins from current document.
      *
@@ -784,7 +793,7 @@ export class PerspectiveViewerElement {
      * # JavaScript Examples
      *
      * ```javascript
-     * viewer.style = "--icon--color: red";
+     * viewer.style = "--psp--color: red";
      * await viewer.restyleElement();
      * ```
      */
@@ -810,7 +819,7 @@ export class PerspectiveViewerElement {
      * });
      * ```
      */
-    save(): Promise<any>;
+    save(): Promise<ViewerConfig>;
     /**
      * Sets the auto-pause behavior of this component.
      *
@@ -831,7 +840,7 @@ export class PerspectiveViewerElement {
      * viewer.setAutoPause(false);
      * ```
      */
-    setAutoPause(autopause: boolean): void;
+    setAutoPause(autopause: boolean): Promise<any>;
     /**
      * Sets the auto-size behavior of this component.
      *
@@ -1317,6 +1326,7 @@ export class View {
 export class VirtualDataSlice {
     free(): void;
     [Symbol.dispose](): void;
+    fromArrowIpc(ipc: Uint8Array): void;
     constructor(config: ViewConfigUpdate);
     setBooleanCol(name: string, index: number, val: any, group_by_index?: number | null): void;
     setCol(dtype: string, name: string, index: number, val: any, group_by_index?: number | null): void;
@@ -1352,10 +1362,7 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
-    readonly __wbg_columndropdownelement_free: (a: number, b: number) => void;
     readonly __wbg_copydropdownmenuelement_free: (a: number, b: number) => void;
-    readonly __wbg_filterdropdownelement_free: (a: number, b: number) => void;
-    readonly __wbg_functiondropdownelement_free: (a: number, b: number) => void;
     readonly __wbg_perspectivedebugpluginelement_free: (a: number, b: number) => void;
     readonly __wbg_perspectiveviewerelement_free: (a: number, b: number) => void;
     readonly copydropdownmenuelement___set_model: (a: number, b: number) => void;
@@ -1373,6 +1380,8 @@ export interface InitOutput {
     readonly perspectivedebugpluginelement_draw: (a: number, b: number) => number;
     readonly perspectivedebugpluginelement_name: (a: number, b: number) => void;
     readonly perspectivedebugpluginelement_new: (a: number) => number;
+    readonly perspectivedebugpluginelement_restore: (a: number, b: number, c: number) => void;
+    readonly perspectivedebugpluginelement_save: (a: number, b: number) => void;
     readonly perspectivedebugpluginelement_select_mode: (a: number, b: number) => void;
     readonly perspectiveviewerelement___get_model: (a: number) => number;
     readonly perspectiveviewerelement_connectedCallback: (a: number, b: number) => void;
@@ -1401,7 +1410,7 @@ export interface InitOutput {
     readonly perspectiveviewerelement_restore: (a: number, b: number) => number;
     readonly perspectiveviewerelement_restyleElement: (a: number) => number;
     readonly perspectiveviewerelement_save: (a: number) => number;
-    readonly perspectiveviewerelement_setAutoPause: (a: number, b: number) => void;
+    readonly perspectiveviewerelement_setAutoPause: (a: number, b: number) => number;
     readonly perspectiveviewerelement_setAutoSize: (a: number, b: number) => void;
     readonly perspectiveviewerelement_setSelection: (a: number, b: number, c: number) => void;
     readonly perspectiveviewerelement_setThrottle: (a: number, b: number, c: number) => void;
@@ -1410,10 +1419,8 @@ export interface InitOutput {
     readonly registerPlugin: (a: number, b: number) => void;
     readonly perspectivedebugpluginelement_update: (a: number, b: number) => number;
     readonly perspectivedebugpluginelement_min_config_columns: (a: number) => number;
-    readonly perspectivedebugpluginelement_save: (a: number) => number;
     readonly perspectivedebugpluginelement_delete: (a: number) => number;
     readonly perspectivedebugpluginelement_resize: (a: number) => number;
-    readonly perspectivedebugpluginelement_restore: (a: number) => number;
     readonly perspectivedebugpluginelement_restyle: (a: number) => number;
     readonly exportdropdownmenuelement_new: (a: number) => number;
     readonly __wbg_exportdropdownmenuelement_free: (a: number, b: number) => void;
@@ -1429,6 +1436,7 @@ export interface InitOutput {
     readonly client_get_hosted_table_names: (a: number) => number;
     readonly client_handle_error: (a: number, b: number, c: number, d: number) => number;
     readonly client_handle_response: (a: number, b: number) => number;
+    readonly client_join: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
     readonly client_new: (a: number, b: number, c: number) => void;
     readonly client_new_proxy_session: (a: number, b: number) => number;
     readonly client_on_error: (a: number, b: number) => number;
@@ -1447,6 +1455,7 @@ export interface InitOutput {
     readonly genericsqlvirtualservermodel_viewColumnSize: (a: number, b: number, c: number, d: number) => void;
     readonly genericsqlvirtualservermodel_viewDelete: (a: number, b: number, c: number, d: number) => void;
     readonly genericsqlvirtualservermodel_viewGetData: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly genericsqlvirtualservermodel_viewGetMinMax: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
     readonly genericsqlvirtualservermodel_viewSchema: (a: number, b: number, c: number, d: number) => void;
     readonly genericsqlvirtualservermodel_viewSize: (a: number, b: number, c: number, d: number) => void;
     readonly proxysession_close: (a: number) => number;
@@ -1494,6 +1503,7 @@ export interface InitOutput {
     readonly view_to_json: (a: number, b: number) => number;
     readonly view_to_json_string: (a: number, b: number) => number;
     readonly view_to_ndjson: (a: number, b: number) => number;
+    readonly virtualdataslice_fromArrowIpc: (a: number, b: number, c: number) => void;
     readonly virtualdataslice_new: (a: number) => number;
     readonly virtualdataslice_setBooleanCol: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
     readonly virtualdataslice_setCol: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
@@ -1503,20 +1513,19 @@ export interface InitOutput {
     readonly virtualdataslice_setStringCol: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
     readonly virtualserver_handleRequest: (a: number, b: number, c: number) => number;
     readonly virtualserver_new: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_13482: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_3123: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_3124: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_18167: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_18937: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_18961: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_20888: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_5237: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_5238: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_5235: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_18286: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_18978: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_14371: (a: number, b: number) => number;
-    readonly __wasm_bindgen_func_elem_18940: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_13446: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_3157: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_16508: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_17165: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_17190: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_24303: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_5198: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_5199: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_5196: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_16627: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_17207: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_14349: (a: number, b: number) => number;
+    readonly __wasm_bindgen_func_elem_17168: (a: number, b: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;