@perspective-dev/viewer 4.4.1 → 4.5.1

package/dist/esm/perspective-viewer.worker.d.ts

@@ -0,0 +1,2 @@
+export * from "../../dist/wasm/perspective-viewer.js";
+export { default } from "../../dist/wasm/perspective-viewer.js";

package/dist/esm/plugin.d.ts

@@ -1,4 +1,5 @@
 import type { View } from "@perspective-dev/client";
+import { PluginStaticConfig } from "./ts-rs/PluginStaticConfig.js";
 /**
  * The `IPerspectiveViewerPlugin` interface defines the necessary API for a
  * `<perspective-viewer>` plugin, which also must be an `HTMLElement` via the
@@ -6,7 +7,8 @@ import type { View } from "@perspective-dev/client";
  * scratch however, the simplest way is to inherit from
  * `<perspective-viewer-plugin>`, which implements `IPerspectiveViewerPlugin`
  * with non-offensive default implementations, where only the `draw()` and
- * `name()` methods need be overridden to get started with a simple plugin.
+ * `get_static_config()` methods need be overridden to get started with a
+ * simple plugin.
  *
  * Note that plugins are frozen once a `<perspective-viewer>` has been
  * instantiated, so generally new plugin code must be executed at the module
@@ -17,8 +19,8 @@ import type { View } from "@perspective-dev/client";
  * ```javascript
  * const BasePlugin = customElements.get("perspective-viewer-plugin");
  * class MyPlugin extends BasePlugin {
- *     get name() {
- *         return "My Plugin";
+ *     get_static_config() {
+ *         return { name: "My Plugin", config_column_names: [] };
  *     }
  *     async draw(view) {
  *         const count = await view.num_rows();
@@ -34,57 +36,16 @@ import type { View } from "@perspective-dev/client";
  */
 export interface IPerspectiveViewerPlugin {
     /**
-     * The name for this plugin, which is used as both it's unique key for use
-     * as a parameter for the `plugin` field of a `ViewerConfig`, and as the
-     * display name for this plugin in the `<perspective-viewer>` UI.
+     * Static plugin configuration. Called exactly once per plugin at
+     * registration time and cached; the result must be stable for the
+     * lifetime of the application.
      */
-    get name(): string;
-    /**
-     * Select mode determines how column add/remove buttons behave for this
-     * plugin.  `"select"` mode exclusively selects the added column, removing
-     * other columns.  `"toggle"` mode toggles the column on or off (dependent
-     * on column state), leaving existing columns alone.
-     */
-    get select_mode(): string | undefined;
-    /**
-     * The minimum number of columns required for this plugin to operate.
-     * This mostly affects drag/drop and column remove button behavior,
-     * preventing the use from applying configs which violate this min.
-     *
-     * While this option can technically be `undefined` (as in the case of
-     * `@perspective-dev/viewer-datagrid`), doing so currently has nearly
-     * identical behavior to 1.
-     */
-    get min_config_columns(): number | undefined;
-    /**
-     * The named column labels, if desired.  Named columns behave differently
-     * in drag/drop mode than unnamed columns, having replace/swap behavior
-     * rather than insert.  If provided, the length of `config_column_names`
-     * _must_ be `>= min_config_columns`, as this is assumed by the drag/drop
-     * logic.
-     */
-    get config_column_names(): string[] | undefined;
-    /**
-     * The load priority of the plugin. If the plugin shares priority with another,
-     * the first to load has a higher priority.
-     *
-     * A larger number has a higher priority.
-     *
-     * The plugin with the highest priority will be loaded by default by the Perspective viewer.
-     * If you would like to instead begin with a lower priority plugin, choose it explicitly with
-     * a `HTMLPerspectiveViewerPluginElement.restore` call.
-     */
-    get priority(): number | undefined;
-    /**
-     * Given a column's grouping (determined by indexing it in `plugin.config_column_names`)
-     * and its view type, determines whether or not to render column styles in the settings sidebar.
-     * Implementing this function and `column_style_config` allows the plugin to interface with the viewer's column configuration API.
-     */
-    can_render_column_styles?: (view_type: string, group: string) => boolean;
+    get_static_config(): PluginStaticConfig;
     /**
      * Determines which column configuration controls are populated in the viewer.
-     * Corresponds to the data the plugin will recieve on save.
-     * Implementing this function and `can_render_column_styles` allows the plugin to interface with the viewer's column configuration API.
+     * Corresponds to the data the plugin will recieve on save. Only
+     * invoked when `can_render_column_styles` is `true` in the static
+     * config.
      */
     column_style_config?: (view_type: string, group: string) => any;
     /**
@@ -137,19 +98,7 @@ export interface IPerspectiveViewerPlugin {
      * Notify the plugin that the style environment has changed.  Useful for
      * plugins which read CSS styles via `window.getComputedStyle()`.
      */
-    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
-     * this plugin's renderer to the same state, though potentially with a
-     * different `View`.
-     *
-     * `save()` should be used for user-persistent settings that are
-     * data-agnostic, so the user can have persistent view during refresh or
-     * reload.  For example, `@perspective-dev/viewer-d3fc` uses
-     * `plugin_config` to remember the user-repositionable legend coordinates.
-     */
-    save(): any;
+    restyle(): void;
     /**
      * Restore this plugin to a state previously returned by `save()`.
      */
@@ -177,19 +126,14 @@ export interface IPerspectiveViewerPlugin {
  */
 export declare class HTMLPerspectiveViewerPluginElement extends HTMLElement implements IPerspectiveViewerPlugin {
     constructor();
-    get name(): string;
-    get select_mode(): "select" | "toggle";
-    get min_config_columns(): number | undefined;
-    get config_column_names(): string[] | undefined;
-    get priority(): number;
-    can_render_column_styles(): boolean;
+    get_static_config(): PluginStaticConfig;
     column_style_config(): any;
     update(view: View): Promise<void>;
     draw(view: View): Promise<void>;
     clear(): Promise<void>;
     resize(view: View): Promise<void>;
-    restyle(view: View): Promise<void>;
-    save(): any;
+    restyle(): void;
     restore(): void;
     delete(): Promise<void>;
+    get supports_streaming(): boolean;
 }

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

@@ -0,0 +1 @@
+export type ColumnSelectMode = "toggle" | "select";

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

@@ -0,0 +1,77 @@
+import type { ColumnSelectMode } from "./ColumnSelectMode.js";
+import type { GroupRollupMode } from "./GroupRollupMode.js";
+/**
+ * Static, immutable configuration for a plugin.
+ *
+ * Returned once per plugin from `get_static_config()` at registration
+ * time and cached in [`crate::renderer::PluginRecord`]. Consumers
+ * (renderer, session, queries, components) read these fields off the
+ * renderer's active-plugin metadata rather than calling back into JS.
+ *
+ * `<perspective-viewer>` reads this exactly once per plugin (at
+ * `registerPlugin` time) and caches it for the lifetime of the
+ * application. The result must be stable; do not mutate any field
+ * after registration.
+ */
+export type PluginStaticConfig = {
+    /**
+     * The unique key for this plugin. Used as the `plugin` field in a
+     * `ViewerConfig` and as the display name key in the
+     * `<perspective-viewer>` UI.
+     */
+    name: string;
+    /**
+     * Category in the plugin picker menu.
+     */
+    category?: string | null;
+    /**
+     * Soft limit on the number of columns the plugin will render.
+     * Triggers the "Rendering N of M" warning when the view exceeds
+     * this value (until dismissed).
+     */
+    max_columns?: number | null;
+    /**
+     * Soft limit on the number of cells (rows × columns) the plugin
+     * will render. Triggers the "Rendering N of M" warning when the view
+     * exceeds this value (until dismissed).
+     */
+    max_cells?: number | null;
+    /**
+     * Column add/remove behavior. `"select"` exclusively selects the
+     * added column, removing other columns. `"toggle"` toggles the
+     * column on or off based on its current state, leaving other
+     * columns alone.
+     */
+    select_mode?: ColumnSelectMode;
+    /**
+     * Minimum number of columns the plugin requires to render. Mostly
+     * affects drag/drop and column-remove button behavior. `undefined`
+     * is treated identically to `1`.
+     */
+    min_config_columns?: number | null;
+    /**
+     * Named column slots. Named columns have replace/swap behavior in
+     * drag/drop rather than insert. The length must be at least
+     * `min_config_columns`.
+     */
+    config_column_names?: Array<string>;
+    /**
+     * Group-rollup modes the plugin accepts, in preference order.
+     * The first entry that matches a feature flag becomes the default.
+     */
+    group_rollup_modes?: Array<GroupRollupMode> | null;
+    /**
+     * Plugin load priority. Higher numbers win; ties resolve in
+     * registration order. The highest-priority plugin is loaded by
+     * default unless `restore({ plugin })` overrides it.
+     */
+    priority?: number | null;
+    /**
+     * Whether this plugin opts into per-column style controls in the
+     * settings sidebar. When `true`, the StyleTab is shown for active
+     * columns and the plugin's `column_config_schema` is queried for
+     * the per-column field set. When `false` or omitted, no StyleTab
+     * is shown.
+     */
+    can_render_column_styles?: boolean;
+};

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

@@ -1,5 +1,4 @@
 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";
@@ -13,10 +12,14 @@ import type { JsonValue } from "./serde_json/JsonValue.js";
 export type ViewerConfig<V = string> = {
     version: V;
     columns_config: {
-        [key in string]?: ColumnConfigValues;
+        [key in string]?: {
+            [key in string]?: JsonValue;
+        };
     };
     plugin: string;
-    plugin_config: JsonValue;
+    plugin_config: {
+        [key in string]?: JsonValue;
+    };
     settings: boolean;
     table: string | null;
     theme: string | null;

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

@@ -1,12 +1,11 @@
 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 { OptionalUpdate } from "./OptionalUpdate.js";
-import type { PluginConfig } from "./PluginConfig.js";
 import type { Sort } from "./Sort.js";
+import type { JsonValue } from "./serde_json/JsonValue.js";
 export type ViewerConfigUpdate = {
     version?: OptionalUpdate<string>;
     plugin?: OptionalUpdate<string>;
@@ -14,9 +13,13 @@ export type ViewerConfigUpdate = {
     table?: OptionalUpdate<string>;
     theme?: OptionalUpdate<string>;
     settings?: OptionalUpdate<boolean>;
-    plugin_config?: PluginConfig | null;
+    plugin_config?: OptionalUpdate<{
+        [key in string]?: JsonValue;
+    }>;
     columns_config?: OptionalUpdate<{
-        [key in string]?: ColumnConfigValues;
+        [key in string]?: {
+            [key in string]?: JsonValue;
+        };
     }>;
     /**
      * A group by _groups_ the dataset by the unique values of each column used

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

@@ -6,6 +6,7 @@ import type {
     TableInitOptions,
     ColumnWindow,
     ViewWindow,
+    TypedArrayWindow,
     OnUpdateOptions,
     JoinOptions,
     UpdateOptions,
@@ -16,6 +17,7 @@ import type {
 
 export type * from "../../src/ts/ts-rs/ViewerConfig.d.ts";
 export type * from "../../src/ts/ts-rs/ViewerConfigUpdate.d.ts";
+export type * from "../../src/ts/ts-rs/PluginStaticConfig.d.ts";
 import type {ViewerConfig} from "../../src/ts/ts-rs/ViewerConfig.d.ts";
 import type {ViewerConfigUpdate} from "../../src/ts/ts-rs/ViewerConfigUpdate.d.ts";
 
@@ -63,6 +65,29 @@ export class Client {
     free(): void;
     [Symbol.dispose](): void;
     __getClassname(): string;
+    /**
+     * Unsafely gets a [`View`] by raw ID, useful for JavaScript multi-threaded
+     * (via Web Worker) context where a standard `View` cannot otherwise be
+     * shared because its wrapper is not serializable.
+     *
+     * # Safety
+     *
+     * This method is unsafe because the lifetime of a [`View`] is bound to
+     * the [`Client`] which created it.
+     *
+     * The caller must guarantee that `entity_id` corresponds to a live
+     * [`crate::View`] on the connected server (obtained from another
+     * [`Client`]'s [`crate::View::get_name`] and forwarded across the
+     * serialization boundary).
+     *
+     * # JavaScript Examples
+     *
+     * ```javascript
+     * const view = client.__unsafe_open_view(name_from_main_thread);
+     * const cols = await view.to_columns();
+     * ```
+     */
+    __unsafe_open_view(entity_id: string): View;
     /**
      * Retrieves the names of all tables that this client has access to.
      *
@@ -345,7 +370,7 @@ export class PerspectiveDebugPluginElement {
     constructor(elem: HTMLElement);
     resize(): Promise<any>;
     restore(_config?: any | null): void;
-    restyle(): Promise<any>;
+    restyle(): void;
     save(): any;
     update(view: View): Promise<any>;
     readonly config_column_names: any;
@@ -463,7 +488,7 @@ export class PerspectiveViewerElement {
      *
      * This method is only really useful for the `"plugin"` method, which
      * will use the configured plugin's export (e.g. PNG for
-     * `@perspective-dev/viewer-d3fc`). Otherwise, prefer to call the
+     * `@perspective-dev/viewer-charts`). Otherwise, prefer to call the
      * equivalent method on the underlying [`View`] directly.
      *
      * # Arguments
@@ -600,6 +625,13 @@ export class PerspectiveViewerElement {
      * [`PerspectiveViewerElement::save`]), and also makes no API calls to the
      * server (unlike [`PerspectiveViewerElement::getView`] followed by
      * [`View::get_config`])
+     *
+     * Returns the [`ViewConfig`] the currently-bound `View` was constructed
+     * from, so the value is consistent with what the active plugin is
+     * rendering even if a queued [`Self::restore`]/`update_and_render` has
+     * already mutated the live config in anticipation of the next draw.
+     * Falls back to the live session config when no `View` has yet been
+     * created (e.g., after `load` but before the first render).
      */
     getViewConfig(): Promise<any>;
     /**
@@ -1147,6 +1179,7 @@ export class View {
     free(): void;
     [Symbol.dispose](): void;
     __get_model(): View;
+    __unsafe_get_name(): string;
     /**
      * Collapses the `group_by` row at `row_index`.
      */
@@ -1321,6 +1354,23 @@ export class View {
      * formatted [`String`].
      */
     to_ndjson(window?: ViewWindow | null): Promise<string>;
+    /**
+     * Fetches columns from the [`View`] in Arrow format, decodes them, and
+     * passes typed array views to `callback`. All arrays are only valid for
+     * the duration of the callback — if `callback` returns a `Promise`, it
+     * is awaited before the backing Arrow buffer is released, so async
+     * callbacks may use the views for the full duration of the awaited
+     * work (e.g. across an `await requestAnimationFrame`-backed promise).
+     *
+     * # Arguments
+     *
+     * - `window` - Optional [`TypedArrayWindow`] controlling row/column
+     *   windowing and output options (e.g., `float32` mode).
+     * - `callback` - A JS function called with `(names: string[], values:
+     *   TypedArray[], validities: (Uint8Array|null)[], dictionaries:
+     *   (string[]|null)[]) => void | Promise<void>`.
+     */
+    with_typed_arrays(window: TypedArrayWindow | null | undefined, callback: Function): Promise<void>;
 }
 
 export class VirtualDataSlice {
@@ -1343,6 +1393,10 @@ export class VirtualServer {
     constructor(handler: object);
 }
 
+export function get_wasm_module(): WebAssembly.Module;
+
+export function get_worker_url(): URL;
+
 /**
  * Register this crate's Custom Elements in the browser's current session.
  *
@@ -1351,7 +1405,7 @@ export class VirtualServer {
  * By default, this crate does not register `PerspectiveViewerElement` (as to
  * preserve backwards-compatible synchronous API).
  */
-export function init(): void;
+export function init(module: WebAssembly.Module, url: URL): void;
 
 /**
  * Register a plugin globally.
@@ -1373,7 +1427,9 @@ export interface InitOutput {
     readonly exportdropdownmenuelement___set_model: (a: number, b: number) => void;
     readonly exportdropdownmenuelement_hide: (a: number, b: number) => void;
     readonly exportdropdownmenuelement_open: (a: number, b: number) => void;
-    readonly init: () => void;
+    readonly get_wasm_module: (a: number) => void;
+    readonly get_worker_url: (a: number) => void;
+    readonly init: (a: number, b: number) => void;
     readonly perspectivedebugpluginelement_clear: (a: number) => number;
     readonly perspectivedebugpluginelement_config_column_names: (a: number) => number;
     readonly perspectivedebugpluginelement_connectedCallback: (a: number) => void;
@@ -1419,9 +1475,9 @@ 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_restyle: (a: number) => void;
     readonly perspectivedebugpluginelement_delete: (a: number) => number;
     readonly perspectivedebugpluginelement_resize: (a: number) => number;
-    readonly perspectivedebugpluginelement_restyle: (a: number) => number;
     readonly exportdropdownmenuelement_new: (a: number) => number;
     readonly __wbg_exportdropdownmenuelement_free: (a: number, b: number) => void;
     readonly exportdropdownmenuelement_connected_callback: (a: number) => void;
@@ -1433,6 +1489,7 @@ export interface InitOutput {
     readonly __wbg_virtualdataslice_free: (a: number, b: number) => void;
     readonly __wbg_virtualserver_free: (a: number, b: number) => void;
     readonly client___getClassname: (a: number, b: number) => void;
+    readonly client___unsafe_open_view: (a: number, b: number, c: number) => number;
     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;
@@ -1480,6 +1537,7 @@ export interface InitOutput {
     readonly table_validate_expressions: (a: number, b: number) => number;
     readonly table_view: (a: number, b: number) => number;
     readonly view___get_model: (a: number) => number;
+    readonly view___unsafe_get_name: (a: number, b: number) => void;
     readonly view_collapse: (a: number, b: number) => number;
     readonly view_column_paths: (a: number, b: number) => number;
     readonly view_delete: (a: number) => number;
@@ -1503,6 +1561,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 view_with_typed_arrays: (a: number, b: number, c: 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;
@@ -1513,19 +1572,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_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 __wasm_bindgen_func_elem_3150: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_13605: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_16753: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_17412: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_17437: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_24661: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_5312: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_5313: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_5310: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_16872: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_17454: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_14526: (a: number, b: number) => number;
+    readonly __wasm_bindgen_func_elem_17415: (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;