mongolite-ts 0.6.2 → 0.7.2

package/dist/collection.d.ts

@@ -1,5 +1,5 @@
 import { SQLiteDB } from './db.js';
-import { DocumentWithId, Filter, UpdateFilter, InsertOneResult, UpdateResult, DeleteResult, Projection, IndexSpecification, CreateIndexOptions, CreateIndexResult, DropIndexResult, IndexInfo } from './types.js';
+import { DocumentWithId, Filter, UpdateFilter, InsertOneResult, InsertManyResult, UpdateResult, DeleteResult, Projection, IndexSpecification, CreateIndexOptions, CreateIndexResult, DropIndexResult, IndexInfo, FindOneAndUpdateOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, ReplaceOptions, AggregationPipeline } from './types.js';
 import { FindCursor } from './cursors/findCursor.js';
 import { ChangeStream, ChangeStreamOptions } from './changeStream.js';
 /**
@@ -33,11 +33,11 @@ export declare class MongoLiteCollection<T extends DocumentWithId> {
      * If any document does not have an `_id`, a UUID will be generated.
      * Uses batch insert with transactions for improved performance.
      * @param docs An array of documents to insert.
-     * @returns {Promise<InsertOneResult[]>} An array of results for each insert operation.
+     * @returns {Promise<InsertManyResult>} An object containing the outcome of all insert operations.
      * */
     insertMany(docs: (Omit<T, '_id'> & {
         _id?: string;
-    })[]): Promise<InsertOneResult[]>;
+    })[]): Promise<InsertManyResult>;
     /**
      * Inserts a batch of documents using a single transaction for optimal performance.
      * @private
@@ -48,8 +48,11 @@ export declare class MongoLiteCollection<T extends DocumentWithId> {
      * @param filter The query criteria.
      * @param projection Optional. Specifies the fields to return.
      * @returns {Promise<T | null>} The found document or `null`.
+     * @remarks When using a projection, some fields may be undefined at runtime despite the
+     * return type being `T`. This provides better ergonomics for the common case where no
+     * projection is used.
      */
-    findOne(filter: Filter<T>, projection?: Projection<T>): Promise<Partial<T> | null>;
+    findOne(filter: Filter<T>, projection?: Projection<T>): Promise<T | null>;
     /**
      * Finds multiple documents matching the filter and returns a cursor.
      * @param filter The query criteria.
@@ -148,6 +151,90 @@ export declare class MongoLiteCollection<T extends DocumentWithId> {
      * @returns {Promise<number>} The count of matching documents.
      */
     countDocuments(filter?: Filter<T>): Promise<number>;
+    /**
+     * Returns the number of documents in the collection.
+     * This is an estimate and may not reflect the exact count in concurrent environments.
+     * @returns {Promise<number>} The estimated count.
+     */
+    estimatedDocumentCount(): Promise<number>;
+    /**
+     * Finds a single document matching the filter, applies the update, and returns the document.
+     * @param filter The selection criteria.
+     * @param update The modifications to apply.
+     * @param options Options including returnDocument ('before'|'after') and upsert.
+     * @returns {Promise<T | null>} The document before or after the update, or null.
+     */
+    findOneAndUpdate(filter: Filter<T>, update: UpdateFilter<T>, options?: FindOneAndUpdateOptions<T>): Promise<T | null>;
+    /**
+     * Finds a single document matching the filter, deletes it, and returns it.
+     * @param filter The selection criteria.
+     * @param options Options including field projection.
+     * @returns {Promise<T | null>} The deleted document or null.
+     */
+    findOneAndDelete(filter: Filter<T>, options?: FindOneAndDeleteOptions<T>): Promise<T | null>;
+    /**
+     * Finds a single document matching the filter and replaces it entirely.
+     * @param filter The selection criteria.
+     * @param replacement The replacement document (replaces all fields except _id).
+     * @param options Options including returnDocument, upsert, and projection.
+     * @returns {Promise<T | null>} The document before or after the replacement, or null.
+     */
+    findOneAndReplace(filter: Filter<T>, replacement: Omit<T, '_id'>, options?: FindOneAndReplaceOptions<T>): Promise<T | null>;
+    /**
+     * Replaces a single document matching the filter.
+     * @param filter The selection criteria.
+     * @param replacement The replacement document (replaces all fields except _id).
+     * @param options Options including upsert.
+     * @returns {Promise<UpdateResult>} An object describing the outcome.
+     */
+    replaceOne(filter: Filter<T>, replacement: Omit<T, '_id'>, options?: ReplaceOptions): Promise<UpdateResult>;
+    /**
+     * Returns distinct values for a field across all documents matching the filter.
+     * @param field The field to find distinct values for.
+     * @param filter Optional filter to narrow the documents.
+     * @returns {Promise<unknown[]>} An array of distinct values.
+     */
+    distinct(field: string, filter?: Filter<T>): Promise<unknown[]>;
+    /**
+     * Drops the entire collection (table) from the database.
+     * @returns {Promise<void>}
+     */
+    drop(): Promise<void>;
+    /**
+     * Executes an aggregation pipeline on the collection.
+     * Supports: $match, $project, $sort, $limit, $skip, $count, $group, $unwind, $addFields.
+     * @param pipeline An array of pipeline stage documents.
+     * @returns An object with a toArray() method that returns the aggregation result.
+     */
+    aggregate(pipeline: AggregationPipeline): {
+        toArray: () => Promise<Record<string, unknown>[]>;
+    };
+    /**
+     * Runs an aggregation pipeline and returns results.
+     * @private
+     */
+    private runAggregationPipeline;
+    /**
+     * Applies a $group pipeline stage.
+     * @private
+     */
+    private applyGroupStage;
+    /**
+     * Applies a $project stage to a document.
+     * @private
+     */
+    private applyAggregateProjection;
+    /**
+     * Checks if a document matches a filter (for in-memory aggregation stages).
+     * Uses the same logic as FindCursor but applied in JavaScript.
+     * @private
+     */
+    private matchesFilter;
+    /**
+     * Checks if a value matches a set of query operators (for in-memory filtering).
+     * @private
+     */
+    private matchesOperators;
     /**
      * Opens a change stream to watch for changes on this collection.
      * Returns a ChangeStream that emits events when documents are inserted, updated, or deleted.