@aneuhold/be-ts-db-lib 1.0.115 → 2.0.20

package/lib/validators/BaseValidator.ts

@@ -0,0 +1,150 @@
+import { BaseDocument, DocumentValidator } from '@aneuhold/core-ts-db-lib';
+import { Logger } from '@aneuhold/core-ts-lib';
+import { ObjectId } from 'bson';
+
+export enum ObjectSchemaState {
+  Valid,
+  InvalidAndCorrectable,
+  InvalidAndUncorrectable
+}
+
+export default abstract class IValidator<TBaseType extends BaseDocument> {
+  /**
+   * Validates that an object that is supposed to be inserted in to the database
+   * is correct.
+   */
+  abstract validateNewObject(object: TBaseType): Promise<void>;
+
+  /**
+   * Validates an object that is suppposed to be updated in the database.
+   *
+   * At this point, the fields that do not change should already be stripped.
+   */
+  abstract validateUpdateObject(
+    partialObject: Partial<TBaseType>
+  ): Promise<void>;
+
+  /**
+   * Validates the entire DB for the repository, and corrects where needed.
+   *
+   * This should only correct the records that this repository has a full
+   * understanding of.
+   *
+   * This can be a long-running process, so it should only be executed in a
+   * script.
+   *
+   * Make sure to use the {@link runStandardValidationForRepository} method
+   * to run the validation to make things easier.
+   */
+  abstract validateRepositoryInDb(dryRun: boolean): Promise<void>;
+
+  /**
+   * Runs the standard validation for a repository.
+   *
+   * @param input
+   * @param shouldDelete A function that returns true if the document should be
+   * deleted. This should also log the specific error because it will not be
+   * logged elsewhere.
+   * @param input.dryRun
+   * @param input.docName
+   * @param input.allDocs
+   * @param input.shouldDelete
+   * @param input.documentValidator
+   * @param input.deletionFunction
+   * @param input.updateFunction
+   */
+  protected async runStandardValidationForRepository(input: {
+    dryRun: boolean;
+    docName: string;
+    allDocs: Array<TBaseType>;
+    shouldDelete: (doc: TBaseType) => boolean;
+    documentValidator: DocumentValidator<TBaseType>;
+    deletionFunction: (docIdsToDelete: ObjectId[]) => Promise<void>;
+    updateFunction: (docsToUpdate: TBaseType[]) => Promise<void>;
+  }) {
+    const {
+      dryRun,
+      docName,
+      allDocs,
+      shouldDelete,
+      documentValidator,
+      deletionFunction,
+      updateFunction
+    } = input;
+    const docIdsToDelete: Array<ObjectId> = [];
+    const docsToValidate: Array<TBaseType> = [];
+    const docsToUpdate: Array<TBaseType> = [];
+    let numInvalidDocs = 0;
+
+    // Check for docs that need to be deleted
+    allDocs.forEach((doc) => {
+      if (shouldDelete(doc)) {
+        docIdsToDelete.push(doc._id);
+      } else {
+        docsToValidate.push(doc);
+      }
+    });
+    // Validate the rest
+    docsToValidate.forEach((doc) => {
+      const { updatedDoc, errors } = documentValidator(doc);
+      if (errors.length !== 0) {
+        Logger.error(
+          `${docName} with ID: ${doc._id.toString()} is invalid. Errors:`
+        );
+        numInvalidDocs += 1;
+        errors.forEach((error) => {
+          Logger.error(error);
+        });
+        docsToUpdate.push(updatedDoc);
+      }
+    });
+    if (dryRun) {
+      if (numInvalidDocs === 0) {
+        Logger.success(`No invalid ${docName}s found.`);
+      } else {
+        Logger.info(
+          `Would update ${numInvalidDocs} ${docName}s in the database.`
+        );
+      }
+      if (docIdsToDelete.length === 0) {
+        Logger.success(`No ${docName}s to delete found.`);
+      } else {
+        Logger.info(
+          `Would delete ${docIdsToDelete.length} ${docName}s in the database.`
+        );
+      }
+      return;
+    }
+    // Delete all invalid
+    if (docIdsToDelete.length !== 0) {
+      Logger.info(
+        `Deleting ${docIdsToDelete.length} ${docName}s from the database.`
+      );
+      await deletionFunction(docIdsToDelete);
+    } else {
+      Logger.success(`No ${docName}s to delete found.`);
+    }
+    // Update all that need to be updated
+    if (docsToUpdate.length !== 0) {
+      Logger.info(
+        `Updating ${docsToUpdate.length} ${docName}s in the database.`
+      );
+      await updateFunction(docsToUpdate);
+    } else {
+      Logger.success(`No ${docName}s to update found.`);
+    }
+  }
+
+  /**
+   * Checks that all elements that exist in array1, exist in array2.
+   *
+   * @param array1
+   * @param array2
+   */
+  protected checkAllElementsExistInArr(
+    array1: Array<unknown>,
+    array2: Array<unknown>
+  ): boolean {
+    return array1.every((value) => array2.includes(value));
+  }
+}

