@neo4j/cypher-builder - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

dist/apoc/apoc.d.ts

 export { RunFirstColumn } from "./functions/RunFirstColumn";
-export { ValidatePredicate } from "./functions/ValidatePredicate";
-export { Validate } from "./procedures/Validate";
-export * as date from "./functions/date";
+export * as date from "./date";
+export * as util from "./util";
 //# sourceMappingURL=apoc.d.ts.map

dist/apoc/apoc.js

@@ -44,10 +44,7 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.date = exports.Validate = exports.ValidatePredicate = exports.RunFirstColumn = void 0;
+exports.util = exports.date = exports.RunFirstColumn = void 0;
 var RunFirstColumn_1 = require("./functions/RunFirstColumn");
 Object.defineProperty(exports, "RunFirstColumn", { enumerable: true, get: function () { return RunFirstColumn_1.RunFirstColumn; } });
-var ValidatePredicate_1 = require("./functions/ValidatePredicate");
-Object.defineProperty(exports, "ValidatePredicate", { enumerable: true, get: function () { return ValidatePredicate_1.ValidatePredicate; } });
-var Validate_1 = require("./procedures/Validate");
-Object.defineProperty(exports, "Validate", { enumerable: true, get: function () { return Validate_1.Validate; } });
-exports.date = __importStar(require("./functions/date"));
+exports.date = __importStar(require("./date"));
+exports.util = __importStar(require("./util"));
 //# sourceMappingURL=apoc.js.map

dist/apoc/functions/RunFirstColumn.d.ts

@@ -15,2 +15,3 @@ import { CypherASTNode } from "../../CypherASTNode";
     constructor(clause: Clause | string, variables?: Variable[] | MapExpr, expectMultipleValues?: boolean);
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -17,0 +18,0 @@ private escapeQuery;

dist/apoc/functions/RunFirstColumn.js

@@ -23,2 +23,3 @@ "use strict";
 const CypherASTNode_1 = require("../../CypherASTNode");
