@perspective-dev/viewer 4.4.1 → 4.5.1

package/src/ts/ts-rs/PluginStaticConfig.ts

@@ -0,0 +1,78 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+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/src/ts/ts-rs/ViewerConfig.ts

@@ -1,6 +1,5 @@
 // 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 { ColumnConfigValues } from "./ColumnConfigValues.js";
 import type { Expressions } from "./Expressions.js";
 import type { Filter } from "./Filter.js";
 import type { FilterReducer } from "./FilterReducer.js";
@@ -12,4 +11,4 @@ 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, };
+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, };

package/src/ts/ts-rs/ViewerConfigUpdate.ts

@@ -1,15 +1,14 @@
 // 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 { 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>, title?: OptionalUpdate<string>, table?: OptionalUpdate<string>, theme?: OptionalUpdate<string>, settings?: OptionalUpdate<boolean>, plugin_config?: PluginConfig | null, columns_config?: OptionalUpdate<{ [key in string]?: ColumnConfigValues }>, 
+export type ViewerConfigUpdate = { version?: OptionalUpdate<string>, plugin?: OptionalUpdate<string>, title?: OptionalUpdate<string>, table?: OptionalUpdate<string>, theme?: OptionalUpdate<string>, settings?: OptionalUpdate<boolean>, plugin_config?: OptionalUpdate<{ [key in string]?: JsonValue }>, columns_config?: OptionalUpdate<{ [key in string]?: { [key in string]?: JsonValue } }>, 
 /**
  * A group by _groups_ the dataset by the unique values of each column used
  * as a group by - a close analogue in SQL to the `GROUP BY` statement.

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

@@ -1,31 +0,0 @@
-import type { CustomNumberFormatConfig } from "./CustomNumberFormatConfig.js";
-import type { DatetimeColorMode } from "./DatetimeColorMode.js";
-import type { DatetimeFormatType } from "./DatetimeFormatType.js";
-import type { FormatMode } from "./FormatMode.js";
-import type { NumberBackgroundMode } from "./NumberBackgroundMode.js";
-import type { NumberForegroundMode } from "./NumberForegroundMode.js";
-import type { StringColorMode } from "./StringColorMode.js";
-/**
- * The value de/serialized and stored in the viewer config.
- * Also passed to the plugin via `plugin.save()`.
- */
-export type ColumnConfigValues = {
-    symbols?: {
-        [key in string]?: string;
-    };
-    number_format?: CustomNumberFormatConfig | null;
-    aggregate_depth?: number;
-    number_fg_mode?: NumberForegroundMode;
-    number_bg_mode?: NumberBackgroundMode;
-    pos_fg_color: string | null;
-    neg_fg_color: string | null;
-    pos_bg_color: string | null;
-    neg_bg_color: string | null;
-    fg_gradient: number | null;
-    bg_gradient: number | null;
-    format?: FormatMode;
-    string_color_mode?: StringColorMode;
-    color?: string | null;
-    date_format?: DatetimeFormatType;
-    datetime_color_mode?: DatetimeColorMode;
-};

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

@@ -1 +0,0 @@
-export type CustomDatetimeFormat = "long" | "short" | "narrow" | "numeric" | "2-digit" | "disabled";

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

@@ -1,15 +0,0 @@
-import type { CustomDatetimeFormat } from "./CustomDatetimeFormat.js";
-import type { FormatUnit } from "./FormatUnit.js";
-export type CustomDatetimeStyleConfig = {
-    format: FormatUnit;
-    timeZone?: string | null;
-    fractionalSecondDigits?: number;
-    second?: CustomDatetimeFormat;
-    minute?: CustomDatetimeFormat;
-    hour?: CustomDatetimeFormat;
-    day?: CustomDatetimeFormat;
-    weekday?: CustomDatetimeFormat;
-    month?: CustomDatetimeFormat;
-    year?: CustomDatetimeFormat;
-    hour12?: boolean;
-};

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

@@ -1,18 +0,0 @@
-import type { RoundingMode } from "./RoundingMode.js";
-import type { RoundingPriority } from "./RoundingPriority.js";
-import type { SignDisplay } from "./SignDisplay.js";
-import type { TrailingZeroDisplay } from "./TrailingZeroDisplay.js";
-import type { UseGrouping } from "./UseGrouping.js";
-export type CustomNumberFormatConfig = {
-    minimumIntegerDigits: number | null;
-    minimumFractionDigits: number | null;
-    maximumFractionDigits: number | null;
-    minimumSignificantDigits: number | null;
-    maximumSignificantDigits: number | null;
-    roundingPriority: RoundingPriority | null;
-    roundingIncrement: number | null;
-    roundingMode: RoundingMode | null;
-    trailingZeroDisplay: TrailingZeroDisplay | null;
-    useGrouping: UseGrouping | null;
-    signDisplay: SignDisplay | null;
-};

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

@@ -1 +0,0 @@
-export type DatetimeColorMode = "none" | "foreground" | "background";

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

@@ -1,6 +0,0 @@
-import type { CustomDatetimeStyleConfig } from "./CustomDatetimeStyleConfig.js";
-import type { SimpleDatetimeStyleConfig } from "./SimpleDatetimeStyleConfig.js";
-/**
- * `Simple` case has all default-able keys and must be last!
- */
-export type DatetimeFormatType = CustomDatetimeStyleConfig | SimpleDatetimeStyleConfig;

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

@@ -1 +0,0 @@
-export type FormatMode = "none" | "link" | "bold" | "italics";

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

@@ -1 +0,0 @@
-export type FormatUnit = "custom";

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

@@ -1 +0,0 @@
-export type NumberBackgroundMode = "disabled" | "color" | "gradient" | "pulse";

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

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

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

@@ -1,2 +0,0 @@
-import type { JsonValue } from "./serde_json/JsonValue.js";
-export type PluginConfig = JsonValue;

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

@@ -1 +0,0 @@
-export type RoundingMode = "ceil" | "floor" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven";

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

@@ -1 +0,0 @@
-export type RoundingPriority = "auto" | "morePrecision" | "lessPrecision";

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

@@ -1 +0,0 @@
-export type SignDisplay = "auto" | "always" | "exceptZero" | "negative" | "never";

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

@@ -1 +0,0 @@
-export type SimpleDatetimeFormat = "full" | "long" | "medium" | "short" | "disabled";

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

@@ -1,6 +0,0 @@
-import type { SimpleDatetimeFormat } from "./SimpleDatetimeFormat.js";
-export type SimpleDatetimeStyleConfig = {
-    timeZone?: string | null;
-    dateStyle?: SimpleDatetimeFormat;
-    timeStyle?: SimpleDatetimeFormat;
-};

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

@@ -1 +0,0 @@
-export type StringColorMode = "none" | "foreground" | "background" | "series";

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

@@ -1 +0,0 @@
-export type TrailingZeroDisplay = "auto" | "stripIfInteger";

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

@@ -1 +0,0 @@
-export type UseGrouping = "always" | "auto" | "min2" | boolean;