package/lib/validators/common/ApiKeyValidator.d.ts

@@ -1,5 +1,5 @@
 import { ApiKey } from '@aneuhold/core-ts-db-lib';
-import IValidator from '../BaseValidator';
+import IValidator from '../BaseValidator.js';
 export default class ApiKeyValidator extends IValidator<ApiKey> {
     validateNewObject(newApiKey: ApiKey): Promise<void>;
     validateUpdateObject(updatedApiKey: Partial<ApiKey>): Promise<void>;

package/lib/validators/common/ApiKeyValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKeyValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/common/ApiKeyValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAKlD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAG1C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,UAAU,CAAC,MAAM,CAAC;IACvD,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBnD,oBAAoB,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA2B7D"}
+{"version":3,"file":"ApiKeyValidator.d.ts","sourceRoot":"./src/","sources":["validators/common/ApiKeyValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAkB,MAAM,0BAA0B,CAAC;AAKlE,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,UAAU,CAAC,MAAM,CAAC;IACvD,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBnD,oBAAoB,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA2B7D"}

package/lib/validators/common/ApiKeyValidator.js

@@ -1,50 +1,45 @@
-"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_lib_1 = require("@aneuhold/core-ts-lib");
-const ApiKey_1 = require("@aneuhold/core-ts-db-lib/lib/documents/common/ApiKey");
-const UserRepository_1 = __importDefault(require("../../repositories/common/UserRepository"));
-const BaseValidator_1 = __importDefault(require("../BaseValidator"));
-const ApiKeyRepository_1 = __importDefault(require("../../repositories/common/ApiKeyRepository"));
-class ApiKeyValidator extends BaseValidator_1.default {
+import { validateApiKey } from '@aneuhold/core-ts-db-lib';
+import { ErrorUtils, Logger } from '@aneuhold/core-ts-lib';
+import ApiKeyRepository from '../../repositories/common/ApiKeyRepository.js';
+import UserRepository from '../../repositories/common/UserRepository.js';
+import IValidator from '../BaseValidator.js';
+export default class ApiKeyValidator extends IValidator {
     async validateNewObject(newApiKey) {
         // Check if the user exists
-        const userRepo = UserRepository_1.default.getRepo();
+        const userRepo = UserRepository.getRepo();
         const userInDb = await userRepo.get({ _id: newApiKey.userId });
         if (!userInDb) {
-            core_ts_lib_1.ErrorUtils.throwError(`User with ID: ${newApiKey.userId.toString()} does not exist in the database.`, newApiKey);
+            ErrorUtils.throwError(`User with ID: ${newApiKey.userId.toString()} does not exist in the database.`, newApiKey);
             return;
         }
         // Check if the user already has an API key
-        const apiKeyRepo = ApiKeyRepository_1.default.getRepo();
+        const apiKeyRepo = ApiKeyRepository.getRepo();
         const apiKeyInDb = await apiKeyRepo.get({ userId: newApiKey.userId });
         if (apiKeyInDb) {
-            core_ts_lib_1.ErrorUtils.throwError(`User with ID: ${newApiKey.userId.toString()} already has an API key.`, newApiKey);
+            ErrorUtils.throwError(`User with ID: ${newApiKey.userId.toString()} already has an API key.`, newApiKey);
         }
     }
     // eslint-disable-next-line @typescript-eslint/require-await
     async validateUpdateObject(updatedApiKey) {
         // Throw, because API keys should not be updated. Only created and deleted.
-        core_ts_lib_1.ErrorUtils.throwError(`API keys should not be updated at this time. Only created and deleted.`, updatedApiKey);
+        ErrorUtils.throwError(`API keys should not be updated at this time. Only created and deleted.`, updatedApiKey);
     }
     async validateRepositoryInDb(dryRun) {
-        const apiKeyRepo = ApiKeyRepository_1.default.getRepo();
+        const apiKeyRepo = ApiKeyRepository.getRepo();
         const allApiKeys = await apiKeyRepo.getAll();
-        const allUserIds = await UserRepository_1.default.getRepo().getAllIdsAsHash();
+        const allUserIds = await UserRepository.getRepo().getAllIdsAsHash();
         await this.runStandardValidationForRepository({
             dryRun,
             docName: 'API Key',
             allDocs: allApiKeys,
             shouldDelete: (apiKey) => {
                 if (!allUserIds[apiKey.userId.toString()]) {
-                    core_ts_lib_1.Logger.error(`API Key with ID: ${apiKey._id.toString()} has no valid associated user.`);
+                    Logger.error(`API Key with ID: ${apiKey._id.toString()} has no valid associated user.`);
                     return true;
                 }
                 return false;
             },
-            documentValidator: ApiKey_1.validateApiKey,
+            documentValidator: validateApiKey,
             deletionFunction: async (docIdsToDelete) => {
                 await apiKeyRepo.deleteList(docIdsToDelete);
             },
@@ -54,4 +49,4 @@ class ApiKeyValidator extends BaseValidator_1.default {
         });
     }
 }
-exports.default = ApiKeyValidator;
+//# sourceMappingURL=ApiKeyValidator.js.map

package/lib/validators/common/ApiKeyValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKeyValidator.js","sourceRoot":"./src/","sources":["validators/common/ApiKeyValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,gBAAgB,MAAM,+CAA+C,CAAC;AAC7E,OAAO,cAAc,MAAM,6CAA6C,CAAC;AACzE,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,UAAkB;IAC7D,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,UAAU,CAAC,UAAU,CACnB,iBAAiB,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,kCAAkC,EAC9E,SAAS,CACV,CAAC;YACF,OAAO;QACT,CAAC;QACD,2CAA2C;QAC3C,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QACtE,IAAI,UAAU,EAAE,CAAC;YACf,UAAU,CAAC,UAAU,CACnB,iBAAiB,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,0BAA0B,EACtE,SAAS,CACV,CAAC;QACJ,CAAC;IACH,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,oBAAoB,CAAC,aAA8B;QACvD,2EAA2E;QAC3E,UAAU,CAAC,UAAU,CACnB,wEAAwE,EACxE,aAAa,CACd,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,MAAe;QAC1C,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC,eAAe,EAAE,CAAC;QAEpE,MAAM,IAAI,CAAC,kCAAkC,CAAC;YAC5C,MAAM;YACN,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,UAAU;YACnB,YAAY,EAAE,CAAC,MAAc,EAAE,EAAE;gBAC/B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;oBAC1C,MAAM,CAAC,KAAK,CACV,oBAAoB,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,gCAAgC,CAC1E,CAAC;oBACF,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,iBAAiB,EAAE,cAAc;YACjC,gBAAgB,EAAE,KAAK,EAAE,cAA0B,EAAE,EAAE;gBACrD,MAAM,UAAU,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAC9C,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,YAAsB,EAAE,EAAE;gBAC/C,MAAM,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC5C,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/validators/common/ApiKeyValidator.ts

@@ -0,0 +1,67 @@
+import { ApiKey, validateApiKey } from '@aneuhold/core-ts-db-lib';
+import { ErrorUtils, Logger } from '@aneuhold/core-ts-lib';
+import { ObjectId } from 'bson';
+import ApiKeyRepository from '../../repositories/common/ApiKeyRepository.js';
+import UserRepository from '../../repositories/common/UserRepository.js';
+import IValidator from '../BaseValidator.js';
+
+export default class ApiKeyValidator extends IValidator<ApiKey> {
+  async validateNewObject(newApiKey: ApiKey): Promise<void> {
+    // Check if the user exists
+    const userRepo = UserRepository.getRepo();
+    const userInDb = await userRepo.get({ _id: newApiKey.userId });
+    if (!userInDb) {
+      ErrorUtils.throwError(
+        `User with ID: ${newApiKey.userId.toString()} does not exist in the database.`,
+        newApiKey
+      );
+      return;
+    }
+    // Check if the user already has an API key
+    const apiKeyRepo = ApiKeyRepository.getRepo();
+    const apiKeyInDb = await apiKeyRepo.get({ userId: newApiKey.userId });
+    if (apiKeyInDb) {
+      ErrorUtils.throwError(
+        `User with ID: ${newApiKey.userId.toString()} already has an API key.`,
+        newApiKey
+      );
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/require-await
+  async validateUpdateObject(updatedApiKey: Partial<ApiKey>): Promise<void> {
+    // Throw, because API keys should not be updated. Only created and deleted.
+    ErrorUtils.throwError(
+      `API keys should not be updated at this time. Only created and deleted.`,
+      updatedApiKey
+    );
+  }
+
+  async validateRepositoryInDb(dryRun: boolean): Promise<void> {
+    const apiKeyRepo = ApiKeyRepository.getRepo();
+    const allApiKeys = await apiKeyRepo.getAll();
+    const allUserIds = await UserRepository.getRepo().getAllIdsAsHash();
+
+    await this.runStandardValidationForRepository({
+      dryRun,
+      docName: 'API Key',
+      allDocs: allApiKeys,
+      shouldDelete: (apiKey: ApiKey) => {
+        if (!allUserIds[apiKey.userId.toString()]) {
+          Logger.error(
+            `API Key with ID: ${apiKey._id.toString()} has no valid associated user.`
+          );
+          return true;
+        }
+        return false;
+      },
+      documentValidator: validateApiKey,
+      deletionFunction: async (docIdsToDelete: ObjectId[]) => {
+        await apiKeyRepo.deleteList(docIdsToDelete);
+      },
+      updateFunction: async (docsToUpdate: ApiKey[]) => {
+        await apiKeyRepo.updateMany(docsToUpdate);
+      }
+    });
+  }
+}

package/lib/validators/common/UserValidator.d.ts

@@ -1,11 +1,24 @@
 import { User } from '@aneuhold/core-ts-db-lib';
-import IValidator from '../BaseValidator';
+import IValidator from '../BaseValidator.js';
+/**
+ * Validator for the User class.
+ */
 export default class UserValidator extends IValidator<User> {
     validateNewObject(newUser: User): Promise<void>;
+    /**
+     * Validates the object to be updated.
+     *
+     * @param userToUpdate - The user to be updated.
+     * @returns A promise that resolves when the validation is complete.
+     */
     validateUpdateObject(userToUpdate: Partial<User>): Promise<void>;
     validateRepositoryInDb(dryRun: boolean): Promise<void>;
     /**
      * Checks if the username exists already and throws an error if it does.
+     *
+     * @param userRepo - The user repository
+     * @param userName - The username to check
+     * @throws An error if the username already exists
      */
     private checkIfUserNameExists;
 }

package/lib/validators/common/UserValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/common/UserValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,0BAA0B,CAAC;AAG9D,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAI1C,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU,CAAC,IAAI,CAAC;IACnD,iBAAiB,CAAC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/C,oBAAoB,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BhE,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B5D;;OAEG;YACW,qBAAqB;CAWpC"}
+{"version":3,"file":"UserValidator.d.ts","sourceRoot":"./src/","sources":["validators/common/UserValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,0BAA0B,CAAC;AAK9D,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU,CAAC,IAAI,CAAC;IACnD,iBAAiB,CAAC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;;;OAKG;IACG,oBAAoB,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BhE,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B5D;;;;;;OAMG;YACW,qBAAqB;CAWpC"}

package/lib/validators/common/UserValidator.js

@@ -1,29 +1,33 @@
-"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 testsUtil_1 = require("../../tests/testsUtil");
-class UserValidator extends BaseValidator_1.default {
+import { User, validateUser } from '@aneuhold/core-ts-db-lib';
+import { ErrorUtils, Logger } from '@aneuhold/core-ts-lib';
+import UserRepository from '../../repositories/common/UserRepository.js';
+import { TEST_USER_NAME_PREFIX } from '../../tests/globalTestVariables.js';
+import IValidator from '../BaseValidator.js';
+/**
+ * Validator for the User class.
+ */
+export default class UserValidator extends IValidator {
     async validateNewObject(newUser) {
         // Check if the username already exists
-        const userRepo = UserRepository_1.default.getRepo();
+        const userRepo = UserRepository.getRepo();
         await this.checkIfUserNameExists(userRepo, newUser.userName);
     }
+    /**
+     * Validates the object to be updated.
+     *
+     * @param userToUpdate - The user to be updated.
+     * @returns A promise that resolves when the validation is complete.
+     */
     async validateUpdateObject(userToUpdate) {
         // Check if an id is defined
         if (!userToUpdate._id) {
-            core_ts_lib_1.ErrorUtils.throwError(`No _id defined for ${core_ts_db_lib_1.User.name} to update.`, userToUpdate);
+            ErrorUtils.throwError(`No _id defined for ${User.name} to update.`, userToUpdate);
         }
         // Check to see if the user exists
-        const userRepo = UserRepository_1.default.getRepo();
+        const userRepo = UserRepository.getRepo();
         const userInDb = await userRepo.get({ _id: userToUpdate._id });
         if (!userInDb) {
-            core_ts_lib_1.ErrorUtils.throwError(`${core_ts_db_lib_1.User.name} with ID: ${userToUpdate._id?.toString()} does not exist in the database.`, userToUpdate);
+            ErrorUtils.throwError(`${User.name} with ID: ${userToUpdate._id?.toString()} does not exist in the database.`, userToUpdate);
             return;
         }
         // Check if the username is being updated and, if it is, if it already
@@ -33,20 +37,20 @@ class UserValidator extends BaseValidator_1.default {
         }
     }
     async validateRepositoryInDb(dryRun) {
-        const userRepo = UserRepository_1.default.getRepo();
+        const userRepo = UserRepository.getRepo();
         const allUsers = await userRepo.getAll();
         await this.runStandardValidationForRepository({
             dryRun,
             docName: 'User',
             allDocs: allUsers,
             shouldDelete: (user) => {
-                if (user.userName.startsWith(testsUtil_1.TEST_USER_NAME_PREFIX)) {
-                    core_ts_lib_1.Logger.error(`User with ID: ${user._id.toString()} is a test user and should be deleted`);
+                if (user.userName.startsWith(TEST_USER_NAME_PREFIX)) {
+                    Logger.error(`User with ID: ${user._id.toString()} is a test user and should be deleted`);
                     return true;
                 }
                 return false;
             },
-            documentValidator: core_ts_db_lib_1.validateUser,
+            documentValidator: validateUser,
             deletionFunction: async (docIdsToDelete) => {
                 await userRepo.deleteList(docIdsToDelete);
             },
@@ -57,14 +61,18 @@ class UserValidator extends BaseValidator_1.default {
     }
     /**
      * Checks if the username exists already and throws an error if it does.
+     *
+     * @param userRepo - The user repository
+     * @param userName - The username to check
+     * @throws An error if the username already exists
      */
     async checkIfUserNameExists(userRepo, userName) {
         const userNameSearchResult = await userRepo.get({
             userName
         });
         if (userNameSearchResult) {
-            core_ts_lib_1.ErrorUtils.throwError('Username already exists', { userName });
+            ErrorUtils.throwError('Username already exists', { userName });
         }
     }
 }
-exports.default = UserValidator;
+//# sourceMappingURL=UserValidator.js.map

package/lib/validators/common/UserValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserValidator.js","sourceRoot":"./src/","sources":["validators/common/UserValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,cAAc,MAAM,6CAA6C,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAgB;IACzD,KAAK,CAAC,iBAAiB,CAAC,OAAa;QACnC,uCAAuC;QACvC,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CAAC,YAA2B;QACpD,4BAA4B;QAC5B,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;YACtB,UAAU,CAAC,UAAU,CACnB,sBAAsB,IAAI,CAAC,IAAI,aAAa,EAC5C,YAAY,CACb,CAAC;QACJ,CAAC;QAED,kCAAkC;QAClC,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,UAAU,CAAC,UAAU,CACnB,GACE,IAAI,CAAC,IACP,aAAa,YAAY,CAAC,GAAG,EAAE,QAAQ,EAAE,kCAAkC,EAC3E,YAAY,CACb,CAAC;YACF,OAAO;QACT,CAAC;QAED,sEAAsE;QACtE,SAAS;QACT,IAAI,YAAY,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;YACzE,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,MAAe;QAC1C,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;QAEzC,MAAM,IAAI,CAAC,kCAAkC,CAAC;YAC5C,MAAM;YACN,OAAO,EAAE,MAAM;YACf,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,CAAC,IAAU,EAAE,EAAE;gBAC3B,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;oBACpD,MAAM,CAAC,KAAK,CACV,iBAAiB,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,uCAAuC,CAC5E,CAAC;oBACF,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,iBAAiB,EAAE,YAAY;YAC/B,gBAAgB,EAAE,KAAK,EAAE,cAA0B,EAAE,EAAE;gBACrD,MAAM,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAC5C,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,YAAoB,EAAE,EAAE;gBAC7C,MAAM,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC1C,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,qBAAqB,CACjC,QAAwB,EACxB,QAAgB;QAEhB,MAAM,oBAAoB,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC;YAC9C,QAAQ;SACT,CAAC,CAAC;QACH,IAAI,oBAAoB,EAAE,CAAC;YACzB,UAAU,CAAC,UAAU,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF"}

package/lib/validators/common/UserValidator.ts

@@ -0,0 +1,98 @@
+import { User, validateUser } from '@aneuhold/core-ts-db-lib';
+import { ErrorUtils, Logger } from '@aneuhold/core-ts-lib';
+import { ObjectId } from 'bson';
+import UserRepository from '../../repositories/common/UserRepository.js';
+import { TEST_USER_NAME_PREFIX } from '../../tests/globalTestVariables.js';
+import IValidator from '../BaseValidator.js';
+
+/**
+ * Validator for the User class.
+ */
+export default class UserValidator extends IValidator<User> {
+  async validateNewObject(newUser: User): Promise<void> {
+    // Check if the username already exists
+    const userRepo = UserRepository.getRepo();
+    await this.checkIfUserNameExists(userRepo, newUser.userName);
+  }
+
+  /**
+   * Validates the object to be updated.
+   *
+   * @param userToUpdate - The user to be updated.
+   * @returns A promise that resolves when the validation is complete.
+   */
+  async validateUpdateObject(userToUpdate: Partial<User>): Promise<void> {
+    // Check if an id is defined
+    if (!userToUpdate._id) {
+      ErrorUtils.throwError(
+        `No _id defined for ${User.name} to update.`,
+        userToUpdate
+      );
+    }
+
+    // Check to see if the user exists
+    const userRepo = UserRepository.getRepo();
+    const userInDb = await userRepo.get({ _id: userToUpdate._id });
+    if (!userInDb) {
+      ErrorUtils.throwError(
+        `${
+          User.name
+        } with ID: ${userToUpdate._id?.toString()} does not exist in the database.`,
+        userToUpdate
+      );
+      return;
+    }
+
+    // Check if the username is being updated and, if it is, if it already
+    // exists
+    if (userToUpdate.userName && userInDb.userName !== userToUpdate.userName) {
+      await this.checkIfUserNameExists(userRepo, userToUpdate.userName);
+    }
+  }
+
+  async validateRepositoryInDb(dryRun: boolean): Promise<void> {
+    const userRepo = UserRepository.getRepo();
+    const allUsers = await userRepo.getAll();
+
+    await this.runStandardValidationForRepository({
+      dryRun,
+      docName: 'User',
+      allDocs: allUsers,
+      shouldDelete: (user: User) => {
+        if (user.userName.startsWith(TEST_USER_NAME_PREFIX)) {
+          Logger.error(
+            `User with ID: ${user._id.toString()} is a test user and should be deleted`
+          );
+          return true;
+        }
+        return false;
+      },
+      documentValidator: validateUser,
+      deletionFunction: async (docIdsToDelete: ObjectId[]) => {
+        await userRepo.deleteList(docIdsToDelete);
+      },
+      updateFunction: async (docsToUpdate: User[]) => {
+        await userRepo.updateMany(docsToUpdate);
+      }
+    });
+  }
+
+  /**
+   * Checks if the username exists already and throws an error if it does.
+   *
+   * @param userRepo - The user repository
+   * @param userName - The username to check
+   * @throws An error if the username already exists
+   */
+  private async checkIfUserNameExists(
+    userRepo: UserRepository,
+    userName: string
+  ) {
+    const userNameSearchResult = await userRepo.get({
+      userName
+    });
+    if (userNameSearchResult) {
+      ErrorUtils.throwError('Username already exists', { userName });
+    }
+  }
+}

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

@@ -1,5 +1,5 @@
 import { NonogramKatanaItem } from '@aneuhold/core-ts-db-lib';
-import IValidator from '../BaseValidator';
+import IValidator from '../BaseValidator.js';
 export default class DashboardNonogramKatanaItemValidator extends IValidator<NonogramKatanaItem> {
     validateNewObject(newItem: NonogramKatanaItem): Promise<void>;
     validateUpdateObject(updatedItem: Partial<NonogramKatanaItem>): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"NonogramKatanaItemValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/dashboard/NonogramKatanaItemValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAEnB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAI1C,MAAM,CAAC,OAAO,OAAO,oCAAqC,SAAQ,UAAU,CAAC,kBAAkB,CAAC;IACxF,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB7D,oBAAoB,CACxB,WAAW,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC;IAUV,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA8B7D"}
+{"version":3,"file":"NonogramKatanaItemValidator.d.ts","sourceRoot":"./src/","sources":["validators/dashboard/NonogramKatanaItemValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAEnB,MAAM,0BAA0B,CAAC;AAKlC,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,oCAAqC,SAAQ,UAAU,CAAC,kBAAkB,CAAC;IACxF,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB7D,oBAAoB,CACxB,WAAW,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC;IAUV,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA8B7D"}

package/lib/validators/dashboard/NonogramKatanaItemValidator.js

@@ -1,54 +1,49 @@
-"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 DashboardNonogramKatanaItemRepository_1 = __importDefault(require("../../repositories/dashboard/DashboardNonogramKatanaItemRepository"));
-class DashboardNonogramKatanaItemValidator extends BaseValidator_1.default {
+import { validateNonogramKatanaItem } from '@aneuhold/core-ts-db-lib';
+import { ErrorUtils, Logger } from '@aneuhold/core-ts-lib';
+import UserRepository from '../../repositories/common/UserRepository.js';
+import DashboardNonogramKatanaItemRepository from '../../repositories/dashboard/DashboardNonogramKatanaItemRepository.js';
+import IValidator from '../BaseValidator.js';
+export default class DashboardNonogramKatanaItemValidator extends IValidator {
     async validateNewObject(newItem) {
         // Check if the item already exists for the user
-        const itemRepo = DashboardNonogramKatanaItemRepository_1.default.getRepo();
+        const itemRepo = DashboardNonogramKatanaItemRepository.getRepo();
         const existingItem = await itemRepo.get({
             userId: newItem.userId,
             itemName: newItem.itemName
         });
         if (existingItem) {
-            core_ts_lib_1.ErrorUtils.throwError(`Nonogram Katana item already exists for user: ${newItem.userId.toString()}`, newItem);
+            ErrorUtils.throwError(`Nonogram Katana item already exists for user: ${newItem.userId.toString()}`, newItem);
         }
-        const userRepo = UserRepository_1.default.getRepo();
+        const userRepo = UserRepository.getRepo();
         const user = await userRepo.get({ _id: newItem.userId });
         if (!user) {
-            core_ts_lib_1.ErrorUtils.throwError(`User does not exist: ${newItem.userId.toString()}`, newItem);
+            ErrorUtils.throwError(`User does not exist: ${newItem.userId.toString()}`, newItem);
         }
     }
     // eslint-disable-next-line @typescript-eslint/require-await
     async validateUpdateObject(updatedItem) {
         // Check if an id is defined
         if (!updatedItem._id) {
-            core_ts_lib_1.ErrorUtils.throwError(`No _id defined for NonogramKatanaItem update.`, updatedItem);
+            ErrorUtils.throwError(`No _id defined for NonogramKatanaItem update.`, updatedItem);
         }
     }
     async validateRepositoryInDb(dryRun) {
-        const itemRepo = DashboardNonogramKatanaItemRepository_1.default.getRepo();
+        const itemRepo = DashboardNonogramKatanaItemRepository.getRepo();
         const allItems = await itemRepo.getAll();
-        const allUserIds = await UserRepository_1.default.getRepo().getAllIdsAsHash();
+        const allUserIds = await UserRepository.getRepo().getAllIdsAsHash();
         await this.runStandardValidationForRepository({
             dryRun,
             docName: 'Nonogram Katana Item',
             allDocs: allItems,
             shouldDelete: (item) => {
                 if (!allUserIds[item.userId.toString()]) {
-                    core_ts_lib_1.Logger.error(`Nonogram Katana Item with ID: ${item._id.toString()} has no valid associated user.`);
+                    Logger.error(`Nonogram Katana Item with ID: ${item._id.toString()} has no valid associated user.`);
                     return true;
                 }
                 return false;
             },
             documentValidator: (item) => {
-                const { updatedDoc, errors } = (0, core_ts_db_lib_1.validateNonogramKatanaItem)(item);
+                const { updatedDoc, errors } = validateNonogramKatanaItem(item);
                 return { updatedDoc, errors };
             },
             deletionFunction: async (docIdsToDelete) => {
@@ -60,4 +55,4 @@ class DashboardNonogramKatanaItemValidator extends BaseValidator_1.default {
         });
     }
 }
-exports.default = DashboardNonogramKatanaItemValidator;
+//# sourceMappingURL=NonogramKatanaItemValidator.js.map

package/lib/validators/dashboard/NonogramKatanaItemValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NonogramKatanaItemValidator.js","sourceRoot":"./src/","sources":["validators/dashboard/NonogramKatanaItemValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,cAAc,MAAM,6CAA6C,CAAC;AACzE,OAAO,qCAAqC,MAAM,uEAAuE,CAAC;AAC1H,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,oCAAqC,SAAQ,UAA8B;IAC9F,KAAK,CAAC,iBAAiB,CAAC,OAA2B;QACjD,gDAAgD;QAChD,MAAM,QAAQ,GAAG,qCAAqC,CAAC,OAAO,EAAE,CAAC;QACjE,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC;YACtC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QACH,IAAI,YAAY,EAAE,CAAC;YACjB,UAAU,CAAC,UAAU,CACnB,iDAAiD,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,EAC5E,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,UAAU,CAAC,UAAU,CACnB,wBAAwB,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,EACnD,OAAO,CACR,CAAC;QACJ,CAAC;IACH,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,oBAAoB,CACxB,WAAwC;QAExC,4BAA4B;QAC5B,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;YACrB,UAAU,CAAC,UAAU,CACnB,+CAA+C,EAC/C,WAAW,CACZ,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,MAAe;QAC1C,MAAM,QAAQ,GAAG,qCAAqC,CAAC,OAAO,EAAE,CAAC;QACjE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;QACzC,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC,eAAe,EAAE,CAAC;QAEpE,MAAM,IAAI,CAAC,kCAAkC,CAAC;YAC5C,MAAM;YACN,OAAO,EAAE,sBAAsB;YAC/B,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,CAAC,IAAwB,EAAE,EAAE;gBACzC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;oBACxC,MAAM,CAAC,KAAK,CACV,iCAAiC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,gCAAgC,CACrF,CAAC;oBACF,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,iBAAiB,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC1B,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAC;gBAChE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;YAChC,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,cAA0B,EAAE,EAAE;gBACrD,MAAM,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAC5C,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,YAAkC,EAAE,EAAE;gBAC3D,MAAM,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC1C,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}