Merge pull request #574 from neo4j/support-25

Support for Cypher 25 prefix

Author: angrykoala

.changeset/blue-ends-relate.md

@@ -0,0 +1,11 @@
+---
+"@neo4j/cypher-builder": patch
+---
+
+Add support for `Cypher 25` version prefix:
+
+```js
+const { cypher } = matchQuery.build({
+    cypherVersion: "25",
+});
+```

src/clauses/Clause.ts

@@ -33,7 +33,7 @@ export type BuildConfig = Partial<{
     /** Will prefix generated queries with the Cypher version
      * @example `CYPHER 5`
      */
-    cypherVersion: "5";
+    cypherVersion: "5" | "25";
     /** Prefix variables with given string.
      *
      * This is useful to avoid name collisions if separate Cypher queries are generated and merged after generating the strings.

tests/build-config/cypher-version.test.ts

@@ -20,7 +20,7 @@
 import Cypher from "../../src";
 
 describe("Cypher version", () => {
-    test("Add cypher version on .build", () => {
+    test("Add cypher version 5 on .build", () => {
         const movieNode = new Cypher.Node();
         const pattern = new Cypher.Pattern(movieNode, { labels: ["Movie"] });
 
@@ -39,6 +39,28 @@ describe("Cypher version", () => {
 MATCH (this0:Movie)
 WHERE this0.title = $param0
 RETURN this0.title"
+`);
+    });
+
+    test("Add cypher version 25 on .build", () => {
+        const movieNode = new Cypher.Node();
+        const pattern = new Cypher.Pattern(movieNode, { labels: ["Movie"] });
+
+        const matchQuery = new Cypher.Match(pattern)
+            .where(movieNode, {
+                title: new Cypher.Param("The Matrix"),
+            })
+            .return(movieNode.property("title"));
+
+        const { cypher } = matchQuery.build({
+            cypherVersion: "25",
+        });
+
+        expect(cypher).toMatchInlineSnapshot(`
+"CYPHER 25
+MATCH (this0:Movie)
+WHERE this0.title = $param0
+RETURN this0.title"
 `);
     });
 });