@adaptabletools/adaptable 23.1.0-canary.2 → 24.0.0-canary.0

package/vendor/aql/types.js

@@ -0,0 +1,57 @@
+/**
+ * Recommended `category` values for Expression Functions — especially custom
+ * ones registered via `expressionOptions.customStandardFunctions`.
+ *
+ * Prefer these (TypeScript autocompletes them) so functions land in the matching
+ * Expression Editor menu. Any other string is allowed and becomes its own menu.
+ *
+ * - `logical` / `conditional` → Logical
+ * - `text` / `numeric` / `date` → same-named menus
+ * - `general` / `comparison` → General
+ * - `custom` (or omit `category`) → Custom
+ */
+export const EXPRESSION_CATEGORIES = [
+    'logical',
+    'comparison',
+    'text',
+    'numeric',
+    'date',
+    'conditional',
+    'general',
+    'observable',
+    'custom',
+];
+/**
+ * Allowed `returnType` values for Expression Functions.
+ * Prefer these literals (TypeScript autocompletes them).
+ *
+ * - `boolean` — predicate (filters, alerts, WHERE clauses, …)
+ * - `number` / `string` / `date` / `object` — typed scalar results
+ * - `null` — nullish sentinel (e.g. `NULL`)
+ * - `any` — untyped / polymorphic (e.g. `COL`, `IF`)
+ */
+export const EXPRESSION_RETURN_TYPES = [
+    'boolean',
+    'number',
+    'string',
+    'date',
+    'object',
+    'null',
+    'any',
+];
+export const isAST_Function = (node) => {
+    return (typeof node?.type === 'string' && Array.isArray(node?.args));
+};
+/**
+ * Column id when the arg was a direct `[col]` / `COL("col")` reference,
+ * otherwise `undefined` (e.g. literals or computed args like
+ * `LOWER([make])`). Use with `context.argNodes` from an expression-function
+ * handler to recover subject provenance / fetch raw cell values.
+ */
+export const getExpressionArgColumnId = (argNode) => argNode != null &&
+    isAST_Function(argNode) &&
+    argNode.type === 'COL' &&
+    typeof argNode.args?.[0] === 'string'
+    ? argNode.args[0]
+    : undefined;
+//# sourceMappingURL=types.js.map

package/vendor/aql/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAsMA;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,SAAS;IACT,YAAY;IACZ,MAAM;IACN,SAAS;IACT,MAAM;IACN,aAAa;IACb,SAAS;IACT,YAAY;IACZ,QAAQ;CACA,CAAC;AAUX;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,MAAM;IACN,KAAK;CACG,CAAC;AAqJX,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAoB,EAAwB,EAAE;IAC3E,OAAO,CACL,OAAQ,IAAqB,EAAE,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAE,IAAqB,EAAE,IAAI,CAAC,CAChG,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,OAAmC,EACf,EAAE,CACtB,OAAO,IAAI,IAAI;IACf,cAAc,CAAC,OAAO,CAAC;IACvB,OAAO,CAAC,IAAI,KAAK,KAAK;IACtB,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,QAAQ;IACnC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjB,CAAC,CAAC,SAAS,CAAC"}

package/vendor/aql/utils/astUtils.d.ts

@@ -0,0 +1,5 @@
+import { AST_Function, Token } from '../types';
+export declare function getCurrentToken(tokens: Token[], offset: number): Token | undefined;
+export declare function walker(node: unknown, callback: (node: any) => void): unknown;
+export declare function findPathTo(node: unknown, offset: number | null): AST_Function[];
+//# sourceMappingURL=astUtils.d.ts.map

package/vendor/aql/utils/astUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"astUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/astUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAE/C,wBAAgB,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,qBAK9D;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAoB5E;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,EAAE,CAY/E"}

package/vendor/aql/utils/astUtils.js

