@tmlmobilidade/interfaces 20250827.1513.21 → 20250827.1523.9

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './src/aggregation-pipeline.js';
 export * from './src/interfaces/index.js';
 export * from './src/mongo-collection.js';
 export * from './src/mongo-transaction.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 /* * */
+export * from './src/aggregation-pipeline.js';
 export * from './src/interfaces/index.js';
 export * from './src/mongo-collection.js';
 export * from './src/mongo-transaction.js';

package/dist/src/aggregation-pipeline.d.ts

@@ -0,0 +1,25 @@
+import { Filter } from 'mongodb';
+interface MatchStage<T> {
+    $match: Filter<T>;
+}
+interface ProjectStage<T> {
+    $project: Partial<Record<keyof T, 0 | 1>>;
+}
+interface GroupStage {
+    $group: {
+        [key: string]: any;
+        _id: Record<string, any> | string;
+    };
+}
+interface SortStage<T> {
+    $sort: Partial<Record<keyof T, -1 | 1>>;
+}
+interface LimitStage {
+    $limit: number;
+}
+interface SkipStage {
+    $skip: number;
+}
+type AggregationStage<T> = GroupStage | LimitStage | MatchStage<T> | ProjectStage<T> | SkipStage | SortStage<T>;
+export type AggregationPipeline<T> = AggregationStage<T>[];
+export {};

package/dist/src/aggregation-pipeline.js

@@ -0,0 +1 @@
+export {};

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

@@ -2,12 +2,18 @@ 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 { z } from 'zod';
+import { AggregationPipeline } from './aggregation-pipeline.js';
 export declare abstract class MongoCollectionClass<T extends Document, TCreate, TUpdate> {
     protected createSchema: null | z.ZodSchema;
     protected mongoCollection: Collection<T>;
     protected mongoConnector: MongoConnector;
     protected updateSchema: null | z.ZodSchema;
-    aggregate(pipeline: AggregationPipeline<T>): Promise<Document[]>;
+    /**
+     * Aggregates documents in the collection.
+     * @param pipeline - The aggregation pipeline to execute
+     * @returns A promise that resolves to an array of aggregated documents
+     */
+    aggregate(pipeline: AggregationPipeline<T>): Promise<T[]>;
     /**
      * Gets all documents in the collection.
      * @returns A promise that resolves to an array of all documents
@@ -147,27 +153,3 @@ export declare abstract class MongoCollectionClass<T extends Document, TCreate,
     protected abstract getCollectionName(): string;
     protected abstract getEnvName(): string;
 }
-interface MatchStage<T> {
-    $match: Partial<T>;
-}
-interface ProjectStage<T> {
-    $project: Partial<Record<keyof T, 0 | 1>>;
-}
-interface GroupStage<T> {
-    $group: {
-        [key: string]: any;
-        _id: Record<string, keyof T> | string;
-    };
-}
-interface SortStage<T> {
-    $sort: Partial<Record<keyof T, -1 | 1>>;
-}
-interface LimitStage {
-    $limit: number;
-}
-interface SkipStage {
-    $skip: number;
-}
-type AggregationStage<T> = GroupStage<T> | LimitStage | MatchStage<T> | ProjectStage<T> | SkipStage | SortStage<T>;
-export type AggregationPipeline<T> = AggregationStage<T>[];
-export {};

package/dist/src/mongo-collection.js

@@ -8,6 +8,11 @@ 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();
     }

package/package.json

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