@neo4j/cypher-builder
Version:
A programmatic API for building Cypher queries for Neo4j
228 lines (227 loc) • 10.2 kB
JavaScript
;
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*/
var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
var _, done = false;
for (var i = decorators.length - 1; i >= 0; i--) {
var context = {};
for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
for (var p in contextIn.access) context.access[p] = contextIn.access[p];
context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
if (kind === "accessor") {
if (result === void 0) continue;
if (result === null || typeof result !== "object") throw new TypeError("Object expected");
if (_ = accept(result.get)) descriptor.get = _;
if (_ = accept(result.set)) descriptor.set = _;
if (_ = accept(result.init)) initializers.unshift(_);
}
else if (_ = accept(result)) {
if (kind === "field") initializers.unshift(_);
else descriptor[key] = _;
}
}
if (target) Object.defineProperty(target, contextIn.name, descriptor);
done = true;
};
var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
var useValue = arguments.length > 2;
for (var i = 0; i < initializers.length; i++) {
value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
}
return useValue ? value : void 0;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.OptionalMatch = exports.Match = void 0;
const compile_cypher_if_exists_1 = require("../utils/compile-cypher-if-exists");
const Clause_1 = require("./Clause");
const WithCall_1 = require("./mixins/clauses/WithCall");
const WithCallProcedure_1 = require("./mixins/clauses/WithCallProcedure");
const WithCreate_1 = require("./mixins/clauses/WithCreate");
const WithFilter_1 = require("./mixins/clauses/WithFilter");
const WithFinish_1 = require("./mixins/clauses/WithFinish");
const WithForeach_1 = require("./mixins/clauses/WithForeach");
const WithLet_1 = require("./mixins/clauses/WithLet");
const WithMatch_1 = require("./mixins/clauses/WithMatch");
const WithMerge_1 = require("./mixins/clauses/WithMerge");
const WithReturn_1 = require("./mixins/clauses/WithReturn");
const WithUnwind_1 = require("./mixins/clauses/WithUnwind");
const WithWith_1 = require("./mixins/clauses/WithWith");
const WithDelete_1 = require("./mixins/sub-clauses/WithDelete");
const WithOrder_1 = require("./mixins/sub-clauses/WithOrder");
const WithSetRemove_1 = require("./mixins/sub-clauses/WithSetRemove");
const WithWhere_1 = require("./mixins/sub-clauses/WithWhere");
const mixin_1 = require("./utils/mixin");
var MatchMode;
(function (MatchMode) {
MatchMode[MatchMode["REPEATABLE_ELEMENTS"] = 0] = "REPEATABLE_ELEMENTS";
MatchMode[MatchMode["DIFFERENT_RELATIONSHIPS"] = 1] = "DIFFERENT_RELATIONSHIPS";
})(MatchMode || (MatchMode = {}));
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation}
* @group Clauses
*/
let Match = (() => {
let _classDecorators = [(0, mixin_1.mixin)(WithReturn_1.WithReturn, WithWhere_1.WithWhere, WithSetRemove_1.WithSetRemove, WithWith_1.WithWith, WithDelete_1.WithDelete, WithUnwind_1.WithUnwind, WithCreate_1.WithCreate, WithMerge_1.WithMerge, WithFinish_1.WithFinish, WithCallProcedure_1.WithCallProcedure, WithCall_1.WithCall, WithOrder_1.WithOrder, WithForeach_1.WithForeach, WithLet_1.WithLet, WithFilter_1.WithFilter, WithMatch_1.WithMatch)];
let _classDescriptor;
let _classExtraInitializers = [];
let _classThis;
let _classSuper = Clause_1.Clause;
var Match = class extends _classSuper {
static { _classThis = this; }
static {
const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
__esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
Match = _classThis = _classDescriptor.value;
if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
__runInitializers(_classThis, _classExtraInitializers);
}
patterns;
_optional = false;
shortestStatement;
mode;
constructor(...patterns) {
super();
if (patterns.length === 0) {
throw new Error("At least one pattern must be provided to Match");
}
this.patterns = patterns;
}
/** Makes the clause an OPTIONAL MATCH
* @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation}
* @example
* ```ts
* new Cypher.Match(new Node({labels: ["Movie"]})).optional();
* ```
* _Cypher:_
* ```cypher
* OPTIONAL MATCH (this:Movie)
* ```
*/
optional() {
this._optional = true;
return this;
}
/**
* @since Neo4j 5.21
*/
shortest(k) {
this.shortestStatement = {
type: "SHORTEST",
k,
};
return this;
}
/**
* @since Neo4j 5.21
*/
shortestGroups(k) {
this.shortestStatement = {
type: "SHORTEST_GROUPS",
k,
};
return this;
}
/**
* @since Neo4j 5.21
*/
allShortest() {
this.shortestStatement = {
type: "ALL SHORTEST",
};
return this;
}
/**
* @since Neo4j 5.21
*/
any() {
this.shortestStatement = {
type: "ANY",
};
return this;
}
/** Add `REPEATABLE ELEMENTS` mode to `MATCH` clause
* @see {@link https://neo4j.com/docs/cypher-manual/25/patterns/match-modes/#repeatable-elements | Cypher Documentation}
* @since Neo4j 2025.06
*/
repeatableElements() {
this.mode = MatchMode.REPEATABLE_ELEMENTS;
return this;
}
/** Add `DIFFERENT RELATIONSHIPS` mode to `MATCH` clause
* @see {@link https://neo4j.com/docs/cypher-manual/25/patterns/match-modes/#different-relationships | Cypher Documentation}
* @since Neo4j 2025.06
*/
differentRelationships() {
this.mode = MatchMode.DIFFERENT_RELATIONSHIPS;
return this;
}
/** @internal */
getCypher(env) {
const patternCyphers = this.patterns.map((pattern) => pattern.getCypher(env));
const whereCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.whereSubClause, env, { prefix: "\n" });
const nextClause = this.compileNextClause(env);
const setCypher = this.compileSetCypher(env);
const deleteCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.deleteClause, env, { prefix: "\n" });
const orderByCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.orderByStatement, env, { prefix: "\n" });
const optionalMatch = this._optional ? "OPTIONAL " : "";
const shortestStatement = this.getShortestStatement();
if (patternCyphers.length > 1 && shortestStatement) {
throw new Error("Shortest cannot be used with multiple path patterns");
}
let patternStr;
if (patternCyphers.length > 1) {
patternStr = patternCyphers.map((p) => `\n ${p}`).join(",");
}
else {
patternStr = ` ${shortestStatement}${patternCyphers[0]}`;
}
const modeStr = this.getModeStr();
return `${optionalMatch}MATCH${modeStr}${patternStr}${whereCypher}${setCypher}${deleteCypher}${orderByCypher}${nextClause}`;
}
getShortestStatement() {
if (!this.shortestStatement) {
return "";
}
switch (this.shortestStatement.type) {
case "SHORTEST":
return `SHORTEST ${this.shortestStatement.k} `;
case "ALL SHORTEST":
return "ALL SHORTEST ";
case "SHORTEST_GROUPS":
return `SHORTEST ${this.shortestStatement.k} GROUPS `;
case "ANY":
return "ANY ";
}
}
getModeStr() {
switch (this.mode) {
case MatchMode.DIFFERENT_RELATIONSHIPS:
return " DIFFERENT RELATIONSHIPS";
case MatchMode.REPEATABLE_ELEMENTS:
return " REPEATABLE ELEMENTS";
default:
return "";
}
}
};
return Match = _classThis;
})();
exports.Match = Match;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation}
* @group Clauses
*/
class OptionalMatch extends Match {
constructor(...patterns) {
super(...patterns);
this.optional();
}
}
exports.OptionalMatch = OptionalMatch;