@uwdata/mosaic-core 0.17.0 → 0.18.0

package/dist/src/QueryManager.d.ts

@@ -0,0 +1,77 @@
+import type { Connector } from './connectors/Connector.js';
+import type { Cache, Logger, QueryEntry, QueryRequest } from './types.js';
+import { QueryResult } from './util/query-result.js';
+export declare const Priority: Readonly<{
+    High: 0;
+    Normal: 1;
+    Low: 2;
+}>;
+export declare class QueryManager {
+    private queue;
+    private db;
+    private clientCache;
+    private _logger;
+    private _logQueries;
+    private _consolidate;
+    /** Requests pending with the query manager. */
+    pendingResults: QueryResult[];
+    private maxConcurrentRequests;
+    private pendingExec;
+    constructor(maxConcurrentRequests?: number);
+    next(): void;
+    /**
+     * Add an entry to the query queue with a priority.
+     * @param entry The entry to add.
+     * @param priority The query priority, defaults to `Priority.Normal`.
+     */
+    enqueue(entry: QueryEntry, priority?: number): void;
+    /**
+     * Submit the query to the connector.
+     * @param request The request.
+     * @param result The query result.
+     */
+    submit(request: QueryRequest, result: QueryResult): Promise<void>;
+    /**
+     * Get or set the current query cache.
+     * @param value Cache value to set
+     * @returns Current cache
+     */
+    cache(): Cache | null;
+    cache(value: Cache | boolean): Cache;
+    /**
+     * Get or set the current logger.
+     * @param value Logger to set
+     * @returns Current logger
+     */
+    logger(): Logger;
+    logger(value: Logger): Logger;
+    /**
+     * Get or set if queries should be logged.
+     * @param value Whether to log queries
+     * @returns Current logging state
+     */
+    logQueries(): boolean;
+    logQueries(value: boolean): boolean;
+    /**
+     * Get or set the database connector.
+     * @param connector Connector to set
+     * @returns Current connector
+     */
+    connector(): Connector | null;
+    connector(connector: Connector): Connector;
+    /**
+     * Indicate if query consolidation should be performed.
+     * @param flag Whether to enable consolidation
+     */
+    consolidate(flag: boolean): void;
+    /**
+     * Request a query result.
+     * @param request The request.
+     * @param priority The query priority, defaults to `Priority.Normal`.
+     * @returns A query result promise.
+     */
+    request(request: QueryRequest, priority?: number): QueryResult;
+    cancel(requests: QueryResult[]): void;
+    clear(): void;
+}
+//# sourceMappingURL=QueryManager.d.ts.map

package/dist/src/QueryManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryManager.d.ts","sourceRoot":"","sources":["../../src/QueryManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI1E,OAAO,EAAE,WAAW,EAAc,MAAM,wBAAwB,CAAC;AAGjE,eAAO,MAAM,QAAQ;;;;EAAgD,CAAC;AAEtE,qBAAa,YAAY;IACvB,OAAO,CAAC,KAAK,CAA4B;IACzC,OAAO,CAAC,EAAE,CAAmB;IAC7B,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,YAAY,CAAyC;IAC7D,+CAA+C;IACxC,cAAc,EAAE,WAAW,EAAE,CAAC;IACrC,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,WAAW,CAAU;gBAEjB,qBAAqB,GAAE,MAAW;IAY9C,IAAI,IAAI,IAAI;IA4BZ;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,GAAE,MAAwB,GAAG,IAAI;IAKpE;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCvE;;;;OAIG;IACH,KAAK,IAAI,KAAK,GAAG,IAAI;IACrB,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,KAAK;IAOpC;;;;OAIG;IACH,MAAM,IAAI,MAAM;IAChB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAK7B;;;;OAIG;IACH,UAAU,IAAI,OAAO;IACrB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAKnC;;;;OAIG;IACH,SAAS,IAAI,SAAS,GAAG,IAAI;IAC7B,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS;IAK1C;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;IAQhC;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,GAAE,MAAwB,GAAG,WAAW;IAW/E,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI;IAmBrC,KAAK,IAAI,IAAI;CAWd"}

