@neo4j/cypher-builder 1.0.0

.changeset/afraid-points-happen.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/cypher-builder": major
+---
+
+Escape variable names if needed

.changeset/cold-singers-fetch.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/cypher-builder": major
+---
+
+Escape relationship types if needed

.changeset/funny-apes-tan.md

@@ -0,0 +1,11 @@
+---
+"@neo4j/cypher-builder": minor
+---
+
+Support for label expressions for nodes and relationships
+
+For example:
+
+```
+(:A&(B|C))
+```

.changeset/little-wombats-doubt.md

@@ -0,0 +1,8 @@
+---
+"@neo4j/cypher-builder": patch
+---
+
+Updates escape logic so names with numbers are not escaped unless they begin with a number:
+
+-   `this0` OK
+-   `0this` Should be escaped

.changeset/rotten-queens-play.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/cypher-builder": major
+---
+
+Escape properties in map projections

.changeset/rude-books-do.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/cypher-builder": patch
+---
+
+Only escape labels if needed

src/Cypher.ts

@@ -34,6 +34,7 @@ export { concat } from "./clauses/utils/concat";
 
 // Patterns
 export { Pattern } from "./pattern/Pattern";
+export { labelExpr } from "./expressions/labels/label-expressions";
 
 // Variables and references
 export { NodeRef as Node, NamedNode } from "./references/NodeRef";
@@ -118,8 +119,10 @@ export type { SetParam } from "./clauses/sub-clauses/Set";
 export type { PredicateFunction } from "./expressions/functions/predicate";
 export type { Order } from "./clauses/sub-clauses/OrderBy";
 export type { CompositeClause } from "./clauses/utils/concat";
+export type { LabelExpr, LabelOperator } from "./expressions/labels/label-expressions";
 export type { CypherAggregationFunction as AggregationFunction } from "./expressions/functions/aggregation";
 export type { HasLabel } from "./expressions/HasLabel";
+export type { InputArgument } from "./utils/normalize-variable";
 
 // utils
 export * as utils from "./utils/utils";

src/apoc/cypher/run-first-column.test.ts

