flowquery 1.0.50 → 1.0.52

package/dist/compute/runner.d.ts

@@ -1,40 +1,75 @@
 import ASTNode from "../parsing/ast_node";
+/**
+ * Metadata about the operations performed by a Runner execution.
+ */
+export interface RunnerMetadata {
+    virtual_nodes_created: number;
+    virtual_relationships_created: number;
+    virtual_nodes_deleted: number;
+    virtual_relationships_deleted: number;
+}
 /**
  * Executes a FlowQuery statement and retrieves the results.
  *
  * The Runner class parses a FlowQuery statement into an AST and executes it,
  * managing the execution flow from the first operation to the final return statement.
  *
+ * Supports multi-statement queries separated by semicolons. Only CREATE and DELETE
+ * statements may appear before the last statement. If a retrieval statement is present,
+ * it must be the last statement.
+ *
  * @example
  * ```typescript
  * const runner = new Runner("WITH 1 as x RETURN x");
  * await runner.run();
  * console.log(runner.results); // [{ x: 1 }]
+ * console.log(runner.metadata); // { virtual_nodes_created: 0, ... }
  * ```
  */
 declare class Runner {
-    private first;
-    private last;
+    private _statements;
+    private _args;
+    private _metadata;
     /**
      * Creates a new Runner instance and parses the FlowQuery statement.
      *
-     * @param statement - The FlowQuery statement to execute
+     * @param statement - The FlowQuery statement to execute (may contain semicolon-separated statements)
+     * @param ast - An optional pre-parsed AST to use instead of parsing the statement
+     * @param args - Optional parameters to inject into $-prefixed parameter references
      * @throws {Error} If the statement is null, empty, or contains syntax errors
      */
-    constructor(statement?: string | null, ast?: ASTNode | null);
+    constructor(statement?: string | null, ast?: ASTNode | null, args?: Record<string, any> | null);
+    private static toStatement;
+    /**
+     * Walks all statement ASTs to count CREATE/DELETE operations for metadata.
+     */
+    private computeMetadata;
     /**
-     * Executes the parsed FlowQuery statement.
+     * Executes the parsed FlowQuery statement(s).
      *
      * @returns A promise that resolves when execution completes
      * @throws {Error} If an error occurs during execution
      */
     run(): Promise<void>;
+    /**
+     * Recursively walks the AST to bind ParameterReference nodes
+     * to the args provided to this Runner.
+     * - $args resolves to the entire args map (for use with $args.key lookups)
+     * - $name resolves to args["name"] (shorthand for individual properties)
+     */
+    private bindParameters;
     /**
      * Gets the results from the executed statement.
      *
      * @returns The results from the last operation (typically a RETURN statement)
      */
     get results(): any;
+    /**
+     * Gets metadata about the operations in this query.
+     *
+     * @returns Counts of virtual nodes/relationships created and deleted
+     */
+    get metadata(): RunnerMetadata;
 }
 export default Runner;
 //# sourceMappingURL=runner.d.ts.map

package/dist/compute/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/compute/runner.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAI1C;;;;;;;;;;;;GAYG;AACH,cAAM,MAAM;IACR,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,IAAI,CAAY;IAExB;;;;;OAKG;gBACS,SAAS,GAAE,MAAM,GAAG,IAAW,EAAE,GAAG,GAAE,OAAO,GAAG,IAAW;IASvE;;;;;OAKG;IACU,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAajC;;;;OAIG;IACH,IAAW,OAAO,IAAI,GAAG,CAExB;CACJ;AAED,eAAe,MAAM,CAAC"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/compute/runner.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAS1C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,6BAA6B,EAAE,MAAM,CAAC;IACtC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,6BAA6B,EAAE,MAAM,CAAC;CACzC;AAQD;;;;;;;;;;;;;;;;;GAiBG;AACH,cAAM,MAAM;IACR,OAAO,CAAC,WAAW,CAAoB;IACvC,OAAO,CAAC,KAAK,CAAoC;IACjD,OAAO,CAAC,SAAS,CAAiB;IAElC;;;;;;;OAOG;gBAEC,SAAS,GAAE,MAAM,GAAG,IAAW,EAC/B,GAAG,GAAE,OAAO,GAAG,IAAW,EAC1B,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAW;IAmB3C,OAAO,CAAC,MAAM,CAAC,WAAW;IAQ1B;;OAEG;IACH,OAAO,CAAC,eAAe;IAoBvB;;;;;OAKG;IACU,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBjC;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAetB;;;;OAIG;IACH,IAAW,OAAO,IAAI,GAAG,CAExB;IAED;;;;OAIG;IACH,IAAW,QAAQ,IAAI,cAAc,CAEpC;CACJ;AAED,eAAe,MAAM,CAAC"}