+// TODO: convert into proper function
 /**
@@ -35,2 +36,3 @@ * @group Expressions
     }
+    /** @internal */
     getCypher(env) {
@@ -37,0 +39,0 @@ let clauseStr;

dist/apoc/types.d.ts

@@ -1,8 +0,3 @@
-import type { ConvertFormat } from "./functions/convert-format";
 import type { RunFirstColumn } from "./functions/RunFirstColumn";
-import type { ValidatePredicate } from "./functions/ValidatePredicate";
-import type { Validate } from "./procedures/Validate";
-export type ApocPredicate = ValidatePredicate;
-export type ApocFunction = ApocPredicate | RunFirstColumn | ConvertFormat;
-export type ApocProcedure = Validate;
+export type ApocFunction = RunFirstColumn;
 //# sourceMappingURL=types.d.ts.map

dist/clauses/Call.d.ts

@@ -18,7 +18,5 @@ import type { CypherEnvironment } from "../Environment";
     innerWith(...params: Variable[]): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Call.d.ts.map

dist/clauses/Call.js

@@ -54,5 +54,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -59,0 +57,0 @@ const subQueryStr = this.subQuery.getCypher(env);

dist/clauses/Clause.d.ts

 import { CypherASTNode } from "../CypherASTNode";
-import { EnvPrefix } from "../Environment";
+import type { EnvPrefix } from "../Environment";
 import type { CypherResult } from "../types";
@@ -4,0 +4,0 @@ declare const customInspectSymbol: unique symbol;

dist/clauses/Create.d.ts

@@ -7,3 +7,4 @@ import type { CypherEnvironment } from "../Environment";
 import { WithSet } from "./mixins/WithSet";
-export interface Create extends WithReturn, WithSet {
+import { WithPathAssign } from "./mixins/WithPathAssign";
+export interface Create extends WithReturn, WithSet, WithPathAssign {
 }
@@ -17,7 +18,5 @@ /**
     constructor(pattern: NodeRef | Pattern);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Create.d.ts.map

dist/clauses/Create.js

@@ -35,2 +35,3 @@ "use strict";
 const WithSet_1 = require("./mixins/WithSet");
+const WithPathAssign_1 = require("./mixins/WithPathAssign");
 /**
@@ -51,16 +52,15 @@ * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/)
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
-        const nodeCypher = this.pattern.getCypher(env);
+        const pathCypher = this.compilePath(env);
+        const patternCypher = this.pattern.getCypher(env);
         const setCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.setSubClause, env, { prefix: "\n" });
         const returnCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.returnStatement, env, { prefix: "\n" });
-        return `CREATE ${nodeCypher}${setCypher}${returnCypher}`;
+        return `CREATE ${pathCypher}${patternCypher}${setCypher}${returnCypher}`;
     }
 };
 Create = __decorate([
-    (0, mixin_1.mixin)(WithReturn_1.WithReturn, WithSet_1.WithSet)
+    (0, mixin_1.mixin)(WithReturn_1.WithReturn, WithSet_1.WithSet, WithPathAssign_1.WithPathAssign)
 ], Create);
 exports.Create = Create;
 //# sourceMappingURL=Create.js.map

dist/clauses/Foreach.d.ts

@@ -23,5 +23,3 @@ import type { CypherEnvironment } from "../Environment";
     constructor(variable: Variable, listExpr: Expr, mapClause: ForeachClauses);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -28,0 +26,0 @@ }

dist/clauses/Foreach.js

@@ -44,5 +44,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -49,0 +47,0 @@ const variableStr = this.variable.getCypher(env);

dist/clauses/Match.d.ts

@@ -7,7 +7,8 @@ import { Pattern } from "../pattern/Pattern";
 import { WithWith } from "./mixins/WithWith";
-import { DeleteInput } from "./sub-clauses/Delete";
+import { WithPathAssign } from "./mixins/WithPathAssign";
+import type { DeleteInput } from "./sub-clauses/Delete";
 import type { PropertyRef } from "../references/PropertyRef";
 import type { CypherEnvironment } from "../Environment";
 import type { NodeRef } from "../references/NodeRef";
-export interface Match extends WithReturn, WithWhere, WithSet, WithWith {
+export interface Match extends WithReturn, WithWhere, WithSet, WithWith, WithPathAssign {
 }
@@ -45,5 +46,3 @@ /**
     optional(): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -50,0 +49,0 @@ private createDeleteClause;

dist/clauses/Match.js

@@ -36,2 +36,3 @@ "use strict";
 const WithWith_1 = require("./mixins/WithWith");
+const WithPathAssign_1 = require("./mixins/WithPathAssign");
 const Delete_1 = require("./sub-clauses/Delete");
@@ -88,7 +89,6 @@ const Remove_1 = require("./sub-clauses/Remove");
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
-        const nodeCypher = this.pattern.getCypher(env);
+        const pathAssignStr = this.compilePath(env);
+        const patternCypher = this.pattern.getCypher(env);
         const whereCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.whereSubClause, env, { prefix: "\n" });
@@ -101,3 +101,3 @@ const returnCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.returnStatement, env, { prefix: "\n" });
         const optionalMatch = this._optional ? "OPTIONAL " : "";
-        return `${optionalMatch}MATCH ${nodeCypher}${whereCypher}${setCypher}${removeCypher}${deleteCypher}${withCypher}${returnCypher}`;
+        return `${optionalMatch}MATCH ${pathAssignStr}${patternCypher}${whereCypher}${setCypher}${removeCypher}${deleteCypher}${withCypher}${returnCypher}`;
     }
@@ -110,3 +110,3 @@ createDeleteClause(deleteInput) {
 Match = __decorate([
-    (0, mixin_1.mixin)(WithReturn_1.WithReturn, WithWhere_1.WithWhere, WithSet_1.WithSet, WithWith_1.WithWith)
+    (0, mixin_1.mixin)(WithReturn_1.WithReturn, WithWhere_1.WithWhere, WithSet_1.WithSet, WithWith_1.WithWith, WithPathAssign_1.WithPathAssign)
 ], Match);
@@ -113,0 +113,0 @@ exports.Match = Match;

dist/clauses/Merge.d.ts

 import type { CypherEnvironment } from "../Environment";
 import { Pattern } from "../pattern/Pattern";
 import { Clause } from "./Clause";
-import { OnCreateParam } from "./sub-clauses/OnCreate";
+import type { OnCreateParam } from "./sub-clauses/OnCreate";
 import { WithReturn } from "./mixins/WithReturn";
 import { WithSet } from "./mixins/WithSet";
 import type { NodeRef } from "../references/NodeRef";
-export interface Merge extends WithReturn, WithSet {
+import { WithPathAssign } from "./mixins/WithPathAssign";
+export interface Merge extends WithReturn, WithSet, WithPathAssign {
 }
@@ -19,7 +20,5 @@ /**
     onCreate(...onCreateParams: OnCreateParam[]): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Merge.d.ts.map

dist/clauses/Merge.js

@@ -35,2 +35,3 @@ "use strict";
 const compile_cypher_if_exists_1 = require("../utils/compile-cypher-if-exists");
+const WithPathAssign_1 = require("./mixins/WithPathAssign");
 /**
@@ -55,7 +56,6 @@ * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/)
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
-        const mergeStr = `MERGE ${this.pattern.getCypher(env)}`;
+        const pathAssignStr = this.compilePath(env);
+        const mergeStr = `MERGE ${pathAssignStr}${this.pattern.getCypher(env)}`;
         const setCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.setSubClause, env, { prefix: "\n" });
@@ -68,5 +68,5 @@ const onCreateStr = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.onCreateClause, env, { prefix: "\n" });
 Merge = __decorate([
-    (0, mixin_1.mixin)(WithReturn_1.WithReturn, WithSet_1.WithSet)
+    (0, mixin_1.mixin)(WithReturn_1.WithReturn, WithSet_1.WithSet, WithPathAssign_1.WithPathAssign)
 ], Merge);
 exports.Merge = Merge;
 //# sourceMappingURL=Merge.js.map

dist/clauses/mixins/WithOrder.d.ts

@@ -1,2 +0,3 @@
-import { Order, OrderBy } from "../sub-clauses/OrderBy";
+import type { Order } from "../sub-clauses/OrderBy";
+import { OrderBy } from "../sub-clauses/OrderBy";
 import { ClauseMixin } from "./ClauseMixin";
@@ -3,0 +4,0 @@ import type { Expr } from "../../types";

dist/clauses/mixins/WithSet.d.ts

@@ -1,2 +0,3 @@
-import { SetClause, SetParam } from "../sub-clauses/Set";
+import type { SetParam } from "../sub-clauses/Set";
+import { SetClause } from "../sub-clauses/Set";
 import { ClauseMixin } from "./ClauseMixin";
@@ -3,0 +4,0 @@ export declare abstract class WithSet extends ClauseMixin {

dist/clauses/mixins/WithWith.d.ts

 import { ClauseMixin } from "./ClauseMixin";
-import { With, WithProjection } from "../With";
+import type { WithProjection } from "../With";
+import { With } from "../With";
 export declare abstract class WithWith extends ClauseMixin {
@@ -4,0 +5,0 @@ protected withStatement: With | undefined;

dist/clauses/Return.d.ts

 import { WithOrder } from "./mixins/WithOrder";
-import { ProjectionColumn } from "./sub-clauses/Projection";
+import type { ProjectionColumn } from "./sub-clauses/Projection";
 import type { CypherEnvironment } from "../Environment";
@@ -17,7 +17,5 @@ import { Clause } from "./Clause";
     distinct(): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Return.d.ts.map

dist/clauses/Return.js

@@ -51,5 +51,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -56,0 +54,0 @@ const projectionStr = this.projection.getCypher(env);

dist/clauses/sub-clauses/Delete.d.ts

@@ -11,4 +11,5 @@ import { CypherASTNode } from "../../CypherASTNode";
     detach(): void;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Delete.d.ts.map

dist/clauses/sub-clauses/Delete.js

@@ -32,2 +32,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -34,0 +35,0 @@ const itemsToDelete = this.deleteInput.map((e) => e.getCypher(env));

dist/clauses/sub-clauses/ImportWith.d.ts

@@ -12,4 +12,5 @@ import type { Call } from "../Call";
     constructor(parent: Call, params?: Variable[]);
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=ImportWith.d.ts.map

dist/clauses/sub-clauses/ImportWith.js

@@ -29,2 +29,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -31,0 +32,0 @@ const paramsStr = this.params.map((v) => v.getCypher(env));

dist/clauses/sub-clauses/OnCreate.d.ts

 import type { CypherEnvironment } from "../../Environment";
-import { SetClause, SetParam } from "./Set";
+import type { SetParam } from "./Set";
+import { SetClause } from "./Set";
 export type OnCreateParam = SetParam;
 export declare class OnCreate extends SetClause {
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=OnCreate.d.ts.map

dist/clauses/sub-clauses/OnCreate.js

@@ -24,2 +24,3 @@ "use strict";
 class OnCreate extends Set_1.SetClause {
+    /** @internal */
     getCypher(env) {
@@ -26,0 +27,0 @@ if (this.params.length === 0)

dist/clauses/sub-clauses/OrderBy.d.ts

@@ -17,2 +17,3 @@ import type { CypherEnvironment } from "../../Environment";
     private hasOrder;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -19,0 +20,0 @@ }

dist/clauses/sub-clauses/OrderBy.js

@@ -44,2 +44,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -46,0 +47,0 @@ let orderStr = "";

dist/clauses/sub-clauses/Projection.d.ts

@@ -12,2 +12,3 @@ import type { CypherEnvironment } from "../../Environment";
     addColumns(columns: Array<"*" | ProjectionColumn>): void;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -14,0 +15,0 @@ private serializeColumn;

dist/clauses/sub-clauses/Projection.js

@@ -40,2 +40,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -42,0 +43,0 @@ let columnsStrs = this.columns.map((column) => {

dist/clauses/sub-clauses/Remove.d.ts

@@ -8,4 +8,5 @@ import { CypherASTNode } from "../../CypherASTNode";
     constructor(parent: CypherASTNode | undefined, removeInput: RemoveInput);
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Remove.d.ts.map

dist/clauses/sub-clauses/Remove.js

@@ -28,2 +28,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -30,0 +31,0 @@ const propertiesToDelete = this.removeInput.map((e) => e.getCypher(env));

dist/clauses/sub-clauses/Set.d.ts

@@ -12,2 +12,3 @@ import { CypherASTNode } from "../../CypherASTNode";
     addParams(...params: SetParam[]): void;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -14,0 +15,0 @@ private composeParam;

dist/clauses/sub-clauses/Set.js

@@ -32,2 +32,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -34,0 +35,0 @@ if (this.params.length === 0)

dist/clauses/sub-clauses/Where.d.ts

@@ -9,4 +9,5 @@ import { CypherASTNode } from "../../CypherASTNode";
     and(op: Predicate): void;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Where.d.ts.map

dist/clauses/sub-clauses/Where.js

@@ -35,2 +35,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -37,0 +38,0 @@ const opStr = this.wherePredicate.getCypher(env);

dist/clauses/Union.d.ts

@@ -12,7 +12,5 @@ import type { CypherEnvironment } from "../Environment";
     all(): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Union.d.ts.map

dist/clauses/Union.js

@@ -39,5 +39,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -44,0 +42,0 @@ const subqueriesStr = this.subqueries.map((s) => s.getCypher(env));

dist/clauses/Unwind.d.ts

 import type { CypherEnvironment } from "../Environment";
-import { ProjectionColumn } from "./sub-clauses/Projection";
+import type { ProjectionColumn } from "./sub-clauses/Projection";
 import { Clause } from "./Clause";
@@ -15,7 +15,5 @@ import { WithWith } from "./mixins/WithWith";
     addColumns(...columns: Array<"*" | ProjectionColumn>): void;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Unwind.d.ts.map

dist/clauses/Unwind.js

@@ -45,5 +45,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -50,0 +48,0 @@ const projectionStr = this.projection.getCypher(env);

dist/clauses/utils/concat.d.ts

@@ -0,1 +1,2 @@
+import type { CypherASTNode } from "../../CypherASTNode";
 import type { CypherEnvironment } from "../../Environment";
@@ -8,3 +9,3 @@ import { Clause } from "../Clause";
     private separator;
-    private children;
+    private _children;
     /**
@@ -16,6 +17,8 @@ * @hidden
     get empty(): boolean;
-    /**
-     * @hidden
-     */
+    get children(): Array<CypherASTNode>;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
+    private filterClauses;
+    private filterEmptyComposite;
+    private unwrapComposite;
 }
@@ -22,0 +25,0 @@ /** Concatenates multiple {@link Clause | clauses} into a single clause

dist/clauses/utils/concat.js

@@ -34,21 +34,45 @@ "use strict";
         this.separator = separator;
-        this.children = [];
+        this._children = [];
         this.concat(...children);
     }
     concat(...clauses) {
-        const childrenRoots = (0, filter_truthy_1.filterTruthy)(clauses).map((c) => c.getRoot());
-        this.addChildren(...childrenRoots);
-        this.children = [...this.children, ...childrenRoots];
+        const filteredChildren = this.filterClauses(clauses);
+        this.addChildren(...filteredChildren);
+        this._children = [...this._children, ...filteredChildren];
         return this;
     }
     get empty() {
-        return this.children.length === 0;
+        return this._children.length === 0;
     }
-    /**
-     * @hidden
-     */
+    get children() {
+        return this._children;
+    }
+    /** @internal */
     getCypher(env) {
-        const childrenStrs = this.children.map((c) => c.getCypher(env));
+        const childrenStrs = this._children.map((c) => c.getCypher(env));
         return childrenStrs.join(this.separator);
     }
+    filterClauses(clauses) {
+        const childrenRoots = (0, filter_truthy_1.filterTruthy)(clauses).map((c) => c.getRoot());
+        return this.filterEmptyComposite(childrenRoots).map((c) => {
+            if (c instanceof CompositeClause) {
+                return this.unwrapComposite(c);
+            }
+            return c;
+        });
+    }
+    filterEmptyComposite(children) {
+        return children.filter((c) => {
+            if (c instanceof CompositeClause && c.empty)
+                return false;
+            return true;
+        });
+    }
+    unwrapComposite(clause) {
+        if (clause.children.length === 1) {
+            return clause.children[0];
+        }
+        else
+            return clause;
+    }
 }
@@ -55,0 +79,0 @@ exports.CompositeClause = CompositeClause;

dist/clauses/With.d.ts

@@ -23,5 +23,3 @@ import type { CypherEnvironment } from "../Environment";
     distinct(): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -28,0 +26,0 @@ with(...columns: ("*" | WithProjection)[]): With;

dist/clauses/With.js

@@ -54,5 +54,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -59,0 +57,0 @@ const projectionStr = this.projection.getCypher(env);

dist/Cypher.d.ts

@@ -5,3 +5,3 @@ export { Match, OptionalMatch } from "./clauses/Match";
 export { Call } from "./clauses/Call";
-export { CallProcedure } from "./clauses/CallProcedure";
+export { Use } from "./clauses/Use";
 export { Return } from "./clauses/Return";
@@ -20,5 +20,5 @@ export { RawCypher } from "./clauses/RawCypher";
 export { Literal, CypherNull as Null } from "./references/Literal";
+export { Path, NamedPath } from "./references/Path";
 export { Exists } from "./expressions/Exists";
 export { Case } from "./expressions/Case";
-export * as db from "./procedures/db";
 export * as apoc from "./apoc/apoc";
@@ -31,10 +31,14 @@ export { ListComprehension } from "./expressions/list/ListComprehension";
 export { or, and, not, xor } from "./expressions/operations/boolean";
-export { eq, gt, gte, lt, lte, isNull, isNotNull, inOp as in, contains, startsWith, endsWith, matches } from "./expressions/operations/comparison";
+export { eq, gt, gte, lt, lte, isNull, isNotNull, inOp as in, contains, startsWith, endsWith, matches, } from "./expressions/operations/comparison";
 export { plus, minus } from "./expressions/operations/math";
 export { CypherFunction as Function } from "./expressions/functions/CypherFunctions";
-export { coalesce, point, distance, pointDistance, labels, count, min, max, avg, sum, randomUUID, id, elementId } from "./expressions/functions/CypherFunctions";
-export { cypherDatetime as datetime, cypherDate as date, cypherLocalTime as localtime, cypherLocalDatetime as localdatetime, cypherTime as time } from "./expressions/functions/TemporalFunctions";
+export { coalesce, point, distance, pointDistance, labels, randomUUID, id, elementId, } from "./expressions/functions/CypherFunctions";
+export { count, min, max, avg, sum, collect } from "./expressions/functions/AggregationFunctions";
+export { cypherDatetime as datetime, cypherDate as date, cypherLocalTime as localtime, cypherLocalDatetime as localdatetime, cypherTime as time, } from "./expressions/functions/TemporalFunctions";
 export * from "./expressions/functions/StringFunctions";
 export * from "./expressions/functions/ListFunctions";
+export * from "./expressions/functions/PathFunctions";
 export { any, all, exists, single } from "./expressions/functions/PredicateFunctions";
+export { CypherProcedure as Procedure, VoidCypherProcedure as VoidProcedure } from "./procedures/CypherProcedure";
+export * as db from "./procedures/db";
 export type { CypherResult } from "./types";
@@ -46,3 +50,4 @@ export type { PropertyRef } from "./references/PropertyRef";
 export type { BooleanOp } from "./expressions/operations/boolean";
-export type { Expr, Predicate, Operation, Procedure } from "./types";
+export type { Expr, Predicate, Operation } from "./types";
+export type { Yield } from "./procedures/Yield";
 export type { ProjectionColumn } from "./clauses/sub-clauses/Projection";
@@ -53,3 +58,4 @@ export type { SetParam } from "./clauses/sub-clauses/Set";
 export type { CompositeClause } from "./clauses/utils/concat";
+export type { CypherAggregationFunction as AggregationFunction } from "./expressions/functions/AggregationFunctions";
 export * as utils from "./utils/utils";
 //# sourceMappingURL=Cypher.d.ts.map

dist/Cypher.js

@@ -47,4 +47,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.minus = exports.plus = exports.matches = exports.endsWith = exports.startsWith = exports.contains = exports.in = exports.isNotNull = exports.isNull = exports.lte = exports.lt = exports.gte = exports.gt = exports.eq = exports.xor = exports.not = exports.and = exports.or = exports.MapProjection = exports.Map = exports.List = exports.PatternComprehension = exports.ListComprehension = exports.apoc = exports.db = exports.Case = exports.Exists = exports.Null = exports.Literal = exports.Variable = exports.NamedVariable = exports.NamedParam = exports.Param = exports.Relationship = exports.NamedNode = exports.Node = exports.Pattern = exports.concat = exports.Foreach = exports.Union = exports.Unwind = exports.With = exports.RawCypher = exports.Return = exports.CallProcedure = exports.Call = exports.Merge = exports.Create = exports.OptionalMatch = exports.Match = void 0;
-exports.utils = exports.single = exports.exists = exports.all = exports.any = exports.time = exports.localdatetime = exports.localtime = exports.date = exports.datetime = exports.elementId = exports.id = exports.randomUUID = exports.sum = exports.avg = exports.max = exports.min = exports.count = exports.labels = exports.pointDistance = exports.distance = exports.point = exports.coalesce = exports.Function = void 0;
+exports.plus = exports.matches = exports.endsWith = exports.startsWith = exports.contains = exports.in = exports.isNotNull = exports.isNull = exports.lte = exports.lt = exports.gte = exports.gt = exports.eq = exports.xor = exports.not = exports.and = exports.or = exports.MapProjection = exports.Map = exports.List = exports.PatternComprehension = exports.ListComprehension = exports.apoc = exports.Case = exports.Exists = exports.NamedPath = exports.Path = exports.Null = exports.Literal = exports.Variable = exports.NamedVariable = exports.NamedParam = exports.Param = exports.Relationship = exports.NamedNode = exports.Node = exports.Pattern = exports.concat = exports.Foreach = exports.Union = exports.Unwind = exports.With = exports.RawCypher = exports.Return = exports.Use = exports.Call = exports.Merge = exports.Create = exports.OptionalMatch = exports.Match = void 0;
+exports.utils = exports.db = exports.VoidProcedure = exports.Procedure = exports.single = exports.exists = exports.all = exports.any = exports.time = exports.localdatetime = exports.localtime = exports.date = exports.datetime = exports.collect = exports.sum = exports.avg = exports.max = exports.min = exports.count = exports.elementId = exports.id = exports.randomUUID = exports.labels = exports.pointDistance = exports.distance = exports.point = exports.coalesce = exports.Function = exports.minus = void 0;
 // Clauses
@@ -60,4 +60,4 @@ var Match_1 = require("./clauses/Match");
 Object.defineProperty(exports, "Call", { enumerable: true, get: function () { return Call_1.Call; } });
-var CallProcedure_1 = require("./clauses/CallProcedure");
-Object.defineProperty(exports, "CallProcedure", { enumerable: true, get: function () { return CallProcedure_1.CallProcedure; } });
+var Use_1 = require("./clauses/Use");
+Object.defineProperty(exports, "Use", { enumerable: true, get: function () { return Use_1.Use; } });
 var Return_1 = require("./clauses/Return");
@@ -95,2 +95,5 @@ Object.defineProperty(exports, "Return", { enumerable: true, get: function () { return Return_1.Return; } });
 Object.defineProperty(exports, "Null", { enumerable: true, get: function () { return Literal_1.CypherNull; } });
+var Path_1 = require("./references/Path");
+Object.defineProperty(exports, "Path", { enumerable: true, get: function () { return Path_1.Path; } });
+Object.defineProperty(exports, "NamedPath", { enumerable: true, get: function () { return Path_1.NamedPath; } });
 // Expressions
@@ -101,4 +104,2 @@ var Exists_1 = require("./expressions/Exists");
 Object.defineProperty(exports, "Case", { enumerable: true, get: function () { return Case_1.Case; } });
-// --Procedures
-exports.db = __importStar(require("./procedures/db"));
 // --Apoc
@@ -149,10 +150,12 @@ exports.apoc = __importStar(require("./apoc/apoc"));
 Object.defineProperty(exports, "labels", { enumerable: true, get: function () { return CypherFunctions_2.labels; } });
-Object.defineProperty(exports, "count", { enumerable: true, get: function () { return CypherFunctions_2.count; } });
-Object.defineProperty(exports, "min", { enumerable: true, get: function () { return CypherFunctions_2.min; } });
-Object.defineProperty(exports, "max", { enumerable: true, get: function () { return CypherFunctions_2.max; } });
-Object.defineProperty(exports, "avg", { enumerable: true, get: function () { return CypherFunctions_2.avg; } });
-Object.defineProperty(exports, "sum", { enumerable: true, get: function () { return CypherFunctions_2.sum; } });
 Object.defineProperty(exports, "randomUUID", { enumerable: true, get: function () { return CypherFunctions_2.randomUUID; } });
 Object.defineProperty(exports, "id", { enumerable: true, get: function () { return CypherFunctions_2.id; } });
 Object.defineProperty(exports, "elementId", { enumerable: true, get: function () { return CypherFunctions_2.elementId; } });
+var AggregationFunctions_1 = require("./expressions/functions/AggregationFunctions");
+Object.defineProperty(exports, "count", { enumerable: true, get: function () { return AggregationFunctions_1.count; } });
+Object.defineProperty(exports, "min", { enumerable: true, get: function () { return AggregationFunctions_1.min; } });
+Object.defineProperty(exports, "max", { enumerable: true, get: function () { return AggregationFunctions_1.max; } });
+Object.defineProperty(exports, "avg", { enumerable: true, get: function () { return AggregationFunctions_1.avg; } });
+Object.defineProperty(exports, "sum", { enumerable: true, get: function () { return AggregationFunctions_1.sum; } });
+Object.defineProperty(exports, "collect", { enumerable: true, get: function () { return AggregationFunctions_1.collect; } });
 var TemporalFunctions_1 = require("./expressions/functions/TemporalFunctions");
@@ -166,2 +169,3 @@ Object.defineProperty(exports, "datetime", { enumerable: true, get: function () { return TemporalFunctions_1.cypherDatetime; } });
 __exportStar(require("./expressions/functions/ListFunctions"), exports);
+__exportStar(require("./expressions/functions/PathFunctions"), exports);
 var PredicateFunctions_1 = require("./expressions/functions/PredicateFunctions");
@@ -172,5 +176,9 @@ Object.defineProperty(exports, "any", { enumerable: true, get: function () { return PredicateFunctions_1.any; } });
 Object.defineProperty(exports, "single", { enumerable: true, get: function () { return PredicateFunctions_1.single; } });
+// Procedures
+var CypherProcedure_1 = require("./procedures/CypherProcedure");
+Object.defineProperty(exports, "Procedure", { enumerable: true, get: function () { return CypherProcedure_1.CypherProcedure; } });
+Object.defineProperty(exports, "VoidProcedure", { enumerable: true, get: function () { return CypherProcedure_1.VoidCypherProcedure; } });
+exports.db = __importStar(require("./procedures/db"));
 // utils
-// --Procedures
 exports.utils = __importStar(require("./utils/utils"));
 //# sourceMappingURL=Cypher.js.map

dist/CypherASTNode.d.ts

@@ -8,9 +8,5 @@ import type { CypherEnvironment } from "./Environment";
     protected parent?: CypherASTNode;
-    /**
-     * @hidden
-     */
+    /** @internal */
     constructor(parent?: CypherASTNode);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getRoot(): CypherASTNode;
@@ -17,0 +13,0 @@ /** Concrete tree traversal pattern to generate the Cypher on nested nodes */

dist/CypherASTNode.js

@@ -26,11 +26,7 @@ "use strict";
 class CypherASTNode {
-    /**
-     * @hidden
-     */
+    /** @internal */
     constructor(parent) {
         this.parent = parent;
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getRoot() {
@@ -37,0 +33,0 @@ if (this.parent) {

dist/expressions/Case.d.ts

@@ -15,5 +15,3 @@ import type { CypherEnvironment } from "../Environment";
     else(defaultExpr: Expr): this;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -28,3 +26,3 @@ }
     /**
-     * @hidden
+     * @internal
      */
@@ -31,0 +29,0 @@ getCypher(env: CypherEnvironment): string;

dist/expressions/Case.js

@@ -44,5 +44,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -68,3 +66,3 @@ const comparatorStr = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.comparator, env, { prefix: " " });
     /**
-     * @hidden
+     * @internal
      */
@@ -71,0 +69,0 @@ getCypher(env) {

dist/expressions/Exists.d.ts

@@ -12,3 +12,3 @@ import type { CypherEnvironment } from "../Environment";
     /**
-     * @hidden
+     * @internal
      */
@@ -15,0 +15,0 @@ getCypher(env: CypherEnvironment): string;

dist/expressions/Exists.js

@@ -36,3 +36,3 @@ "use strict";
     /**
-     * @hidden
+     * @internal
      */
@@ -39,0 +39,0 @@ getCypher(env) {

dist/expressions/functions/CypherFunctions.d.ts

@@ -13,10 +13,6 @@ import type { Variable } from "../../references/Variable";
     private params;
-    /**
-     * @hidden
-     */
     constructor(name: string, params?: Array<Expr>);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
+    protected serializeParams(env: CypherEnvironment): string;
 }
@@ -55,32 +51,2 @@ /**
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-count)
- * @group Expressions
- * @category Cypher Functions
- */
-export declare function count(expr: Expr): CypherFunction;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-min)
- * @group Expressions
- * @category Cypher Functions
- */
-export declare function min(expr: Expr): CypherFunction;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-max)
- * @group Expressions
- * @category Cypher Functions
- */
-export declare function max(expr: Expr): CypherFunction;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-avg)
- * @group Expressions
- * @category Cypher Functions
- */
-export declare function avg(expr: Expr): CypherFunction;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-sum)
- * @group Expressions
- * @category Cypher Functions
- */
-export declare function sum(expr: Expr): CypherFunction;
-/**
  * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-randomuuid)
@@ -87,0 +53,0 @@ * @group Expressions

dist/expressions/functions/CypherFunctions.js

@@ -21,3 +21,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.elementId = exports.id = exports.randomUUID = exports.sum = exports.avg = exports.max = exports.min = exports.count = exports.labels = exports.pointDistance = exports.distance = exports.point = exports.coalesce = exports.CypherFunction = void 0;
+exports.elementId = exports.id = exports.randomUUID = exports.labels = exports.pointDistance = exports.distance = exports.point = exports.coalesce = exports.CypherFunction = void 0;
 const CypherASTNode_1 = require("../../CypherASTNode");
@@ -30,5 +30,2 @@ /** Represents a Cypher Function
 class CypherFunction extends CypherASTNode_1.CypherASTNode {
-    /**
-     * @hidden
-     */
     constructor(name, params = []) {
@@ -44,9 +41,10 @@ super();
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
-        const argsStr = this.params.map((expr) => expr.getCypher(env)).join(", ");
+        const argsStr = this.serializeParams(env);
         return `${this.name}(${argsStr})`;
     }
+    serializeParams(env) {
+        return this.params.map((expr) => expr.getCypher(env)).join(", ");
+    }
 }
