@aneuhold/be-ts-db-lib 4.0.2 → 4.1.0

package/lib/util/DbOperationMetaData.d.ts

@@ -0,0 +1,47 @@
+import type { UUID } from 'crypto';
+/**
+ * Tracks metadata about database operations during a single API request.
+ *
+ * This is intentionally **not** called "context" to avoid confusion with other libraries that
+ * use that term for different concepts.
+ */
+export default class DbOperationMetaData {
+    private readonly docTypesTouched;
+    private readonly affectedUserIds;
+    private readonly docCache;
+    /**
+     * Records that a doc type was touched by an operation during this request.
+     *
+     * @param docType - The doc type that was touched.
+     */
+    recordDocTypeTouched(docType: string): void;
+    /**
+     * Records multiple user IDs as affected by an operation during this request.
+     *
+     * @param userIds - The user IDs to record as affected.
+     */
+    addAffectedUserIds(userIds: UUID[]): void;
+    /**
+     * Gets all doc types that were touched during this request.
+     */
+    getDocTypesTouched(): Set<string>;
+    /**
+     * Gets all user IDs recorded as affected during this request.
+     */
+    getAffectedUserIds(): Set<UUID>;
+    /**
+     * Caches a document by its ID to prevent duplicate queries during this request.
+     *
+     * @param docId - The ID of the document to cache.
+     * @param doc - The document to cache.
+     */
+    cacheDoc<T>(docId: UUID, doc: T): void;
+    /**
+     * Retrieves a cached document by its ID.
+     *
+     * @param docId - The ID of the document to retrieve.
+     * @returns The cached document, or undefined if not found.
+     */
+    getCachedDoc<T>(docId: UUID): T | undefined;
+}
+//# sourceMappingURL=DbOperationMetaData.d.ts.map

package/lib/util/DbOperationMetaData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbOperationMetaData.d.ts","sourceRoot":"","sources":["../../src/util/DbOperationMetaData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IAErD;;;;OAIG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI3C;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI;IAIzC;;OAEG;IACH,kBAAkB,IAAI,GAAG,CAAC,MAAM,CAAC;IAIjC;;OAEG;IACH,kBAAkB,IAAI,GAAG,CAAC,IAAI,CAAC;IAI/B;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI;IAItC;;;;;OAKG;IACH,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,GAAG,SAAS;CAG5C"}

package/lib/util/DbOperationMetaData.js

@@ -0,0 +1,58 @@
+/**
+ * Tracks metadata about database operations during a single API request.
+ *
+ * This is intentionally **not** called "context" to avoid confusion with other libraries that
+ * use that term for different concepts.
+ */
+export default class DbOperationMetaData {
+    docTypesTouched = new Set();
+    affectedUserIds = new Set();
+    docCache = new Map();
+    /**
+     * Records that a doc type was touched by an operation during this request.
+     *
+     * @param docType - The doc type that was touched.
+     */
+    recordDocTypeTouched(docType) {
+        this.docTypesTouched.add(docType);
+    }
+    /**
+     * Records multiple user IDs as affected by an operation during this request.
+     *
+     * @param userIds - The user IDs to record as affected.
+     */
+    addAffectedUserIds(userIds) {
+        userIds.forEach((userId) => this.affectedUserIds.add(userId));
+    }
+    /**
+     * Gets all doc types that were touched during this request.
+     */
+    getDocTypesTouched() {
+        return this.docTypesTouched;
+    }
+    /**
+     * Gets all user IDs recorded as affected during this request.
+     */
+    getAffectedUserIds() {
+        return this.affectedUserIds;
+    }
+    /**
+     * Caches a document by its ID to prevent duplicate queries during this request.
+     *
+     * @param docId - The ID of the document to cache.
+     * @param doc - The document to cache.
+     */
+    cacheDoc(docId, doc) {
+        this.docCache.set(docId, doc);
+    }
+    /**
+     * Retrieves a cached document by its ID.
+     *
+     * @param docId - The ID of the document to retrieve.
+     * @returns The cached document, or undefined if not found.
+     */
+    getCachedDoc(docId) {
+        return this.docCache.get(docId);
+    }
+}
+//# sourceMappingURL=DbOperationMetaData.js.map

package/lib/util/DbOperationMetaData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbOperationMetaData.js","sourceRoot":"","sources":["../../src/util/DbOperationMetaData.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACrB,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,eAAe,GAAG,IAAI,GAAG,EAAQ,CAAC;IAClC,QAAQ,GAAG,IAAI,GAAG,EAAiB,CAAC;IAErD;;;;OAIG;IACH,oBAAoB,CAAC,OAAe;QAClC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,OAAe;QAChC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAI,KAAW,EAAE,GAAM;QAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAI,KAAW;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAkB,CAAC;IACnD,CAAC;CACF"}

