Deprecate apoc methods

Author: angrykoala

.changeset/lazy-buckets-peel.md

@@ -0,0 +1,11 @@
+---
+"@neo4j/cypher-builder": patch
+---
+
+Deprecate apoc functions and procedures. These will no longer be supported in version 3 of Cypher Builder:
+
+- `apoc.date.convertFormat`
+- `apoc.util.validate`
+- `apoc.util.validatePredicate`
+- `apoc.cypher.runFirstColumnMany`
+- `apoc.cypher.runFirstColumnSingle`

docs/modules/ROOT/pages/functions.adoc

@@ -26,18 +26,18 @@ This differentiates functions from clauses and other elements of the Cypher Buil
 ====
 
 Exposed functions have the closest possible name to their Cypher counterpart, and reside in the same namespace.
-For example, this query:
+For example:
 
 [source, javascript]
 ----
-Cypher.apoc.cypher.runFirstColumnSingle()
+Cypher.db.nameFromElementId("1234")
 ----
 
-Is equivalent to the Cypher function:
+Generates the Cypher function:
 
 [source, cypher]
 ----
-apoc.cypher.runFirstColumnSingle()
+db.nameFromElementId("1234")
 ----
 
 == Custom functions

docs/modules/ROOT/pages/subqueries/call.adoc

@@ -69,6 +69,7 @@ CALL (*) {
 }
 ----
 
+[role=label--deprecated]
 == `.importWith`
 
 [WARNING]

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

@@ -26,6 +26,7 @@ import type { Expr } from "../../../types";
 
 /**
  * @group Functions
+ * @deprecated apoc methods will no longer be supported in Cypher Builder version 3
  * @see [Apoc Documentation](https://neo4j.com/docs/apoc/current/overview/apoc.cypher/apoc.cypher.runFirstColumnMany/)
  */
 export function runFirstColumnMany(
@@ -37,6 +38,7 @@ export function runFirstColumnMany(
 
 /**
  * @group Functions
+ * @deprecated apoc methods will no longer be supported in Cypher Builder version 3
  * @see [Apoc Documentation](https://neo4j.com/docs/apoc/current/overview/apoc.cypher/apoc.cypher.runFirstColumnSingle/)
  */
 export function runFirstColumnSingle(

src/namespaces/apoc/date.ts

@@ -25,6 +25,7 @@ import type { Expr } from "../../types";
 /**
  * @group Functions
  * @see [Apoc Documentation](https://neo4j.com/docs/apoc/current/overview/apoc.date/apoc.date.convertFormat/)
+ * @deprecated apoc methods will no longer be supported in Cypher Builder version 3
  * @example
  * ```ts
  * Cypher.apoc.date.convertFormat(

src/namespaces/apoc/util.ts

@@ -27,6 +27,7 @@ import { normalizeVariable } from "../../utils/normalize-variable";
 
 /**
  * @group Procedures
+ * @deprecated apoc methods will no longer be supported in Cypher Builder version 3
  * @see [Apoc Documentation](https://neo4j.com/docs/apoc/current/overview/apoc.util/apoc.util.validate/)
  */
 export function validate(
@@ -40,6 +41,7 @@ export function validate(
 
 /**
  * @group Functions
+ * @deprecated apoc methods will no longer be supported in Cypher Builder version 3
  * @see [Apoc Documentation](https://neo4j.com/docs/apoc/current/overview/apoc.util/apoc.util.validatePredicate/)
  */
 export function validatePredicate(predicate: Predicate, message: string): CypherFunction {