flowquery 1.0.3 → 1.0.6

package/dist/parsing/expressions/reference.d.ts

@@ -0,0 +1,29 @@
+import ASTNode from "../ast_node";
+import Identifier from "./identifier";
+/**
+ * Represents a reference to a previously defined variable or expression.
+ *
+ * References point to values defined earlier in the query (e.g., in WITH or LOAD statements).
+ *
+ * @example
+ * ```typescript
+ * const ref = new Reference("myVar", previousNode);
+ * console.log(ref.value()); // Gets value from referred node
+ * ```
+ */
+declare class Reference extends Identifier {
+    private _referred;
+    /**
+     * Creates a new Reference to a variable.
+     *
+     * @param value - The identifier name
+     * @param referred - The node this reference points to (optional)
+     */
+    constructor(value: string, referred?: ASTNode | undefined);
+    set referred(node: ASTNode);
+    toString(): string;
+    value(): any;
+    get identifier(): string;
+}
+export default Reference;
+//# sourceMappingURL=reference.d.ts.map

package/dist/parsing/expressions/reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/parsing/expressions/reference.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAC;AAClC,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,cAAM,SAAU,SAAQ,UAAU;IAC9B,OAAO,CAAC,SAAS,CAAkC;IAEnD;;;;;OAKG;gBACS,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAO,GAAG,SAAqB;IAIpE,IAAW,QAAQ,CAAC,IAAI,EAAE,OAAO,EAEhC;IACM,QAAQ,IAAI,MAAM;IAGlB,KAAK,IAAI,GAAG;IAGnB,IAAW,UAAU,IAAI,MAAM,CAE9B;CACJ;AAED,eAAe,SAAS,CAAC"}

package/dist/parsing/expressions/string.d.ts

@@ -0,0 +1,23 @@
+import ASTNode from "../ast_node";
+/**
+ * Represents a string literal in the AST.
+ *
+ * @example
+ * ```typescript
+ * const str = new String("hello");
+ * console.log(str.value()); // "hello"
+ * ```
+ */
+declare class String extends ASTNode {
+    protected _value: string;
+    /**
+     * Creates a new String node with the given value.
+     *
+     * @param value - The string value
+     */
+    constructor(value: string);
+    value(): string;
+    toString(): string;
+}
+export default String;
+//# sourceMappingURL=string.d.ts.map

package/dist/parsing/expressions/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/parsing/expressions/string.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAC;AAElC;;;;;;;;GAQG;AACH,cAAM,MAAO,SAAQ,OAAO;IACxB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;gBACS,KAAK,EAAE,MAAM;IAKlB,KAAK,IAAI,MAAM;IAIf,QAAQ,IAAI,MAAM;CAG5B;AAED,eAAe,MAAM,CAAC"}

package/dist/parsing/functions/aggregate_function.d.ts

@@ -0,0 +1,42 @@
+import Function from "./function";
+import ReducerElement from "./reducer_element";
+/**
+ * Base class for aggregate functions that reduce multiple values to a single value.
+ *
+ * Aggregate functions like SUM, AVG, and COLLECT process multiple input values
+ * and produce a single output. They cannot be nested within other aggregate functions.
+ *
+ * @example
+ * ```typescript
+ * const sumFunc = new Sum();
+ * // Used in: RETURN SUM(values)
+ * ```
+ */
+declare class AggregateFunction extends Function {
+    private _overridden;
+    /**
+     * Creates a new AggregateFunction with the given name.
+     *
+     * @param name - The function name
+     */
+    constructor(name: string);
+    /**
+     * Processes a value during the aggregation phase.
+     *
+     * @param value - The element to aggregate
+     * @throws {Error} If not implemented by subclass
+     */
+    reduce(value: ReducerElement): void;
+    /**
+     * Creates a reducer element for this aggregate function.
+     *
+     * @returns A ReducerElement instance
+     * @throws {Error} If not implemented by subclass
+     */
+    element(): ReducerElement;
+    get overridden(): any | null;
+    set overridden(value: any | null);
+    value(): any;
+}
+export default AggregateFunction;
+//# sourceMappingURL=aggregate_function.d.ts.map

