@uwdata/mosaic-spec 0.16.1 → 0.17.0

package/dist/types/parse-spec.d.ts

@@ -1,111 +0,0 @@
-/**
- * @typedef {{
- *   attributes: Set<string>;
- *   interactors: Set<string>;
- *   legends: Set<string>;
- *   marks: Set<string>;
- * }} PlotNames names for supported plot elements
- */
-/**
- * Parse a Mosaic specification to an AST (abstract syntax tree).
- * @param {import('./spec/Spec.js').Spec} spec The input specification.
- * @param {object} [options] Optional parse options object.
- * @param {Map<string, Function>} [options.components] Map of component names to parse functions.
- * @param {Set<string>} [options.transforms] The names of allowed transform functions.
- * @param {Set<string>} [options.inputs] The names of supported input widgets.
- * @param {PlotNames} [options.plot] The names of supported plot elements.
- * @param {any[]} [options.params] An array of [name, node] pairs of pre-parsed
- *  Param or Selection AST nodes.
- * @param {any[]} [options.datasets] An array of [name, node] pairs of pre-parsed
- *  dataset definition AST nodes.
- * @returns {SpecNode} The top-level AST spec node.
- */
-export function parseSpec(spec: import("./spec/Spec.js").Spec, options?: {
-    components?: Map<string, Function>;
-    transforms?: Set<string>;
-    inputs?: Set<string>;
-    plot?: PlotNames;
-    params?: any[];
-    datasets?: any[];
-}): SpecNode;
-export class ParseContext {
-    /**
-     * Create a new parser context.
-     * @param {object} [options]
-     * @param {Map<string, Function>} [options.components] Map of component names to parse functions.
-     * @param {Set<string>} [options.transforms] The names of allowed transform functions.
-     * @param {Set<string>} [options.inputs] The names of supported input widgets.
-     * @param {PlotNames} [options.plot] The names of supported plot elements.
-     * @param {any[]} [options.params] An array of [name, node] pairs of pre-parsed
-     *  Param or Selection AST nodes.
-     * @param {any[]} [options.datasets] An array of [name, node] pairs of pre-parsed
-     *  dataset definition AST nodes.
-     */
-    constructor({ components, transforms, inputs, plot, params, datasets }?: {
-        components?: Map<string, Function>;
-        transforms?: Set<string>;
-        inputs?: Set<string>;
-        plot?: PlotNames;
-        params?: any[];
-        datasets?: any[];
-    });
-    components: Map<string, Function>;
-    transforms: Set<string>;
-    inputs: Set<string>;
-    plot: PlotNames;
-    params: Map<any, any>;
-    datasets: Map<any, any>;
-    parse(spec: any): SpecNode;
-    plotDefaults: import("./ast/PlotAttributeNode.js").PlotAttributeNode[];
-    parseComponent(spec: any): any;
-    /**
-     * Test if a value is a param reference, if so, generates a parameter
-     * definition as needed and returns a new ParamRefNode. Otherwise,
-     * returns a LiteralNode for the given value.
-     * @param {*} value The value to test.
-     * @returns {ParamRefNode|LiteralNode} An AST node for the input value.
-     */
-    maybeParam(value: any): ParamRefNode | LiteralNode;
-    /**
-     * Test if a value is a param reference, if so, generates a selection
-     * definition as needed and returns a new ParamRefNode. Otherwise,
-     * returns a LiteralNode for the given value.
-     * @param {*} value The value to test.
-     * @returns {ParamRefNode|LiteralNode} An AST node for the input value.
-     */
-    maybeSelection(value: any): ParamRefNode | LiteralNode;
-    /**
-     * Create a parameter reference. Generates a parameter definition if needed
-     * and returns a new ParamRefNode.
-     * @param {string} name The parameter name.
-     * @param {() => ParamNode | SelectionNode} [makeNode] A Param or Selection AST
-     *  node constructor.
-     * @returns {ParamRefNode|null} A node referring to the param or selection.
-     */
-    paramRef(name: string, makeNode?: () => ParamNode | SelectionNode): ParamRefNode | null;
-    /**
-     * Create a selection reference. Generates a selection definition if needed
-     * and returns a new ParamRefNode. Returns null if a non-selection parameter
-     * with the same name already exists and *strict* is true.
-     * @param {string} name The selection name.
-     * @param {boolean} [strict=false] Indicates if this method may return param
-     *  references (false, default) or only selection references (true).
-     * @returns {ParamRefNode|null} A node referring to the param or selection.
-     */
-    selectionRef(name: string, strict?: boolean): ParamRefNode | null;
-    error(message: any, data: any): void;
-}
-/**
- * names for supported plot elements
- */
-export type PlotNames = {
-    attributes: Set<string>;
-    interactors: Set<string>;
-    legends: Set<string>;
-    marks: Set<string>;
-};
-import { SpecNode } from './ast/SpecNode.js';
-import { ParamRefNode } from './ast/ParamRefNode.js';
-import { LiteralNode } from './ast/LiteralNode.js';
-import { ParamNode } from './ast/ParamNode.js';
-import { SelectionNode } from './ast/SelectionNode.js';

