Collection: swap Collection.aggregate pipeline and schema parameter positions

Author: devmatteini

.changeset/six-carrots-suffer.md

@@ -0,0 +1,13 @@
+---
+"effect-mongodb": patch
+---
+
+Swap `Collection.aggregate` pipeline and schema parameter positions
+
+```typescript
+// Before
+Collection.aggregate(pipeline, schema)
+
+// After
+Collection.aggregate(schema, pipeline)
+```

packages/effect-mongodb/dtslint/Collection.ts

@@ -186,10 +186,10 @@ const MyAggregatedType = Schema.Struct({
 const groupByBirthday = [{ $group: { _id: "$birthday", birthdays: { $sum: 1 } } }]
 
 // $ExpectType AggregationCursor<{ readonly _id: Date; readonly birthdays: number; }, { readonly _id: string; readonly birthdays: number; }, never>
-Collection.aggregate(collection, groupByBirthday, MyAggregatedType)
+Collection.aggregate(collection, MyAggregatedType, groupByBirthday)
 
 // $ExpectType AggregationCursor<{ readonly _id: Date; readonly birthdays: number; }, { readonly _id: string; readonly birthdays: number; }, never>
-F.pipe(collection, Collection.aggregate(groupByBirthday, MyAggregatedType))
+F.pipe(collection, Collection.aggregate(MyAggregatedType, groupByBirthday))
 
 // -------------------------------------------------------------------------------------
 // estimatedDocumentCount

packages/effect-mongodb/examples/aggregate.ts

@@ -33,7 +33,7 @@ const program = Effect.gen(function*(_) {
   ]))
 
   const items = yield* _(
-    Collection.aggregate(sourceCollection, [
+    Collection.aggregate(sourceCollection, MyTypeAggregation, [
       {
         $group: {
           _id: "$source",
@@ -43,7 +43,7 @@ const program = Effect.gen(function*(_) {
       {
         $sort: { _id: 1 }
       }
-    ], MyTypeAggregation),
+    ]),
     AggregationCursor.toArray
   )
 

packages/effect-mongodb/src/Collection.ts

@@ -438,24 +438,24 @@ export const dropIndex: {
 
 export const aggregate: {
   <B extends Document, BI extends Document, BR>(
-    pipeline: ReadonlyArray<Document>,
     schema: Schema.Schema<B, BI, BR>,
+    pipeline: ReadonlyArray<Document>,
     options?: AggregateOptions
   ): <A extends Document, I extends Document, R>(
     collection: Collection<A, I, R>
   ) => AggregationCursor.AggregationCursor<B, BI, BR>
   <A extends Document, I extends Document, R, B extends Document, BI extends Document, BR>(
     collection: Collection<A, I, R>,
-    pipeline: ReadonlyArray<Document>,
     schema: Schema.Schema<B, BI, BR>,
+    pipeline: ReadonlyArray<Document>,
     options?: AggregateOptions
   ): AggregationCursor.AggregationCursor<B, BI, BR>
 } = F.dual(
   (args) => isCollection(args[0]),
   <A extends Document, I extends Document, R, B extends Document, BI extends Document, BR>(
     collection: Collection<A, I, R>,
-    pipeline: ReadonlyArray<Document>,
     schema: Schema.Schema<B, BI, BR>,
+    pipeline: ReadonlyArray<Document>,
     options?: AggregateOptions
   ): AggregationCursor.AggregationCursor<B, BI, BR> =>
     new AggregationCursor.AggregationCursor<B, BI, BR>({

packages/effect-mongodb/test/Collection.test.ts

@@ -45,7 +45,7 @@ describeMongo("Collection", (ctx) => {
 
       const _1990 = "1990-01-01T00:00:00.000Z"
       return yield* _(
-        Collection.aggregate(collection, [
+        Collection.aggregate(collection, UserAggregation, [
           {
             $match: {
               birthday: { $lt: _1990 }
@@ -60,7 +60,7 @@ describeMongo("Collection", (ctx) => {
           {
             $sort: { _id: 1 }
           }
-        ], UserAggregation),
+        ]),
         AggregationCursor.toArray
       )
     })