@uwdata/mosaic-core 0.16.2 → 0.18.0

package/dist/types/make-client.d.ts

@@ -1,78 +0,0 @@
-/**
- * @typedef {Object} MakeClientOptions
- * @property {Coordinator} [coordinator] Mosaic coordinator.
- *  Defaults to the global coordinator.
- * @property {Selection|null} [selection] A selection whose predicates are
- *  fed into the query function to produce the SQL query.
- * @property {boolean} [enabled] A flag (default `true`) indicating if the
- *  client should initially be enabled or not.
- * @property {boolean} [filterStable] A flag (default `true`) indicating if the
- *  if client queries can be sped up using pre-aggregated data. Should be set
- *  to `false` if filtering changes the groupby domain of the query.
- * @property {function(): Promise<void>} [prepare]
- *  An async function to prepare the client before running queries.
- * @property {function(any): any} [query]
- *  A function that returns a query from a list of selection predicates.
- * @property {function(any): void} [queryResult]
- *  Called by the coordinator to return a query result.
- * @property {function(): void} [queryPending]
- *  Called by the coordinator to report a query execution error.
- * @property {function(any): void} [queryError]
- *  Called by the coordinator to inform the client that a query is pending.
- */
-/**
- * Make a new client with the given options, and connect the client to the
- * provided coordinator.
- * @param {MakeClientOptions} options The options for making the client.
- * @returns {MosaicClient & { destroy: () => void }} The resulting client,
- *  along with a method to destroy the client when no longer needed.
- */
-export function makeClient(options: MakeClientOptions): MosaicClient & {
-    destroy: () => void;
-};
-export type MakeClientOptions = {
-    /**
-     * Mosaic coordinator.
-     * Defaults to the global coordinator.
-     */
-    coordinator?: Coordinator;
-    /**
-     * A selection whose predicates are
-     * fed into the query function to produce the SQL query.
-     */
-    selection?: Selection | null;
-    /**
-     * A flag (default `true`) indicating if the
-     * client should initially be enabled or not.
-     */
-    enabled?: boolean;
-    /**
-     * A flag (default `true`) indicating if the
-     * if client queries can be sped up using pre-aggregated data. Should be set
-     * to `false` if filtering changes the groupby domain of the query.
-     */
-    filterStable?: boolean;
-    /**
-     * An async function to prepare the client before running queries.
-     */
-    prepare?: () => Promise<void>;
-    /**
-     * A function that returns a query from a list of selection predicates.
-     */
-    query?: (arg0: any) => any;
-    /**
-     * Called by the coordinator to return a query result.
-     */
-    queryResult?: (arg0: any) => void;
-    /**
-     * Called by the coordinator to report a query execution error.
-     */
-    queryPending?: () => void;
-    /**
-     * Called by the coordinator to inform the client that a query is pending.
-     */
-    queryError?: (arg0: any) => void;
-};
-import { MosaicClient } from './MosaicClient.js';
-import type { Coordinator } from './Coordinator.js';
-import type { Selection } from './Selection.js';

package/dist/types/preagg/sufficient-statistics.d.ts

@@ -1,13 +0,0 @@
-/**
- * Determine sufficient statistics to preaggregate the given node. This
- * method populates the *preagg* and *aggrs* arguments with necessary
- * information for preaggregation optimization.
- * @param {AggregateNode} node An aggregate function.
- * @param {Record<string, ExprNode>} preagg Map of column names to
- *  expressions to include in the preaggregation table.
- * @returns {ExprNode} Output aggregate expression that uses preaggregated
- *  sufficient statistics to service updates.
- */
-export function sufficientStatistics(node: AggregateNode, preagg: Record<string, ExprNode>, avg: any): ExprNode;
-import type { AggregateNode } from '@uwdata/mosaic-sql';
-import type { ExprNode } from '@uwdata/mosaic-sql';

package/dist/types/util/cache.d.ts

