@aneuhold/be-ts-db-lib 1.0.8 → 1.0.9

package/README.md

@@ -9,16 +9,7 @@ This is used to actually interact with databases in personal projects.
 ### Creating a new Repository
 
 1. Copy an existing one over
-2. Make sure to register the repository in the `RepoSubscriptionService`, even if nothing needs to be setup, just as a future precaution.
-
-## Subscription System
-
-```mermaid
-sequenceDiagram
-  Note over UserRepository: getRepo called
-  UserRepository->>ApiKeyRepository: getSubscribers called
-  ApiKeyRepository->>UserRepository: Subscribes
-```
+1. Create an associated validator
 
 ## Schema Validation for DB
 

package/lib/repositories/common/UserRepository.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/UserRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAK/C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc,CAAC,IAAI,CAAC;IAC9D,OAAO,CAAC,MAAM,CAAC,eAAe,CAAW;IAEzC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAiB;IAEjD,OAAO;IAIP,SAAS,CAAC,gBAAgB,IAAI,IAAI;IAOlC;;OAEG;IACH,MAAM,CAAC,OAAO;CAMf"}
+{"version":3,"file":"UserRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/UserRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAM/C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc,CAAC,IAAI,CAAC;IAC9D,OAAO,CAAC,MAAM,CAAC,eAAe,CAAW;IAEzC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAiB;IAEjD,OAAO;IAIP,SAAS,CAAC,gBAAgB,IAAI,IAAI;IAQlC;;OAEG;IACH,MAAM,CAAC,OAAO;CAMf"}

package/lib/repositories/common/UserRepository.js

@@ -7,6 +7,7 @@ const BaseRepository_1 = __importDefault(require("../BaseRepository"));
 const UserValidator_1 = __importDefault(require("../../validators/common/UserValidator"));
 const ApiKeyRepository_1 = __importDefault(require("./ApiKeyRepository"));
 const DashboardUserConfigRepository_1 = __importDefault(require("../dashboard/DashboardUserConfigRepository"));
+const DashboardTaskRepository_1 = __importDefault(require("../dashboard/DashboardTaskRepository"));
 /**
  * The repository that contains {@link User} documents.
  */
