@frogfish/k2db 3.0.2 → 3.0.3

package/data.d.ts

@@ -1,5 +1,5 @@
 import { K2DB } from "./db.js";
-import type { BaseDocument, CreateResult, UpdateResult, DeleteResult, RestoreResult, CountResult, DropResult, VersionedUpdateResult, VersionInfo } from "./db.js";
+import type { BaseDocument, CreateResult, UpdateResult, DeleteResult, RestoreResult, CountResult, DropResult, PurgeResult, PurgeManyResult, VersionedUpdateResult, VersionInfo } from "./db.js";
 export declare class K2Data {
     private db;
     private owner;
@@ -68,9 +68,11 @@ export declare class K2Data {
     /**
      * Permanently deletes a document that has been soft-deleted.
      */
-    purge(collectionName: string, id: string): Promise<{
-        id: string;
-    }>;
+    purge(collectionName: string, id: string): Promise<PurgeResult>;
+    /**
+     * Permanently deletes all soft-deleted documents older than a threshold.
+     */
+    purgeDeletedOlderThan(collectionName: string, olderThanMs: number): Promise<PurgeManyResult>;
     /**
      * Restores a soft-deleted document.
      */
@@ -83,6 +85,15 @@ export declare class K2Data {
      * Drops an entire collection.
      */
     drop(collectionName: string): Promise<DropResult>;
+    /**
+     * Ensure commonly needed indexes exist.
+     */
+    ensureIndexes(collectionName: string, opts?: {
+        uuidUnique?: boolean;
+        uuidPartialUnique?: boolean;
+        ownerIndex?: boolean;
+        deletedIndex?: boolean;
+    }): Promise<void>;
     /**
      * Executes a transaction with the provided operations.
      */
@@ -95,6 +106,18 @@ export declare class K2Data {
      * Drops the entire database.
      */
     dropDatabase(): Promise<void>;
+    /**
+     * Releases the MongoDB connection.
+     */
+    release(): Promise<void>;
+    /**
+     * Closes the MongoDB connection.
+     */
+    close(): void;
+    /**
+     * Validates the MongoDB collection name.
+     */
+    validateCollectionName(collectionName: string): void;
     /**
      * Checks the health of the database connection.
      */
@@ -102,4 +125,4 @@ export declare class K2Data {
 }
 export { K2DB } from "./db.js";
 export declare const isK2ID: (id: string) => boolean;
-export type { DatabaseConfig, BaseDocument, CreateResult, UpdateResult, DeleteResult, RestoreResult, CountResult, DropResult, VersionedUpdateResult, VersionInfo, } from "./db.js";
+export type { DatabaseConfig, BaseDocument, CreateResult, UpdateResult, DeleteResult, RestoreResult, CountResult, DropResult, PurgeResult, PurgeManyResult, VersionedUpdateResult, VersionInfo, } from "./db.js";

package/data.js

@@ -12,7 +12,7 @@ export class K2Data {
      * @param uuid - UUID of the document.
      */
     async get(collectionName, uuid) {
-        return this.db.get(collectionName, uuid);
+        return this.db.get(collectionName, uuid, this.owner);
     }
     /**
      * Retrieves a single document matching the criteria.
@@ -21,19 +21,19 @@ export class K2Data {
      * @param fields - Optional fields to include.
      */
     async findOne(collectionName, criteria, fields) {
-        return this.db.findOne(collectionName, criteria, fields);
+        return this.db.findOne(collectionName, criteria, fields, this.owner);
     }
     /**
      * Finds documents based on filter with optional parameters and pagination.
      */
     async find(collectionName, filter, params, skip, limit) {
-        return this.db.find(collectionName, filter, params, skip, limit);
+        return this.db.find(collectionName, filter, params, skip, limit, this.owner);
     }
     /**
      * Aggregates documents based on criteria with pagination support.
      */
     async aggregate(collectionName, criteria, skip, limit) {
-        return this.db.aggregate(collectionName, criteria, skip, limit);
+        return this.db.aggregate(collectionName, criteria, skip, limit, this.owner);
     }
     /**
      * Creates a new document in the collection.
@@ -46,28 +46,28 @@ export class K2Data {
      */
     async updateAll(collectionName, criteria, values) {
         // Ensure it returns { updated: number }
-        return this.db.updateAll(collectionName, criteria, values);
+        return this.db.updateAll(collectionName, criteria, values, this.owner);
     }
     /**
      * Updates a single document by UUID.
      */
     async update(collectionName, id, data, replace = false) {
         // Ensure it returns { updated: number }
-        return this.db.update(collectionName, id, data, replace);
+        return this.db.update(collectionName, id, data, replace, this.owner);
     }
     /**
      * Updates a single document by UUID and saves the previous version to history.
      */
     async updateVersioned(collectionName, id, data, replace = false, maxVersions) {
-        return this.db.updateVersioned(collectionName, id, data, replace, maxVersions);
+        return this.db.updateVersioned(collectionName, id, data, replace, maxVersions, this.owner);
     }
     /** List versions for a document (latest first). */
     async listVersions(collectionName, id, skip, limit) {
-        return this.db.listVersions(collectionName, id, skip, limit);
+        return this.db.listVersions(collectionName, id, skip, limit, this.owner);
     }
     /** Revert a document to a prior version. */
     async revertToVersion(collectionName, id, version) {
-        return this.db.revertToVersion(collectionName, id, version);
+        return this.db.revertToVersion(collectionName, id, version, this.owner);
     }
     /** Ensure history collection indexes exist. */
     async ensureHistoryIndexes(collectionName) {
@@ -90,37 +90,49 @@ export class K2Data {
      */
     async deleteAll(collectionName, criteria) {
         // Ensure it returns { deleted: number }
-        return this.db.deleteAll(collectionName, criteria);
+        return this.db.deleteAll(collectionName, criteria, this.owner);
     }
     /**
      * Removes (soft deletes) a single document by UUID.
      */
     async delete(collectionName, id) {
-        return this.db.delete(collectionName, id);
+        return this.db.delete(collectionName, id, this.owner);
     }
     /**
      * Permanently deletes a document that has been soft-deleted.
      */
     async purge(collectionName, id) {
-        return this.db.purge(collectionName, id);
+        return this.db.purge(collectionName, id, this.owner);
+    }
+    /**
+     * Permanently deletes all soft-deleted documents older than a threshold.
+     */
+    async purgeDeletedOlderThan(collectionName, olderThanMs) {
+        return this.db.purgeDeletedOlderThan(collectionName, olderThanMs, this.owner);
     }
     /**
      * Restores a soft-deleted document.
      */
     async restore(collectionName, criteria) {
-        return this.db.restore(collectionName, criteria);
+        return this.db.restore(collectionName, criteria, this.owner);
     }
     /**
      * Counts documents based on criteria.
      */
     async count(collectionName, criteria) {
-        return this.db.count(collectionName, criteria);
+        return this.db.count(collectionName, criteria, this.owner);
     }
     /**
      * Drops an entire collection.
      */
     async drop(collectionName) {
-        return this.db.drop(collectionName);
+        return this.db.drop(collectionName, this.owner);
+    }
+    /**
+     * Ensure commonly needed indexes exist.
+     */
+    async ensureIndexes(collectionName, opts) {
+        return this.db.ensureIndexes(collectionName, opts);
     }
     /**
      * Executes a transaction with the provided operations.
@@ -140,6 +152,24 @@ export class K2Data {
     async dropDatabase() {
         return this.db.dropDatabase();
     }
+    /**
+     * Releases the MongoDB connection.
+     */
+    async release() {
+        return this.db.release();
+    }
+    /**
+     * Closes the MongoDB connection.
+     */
+    close() {
+        this.db.close();
+    }
+    /**
+     * Validates the MongoDB collection name.
+     */
+    validateCollectionName(collectionName) {
+        return this.db.validateCollectionName(collectionName);
+    }
     /**
      * Checks the health of the database connection.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frogfish/k2db",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "A data handling library for K2 applications.",
   "type": "module",
   "main": "data.js",