Deprecate Old and Stabilize New Result Transformer Aliases (#1287)

Author: MaxAake

packages/core/src/driver.ts

@@ -561,7 +561,7 @@ class Driver {
    *    'MATCH (p:Person{ name: $name }) RETURN p',
    *    { name: 'Person1'},
    *    {
-   *      resultTransformer: neo4j.resultTransformers.mappedResultTransformer({
+   *      resultTransformer: neo4j.resultTransformers.mapped({
    *        map(record) {
    *          const p = record.get('p')
    *          return [p.elementId, p]
@@ -613,7 +613,7 @@ class Driver {
    */
   async executeQuery<T = EagerResult> (query: Query, parameters?: any, config: QueryConfig<T> = {}): Promise<T> {
     const bookmarkManager = config.bookmarkManager === null ? undefined : (config.bookmarkManager ?? this.executeQueryBookmarkManager)
-    const resultTransformer = (config.resultTransformer ?? resultTransformers.eagerResultTransformer()) as ResultTransformer<T>
+    const resultTransformer = (config.resultTransformer ?? resultTransformers.eager()) as ResultTransformer<T>
     const routingConfig: string = config.routing ?? routing.WRITE
 
     if (routingConfig !== routing.READ && routingConfig !== routing.WRITE) {

packages/core/src/result-transformers.ts

@@ -52,7 +52,7 @@ class ResultTransformers {
    * const { keys, records, summary } = await driver.executeQuery('CREATE (p:Person{ name: $name }) RETURN p', { name: 'Person1'})
    *
    * @returns {ResultTransformer<EagerResult<Entries>>} The result transformer
-   * @alias {@link ResultTransformers#eager}
+   * @deprecated This is deprecated as of 6.0, use drop-in replacement {@link ResultTransformers#eager} instead.
    */
   eagerResultTransformer<Entries extends RecordShape = RecordShape>(): ResultTransformer<EagerResult<Entries>> {
     return createEagerResultFromResult
@@ -62,8 +62,7 @@ class ResultTransformers {
    * Creates a {@link ResultTransformer} which transforms {@link Result} to {@link EagerResult}
    * by consuming the whole stream.
    *
-   * This is the default implementation used in {@link Driver#executeQuery} and a alias to
-   * {@link resultTransformers.eagerResultTransformer}
+   * This is the default implementation used in {@link Driver#executeQuery}
    *
    * @example
    * // This:
@@ -74,9 +73,7 @@ class ResultTransformers {
    * const { keys, records, summary } = await driver.executeQuery('CREATE (p:Person{ name: $name }) RETURN p', { name: 'Person1'})
    *
    * @returns {ResultTransformer<EagerResult<Entries>>} The result transformer
-   * @experimental this is a preview
    * @since 5.22.0
-   * @alias {@link ResultTransformers#eagerResultTransformer}
    */
   eager<Entries extends RecordShape = RecordShape>(): ResultTransformer<EagerResult<Entries>> {
     return createEagerResultFromResult
@@ -143,6 +140,7 @@ class ResultTransformers {
    * the result data to the transformer output.
    * @returns {ResultTransformer<T>} The result transformer
    * @see {@link Driver#executeQuery}
+   * @deprecated This is deprecated as of 6.0, use drop-in replacement {@link ResultTransformers#mapped} instead.
    */
   mappedResultTransformer <
     R = Record, T = { records: R[], keys: string[], summary: ResultSummary }
@@ -156,9 +154,6 @@ class ResultTransformers {
    *
    * NOTE: The config object requires map or/and collect to be valid.
    *
-   * This method is a alias to {@link ResultTransformers#mappedResultTransformer}
-   *
-   *
    * @example
    * // Mapping the records
    * const { keys, records, summary } = await driver.executeQuery('MATCH (p:Person{ age: $age }) RETURN p.name as name', { age: 25 }, {
@@ -213,10 +208,8 @@ class ResultTransformers {
    * @param {function(records:R[], summary:ResultSummary, keys:string[]):T} [config.collect=function(records, summary, keys) { return { records, summary, keys }}] Method called for mapping
    * the result data to the transformer output.
    * @returns {ResultTransformer<T>} The result transformer
-   * @experimental This is a preview feature
-   * @alias {@link ResultTransformers#mappedResultTransformer}
-   * @since 5.22.0
    * @see {@link Driver#executeQuery}
+   * @since 5.22.0
    */
   mapped <
     R = Record, T = { records: R[], keys: string[], summary: ResultSummary }
@@ -242,7 +235,6 @@ class ResultTransformers {
    * @template Entries The shape of the record.
    * @returns {ResultTransformer<Record<Entries>|undefined>} The result transformer
    * @see {@link Driver#executeQuery}
-   * @experimental This is a preview feature.
    * @since 5.22.0
    */
   first<Entries extends RecordShape = RecordShape>(): ResultTransformer<Record<Entries> | undefined> {
@@ -261,7 +253,7 @@ class ResultTransformers {
    *
    * @returns {ResultTransformer<ResultSummary<T>>} The result transformer
    * @see {@link Driver#executeQuery}
-   * @experimental This is a preview feature
+   * @since 5.22.0
    */
   summary <T extends NumberOrInteger = Integer> (): ResultTransformer<ResultSummary<T>> {
     return summary

packages/core/test/driver.test.ts

@@ -394,7 +394,7 @@ describe('Driver', () => {
 
         expect(eagerResult).toEqual(expected)
         expect(spiedExecute).toBeCalledWith({
-          resultTransformer: resultTransformers.eagerResultTransformer(),
+          resultTransformer: resultTransformers.eager(),
           bookmarkManager: driver?.executeQueryBookmarkManager,
           routing: routing.WRITE,
           database: undefined,
@@ -420,7 +420,7 @@ describe('Driver', () => {
         expect(keys).toEqual(expected.keys)
         expect(summary).toEqual(expected.summary)
         expect(spiedExecute).toBeCalledWith({
-          resultTransformer: resultTransformers.eagerResultTransformer(),
+          resultTransformer: resultTransformers.eager(),
           bookmarkManager: driver?.executeQueryBookmarkManager,
           routing: routing.WRITE,
           database: undefined,
@@ -555,7 +555,7 @@ describe('Driver', () => {
       function extendsDefaultWith<T = EagerResult<RecordShape>> (config: QueryConfig<T>) {
         return () => {
           const defaultConfig = {
-            resultTransformer: resultTransformers.eagerResultTransformer(),
+            resultTransformer: resultTransformers.eager(),
             bookmarkManager: driver?.executeQueryBookmarkManager,
             routing: routing.WRITE,
             database: undefined,