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

package/lib/repositories/BaseRepository.ts

@@ -11,6 +11,7 @@ import type {
 } from 'mongodb';
 import type { RepoListeners, RepoSubscribers } from '../services/RepoSubscriptionService.js';
 import RepoSubscriptionService from '../services/RepoSubscriptionService.js';
+import type DbOperationMetaData from '../util/DbOperationMetaData.js';
 import DocumentCleaner from '../util/DocumentCleaner.js';
 import DocumentDb from '../util/DocumentDb.js';
 import type IValidator from '../validators/BaseValidator.js';
@@ -21,15 +22,15 @@ import type IValidator from '../validators/BaseValidator.js';
  * Implementation note: I have tried to do the types correctly here, but kept struggling with
  * MongoDB's types around Filter<T> and _id fields.
  *
- * @template TBasetype - The type of the documents in the collection.
+ * @template TBaseType - The type of the documents in the collection.
  */
-export default abstract class BaseRepository<TBasetype extends BaseDocument> {
+export default abstract class BaseRepository<TBaseType extends BaseDocument> {
   protected collectionName: string;
 
-  private collection?: Collection<TBasetype>;
+  private collection?: Collection<TBaseType>;
 
-  protected subscribers: RepoSubscribers<TBasetype> =
-    RepoSubscriptionService.getDefaultSubscribers<TBasetype>();
+  protected subscribers: RepoSubscribers<TBaseType> =
+    RepoSubscriptionService.getDefaultSubscribers<TBaseType>();
 
   /**
    * Constructs a new base repository.
@@ -41,9 +42,9 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    */
   constructor(
     collectionName: string,
-    private validator: IValidator<TBasetype>,
-    private defaultFilter?: Partial<TBasetype>,
-    private defaultUpdateCleaner?: (doc: Partial<TBasetype>) => Partial<TBasetype>
+    private validator: IValidator<TBaseType>,
+    private defaultFilter?: Partial<TBaseType>,
+    private defaultUpdateCleaner?: (doc: Partial<TBaseType>) => Partial<TBaseType>
   ) {
     this.collectionName = collectionName;
   }
@@ -53,7 +54,7 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    *
    * @returns The collection.
    */
-  protected async getCollection(): Promise<Collection<TBasetype>> {
+  protected async getCollection(): Promise<Collection<TBaseType>> {
     if (!this.collection) {
       this.collection = await DocumentDb.getCollection(this.collectionName);
       this.setupSubscribers();
@@ -69,7 +70,7 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    *
    * @param listeners - The listeners to register.
    */
-  subscribeToChanges(listeners: RepoListeners<TBasetype>) {
+  subscribeToChanges(listeners: RepoListeners<TBaseType>) {
     const { insertNew, updateOne, updateMany, deleteOne, deleteList } = listeners;
     if (insertNew) {
       this.subscribers.insertNew.push(insertNew);
@@ -92,16 +93,17 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * Inserts a new document into the collection.
    *
    * @param newDoc - The new document to insert.
+   * @param meta - Tracks database operation metadata for a single request.
    * @returns The inserted document or null if the insertion failed.
    */
-  async insertNew(newDoc: TBasetype): Promise<TBasetype | null> {
+  async insertNew(newDoc: TBaseType, meta?: DbOperationMetaData): Promise<TBaseType | null> {
     const collection = await this.getCollection();
     await this.validator.validateNewObject(newDoc);
-    const insertResult = await collection.insertOne(newDoc as OptionalUnlessRequiredId<TBasetype>);
+    const insertResult = await collection.insertOne(newDoc as OptionalUnlessRequiredId<TBaseType>);
     if (!insertResult.acknowledged) {
       return null;
     }
-    await Promise.all(this.subscribers.insertNew.map((subscriber) => subscriber(newDoc)));
+    await Promise.all(this.subscribers.insertNew.map((subscriber) => subscriber(newDoc, meta)));
     return newDoc;
   }
 
@@ -109,18 +111,19 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * Inserts multiple new documents into the collection.
    *
    * @param newDocs - The new documents to insert.
+   * @param meta - Tracks database operation metadata for a single request.
    * @returns The inserted documents or an empty array if the insertion failed.
    */
-  async insertMany(newDocs: TBasetype[]): Promise<TBasetype[]> {
+  async insertMany(newDocs: TBaseType[], meta?: DbOperationMetaData): Promise<TBaseType[]> {
     const collection = await this.getCollection();
     await Promise.all(newDocs.map((doc) => this.validator.validateNewObject(doc)));
     const insertResult = await collection.insertMany(
-      newDocs as OptionalUnlessRequiredId<TBasetype>[]
+      newDocs as OptionalUnlessRequiredId<TBaseType>[]
     );
     if (!insertResult.acknowledged) {
       return [];
     }
-    await Promise.all(this.subscribers.insertMany.map((subscriber) => subscriber(newDocs)));
+    await Promise.all(this.subscribers.insertMany.map((subscriber) => subscriber(newDocs, meta)));
     return newDocs;
   }
 
@@ -130,10 +133,10 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * @param filter - The filter to apply.
    * @returns The matching document or null if no document was found.
    */
-  async get(filter: Partial<TBasetype>): Promise<TBasetype | null> {
+  async get(filter: Partial<TBaseType>): Promise<TBaseType | null> {
     const collection = await this.getCollection();
-    const result = await collection.findOne(this.getFilterWithDefault(filter as Filter<TBasetype>));
-    return result as TBasetype | null;
+    const result = await collection.findOne(this.getFilterWithDefault(filter as Filter<TBaseType>));
+    return result as TBaseType | null;
   }
 
   /**
@@ -141,11 +144,11 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    *
    * @returns An array of all documents in the collection.
    */
-  async getAll(): Promise<TBasetype[]> {
+  async getAll(): Promise<TBaseType[]> {
     const collection = await this.getCollection();
     const result = await collection.find(this.getFilterWithDefault()).toArray();
     // Set to unknown first because of some weird type things.
-    return result as unknown as TBasetype[];
+    return result as unknown as TBaseType[];
   }
 
   /**
@@ -167,38 +170,40 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * @param docIds - The IDs of the documents to retrieve.
    * @returns An array of matching documents.
    */
-  async getList(docIds: UUID[]): Promise<TBasetype[]> {
+  async getList(docIds: UUID[]): Promise<TBaseType[]> {
     const collection = await this.getCollection();
     const result = await collection
-      .find(this.getFilterWithDefault({ _id: { $in: docIds } } as Filter<TBasetype>))
+      .find(this.getFilterWithDefault({ _id: { $in: docIds } } as Filter<TBaseType>))
       .toArray();
-    return result as TBasetype[];
+    return result as TBaseType[];
   }
 
   /**
    * Deletes a document by its ID.
    *
    * @param docId - The ID of the document to delete.
+   * @param meta - Tracks database operation metadata for a single request.
    * @returns The result of the delete operation.
    */
-  async delete(docId: UUID): Promise<DeleteResult> {
+  async delete(docId: UUID, meta?: DbOperationMetaData): Promise<DeleteResult> {
     const collection = await this.getCollection();
-    await Promise.all(this.subscribers.deleteOne.map((subscriber) => subscriber(docId)));
-    return collection.deleteOne({ _id: docId } as Filter<TBasetype>);
+    await Promise.all(this.subscribers.deleteOne.map((subscriber) => subscriber(docId, meta)));
+    return collection.deleteOne({ _id: docId } as Filter<TBaseType>);
   }
 
   /**
    * Deletes multiple documents by their IDs.
    *
    * @param docIds - The IDs of the documents to delete.
+   * @param meta - Tracks database operation metadata for a single request.
    * @returns The result of the delete operation.
    */
-  async deleteList(docIds: UUID[]): Promise<DeleteResult> {
+  async deleteList(docIds: UUID[], meta?: DbOperationMetaData): Promise<DeleteResult> {
     const collection = await this.getCollection();
     const deleteResult = collection.deleteMany({
       _id: { $in: docIds }
-    } as Filter<TBasetype>);
-    await Promise.all(this.subscribers.deleteList.map((subscriber) => subscriber(docIds)));
+    } as Filter<TBaseType>);
+    await Promise.all(this.subscribers.deleteList.map((subscriber) => subscriber(docIds, meta)));
     return deleteResult;
   }
 
@@ -218,9 +223,10 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * This base method strips the `_id` before updating.
    *
    * @param updatedDoc - The document to update.
+   * @param meta - Tracks database operation metadata for a single request.
    * @returns The result of the update operation.
    */
-  async update(updatedDoc: Partial<TBasetype>): Promise<UpdateResult> {
+  async update(updatedDoc: Partial<TBaseType>, meta?: DbOperationMetaData): Promise<UpdateResult> {
     const collection = await this.getCollection();
     await this.validator.validateUpdateObject(updatedDoc);
 
@@ -228,10 +234,10 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
 
     const cleanedDoc = this.cleanUpdateObject(updatedDoc);
 
-    const result = collection.updateOne({ _id: docId } as Filter<TBasetype>, {
+    const result = collection.updateOne({ _id: docId } as Filter<TBaseType>, {
       $set: cleanedDoc
     });
-    await Promise.all(this.subscribers.updateOne.map((subscriber) => subscriber(updatedDoc)));
+    await Promise.all(this.subscribers.updateOne.map((subscriber) => subscriber(updatedDoc, meta)));
     return result;
   }
 
@@ -241,9 +247,13 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * This base method strips the `_id` before updating.
    *
    * @param updatedDocs - The documents to update.
+   * @param meta - Tracks database operation metadata for a single request.
    * @returns The result of the bulk update operation.
    */
-  async updateMany(updatedDocs: Array<Partial<TBasetype>>): Promise<BulkWriteResult> {
+  async updateMany(
+    updatedDocs: Array<Partial<TBaseType>>,
+    meta?: DbOperationMetaData
+  ): Promise<BulkWriteResult> {
     const collection = await this.getCollection();
     await Promise.all(updatedDocs.map((doc) => this.validator.validateUpdateObject(doc)));
 
@@ -256,20 +266,60 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
           update: { $set: cleanedDoc }
         }
       };
-    }) as AnyBulkWriteOperation<TBasetype>[];
+    }) as AnyBulkWriteOperation<TBaseType>[];
 
-    await Promise.all(this.subscribers.updateMany.map((subscriber) => subscriber(updatedDocs)));
+    await Promise.all(
+      this.subscribers.updateMany.map((subscriber) => subscriber(updatedDocs, meta))
+    );
 
     return collection.bulkWrite(bulkOps);
   }
 
+  /**
+   * Fetches and caches multiple documents, returning only those not already cached.
+   * This method checks the cache in the provided metadata object first, then fetches
+   * any missing documents from the database and caches them.
+   *
+   * @param docIds - The IDs of the documents to fetch.
+   * @param meta - The metadata object containing the cache.
+   * @returns An array of all documents (from cache and newly fetched).
+   */
+  protected async fetchAndCacheDocsForMeta(
+    docIds: UUID[],
+    meta: DbOperationMetaData
+  ): Promise<TBaseType[]> {
+    const docIdsToFetch: UUID[] = [];
+    const cachedDocs: TBaseType[] = [];
+
+    // Check cache first
+    for (const docId of docIds) {
+      const cached = meta.getCachedDoc<TBaseType>(docId);
+      if (cached) {
+        cachedDocs.push(cached);
+      } else {
+        docIdsToFetch.push(docId);
+      }
+    }
+
+    // Fetch uncached docs
+    if (docIdsToFetch.length > 0) {
+      const fetchedDocs = await this.getList(docIdsToFetch);
+      fetchedDocs.forEach((doc) => {
+        meta.cacheDoc(doc._id, doc);
+        cachedDocs.push(doc);
+      });
+    }
+
+    return cachedDocs;
+  }
+
   /**
    * Gets the filter with the default filter applied if there is one.
    *
    * @param filter - The filter to apply.
    * @returns The filter with the default filter applied.
    */
-  protected getFilterWithDefault(filter: Filter<TBasetype> = {}): Filter<TBasetype> {
+  protected getFilterWithDefault(filter: Filter<TBaseType> = {}): Filter<TBaseType> {
     if (!this.defaultFilter) {
       return filter;
     }
@@ -299,7 +349,7 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
    * @param updatedDoc - The document to clean.
    * @returns The cleaned document.
    */
-  private cleanUpdateObject(updatedDoc: Partial<TBasetype>): Partial<TBasetype> {
+  private cleanUpdateObject(updatedDoc: Partial<TBaseType>): Partial<TBaseType> {
     return this.defaultUpdateCleaner
       ? this.defaultUpdateCleaner(DocumentCleaner.id(updatedDoc))
       : DocumentCleaner.id(updatedDoc);

package/lib/repositories/dashboard/DashboardBaseRepository.d.ts

@@ -1,11 +1,22 @@
 import type { BaseDocumentWithType } from '@aneuhold/core-ts-db-lib';
-import IValidator from '../../validators/BaseValidator.js';
+import type { UUID } from 'crypto';
+import type { BulkWriteResult, DeleteResult, UpdateResult } from 'mongodb';
+import type DbOperationMetaData from '../../util/DbOperationMetaData.js';
+import type IValidator from '../../validators/BaseValidator.js';
 import BaseRepository from '../BaseRepository.js';
 /**
  * A base repository for the `dashboard` collection.
  */
 export default abstract class DashboardBaseRepository<TBaseType extends BaseDocumentWithType> extends BaseRepository<TBaseType> {
+    protected docType: string;
     private static COLLECTION_NAME;
     constructor(docType: string, validator: IValidator<TBaseType>, updateCleaner?: (doc: Partial<TBaseType>) => Partial<TBaseType>);
+    insertNew(newDoc: TBaseType, meta?: DbOperationMetaData): Promise<TBaseType | null>;
+    insertMany(newDocs: TBaseType[], meta?: DbOperationMetaData): Promise<TBaseType[]>;
+    update(updatedDoc: Partial<TBaseType>, meta?: DbOperationMetaData): Promise<UpdateResult>;
+    updateMany(updatedDocs: Partial<TBaseType>[], meta?: DbOperationMetaData): Promise<BulkWriteResult>;
+    delete(docId: UUID, meta?: DbOperationMetaData): Promise<DeleteResult>;
+    deleteList(docIds: UUID[], meta?: DbOperationMetaData): Promise<DeleteResult>;
+    deleteAll(meta?: DbOperationMetaData): Promise<DeleteResult>;
 }
 //# sourceMappingURL=DashboardBaseRepository.d.ts.map

package/lib/repositories/dashboard/DashboardBaseRepository.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardBaseRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,UAAU,MAAM,mCAAmC,CAAC;AAC3D,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,uBAAuB,CACnD,SAAS,SAAS,oBAAoB,CACtC,SAAQ,cAAc,CAAC,SAAS,CAAC;IACjC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAe;gBAG3C,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,EAChC,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC;CASlE"}
+{"version":3,"file":"DashboardBaseRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,KAAK,mBAAmB,MAAM,mCAAmC,CAAC;AAEzE,OAAO,KAAK,UAAU,MAAM,mCAAmC,CAAC;AAChE,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,uBAAuB,CACnD,SAAS,SAAS,oBAAoB,CACtC,SAAQ,cAAc,CAAC,SAAS,CAAC;IAI/B,SAAS,CAAC,OAAO,EAAE,MAAM;IAH3B,OAAO,CAAC,MAAM,CAAC,eAAe,CAAe;gBAGjC,OAAO,EAAE,MAAM,EACzB,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,EAChC,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC;IAUlD,SAAS,CACtB,MAAM,EAAE,SAAS,EACjB,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAKb,UAAU,CACvB,OAAO,EAAE,SAAS,EAAE,EACpB,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,SAAS,EAAE,CAAC;IAKR,MAAM,CACnB,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAC9B,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,YAAY,CAAC;IAKT,UAAU,CACvB,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,EACjC,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,eAAe,CAAC;IAKZ,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAKtE,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAK7E,SAAS,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;CAI5E"}

package/lib/repositories/dashboard/DashboardBaseRepository.js

@@ -1,10 +1,10 @@
 import CleanDocument from '../../util/DocumentCleaner.js';
-import IValidator from '../../validators/BaseValidator.js';
 import BaseRepository from '../BaseRepository.js';
 /**
  * A base repository for the `dashboard` collection.
  */
 export default class DashboardBaseRepository extends BaseRepository {
+    docType;
     static COLLECTION_NAME = 'dashboard';
     constructor(docType, validator, updateCleaner) {
         const defaultUpdateCleaner = (updatedDoc) => updateCleaner
@@ -12,6 +12,35 @@ export default class DashboardBaseRepository extends BaseRepository {
             : CleanDocument.docType(updatedDoc);
         const defaultFilter = { docType };
         super(DashboardBaseRepository.COLLECTION_NAME, validator, defaultFilter, defaultUpdateCleaner);
+        this.docType = docType;
+    }
+    async insertNew(newDoc, meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.insertNew(newDoc, meta);
+    }
+    async insertMany(newDocs, meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.insertMany(newDocs, meta);
+    }
+    async update(updatedDoc, meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.update(updatedDoc, meta);
+    }
+    async updateMany(updatedDocs, meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.updateMany(updatedDocs, meta);
+    }
+    async delete(docId, meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.delete(docId, meta);
+    }
+    async deleteList(docIds, meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.deleteList(docIds, meta);
+    }
+    async deleteAll(meta) {
+        meta?.recordDocTypeTouched(this.docType);
+        return super.deleteAll();
     }
 }
 //# sourceMappingURL=DashboardBaseRepository.js.map

package/lib/repositories/dashboard/DashboardBaseRepository.js.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardBaseRepository.js","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseRepository.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,+BAA+B,CAAC;AAC1D,OAAO,UAAU,MAAM,mCAAmC,CAAC;AAC3D,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAgB,uBAE5B,SAAQ,cAAyB;IACzB,MAAM,CAAC,eAAe,GAAG,WAAW,CAAC;IAE7C,YACE,OAAe,EACf,SAAgC,EAChC,aAA+D;QAE/D,MAAM,oBAAoB,GAAG,CAAC,UAA8B,EAAE,EAAE,CAC9D,aAAa;YACX,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClD,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,EAAE,OAAO,EAAwB,CAAC;QACxD,KAAK,CAAC,uBAAuB,CAAC,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;IACjG,CAAC"}
+{"version":3,"file":"DashboardBaseRepository.js","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseRepository.ts"],"names":[],"mappings":"AAIA,OAAO,aAAa,MAAM,+BAA+B,CAAC;AAE1D,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAgB,uBAE5B,SAAQ,cAAyB;IAIrB;IAHJ,MAAM,CAAC,eAAe,GAAG,WAAW,CAAC;IAE7C,YACY,OAAe,EACzB,SAAgC,EAChC,aAA+D;QAE/D,MAAM,oBAAoB,GAAG,CAAC,UAA8B,EAAE,EAAE,CAC9D,aAAa;YACX,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClD,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,EAAE,OAAO,EAAwB,CAAC;QACxD,KAAK,CAAC,uBAAuB,CAAC,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QATrF,YAAO,GAAP,OAAO,CAAQ;IAU3B,CAAC;IAEQ,KAAK,CAAC,SAAS,CACtB,MAAiB,EACjB,IAA0B;QAE1B,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAEQ,KAAK,CAAC,UAAU,CACvB,OAAoB,EACpB,IAA0B;QAE1B,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IAEQ,KAAK,CAAC,MAAM,CACnB,UAA8B,EAC9B,IAA0B;QAE1B,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAEQ,KAAK,CAAC,UAAU,CACvB,WAAiC,EACjC,IAA0B;QAE1B,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEQ,KAAK,CAAC,MAAM,CAAC,KAAW,EAAE,IAA0B;QAC3D,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,IAA0B;QAClE,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAEQ,KAAK,CAAC,SAAS,CAAC,IAA0B;QACjD,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,SAAS,EAAE,CAAC;IAC3B,CAAC"}

package/lib/repositories/dashboard/DashboardBaseRepository.ts

@@ -1,6 +1,9 @@
 import type { BaseDocumentWithType } from '@aneuhold/core-ts-db-lib';
+import type { UUID } from 'crypto';
+import type { BulkWriteResult, DeleteResult, UpdateResult } from 'mongodb';
+import type DbOperationMetaData from '../../util/DbOperationMetaData.js';
 import CleanDocument from '../../util/DocumentCleaner.js';
-import IValidator from '../../validators/BaseValidator.js';
+import type IValidator from '../../validators/BaseValidator.js';
 import BaseRepository from '../BaseRepository.js';
 
 /**
@@ -12,7 +15,7 @@ export default abstract class DashboardBaseRepository<
   private static COLLECTION_NAME = 'dashboard';
 
   constructor(
-    docType: string,
+    protected docType: string,
     validator: IValidator<TBaseType>,
     updateCleaner?: (doc: Partial<TBaseType>) => Partial<TBaseType>
   ) {
@@ -23,4 +26,51 @@ export default abstract class DashboardBaseRepository<
     const defaultFilter = { docType } as Partial<TBaseType>;
     super(DashboardBaseRepository.COLLECTION_NAME, validator, defaultFilter, defaultUpdateCleaner);
   }
+
+  override async insertNew(
+    newDoc: TBaseType,
+    meta?: DbOperationMetaData
+  ): Promise<TBaseType | null> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.insertNew(newDoc, meta);
+  }
+
+  override async insertMany(
+    newDocs: TBaseType[],
+    meta?: DbOperationMetaData
+  ): Promise<TBaseType[]> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.insertMany(newDocs, meta);
+  }
+
+  override async update(
+    updatedDoc: Partial<TBaseType>,
+    meta?: DbOperationMetaData
+  ): Promise<UpdateResult> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.update(updatedDoc, meta);
+  }
+
+  override async updateMany(
+    updatedDocs: Partial<TBaseType>[],
+    meta?: DbOperationMetaData
+  ): Promise<BulkWriteResult> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.updateMany(updatedDocs, meta);
+  }
+
+  override async delete(docId: UUID, meta?: DbOperationMetaData): Promise<DeleteResult> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.delete(docId, meta);
+  }
+
+  override async deleteList(docIds: UUID[], meta?: DbOperationMetaData): Promise<DeleteResult> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.deleteList(docIds, meta);
+  }
+
+  override async deleteAll(meta?: DbOperationMetaData): Promise<DeleteResult> {
+    meta?.recordDocTypeTouched(this.docType);
+    return super.deleteAll();
+  }
 }

package/lib/repositories/dashboard/DashboardBaseWithUserIdRepository.d.ts

@@ -0,0 +1,25 @@
+import type { BaseDocumentWithType, RequiredUserId } from '@aneuhold/core-ts-db-lib';
+import type { UUID } from 'crypto';
+import type { BulkWriteResult, DeleteResult, UpdateResult } from 'mongodb';
+import type DbOperationMetaData from '../../util/DbOperationMetaData.js';
+import type IValidator from '../../validators/BaseValidator.js';
+import DashboardBaseRepository from './DashboardBaseRepository.js';
+/**
+ * A base repository for the `dashboard` collection that requires a `userId`.
+ */
+export default abstract class DashboardBaseWithUserIdRepository<TBaseType extends BaseDocumentWithType & RequiredUserId> extends DashboardBaseRepository<TBaseType> {
+    constructor(docType: string, validator: IValidator<TBaseType>, updateCleaner?: (doc: Partial<TBaseType>) => Partial<TBaseType>);
+    /**
+     * Gets all items for a given user.
+     *
+     * @param userId The ID of the user to get items for.
+     */
+    getAllForUser(userId: UUID): Promise<TBaseType[]>;
+    insertNew(newDoc: TBaseType, meta?: DbOperationMetaData): Promise<TBaseType | null>;
+    insertMany(newDocs: TBaseType[], meta?: DbOperationMetaData): Promise<TBaseType[]>;
+    update(updatedDoc: Partial<TBaseType>, meta?: DbOperationMetaData): Promise<UpdateResult>;
+    updateMany(updatedDocs: Partial<TBaseType>[], meta?: DbOperationMetaData): Promise<BulkWriteResult>;
+    delete(docId: UUID, meta?: DbOperationMetaData): Promise<DeleteResult>;
+    deleteList(docIds: UUID[], meta?: DbOperationMetaData): Promise<DeleteResult>;
+}
+//# sourceMappingURL=DashboardBaseWithUserIdRepository.d.ts.map

package/lib/repositories/dashboard/DashboardBaseWithUserIdRepository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DashboardBaseWithUserIdRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseWithUserIdRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAU,YAAY,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,KAAK,mBAAmB,MAAM,mCAAmC,CAAC;AAEzE,OAAO,KAAK,UAAU,MAAM,mCAAmC,CAAC;AAChE,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AAEnE;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,iCAAiC,CAC7D,SAAS,SAAS,oBAAoB,GAAG,cAAc,CACvD,SAAQ,uBAAuB,CAAC,SAAS,CAAC;gBAExC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,EAChC,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC;IAOjE;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IASxC,SAAS,CACtB,MAAM,EAAE,SAAS,EACjB,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAQb,UAAU,CACvB,OAAO,EAAE,SAAS,EAAE,EACpB,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,SAAS,EAAE,CAAC;IAMR,MAAM,CACnB,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAC9B,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,YAAY,CAAC;IAUT,UAAU,CACvB,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,EACjC,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,eAAe,CAAC;IASZ,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAUtE,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;CAO7F"}

package/lib/repositories/dashboard/DashboardBaseWithUserIdRepository.js

@@ -0,0 +1,70 @@
+import CleanDocument from '../../util/DocumentCleaner.js';
+import DashboardBaseRepository from './DashboardBaseRepository.js';
+/**
+ * A base repository for the `dashboard` collection that requires a `userId`.
+ */
+export default class DashboardBaseWithUserIdRepository extends DashboardBaseRepository {
+    constructor(docType, validator, updateCleaner) {
+        const defaultUpdateCleaner = (doc) => updateCleaner ? updateCleaner(CleanDocument.userId(doc)) : CleanDocument.userId(doc);
+        super(docType, validator, defaultUpdateCleaner);
+    }
+    /**
+     * Gets all items for a given user.
+     *
+     * @param userId The ID of the user to get items for.
+     */
+    async getAllForUser(userId) {
+        const collection = await this.getCollection();
+        const filter = {
+            $and: [this.getFilterWithDefault(), { userId }]
+        };
+        const result = await collection.find(filter).toArray();
+        return result;
+    }
+    async insertNew(newDoc, meta) {
+        const result = await super.insertNew(newDoc, meta);
+        if (result) {
+            meta?.addAffectedUserIds([result.userId]);
+        }
+        return result;
+    }
+    async insertMany(newDocs, meta) {
+        const result = await super.insertMany(newDocs, meta);
+        meta?.addAffectedUserIds(result.map((d) => d.userId));
+        return result;
+    }
+    async update(updatedDoc, meta) {
+        if (meta && updatedDoc._id) {
+            const docs = await this.fetchAndCacheDocsForMeta([updatedDoc._id], meta);
+            if (docs.length > 0) {
+                meta.addAffectedUserIds([docs[0].userId]);
+            }
+        }
+        return super.update(updatedDoc, meta);
+    }
+    async updateMany(updatedDocs, meta) {
+        if (meta && updatedDocs.length > 0) {
+            const docIds = updatedDocs.map((doc) => doc._id).filter((id) => id !== undefined);
+            const cachedDocs = await this.fetchAndCacheDocsForMeta(docIds, meta);
+            meta.addAffectedUserIds(cachedDocs.map((doc) => doc.userId));
+        }
+        return super.updateMany(updatedDocs, meta);
+    }
+    async delete(docId, meta) {
+        if (meta) {
+            const docs = await this.fetchAndCacheDocsForMeta([docId], meta);
+            if (docs.length > 0) {
+                meta.addAffectedUserIds([docs[0].userId]);
+            }
+        }
+        return super.delete(docId, meta);
+    }
+    async deleteList(docIds, meta) {
+        if (meta && docIds.length > 0) {
+            const cachedDocs = await this.fetchAndCacheDocsForMeta(docIds, meta);
+            meta.addAffectedUserIds(cachedDocs.map((doc) => doc.userId));
+        }
+        return super.deleteList(docIds, meta);
+    }
+}
+//# sourceMappingURL=DashboardBaseWithUserIdRepository.js.map

package/lib/repositories/dashboard/DashboardBaseWithUserIdRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DashboardBaseWithUserIdRepository.js","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseWithUserIdRepository.ts"],"names":[],"mappings":"AAIA,OAAO,aAAa,MAAM,+BAA+B,CAAC;AAE1D,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AAEnE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAgB,iCAE5B,SAAQ,uBAAkC;IAC1C,YACE,OAAe,EACf,SAAgC,EAChC,aAA+D;QAE/D,MAAM,oBAAoB,GAAG,CAAC,GAAuB,EAAE,EAAE,CACvD,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvF,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,MAAY;QAC9B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;SAC3B,CAAC;QACvB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;QACvD,OAAO,MAAqB,CAAC;IAC/B,CAAC;IAEQ,KAAK,CAAC,SAAS,CACtB,MAAiB,EACjB,IAA0B;QAE1B,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACnD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,EAAE,kBAAkB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEQ,KAAK,CAAC,UAAU,CACvB,OAAoB,EACpB,IAA0B;QAE1B,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEQ,KAAK,CAAC,MAAM,CACnB,UAA8B,EAC9B,IAA0B;QAE1B,IAAI,IAAI,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YACzE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpB,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAEQ,KAAK,CAAC,UAAU,CACvB,WAAiC,EACjC,IAA0B;QAE1B,IAAI,IAAI,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAc,EAAE,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;YAC9F,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACrE,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEQ,KAAK,CAAC,MAAM,CAAC,KAAW,EAAE,IAA0B;QAC3D,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;YAChE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpB,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,IAA0B;QAClE,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACrE,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;CACF"}

package/lib/repositories/dashboard/DashboardBaseWithUserIdRepository.ts

@@ -0,0 +1,101 @@
+import type { BaseDocumentWithType, RequiredUserId } from '@aneuhold/core-ts-db-lib';
+import type { UUID } from 'crypto';
+import type { BulkWriteResult, DeleteResult, Filter, UpdateResult } from 'mongodb';
+import type DbOperationMetaData from '../../util/DbOperationMetaData.js';
+import CleanDocument from '../../util/DocumentCleaner.js';
+import type IValidator from '../../validators/BaseValidator.js';
+import DashboardBaseRepository from './DashboardBaseRepository.js';
+
+/**
+ * A base repository for the `dashboard` collection that requires a `userId`.
+ */
+export default abstract class DashboardBaseWithUserIdRepository<
+  TBaseType extends BaseDocumentWithType & RequiredUserId
+> extends DashboardBaseRepository<TBaseType> {
+  constructor(
+    docType: string,
+    validator: IValidator<TBaseType>,
+    updateCleaner?: (doc: Partial<TBaseType>) => Partial<TBaseType>
+  ) {
+    const defaultUpdateCleaner = (doc: Partial<TBaseType>) =>
+      updateCleaner ? updateCleaner(CleanDocument.userId(doc)) : CleanDocument.userId(doc);
+    super(docType, validator, defaultUpdateCleaner);
+  }
+
+  /**
+   * Gets all items for a given user.
+   *
+   * @param userId The ID of the user to get items for.
+   */
+  async getAllForUser(userId: UUID): Promise<TBaseType[]> {
+    const collection = await this.getCollection();
+    const filter = {
+      $and: [this.getFilterWithDefault(), { userId }]
+    } as Filter<TBaseType>;
+    const result = await collection.find(filter).toArray();
+    return result as TBaseType[];
+  }
+
+  override async insertNew(
+    newDoc: TBaseType,
+    meta?: DbOperationMetaData
+  ): Promise<TBaseType | null> {
+    const result = await super.insertNew(newDoc, meta);
+    if (result) {
+      meta?.addAffectedUserIds([result.userId]);
+    }
+    return result;
+  }
+
+  override async insertMany(
+    newDocs: TBaseType[],
+    meta?: DbOperationMetaData
+  ): Promise<TBaseType[]> {
+    const result = await super.insertMany(newDocs, meta);
+    meta?.addAffectedUserIds(result.map((d) => d.userId));
+    return result;
+  }
+
+  override async update(
+    updatedDoc: Partial<TBaseType>,
+    meta?: DbOperationMetaData
+  ): Promise<UpdateResult> {
+    if (meta && updatedDoc._id) {
+      const docs = await this.fetchAndCacheDocsForMeta([updatedDoc._id], meta);
+      if (docs.length > 0) {
+        meta.addAffectedUserIds([docs[0].userId]);
+      }
+    }
+    return super.update(updatedDoc, meta);
+  }
+
+  override async updateMany(
+    updatedDocs: Partial<TBaseType>[],
+    meta?: DbOperationMetaData
+  ): Promise<BulkWriteResult> {
+    if (meta && updatedDocs.length > 0) {
+      const docIds = updatedDocs.map((doc) => doc._id).filter((id): id is UUID => id !== undefined);
+      const cachedDocs = await this.fetchAndCacheDocsForMeta(docIds, meta);
+      meta.addAffectedUserIds(cachedDocs.map((doc) => doc.userId));
+    }
+    return super.updateMany(updatedDocs, meta);
+  }
+
+  override async delete(docId: UUID, meta?: DbOperationMetaData): Promise<DeleteResult> {
+    if (meta) {
+      const docs = await this.fetchAndCacheDocsForMeta([docId], meta);
+      if (docs.length > 0) {
+        meta.addAffectedUserIds([docs[0].userId]);
+      }
+    }
+    return super.delete(docId, meta);
+  }
+
+  override async deleteList(docIds: UUID[], meta?: DbOperationMetaData): Promise<DeleteResult> {
+    if (meta && docIds.length > 0) {
+      const cachedDocs = await this.fetchAndCacheDocsForMeta(docIds, meta);
+      meta.addAffectedUserIds(cachedDocs.map((doc) => doc.userId));
+    }
+    return super.deleteList(docIds, meta);
+  }
+}