@@ -19,6 +20,7 @@ class UserRepository extends BaseRepository_1.default {
     setupSubscribers() {
         this.subscribeToChanges(ApiKeyRepository_1.default.getListenersForUserRepo());
         this.subscribeToChanges(DashboardUserConfigRepository_1.default.getListenersForUserRepo());
+        this.subscribeToChanges(DashboardTaskRepository_1.default.getListenersForUserRepo());
     }
     /**
      * Gets the singleton instance of the {@link UserRepository}.

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

@@ -0,0 +1,17 @@
+import { DashboardTask, User } from '@aneuhold/core-ts-db-lib';
+import DashboardBaseRepository from './DashboardBaseRepository';
+import { RepoListeners } from '../../services/RepoSubscriptionService';
+/**
+ * The repository that contains {@link DashboardTask} documents.
+ */
+export default class DashboardTaskRepository extends DashboardBaseRepository<DashboardTask> {
+    private static singletonInstance;
+    private constructor();
+    static getListenersForUserRepo(): RepoListeners<User>;
+    protected setupSubscribers(): void;
+    /**
+     * Gets the singleton instance of the {@link DashboardTaskRepository}.
+     */
+    static getRepo(): DashboardTaskRepository;
+}
+//# sourceMappingURL=DashboardTaskRepository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DashboardTaskRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardTaskRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AAGvE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAwB,SAAQ,uBAAuB,CAAC,aAAa,CAAC;IACzF,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA0B;IAE1D,OAAO;IAaP,MAAM,CAAC,uBAAuB,IAAI,aAAa,CAAC,IAAI,CAAC;IAcrD,SAAS,CAAC,gBAAgB,IAAI,IAAI;IAElC;;OAEG;WACW,OAAO;CAMtB"}

package/lib/repositories/dashboard/DashboardTaskRepository.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_ts_db_lib_1 = require("@aneuhold/core-ts-db-lib");
+const DashboardBaseRepository_1 = __importDefault(require("./DashboardBaseRepository"));
+const DocumentCleaner_1 = __importDefault(require("../../util/DocumentCleaner"));
+const TaskValidator_1 = __importDefault(require("../../validators/dashboard/TaskValidator"));
+/**
+ * The repository that contains {@link DashboardTask} documents.
+ */
+class DashboardTaskRepository extends DashboardBaseRepository_1.default {
+    static singletonInstance;
+    constructor() {
+        super(core_ts_db_lib_1.DashboardTask.docType, new TaskValidator_1.default(), (task) => {
+            const docCopy = DocumentCleaner_1.default.userId(task);
+            delete docCopy.createdDate;
+            docCopy.lastUpdatedDate = new Date();
+            return docCopy;
+        });
+    }
+    static getListenersForUserRepo() {
+        const taskRepo = DashboardTaskRepository.getRepo();
+        return {
+            deleteOne: async (userId) => {
+                (await taskRepo.getCollection()).deleteOne({ userId });
+            },
+            deleteList: async (userIds) => {
+                (await taskRepo.getCollection()).deleteMany({
+                    userId: { $in: userIds }
+                });
+            }
+        };
+    }
+    setupSubscribers() { }
+    /**
+     * Gets the singleton instance of the {@link DashboardTaskRepository}.
+     */
+    static getRepo() {
+        if (!DashboardTaskRepository.singletonInstance) {
+            DashboardTaskRepository.singletonInstance = new DashboardTaskRepository();
+        }
+        return DashboardTaskRepository.singletonInstance;
+    }
+}
+exports.default = DashboardTaskRepository;

package/lib/tests/repositories/BaseRepository.spec.js

@@ -9,6 +9,7 @@ const UserRepository_1 = __importDefault(require("../../repositories/common/User
 const testsUtil_1 = require("../testsUtil");
 const DocumentDb_1 = __importDefault(require("../../util/DocumentDb"));
 const DashboardUserConfigRepository_1 = __importDefault(require("../../repositories/dashboard/DashboardUserConfigRepository"));
+const DashboardTaskRepository_1 = __importDefault(require("../../repositories/dashboard/DashboardTaskRepository"));
 it('can create a new document and delete it', async () => {
     const userRepository = UserRepository_1.default.getRepo();
     const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)());
@@ -35,6 +36,17 @@ it.skip('can create a dashboard config for a user', async () => {
         await configRepo.insertNew(newConfig);
     }
 });
+it.skip(`can create a new task for a user`, async () => {
+    const userRepo = UserRepository_1.default.getRepo();
+    const user = await userRepo.get({ userName: 'testUser' });
+    expect(user).toBeTruthy();
+    if (user) {
+        const taskRepo = DashboardTaskRepository_1.default.getRepo();
+        const newTask = new core_ts_db_lib_1.DashboardTask(user._id);
+        newTask.title = 'Test Task';
+        await taskRepo.insertNew(newTask);
+    }
+});
 afterAll(async () => {
     return DocumentDb_1.default.closeDbConnection();
 });

package/lib/tests/repositories/dashboard/TaskRepository.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TaskRepository.spec.d.ts.map

package/lib/tests/repositories/dashboard/TaskRepository.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskRepository.spec.d.ts","sourceRoot":"","sources":["../../../../src/tests/repositories/dashboard/TaskRepository.spec.ts"],"names":[],"mappings":""}

package/lib/tests/repositories/dashboard/TaskRepository.spec.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = __importDefault(require("crypto"));
+const core_ts_db_lib_1 = require("@aneuhold/core-ts-db-lib");
+const UserRepository_1 = __importDefault(require("../../../repositories/common/UserRepository"));
+const testsUtil_1 = require("../../testsUtil");
+const DocumentDb_1 = __importDefault(require("../../../util/DocumentDb"));
+const DashboardTaskRepository_1 = __importDefault(require("../../../repositories/dashboard/DashboardTaskRepository"));
+const userRepo = UserRepository_1.default.getRepo();
+const taskRepo = DashboardTaskRepository_1.default.getRepo();
+describe('Create operations', () => {
+    it('can create a new task', async () => {
+        const newUser = await createNewTestUser();
+        const newTask = new core_ts_db_lib_1.DashboardTask(newUser._id);
+        const insertResult = await taskRepo.insertNew(newTask);
+        expect(insertResult).toBeTruthy();
+        const insertedTask = await taskRepo.get({ _id: newTask._id });
+        expect(insertedTask).toBeTruthy();
+        expect(typeof insertedTask?.createdDate).toBe('object');
+        if (!insertedTask) {
+            return;
+        }
+        await (0, testsUtil_1.cleanupDoc)(userRepo, newUser);
+        // Task should be deleted
+        const deletedTask = await taskRepo.get({ _id: newTask._id });
+        expect(deletedTask).toBeFalsy();
+    });
+});
+afterAll(async () => {
+    return DocumentDb_1.default.closeDbConnection();
+});
+async function createNewTestUser() {
+    const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)(`${crypto_1.default.randomUUID()}dashboardTaskTest`));
+    const insertResult = await userRepo.insertNew(newUser);
+    expect(insertResult).toBeTruthy();
+    return newUser;
+}

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