package/dist/compute/runner.js

@@ -12,6 +12,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const parameter_reference_1 = __importDefault(require("../parsing/expressions/parameter_reference"));
+const create_node_1 = __importDefault(require("../parsing/operations/create_node"));
+const create_relationship_1 = __importDefault(require("../parsing/operations/create_relationship"));
+const delete_node_1 = __importDefault(require("../parsing/operations/delete_node"));
+const delete_relationship_1 = __importDefault(require("../parsing/operations/delete_relationship"));
 const parser_1 = __importDefault(require("../parsing/parser"));
 /**
  * Executes a FlowQuery statement and retrieves the results.
@@ -19,30 +24,76 @@ const parser_1 = __importDefault(require("../parsing/parser"));
  * The Runner class parses a FlowQuery statement into an AST and executes it,
  * managing the execution flow from the first operation to the final return statement.
  *
+ * Supports multi-statement queries separated by semicolons. Only CREATE and DELETE
+ * statements may appear before the last statement. If a retrieval statement is present,
+ * it must be the last statement.
+ *
  * @example
  * ```typescript
  * const runner = new Runner("WITH 1 as x RETURN x");
  * await runner.run();
  * console.log(runner.results); // [{ x: 1 }]
+ * console.log(runner.metadata); // { virtual_nodes_created: 0, ... }
  * ```
  */
 class Runner {
     /**
      * Creates a new Runner instance and parses the FlowQuery statement.
      *
-     * @param statement - The FlowQuery statement to execute
+     * @param statement - The FlowQuery statement to execute (may contain semicolon-separated statements)
+     * @param ast - An optional pre-parsed AST to use instead of parsing the statement
+     * @param args - Optional parameters to inject into $-prefixed parameter references
      * @throws {Error} If the statement is null, empty, or contains syntax errors
      */
-    constructor(statement = null, ast = null) {
+    constructor(statement = null, ast = null, args = null) {
+        this._args = null;
         if ((statement === null || statement === "") && ast === null) {
             throw new Error("Either statement or AST must be provided");
         }
-        const _ast = ast !== null ? ast : new parser_1.default().parse(statement);
-        this.first = _ast.firstChild();
-        this.last = _ast.lastChild();
+        this._args = args;
+        if (ast !== null) {
+            this._statements = [Runner.toStatement(ast)];
+        }
+        else {
+            this._statements = Array.from(new parser_1.default().parseStatements(statement), Runner.toStatement);
+        }
+        this._metadata = this.computeMetadata();
+    }
+    static toStatement(ast) {
+        return {
+            ast,
+            first: ast.firstChild(),
+            last: ast.lastChild(),
+        };
     }
     /**
-     * Executes the parsed FlowQuery statement.
+     * Walks all statement ASTs to count CREATE/DELETE operations for metadata.
+     */
+    computeMetadata() {
+        const metadata = {
+            virtual_nodes_created: 0,
+            virtual_relationships_created: 0,
+            virtual_nodes_deleted: 0,
+            virtual_relationships_deleted: 0,
+        };
+        for (const stmt of this._statements) {
+            let op = stmt.first;
+            while (op !== null) {
+                if (op instanceof create_node_1.default)
+                    metadata.virtual_nodes_created++;
+                else if (op instanceof create_relationship_1.default)
+                    metadata.virtual_relationships_created++;
+                else if (op instanceof delete_node_1.default)
+                    metadata.virtual_nodes_deleted++;
+                else if (op instanceof delete_relationship_1.default)
+                    metadata.virtual_relationships_deleted++;
+                op = op.next;
+            }
+        }
+        return metadata;
+    }
+    /**
+     * Executes the parsed FlowQuery statement(s).
      *
      * @returns A promise that resolves when execution completes
      * @throws {Error} If an error occurs during execution
@@ -51,9 +102,12 @@ class Runner {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
                 try {
-                    yield this.first.initialize();
-                    yield this.first.run();
-                    yield this.first.finish();
+                    for (const stmt of this._statements) {
+                        this.bindParameters(stmt.ast);
+                        yield stmt.first.initialize();
+                        yield stmt.first.run();
+                        yield stmt.first.finish();
+                    }
                     resolve();
                 }
                 catch (e) {
@@ -62,13 +116,43 @@ class Runner {
             }));
         });
     }
+    /**
+     * Recursively walks the AST to bind ParameterReference nodes
+     * to the args provided to this Runner.
+     * - $args resolves to the entire args map (for use with $args.key lookups)
+     * - $name resolves to args["name"] (shorthand for individual properties)
+     */
+    bindParameters(node) {
+        var _a;
+        if (node instanceof parameter_reference_1.default) {
+            const args = (_a = this._args) !== null && _a !== void 0 ? _a : {};
+            const key = node.name.startsWith("$") ? node.name.substring(1) : node.name;
+            if (key === "args") {
+                node.parameterValue = args;
+            }
+            else {
+                node.parameterValue = key in args ? args[key] : null;
+            }
+        }
+        for (const child of node.getChildren()) {
+            this.bindParameters(child);
+        }
+    }
     /**
      * Gets the results from the executed statement.
      *
      * @returns The results from the last operation (typically a RETURN statement)
      */
     get results() {
-        return this.last.results;
+        return this._statements[this._statements.length - 1].last.results;
+    }
+    /**
+     * Gets metadata about the operations in this query.
+     *
+     * @returns Counts of virtual nodes/relationships created and deleted
+     */
+    get metadata() {
+        return Object.assign({}, this._metadata);
     }
 }
 exports.default = Runner;

package/dist/compute/runner.js.map

@@ -1 +1 @@
-{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../src/compute/runner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA,+DAAuC;AAEvC;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM;IAIR;;;;;OAKG;IACH,YAAY,YAA2B,IAAI,EAAE,MAAsB,IAAI;QACnE,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QACD,MAAM,IAAI,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAM,EAAE,CAAC,KAAK,CAAC,SAAU,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,EAAe,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,EAAe,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACU,GAAG;;YACZ,OAAO,IAAI,OAAO,CAAO,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC/C,IAAI,CAAC;oBACD,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;oBAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;oBACvB,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;oBAC1B,OAAO,EAAE,CAAC;gBACd,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,MAAM,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC;YACL,CAAC,CAAA,CAAC,CAAC;QACP,CAAC;KAAA;IAED;;;;OAIG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC7B,CAAC;CACJ;AAED,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../src/compute/runner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,qGAA4E;AAC5E,oFAA2D;AAC3D,oGAA2E;AAC3E,oFAA2D;AAC3D,oGAA2E;AAE3E,+DAAuC;AAkBvC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM;IAKR;;;;;;;OAOG;IACH,YACI,YAA2B,IAAI,EAC/B,MAAsB,IAAI,EAC1B,OAAmC,IAAI;QAdnC,UAAK,GAA+B,IAAI,CAAC;QAgB7C,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,IAAI,CACzB,IAAI,gBAAM,EAAE,CAAC,eAAe,CAAC,SAAU,CAAC,EACxC,MAAM,CAAC,WAAW,CACrB,CAAC;QACN,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,GAAY;QACnC,OAAO;YACH,GAAG;YACH,KAAK,EAAE,GAAG,CAAC,UAAU,EAAe;YACpC,IAAI,EAAE,GAAG,CAAC,SAAS,EAAe;SACrC,CAAC;IACN,CAAC;IAED;;OAEG;IACK,eAAe;QACnB,MAAM,QAAQ,GAAmB;YAC7B,qBAAqB,EAAE,CAAC;YACxB,6BAA6B,EAAE,CAAC;YAChC,qBAAqB,EAAE,CAAC;YACxB,6BAA6B,EAAE,CAAC;SACnC,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAClC,IAAI,EAAE,GAAqB,IAAI,CAAC,KAAK,CAAC;YACtC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;gBACjB,IAAI,EAAE,YAAY,qBAAU;oBAAE,QAAQ,CAAC,qBAAqB,EAAE,CAAC;qBAC1D,IAAI,EAAE,YAAY,6BAAkB;oBAAE,QAAQ,CAAC,6BAA6B,EAAE,CAAC;qBAC/E,IAAI,EAAE,YAAY,qBAAU;oBAAE,QAAQ,CAAC,qBAAqB,EAAE,CAAC;qBAC/D,IAAI,EAAE,YAAY,6BAAkB;oBAAE,QAAQ,CAAC,6BAA6B,EAAE,CAAC;gBACpF,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC;YACjB,CAAC;QACL,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACU,GAAG;;YACZ,OAAO,IAAI,OAAO,CAAO,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC/C,IAAI,CAAC;oBACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;wBAClC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;wBAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;wBACvB,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;oBAC9B,CAAC;oBACD,OAAO,EAAE,CAAC;gBACd,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,MAAM,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC;YACL,CAAC,CAAA,CAAC,CAAC;QACP,CAAC;KAAA;IAED;;;;;OAKG;IACK,cAAc,CAAC,IAAa;;QAChC,IAAI,IAAI,YAAY,6BAAkB,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3E,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,cAAc,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzD,CAAC;QACL,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACf,yBAAY,IAAI,CAAC,SAAS,EAAG;IACjC,CAAC;CACJ;AAED,kBAAe,MAAM,CAAC"}