@@ -1,17 +0,0 @@
-/**
- * Create a new cache that ignores all values.
- * @returns {Cache}
- */
-export function voidCache(): Cache;
-/**
- * Create a new cache that uses an LRU eviction policy.
- * @param {object} [options] Cache options.
- * @param {number} [options.max] Maximum number of cache entries.
- * @param {number} [options.ttl] Time-to-live for cache entries.
- * @returns {Cache}
- */
-export function lruCache({ max, ttl }?: {
-    max?: number;
-    ttl?: number;
-}): Cache;
-import type { Cache } from '../types.js';

package/dist/types/util/decode-ipc.d.ts

@@ -1,12 +0,0 @@
-/**
- * Decode Arrow IPC bytes to a table instance.
- * The default options map date and timestamp values to JS Date objects.
- * @param {ArrayBuffer | Uint8Array} data Arrow IPC bytes.
- * @param {ExtractionOptions} [options] Arrow IPC extraction options.
- *  If unspecified, the default options will extract date and timestamp
- *  values to JS Date objects.
- * @returns {Table} A table instance.
- */
-export function decodeIPC(data: ArrayBuffer | Uint8Array, options?: ExtractionOptions): Table;
-import type { ExtractionOptions } from '@uwdata/flechette';
-import type { Table } from '@uwdata/flechette';

package/dist/types/util/distinct.d.ts

@@ -1,2 +0,0 @@
-export function distinct(a: any, b: any): boolean;
-export function distinctArray(a: any, b: any): boolean;

package/dist/types/util/field-info.d.ts

@@ -1,23 +0,0 @@
-/**
- * Queries information about fields of a table.
- * If the `fields` array contains a single field with the column set to '*',
- * the function will retrieve and return the table information using `getTableInfo`.
- * Otherwise, it will query individual field information using `getFieldInfo`
- * for each field in the `fields` array.
- * @param {import('../Coordinator.js').Coordinator} mc A Mosaic coordinator.
- * @param {import('../types.js').FieldInfoRequest[]} fields
- * @returns {Promise<import('../types.js').FieldInfo[]>}
- */
-export function queryFieldInfo(mc: import("../Coordinator.js").Coordinator, fields: import("../types.js").FieldInfoRequest[]): Promise<import("../types.js").FieldInfo[]>;
-export const Count: "count";
-export const Nulls: "nulls";
-export const Max: "max";
-export const Min: "min";
-export const Distinct: "distinct";
-export namespace Stats {
-    export { Count };
-    export { Nulls };
-    export { Max };
-    export { Min };
-    export { Distinct };
-}

package/dist/types/util/hash.d.ts

@@ -1 +0,0 @@
-export function fnv_hash(v: any): number;

package/dist/types/util/is-activatable.d.ts

@@ -1,6 +0,0 @@
-/**
- * Test if a value implements the Activatable interface.
- * @param {*} value The value to test.
- * @returns {value is import('../types.js').Activatable}
- */
-export function isActivatable(value: any): value is import("../types.js").Activatable;

package/dist/types/util/is-arrow-table.d.ts

@@ -1,8 +0,0 @@
-/**
- * Test if a value is a Flechette Arrow table.
- * We use a "duck typing" approach and check for a getChild function.
- * @param {*} values The value to test
- * @returns {values is import('@uwdata/flechette').Table}
- *  true if the value duck types as Arrow data
- */
-export function isArrowTable(values: any): values is import("@uwdata/flechette").Table;

package/dist/types/util/js-type.d.ts

@@ -1,7 +0,0 @@
-/**
- * Maps a SQL data type to its corresponding JavaScript type.
- * @param {string} type The name of a SQL data type
- * @returns {import('../types.js').JSType} The corresponding JavaScript type name
- * @throws {Error} Throws an error if the given SQL type name is unsupported or unrecognized.
- */
-export function jsType(type: string): import("../types.js").JSType;

package/dist/types/util/query-result.d.ts

