firestore-batch-updater 1.14.0 → 1.15.0

package/README.ko.md

@@ -20,7 +20,7 @@
 - 비어있는지 확인 - `isEmpty()`로 매칭 문서가 없는지 확인 (`exists()`의 반대)
 - 전체 문서 조회 - `getAll()`로 매칭되는 모든 문서 데이터 조회
 - 집계 쿼리 - `aggregate()`로 서버 사이드 `sum`, `average`, `count` 연산
-- 간편 집계 - `sum()`과 `avg()`로 단일 필드 간편 집계
+- 간편 집계 - `sum()`, `avg()`, `min()`, `max()`로 단일 필드 간편 집계
 - 커서 페이지네이션 - `paginate()`로 메모리 효율적인 페이지 단위 조회
 - ID 직접 조회 - `getOne()`으로 문서 ID로 빠른 조회
 - 벌크 작업 - `bulkCreate()`, `bulkUpdate()`, `bulkDelete()`로 여러 문서에 각기 다른 데이터로 효율적 처리
@@ -118,6 +118,8 @@ console.log(`${result.successCount}개 문서 업데이트 완료`);
 | `aggregate(spec)` | sum/average/count 집계 쿼리 | `AggregateResult` |
 | `sum(field)` | 숫자 필드 합계 조회 | `number \| null` |
 | `avg(field)` | 숫자 필드 평균 조회 | `number \| null` |
+| `min(field)` | 필드 최소값 조회 | `any` |
+| `max(field)` | 필드 최대값 조회 | `any` |
 | `paginate(options)` | 커서 기반 페이지네이션 | `PaginateResult` |
 | `bulkCreate(docs, options?)` | 여러 문서를 각기 다른 데이터로 생성 | `BulkCreateResult` |
 | `bulkUpdate(updates, options?)` | 여러 문서에 각기 다른 데이터 업데이트 | `BulkUpdateResult` |
@@ -542,6 +544,29 @@ console.log(`평균 점수: ${avgScore}`);
 // aggregate({ avg: { op: "average", field: "score" } }) → avg("score")
 ```
 
+### 최솟값 & 최댓값
+
+```typescript
+// 필드의 최솟값/최댓값 조회
+const cheapest = await updater.collection("products").min("price");
+const mostExpensive = await updater.collection("products").max("price");
+console.log(`가격 범위: ${cheapest}원 - ${mostExpensive}원`);
+
+// 날짜/타임스탬프에도 사용 가능
+const earliestOrder = await updater
+  .collection("orders")
+  .where("status", "==", "completed")
+  .min("createdAt");
+
+// 매칭 문서가 없으면 null 반환
+const maxScore = await updater
+  .collection("users")
+  .where("status", "==", "nonexistent")
+  .max("score"); // null
+```
+
+> 참고: 한 필드에 `where()`를 걸고 다른 필드에 `min()/max()`를 사용할 경우 Firestore 복합 인덱스가 필요할 수 있습니다. `FAILED_PRECONDITION` 오류가 발생하면 오류 메시지의 링크를 통해 인덱스를 생성하세요.
+
 ### 커서 기반 페이지네이션
 
 ```typescript

package/README.md

@@ -20,7 +20,7 @@ English | [한국어](./README.ko.md)
 - Empty check - Use `isEmpty()` to check if no matching documents exist (opposite of `exists()`)
 - Get all documents - Use `getAll()` to retrieve all matching documents with data
 - Aggregation - Use `aggregate()` for server-side `sum`, `average`, and `count` operations
-- Quick aggregation - Use `sum()` and `avg()` for simple single-field aggregation
+- Quick aggregation - Use `sum()`, `avg()`, `min()`, `max()` for simple single-field aggregation
 - Cursor pagination - Use `paginate()` for memory-efficient page-by-page iteration
 - Direct ID lookup - Use `getOne()` for fast document retrieval by ID
 - Bulk operations - Use `bulkCreate()`, `bulkUpdate()`, `bulkDelete()` for efficient multi-document operations with different data each
@@ -118,6 +118,8 @@ console.log(`Updated ${result.successCount} documents`);
 | `aggregate(spec)` | Run sum/average/count queries | `AggregateResult` |
 | `sum(field)` | Get sum of a numeric field | `number \| null` |
 | `avg(field)` | Get average of a numeric field | `number \| null` |
+| `min(field)` | Get minimum value of a field | `any` |
+| `max(field)` | Get maximum value of a field | `any` |
 | `paginate(options)` | Cursor-based pagination | `PaginateResult` |
 | `bulkCreate(docs, options?)` | Create multiple docs with different data | `BulkCreateResult` |
 | `bulkUpdate(updates, options?)` | Update multiple docs with different data | `BulkUpdateResult` |
@@ -566,6 +568,29 @@ console.log(`Average score: ${avgScore}`);
 // aggregate({ avg: { op: "average", field: "score" } }) → avg("score")
 ```
 
+### Min & Max
+
+```typescript
+// Get the minimum/maximum value of a field
+const cheapest = await updater.collection("products").min("price");
+const mostExpensive = await updater.collection("products").max("price");
+console.log(`Price range: $${cheapest} - $${mostExpensive}`);
+
+// Works with dates/timestamps too
+const earliestOrder = await updater
+  .collection("orders")
+  .where("status", "==", "completed")
+  .min("createdAt");
+
+// Returns null if no documents match
+const maxScore = await updater
+  .collection("users")
+  .where("status", "==", "nonexistent")
+  .max("score"); // null
+```
+
+> Note: Combining `where()` on one field with `min()/max()` on a different field may require a Firestore composite index. If you see a `FAILED_PRECONDITION` error, follow the link in the error message to create the required index.
+
 ### Cursor-Based Pagination
 
 ```typescript