package/dist/types/spec/CSSStyles.d.ts

@@ -1,3 +0,0 @@
-type OmittedProperties = 'parentRule' | 'getPropertyPriority' | 'getPropertyValue' | 'item' | 'removeProperty' | 'setProperty';
-export type CSSStyles = Partial<Omit<CSSStyleDeclaration, OmittedProperties>>;
-export {};

package/dist/types/spec/Data.d.ts

@@ -1,165 +0,0 @@
-export interface DataBaseOptions {
-    /**
-     * A list of column names to extract upon load.
-     * Any other columns are omitted.
-     */
-    select?: string[];
-    /**
-     * A filter (WHERE clause) to apply upon load.
-     * Only rows that pass the filted are included.
-     */
-    where?: string | string[];
-    /**
-     * Flag (default `false`) to generate a view instead of a table.
-     */
-    view?: boolean;
-    /**
-     * Flag (default `true`) to generate a temporary view or table.
-     */
-    temp?: boolean;
-    /**
-     * Flag (default `true`) to replace an existing table of the same name.
-     * If `false`, creating a new table with an existing name raises an error.
-     */
-    replace?: boolean;
-}
-/**
- * A SQL query defining a new temporary database table.
- */
-export type DataQuery = string;
-/**
- * An inline array of data objects to treat as JSON data.
- */
-export type DataArray = object[];
-/**
- * A data definition that loads an external data file.
- */
-export interface DataFile extends DataBaseOptions {
-    /**
-     * The data file to load. If no type option is provided,
-     * the file suffix must be one of `.csv`, `.json`, or `.parquet`.
-     */
-    file: `${string}.parquet` | `${string}.csv` | `${string}.json`;
-}
-/**
- * A data definition that queries an existing table.
- */
-export interface DataTable extends DataBaseOptions {
-    /**
-     * The data source type. One of:
-     * - `"table"`: Define a new table based on a SQL query.
-     * - `"csv"`: Load a comma-separated values (CSV) file.
-     * - `"json"`: Load JavaScript Object Notation (json) data.
-     * - `"parquet"`: Load a Parquet file.
-     * - `"spatial"`: Load a spatial data file format via `ST_Read`.
-     */
-    type: 'table';
-    /**
-     * A SQL query string for the desired table data.
-     */
-    query: string;
-}
-/**
- * A data definition that loads a parquet file.
- */
-export interface DataParquet extends DataBaseOptions {
-    /**
-     * The data source type. One of:
-     * - `"table"`: Define a new table based on a SQL query.
-     * - `"csv"`: Load a comma-separated values (CSV) file.
-     * - `"json"`: Load JavaScript Object Notation (json) data.
-     * - `"parquet"`: Load a Parquet file.
-     * - `"spatial"`: Load a spatial data file format via `ST_Read`.
-     */
-    type: 'parquet';
-    /**
-     * The file path for the dataset to load.
-     */
-    file: string;
-}
-/**
- * A data definition that loads a csv file.
- */
-export interface DataCSV extends DataBaseOptions {
-    /**
-     * The data source type. One of:
-     * - `"table"`: Define a new table based on a SQL query.
-     * - `"csv"`: Load a comma-separated values (CSV) file.
-     * - `"json"`: Load JavaScript Object Notation (json) data.
-     * - `"parquet"`: Load a Parquet file.
-     * - `"spatial"`: Load a spatial data file format via `ST_Read`.
-     */
-    type: 'csv';
-    /**
-     * The file path for the dataset to load.
-     */
-    file: string;
-    /**
-     * The column delimiter string. If not specified, DuckDB will try to infer
-     * the delimiter automatically.
-     */
-    delimiter?: string;
-    /**
-     * The sample size, in table rows, to consult for type inference.
-     * Set to `-1` to process all rows in the dataset.
-     */
-    sample_size?: number;
-}
-/**
- * A data definition that loads a supported spatial data file format.
- */
-export interface DataSpatial extends DataBaseOptions {
-    /**
-     * The data source type. One of:
-     * - `"table"`: Define a new table based on a SQL query.
-     * - `"csv"`: Load a comma-separated values (CSV) file.
-     * - `"json"`: Load JavaScript Object Notation (json) data.
-     * - `"parquet"`: Load a Parquet file.
-     * - `"spatial"`: Load a spatial data file format via `ST_Read`.
-     */
-    type: 'spatial';
-    /**
-     * The file path for the spatial dataset to load. See the [DuckDB spatial
-     * documention][1] for more information on supported file types.
-     *
-     * [1]: https://duckdb.org/docs/extensions/spatial.html#st_read--read-spatial-data-from-files
-     */
-    file: string;
-    /**
-     * The named layer to load from the file. For example, in a TopoJSON file
-     * the layer is the named object to extract. For Excel spreadsheet files,
-     * the layer is the name of the worksheet to extract.
-     */
-    layer?: string;
-}
-export interface DataJSON extends DataBaseOptions {
-    /**
-     * The data source type. One of:
-     * - `"table"`: Define a new table based on a SQL query.
-     * - `"csv"`: Load a comma-separated values (CSV) file.
-     * - `"json"`: Load JavaScript Object Notation (json) data.
-     * - `"parquet"`: Load a Parquet file.
-     * - `"spatial"`: Load a spatial data file format via `ST_Read`.
-     */
-    type: 'json';
-    /**
-     * The file path for the dataset to load.
-     */
-    file: string;
-}
-export interface DataJSONObjects extends DataBaseOptions {
-    /**
-     * The data source type. One of:
-     * - `"table"`: Define a new table based on a SQL query.
-     * - `"csv"`: Load a comma-separated values (CSV) file.
-     * - `"json"`: Load JavaScript Object Notation (json) data.
-     * - `"parquet"`: Load a Parquet file.
-     * - `"spatial"`: Load a spatial data file format via `ST_Read`.
-     */
-    type?: 'json';
-    /**
-     * An array of inline objects in JSON-style format.
-     */
-    data: object[];
-}
-export type DataDefinition = DataQuery | DataArray | DataFile | DataTable | DataParquet | DataCSV | DataSpatial | DataJSON | DataJSONObjects;