package/dist/src/QueryManager.js

@@ -0,0 +1,174 @@
+import { consolidator } from './QueryConsolidator.js';
+import { lruCache, voidCache } from './util/cache.js';
+import { PriorityQueue } from './util/priority-queue.js';
+import { QueryResult, QueryState } from './util/query-result.js';
+import { voidLogger } from './util/void-logger.js';
+export const Priority = Object.freeze({ High: 0, Normal: 1, Low: 2 });
+export class QueryManager {
+    queue;
+    db;
+    clientCache;
+    _logger;
+    _logQueries;
+    _consolidate;
+    /** Requests pending with the query manager. */
+    pendingResults;
+    maxConcurrentRequests;
+    pendingExec;
+    constructor(maxConcurrentRequests = 32) {
+        this.queue = new PriorityQueue(3);
+        this.db = null;
+        this.clientCache = null;
+        this._logger = voidLogger();
+        this._logQueries = false;
+        this._consolidate = null;
+        this.pendingResults = [];
+        this.maxConcurrentRequests = maxConcurrentRequests;
+        this.pendingExec = false;
+    }
+    next() {
+        if (this.queue.isEmpty() || this.pendingResults.length > this.maxConcurrentRequests || this.pendingExec) {
+            return;
+        }
+        const entry = this.queue.next();
+        if (!entry)
+            return;
+        const { request, result } = entry;
+        this.pendingResults.push(result);
+        if (request.type === 'exec')
+            this.pendingExec = true;
+        this.submit(request, result).finally(() => {
+            // return from the queue all requests that are ready
+            while (this.pendingResults.length && this.pendingResults[0].state !== QueryState.pending) {
+                const result = this.pendingResults.shift();
+                if (result.state === QueryState.ready) {
+                    result.fulfill();
+                }
+                else if (result.state === QueryState.done) {
+                    this._logger.warn('Found resolved query in pending results.');
+                }
+            }
+            if (request.type === 'exec')
+                this.pendingExec = false;
+            this.next();
+        });
+    }
+    /**
+     * Add an entry to the query queue with a priority.
+     * @param entry The entry to add.
+     * @param priority The query priority, defaults to `Priority.Normal`.
+     */
+    enqueue(entry, priority = Priority.Normal) {
+        this.queue.insert(entry, priority);
+        this.next();
+    }
+    /**
+     * Submit the query to the connector.
+     * @param request The request.
+     * @param result The query result.
+     */
+    async submit(request, result) {
+        try {
+            const { query, type, cache = false, options } = request;
+            const sql = query ? `${query}` : null;
+            // check query cache
+            if (cache) {
+                const cached = this.clientCache.get(sql);
+                if (cached) {
+                    const data = await cached;
+                    this._logger.debug('Cache');
+                    result.ready(data);
+                    return;
+                }
+            }
+            // issue query, potentially cache result
+            const t0 = performance.now();
+            if (this._logQueries) {
+                this._logger.debug('Query', { type, sql, ...options });
+            }
+            // @ts-expect-error type may be exec | json | arrow
+            const promise = this.db.query({ type, sql: sql, ...options });
+            if (cache)
+                this.clientCache.set(sql, promise);
+            const data = await promise;
+            if (cache)
+                this.clientCache.set(sql, data);
+            this._logger.debug(`Request: ${(performance.now() - t0).toFixed(1)}`);
+            result.ready(type === 'exec' ? null : data);
+        }
+        catch (err) {
+            result.reject(err);
+        }
+    }
+    cache(value) {
+        return value !== undefined
+            ? (this.clientCache = value === true ? lruCache() : (value || voidCache()))
+            : this.clientCache;
+    }
+    logger(value) {
+        return value ? (this._logger = value) : this._logger;
+    }
+    logQueries(value) {
+        return value !== undefined ? this._logQueries = !!value : this._logQueries;
+    }
+    connector(connector) {
+        return connector ? (this.db = connector) : this.db;
+    }
+    /**
+     * Indicate if query consolidation should be performed.
+     * @param flag Whether to enable consolidation
+     */
+    consolidate(flag) {
+        if (flag && !this._consolidate) {
+            this._consolidate = consolidator(this.enqueue.bind(this), this.clientCache);
+        }
+        else if (!flag && this._consolidate) {
+            this._consolidate = null;
+        }
+    }
+    /**
+     * Request a query result.
+     * @param request The request.
+     * @param priority The query priority, defaults to `Priority.Normal`.
+     * @returns A query result promise.
+     */
+    request(request, priority = Priority.Normal) {
+        const result = new QueryResult();
+        const entry = { request, result };
+        if (this._consolidate) {
+            this._consolidate.add(entry, priority);
+        }
+        else {
+            this.enqueue(entry, priority);
+        }
+        return result;
+    }
+    cancel(requests) {
+        const set = new Set(requests);
+        if (set.size) {
+            this.queue.remove(({ result }) => {
+                if (set.has(result)) {
+                    result.reject('Canceled');
+                    return true;
+                }
+                return false;
+            });
+            for (const result of this.pendingResults) {
+                if (set.has(result)) {
+                    result.reject('Canceled');
+                }
+            }
+        }
+    }
+    clear() {
+        this.queue.remove(({ result }) => {
+            result.reject('Cleared');
+            return true;
+        });
+        for (const result of this.pendingResults) {
+            result.reject('Cleared');
+        }
+        this.pendingResults = [];
+    }
+}
+//# sourceMappingURL=QueryManager.js.map