@@ -1,44 +0,0 @@
-export const QueryState: Readonly<{
-    pending: symbol;
-    ready: symbol;
-    error: symbol;
-    done: symbol;
-}>;
-/**
- * A query result Promise that can allows external callers
- * to resolve or reject the Promise.
- */
-export class QueryResult extends Promise<any> {
-    /**
-     * Create a new query result Promise.
-     */
-    constructor();
-    _resolve: any;
-    _reject: any;
-    _state: symbol;
-    _value: any;
-    /**
-     * Resolve the result Promise with a prepared value or the provided value.
-     * This method will only succeed if either a value is provided or the promise is ready.
-     * @param {*} value The result value.
-     * @returns {this}
-     */
-    fulfill(value: any): this;
-    /**
-     * Prepare to resolve with the provided value.
-     * @param {*} value The result value.
-     * @returns {this}
-     */
-    ready(value: any): this;
-    /**
-     * Rejects the result Promise with the provided error.
-     * @param {*} error The error value.
-     * @returns {this}
-     */
-    reject(error: any): this;
-    /**
-     * Returns the state of this query result.
-     * @returns {symbol}
-     */
-    get state(): symbol;
-}

package/dist/types/util/selection-types.d.ts

@@ -1,114 +0,0 @@
-import { ExprNode } from '@uwdata/mosaic-sql';
-import { MosaicClient } from '../MosaicClient.js';
-/**
- * Selection clause metadata to guide possible query optimizations.
- * Sub-interfaces provide more information about the specifics of a
- * given selection based on the selection type.
- */
-export interface ClauseMetadata {
-    /**
-     * The selection type, such as `'point'`, `'interval'`, or `'match'`.
-     */
-    type: string;
-}
-/**
- * Selection clause metadata indicating selection of one or more discrete
- * point values, typically based on equality or is distinctiveness checks.
- */
-export interface PointMetadata extends ClauseMetadata {
-    type: 'point';
-}
-/** Text search matching methods. */
-export type MatchMethod = 'contains' | 'prefix' | 'suffix' | 'regexp' | (string & {});
-/**
- * Selection clause metadata indicating text search matching.
- */
-export interface MatchMetadata extends ClauseMetadata {
-    type: MatchMethod;
-    /** The text search matching method used. */
-    method?: 'contains' | 'prefix' | 'suffix' | 'regexp' | (string & {});
-}
-/** Quantitative scale types. */
-export type ScaleType = 'identity' | 'linear' | 'log' | 'sqrt' | 'pow' | 'symlog' | 'time' | 'utc';
-/** A data value interval extent. */
-export type Extent = [number, number] | [Date, Date];
-/**
- * Descriptor for a scale that maps a data domain to screen pixels.
- */
-export interface Scale {
-    /** The scale type, such as `'linear'`, `'log'`, etc. */
-    type: ScaleType;
-    /** The scale domain, as an array of start and end data values. */
-    domain: Extent;
-    /**
-     * The scale range, as an array of start and end screen pixels.
-     * The range may be omitted for *identity* scales.
-     */
-    range?: [number, number];
-    /** The base of the logarithm. For `'log'` scales only. */
-    base?: number;
-    /** The constant parameter. For `'symlog'` scales only. */
-    constant?: number;
-    /** The exponent parameter. For `'pow'` scales only. */
-    exponent?: number;
-}
-/** A binning method name. */
-export type BinMethod = 'floor' | 'ceil' | 'round';
-/**
- * Selection clause metadata for one or more selected intervals. This
- * metadata can be used to determine appropriate data-space binning
- * schemes that correspond to pixel-level bins in screen space.
- */
-export interface IntervalMetadata extends ClauseMetadata {
-    type: 'interval';
-    /**
-     * The interactive pixel size used by the generating component.
-     * Values larger than one indicate intervals that "snap-to" values
-     * greater than a single pixel. If unspecified, assumed to be `1`.
-     */
-    pixelSize?: number;
-    /**
-     * An array of one or more scale descriptors that describe the
-     * mapping from data values to screen pixels.
-     */
-    scales?: Scale[];
-    /**
-     * A hint for the binning method to use when discretizing the
-     * interval domain. If unspecified, the default is `'floor'`.
-     */
-    bin?: BinMethod;
-}
-/**
- * A selection clause representing filtering criteria
- * to apply within a Mosiac Selection.
- */
-export interface SelectionClause {
-    /**
-     * A unique identifier (according to object equality) for the source
-     * component that generated this clause. In many cases, this is a
-     * reference to the originating component itself.
-     */
-    source: any;
-    /**
-     * A set of Mosaic clients associated with this clause that should not
-     * be updated when this clause is applied in a cross-filtering context.
-     */
-    clients?: Set<MosaicClient>;
-    /**
-     * A selected value associated with this clause. For example, for a 1D
-     * interval selection clause the value may be a [lo, hi] array.
-     */
-    value: any;
-    /**
-     * A predicate SQL expression suitable for use in a query WHERE clause.
-     * The predicate should apply filtering criteria consistent with this
-     * clause's *value* property.
-     */
-    predicate: ExprNode | null;
-    /**
-     * Optional clause metadata that varies based on the selection type.
-     * The metadata can be used to optimize selection queries, for example
-     * by creating materialized views of pre-aggregated data when applicable.
-     */
-    meta?: ClauseMetadata;
-}