@@ -0,0 +1,33 @@
+export function getCurrentToken(tokens, offset) {
+    return (tokens.find(({ range }) => range[0] <= offset && range[1] > offset) ||
+        tokens.find(({ range }) => range[1] == offset));
+}
+export function walker(node, callback) {
+    if (node == undefined ||
+        typeof node === 'boolean' ||
+        typeof node === 'number' ||
+        typeof node === 'string') {
+        return;
+    }
+    if (Array.isArray(node)) {
+        return node.map((n) => walker(n, callback));
+    }
+    // isObject
+    const obj = node;
+    if (obj.args) {
+        obj.args.map((n) => walker(n, callback));
+        callback(node);
+    }
+}
+export function findPathTo(node, offset) {
+    const path = [];
+    if (offset === null)
+        return path;
+    walker(node, (n) => {
+        if (n.range[0] <= offset && n.range[1] >= offset) {
+            path.push(n);
+        }
+    });
+    return path;
+}
+//# sourceMappingURL=astUtils.js.map

package/vendor/aql/utils/astUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"astUtils.js","sourceRoot":"","sources":["../../../src/utils/astUtils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,eAAe,CAAC,MAAe,EAAE,MAAc;IAC7D,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,IAAa,EAAE,QAA6B;IACjE,IACE,IAAI,IAAI,SAAS;QACjB,OAAO,IAAI,KAAK,SAAS;QACzB,OAAO,IAAI,KAAK,QAAQ;QACxB,OAAO,IAAI,KAAK,QAAQ,EACxB,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,WAAW;IACX,MAAM,GAAG,GAAG,IAA4B,CAAC;IACzC,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACb,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QAClD,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAa,EAAE,MAAqB;IAC7D,MAAM,IAAI,GAAmB,EAAE,CAAC;IAEhC,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;QACjB,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC"}

package/vendor/aql/utils/dependencyCycle.d.ts

@@ -0,0 +1,7 @@
+/**
+ * DFS cycle detection for a directed dependency graph.
+ * Returns the cycle path including the repeated start node
+ * (e.g. `['A', 'B', 'C', 'A']`), or `null` when none exists.
+ */
+export declare function findDependencyCycle(startName: string, getReferencedNames: (name: string) => readonly string[]): string[] | null;
+//# sourceMappingURL=dependencyCycle.d.ts.map

package/vendor/aql/utils/dependencyCycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencyCycle.d.ts","sourceRoot":"","sources":["../../../src/utils/dependencyCycle.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,kBAAkB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,MAAM,EAAE,GACtD,MAAM,EAAE,GAAG,IAAI,CAoBjB"}

package/vendor/aql/utils/dependencyCycle.js

@@ -0,0 +1,24 @@
+/**
+ * DFS cycle detection for a directed dependency graph.
+ * Returns the cycle path including the repeated start node
+ * (e.g. `['A', 'B', 'C', 'A']`), or `null` when none exists.
+ */
+export function findDependencyCycle(startName, getReferencedNames) {
+    const stack = [];
+    const visit = (name) => {
+        if (stack.includes(name)) {
+            return [...stack.slice(stack.indexOf(name)), name];
+        }
+        stack.push(name);
+        for (const referenced of getReferencedNames(name)) {
+            const cycle = visit(referenced);
+            if (cycle) {
+                return cycle;
+            }
+        }
+        stack.pop();
+        return null;
+    };
+    return visit(startName);
+}
+//# sourceMappingURL=dependencyCycle.js.map

package/vendor/aql/utils/dependencyCycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencyCycle.js","sourceRoot":"","sources":["../../../src/utils/dependencyCycle.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAAiB,EACjB,kBAAuD;IAEvD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,MAAM,KAAK,GAAG,CAAC,IAAY,EAAmB,EAAE;QAC9C,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,KAAK,MAAM,UAAU,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;YAChC,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,KAAK,CAAC,GAAG,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC;AAC1B,CAAC"}

package/vendor/aql/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { findPathTo, getCurrentToken, walker } from './astUtils';
+export { findDependencyCycle } from './dependencyCycle';
+//# sourceMappingURL=index.d.ts.map

package/vendor/aql/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC"}

package/vendor/aql/utils/index.js

@@ -0,0 +1,3 @@
+export { findPathTo, getCurrentToken, walker } from './astUtils.js';
+export { findDependencyCycle } from './dependencyCycle.js';
+//# sourceMappingURL=index.js.map

package/vendor/aql/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC"}

package/vendor/aql/validation/classifyExpression.d.ts