@@ -101,47 +99,2 @@ exports.CypherFunction = CypherFunction;
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-count)
- * @group Expressions
- * @category Cypher Functions
- */
-function count(expr) {
-    return new CypherFunction("count", [expr]);
-}
-exports.count = count;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-min)
- * @group Expressions
- * @category Cypher Functions
- */
-function min(expr) {
-    return new CypherFunction("min", [expr]);
-}
-exports.min = min;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-max)
- * @group Expressions
- * @category Cypher Functions
- */
-function max(expr) {
-    return new CypherFunction("max", [expr]);
-}
-exports.max = max;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-avg)
- * @group Expressions
- * @category Cypher Functions
- */
-function avg(expr) {
-    return new CypherFunction("avg", [expr]);
-}
-exports.avg = avg;
-/**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-sum)
- * @group Expressions
- * @category Cypher Functions
- */
-function sum(expr) {
-    return new CypherFunction("sum", [expr]);
-}
-exports.sum = sum;
-/**
  * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-randomuuid)
@@ -148,0 +101,0 @@ * @group Expressions

dist/expressions/functions/ListFunctions.d.ts

@@ -11,8 +11,2 @@ import type { Variable } from "../..";
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-collect)
- * @group Expressions
- * @category Cypher Functions
- */
-export declare function collect(expr: Expr): CypherFunction;
-/**
  * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-head)
@@ -19,0 +13,0 @@ * @group Expressions

dist/expressions/functions/ListFunctions.js

@@ -21,3 +21,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reduce = exports.last = exports.head = exports.collect = exports.size = void 0;
+exports.reduce = exports.last = exports.head = exports.size = void 0;
 const CypherFunctions_1 = require("./CypherFunctions");
@@ -34,11 +34,2 @@ /**
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-collect)
- * @group Expressions
- * @category Cypher Functions
- */
-function collect(expr) {
-    return new CypherFunctions_1.CypherFunction("collect", [expr]);
-}
-exports.collect = collect;
-/**
  * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-head)
@@ -45,0 +36,0 @@ * @group Expressions

dist/expressions/HasLabel.d.ts

@@ -16,7 +16,5 @@ import { CypherASTNode } from "../CypherASTNode";
     constructor(node: NodeRef, expectedLabels: string[]);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=HasLabel.d.ts.map

dist/expressions/HasLabel.js

@@ -40,5 +40,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -45,0 +43,0 @@ const nodeId = this.node.getCypher(env);

dist/expressions/list/ListExpr.d.ts

@@ -20,5 +20,3 @@ import type { CypherEnvironment } from "../../Environment";
     private serializeList;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -25,0 +23,0 @@ /** Access individual elements in the list via the ListIndex class*/