package/dist/src/QueryManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryManager.js","sourceRoot":"","sources":["../../src/QueryManager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAEtE,MAAM,OAAO,YAAY;IACf,KAAK,CAA4B;IACjC,EAAE,CAAmB;IACrB,WAAW,CAAe;IAC1B,OAAO,CAAS;IAChB,WAAW,CAAU;IACrB,YAAY,CAAyC;IAC7D,+CAA+C;IACxC,cAAc,CAAgB;IAC7B,qBAAqB,CAAS;IAC9B,WAAW,CAAU;IAE7B,YAAY,wBAAgC,EAAE;QAC5C,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,UAAU,EAAE,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACxG,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK;YAAE,OAAO;QAEnB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAElC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM;YAAE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACxC,oDAAoD;YACpD,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;gBACzF,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAG,CAAC;gBAC5C,IAAI,MAAM,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,EAAE,CAAC;oBACtC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,CAAC;qBAAM,IAAI,MAAM,CAAC,KAAK,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;oBAC5C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM;gBAAE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACtD,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAiB,EAAE,WAAmB,QAAQ,CAAC,MAAM;QAC3D,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,OAAqB,EAAE,MAAmB;QACrD,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;YACxD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAEtC,oBAAoB;YACpB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,MAAM,GAAG,IAAI,CAAC,WAAY,CAAC,GAAG,CAAC,GAAI,CAAC,CAAC;gBAC3C,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC;oBAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACnB,OAAO;gBACT,CAAC;YACH,CAAC;YAED,wCAAwC;YACxC,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YACzD,CAAC;YAED,mDAAmD;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,EAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,GAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YAChE,IAAI,KAAK;gBAAE,IAAI,CAAC,WAAY,CAAC,GAAG,CAAC,GAAI,EAAE,OAAO,CAAC,CAAC;YAEhD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC;YAE3B,IAAI,KAAK;gBAAE,IAAI,CAAC,WAAY,CAAC,GAAG,CAAC,GAAI,EAAE,IAAI,CAAC,CAAC;YAE7C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACtE,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IASD,KAAK,CAAC,KAAuB;QAC3B,OAAO,KAAK,KAAK,SAAS;YACxB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IACvB,CAAC;IASD,MAAM,CAAC,KAAc;QACnB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACvD,CAAC;IASD,UAAU,CAAC,KAAe;QACxB,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC7E,CAAC;IASD,SAAS,CAAC,SAAqB;QAC7B,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,IAAa;QACvB,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAY,CAAC,CAAC;QAC/E,CAAC;aAAM,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,OAAqB,EAAE,WAAmB,QAAQ,CAAC,MAAM;QAC/D,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAClC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,QAAuB;QAC5B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACb,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC/B,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBACpB,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,CAAC;YAEH,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzC,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBACpB,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;CACF"}

