@aneuhold/core-ts-db-lib 2.0.83 → 2.0.85

package/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 🔖 [2.0.85] (2025-10-25)
+
+### 🏗️ Changed
+
+- Updated dependencies in package.json for compatibility and security improvements
+
+## 🔖 [2.0.84] (2025-10-17)
+
+### 🏗️ Changed
+
+- Improved and expanded JSDoc comments and documentation for public types and methods throughout the package
+
 ## 🔖 [2.0.83] (2025-07-04)
 
 ### 🏗️ Changed
@@ -38,6 +50,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- Link References -->
 
+[2.0.85]: https://github.com/aneuhold/ts-libs/compare/core-ts-db-lib-v2.0.84...core-ts-db-lib-v2.0.85
+[2.0.84]: https://github.com/aneuhold/ts-libs/compare/core-ts-db-lib-v2.0.83...core-ts-db-lib-v2.0.84
 [2.0.83]: https://github.com/aneuhold/ts-libs/compare/core-ts-db-lib-v2.0.82...core-ts-db-lib-v2.0.83
 [2.0.82]: https://github.com/aneuhold/ts-libs/compare/core-ts-db-lib-v2.0.81...core-ts-db-lib-v2.0.82
 [2.0.81]: https://github.com/aneuhold/ts-libs/compare/core-ts-db-lib-v2.0.80...core-ts-db-lib-v2.0.81

package/lib/documents/BaseDocument.d.ts

@@ -1,9 +1,12 @@
 import { Document, ObjectId } from 'bson';
 /**
- * A base document which other types that will be stored in a document DB can
- * inherit from.
+ * Base class for all document types stored in a document database.
+ *
+ * Provides the common `_id` field required by MongoDB and other
+ * document databases. All document types should extend this class.
  */
 export default abstract class BaseDocument implements Document {
+    /** The unique identifier for this document */
     _id: ObjectId;
 }
 //# sourceMappingURL=BaseDocument.d.ts.map

package/lib/documents/BaseDocument.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDocument.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,YAAa,YAAW,QAAQ;IAC5D,GAAG,EAAE,QAAQ,CAAkB;CAChC"}
+{"version":3,"file":"BaseDocument.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,YAAa,YAAW,QAAQ;IAC5D,8CAA8C;IAC9C,GAAG,EAAE,QAAQ,CAAkB;CAChC"}

package/lib/documents/BaseDocument.js

@@ -1,9 +1,12 @@
 import { ObjectId } from 'bson';
 /**
- * A base document which other types that will be stored in a document DB can
- * inherit from.
+ * Base class for all document types stored in a document database.
+ *
+ * Provides the common `_id` field required by MongoDB and other
+ * document databases. All document types should extend this class.
  */
 export default class BaseDocument {
+    /** The unique identifier for this document */
     _id = new ObjectId();
 }
 //# sourceMappingURL=BaseDocument.js.map

package/lib/documents/BaseDocument.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDocument.js","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAgB,YAAY;IACxC,GAAG,GAAa,IAAI,QAAQ,EAAE,CAAC;CAChC"}
+{"version":3,"file":"BaseDocument.js","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAgB,YAAY;IACxC,8CAA8C;IAC9C,GAAG,GAAa,IAAI,QAAQ,EAAE,CAAC;CAChC"}

package/lib/documents/BaseDocument.ts

@@ -1,9 +1,12 @@
 import { Document, ObjectId } from 'bson';
 
 /**
- * A base document which other types that will be stored in a document DB can
- * inherit from.
+ * Base class for all document types stored in a document database.
+ *
+ * Provides the common `_id` field required by MongoDB and other
+ * document databases. All document types should extend this class.
  */
 export default abstract class BaseDocument implements Document {
+  /** The unique identifier for this document */
   _id: ObjectId = new ObjectId();
 }

package/lib/services/DocumentService.d.ts

@@ -1,6 +1,8 @@
 import BaseDocument from '../documents/BaseDocument.js';
 /**
- * A utility type for a map of documents.
+ * Utility type for mapping document IDs to their corresponding documents.
+ *
+ * @template T - The type of document being mapped, must extend BaseDocument.
  */
 export type DocumentMap<T extends BaseDocument> = {
     [docId: string]: T | undefined;
@@ -9,6 +11,11 @@ export type DocumentMap<T extends BaseDocument> = {
  * A service for low-level utilities related to documents.
  */
 export default class DocumentService {
+    /**
+     * Creates a deep copy of an object using EJSON serialization.
+     *
+     * @param obj - The object to copy.
+     */
     static deepCopy<T extends object>(obj: T): T;
 }
 //# sourceMappingURL=DocumentService.d.ts.map

package/lib/services/DocumentService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentService.d.ts","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,IAAI;IAChD,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;CAG7C"}
+{"version":3,"file":"DocumentService.d.ts","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,IAAI;IAChD,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;CAG7C"}

package/lib/services/DocumentService.js

@@ -3,6 +3,11 @@ import { EJSON } from 'bson';
  * A service for low-level utilities related to documents.
  */
 export default class DocumentService {
+    /**
+     * Creates a deep copy of an object using EJSON serialization.
+     *
+     * @param obj - The object to copy.
+     */
     static deepCopy(obj) {
         return EJSON.parse(EJSON.stringify(obj, { relaxed: false }));
     }

package/lib/services/DocumentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentService.js","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAU7B;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,MAAM,CAAC,QAAQ,CAAmB,GAAM;QACtC,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAM,CAAC;IACpE,CAAC;CACF"}
+{"version":3,"file":"DocumentService.js","sourceRoot":"","sources":["../../src/services/DocumentService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAY7B;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAmB,GAAM;QACtC,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAM,CAAC;IACpE,CAAC;CACF"}

package/lib/services/DocumentService.ts

@@ -2,7 +2,9 @@ import { EJSON } from 'bson';
 import BaseDocument from '../documents/BaseDocument.js';
 
 /**
- * A utility type for a map of documents.
+ * Utility type for mapping document IDs to their corresponding documents.
+ *
+ * @template T - The type of document being mapped, must extend BaseDocument.
  */
 export type DocumentMap<T extends BaseDocument> = {
   [docId: string]: T | undefined;
@@ -12,6 +14,11 @@ export type DocumentMap<T extends BaseDocument> = {
  * A service for low-level utilities related to documents.
  */
 export default class DocumentService {
+  /**
+   * Creates a deep copy of an object using EJSON serialization.
+   *
+   * @param obj - The object to copy.
+   */
   static deepCopy<T extends object>(obj: T): T {
     return EJSON.parse(EJSON.stringify(obj, { relaxed: false })) as T;
   }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@aneuhold/core-ts-db-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "2.0.83",
+  "version": "2.0.85",
   "description": "A core database library used for personal projects",
   "packageManager": "pnpm@10.12.1",
   "type": "module",
@@ -50,18 +50,18 @@
   ],
   "dependencies": {
     "@aneuhold/core-ts-lib": "*",
-    "bson": "^6.2.0"
+    "bson": "^6.10.4"
   },
   "devDependencies": {
     "@aneuhold/local-npm-registry": "*",
-    "@aneuhold/main-scripts": "^2.5.2",
-    "@types/node": "^22.15.32",
-    "eslint": "^9.29.0",
-    "jsr": "^0.13.4",
-    "prettier": "^3.5.3",
+    "@aneuhold/main-scripts": "^2.6.1",
+    "@types/node": "^24.9.1",
+    "eslint": "^9.38.0",
+    "jsr": "^0.13.5",
+    "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
-    "tsx": "^4.20.3",
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.4"
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.3"
   }
 }