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

package/lib/services/MigrationService.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-ignore
+// @ts-nocheck
+const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+const UserRepository_1 = __importDefault(require("../repositories/common/UserRepository"));
+/**
+ * A service for migrating the DB to a new state after an existing document
+ * change.
+ *
+ * This entire class is ignored from ESLint and TypeScript to allow for
+ * manipulating the DB in any way necessary.
+ */
+class MigrationService {
+    /**
+     * A function that can be used to migrate the DB to a new state after an
+     * existing document change.
+     *
+     * ❗️ BEWARE!!! ❗️
+     * TRIPLE CHECK THAT THIS IS WHAT YOU WANT TO DO BEFORE RUNNING THIS FUNCTION.
+     *
+     * @param dryRun Whether or not to actually make the changes or just log them.
+     */
+    static async migrateDb(dryRun = false) {
+        const userRepo = UserRepository_1.default.getRepo();
+        const allUsers = (await userRepo.getAll());
+        const updatedUsers = [];
+        allUsers.forEach((user) => {
+            if (user.password) {
+                core_ts_lib_1.Logger.error(`User with ID: ${user._id} has a password in the wrong spot.`);
+                user.auth.password = user.password;
+                delete user.password;
+                updatedUsers.push(user);
+            }
+        });
+        if (dryRun) {
+            if (updatedUsers.length > 0) {
+                core_ts_lib_1.Logger.info(`Would update ${updatedUsers.length} users.`);
+            }
+            else {
+                core_ts_lib_1.Logger.success('No changes to make.');
+            }
+            return;
+        }
+        if (updatedUsers.length > 0) {
+            core_ts_lib_1.Logger.info(`Updating ${updatedUsers.length} users.`);
+            await userRepo.updateMany(updatedUsers);
+        }
+        else {
+            core_ts_lib_1.Logger.success('No changes to make.');
+        }
+    }
+}
+exports.default = MigrationService;

package/lib/services/RepoSubscriptionService.d.ts

@@ -0,0 +1,30 @@
+import { BaseDocument } from '@aneuhold/core-ts-db-lib';
+import { ObjectId } from 'bson';
+export type RepoSubscribers<TDocType extends BaseDocument> = {
+    insertNew: InsertNewSubscriber<TDocType>[];
+    updateMany: UpdateManySubscriber<TDocType>[];
+    deleteOne: DeleteOneSubscriber[];
+    deleteList: DeleteListSubscriber[];
+};
+export type RepoListeners<TDocType extends BaseDocument> = {
+    insertNew?: InsertNewSubscriber<TDocType>;
+    updateMany?: UpdateManySubscriber<TDocType>;
+    deleteOne?: DeleteOneSubscriber;
+    deleteList?: DeleteListSubscriber;
+};
+export type InsertNewSubscriber<TDocType extends BaseDocument> = (doc: TDocType) => Promise<void>;
+export type UpdateManySubscriber<TDocType extends BaseDocument> = (docs: TDocType[]) => Promise<void>;
+export type DeleteOneSubscriber = (docId: ObjectId) => Promise<void>;
+export type DeleteListSubscriber = (docIds: ObjectId[]) => Promise<void>;
+/**
+ * A subscription service that allows repositories to subscribe to events
+ * that happen in other repositories.
+ */
+export default class RepoSubscriptionService {
+    /**
+     * A utility method to get a default empty set of subscribers for a
+     * repository.
+     */
+    static getDefaultSubscribers<TDocType extends BaseDocument>(): RepoSubscribers<TDocType>;
+}
+//# sourceMappingURL=RepoSubscriptionService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RepoSubscriptionService.d.ts","sourceRoot":"","sources":["../../src/services/RepoSubscriptionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,YAAY,IAAI;IAC3D,SAAS,EAAE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3C,UAAU,EAAE,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC7C,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,YAAY,IAAI;IACzD,SAAS,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC1C,UAAU,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC5C,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,QAAQ,SAAS,YAAY,IAAI,CAC/D,GAAG,EAAE,QAAQ,KACV,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,oBAAoB,CAAC,QAAQ,SAAS,YAAY,IAAI,CAChE,IAAI,EAAE,QAAQ,EAAE,KACb,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErE,MAAM,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAuB;IAC1C;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAC1B,QAAQ,SAAS,YAAY,KAC1B,eAAe,CAAC,QAAQ,CAAC;CAQ/B"}