@@ -28,7 +28,7 @@ describe("apoc.cypher", () => {
         const apocRunFirstColum = Cypher.apoc.cypher.runFirstColumnSingle(subquery, [node]);
         const queryResult = new TestClause(apocRunFirstColum).build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "apoc.cypher.runFirstColumnSingle(\\"MATCH (this0:\`Movie\`)
+            "apoc.cypher.runFirstColumnSingle(\\"MATCH (this0:Movie)
             RETURN this0\\", { this0: this0 })"
         `);
 
@@ -42,7 +42,7 @@ describe("apoc.cypher", () => {
         const apocRunFirstColum = Cypher.apoc.cypher.runFirstColumnMany(subquery, [node]);
         const queryResult = new TestClause(apocRunFirstColum).build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "apoc.cypher.runFirstColumnMany(\\"MATCH (this0:\`Movie\`)
+            "apoc.cypher.runFirstColumnMany(\\"MATCH (this0:Movie)
             RETURN this0\\", { this0: this0 })"
         `);
 
@@ -104,13 +104,13 @@ describe("apoc.cypher", () => {
         const cypherResult = topQuery.build();
 
         expect(cypherResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
-                WHERE this0.title = $param0
-                RETURN { result: apoc.cypher.runFirstColumnMany(\\"MATCH (this0)
-                SET
-                    this0.released = $param1
-                RETURN this0\\", { this0: this0, param1: $param1 }) }"
-            `);
+            "MATCH (this0:Movie)
+            WHERE this0.title = $param0
+            RETURN { result: apoc.cypher.runFirstColumnMany(\\"MATCH (this0)
+            SET
+                this0.released = $param1
+            RETURN this0\\", { this0: this0, param1: $param1 }) }"
+        `);
         expect(cypherResult.params).toMatchInlineSnapshot(`
             {
               "param0": "The Matrix",

src/apoc/util.test.ts

@@ -44,7 +44,7 @@ describe("apoc.util", () => {
 
             const { cypher, params } = query.build();
             expect(cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE apoc.util.validatePredicate(1 = 2, \\"That's not how math works\\", [0])
                 RETURN this0"
             `);

src/clauses/Call.test.ts

@@ -30,7 +30,7 @@ describe("CypherBuilder Call", () => {
         const queryResult = new Cypher.Call(createQuery).build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
-                CREATE (this0:\`Movie\`)
+                CREATE (this0:Movie)
                 SET
                     this0.id = $param0
                 RETURN this0
@@ -57,7 +57,7 @@ describe("CypherBuilder Call", () => {
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
                 CALL {
-                    CREATE (this0:\`Movie\`)
+                    CREATE (this0:Movie)
                     SET
                         this0.id = $param0
                     RETURN this0
@@ -83,7 +83,7 @@ describe("CypherBuilder Call", () => {
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
                 WITH this0
-                MATCH (this0:\`Movie\`)
+                MATCH (this0:Movie)
                 WHERE $param0 = $param1
                 RETURN this0.title AS movie
             }"
@@ -121,7 +121,7 @@ describe("CypherBuilder Call", () => {
         const queryResult = clause.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
-                MATCH (this0:\`Movie\`)
+                MATCH (this0:Movie)
                 WHERE $param0 = $param1
                 RETURN this0.title AS movie
             }
@@ -146,7 +146,7 @@ describe("CypherBuilder Call", () => {
         const queryResult = clause.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
-                MATCH (this0:\`Movie\`)
+                MATCH (this0:Movie)
                 WHERE $param0 = $param1
                 RETURN this0.title AS movie
             }
@@ -174,7 +174,7 @@ describe("CypherBuilder Call", () => {
 
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
-                MATCH (this0:\`Movie\`)
+                MATCH (this0:Movie)
                 WHERE $param0 = $param1
                 RETURN this0.title AS var1
             }
@@ -204,7 +204,7 @@ describe("CypherBuilder Call", () => {
 
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "CALL {
-                MATCH (this0:\`Movie\`)
+                MATCH (this0:Movie)
                 WHERE $param0 = $param1
                 RETURN this0.title AS var1
             }

src/clauses/Create.test.ts

@@ -40,21 +40,21 @@ describe("CypherBuilder Create", () => {
 
         const queryResult = createQuery.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "CREATE (this0:\`Movie\` { test: $param0, id: $param1 })
+            "CREATE (this0:Movie { test: $param0, id: $param1 })
             SET
                 this0.title = $param2,
                 this0.runtime = $param3
             RETURN this0"
         `);
 
         expect(queryResult.params).toMatchInlineSnapshot(`
-{
-  "param0": "test-value",
-  "param1": "my-id",
-  "param2": "The Matrix",
-  "param3": 120,
-}
-`);
+            {
+              "param0": "test-value",
+              "param1": "my-id",
+              "param2": "The Matrix",
+              "param3": 120,
+            }
+        `);
     });
 
     test("Create Node with null property", () => {
@@ -76,18 +76,18 @@ describe("CypherBuilder Create", () => {
 
         const queryResult = createQuery.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "CREATE (this0:\`Movie\` { id: NULL })
+            "CREATE (this0:Movie { id: NULL })
             SET
                 this0.test = NULL,
                 this0.nullStr = $param0
             RETURN this0"
         `);
 
         expect(queryResult.params).toMatchInlineSnapshot(`
-{
-  "param0": "null",
-}
-`);
+            {
+              "param0": "null",
+            }
+        `);
     });
 
     test("Create Node with null property and assign path variable", () => {
@@ -110,17 +110,17 @@ describe("CypherBuilder Create", () => {
 
         const queryResult = createQuery.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "CREATE p0 = (this1:\`Movie\` { id: NULL })
+            "CREATE p0 = (this1:Movie { id: NULL })
             SET
                 this1.test = NULL,
                 this1.nullStr = $param0
             RETURN this1"
         `);
 
         expect(queryResult.params).toMatchInlineSnapshot(`
-{
-  "param0": "null",
-}
-`);
+            {
+              "param0": "null",
+            }
+        `);
     });
 });

src/clauses/Foreach.test.ts

@@ -32,7 +32,7 @@ describe("Foreach", () => {
         const queryResult = foreachClause.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
             "FOREACH (var0 IN [1, 2, 3] |
-                CREATE (this1:\`Movie\`)
+                CREATE (this1:Movie)
                 SET
                     this1.id = var0
             )

src/clauses/Match.test.ts

@@ -32,7 +32,7 @@ describe("CypherBuilder Match", () => {
         );
 
         const queryResult = matchQuery.build();
-        expect(queryResult.cypher).toMatchInlineSnapshot(`"MATCH (this0:\`Movie\` { test: $param0 })"`);
+        expect(queryResult.cypher).toMatchInlineSnapshot(`"MATCH (this0:Movie { test: $param0 })"`);
 
         expect(queryResult.params).toMatchInlineSnapshot(`
             {
@@ -52,7 +52,7 @@ describe("CypherBuilder Match", () => {
 
         const queryResult = matchQuery.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "MATCH (this0:\`Movie\`)
+            "MATCH (this0:Movie)
             RETURN this0"
         `);
 
@@ -74,7 +74,7 @@ describe("CypherBuilder Match", () => {
 
         const queryResult = matchQuery.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "MATCH (this0:\`Movie\`)
+            "MATCH (this0:Movie)
             WHERE (this0.id = $param0 AND this0.name = $param1)
             REMOVE this0.name
             RETURN this0.id"
@@ -100,7 +100,7 @@ describe("CypherBuilder Match", () => {
 
         const queryResult = matchQuery.build();
         expect(queryResult.cypher).toMatchInlineSnapshot(`
-            "OPTIONAL MATCH (this0:\`Movie\` { test: $param0 })
+            "OPTIONAL MATCH (this0:Movie { test: $param0 })
             RETURN this0"
         `);
 
@@ -140,8 +140,8 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = query.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH my-path = (this0)-[this1:ACTED_IN]->(this2)
-                RETURN my-path"
+                "MATCH \`my-path\` = (this0)-[this1:ACTED_IN]->(this2)
+                RETURN \`my-path\`"
             `);
             expect(queryResult.params).toMatchInlineSnapshot(`{}`);
         });
@@ -167,7 +167,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\` { test: $param0 })
+                "MATCH (this0:Movie { test: $param0 })
                 WHERE ((this0.id = $param1 AND this0.name = $param2) AND this0.age = $param3)
                 RETURN this0"
             `);
@@ -200,7 +200,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\` { test: $param0 })
+                "MATCH (this0:Movie { test: $param0 })
                 WHERE (this0.id = $param1 AND this0.name = $param2)
                 RETURN this0.name AS myAlias"
             `);
@@ -231,7 +231,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\` { test: NULL })
+                "MATCH (this0:Movie { test: NULL })
                 WHERE this0.name IS NULL
                 RETURN this0"
             `);
@@ -254,7 +254,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = clause.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE (($param0 > $param1 OR $param0 < $param2) AND $param3 = $param4)
                 RETURN this0.title AS movie"
             `);
@@ -279,7 +279,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = queryMatch.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE NOT (this0.title = $param0)"
             `);
 
@@ -303,7 +303,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE NOT (this0.name = $param0)
                 RETURN this0"
             `);
@@ -336,7 +336,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE NOT (this0.age = $param0 OR this0.name = $param1)
                 RETURN this0"
             `);
@@ -366,7 +366,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Person\`)
+                "MATCH (this0:Person)
                 WHERE this0.name = $param0
                 SET
                     this0.name = $param1
@@ -398,7 +398,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE (this0.id = $param0 AND this0.name = $param1)
                 DELETE this0
                 RETURN 5"
@@ -426,7 +426,7 @@ describe("CypherBuilder Match", () => {
 
             const queryResult = matchQuery.build();
             expect(queryResult.cypher).toMatchInlineSnapshot(`
-                "MATCH (this0:\`Movie\`)
+                "MATCH (this0:Movie)
                 WHERE (this0.id = $param0 AND this0.name = $param1)
                 DETACH DELETE this0"
             `);