@perspective-dev/viewer 5.0.0 → 5.1.0

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

@@ -4,6 +4,7 @@ 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 { Windows } from "./Windows.js";
 import type { JsonValue } from "./serde_json/JsonValue.js";
 /**
  * The per-panel state of a [`ViewerConfig`] — everything except the
@@ -31,6 +32,7 @@ export type PanelViewerConfig<V = string> = {
     group_rollup_mode: GroupRollupMode;
     filter_op?: FilterReducer;
     expressions: Expressions;
+    windows?: Windows;
     columns: Array<string | null>;
     aggregates: {
         [key in string]?: Aggregate;

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

@@ -4,6 +4,7 @@ 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 { Windows } from "./Windows.js";
 import type { JsonValue } from "./serde_json/JsonValue.js";
 /**
  * The state of an entire `custom_elements::PerspectiveViewerElement` component
@@ -35,6 +36,7 @@ export type ViewerConfig<V = string> = {
     group_rollup_mode: GroupRollupMode;
     filter_op?: FilterReducer;
     expressions: Expressions;
+    windows?: Windows;
     columns: Array<string | null>;
     aggregates: {
         [key in string]?: Aggregate;

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

@@ -5,6 +5,7 @@ import type { FilterReducer } from "./FilterReducer.js";
 import type { GroupRollupMode } from "./GroupRollupMode.js";
 import type { OptionalUpdate } from "./OptionalUpdate.js";
 import type { Sort } from "./Sort.js";
+import type { Windows } from "./Windows.js";
 import type { JsonValue } from "./serde_json/JsonValue.js";
 export type ViewerConfigUpdate = {
     version?: OptionalUpdate<string>;
@@ -86,6 +87,14 @@ export type ViewerConfigUpdate = {
      * panel.
      */
     expressions?: Expressions;
+    /**
+     * The `windows` property declares ordered, partitioned rolling
+     * computations (moving aggregates, cumulative sums) as _new_ columns
+     * keyed by output alias (`{"name": {...spec}}`, symmetric with
+     * `expressions`), analogous to SQL window functions. See
+     * [`crate::config::WindowSpec`].
+     */
+    windows?: Windows;
     /**
      * Aggregates perform a calculation over an entire column, and are
      * displayed when one or more [Group By](#group-by) are applied to the

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

@@ -0,0 +1 @@
+export type WindowAggregate = "sum" | "avg" | "count" | "min" | "max" | "stddev" | "var" | "first" | "last" | "lag" | "lead" | "diff" | "rate" | "ema";

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

@@ -0,0 +1,7 @@
+import type { WindowSortDir } from "./WindowSortDir.js";
+/**
+ * The `Table` column which orders each partition, with its direction -
+ * serialized as a two-element array (`["ts", "desc"]`), symmetric with the
+ * `ViewConfig`'s `sort` field.
+ */
+export type WindowSort = [string, WindowSortDir];

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

@@ -0,0 +1,6 @@
+/**
+ * A window's order direction. A dedicated two-variant enum rather than
+ * [`crate::config::SortDir`] - the column-sort extras (`col asc`, `abs`,
+ * `none`) are meaningless inside a window frame and unrepresentable here.
+ */
+export type WindowSortDir = "asc" | "desc";

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

@@ -0,0 +1,46 @@
+import type { WindowAggregate } from "./WindowAggregate.js";
+import type { WindowSort } from "./WindowSort.js";
+/**
+ * The serialized form of [`WindowSpec`].
+ */
+export type WindowSpec = {
+    /**
+     * The input column - either a real `Table` column or an expression
+     * alias from the same `ViewConfig`.
+     */
+    column: string;
+    aggregate: WindowAggregate;
+    /**
+     * Columns whose distinct value tuples partition the rows; empty
+     * partitions the whole `Table` as one group.
+     */
+    partition_by?: Array<string>;
+    /**
+     * The `Table` column which orders each partition, and the direction.
+     */
+    order_by?: WindowSort | null;
+    /**
+     * A frame of the `rows` preceding each row, plus the row itself.
+     * Mutually exclusive with `range` and `cumulative`.
+     */
+    rows?: number | null;
+    /**
+     * A frame of the rows whose `order_by` value lies within `range` of
+     * each row's, requiring a numeric or temporal `order_by`. Mutually
+     * exclusive with `rows` and `cumulative`.
+     */
+    range?: number | null;
+    /**
+     * `true` frames all rows from the partition start through each row.
+     * Default can be omitted.
+     */
+    cumulative?: boolean | null;
+    /**
+     * Row offset for `lag`/`lead` (default 1).
+     */
+    offset?: number | null;
+    /**
+     * Smoothing factor in `(0, 1]` for `ema`.
+     */
+    alpha?: number | null;
+};

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