package/dist/types/spec/Expression.d.ts

@@ -1,27 +0,0 @@
-export type Expression = SQLExpression | AggregateExpression;
-/** A custom SQL expression. */
-export interface SQLExpression {
-    /**
-     * A SQL expression string to derive a new column value.
-     * Embedded Param refrences, such as `$param + 1`, are supported.
-     * For expressions with aggregate functions, use *agg* instead.
-     */
-    sql: string;
-    /**
-     * A label for this expression, for example to label a plot axis.
-     */
-    label?: string;
-}
-/** A custom SQL aggregate expression. */
-export interface AggregateExpression {
-    /**
-     * A SQL expression string to calculate an aggregate value.
-     * Embedded Param references, such as `SUM($param + 1)`, are supported.
-     * For expressions without aggregate functions, use *sql* instead.
-     */
-    agg: string;
-    /**
-     * A label for this expression, for example to label a plot axis.
-     */
-    label?: string;
-}

package/dist/types/spec/HConcat.d.ts

@@ -1,8 +0,0 @@
-import { Component } from './Spec.js';
-/** An hconcat component. */
-export interface HConcat {
-    /**
-     * Horizontally concatenate components in a row layout.
-     */
-    hconcat: Component[];
-}

package/dist/types/spec/HSpace.d.ts

@@ -1,9 +0,0 @@
-/** An hspace component. */
-export interface HSpace {
-    /**
-     * Horizontal space to place between components.
-     * Number values indicate screen pixels.
-     * String values may use CSS units (em, pt, px, etc).
-     */
-    hspace: number | string;
-}

package/dist/types/spec/Input.d.ts