dist/expressions/list/ListExpr.js

@@ -46,5 +46,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -51,0 +49,0 @@ return this.serializeList(env, this.value);

dist/expressions/list/ListIndex.d.ts

@@ -26,7 +26,5 @@ import type { CypherEnvironment } from "../../Environment";
     constructor(variable: Variable | ListExpr, index: number);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=ListIndex.d.ts.map

dist/expressions/list/ListIndex.js

@@ -44,5 +44,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -49,0 +47,0 @@ return `${this.value.getCypher(env)}[${this.index}]`;

dist/expressions/map/MapExpr.d.ts

@@ -12,7 +12,5 @@ import type { CypherEnvironment } from "../../Environment";
     set(values: Record<string, Expr>): void;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=MapExpr.d.ts.map

dist/expressions/map/MapExpr.js

@@ -39,5 +39,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -44,0 +42,0 @@ return (0, serialize_map_1.serializeMap)(env, this.value);

dist/expressions/map/MapProjection.d.ts

@@ -18,4 +18,5 @@ import type { CypherEnvironment } from "../../Environment";
     set(values: Record<string, Expr> | string): void;
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=MapProjection.d.ts.map

dist/expressions/map/MapProjection.js

@@ -45,2 +45,3 @@ "use strict";
     }
+    /** @internal */
     getCypher(env) {
@@ -47,0 +48,0 @@ const variableStr = this.variable.getCypher(env);

dist/pattern/PartialPattern.d.ts

@@ -34,2 +34,5 @@ import type { CypherEnvironment } from "../Environment";
     withLength(option: LengthOption): this;
+    /**
+     * @hidden
+     */
     getCypher(env: CypherEnvironment): string;
@@ -36,0 +39,0 @@ private generateLengthStr;

dist/pattern/PartialPattern.js

@@ -61,2 +61,5 @@ "use strict";
     }