@@ -0,0 +1,10 @@
+import type { WindowSpec } from "./WindowSpec.js";
+/**
+ * The window columns of a `ViewConfig`, keyed by output column alias -
+ * symmetric with `expressions` (`{"name": {...spec}}`). An alias must not
+ * collide with a `Table` column, expression alias, or another window's
+ * key.
+ */
+export type Windows = {
+    [key in string]?: WindowSpec;
+};

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

@@ -1,6 +1,90 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/**
+ * A table hosted by a `VirtualServerHandler`, as returned by
+ * `getHostedTables()`. A plain `string` is shorthand for `{ name }`.
+ */
+export interface VirtualHostedTable {
+    name: string;
+    index?: string;
+    limit?: number;
+}
+
+/**
+ * Handler interface that you implement to provide custom data sources.
+ *
+ * All methods will be called by the `VirtualServer` when handling protocol
+ * messages from Perspective clients. Methods can return values directly or
+ * return Promises for asynchronous operations (e.g., database queries).
+ * Optional methods fall back to defaults documented per-method.
+ */
+export interface VirtualServerHandler {
+    getHostedTables():
+    | (string | VirtualHostedTable)[]
+    | Promise<(string | VirtualHostedTable)[]>;
+    tableSchema(
+    tableId: string,
+    ): Record<string, ColumnType> | Promise<Record<string, ColumnType>>;
+    tableSize(tableId: string): number | Promise<number>;
+    tableMakeView(
+    tableId: string,
+    viewId: string,
+    config: ViewConfigUpdate,
+    ): void | Promise<void>;
+    viewDelete(viewId: string): void | Promise<void>;
+    viewGetData(
+    viewId: string,
+    config: ViewConfig,
+    schema: Record<string, ColumnType>,
+    viewport: ViewWindow,
+    dataSlice: VirtualDataSlice,
+    ): void | Promise<void>;
+
+    /** Defaults to `tableSchema(viewId)`. */
+    viewSchema?(
+    viewId: string,
+    config: ViewConfig,
+    ): Record<string, ColumnType> | Promise<Record<string, ColumnType>>;
+
+    /** Defaults to `tableSize(viewId)`. */
+    viewSize?(viewId: string): number | Promise<number>;
+
+    /** Defaults to the length of `tableSchema(tableId)`. */
+    tableColumnsSize?(tableId: string): number | Promise<number>;
+
+    /** Defaults to the length of `viewSchema(viewId, config)`. */
+    viewColumnSize?(
+    viewId: string,
+    config: ViewConfig,
+    ): number | Promise<number>;
+
+    /** Required when `getFeatures()` reports `expressions: true`. */
+    tableValidateExpression?(
+    tableId: string,
+    expression: string,
+    ): ColumnType | Promise<ColumnType>;
+
+    viewGetMinMax?(
+    viewId: string,
+    columnName: string,
+    config: ViewConfig,
+    ): { min: Scalar; max: Scalar } | Promise<{ min: Scalar; max: Scalar }>;
+
+    /** Defaults to no optional features. */
+    getFeatures?(): Features | Promise<Features>;
+
+    /** Defaults to port `0`. */
+    tableMakePort?(): number | Promise<number>;
+
+    makeTable?(
+    tableId: string,
+    data: string | Uint8Array,
+    ): void | Promise<void>;
+}
+
+
+
 import type {
     ColumnType,
     TableInitOptions,
@@ -11,8 +95,11 @@ import type {
     JoinOptions,
     UpdateOptions,
     DeleteOptions,
+    ViewConfig,
     ViewConfigUpdate,
     SystemInfo,
+    Scalar,
+    Features,
 } from "@perspective-dev/client";
 
 export type * from "../../src/ts/ts-rs/ViewerConfig.d.ts";
@@ -1516,7 +1603,7 @@ export class VirtualServer {
     free(): void;
     [Symbol.dispose](): void;
     handleRequest(bytes: Uint8Array): Promise<any>;
-    constructor(handler: object);
+    constructor(handler: VirtualServerHandler);
 }
 
 export function get_wasm_module(): WebAssembly.Module;
@@ -1704,21 +1791,21 @@ 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_15590: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_3497: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_18482: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_19140: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_19169: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_26445: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_6144: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_6145: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_6146: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_6142: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_18602: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_19145: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_19186: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_16279: (a: number, b: number) => number;
-    readonly __wasm_bindgen_func_elem_19144: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_3667: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_16364: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_19409: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_20067: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_20096: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_27549: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_6430: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_6431: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_6432: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_6428: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_19529: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_20072: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_20113: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_17084: (a: number, b: number) => number;
+    readonly __wasm_bindgen_func_elem_20071: (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;