@@ -0,0 +1,55 @@
+import type { AST, AST_Expression } from '../types';
+/**
+ * Structural classification of AQL expressions.
+ *
+ * Every expression is a value expression — the root evaluates to a value
+ * and may contain `AGG_CALL`s (set context) and `OBSERVABLE_CALL`s (change
+ * history). Product features request a required return type plus
+ * capabilities (`ExpressionValidationRequest`); any product-specific
+ * vocabulary (Adaptable's module kinds) maps onto that request on the host
+ * side — aql only knows the capability request.
+ */
+export interface ExpressionClassification {
+    /** Number of `AGG_CALL` nodes anywhere in the program. */
+    aggCallCount: number;
+    /** Number of `OBSERVABLE_CALL` nodes anywhere in the program. */
+    observableCallCount: number;
+    /**
+     * True when the value depends on the clock without any grid change:
+     * a `WITHIN(...)` window (entries age out) or a time-volatile scalar
+     * (`NOW()`, `IS_PAST()`, … — needs `options.scalarFunctions`).
+     * Consumers re-evaluate such expressions on a clock cadence.
+     */
+    timeVolatile: boolean;
+}
+export interface ExpressionValidationRequest {
+    /** Required root return type; omit for "any value" (e.g. calculated columns). */
+    returnType?: 'boolean';
+    /** When false, `AGG_CALL`s are forbidden (client-evaluated per-row contexts). */
+    allowsAggCalls?: boolean;
+    /** When true, at least one `AGG_CALL` is required (Alert aggregation rules). */
+    requiresAggCalls?: boolean;
+    /** When false, `OBSERVABLE_CALL`s are forbidden (module policy). */
+    allowsObservableCalls?: boolean;
+}
+export interface ClassifyExpressionOptions {
+    /** Scalar pool — enables `timeVolatile` detection of `NOW()`-like functions. */
+    scalarFunctions?: Record<string, {
+        isTimeVolatile?: boolean;
+    } | undefined>;
+}
+/** The program's root expression: the last statement. */
+export declare const getRootExpression: (ast: AST) => AST_Expression;
+/** Classifies a **normalized** program (see `normalizeAst`). */
+export declare const classifyExpression: (normalizedAst: AST, options?: ClassifyExpressionOptions) => ExpressionClassification;
+/**
+ * Evaluation strategy implied by the text alone:
+ * - `aggregated` — the value depends on a set of rows (any aggregation node,
+ *   including the paren wrappers the normalizer leaves as `FUNCTION`)
+ * - `scalar` — evaluated per row (observable calls included: they read the
+ *   row's own history)
+ */
+export type ExpressionKind = 'scalar' | 'aggregated';
+/** Infers the {@link ExpressionKind} of a **normalized** program. */
+export declare const inferExpressionKind: (normalizedAst: AST) => ExpressionKind;
+//# sourceMappingURL=classifyExpression.d.ts.map

package/vendor/aql/validation/classifyExpression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classifyExpression.d.ts","sourceRoot":"","sources":["../../../src/validation/classifyExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,cAAc,EAAgB,MAAM,UAAU,CAAC;AAIlE;;;;;;;;;GASG;AAEH,MAAM,WAAW,wBAAwB;IACvC,0DAA0D;IAC1D,YAAY,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C,iFAAiF;IACjF,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,iFAAiF;IACjF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,oEAAoE;IACpE,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,yBAAyB;IACxC,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC;CAC5E;AA4CD,yDAAyD;AACzD,eAAO,MAAM,iBAAiB,QAAS,GAAG,KAAG,cACA,CAAC;AAE9C,gEAAgE;AAChE,eAAO,MAAM,kBAAkB,kBACd,GAAG,YACT,yBAAyB,KACjC,wBAaF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,YAAY,CAAC;AAErD,qEAAqE;AACrE,eAAO,MAAM,mBAAmB,kBAAmB,GAAG,KAAG,cAKxD,CAAC"}

package/vendor/aql/validation/classifyExpression.js

