Merge branch '3-dev' into remove-import-with

angrykoala · web-flow · commit 315de05d1112 · 2025-09-16T11:15:32.000+01:00
diff --git a/.changeset/all-signs-live.md b/.changeset/all-signs-live.md
@@ -0,0 +1,5 @@
+---
+"@neo4j/cypher-builder": major
+---
+
+Remove type `Cypher.Operation` in favor of `Cypher.Expr`
diff --git a/.changeset/floppy-llamas-teach.md b/.changeset/floppy-llamas-teach.md
@@ -0,0 +1,10 @@
+---
+"@neo4j/cypher-builder": major
+---
+
+Remove method `.children` from concat clauses:
+
+```js
+const query = Cypher.utils.concat(clause1, clause2);
+query.children; // No longer supported
+```
diff --git a/.changeset/thin-radios-poke.md b/.changeset/thin-radios-poke.md
@@ -0,0 +1,8 @@
+---
+"@neo4j/cypher-builder": major
+---
+
+Remove functions deprecated in Cypher 5:
+
+- `distance` in favor of `point.distance`
+- `id` in favor of `elementId`
diff --git a/.github/workflows/cla-assistant.yml b/.github/workflows/cla-assistant.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -25,7 +25,7 @@ jobs:
           fetch-depth: 0
           persist-credentials: false
 
-      - name: Setup Node.js 16.x
+      - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: lts/*
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,17 +2,17 @@ name: Test
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main", "*.x", "*-dev"]
   pull_request:
-    branches: ["main"]
+    branches: ["main", "*.x", "*-dev"]
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x, latest]
+        node-version: [20.x, latest]
 
     steps:
       - uses: actions/checkout@v5
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -55,3 +55,11 @@ export function abs(expr: Expr): CypherFunction {}
 
 - `tsdoc.json` Defines the tsdoc shcema
 - `typedoc.json` Configures the tool typedoc
+
+## Branches
+
+These are the branches conventions on the repo:
+
+- `main` The main branch, this is the latest release version
+- `*.x` The cutoff of an older major version (e.g. `2.x`)
+- `*-dev` development of a new major version
diff --git a/src/Cypher.ts b/src/Cypher.ts
@@ -190,7 +190,7 @@ export type { PathAssign } from "./pattern/PathAssign";
 export type { InputArgument } from "./procedures/CypherProcedure";
 export type { Yield, YieldProjectionColumn } from "./procedures/Yield";
 export type { Label } from "./references/Label";
-export type { CypherResult, Expr, NormalizationType, Operation, Predicate } from "./types";
+export type { CypherResult, Expr, NormalizationType, Predicate } from "./types";
 
 /**
  * Utility functions
diff --git a/src/clauses/utils/concat.ts b/src/clauses/utils/concat.ts
@@ -51,11 +51,6 @@ export class CompositeClause extends Clause {
         return this._children.length === 0;
     }
 
-    /** @deprecated Children from a composite clause should not be accessed as this will lead to unexpected behaviour */
-    public get children(): Array<CypherASTNode> {
-        return this._children;
-    }
-
     /** @internal */
     public getCypher(env: CypherEnvironment): string {
         // NOTE: importWithCypher used to pass down import WITH to UNION clauses
diff --git a/src/expressions/functions/scalar.test.ts b/src/expressions/functions/scalar.test.ts
@@ -31,7 +31,6 @@ describe("Scalar Functions", () => {
 
     // 1 parameter functions
     test.each([
-        "id",
         "elementId",
         "endNode",
         "size",
diff --git a/src/expressions/functions/scalar.ts b/src/expressions/functions/scalar.ts
@@ -58,16 +58,6 @@ export function head(expr: Expr): CypherFunction {
     return new CypherFunction("head", [expr]);
 }
 
-/**
- * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-id | Cypher Documentation}
- * @group Functions
- * @category Scalar
- * @deprecated Use {@link elementId} instead
- */
-export function id(variable: Expr): CypherFunction {
-    return new CypherFunction("id", [variable]);
-}
-
 /**
  * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-last | Cypher Documentation}
  * @group Functions
diff --git a/src/expressions/functions/spatial.test.ts b/src/expressions/functions/spatial.test.ts
@@ -17,23 +17,10 @@
  * limitations under the License.
  */
 
-import { TestClause } from "../../utils/TestClause";
 import Cypher from "../..";
+import { TestClause } from "../../utils/TestClause";
 
 describe("Spatial Functions", () => {
-    describe("4.x deprecated functions", () => {
-        test.each(["distance"] as const)("%s", (value) => {
-            const leftExpr = new Cypher.Variable();
-            const rightExpr = new Cypher.Variable();
-            const spatialFn = Cypher[value](leftExpr, rightExpr);
-
-            const queryResult = new TestClause(spatialFn).build();
-
-            expect(queryResult.cypher).toBe(`${value}(var0, var1)`);
-            expect(queryResult.params).toEqual({});
-        });
-    });
-
     test("point function", () => {
         const pointFn = Cypher.point(new Cypher.Variable());
 
diff --git a/src/expressions/functions/spatial.ts b/src/expressions/functions/spatial.ts
@@ -29,16 +29,6 @@ export function point(variable: Expr): CypherFunction {
     return new CypherFunction("point", [variable]);
 }
 
-/**
- * @see {@link https://neo4j.com/docs/cypher-manual/4.3/functions/spatial/#functions-distance | Cypher Documentation}
- * @group Functions
- * @category Spatial
- * @deprecated No longer supported in Neo4j 5. Use {@link point.distance} instead.
- */
-export function distance(lexpr: Expr, rexpr: Expr): CypherFunction {
-    return new CypherFunction("distance", [lexpr, rexpr]);
-}
-
 /**
  * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-distance | Cypher Documentation}
  * @group Functions
diff --git a/src/types.ts b/src/types.ts
@@ -41,12 +41,6 @@ import type { Literal } from "./references/Literal";
 import type { PropertyRef } from "./references/PropertyRef";
 import type { Variable } from "./references/Variable";
 
-/**
- * @group Expressions
- * @deprecated This type will no longer be exported, use {@link Expr} instead
- */
-export type Operation = BooleanOp | ComparisonOp | MathOp | ConcatOp;
-
 /** Represents a Cypher Expression
  * @group Expressions
  * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/ | Cypher Documentation}
diff --git a/tests/deprecated/concat.test.ts b/tests/deprecated/concat.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@neo4j/cypher-builder": major
 +---
++
 +Remove type `Cypher.Operation` in favor of `Cypher.Expr`