@tmlmobilidade/interfaces 20250922.953.29 → 20250924.1552.9

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export * from './src/interfaces/index.js';
 export * from './src/mongo-collection.js';
 export * from './src/mongo-transaction.js';
 export * from './src/providers/index.js';
-export type { Collection, DeleteOptions, Document, Filter, FindOptions, IndexDescription, InsertOneOptions, InsertOneResult, MongoClientOptions, OptionalUnlessRequiredId, Sort, UpdateOptions, UpdateResult, WithId, } from 'mongodb';
+export type { ChangeStreamDeleteDocument, ChangeStreamDocument, ChangeStreamInsertDocument, ChangeStreamUpdateDocument, Collection, DeleteOptions, Document, Filter, FindOptions, IndexDescription, InsertOneOptions, InsertOneResult, MongoClientOptions, OptionalUnlessRequiredId, Sort, UpdateDescription, UpdateOptions, UpdateResult, WithId, } from 'mongodb';

package/dist/src/mongo-collection.d.ts

@@ -1,6 +1,6 @@
 import { MongoConnector } from '@tmlmobilidade/connectors';
 import { type UnixTimestamp } from '@tmlmobilidade/types';
-import { Collection, DeleteOptions, DeleteResult, Document, Filter, FindOptions, IndexDescription, InsertOneOptions, InsertOneResult, MongoClientOptions, UpdateOptions, UpdateResult, WithId } from 'mongodb';
+import { AggregateOptions, AggregationCursor, Collection, DeleteOptions, DeleteResult, Document, Filter, FindOptions, IndexDescription, InsertOneOptions, InsertOneResult, MongoClientOptions, UpdateOptions, UpdateResult, WithId } from 'mongodb';
 import { z } from 'zod';
 import { AggregationPipeline } from './aggregation-pipeline.js';
 export declare abstract class MongoCollectionClass<T extends Document, TCreate, TUpdate> {
@@ -11,9 +11,15 @@ export declare abstract class MongoCollectionClass<T extends Document, TCreate,
     /**
      * Aggregates documents in the collection.
      * @param pipeline - The aggregation pipeline to execute
+     * @param options - The options for the aggregation operation
      * @returns A promise that resolves to an array of aggregated documents
      */
-    aggregate(pipeline: AggregationPipeline<T>): Promise<T[]>;
+    aggregate(pipeline: AggregationPipeline<T>, options?: AggregateOptions & {
+        returnResult?: true;
+    }): Promise<T[]>;
+    aggregate(pipeline: AggregationPipeline<T>, options: AggregateOptions & {
+        returnResult: false;
+    }): Promise<AggregationCursor<T>>;
     /**
      * Gets all documents in the collection.
      * @returns A promise that resolves to an array of all documents

package/dist/src/mongo-collection.js

@@ -8,13 +8,12 @@ export class MongoCollectionClass {
     mongoCollection;
     mongoConnector;
     updateSchema = null;
-    /**
-     * Aggregates documents in the collection.
-     * @param pipeline - The aggregation pipeline to execute
-     * @returns A promise that resolves to an array of aggregated documents
-     */
-    async aggregate(pipeline) {
-        return await this.mongoCollection.aggregate(pipeline).toArray();
+    async aggregate(pipeline, options) {
+        const aggregation = this.mongoCollection.aggregate(pipeline, options);
+        if (options?.returnResult === false) {
+            return aggregation;
+        }
+        return aggregation.toArray();
     }
     /**
      * Gets all documents in the collection.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/interfaces",
-	"version": "20250922.953.29",
+	"version": "20250924.1552.9",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",