@@ -0,0 +1,61 @@
+import { isAST_Function } from '../types.js';
+import { containsAggregation } from '../plan/compile.js';
+const kindOf = (fn) => fn.kind ?? fn.metaInfo;
+const countKinds = (expression, counts) => {
+    if (expression == null || typeof expression !== 'object') {
+        return;
+    }
+    if (Array.isArray(expression)) {
+        for (const item of expression) {
+            countKinds(item, counts);
+        }
+        return;
+    }
+    if (!isAST_Function(expression)) {
+        // CASE {WHEN, THEN} entries and other plain objects
+        for (const value of Object.values(expression)) {
+            countKinds(value, counts);
+        }
+        return;
+    }
+    const kind = kindOf(expression);
+    if (kind === 'AGG_CALL') {
+        counts.agg += 1;
+    }
+    else if (kind === 'OBSERVABLE_CALL') {
+        counts.observable += 1;
+    }
+    else if (kind === 'CLAUSE' && expression.type === 'WITHIN') {
+        counts.timeVolatile = true;
+    }
+    else if (kind === 'FUNCTION' &&
+        counts.scalarFunctions?.[expression.type]?.isTimeVolatile === true) {
+        counts.timeVolatile = true;
+    }
+    countKinds(expression.args, counts);
+};
+/** The program's root expression: the last statement. */
+export const getRootExpression = (ast) => ast.length > 0 ? ast[ast.length - 1] : null;
+/** Classifies a **normalized** program (see `normalizeAst`). */
+export const classifyExpression = (normalizedAst, options = {}) => {
+    const counts = {
+        agg: 0,
+        observable: 0,
+        timeVolatile: false,
+        scalarFunctions: options.scalarFunctions,
+    };
+    countKinds(normalizedAst, counts);
+    return {
+        aggCallCount: counts.agg,
+        observableCallCount: counts.observable,
+        timeVolatile: counts.timeVolatile,
+    };
+};
+/** Infers the {@link ExpressionKind} of a **normalized** program. */
+export const inferExpressionKind = (normalizedAst) => {
+    if (containsAggregation(normalizedAst)) {
+        return 'aggregated';
+    }
+    return 'scalar';
+};
+//# sourceMappingURL=classifyExpression.js.map