@@ -1 +1 @@
-{"version":3,"file":"DbSchemaUpdater.d.ts","sourceRoot":"","sources":["../../src/util/DbSchemaUpdater.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,uBAAuB,CAAC,MAAM,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAKpE"}
+{"version":3,"file":"DbSchemaUpdater.d.ts","sourceRoot":"","sources":["../../src/util/DbSchemaUpdater.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,uBAAuB,CAAC,MAAM,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAMpE"}

package/lib/util/DbSchemaUpdater.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const ApiKeyValidator_1 = __importDefault(require("../validators/common/ApiKeyValidator"));
 const UserValidator_1 = __importDefault(require("../validators/common/UserValidator"));
+const TaskValidator_1 = __importDefault(require("../validators/dashboard/TaskValidator"));
 const UserConfigValidator_1 = __importDefault(require("../validators/dashboard/UserConfigValidator"));
 /**
  * A class that can be used to validate and update the DB and all repositories.
@@ -14,6 +15,7 @@ class DbSchemaUpdater {
         await new UserValidator_1.default().validateRepositoryInDb(dryRun);
         await new ApiKeyValidator_1.default().validateRepositoryInDb(dryRun);
         await new UserConfigValidator_1.default().validateRepositoryInDb(dryRun);
+        await new TaskValidator_1.default().validateRepositoryInDb(dryRun);
     }
 }
 exports.default = DbSchemaUpdater;

package/lib/validators/dashboard/TaskValidator.d.ts

@@ -0,0 +1,8 @@
+import { DashboardTask } from '@aneuhold/core-ts-db-lib';
+import IValidator from '../BaseValidator';
+export default class DashboardTaskValidator extends IValidator<DashboardTask> {
+    validateNewObject(newTask: DashboardTask): Promise<void>;
+    validateUpdateObject(updatedTask: Partial<DashboardTask>): Promise<void>;
+    validateRepositoryInDb(dryRun: boolean): Promise<void>;
+}
+//# sourceMappingURL=TaskValidator.d.ts.map

package/lib/validators/dashboard/TaskValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/dashboard/TaskValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAyB,MAAM,0BAA0B,CAAC;AAGhF,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAI1C,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,UAAU,CAAC,aAAa,CAAC;IACrE,iBAAiB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxD,oBAAoB,CACxB,WAAW,EAAE,OAAO,CAAC,aAAa,CAAC,GAClC,OAAO,CAAC,IAAI,CAAC;IAUV,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA0C7D"}

package/lib/validators/dashboard/TaskValidator.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_ts_db_lib_1 = require("@aneuhold/core-ts-db-lib");
+const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+const BaseValidator_1 = __importDefault(require("../BaseValidator"));
+const UserRepository_1 = __importDefault(require("../../repositories/common/UserRepository"));
+const DashboardTaskRepository_1 = __importDefault(require("../../repositories/dashboard/DashboardTaskRepository"));
+class DashboardTaskValidator extends BaseValidator_1.default {
+    async validateNewObject(newTask) {
+        // Check if the user exists, and any shared users exist
+        const userRepo = UserRepository_1.default.getRepo();
+        const users = [newTask.userId, ...newTask.sharedWith];
+        const usersFound = await userRepo.getList(users);
+        if (usersFound.length !== users.length) {
+            core_ts_lib_1.ErrorUtils.throwError(`Not all users exist. Found: ${usersFound.length}, expected: ${users.length}`, newTask);
+        }
+    }
+    async validateUpdateObject(updatedTask) {
+        // Check if an id is defined
+        if (!updatedTask._id) {
+            core_ts_lib_1.ErrorUtils.throwError(`No _id defined for DashboardTask update.`, updatedTask);
+        }
+    }
+    async validateRepositoryInDb(dryRun) {
+        const taskRepo = DashboardTaskRepository_1.default.getRepo();
+        const allTasks = await taskRepo.getAll();
+        const allUserIds = await UserRepository_1.default.getRepo().getAllIdsAsHash();
+        await this.runStandardValidationForRepository({
+            dryRun,
+            docName: 'Dashboard Task',
+            allDocs: allTasks,
+            shouldDelete: (task) => {
+                if (!allUserIds[task.userId.toString()]) {
+                    core_ts_lib_1.Logger.error(`Dashboard Task with ID: ${task._id} has no valid associated owner (user).`);
+                    return true;
+                }
+                return false;
+            },
+            documentValidator: (task) => {
+                const { updatedDoc, errors } = (0, core_ts_db_lib_1.validateDashboardTask)(task);
+                const sharedWithUserIds = [...task.sharedWith];
+                sharedWithUserIds.forEach((userId) => {
+                    if (!allUserIds[userId.toString()]) {
+                        errors.push(`User with ID: ${userId} does not exist in sharedWith property of task with ID: ${task._id}.`);
+                        // eslint-disable-next-line no-param-reassign
+                        task.sharedWith = task.sharedWith.filter((id) => id.toString() !== userId.toString());
+                    }
+                });
+                return { updatedDoc, errors };
+            },
+            deletionFunction: async (docIdsToDelete) => {
+                await taskRepo.deleteList(docIdsToDelete);
+            },
+            updateFunction: async (docsToUpdate) => {
+                await taskRepo.updateMany(docsToUpdate);
+            }
+        });
+    }
+}
+exports.default = DashboardTaskValidator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/be-ts-db-lib",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "A backend database library meant to actually interact with various databases in personal projects",
   "author": "Anton G Neuhold Jr <agneuhold@gmail.com>",
   "license": "MIT",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@aneuhold/be-ts-lib": "^1.0.6",
-    "@aneuhold/core-ts-db-lib": "^1.0.13",
+    "@aneuhold/core-ts-db-lib": "^1.0.16",
     "@aneuhold/core-ts-lib": "^1.1.9",
     "bson": "^6.2.0",
     "mongodb": "^6.3.0"