+    /**
+     * @hidden
+     */
     getCypher(env) {
@@ -63,0 +66,0 @@ const prevStr = this.previous.getCypher(env);

dist/pattern/Pattern.d.ts

@@ -16,2 +16,3 @@ import type { CypherEnvironment } from "../Environment";
     private properties;
+    private pathVariable;
     constructor(node: NodeRef, previous?: PartialPattern);
@@ -23,3 +24,3 @@ withoutLabels(): this;
     /**
-     * @hidden
+     * @internal
      */
@@ -26,0 +27,0 @@ getCypher(env: CypherEnvironment): string;

dist/pattern/Pattern.js

@@ -55,3 +55,3 @@ "use strict";
     /**
-     * @hidden
+     * @internal
      */
@@ -58,0 +58,0 @@ getCypher(env) {

dist/procedures/db.d.ts

@@ -1,22 +0,23 @@
-import type { CypherEnvironment } from "../Environment";
-import type { NodeRef } from "../references/NodeRef";
-import { Clause } from "../clauses/Clause";
-import { WithReturn } from "../clauses/mixins/WithReturn";
+import { CypherProcedure } from "./CypherProcedure";
+import type { Literal } from "../references/Literal";
+import type { Param } from "../references/Param";
 import type { Variable } from "../references/Variable";
-import type { Predicate } from "../types";
-export interface FullTextQueryNodes extends WithReturn {
-}
+type FulltextPhrase = string | Literal<string> | Param | Variable;
 /**
- * @group Procedures
+ * @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/5/reference/procedures/)
+ * @group Expressions
+ * @category Procedures
  */
-export declare class FullTextQueryNodes extends Clause {
-    private targetNode;
-    private indexName;
-    private phrase;
-    private scoreVar;
-    private whereClause;
-    constructor(targetNode: NodeRef, indexName: string, phrase: Variable, scoreVar?: Variable, parent?: Clause);
-    where(input: Predicate): this;
-    getCypher(env: CypherEnvironment): string;
-}
+export declare const index: {
+    fulltext: {
+        queryNodes(indexName: string | Literal<string>, phrase: FulltextPhrase): CypherProcedure<"node" | "score">;
+    };
+};
+/** Returns all labels in database
+ * @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/5/reference/procedures/#procedure_db_labels)
+ * @group Expressions
+ * @category Procedures
+ */
+export declare function labels(): CypherProcedure<"label">;
+export {};
 //# sourceMappingURL=db.d.ts.map

dist/procedures/db.js

@@ -20,51 +20,30 @@ "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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FullTextQueryNodes = void 0;
-const Where_1 = require("../clauses/sub-clauses/Where");
-const Clause_1 = require("../clauses/Clause");
-const WithReturn_1 = require("../clauses/mixins/WithReturn");
-const mixin_1 = require("../clauses/utils/mixin");
-const compile_cypher_if_exists_1 = require("../utils/compile-cypher-if-exists");
-// TODO: remove yield and CALL and put them in CallProcedure
+exports.labels = exports.index = void 0;
+const CypherProcedure_1 = require("./CypherProcedure");
+const normalize_variable_1 = require("../utils/normalize-variable");
 /**
- * @group Procedures
+ * @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/5/reference/procedures/)
+ * @group Expressions
+ * @category Procedures
  */
-let FullTextQueryNodes = class FullTextQueryNodes extends Clause_1.Clause {
-    constructor(targetNode, indexName, phrase, scoreVar, parent) {
-        super(parent);
-        this.targetNode = targetNode;
-        this.indexName = indexName;
-        this.phrase = phrase;
-        this.scoreVar = scoreVar;
-    }
-    where(input) {
-        if (!this.whereClause) {
-            const whereStatement = new Where_1.Where(this, input);
-            this.addChildren(whereStatement);
-            this.whereClause = whereStatement;
-        }
-        else {
-            this.whereClause.and(input);
-        }
-        return this;
-    }
-    getCypher(env) {
-        const targetId = this.targetNode.getCypher(env);
-        const scoreYield = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.scoreVar, env, { prefix: ", score AS " });
-        const textSearchStr = `CALL db.index.fulltext.queryNodes("${this.indexName}", ${this.phrase.getCypher(env)}) YIELD node AS ${targetId}${scoreYield}`;
-        const whereStr = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.whereClause, env, { prefix: "\n" });
-        const returnStr = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.returnStatement, env, { prefix: "\n" });
-        return `${textSearchStr}${whereStr}${returnStr}`;
-    }
+exports.index = {
+    fulltext: {
+        queryNodes(indexName, phrase) {
+            // TODO: add options, skip limit, analyzer
+            const phraseVar = (0, normalize_variable_1.normalizeVariable)(phrase);
+            const indexNameVar = (0, normalize_variable_1.normalizeVariable)(indexName);
+            return new CypherProcedure_1.CypherProcedure("db.index.fulltext.queryNodes", [indexNameVar, phraseVar]);
+        },
+    },
 };