package/dist/src/Selection.d.ts

@@ -0,0 +1,222 @@
+import { type MosaicClient } from './MosaicClient.js';
+import { type ExprNode, MaybeArray } from '@uwdata/mosaic-sql';
+import { Param } from './Param.js';
+import { ClauseSource, SelectionClause } from './SelectionClause.js';
+export interface SelectionOptions {
+    /** Boolean flag indicating cross-filtered resolution. If true, selection clauses will not be applied to the clients they are associated with. */
+    cross?: boolean;
+    /** Boolean flag indicating if a lack of clauses should correspond to an empty selection with no records. This setting determines the default selection state. */
+    empty?: boolean;
+    /** Upstream selections whose clauses should be included as part of the new selection. Any clauses published to upstream selections will be relayed to the new selection. */
+    include?: Selection | Selection[];
+}
+export interface SelectionResolverOptions extends Pick<SelectionOptions, "empty" | "cross"> {
+    /** Boolean flag to indicate a union strategy. If false, an intersection strategy is used. */
+    union?: boolean;
+    /** Boolean flag to indicate single clauses only. */
+    single?: boolean;
+}
+/**
+ * Test if a value is a Selection instance.
+ * @param x The value to test.
+ * @returns True if the input is a Selection, false otherwise.
+ */
+export declare function isSelection(x: unknown): x is Selection;
+type SelectionClauseArray = SelectionClause[] & {
+    active?: SelectionClause;
+};
+type ResolvedPredicate = MaybeArray<string | boolean | ExprNode> | undefined;
+/**
+ * Represents a dynamic set of query filter predicates.
+ */
+export declare class Selection extends Param<SelectionClauseArray> {
+    _resolved: SelectionClauseArray;
+    _resolver: SelectionResolver;
+    _relay: Set<Selection>;
+    /**
+     * Create a new Selection instance with an
+     * intersect (conjunction) resolution strategy.
+     * @param options The selection options.
+     * @returns The new Selection instance.
+     */
+    static intersect({ cross, empty, include }?: SelectionOptions): Selection;
+    /**
+     * Create a new Selection instance with a
+     * union (disjunction) resolution strategy.
+     * @param options The selection options.
+     * @returns The new Selection instance.
+     */
+    static union({ cross, empty, include }?: SelectionOptions): Selection;
+    /**
+     * Create a new Selection instance with a singular resolution strategy
+     * that keeps only the most recent selection clause.
+     * @param options The selection options.
+     * @returns The new Selection instance.
+     */
+    static single({ cross, empty, include }?: SelectionOptions): Selection;
+    /**
+     * Create a new Selection instance with a
+     * cross-filtered intersect resolution strategy.
+     * @param options The selection options.
+     * @returns The new Selection instance.
+     */
+    static crossfilter({ empty, include }?: Omit<SelectionOptions, 'cross'>): Selection;
+    /**
+     * Create a new Selection instance.
+     * @param resolver The selection resolution
+     *  strategy to apply.
+     * @param include Upstream selections whose clauses
+     * should be included as part of this selection. Any clauses published
+     * to these upstream selections will be relayed to this selection.
+     */
+    constructor(resolver?: SelectionResolver, include?: Selection[]);
+    /**
+     * Create a cloned copy of this Selection instance.
+     * @returns A clone of this selection.
+     */
+    clone(): Selection;
+    /**
+     * Create a clone of this Selection with clauses corresponding
+     * to the provided source removed.
+     * @param source The clause source to remove.
+     * @returns A cloned and updated Selection.
+     */
+    remove(source: ClauseSource): Selection;
+    /**
+     * The selection clause resolver.
+     */
+    get resolver(): SelectionResolver;
+    /**
+     * Indicate if this selection has a single resolution strategy.
+     */
+    get single(): boolean;
+    /**
+     * The current array of selection clauses.
+     */
+    get clauses(): SelectionClauseArray;
+    /**
+     * The current active (most recently updated) selection clause.
+     */
+    get active(): SelectionClause;
+    /**
+     * The value corresponding to the current active selection clause.
+     * This method ensures compatibility where a normal Param is expected.
+     */
+    get value(): unknown;
+    /**
+     * The value corresponding to a given source. Returns undefined if
+     * this selection does not include a clause from this source.
+     * @param source The clause source to look up the value for.
+     */
+    valueFor(source: unknown): unknown;
+    /**
+     * Emit an activate event with the given selection clause.
+     * @param clause The clause representing the potential activation.
+     */
+    activate(clause: SelectionClause): void;
+    /**
+     * Update the selection with a new selection clause.
+     * @param clause The selection clause to add.
+     * @returns This Selection instance.
+     */
+    update(clause: SelectionClause): this;
+    /**
+     * Reset the selection state by removing all provided clauses. If no clause
+     * array is provided as an argument, all current clauses are removed. The
+     * reset method (if defined) is invoked on all corresponding clause sources.
+     * The reset is relayed to downstream selections that include this selection.
+     * @param clauses The clauses to remove. If unspecified, all current clauses are removed.
+     * @returns This selection instance.
+     */
+    reset(clauses?: SelectionClause[]): this;
+    /**
+     * Upon value-typed updates, sets the current clause list to the
+     * input value and returns the active clause value.
+     * @param type The event type.
+     * @param value The input event value.
+     * @returns For value-typed events, returns the active clause
+     *  values. Otherwise returns the input event value as-is.
+     */
+    willEmit(type: string, value: unknown): unknown;
+    /**
+     * Upon value-typed updates, returns a dispatch queue filter function.
+     * The return value depends on the selection resolution strategy.
+     * @param type The event type.
+     * @param value The new event value that will be enqueued.
+     * @returns A dispatch queue filter function. For non-value events,
+     *  returns a function that always returns null (no filtering).
+     */
+    emitQueueFilter(type: string, value: SelectionClauseArray): ((value: SelectionClauseArray) => boolean) | null;
+    /**
+     * Indicates if a selection clause should not be applied to a given client.
+     * The return value depends on the selection resolution strategy.
+     * @param client The client to test.
+     * @param clause The selection clause.
+     * @returns True if the client should be skipped, false otherwise.
+     */
+    skip(client: MosaicClient, clause: SelectionClause): boolean;
+    /**
+     * Return a selection query predicate for the given client.
+     * @param client The client whose data may be filtered.
+     * @param noSkip Disable skipping of active
+     *  cross-filtered sources. If set true, the source of the active
+     *  clause in a cross-filtered selection will not be skipped.
+     * @returns The query predicate for filtering client data,
+     *  based on the current state of this selection.
+     */
+    predicate(client: MosaicClient, noSkip?: boolean): ResolvedPredicate;
+}
+/**
+ * Implements selection clause resolution strategies.
+ */
+export declare class SelectionResolver {
+    union: boolean;
+    cross: boolean;
+    single: boolean;
+    empty: boolean;
+    /**
+     * Create a new selection resolved instance.
+     * @param options The resolution strategy options.
+     * @param options.union Boolean flag to indicate a union strategy.
+     *  If false, an intersection strategy is used.
+     * @param options.cross Boolean flag to indicate cross-filtering.
+     * @param options.single Boolean flag to indicate single clauses only.
+     * @param options.empty Boolean flag indicating if a lack
+     *  of clauses should correspond to an empty selection with no records. This
+     *  setting determines the default selection state.
+     */
+    constructor({ union, cross, single, empty }?: SelectionResolverOptions);
+    /**
+     * Resolve a list of selection clauses according to the resolution strategy.
+     * @param clauseList An array of selection clauses.
+     * @param clause A new selection clause to add.
+     * @returns An updated array of selection clauses.
+     */
+    resolve(clauseList: SelectionClause[], clause: SelectionClause, reset?: boolean): SelectionClause[];
+    /**
+     * Indicates if a selection clause should not be applied to a given client.
+     * The return value depends on the resolution strategy.
+     * @param client The selection clause.
+     * @param clause The client to test.
+     * @returns True if the client should be skipped, false otherwise.
+     */
+    skip(client: MosaicClient, clause: SelectionClause): boolean;
+    /**
+     * Return a selection query predicate for the given client.
+     * @param clauseList An array of selection clauses.
+     * @param active The current active selection clause.
+     * @param client The client whose data may be filtered.
+     * @returns The query predicate for filtering client data,
+     *  based on the current state of this selection.
+     */
+    predicate(clauseList: SelectionClause[], active: SelectionClause, client: MosaicClient): ResolvedPredicate;
+    /**
+     * Returns a filter function for queued selection updates.
+     * @param value The new event value that will be enqueued.
+     * @returns A dispatch queue filter
+     *  function, or null if all unemitted event values should be filtered.
+     */
+    queueFilter(value: SelectionClauseArray): ((value: SelectionClauseArray) => boolean) | null;
+}
+export {};
+//# sourceMappingURL=Selection.d.ts.map