package/dist/parsing/functions/aggregate_function.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate_function.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/aggregate_function.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAE/C;;;;;;;;;;;GAWG;AACH,cAAM,iBAAkB,SAAQ,QAAQ;IACpC,OAAO,CAAC,WAAW,CAAoB;IAEvC;;;;OAIG;gBACS,IAAI,EAAE,MAAM;IAIxB;;;;;OAKG;IACI,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAI1C;;;;;OAKG;IACI,OAAO,IAAI,cAAc;IAGhC,IAAW,UAAU,IAAI,GAAG,GAAG,IAAI,CAElC;IACD,IAAW,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI,EAEtC;IACM,KAAK,IAAI,GAAG;CAGtB;AAED,eAAe,iBAAiB,CAAC"}

package/dist/parsing/functions/async_function.d.ts

@@ -0,0 +1,52 @@
+import ASTNode from "../ast_node";
+/**
+ * Represents an async data provider function call for use in LOAD operations.
+ *
+ * This class holds the function name and arguments, and provides async iteration
+ * over the results from a registered async data provider.
+ *
+ * @example
+ * ```typescript
+ * // Used in: LOAD JSON FROM myDataSource('arg1', 'arg2') AS data
+ * const asyncFunc = new AsyncFunction("myDataSource");
+ * asyncFunc.parameters = [arg1Node, arg2Node];
+ * for await (const item of asyncFunc.execute()) {
+ *     console.log(item);
+ * }
+ * ```
+ */
+declare class AsyncFunction extends ASTNode {
+    private _name;
+    /**
+     * Creates a new AsyncFunction with the given name.
+     *
+     * @param name - The function name (must be registered as an async provider)
+     */
+    constructor(name: string);
+    /**
+     * Gets the function name.
+     */
+    get name(): string;
+    /**
+     * Sets the function parameters.
+     *
+     * @param nodes - Array of AST nodes representing the function arguments
+     */
+    set parameters(nodes: ASTNode[]);
+    /**
+     * Evaluates all parameters and returns their values.
+     *
+     * @returns Array of parameter values
+     */
+    private getArguments;
+    /**
+     * Executes the async data provider function and yields results.
+     *
+     * @yields Data items from the async provider
+     * @throws {Error} If the function is not registered as an async provider
+     */
+    execute(): AsyncGenerator<any, void, unknown>;
+    toString(): string;
+}
+export default AsyncFunction;
+//# sourceMappingURL=async_function.d.ts.map

package/dist/parsing/functions/async_function.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async_function.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/async_function.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAC;AAGlC;;;;;;;;;;;;;;;GAeG;AACH,cAAM,aAAc,SAAQ,OAAO;IAC/B,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;OAIG;gBACS,IAAI,EAAE,MAAM;IAKxB;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;OAIG;IACH,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAErC;IAED;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAIpB;;;;;OAKG;IACW,OAAO,IAAI,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC;IA0BpD,QAAQ,IAAI,MAAM;CAG5B;AAED,eAAe,aAAa,CAAC"}

package/dist/parsing/functions/avg.d.ts

@@ -0,0 +1,15 @@
+import AggregateFunction from "./aggregate_function";
+import ReducerElement from "./reducer_element";
+declare class AvgReducerElement extends ReducerElement {
+    private _count;
+    private _sum;
+    get value(): number | null;
+    set value(value: number);
+}
+declare class Avg extends AggregateFunction {
+    constructor();
+    reduce(element: AvgReducerElement): void;
+    element(): AvgReducerElement;
+}
+export default Avg;
+//# sourceMappingURL=avg.d.ts.map

package/dist/parsing/functions/avg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"avg.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/avg.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AAErD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAG/C,cAAM,iBAAkB,SAAQ,cAAc;IAC1C,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,IAAI,CAAuB;IACnC,IAAW,KAAK,IAAI,MAAM,GAAG,IAAI,CAKhC;IACD,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAO7B;CACJ;AAED,cASM,GAAI,SAAQ,iBAAiB;;IAKxB,MAAM,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAGxC,OAAO,IAAI,iBAAiB;CAGtC;AAED,eAAe,GAAG,CAAC"}