-FullTextQueryNodes = __decorate([
-    (0, mixin_1.mixin)(WithReturn_1.WithReturn)
-], FullTextQueryNodes);
-exports.FullTextQueryNodes = FullTextQueryNodes;
+/** Returns all labels in database
+ * @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/5/reference/procedures/#procedure_db_labels)
+ * @group Expressions
+ * @category Procedures
+ */
+function labels() {
+    return new CypherProcedure_1.CypherProcedure("db.labels");
+}
+exports.labels = labels;
 //# sourceMappingURL=db.js.map

dist/references/Literal.d.ts

@@ -9,2 +9,3 @@ import type { CypherCompilable } from "../types";
     constructor(value: T);
+    /** @internal */
     getCypher(): string;
@@ -11,0 +12,0 @@ private formatLiteralValue;

dist/references/Literal.js

@@ -29,2 +29,3 @@ "use strict";
     }
+    /** @internal */
     getCypher() {
@@ -31,0 +32,0 @@ return this.formatLiteralValue(this.value);

dist/references/NodeRef.d.ts

 import { HasLabel } from "../expressions/HasLabel";
 import type { Param } from "./Param";
-import { NamedReference, Reference } from "./Reference";
+import type { NamedReference } from "./Reference";
+import { Reference } from "./Reference";
 export type NodeProperties = Record<string, Param<any>>;
@@ -5,0 +6,0 @@ type NodeRefOptions = {

dist/references/Param.d.ts

@@ -20,7 +20,5 @@ import type { CypherEnvironment } from "../Environment";
     constructor(name: string, value?: any);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
 }
 //# sourceMappingURL=Param.d.ts.map

dist/references/Param.js

@@ -54,5 +54,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -59,0 +57,0 @@ env.addNamedParamReference(this.id, this);

dist/references/PropertyRef.d.ts

@@ -16,5 +16,3 @@ import type { CypherEnvironment } from "../Environment";
     property(prop: string | Expr): PropertyRef;
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -21,0 +19,0 @@ private getPropertyCypher;

dist/references/PropertyRef.js

@@ -38,5 +38,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -43,0 +41,0 @@ const variableStr = this.variable.getCypher(env);

dist/references/Reference.d.ts

@@ -9,5 +9,3 @@ import { PropertyRef } from "./PropertyRef";
     constructor(prefix?: string);
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env: CypherEnvironment): string;
@@ -14,0 +12,0 @@ /** Access individual property via the PropertyRef class, using the dot notation */