package/dist/src/Selection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Selection.d.ts","sourceRoot":"","sources":["../../src/Selection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,KAAK,QAAQ,EAAuB,UAAU,EAAM,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAErE,MAAM,WAAW,gBAAgB;IAC/B,iJAAiJ;IACjJ,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,iKAAiK;IACjK,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4KAA4K;IAC5K,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,wBAAyB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC;IACzF,6FAA6F;IAC7F,KAAK,CAAC,EAAE,OAAO,CAAC;IACd,oDAAoD;IACtD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAEtD;AASD,KAAK,oBAAoB,GAAG,eAAe,EAAE,GAAG;IAAE,MAAM,CAAC,EAAE,eAAe,CAAA;CAAE,CAAC;AAC7E,KAAK,iBAAiB,GAAG,UAAU,CAAC,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC,GAAG,SAAS,CAAC;AAE7E;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK,CAAC,oBAAoB,CAAC;IACxD,SAAS,EAAE,oBAAoB,CAAC;IAChC,SAAS,EAAE,iBAAiB,CAAC;IAC7B,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,KAAa,EAAE,KAAa,EAAE,OAAY,EAAE,GAAE,gBAAqB,GAAG,SAAS;IAIlG;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,KAAa,EAAE,KAAa,EAAE,OAAY,EAAE,GAAE,gBAAqB,GAAG,SAAS;IAI9F;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,EAAE,KAAa,EAAE,KAAa,EAAE,OAAY,EAAE,GAAE,gBAAqB,GAAG,SAAS;IAI/F;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,KAAa,EAAE,OAAY,EAAE,GAAE,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAM,GAAG,SAAS;IAIpG;;;;;;;OAOG;gBACS,QAAQ,oBAA0B,EAAE,OAAO,GAAE,SAAS,EAAO;IAYzE;;;OAGG;IACH,KAAK,IAAI,SAAS;IAMlB;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS;IAUvC;;OAEG;IACH,IAAI,QAAQ,IAAI,iBAAiB,CAEhC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,oBAAoB,CAElC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,eAAe,CAE5B;IAED;;;OAGG;IAEH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO;IAIlC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAMvC;;;;OAIG;IAEH,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IASrC;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI;IAQxC;;;;;;;OAOG;IAEH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO;IAQ/C;;;;;;;OAOG;IAEH,eAAe,CACb,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,oBAAoB,GAC1B,CAAC,CAAC,KAAK,EAAE,oBAAoB,KAAK,OAAO,CAAC,GAAG,IAAI;IAMpD;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO;IAI5D;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,GAAE,OAAe,GAAG,iBAAiB;CAK5E;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IAEf;;;;;;;;;;OAUG;gBACS,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAE,wBAA6B;IAO1E;;;;;OAKG;IACH,OAAO,CACL,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,GAAE,OAAe,GACrB,eAAe,EAAE;IASpB;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO;IAI5D;;;;;;;OAOG;IACH,SAAS,CACP,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,YAAY,GACnB,iBAAiB;IAoBpB;;;;;OAKG;IACH,WAAW,CACT,KAAK,EAAE,oBAAoB,GAC1B,CAAC,CAAC,KAAK,EAAE,oBAAoB,KAAK,OAAO,CAAC,GAAG,IAAI;CAOrD"}