package/dist/index.d.mts

@@ -655,6 +655,20 @@ declare class BatchUpdater {
      * @returns Average of the field values, or null if no documents match
      */
     avg(field: string): Promise<number | null>;
+    /**
+     * Get the minimum value of a numeric field from matching documents
+     * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+     * @param field - Field path to find the minimum value of
+     * @returns Minimum field value, or null if no documents match
+     */
+    min(field: string): Promise<any>;
+    /**
+     * Get the maximum value of a numeric field from matching documents
+     * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+     * @param field - Field path to find the maximum value of
+     * @returns Maximum field value, or null if no documents match
+     */
+    max(field: string): Promise<any>;
     /**
      * Get documents with cursor-based pagination
      * @param options - Pagination options (pageSize, startAfter cursor)

package/dist/index.d.ts

@@ -655,6 +655,20 @@ declare class BatchUpdater {
      * @returns Average of the field values, or null if no documents match
      */
     avg(field: string): Promise<number | null>;
+    /**
+     * Get the minimum value of a numeric field from matching documents
+     * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+     * @param field - Field path to find the minimum value of
+     * @returns Minimum field value, or null if no documents match
+     */
+    min(field: string): Promise<any>;
+    /**
+     * Get the maximum value of a numeric field from matching documents
+     * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+     * @param field - Field path to find the maximum value of
+     * @returns Maximum field value, or null if no documents match
+     */
+    max(field: string): Promise<any>;
     /**
      * Get documents with cursor-based pagination
      * @param options - Pagination options (pageSize, startAfter cursor)

package/dist/index.js

@@ -501,6 +501,52 @@ var BatchUpdater = class {
     });
     return result._avg;
   }
+  /**
+   * Get the minimum value of a numeric field from matching documents
+   * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+   * @param field - Field path to find the minimum value of
+   * @returns Minimum field value, or null if no documents match
+   */
+  async min(field) {
+    this.validateSetup();
+    if (!field || typeof field !== "string") {
+      throw new Error("Field is required for min operation");
+    }
+    let query = this.isCollectionGroup ? this.firestore.collectionGroup(this.collectionPath) : this.firestore.collection(this.collectionPath);
+    for (const condition of this.conditions) {
+      query = query.where(condition.field, condition.operator, condition.value);
+    }
+    query = query.orderBy(field, "asc").limit(1);
+    const snapshot = await query.get();
+    if (snapshot.empty) {
+      return null;
+    }
+    const value = this.getNestedValue(snapshot.docs[0].data(), field);
+    return value ?? null;
+  }
+  /**
+   * Get the maximum value of a numeric field from matching documents
+   * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+   * @param field - Field path to find the maximum value of
+   * @returns Maximum field value, or null if no documents match
+   */
+  async max(field) {
+    this.validateSetup();
+    if (!field || typeof field !== "string") {
+      throw new Error("Field is required for max operation");
+    }
+    let query = this.isCollectionGroup ? this.firestore.collectionGroup(this.collectionPath) : this.firestore.collection(this.collectionPath);
+    for (const condition of this.conditions) {
+      query = query.where(condition.field, condition.operator, condition.value);
+    }
+    query = query.orderBy(field, "desc").limit(1);
+    const snapshot = await query.get();
+    if (snapshot.empty) {
+      return null;
+    }
+    const value = this.getNestedValue(snapshot.docs[0].data(), field);
+    return value ?? null;
+  }
   /**
    * Get documents with cursor-based pagination
    * @param options - Pagination options (pageSize, startAfter cursor)

package/dist/index.mjs

@@ -456,6 +456,52 @@ var BatchUpdater = class {
     });
     return result._avg;
   }
+  /**
+   * Get the minimum value of a numeric field from matching documents
+   * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+   * @param field - Field path to find the minimum value of
+   * @returns Minimum field value, or null if no documents match
+   */
+  async min(field) {
+    this.validateSetup();
+    if (!field || typeof field !== "string") {
+      throw new Error("Field is required for min operation");
+    }
+    let query = this.isCollectionGroup ? this.firestore.collectionGroup(this.collectionPath) : this.firestore.collection(this.collectionPath);
+    for (const condition of this.conditions) {
+      query = query.where(condition.field, condition.operator, condition.value);
+    }
+    query = query.orderBy(field, "asc").limit(1);
+    const snapshot = await query.get();
+    if (snapshot.empty) {
+      return null;
+    }
+    const value = this.getNestedValue(snapshot.docs[0].data(), field);
+    return value ?? null;
+  }
+  /**
+   * Get the maximum value of a numeric field from matching documents
+   * Uses orderBy + limit(1) since Firestore doesn't support min/max aggregation natively
+   * @param field - Field path to find the maximum value of
+   * @returns Maximum field value, or null if no documents match
+   */
+  async max(field) {
+    this.validateSetup();
+    if (!field || typeof field !== "string") {
+      throw new Error("Field is required for max operation");
+    }
+    let query = this.isCollectionGroup ? this.firestore.collectionGroup(this.collectionPath) : this.firestore.collection(this.collectionPath);
+    for (const condition of this.conditions) {
+      query = query.where(condition.field, condition.operator, condition.value);
+    }
+    query = query.orderBy(field, "desc").limit(1);
+    const snapshot = await query.get();
+    if (snapshot.empty) {
+      return null;
+    }
+    const value = this.getNestedValue(snapshot.docs[0].data(), field);
+    return value ?? null;
+  }
   /**
    * Get documents with cursor-based pagination
    * @param options - Pagination options (pageSize, startAfter cursor)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-batch-updater",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "Batch update Firestore documents with query-based filtering and preview",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",