package/lib/services/RepoSubscriptionService.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A subscription service that allows repositories to subscribe to events
+ * that happen in other repositories.
+ */
+class RepoSubscriptionService {
+    /**
+     * A utility method to get a default empty set of subscribers for a
+     * repository.
+     */
+    static getDefaultSubscribers() {
+        return {
+            insertNew: [],
+            updateMany: [],
+            deleteOne: [],
+            deleteList: []
+        };
+    }
+}
+exports.default = RepoSubscriptionService;

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

@@ -8,10 +8,10 @@ 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 UserConfigRepository_1 = __importDefault(require("../../repositories/dashboard/UserConfigRepository"));
+const DashboardUserConfigRepository_1 = __importDefault(require("../../repositories/dashboard/DashboardUserConfigRepository"));
 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(crypto_1.default.randomUUID());
+    const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)());
     const createResult = await userRepository.insertNew(newUser);
     expect(createResult).toBeTruthy();
     await (0, testsUtil_1.cleanupDoc)(userRepository, newUser);
@@ -20,16 +20,16 @@ it('can create a new document and delete it', async () => {
 it.skip('can add a new test user', async () => {
     const userRepository = UserRepository_1.default.getRepo();
     const newUser = new core_ts_db_lib_1.User('someUser');
-    newUser.password = crypto_1.default.randomUUID();
+    newUser.auth.password = crypto_1.default.randomUUID();
     const createResult = await userRepository.insertNew(newUser);
     expect(createResult).toBeTruthy();
 });
-it('can create a dashboard config for a user', async () => {
+it.skip('can create a dashboard config for a user', async () => {
     const userRepo = UserRepository_1.default.getRepo();
     const user = await userRepo.get({ userName: 'usernameHere' });
     expect(user).toBeTruthy();
     if (user) {
-        const configRepo = UserConfigRepository_1.default.getRepo();
+        const configRepo = DashboardUserConfigRepository_1.default.getRepo();
         const newConfig = new core_ts_db_lib_1.DashboardUserConfig(user._id);
         newConfig.enableDevMode = true;
         await configRepo.insertNew(newConfig);

package/lib/tests/repositories/common/UserRepository.spec.js

@@ -3,7 +3,6 @@ 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");
@@ -12,13 +11,13 @@ const DocumentDb_1 = __importDefault(require("../../../util/DocumentDb"));
 const userRepo = UserRepository_1.default.getRepo();
 describe('Create operations', () => {
     it('can create a new user', async () => {
-        const newUser = new core_ts_db_lib_1.User(crypto_1.default.randomUUID());
+        const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)());
         const insertResult = await userRepo.insertNew(newUser);
         expect(insertResult).toBeTruthy();
         await (0, testsUtil_1.cleanupDoc)(userRepo, newUser);
     });
     it('can create a new user and the new user gets an API key', async () => {
-        const newUser = new core_ts_db_lib_1.User(crypto_1.default.randomUUID());
+        const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)());
         const insertResult = await userRepo.insertNew(newUser);
         expect(insertResult).toBeTruthy();
         const apiKey = await ApiKeyRepository_1.default.getRepo().get({
@@ -32,7 +31,7 @@ describe('Create operations', () => {
         expect(apiKeyThatShouldNotExist).toBeFalsy();
     });
     it('throws if the username is a duplicate username', async () => {
-        const duplicateUserName = `${crypto_1.default.randomUUID()}`;
+        const duplicateUserName = (0, testsUtil_1.getTestUserName)();
         const newUser1 = new core_ts_db_lib_1.User(duplicateUserName);
         const newUser2 = new core_ts_db_lib_1.User(duplicateUserName);
         const insertResult = await userRepo.insertNew(newUser1);
@@ -45,8 +44,8 @@ describe('Create operations', () => {
 });
 describe('Update operations', () => {
     it('succeeds in updating the username if the username doesnt already exist', async () => {
-        const userName1 = crypto_1.default.randomUUID();
-        const userName2 = crypto_1.default.randomUUID();
+        const userName1 = (0, testsUtil_1.getTestUserName)();
+        const userName2 = (0, testsUtil_1.getTestUserName)();
         const newUser = new core_ts_db_lib_1.User(userName1);
         // Insert the user
         const insertResult = await userRepo.insertNew(newUser);
@@ -58,15 +57,15 @@ describe('Update operations', () => {
         await (0, testsUtil_1.cleanupDoc)(userRepo, newUser);
     });
     it('throws if no id is defined', async () => {
-        const newUser = new core_ts_db_lib_1.User(crypto_1.default.randomUUID());
+        const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)());
         delete newUser._id;
         await (0, testsUtil_1.expectToThrow)(async () => {
             await userRepo.update(newUser);
         });
     });
     it('throws if the username is updated and already exists', async () => {
-        const userName1 = crypto_1.default.randomUUID();
-        const userName2 = crypto_1.default.randomUUID();
+        const userName1 = (0, testsUtil_1.getTestUserName)();
+        const userName2 = (0, testsUtil_1.getTestUserName)();
         const newUser = new core_ts_db_lib_1.User(userName1);
         const userWithOtherUserName = new core_ts_db_lib_1.User(userName2);
         // Insert the users
@@ -85,7 +84,7 @@ describe('Update operations', () => {
         ]);
     });
     it('throws if the user doesnt exist', async () => {
-        const newUser = new core_ts_db_lib_1.User(crypto_1.default.randomUUID());
+        const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)());
         // Try to update the user
         await (0, testsUtil_1.expectToThrow)(async () => {
             await userRepo.update(newUser);

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

@@ -8,9 +8,9 @@ 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 UserConfigRepository_1 = __importDefault(require("../../../repositories/dashboard/UserConfigRepository"));
+const DashboardUserConfigRepository_1 = __importDefault(require("../../../repositories/dashboard/DashboardUserConfigRepository"));
 const userRepo = UserRepository_1.default.getRepo();
-const configRepo = UserConfigRepository_1.default.getRepo();
+const configRepo = DashboardUserConfigRepository_1.default.getRepo();
 describe('Create operations', () => {
     it('can create a new user config', async () => {
         // User configs are created automatically when a new user is created
@@ -42,7 +42,7 @@ afterAll(async () => {
     return DocumentDb_1.default.closeDbConnection();
 });
 async function createNewTestUser() {
-    const newUser = new core_ts_db_lib_1.User(`${crypto_1.default.randomUUID()}userconfigtest`);
+    const newUser = new core_ts_db_lib_1.User((0, testsUtil_1.getTestUserName)(`${crypto_1.default.randomUUID()}userconfigtest`));
     newUser.projectAccess.dashboard = true;
     const insertResult = await userRepo.insertNew(newUser);
     expect(insertResult).toBeTruthy();

package/lib/tests/testsUtil.d.ts

@@ -1,6 +1,15 @@
 import { BaseDocument } from '@aneuhold/core-ts-db-lib';
 import BaseRepository from '../repositories/BaseRepository';
+/**
+ * A random series of characters for tests to help identify test users.
+ */
+export declare const TEST_USER_NAME_PREFIX = "lkahwsetpiohweat";
 export declare function expectToThrow(func: () => Promise<void>): Promise<void>;
+/**
+ * Gets a test user name with a standardized prefix so that they can all be
+ * identified and deleted if anything goes wrong in the tests.
+ */
+export declare function getTestUserName(username?: string): string;
 /**
  * Removes the provided doc from the DB
  */

package/lib/tests/testsUtil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testsUtil.d.ts","sourceRoot":"","sources":["../../src/tests/testsUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,cAAc,MAAM,gCAAgC,CAAC;AAE5D,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,iBAQ5D;AAED;;GAEG;AACH,wBAAsB,UAAU,CAAC,QAAQ,SAAS,YAAY,EAC5D,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC9B,GAAG,EAAE,QAAQ,iBAMd;AAED,wBAAsB,WAAW,CAAC,QAAQ,SAAS,YAAY,EAC7D,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC9B,IAAI,EAAE,QAAQ,EAAE,iBAOjB"}
+{"version":3,"file":"testsUtil.d.ts","sourceRoot":"","sources":["../../src/tests/testsUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,OAAO,cAAc,MAAM,gCAAgC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AAExD,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,iBAQ5D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,UAGhD;AAED;;GAEG;AACH,wBAAsB,UAAU,CAAC,QAAQ,SAAS,YAAY,EAC5D,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC9B,GAAG,EAAE,QAAQ,iBAMd;AAED,wBAAsB,WAAW,CAAC,QAAQ,SAAS,YAAY,EAC7D,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC9B,IAAI,EAAE,QAAQ,EAAE,iBAOjB"}

package/lib/tests/testsUtil.js

@@ -1,6 +1,14 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanupDocs = exports.cleanupDoc = exports.expectToThrow = void 0;
+exports.cleanupDocs = exports.cleanupDoc = exports.getTestUserName = exports.expectToThrow = exports.TEST_USER_NAME_PREFIX = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+/**
+ * A random series of characters for tests to help identify test users.
+ */
+exports.TEST_USER_NAME_PREFIX = 'lkahwsetpiohweat';
 async function expectToThrow(func) {
     let threwError = false;
     try {
@@ -12,6 +20,16 @@ async function expectToThrow(func) {
     expect(threwError).toBeTruthy();
 }
 exports.expectToThrow = expectToThrow;
+/**
+ * Gets a test user name with a standardized prefix so that they can all be
+ * identified and deleted if anything goes wrong in the tests.
+ */
+function getTestUserName(username) {
+    if (!username)
+        return `${exports.TEST_USER_NAME_PREFIX}-${crypto_1.default.randomUUID()}`;
+    return `${exports.TEST_USER_NAME_PREFIX}-${username}`;
+}
+exports.getTestUserName = getTestUserName;
 /**
  * Removes the provided doc from the DB
  */

package/lib/util/DbSchemaUpdater.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A class that can be used to validate and update the DB and all repositories.
+ */
+export default class DbSchemaUpdater {
+    static updateSchemaForAllRepos(dryRun?: boolean): Promise<void>;
+}
+//# sourceMappingURL=DbSchemaUpdater.d.ts.map

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

@@ -0,0 +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"}

package/lib/util/DbSchemaUpdater.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ApiKeyValidator_1 = __importDefault(require("../validators/common/ApiKeyValidator"));
+const UserValidator_1 = __importDefault(require("../validators/common/UserValidator"));
+const UserConfigValidator_1 = __importDefault(require("../validators/dashboard/UserConfigValidator"));
+/**
+ * A class that can be used to validate and update the DB and all repositories.
+ */
+class DbSchemaUpdater {
+    static async updateSchemaForAllRepos(dryRun = false) {
+        await new UserValidator_1.default().validateRepositoryInDb(dryRun);
+        await new ApiKeyValidator_1.default().validateRepositoryInDb(dryRun);
+        await new UserConfigValidator_1.default().validateRepositoryInDb(dryRun);
+    }
+}
+exports.default = DbSchemaUpdater;

package/lib/util/DocumentCleaner.d.ts

@@ -1,11 +1,11 @@
-import { BaseDocument, BaseDocumentWithType, BaseDocumentWithUserId } from '@aneuhold/core-ts-db-lib';
+import { BaseDocument, BaseDocumentWithType, RequiredUserId } from '@aneuhold/core-ts-db-lib';
 /**
  * A class which contains some standard methods for cleaning update documents
  * before they are sent to the database.
  */
 export default class CleanDocument {
     static id<TDocType extends BaseDocument>(updateDoc: Partial<TDocType>): Partial<TDocType>;
-    static userId<TDocType extends BaseDocumentWithUserId>(updateDoc: Partial<TDocType>): Partial<TDocType>;
+    static userId<TDocType extends RequiredUserId>(updateDoc: Partial<TDocType>): Partial<TDocType>;
     static docType<TDocType extends BaseDocumentWithType>(updateDoc: Partial<TDocType>): Partial<TDocType>;
 }
 //# sourceMappingURL=DocumentCleaner.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DocumentCleaner.d.ts","sourceRoot":"","sources":["../../src/util/DocumentCleaner.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,MAAM,CAAC,EAAE,CAAC,QAAQ,SAAS,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC;IAMrE,MAAM,CAAC,MAAM,CAAC,QAAQ,SAAS,sBAAsB,EACnD,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC;IAO9B,MAAM,CAAC,OAAO,CAAC,QAAQ,SAAS,oBAAoB,EAClD,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC;CAM/B"}
+{"version":3,"file":"DocumentCleaner.d.ts","sourceRoot":"","sources":["../../src/util/DocumentCleaner.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACf,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,MAAM,CAAC,EAAE,CAAC,QAAQ,SAAS,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC;IAMrE,MAAM,CAAC,MAAM,CAAC,QAAQ,SAAS,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC;IAM3E,MAAM,CAAC,OAAO,CAAC,QAAQ,SAAS,oBAAoB,EAClD,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC;CAM/B"}

package/lib/validators/BaseValidator.d.ts

@@ -1,4 +1,10 @@
-import { BaseDocument } from '@aneuhold/core-ts-db-lib';
+import { BaseDocument, DocumentValidator } from '@aneuhold/core-ts-db-lib';
+import { ObjectId } from 'bson';
+export declare enum ObjectSchemaState {
+    Valid = 0,
+    InvalidAndCorrectable = 1,
+    InvalidAndUncorrectable = 2
+}
 export default abstract class IValidator<TBaseType extends BaseDocument> {
     /**
      * Validates that an object that is supposed to be inserted in to the database
@@ -11,6 +17,35 @@ export default abstract class IValidator<TBaseType extends BaseDocument> {
      * 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 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.
+     */
+    protected 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>;
+    }): Promise<void>;
     /**
      * Checks that all elements that exist in array1, exist in array2.
      */

package/lib/validators/BaseValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseValidator.d.ts","sourceRoot":"","sources":["../../src/validators/BaseValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,UAAU,CAAC,SAAS,SAAS,YAAY;IACrE;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5D;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,0BAA0B,CAClC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC;CAIzB"}
+{"version":3,"file":"BaseValidator.d.ts","sourceRoot":"","sources":["../../src/validators/BaseValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,qBAAqB,IAAA;IACrB,uBAAuB,IAAA;CACxB;AAED,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,UAAU,CAAC,SAAS,SAAS,YAAY;IACrE;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5D;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;;;;;OAMG;cACa,kCAAkC,CAAC,KAAK,EAAE;QACxD,MAAM,EAAE,OAAO,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1B,YAAY,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,OAAO,CAAC;QAC1C,iBAAiB,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAChD,gBAAgB,EAAE,CAAC,cAAc,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,cAAc,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KAC9D;IAwED;;OAEG;IACH,SAAS,CAAC,0BAA0B,CAClC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC;CAIzB"}

package/lib/validators/BaseValidator.js

@@ -1,6 +1,80 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectSchemaState = void 0;
+const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+var ObjectSchemaState;
+(function (ObjectSchemaState) {
+    ObjectSchemaState[ObjectSchemaState["Valid"] = 0] = "Valid";
+    ObjectSchemaState[ObjectSchemaState["InvalidAndCorrectable"] = 1] = "InvalidAndCorrectable";
+    ObjectSchemaState[ObjectSchemaState["InvalidAndUncorrectable"] = 2] = "InvalidAndUncorrectable";
+})(ObjectSchemaState || (exports.ObjectSchemaState = ObjectSchemaState = {}));
 class IValidator {
+    /**
+     * Runs the standard validation for a repository.
+     *
+     * @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.
+     */
+    async runStandardValidationForRepository(input) {
+        const { dryRun, docName, allDocs, shouldDelete, documentValidator, deletionFunction, updateFunction } = input;
+        const docIdsToDelete = [];
+        const docsToValidate = [];
+        const docsToUpdate = [];
+        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) {
+                core_ts_lib_1.Logger.error(`${docName} with ID: ${doc._id} is invalid. Errors:`);
+                numInvalidDocs += 1;
+                errors.forEach((error) => {
+                    core_ts_lib_1.Logger.error(error);
+                });
+                docsToUpdate.push(updatedDoc);
+            }
+        });
+        if (dryRun) {
+            if (numInvalidDocs === 0) {
+                core_ts_lib_1.Logger.success(`No invalid ${docName}s found.`);
+            }
+            else {
+                core_ts_lib_1.Logger.info(`Would update ${numInvalidDocs} ${docName}s in the database.`);
+            }
+            if (docIdsToDelete.length === 0) {
+                core_ts_lib_1.Logger.success(`No ${docName}s to delete found.`);
+            }
+            else {
+                core_ts_lib_1.Logger.info(`Would delete ${docIdsToDelete.length} ${docName}s in the database.`);
+            }
+            return;
+        }
+        // Delete all invalid
+        if (docIdsToDelete.length !== 0) {
+            core_ts_lib_1.Logger.info(`Deleting ${docIdsToDelete.length} ${docName}s from the database.`);
+            await deletionFunction(docIdsToDelete);
+        }
+        else {
+            core_ts_lib_1.Logger.success(`No ${docName}s to delete found.`);
+        }
+        // Update all that need to be updated
+        if (docsToUpdate.length !== 0) {
+            core_ts_lib_1.Logger.info(`Updating ${docsToUpdate.length} ${docName}s in the database.`);
+            await updateFunction(docsToUpdate);
+        }
+        else {
+            core_ts_lib_1.Logger.success(`No ${docName}s to update found.`);
+        }
+    }
     /**
      * Checks that all elements that exist in array1, exist in array2.
      */

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

@@ -3,5 +3,6 @@ import IValidator from '../BaseValidator';
 export default class ApiKeyValidator extends IValidator<ApiKey> {
     validateNewObject(newApiKey: ApiKey): Promise<void>;
     validateUpdateObject(updatedApiKey: Partial<ApiKey>): Promise<void>;
+    validateRepositoryInDb(dryRun: boolean): Promise<void>;
 }
 //# sourceMappingURL=ApiKeyValidator.d.ts.map

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;AAGlD,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;IAsBnD,oBAAoB,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}
+{"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;IAsBnD,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

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (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"));
@@ -27,5 +28,29 @@ class ApiKeyValidator extends BaseValidator_1.default {
         // 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);
     }
+    async validateRepositoryInDb(dryRun) {
+        const apiKeyRepo = ApiKeyRepository_1.default.getRepo();
+        const allApiKeys = await apiKeyRepo.getAll();
+        const allUserIds = await UserRepository_1.default.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} has no valid associated user.`);
+                    return true;
+                }
+                return false;
+            },
+            documentValidator: ApiKey_1.validateApiKey,
+            deletionFunction: async (docIdsToDelete) => {
+                await apiKeyRepo.deleteList(docIdsToDelete);
+            },
+            updateFunction: async (docsToUpdate) => {
+                await apiKeyRepo.updateMany(docsToUpdate);
+            }
+        });
+    }
 }
 exports.default = ApiKeyValidator;

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

@@ -3,6 +3,7 @@ import IValidator from '../BaseValidator';
 export default class UserValidator extends IValidator<User> {
     validateNewObject(newUser: User): Promise<void>;
     validateUpdateObject(userToUpdate: Partial<User>): Promise<void>;
+    validateRepositoryInDb(dryRun: boolean): Promise<void>;
     /**
      * Checks if the username exists already and throws an error if it does.
      */

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,EAAE,MAAM,0BAA0B,CAAC;AAEhD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAG1C,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;IA2BtE;;OAEG;YACW,qBAAqB;CAWpC"}
+{"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;IA2BhE,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B5D;;OAEG;YACW,qBAAqB;CAWpC"}

package/lib/validators/common/UserValidator.js

@@ -7,6 +7,7 @@ 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 {
     async validateNewObject(newUser) {
         // Check if the username already exists
@@ -31,6 +32,29 @@ class UserValidator extends BaseValidator_1.default {
             await this.checkIfUserNameExists(userRepo, userToUpdate.userName);
         }
     }
+    async validateRepositoryInDb(dryRun) {
+        const userRepo = UserRepository_1.default.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} is a test user and should be deleted`);
+                    return true;
+                }
+                return false;
+            },
+            documentValidator: core_ts_db_lib_1.validateUser,
+            deletionFunction: async (docIdsToDelete) => {
+                await userRepo.deleteList(docIdsToDelete);
+            },
+            updateFunction: async (docsToUpdate) => {
+                await userRepo.updateMany(docsToUpdate);
+            }
+        });
+    }
     /**
      * Checks if the username exists already and throws an error if it does.
      */

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

@@ -3,5 +3,6 @@ import IValidator from '../BaseValidator';
 export default class DashboardUserConfigValidator extends IValidator<DashboardUserConfig> {
     validateNewObject(newUserConfig: DashboardUserConfig): Promise<void>;
     validateUpdateObject(updatedUserConfig: Partial<DashboardUserConfig>): Promise<void>;
+    validateRepositoryInDb(dryRun: boolean): Promise<void>;
 }
 //# sourceMappingURL=UserConfigValidator.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"UserConfigValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/dashboard/UserConfigValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAI1C,MAAM,CAAC,OAAO,OAAO,4BAA6B,SAAQ,UAAU,CAAC,mBAAmB,CAAC;IACjF,iBAAiB,CAAC,aAAa,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpE,oBAAoB,CACxB,iBAAiB,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;CASjB"}
+{"version":3,"file":"UserConfigValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/dashboard/UserConfigValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAEpB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAI1C,MAAM,CAAC,OAAO,OAAO,4BAA6B,SAAQ,UAAU,CAAC,mBAAmB,CAAC;IACjF,iBAAiB,CAAC,aAAa,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpE,oBAAoB,CACxB,iBAAiB,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;IAUV,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA2B7D"}