package/vendor/aql/validation/classifyExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"classifyExpression.js","sourceRoot":"","sources":["../../../src/validation/classifyExpression.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AA2CtD,MAAM,MAAM,GAAG,CAAC,EAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,QAAQ,CAAC;AAShF,MAAM,UAAU,GAAG,CAAC,UAA0B,EAAE,MAAkB,EAAQ,EAAE;IAC1E,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACzD,OAAO;IACT,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO;IACT,CAAC;IACD,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,oDAAoD;QACpD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,UAAqC,CAAC,EAAE,CAAC;YACzE,UAAU,CAAC,KAAuB,EAAE,MAAM,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IAChC,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAClB,CAAC;SAAM,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACtC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;IACzB,CAAC;SAAM,IAAI,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7D,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;SAAM,IACL,IAAI,KAAK,UAAU;QACnB,MAAM,CAAC,eAAe,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,cAAc,KAAK,IAAI,EAClE,CAAC;QACD,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,yDAAyD;AACzD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,GAAQ,EAAkB,EAAE,CAC5D,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAE9C,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,aAAkB,EAClB,UAAqC,EAAE,EACb,EAAE;IAC5B,MAAM,MAAM,GAAe;QACzB,GAAG,EAAE,CAAC;QACN,UAAU,EAAE,CAAC;QACb,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,OAAO,CAAC,eAAe;KACzC,CAAC;IACF,UAAU,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAClC,OAAO;QACL,YAAY,EAAE,MAAM,CAAC,GAAG;QACxB,mBAAmB,EAAE,MAAM,CAAC,UAAU;QACtC,YAAY,EAAE,MAAM,CAAC,YAAY;KAClC,CAAC;AACJ,CAAC,CAAC;AAWF,qEAAqE;AACrE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,aAAkB,EAAkB,EAAE;IACxE,IAAI,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC;QACvC,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}

package/vendor/aql/validation/functionMetadata.d.ts

@@ -0,0 +1,159 @@
+import type { ExpressionFunctionInputType } from '../types';
+/**
+ * Unified function/clause parameter metadata.
+ *
+ * Positional inputs carry a grouped `ui` hint; `clauses` lists which clauses
+ * each brace-callable supports. This is the single schema that feeds
+ * validation (the guard rails and the clause operand checks) and the
+ * expression editor. Aggregation specs are *derived* from the operators by
+ * the aggregation catalogue (`plan/catalogue.ts`); observable specs are the
+ * static tables below.
+ */
+export type QueryBuilderInputMode = 'column' | 'field' | 'input-value';
+export type QueryBuilderValueEditor = 'permitted' | 'free' | {
+    enum: string[];
+};
+/** QB-only hints; ignored by validation, Row Summary and other generic consumers. */
+export interface FunctionParameterUiHints {
+    label?: string;
+    modes?: QueryBuilderInputMode[];
+    valueEditor?: QueryBuilderValueEditor;
+}
+export interface FunctionParameter {
+    /** Accepted static types. Omitted = any type. */
+    types?: ExpressionFunctionInputType[];
+    /** RHS editor/check type follows the resolved subject (list[0]) type. */
+    matchesSubjectType?: boolean;
+    /** This slot repeats (variadic tail). */
+    multi?: boolean;
+    /** The slot may be omitted. */
+    optional?: boolean;
+    ui?: FunctionParameterUiHints;
+}
+export interface FunctionParameters {
+    /** `'column-or-field'` ⇒ list[0] is the subject; `'none'` ⇒ no subject. */
+    subject?: 'column-or-field' | 'none';
+    /** Eligible for the visual Query Builder. */
+    queryBuilder?: boolean;
+    list: FunctionParameter[];
+}
+/** Contract-v2 clause names. */
+export type AqlClauseName = 'GROUP_BY' | 'OVER' | 'WEIGHT' | 'CUMULATIVE' | 'WHERE' | 'ANY_COL' | 'WITHIN' | 'LAST_N' | 'ALL_ROWS' | 'TRIGGER';
+export interface ClauseUsage {
+    clause: AqlClauseName;
+    /** The call is invalid without this clause (e.g. RANK needs OVER). */
+    required?: boolean;
+}
+/**
+ * What a clause's operand must be (enforced by the structural validator):
+ * - `'ref'` — a column/field reference
+ * - `'numeric-ref'` — a column/field reference of numeric type (when known)
+ * - `'column-list'` — zero or more column references (`ANY_COL()`, `ANY_COL([a], [b])`)
+ * - `'duration'` — a `DURATION` literal node
+ * - `'positive-int'` — an integer literal >= 1 (`LAST_N(20)`)
+ * - `'trigger-list'` — one or more string literals from {@link TRIGGER_LITERALS}
+ * - `'predicate'` — a boolean expression (checked by the scalar type walk)
+ * - `'none'` — the clause takes no operand (`ALL_ROWS()`)
+ */
+export type ClauseOperandKind = 'ref' | 'numeric-ref' | 'column-list' | 'duration' | 'positive-int' | 'trigger-list' | 'predicate' | 'none';
+export declare const CLAUSE_OPERAND_KINDS: Record<AqlClauseName, ClauseOperandKind>;
+/** Accepted `TRIGGER(...)` operands (change origins recorded by the host). */
+export declare const TRIGGER_LITERALS: ReadonlySet<string>;
+export interface AqlCallableSpec {
+    /** Positional inputs: list[0] is the aggregated/watched input when present. */
+    parameters: FunctionParameters;
+    /** Clauses this callable accepts (validation rejects the rest). */
+    clauses: readonly ClauseUsage[];
+    /** When true, the call is invalid without a positional input. */
+    requiresInput: boolean;
+    /**
+     * Static result type feeding the outer scalar type check:
+     * `'input'` = same type as the aggregated input (MIN/MAX/FIRST/…).
+     */
+    resultType: 'input' | 'number' | 'boolean' | 'text' | 'date' | 'duration' | 'unknown';
+    /** Whether the CUMULATIVE clause is accepted (the cumulation capability). */
+    supportsCumulative?: boolean;
+    /**
+     * Whether an optional `'ASC'` / `'DESC'` positional item sets the order the
+     * operator sorts its own input in (QUANT / QUARTILE / PERCENTILE).
+     */
+    acceptsSortDirection?: boolean;
+}
+/** The sort-direction literals accepted by OVER, CUMULATIVE and QUANT. */
+export declare const SORT_DIRECTION_LITERALS: readonly ["ASC", "DESC"];
+/**
+ * Reads a sort-direction literal (`'ASC'` / `'DESC'`, case-insensitive);
+ * `undefined` when the value is not one.
+ */
+export declare const toSortDirection: (value: unknown) => "asc" | "desc" | undefined;
+export type ObservableSourceName = 'CHANGE_COUNT' | 'NO_CHANGES' | 'SINCE_CHANGE' | 'CHANGED_AT' | 'NET_CHANGE' | 'PERCENT_CHANGE' | 'HIGHEST' | 'LOWEST' | 'PREVIOUS' | 'ROW_AGE' | 'ADDED_AT' | 'ROWS_ADDED' | 'ROWS_REMOVED';
+export type ObservableWindowKind = 'WITHIN' | 'LAST_N' | 'cumulative';
+export type ObservableScope = 'row' | 'grid';
+export type ObservableInputType = 'number' | 'text' | 'date' | 'boolean';
+export interface ObservablePositionalParam {
+    name: string;
+    kind: 'positive-int';
+    optional: boolean;
+}
+export interface ObservableCallSpec extends AqlCallableSpec {
+    /**
+     * Whether the call watches a column (`[col]` first item) or takes none.
+     * `'column-or-any'` also accepts the union subject `ANY_COL()` /
+     * `ANY_COL([a], [b])` in place of `[col]` (exactly one of the two).
+     * `'optional'` is reserved for host-registered names without a system spec.
+     */
+    input: 'required' | 'column-or-any' | 'forbidden' | 'optional';
+    /** Accepted watched-column types; `undefined` = any. */
+    inputTypes?: readonly ObservableInputType[];
+    windows: readonly ObservableWindowKind[];
+    /** `['grid']` alone means grid scope is implicit and `ALL_ROWS()` is rejected. */
+    scopes: readonly ObservableScope[];
+    positional?: readonly ObservablePositionalParam[];
+    resultType: 'input' | 'number' | 'boolean' | 'duration' | 'date';
+}
+/** Sources that accept the `ANY_COL(…)` union subject. */
+export declare const ANY_COL_SOURCE_NAMES: readonly ObservableSourceName[];
+/**
+ * Observable brace-callables. Every entry is a *value* (legal inside scalar
+ * math and comparisons). The catalogue naming applies: `CHANGE_COUNT`,
+ * `NO_CHANGES`, `SINCE_CHANGE`, `CHANGED_AT`, `NET_CHANGE`, `PERCENT_CHANGE{}`,
+ * `HIGHEST`, `LOWEST`, `PREVIOUS`, `ROW_AGE`, `ADDED_AT`, `ROWS_ADDED`,
+ * `ROWS_REMOVED`.
+ */
+export declare const OBSERVABLE_CALL_SPECS: Record<ObservableSourceName, ObservableCallSpec>;
+/** Host-registered observable names without a system spec: accept the full clause set. */
+export declare const CUSTOM_OBSERVABLE_FALLBACK_SPEC: ObservableCallSpec;
+export declare const isObservableSourceName: (name: string) => name is ObservableSourceName;
+export declare const getObservableCallSpec: (name: string) => ObservableCallSpec | undefined;
+/**
+ * Documentation of the observable callables. Like {@link CLAUSE_DOCS}: pure
+ * data (description / signatures / examples / category) that hosts present
+ * in menus, hover docs and completion, adding labels and icons on their side.
+ *
+ * Signatures list the common shapes (bare, time window, count window, and —
+ * where the call accepts them — ANY_COL / ALL_ROWS / TRIGGER / WHERE). Examples include both
+ * bare values (Calculated Columns) and comparisons (Alerts / Format Columns).
+ */
+export declare const OBSERVABLE_DOCS: Record<ObservableSourceName, ClauseDocs>;
+/**
+ * Documentation of the clause keywords (`GROUP_BY([c])`, `OVER([c])`, …).
+ * Clauses are not callables — they modify a brace call — so they are
+ * documented here rather than in the aggregation catalogue. Pure data;
+ * hosts add presentation (labels, icons) on their side.
+ */
+export interface ClauseDocs {
+    description: string;
+    signatures: string[];
+    /** Full expressions (regression corpus material). */
+    examples: string[];
+    category: string;
+}
+export declare const CLAUSE_DOCS: Record<AqlClauseName, ClauseDocs>;
+/**
+ * Baseline shape for a host-known aggregation name with no operator in the
+ * catalogue (one input, `GROUP_BY` / `WHERE`): validation and editors accept
+ * it so the rest of the expression still checks. Names *with* an operator
+ * get their spec derived from the operator's capabilities instead.
+ */
+export declare const BASELINE_CUSTOM_AGGREGATION_SPEC: AqlCallableSpec;
+//# sourceMappingURL=functionMetadata.d.ts.map

package/vendor/aql/validation/functionMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functionMetadata.d.ts","sourceRoot":"","sources":["../../../src/validation/functionMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAE5D;;;;;;;;;GASG;AAMH,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,OAAO,GAAG,aAAa,CAAC;AACvE,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEhF,qFAAqF;AACrF,MAAM,WAAW,wBAAwB;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC,iDAAiD;IACjD,KAAK,CAAC,EAAE,2BAA2B,EAAE,CAAC;IACtC,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,yCAAyC;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,EAAE,CAAC,EAAE,wBAAwB,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,2EAA2E;IAC3E,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;IACrC,6CAA6C;IAC7C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,IAAI,EAAE,iBAAiB,EAAE,CAAC;CAC3B;AAMD,gCAAgC;AAChC,MAAM,MAAM,aAAa,GACrB,UAAU,GACV,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,SAAS,CAAC;AAEd,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,aAAa,CAAC;IACtB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iBAAiB,GACzB,KAAK,GACL,aAAa,GACb,aAAa,GACb,UAAU,GACV,cAAc,GACd,cAAc,GACd,WAAW,GACX,MAAM,CAAC;AAEX,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,aAAa,EAAE,iBAAiB,CAWzE,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAmD,CAAC;AAMrG,MAAM,WAAW,eAAe;IAC9B,+EAA+E;IAC/E,UAAU,EAAE,kBAAkB,CAAC;IAC/B,mEAAmE;IACnE,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IAChC,iEAAiE;IACjE,aAAa,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IACtF,6EAA6E;IAC7E,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,0EAA0E;AAC1E,eAAO,MAAM,uBAAuB,0BAA2B,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,eAAe,UAAW,OAAO,KAAG,KAAK,GAAG,MAAM,GAAG,SAMjE,CAAC;AAMF,MAAM,MAAM,oBAAoB,GAC5B,cAAc,GACd,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,SAAS,GACT,QAAQ,GACR,UAAU,GACV,SAAS,GACT,UAAU,GACV,YAAY,GACZ,cAAc,CAAC;AAEnB,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,CAAC;AACtE,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,CAAC;AAC7C,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAEzE,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD;;;;;OAKG;IACH,KAAK,EAAE,UAAU,GAAG,eAAe,GAAG,WAAW,GAAG,UAAU,CAAC;IAC/D,wDAAwD;IACxD,UAAU,CAAC,EAAE,SAAS,mBAAmB,EAAE,CAAC;IAC5C,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACzC,kFAAkF;IAClF,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;IACnC,UAAU,CAAC,EAAE,SAAS,yBAAyB,EAAE,CAAC;IAClD,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;CAClE;AAiDD,0DAA0D;AAC1D,eAAO,MAAM,oBAAoB,EAAE,SAAS,oBAAoB,EAK/D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,oBAAoB,EAAE,kBAAkB,CA0DlF,CAAC;AAEF,0FAA0F;AAC1F,eAAO,MAAM,+BAA+B,EAAE,kBAQ7C,CAAC;AAEF,eAAO,MAAM,sBAAsB,SAAU,MAAM,KAAG,IAAI,IAAI,oBACK,CAAC;AAEpE,eAAO,MAAM,qBAAqB,SAAU,MAAM,KAAG,kBAAkB,GAAG,SACF,CAAC;AAEzE;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,oBAAoB,EAAE,UAAU,CAiNpE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAyIzD,CAAC;AAIF;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,EAAE,eAK9C,CAAC"}