dist/references/Reference.js

@@ -29,5 +29,3 @@ "use strict";
     }
-    /**
-     * @hidden
-     */
+    /** @internal */
     getCypher(env) {
@@ -34,0 +32,0 @@ const id = env.getReferenceId(this);

dist/references/Variable.d.ts

@@ -1,2 +0,3 @@
-import { NamedReference, Reference } from "./Reference";
+import type { NamedReference } from "./Reference";
+import { Reference } from "./Reference";
 /** Represents a variable
@@ -3,0 +4,0 @@ * @group Internal

dist/types.d.ts

@@ -19,4 +19,5 @@ import type { PropertyRef } from "./references/PropertyRef";
 import type { Reference } from "./references/Reference";
-import type { ApocFunction, ApocPredicate, ApocProcedure } from "./apoc/types";
+import type { ApocFunction } from "./apoc/types";
 import type { ListIndex } from "./expressions/list/ListIndex";
+import type { Path } from "./references/Path";
 export type Operation = BooleanOp | ComparisonOp | MathOp;
@@ -26,7 +27,5 @@ /** Represents a Cypher Expression
  */
-export type Expr = Operation | Reference | Literal | PropertyRef | CypherFunction | Predicate | ListComprehension | PatternComprehension | MapExpr | MapProjection | ListExpr | ListIndex | ApocFunction | Case<ComparisonOp>;
+export type Expr = Operation | Reference | Literal | PropertyRef | CypherFunction | Predicate | ListComprehension | PatternComprehension | MapExpr | MapProjection | ListExpr | ListIndex | ApocFunction | Case<ComparisonOp> | Path;
 /** Represents a predicate statement (i.e returns a boolean). Note that RawCypher is only added for compatibility */
-export type Predicate = BooleanOp | ComparisonOp | RawCypher | Exists | PredicateFunction | ApocPredicate | Literal<boolean> | Case | HasLabel;
-/** Represents a procedure, invocable with the CALL statement */
-export type Procedure = ApocProcedure;
+export type Predicate = BooleanOp | ComparisonOp | RawCypher | Exists | PredicateFunction | Literal<boolean> | Case | HasLabel;
 export type CypherResult = {
@@ -33,0 +32,0 @@ cypher: string;

package.json

 {
     "name": "@neo4j/cypher-builder",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "description": "Neo4j Cypher query builder",
@@ -36,10 +36,10 @@ "exports": "./dist/index.js",
     "devDependencies": {
-        "@types/jest": "29.4.0",
-        "@types/node": "18.11.17",
+        "@types/jest": "29.5.0",
+        "@types/node": "18.15.1",
         "expect-type": "0.15.0",
-        "jest": "29.4.3",
+        "jest": "29.5.0",
         "ts-jest": "29.0.5",
-        "typedoc": "0.23.25",
-        "typescript": "4.9.5"
+        "typedoc": "0.23.28",
+        "typescript": "5.0.2"
     }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

415483

increased by6.07%

Number of package files

347

increased by4.83%

Lines of code

6690

increased by5.01%

No dependency changes