package/dist/types/util/synchronizer.d.ts

@@ -1,29 +0,0 @@
-/**
- * Create a new synchronizer instance to aid synchronization
- * of updates on multiple pending operations.
- */
-export function synchronizer(): {
-    /**
-     * Mark an item as pending.
-     * @param {*} item An item to synchronize on.
-     */
-    pending(item: any): void;
-    /**
-     * Mark a pending item as ready, indicating it is
-     * ready for a synchronized update.
-     * @param {*} item An item to synchronize on.
-     * @returns {boolean} True if the synchronizer is ready to
-     *  resolve, false otherwise.
-     */
-    ready(item: any): boolean;
-    /**
-     * Resolve the current synchronization cycle, causing the synchronize
-     * promise to resolve and thereby trigger downstream updates.
-     */
-    resolve(): void;
-    /**
-     * The promise for the current synchronization cycle.
-     * @return {Promise} The synchronization promise.
-     */
-    readonly promise: Promise<any>;
-};

package/dist/types/util/throttle.d.ts

@@ -1,13 +0,0 @@
-/**
- * Throttle invocations of a callback function. The callback must return
- * a Promise. Upon repeated invocation, the callback will not be invoked
- * until a prior Promise resolves. If multiple invocations occurs while
- * waiting, only the most recent invocation will be pending.
- * @template E, T
- * @param {(event: E) => Promise<T>} callback The callback function.
- * @param {boolean} [debounce=true] Flag indicating if invocations
- *  should also be debounced within the current animation frame.
- * @returns {(event: E) => void} A new function that throttles
- *  access to the callback.
- */
-export function throttle<E, T>(callback: (event: E) => Promise<T>, debounce?: boolean): (event: E) => void;

package/dist/types/util/to-data-columns.d.ts

@@ -1,29 +0,0 @@
-/**
- * @typedef {Array | Int8Array | Uint8Array | Uint8ClampedArray
- *  | Int16Array | Uint16Array | Int32Array | Uint32Array
- *  | Float32Array | Float64Array
- * } Arrayish - an Array or TypedArray
- */
-/**
- * @typedef {
- *  | { numRows: number, columns: Record<string,Arrayish> }
- *  | { numRows: number, values: Arrayish; }
- * } DataColumns
-*/
-/**
- * Convert input data to a set of column arrays.
- * @param {any} data The input data.
- * @returns {DataColumns} An object with named column arrays.
- */
-export function toDataColumns(data: any): DataColumns;
-/**
- * - an Array or TypedArray
- */
-export type Arrayish = any[] | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
-export type DataColumns = any | {
-    numRows: number;
-    columns: Record<string, Arrayish>;
-} | {
-    numRows: number;
-    values: Arrayish;
-};

package/dist/types/util/void-logger.d.ts

@@ -1,10 +0,0 @@
-export function voidLogger(): {
-    debug(..._: any[]): void;
-    info(..._: any[]): void;
-    log(..._: any[]): void;
-    warn(..._: any[]): void;
-    error(..._: any[]): void;
-    group(label: any): void;
-    groupCollapsed(label: any): void;
-    groupEnd(): void;
-};

package/jsconfig.json

@@ -1,11 +0,0 @@
-{
-  "include": ["src/**/*"],
-  "compilerOptions": {
-    "checkJs": true,
-    "noEmit": true,
-    "noImplicitAny": false,
-    "module": "node16",
-    "skipLibCheck": true,
-    "types": []
-  }
-}