package/lib/util/DbOperationMetaData.ts

@@ -0,0 +1,65 @@
+import type { UUID } from 'crypto';
+
+/**
+ * Tracks metadata about database operations during a single API request.
+ *
+ * This is intentionally **not** called "context" to avoid confusion with other libraries that
+ * use that term for different concepts.
+ */
+export default class DbOperationMetaData {
+  private readonly docTypesTouched = new Set<string>();
+  private readonly affectedUserIds = new Set<UUID>();
+  private readonly docCache = new Map<UUID, unknown>();
+
+  /**
+   * Records that a doc type was touched by an operation during this request.
+   *
+   * @param docType - The doc type that was touched.
+   */
+  recordDocTypeTouched(docType: string): void {
+    this.docTypesTouched.add(docType);
+  }
+
+  /**
+   * Records multiple user IDs as affected by an operation during this request.
+   *
+   * @param userIds - The user IDs to record as affected.
+   */
+  addAffectedUserIds(userIds: UUID[]): void {
+    userIds.forEach((userId) => this.affectedUserIds.add(userId));
+  }
+
+  /**
+   * Gets all doc types that were touched during this request.
+   */
+  getDocTypesTouched(): Set<string> {
+    return this.docTypesTouched;
+  }
+
+  /**
+   * Gets all user IDs recorded as affected during this request.
+   */
+  getAffectedUserIds(): Set<UUID> {
+    return this.affectedUserIds;
+  }
+
+  /**
+   * Caches a document by its ID to prevent duplicate queries during this request.
+   *
+   * @param docId - The ID of the document to cache.
+   * @param doc - The document to cache.
+   */
+  cacheDoc<T>(docId: UUID, doc: T): void {
+    this.docCache.set(docId, doc);
+  }
+
+  /**
+   * Retrieves a cached document by its ID.
+   *
+   * @param docId - The ID of the document to retrieve.
+   * @returns The cached document, or undefined if not found.
+   */
+  getCachedDoc<T>(docId: UUID): T | undefined {
+    return this.docCache.get(docId) as T | undefined;
+  }
+}

package/package.json

@@ -2,9 +2,9 @@
   "name": "@aneuhold/be-ts-db-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "A backend database library meant to actually interact with various databases in personal projects",
-  "packageManager": "pnpm@10.12.1",
+  "packageManager": "pnpm@10.25.0",
   "type": "module",
   "scripts": {
     "build": "rimraf lib && pnpm build:withoutClean",
@@ -13,7 +13,7 @@
     "watch": "nodemon --ignore lib/ -e ts --exec \"pnpm build:withoutClean && local-npm publish\"",
     "unpub:local": "local-npm unpublish || true",
     "lint": "eslint",
-    "test": "vitest run && pnpm validate:dry",
+    "test": "vitest run --coverage && pnpm validate:dry",
     "preparePkg": "tb pkg prepare",
     "validate": "tsx ./scripts/validateSchema.ts",
     "validate:dry": "tsx ./scripts/validateSchemaDryRun.ts",
@@ -57,21 +57,22 @@
     "MongoDB"
   ],
   "dependencies": {
-    "@aneuhold/be-ts-lib": "^3.0.6",
-    "@aneuhold/core-ts-db-lib": "^4.0.2",
-    "@aneuhold/core-ts-lib": "^2.3.14",
+    "@aneuhold/be-ts-lib": "^3.0.7",
+    "@aneuhold/core-ts-db-lib": "^4.0.3",
+    "@aneuhold/core-ts-lib": "^2.3.15",
     "bson": "^7.0.0",
     "mongodb": "^7.0.0",
     "uuid": "^13.0.0",
     "zod": "^4.1.13"
   },
   "devDependencies": {
-    "@aneuhold/local-npm-registry": "^0.2.21",
+    "@aneuhold/local-npm-registry": "^0.2.22",
     "@aneuhold/main-scripts": "^2.8.0",
-    "@types/node": "^24.10.1",
+    "@types/node": "^25.0.2",
     "@types/node-fetch": "^2.6.13",
+    "@vitest/coverage-v8": "^4.0.15",
     "dotenv": "^17.2.3",
-    "eslint": "^9.39.1",
+    "eslint": "^9.39.2",
     "jsr": "^0.13.5",
     "prettier": "^3.7.4",
     "rimraf": "^6.1.2",
@@ -80,4 +81,4 @@
     "typescript": "^5.9.3",
     "vitest": "^4.0.15"
   }
-}
+}