package/dist/parsing/functions/avg.js

@@ -1,10 +1,17 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const aggregate_function_1 = __importDefault(require("./aggregate_function"));
 const reducer_element_1 = __importDefault(require("./reducer_element"));
+const function_metadata_1 = require("./function_metadata");
 class AvgReducerElement extends reducer_element_1.default {
     constructor() {
         super(...arguments);
@@ -27,7 +34,7 @@ class AvgReducerElement extends reducer_element_1.default {
         }
     }
 }
-class Avg extends aggregate_function_1.default {
+let Avg = class Avg extends aggregate_function_1.default {
     constructor() {
         super("avg");
         this._expectedParameterCount = 1;
@@ -38,6 +45,17 @@ class Avg extends aggregate_function_1.default {
     element() {
         return new AvgReducerElement();
     }
-}
+};
+Avg = __decorate([
+    (0, function_metadata_1.FunctionDef)({
+        description: "Calculates the average of numeric values across grouped rows",
+        category: "aggregate",
+        parameters: [
+            { name: "value", description: "Numeric value to average", type: "number" }
+        ],
+        output: { description: "Average of all values", type: "number", example: 50 },
+        examples: ["WITH [10, 20, 30] AS nums UNWIND nums AS n RETURN avg(n)"]
+    })
+], Avg);
 exports.default = Avg;
 //# sourceMappingURL=avg.js.map

package/dist/parsing/functions/avg.js.map

@@ -1 +1 @@
-{"version":3,"file":"avg.js","sourceRoot":"","sources":["../../../src/parsing/functions/avg.ts"],"names":[],"mappings":";;;;;AAAA,8EAAqD;AAErD,wEAA+C;AAE/C,MAAM,iBAAkB,SAAQ,yBAAc;IAA9C;;QACY,WAAM,GAAW,CAAC,CAAC;QACnB,SAAI,GAAkB,IAAI,CAAC;IAevC,CAAC;IAdG,IAAW,KAAK;QACZ,IAAG,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IACnC,CAAC;IACD,IAAW,KAAK,CAAC,KAAa;QAC1B,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACjB,IAAG,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC;QACvB,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QACtB,CAAC;IACL,CAAC;CACJ;AAED,MAAM,GAAI,SAAQ,4BAAiB;IAC/B;QACI,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,OAA0B;QACpC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;IAC9C,CAAC;IACM,OAAO;QACV,OAAO,IAAI,iBAAiB,EAAE,CAAC;IACnC,CAAC;CACJ;AAED,kBAAe,GAAG,CAAC"}
+{"version":3,"file":"avg.js","sourceRoot":"","sources":["../../../src/parsing/functions/avg.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,8EAAqD;AAErD,wEAA+C;AAC/C,2DAAkD;AAElD,MAAM,iBAAkB,SAAQ,yBAAc;IAA9C;;QACY,WAAM,GAAW,CAAC,CAAC;QACnB,SAAI,GAAkB,IAAI,CAAC;IAevC,CAAC;IAdG,IAAW,KAAK;QACZ,IAAG,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IACnC,CAAC;IACD,IAAW,KAAK,CAAC,KAAa;QAC1B,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACjB,IAAG,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC;QACvB,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QACtB,CAAC;IACL,CAAC;CACJ;AAWD,IAAM,GAAG,GAAT,MAAM,GAAI,SAAQ,4BAAiB;IAC/B;QACI,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,OAA0B;QACpC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;IAC9C,CAAC;IACM,OAAO;QACV,OAAO,IAAI,iBAAiB,EAAE,CAAC;IACnC,CAAC;CACJ,CAAA;AAXK,GAAG;IATR,IAAA,+BAAW,EAAC;QACT,WAAW,EAAE,8DAA8D;QAC3E,QAAQ,EAAE,WAAW;QACrB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC7E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;QAC7E,QAAQ,EAAE,CAAC,0DAA0D,CAAC;KACzE,CAAC;GACI,GAAG,CAWR;AAED,kBAAe,GAAG,CAAC"}

package/dist/parsing/functions/collect.d.ts

@@ -0,0 +1,21 @@
+import AggregateFunction from "./aggregate_function";
+import ReducerElement from "./reducer_element";
+declare class CollectReducerElement extends ReducerElement {
+    private _value;
+    get value(): any;
+    set value(value: any);
+}
+declare class DistinctCollectReducerElement extends ReducerElement {
+    private _value;
+    get value(): any;
+    set value(value: any);
+}
+declare class Collect extends AggregateFunction {
+    private _distinct;
+    constructor();
+    reduce(element: CollectReducerElement): void;
+    element(): CollectReducerElement | DistinctCollectReducerElement;
+    set distinct(distinct: boolean);
+}
+export default Collect;
+//# sourceMappingURL=collect.d.ts.map

package/dist/parsing/functions/collect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/collect.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AACrD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAG/C,cAAM,qBAAsB,SAAQ,cAAc;IAC9C,OAAO,CAAC,MAAM,CAAa;IAC3B,IAAW,KAAK,IAAI,GAAG,CAEtB;IACD,IAAW,KAAK,CAAC,KAAK,EAAE,GAAG,EAE1B;CACJ;AAED,cAAM,6BAA8B,SAAQ,cAAc;IACtD,OAAO,CAAC,MAAM,CAA4B;IAC1C,IAAW,KAAK,IAAI,GAAG,CAEtB;IACD,IAAW,KAAK,CAAC,KAAK,EAAE,GAAG,EAK1B;CACJ;AAED,cASM,OAAQ,SAAQ,iBAAiB;IACnC,OAAO,CAAC,SAAS,CAAkB;;IAK5B,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAG5C,OAAO,IAAI,qBAAqB,GAAG,6BAA6B;IAGvE,IAAW,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAEpC;CACJ;AAED,eAAe,OAAO,CAAC"}

package/dist/parsing/functions/collect.js

@@ -1,10 +1,17 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const aggregate_function_1 = __importDefault(require("./aggregate_function"));
 const reducer_element_1 = __importDefault(require("./reducer_element"));
+const function_metadata_1 = require("./function_metadata");
 class CollectReducerElement extends reducer_element_1.default {
     constructor() {
         super(...arguments);
@@ -32,7 +39,7 @@ class DistinctCollectReducerElement extends reducer_element_1.default {
         }
     }
 }
-class Collect extends aggregate_function_1.default {
+let Collect = class Collect extends aggregate_function_1.default {
     constructor() {
         super("collect");
         this._distinct = false;
@@ -47,6 +54,17 @@ class Collect extends aggregate_function_1.default {
     set distinct(distinct) {
         this._distinct = distinct;
     }
-}
+};
+Collect = __decorate([
+    (0, function_metadata_1.FunctionDef)({
+        description: "Collects values into an array across grouped rows",
+        category: "aggregate",
+        parameters: [
+            { name: "value", description: "Value to collect", type: "any" }
+        ],
+        output: { description: "Array of collected values", type: "array", example: [1, 2, 3] },
+        examples: ["WITH [1, 2, 3] AS nums UNWIND nums AS n RETURN collect(n)"]
+    })
+], Collect);
 exports.default = Collect;
 //# sourceMappingURL=collect.js.map

package/dist/parsing/functions/collect.js.map

@@ -1 +1 @@
-{"version":3,"file":"collect.js","sourceRoot":"","sources":["../../../src/parsing/functions/collect.ts"],"names":[],"mappings":";;;;;AAAA,8EAAqD;AACrD,wEAA+C;AAE/C,MAAM,qBAAsB,SAAQ,yBAAc;IAAlD;;QACY,WAAM,GAAU,EAAE,CAAC;IAO/B,CAAC;IANG,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,IAAW,KAAK,CAAC,KAAU;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;CACJ;AAED,MAAM,6BAA8B,SAAQ,yBAAc;IAA1D;;QACY,WAAM,GAAkB,IAAI,GAAG,EAAE,CAAC;IAU9C,CAAC;IATG,IAAW,KAAK;QACZ,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,IAAW,KAAK,CAAC,KAAU;QACvB,MAAM,GAAG,GAAW,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;CACJ;AAED,MAAM,OAAQ,SAAQ,4BAAiB;IAEnC;QACI,KAAK,CAAC,SAAS,CAAC,CAAC;QAFb,cAAS,GAAY,KAAK,CAAC;QAG/B,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,OAA8B;QACxC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;IAC9C,CAAC;IACM,OAAO;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,6BAA6B,EAAE,CAAC,CAAC,CAAC,IAAI,qBAAqB,EAAE,CAAC;IAC9F,CAAC;IACD,IAAW,QAAQ,CAAC,QAAiB;QACjC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;CACJ;AAED,kBAAe,OAAO,CAAC"}
+{"version":3,"file":"collect.js","sourceRoot":"","sources":["../../../src/parsing/functions/collect.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,8EAAqD;AACrD,wEAA+C;AAC/C,2DAAkD;AAElD,MAAM,qBAAsB,SAAQ,yBAAc;IAAlD;;QACY,WAAM,GAAU,EAAE,CAAC;IAO/B,CAAC;IANG,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,IAAW,KAAK,CAAC,KAAU;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;CACJ;AAED,MAAM,6BAA8B,SAAQ,yBAAc;IAA1D;;QACY,WAAM,GAAkB,IAAI,GAAG,EAAE,CAAC;IAU9C,CAAC;IATG,IAAW,KAAK;QACZ,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,IAAW,KAAK,CAAC,KAAU;QACvB,MAAM,GAAG,GAAW,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;CACJ;AAWD,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,4BAAiB;IAEnC;QACI,KAAK,CAAC,SAAS,CAAC,CAAC;QAFb,cAAS,GAAY,KAAK,CAAC;QAG/B,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,OAA8B;QACxC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;IAC9C,CAAC;IACM,OAAO;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,6BAA6B,EAAE,CAAC,CAAC,CAAC,IAAI,qBAAqB,EAAE,CAAC;IAC9F,CAAC;IACD,IAAW,QAAQ,CAAC,QAAiB;QACjC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;CACJ,CAAA;AAfK,OAAO;IATZ,IAAA,+BAAW,EAAC;QACT,WAAW,EAAE,mDAAmD;QAChE,QAAQ,EAAE,WAAW;QACrB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,IAAI,EAAE,KAAK,EAAE;SAClE;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE;QACvF,QAAQ,EAAE,CAAC,2DAA2D,CAAC;KAC1E,CAAC;GACI,OAAO,CAeZ;AAED,kBAAe,OAAO,CAAC"}

package/dist/parsing/functions/extensibility/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * FlowQuery Extensibility API
+ *
+ * This module provides all the exports needed to create custom FlowQuery functions.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * ```typescript
+ * import { Function, FunctionDef } from '../parsing/functions/extensibility';
+ *
+ * @FunctionDef({
+ *     description: "Converts a string to uppercase",
+ *     category: "string",
+ *     parameters: [{ name: "text", description: "String to convert", type: "string" }],
+ *     output: { description: "Uppercase string", type: "string" }
+ * })
+ * class UpperCase extends Function {
+ *     constructor() {
+ *         super("uppercase");
+ *         this._expectedParameterCount = 1;
+ *     }
+ *     public value(): string {
+ *         return String(this.getChildren()[0].value()).toUpperCase();
+ *     }
+ * }
+ * ```
+ */
+export { default as Function } from "../function";
+export { default as AggregateFunction } from "../aggregate_function";
+export { default as PredicateFunction } from "../predicate_function";
+export { default as ReducerElement } from "../reducer_element";
+export { FunctionDef, FunctionMetadata, FunctionDefOptions, ParameterSchema, OutputSchema, FunctionCategory } from "../function_metadata";
+export { default as FunctionFactory } from "../function_factory";
+export type { FunctionCreator, AsyncDataProvider } from "../function_factory";
+export type { RegisterFunctionOptions, RegisterAsyncProviderOptions } from "../function_metadata";
+//# sourceMappingURL=index.d.ts.map

package/dist/parsing/functions/extensibility/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/parsing/functions/extensibility/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAGH,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAG/D,OAAO,EACH,WAAW,EACX,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,gBAAgB,EACnB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG9E,YAAY,EACR,uBAAuB,EACvB,4BAA4B,EAC/B,MAAM,sBAAsB,CAAC"}

package/dist/parsing/functions/extensibility/index.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * FlowQuery Extensibility API
+ *
+ * This module provides all the exports needed to create custom FlowQuery functions.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * ```typescript
+ * import { Function, FunctionDef } from '../parsing/functions/extensibility';
+ *
+ * @FunctionDef({
+ *     description: "Converts a string to uppercase",
+ *     category: "string",
+ *     parameters: [{ name: "text", description: "String to convert", type: "string" }],
+ *     output: { description: "Uppercase string", type: "string" }
+ * })
+ * class UpperCase extends Function {
+ *     constructor() {
+ *         super("uppercase");
+ *         this._expectedParameterCount = 1;
+ *     }
+ *     public value(): string {
+ *         return String(this.getChildren()[0].value()).toUpperCase();
+ *     }
+ * }
+ * ```
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionFactory = exports.FunctionDef = exports.ReducerElement = exports.PredicateFunction = exports.AggregateFunction = exports.Function = void 0;
+// Base function classes for creating custom functions
+var function_1 = require("../function");
+Object.defineProperty(exports, "Function", { enumerable: true, get: function () { return __importDefault(function_1).default; } });
+var aggregate_function_1 = require("../aggregate_function");
+Object.defineProperty(exports, "AggregateFunction", { enumerable: true, get: function () { return __importDefault(aggregate_function_1).default; } });
+var predicate_function_1 = require("../predicate_function");
+Object.defineProperty(exports, "PredicateFunction", { enumerable: true, get: function () { return __importDefault(predicate_function_1).default; } });
+var reducer_element_1 = require("../reducer_element");
+Object.defineProperty(exports, "ReducerElement", { enumerable: true, get: function () { return __importDefault(reducer_element_1).default; } });
+// Decorator and metadata types for function registration
+var function_metadata_1 = require("../function_metadata");
+Object.defineProperty(exports, "FunctionDef", { enumerable: true, get: function () { return function_metadata_1.FunctionDef; } });
+// Factory for advanced usage
+var function_factory_1 = require("../function_factory");
+Object.defineProperty(exports, "FunctionFactory", { enumerable: true, get: function () { return __importDefault(function_factory_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/parsing/functions/extensibility/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/parsing/functions/extensibility/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;;;;;;AAEH,sDAAsD;AACtD,wCAAkD;AAAzC,qHAAA,OAAO,OAAY;AAC5B,4DAAqE;AAA5D,wIAAA,OAAO,OAAqB;AACrC,4DAAqE;AAA5D,wIAAA,OAAO,OAAqB;AACrC,sDAA+D;AAAtD,kIAAA,OAAO,OAAkB;AAElC,yDAAyD;AACzD,0DAO8B;AAN1B,gHAAA,WAAW,OAAA;AAQf,6BAA6B;AAC7B,wDAAiE;AAAxD,oIAAA,OAAO,OAAmB"}

package/dist/parsing/functions/function.d.ts

@@ -0,0 +1,36 @@
+import ASTNode from "../ast_node";
+/**
+ * Base class for all functions in FlowQuery.
+ *
+ * Functions can have parameters and may support the DISTINCT modifier.
+ * Subclasses implement specific function logic.
+ *
+ * @example
+ * ```typescript
+ * const func = FunctionFactory.create("sum");
+ * func.parameters = [expression1, expression2];
+ * ```
+ */
+declare class Function extends ASTNode {
+    protected _name: string;
+    protected _expectedParameterCount: number | null;
+    protected _supports_distinct: boolean;
+    /**
+     * Creates a new Function with the given name.
+     *
+     * @param name - The function name
+     */
+    constructor(name: string);
+    /**
+     * Sets the function parameters.
+     *
+     * @param nodes - Array of AST nodes representing the function arguments
+     * @throws {Error} If the number of parameters doesn't match expected count
+     */
+    set parameters(nodes: ASTNode[]);
+    get name(): string;
+    toString(): string;
+    set distinct(distinct: boolean);
+}
+export default Function;
+//# sourceMappingURL=function.d.ts.map

package/dist/parsing/functions/function.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/function.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,cAAM,QAAS,SAAQ,OAAO;IAC1B,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAQ;IACxD,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAS;IAE9C;;;;OAIG;gBACS,IAAI,EAAE,MAAM;IAKxB;;;;;OAKG;IACH,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAKrC;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAEM,QAAQ,IAAI,MAAM;IAIzB,IAAW,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAMpC;CACJ;AAED,eAAe,QAAQ,CAAC"}

package/dist/parsing/functions/function_factory.d.ts

@@ -0,0 +1,174 @@
+import Function from "./function";
+import PredicateFunction from "./predicate_function";
+import "./sum";
+import "./collect";
+import "./avg";
+import "./range";
+import "./rand";
+import "./round";
+import "./split";
+import "./join";
+import "./to_json";
+import "./replace";
+import "./stringify";
+import "./size";
+import "./functions";
+import "./predicate_sum";
+import { FunctionMetadata, RegisterFunctionOptions, RegisterAsyncProviderOptions } from "./function_metadata";
+/**
+ * Type for synchronous function factories.
+ */
+export type FunctionCreator = () => Function;
+/**
+ * Type for async data provider functions used in LOAD operations.
+ * These functions can yield data asynchronously.
+ */
+export type AsyncDataProvider = (...args: any[]) => AsyncGenerator<any, void, unknown> | Promise<any>;
+/**
+ * Factory for creating function instances by name.
+ *
+ * Maps function names (case-insensitive) to their corresponding implementation classes.
+ * Supports built-in functions like sum, avg, collect, range, split, join, etc.
+ *
+ * @example
+ * ```typescript
+ * const sumFunc = FunctionFactory.create("sum");
+ * const avgFunc = FunctionFactory.create("AVG");
+ * ```
+ */
+declare class FunctionFactory {
+    /**
+     * Registry for plugin functions (synchronous).
+     */
+    private static plugins;
+    /**
+     * Registry for async data provider functions used in LOAD operations.
+     */
+    private static asyncProviders;
+    /**
+     * Registry for function metadata (both sync and async).
+     */
+    private static metadata;
+    /**
+     * Registers a synchronous plugin function.
+     *
+     * @param name - The function name (will be lowercased)
+     * @param factoryOrOptions - Factory function or options object with metadata
+     */
+    static register(name: string, factoryOrOptions: FunctionCreator | RegisterFunctionOptions): void;
+    /**
+     * Unregisters a synchronous plugin function.
+     *
+     * @param name - The function name to unregister
+     */
+    static unregister(name: string): void;
+    /**
+     * Registers an async data provider function for use in LOAD operations.
+     *
+     * @param name - The function name (will be lowercased)
+     * @param providerOrOptions - Async provider or options object with metadata
+     *
+     * @example
+     * ```typescript
+     * // Register with metadata for LLM consumption
+     * FunctionFactory.registerAsyncProvider("fetchUsers", {
+     *     provider: async function* (endpoint: string) {
+     *         const response = await fetch(endpoint);
+     *         const data = await response.json();
+     *         for (const item of data) {
+     *             yield item;
+     *         }
+     *     },
+     *     metadata: {
+     *         name: "fetchUsers",
+     *         description: "Fetches user data from an API endpoint",
+     *         parameters: [
+     *             { name: "endpoint", description: "API endpoint URL", type: "string" }
+     *         ],
+     *         output: {
+     *             description: "User objects",
+     *             type: "object",
+     *             properties: {
+     *                 id: { description: "User ID", type: "number" },
+     *                 name: { description: "User name", type: "string" }
+     *             }
+     *         },
+     *         examples: ["LOAD JSON FROM fetchUsers('https://api.example.com/users') AS user"]
+     *     }
+     * });
+     * ```
+     */
+    static registerAsyncProvider(name: string, providerOrOptions: AsyncDataProvider | RegisterAsyncProviderOptions): void;
+    /**
+     * Unregisters an async data provider function.
+     *
+     * @param name - The function name to unregister
+     */
+    static unregisterAsyncProvider(name: string): void;
+    /**
+     * Gets an async data provider by name.
+     *
+     * @param name - The function name (case-insensitive)
+     * @returns The async data provider, or undefined if not found
+     */
+    static getAsyncProvider(name: string): AsyncDataProvider | undefined;
+    /**
+     * Checks if a function name is registered as an async data provider.
+     *
+     * @param name - The function name (case-insensitive)
+     * @returns True if the function is an async data provider
+     */
+    static isAsyncProvider(name: string): boolean;
+    /**
+     * Gets metadata for a specific function.
+     *
+     * @param name - The function name (case-insensitive)
+     * @returns The function metadata, or undefined if not found
+     */
+    static getMetadata(name: string): FunctionMetadata | undefined;
+    /**
+     * Lists all registered functions with their metadata.
+     * Includes both built-in and plugin functions.
+     *
+     * @param options - Optional filter options
+     * @returns Array of function metadata
+     */
+    static listFunctions(options?: {
+        category?: string;
+        includeBuiltins?: boolean;
+        asyncOnly?: boolean;
+        syncOnly?: boolean;
+    }): FunctionMetadata[];
+    /**
+     * Lists all registered function names.
+     *
+     * @returns Array of function names
+     */
+    static listFunctionNames(): string[];
+    /**
+     * Gets all function metadata as a JSON-serializable object for LLM consumption.
+     *
+     * @returns Object with functions grouped by category
+     */
+    static toJSON(): {
+        functions: FunctionMetadata[];
+        categories: string[];
+    };
+    /**
+     * Creates a function instance by name.
+     *
+     * @param name - The function name (case-insensitive)
+     * @returns A Function instance of the appropriate type
+     */
+    static create(name: string): Function;
+    /**
+     * Creates a predicate function instance by name.
+     * Predicate functions are used in WHERE clauses with quantifiers (e.g., ANY, ALL).
+     *
+     * @param name - The function name (case-insensitive)
+     * @returns A PredicateFunction instance of the appropriate type
+     */
+    static createPredicate(name: string): PredicateFunction;
+}
+export default FunctionFactory;
+//# sourceMappingURL=function_factory.d.ts.map

package/dist/parsing/functions/function_factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function_factory.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/function_factory.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,iBAAiB,MAAM,sBAAsB,CAAC;AAErD,OAAO,OAAO,CAAC;AACf,OAAO,WAAW,CAAC;AACnB,OAAO,OAAO,CAAC;AACf,OAAO,SAAS,CAAC;AACjB,OAAO,QAAQ,CAAC;AAChB,OAAO,SAAS,CAAC;AACjB,OAAO,SAAS,CAAC;AACjB,OAAO,QAAQ,CAAC;AAChB,OAAO,WAAW,CAAC;AACnB,OAAO,WAAW,CAAC;AACnB,OAAO,aAAa,CAAC;AACrB,OAAO,QAAQ,CAAC;AAChB,OAAO,aAAa,CAAC;AACrB,OAAO,iBAAiB,CAAC;AACzB,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,4BAA4B,EAI/B,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAEtG;;;;;;;;;;;GAWG;AACH,cAAM,eAAe;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAA2C;IAEjE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc,CAA6C;IAE1E;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA4C;IAEnE;;;;;OAKG;WACW,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,GAAG,uBAAuB,GAAG,IAAI;IAcvG;;;;OAIG;WACW,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAM5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;WACW,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,4BAA4B,GAAG,IAAI;IAc5H;;;;OAIG;WACW,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMzD;;;;;OAKG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAI3E;;;;;OAKG;WACW,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIpD;;;;;OAKG;WACW,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAUrE;;;;;;OAMG;WACW,aAAa,CAAC,OAAO,CAAC,EAAE;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,GAAG,gBAAgB,EAAE;IAwBtB;;;;OAIG;WACW,iBAAiB,IAAI,MAAM,EAAE;IAO3C;;;;OAIG;WACW,MAAM,IAAI;QAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE;IAM/E;;;;;OAKG;WACW,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ;IAkB5C;;;;;;OAMG;WACW,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB;CAYjE;AAED,eAAe,eAAe,CAAC"}