@@ -1,212 +0,0 @@
-import { ParamRef } from './Param.js';
-/** A menu input component. */
-export interface Menu {
-    /**
-     * A menu input widget.
-     */
-    input: 'menu';
-    /**
-     * The output selection. A selection clause is added for the
-     * currently selected menu option.
-     */
-    as?: ParamRef;
-    /**
-     * The database column name to use within generated selection clause
-     * predicates. Defaults to the `column` property.
-     */
-    field?: string;
-    /**
-     * The name of a database table to use as a data source for this widget.
-     * Used in conjunction with the `column` property.
-     */
-    from?: string;
-    /**
-     * The name of a database column from which to pull menu options.
-     * The unique column values are used as menu options.
-     * Used in conjunction with the `from` property.
-     */
-    column?: string;
-    /**
-     * A selection to filter the database table indicated by the `from` property.
-     */
-    filterBy?: ParamRef;
-    /**
-     * A text label for this input.
-     */
-    label?: string;
-    /**
-     * An array of menu options, as literal values or option objects.
-     * Option objects have a `value` property and an optional `label` property.
-     * If no label is provided, the string-coerced value is used.
-     */
-    options?: Array<any | {
-        value: any;
-        label?: string;
-    }>;
-    /**
-     * The initial selected menu value.
-     */
-    value?: any;
-}
-/** A search input component. */
-export interface Search {
-    /**
-     * A text search input widget.
-     */
-    input: 'search';
-    /**
-     * The output selection. A selection clause is added for the
-     * current text search query.
-     */
-    as?: ParamRef;
-    /**
-     * The database column name to use within generated selection clause
-     * predicates. Defaults to the `column` property.
-     */
-    field?: string;
-    /**
-     * The type of text search query to perform. One of:
-     * - `"contains"` (default): the query string may appear anywhere in the text
-     * - `"prefix"`: the query string must appear at the start of the text
-     * - `"suffix"`: the query string must appear at the end of the text
-     * - `"regexp"`: the query string is a regular expression the text must match
-     */
-    type?: 'contains' | 'prefix' | 'suffix' | 'regexp';
-    /**
-     * The name of a database table to use as an autocomplete data source
-     * for this widget. Used in conjunction with the `column` property.
-     */
-    from?: string;
-    /**
-     * The name of a database column from which to pull valid search results.
-     * The unique column values are used as search autocomplete values.
-     * Used in conjunction with the `from` property.
-     */
-    column?: string;
-    /**
-     * A selection to filter the database table indicated by the `from` property.
-     */
-    filterBy?: ParamRef;
-    /**
-     * A text label for this input.
-     */
-    label?: string;
-}
-/** A slider input component. */
-export interface Slider {
-    /**
-     * A slider input widget.
-     */
-    input: 'slider';
-    /**
-     * The output selection. A selection clause is added for the
-     * currently selected slider option.
-     */
-    as?: ParamRef;
-    /**
-     * The database column name to use within generated selection clause
-     * predicates. Defaults to the `column` property.
-     */
-    field?: string;
-    /**
-     * The type of selection clause predicate to generate if the **as** option
-     * is a Selection. If `'point'` (the default), the selection predicate is an
-     * equality check for the slider value. If `'interval'`, the predicate checks
-     * an interval from the minimum to the current slider value.
-     */
-    select?: 'point' | 'interval';
-    /**
-     * The name of a database table to use as a data source for this widget.
-     * Used in conjunction with the `column` property.
-     * The minimum and maximum values of the column determine the slider range.
-     */
-    from?: string;
-    /**
-     * The name of a database column whose values determine the slider range.
-     * Used in conjunction with the `from` property.
-     * The minimum and maximum values of the column determine the slider range.
-     */
-    column?: string;
-    /**
-     * A selection to filter the database table indicated by the `from` property.
-     */
-    filterBy?: ParamRef;
-    /**
-     * The minumum slider value.
-     */
-    min?: number;
-    /**
-     * The maximum slider value.
-     */
-    max?: number;
-    /**
-     * The slider step, the amount to increment between consecutive values.
-     */
-    step?: number;
-    /**
-     * A text label for this input.
-     */
-    label?: string;
-    /**
-     * The initial slider value.
-     */
-    value?: number;
-    /**
-     * The width of the slider in screen pixels.
-     */
-    width?: number;
-}
-/** A table grid view component. */
-export interface Table {
-    /**
-     * A table grid widget.
-     */
-    input: 'table';
-    /**
-     * The output selection. A selection clause is added for each
-     * currently selected table row.
-     */
-    as?: ParamRef;
-    /**
-     * The name of a database table to use as a data source for this widget.
-     */
-    from: string | ParamRef;
-    /**
-     * A list of column names to include in the table grid.
-     * If unspecified, all table columns are included.
-     */
-    columns?: string[];
-    /**
-     * A selection to filter the database table indicated by the `from` property.
-     */
-    filterBy?: ParamRef;
-    /**
-     * An object of per-column alignment values.
-     * Column names should be object keys, which map to alignment values.
-     * Valid alignment values are: `"left"`, `"right"`, `"center"`, and `"justify"`.
-     * By default, numbers are right-aligned and other values are left-aligned.
-     */
-    align?: {
-        [column: string]: 'left' | 'right' | 'center' | 'justify';
-    };
-    /**
-     * If a number, sets the total width of the table widget, in pixels.
-     * If an object, provides per-column pixel width values.
-     * Column names should be object keys, mapped to numeric width values.
-     */
-    width?: number | {
-        [column: string]: number;
-    };
-    /**
-     * The maximum width of the table widget, in pixels.
-     */
-    maxWidth?: number;
-    /**
-     * The height of the table widget, in pixels.
-     */
-    height?: number;
-    /**
-     * The number of rows load in a new batch upon table scroll.
-     */
-    rowBatch?: number;
-}

package/dist/types/spec/Param.d.ts

@@ -1,63 +0,0 @@
-export type ParamRef = `$${string}`;
-/** Base properties shared by Param definitions. */
-export interface ParamBase {
-    /**
-     * The type of reactive parameter. One of:
-     * - `"value"` (default) for a standard `Param`
-     * - `"intersect"` for a `Selection` that intersects clauses (logical "and")
-     * - `"union"` for a `Selection` that unions clauses (logical "or")
-     * - `"single"` for a `Selection` that retains a single clause only
-     * - `"crossfilter"` for a cross-filtered intersection `Selection`
-     */
-    select?: 'value';
-}
-/** A Param definition. */
-export interface Param extends ParamBase {
-    /**
-     * The initial parameter value.
-     */
-    value: ParamValue;
-}
-/** A Date-valued Param definition. */
-export interface ParamDate extends ParamBase {
-    /**
-     * The initial parameter value as an ISO date/time
-     * string to be parsed to a Date object.
-     */
-    date: string;
-}
-/** Literal Param values. */
-export type ParamLiteral = null | string | number | boolean;
-/** Valid Param values. */
-export type ParamValue = ParamLiteral | Array<ParamLiteral | ParamRef>;
-/** A Selection definition. */
-export interface Selection {
-    /**
-     * The type of reactive parameter. One of:
-     * - `"value"` (default) for a standard `Param`
-     * - `"intersect"` for a `Selection` that intersects clauses (logical "and")
-     * - `"union"` for a `Selection` that unions clauses (logical "or")
-     * - `"single"` for a `Selection` that retains a single clause only
-     * - `"crossfilter"` for a cross-filtered intersection `Selection`
-     */
-    select: 'crossfilter' | 'intersect' | 'single' | 'union';
-    /**
-     * A flag for cross-filtering, where selections made in a plot filter others
-     * but not oneself (default `false`, except for `crossfilter` selections).
-     */
-    cross?: boolean;
-    /**
-     * A flag for setting an initial empty selection state. If true, a selection
-     * with no clauses corresponds to an empty selection with no records. If
-     * false, a selection with no clauses selects all values.
-     */
-    empty?: boolean;
-    /**
-     * Upstream selections whose clauses should be included as part of this
-     * selection. Any clauses or activations published to the upstream
-     * selections will be relayed to this selection.
-     */
-    include?: ParamRef | ParamRef[];
-}
-/** A Param or Selection definition. */
-export type ParamDefinition = ParamValue | Param | ParamDate | Selection;

package/dist/types/spec/Plot.d.ts

@@ -1,14 +0,0 @@
-import { PlotAttributes } from './PlotAttribute.js';
-import { PlotInteractor } from './PlotInteractor.js';
-import { PlotLegend } from './PlotLegend.js';
-import { PlotMark } from './PlotMark.js';
-/** A plot component. */
-export interface Plot extends PlotAttributes {
-    /**
-     * An array of plot marks, interactors, or legends.
-     * Marks are graphical elements that make up plot layers.
-     * Unless otherwise configured, interactors will use the nearest
-     * previous mark as a basis for which data fields to select.
-     */
-    plot: (PlotMark | PlotInteractor | PlotLegend)[];
-}