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

package/lib/tests/testsUtil.js

@@ -1,19 +1,12 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_USER_NAME_PREFIX = void 0;
-exports.expectToThrow = expectToThrow;
-exports.getTestUserName = getTestUserName;
-exports.cleanupDoc = cleanupDoc;
-exports.cleanupDocs = cleanupDocs;
-const crypto_1 = __importDefault(require("crypto"));
+import crypto from 'crypto';
+import { expect } from 'vitest';
+import { TEST_USER_NAME_PREFIX } from './globalTestVariables.js';
 /**
- * A random series of characters for tests to help identify test users.
+ * Asserts that the provided asynchronous function throws an error.
+ *
+ * @param func - The asynchronous function expected to throw an error.
  */
-exports.TEST_USER_NAME_PREFIX = 'lkahwsetpiohweat';
-async function expectToThrow(func) {
+export async function expectToThrow(func) {
     let threwError = false;
     try {
         await func();
@@ -26,25 +19,41 @@ async function expectToThrow(func) {
 /**
  * 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.
+ *
+ * @param username - The username to use as a base for the test user name.
+ * @returns The test user name.
  */
-function getTestUserName(username) {
+export function getTestUserName(username) {
     if (!username)
-        return `${exports.TEST_USER_NAME_PREFIX}-${crypto_1.default.randomUUID()}`;
-    return `${exports.TEST_USER_NAME_PREFIX}-${username}`;
+        return `${TEST_USER_NAME_PREFIX}-${crypto.randomUUID()}`;
+    return `${TEST_USER_NAME_PREFIX}-${username}`;
 }
 /**
- * Removes the provided doc from the DB
+ * Cleans up a document by deleting it from the repository and verifying its deletion.
+ *
+ * @template TDocType - The type of the document extending {@link BaseDocument}.
+ * @param repo - The repository from which the document will be deleted.
+ * @param doc - The document to be deleted.
  */
-async function cleanupDoc(repo, doc) {
+export async function cleanupDoc(repo, doc) {
     const deleteResult = await repo.delete(doc._id);
     expect(deleteResult.acknowledged).toBeTruthy();
     const findResult = await repo.get({ _id: doc._id });
     expect(findResult).toBeNull();
 }
-async function cleanupDocs(repo, docs) {
+/**
+ * Cleans up the specified documents from the repository.
+ *
+ * @template TDocType - The type of the documents.
+ * @param repo - The repository from which to delete the documents.
+ * @param docs - The documents to be deleted.
+ * @returns A promise that resolves when the cleanup is complete.
+ */
+export async function cleanupDocs(repo, docs) {
     const idsToDelete = docs.map((doc) => doc._id);
     const deleteResult = await repo.deleteList(idsToDelete);
     expect(deleteResult.acknowledged).toBeTruthy();
     const findResult = await repo.getList(idsToDelete);
     expect(findResult.length).toBe(0);
 }
+//# sourceMappingURL=testsUtil.js.map

package/lib/tests/testsUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testsUtil.js","sourceRoot":"./src/","sources":["tests/testsUtil.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAyB;IAC3D,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,CAAC;QACH,MAAM,IAAI,EAAE,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACP,UAAU,GAAG,IAAI,CAAC;IACpB,CAAC;IACD,MAAM,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;AAClC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,QAAiB;IAC/C,IAAI,CAAC,QAAQ;QAAE,OAAO,GAAG,qBAAqB,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;IACxE,OAAO,GAAG,qBAAqB,IAAI,QAAQ,EAAE,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,IAA8B,EAC9B,GAAa;IAEb,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAuB,CAAC,CAAC;IACzE,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAA8B,EAC9B,IAAgB;IAEhB,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACxD,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC"}

package/lib/tests/testsUtil.ts

@@ -0,0 +1,68 @@
+import { BaseDocument } from '@aneuhold/core-ts-db-lib';
+import crypto from 'crypto';
+import { expect } from 'vitest';
+import BaseRepository from '../repositories/BaseRepository.js';
+import { TEST_USER_NAME_PREFIX } from './globalTestVariables.js';
+
+/**
+ * Asserts that the provided asynchronous function throws an error.
+ *
+ * @param func - The asynchronous function expected to throw an error.
+ */
+export async function expectToThrow(func: () => Promise<void>) {
+  let threwError = false;
+  try {
+    await func();
+  } catch {
+    threwError = true;
+  }
+  expect(threwError).toBeTruthy();
+}
+
+/**
+ * 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.
+ *
+ * @param username - The username to use as a base for the test user name.
+ * @returns The test user name.
+ */
+export function getTestUserName(username?: string): string {
+  if (!username) return `${TEST_USER_NAME_PREFIX}-${crypto.randomUUID()}`;
+  return `${TEST_USER_NAME_PREFIX}-${username}`;
+}
+
+/**
+ * Cleans up a document by deleting it from the repository and verifying its deletion.
+ *
+ * @template TDocType - The type of the document extending {@link BaseDocument}.
+ * @param repo - The repository from which the document will be deleted.
+ * @param doc - The document to be deleted.
+ */
+export async function cleanupDoc<TDocType extends BaseDocument>(
+  repo: BaseRepository<TDocType>,
+  doc: TDocType
+) {
+  const deleteResult = await repo.delete(doc._id);
+  expect(deleteResult.acknowledged).toBeTruthy();
+  const findResult = await repo.get({ _id: doc._id } as Partial<TDocType>);
+  expect(findResult).toBeNull();
+}
+
+/**
+ * Cleans up the specified documents from the repository.
+ *
+ * @template TDocType - The type of the documents.
+ * @param repo - The repository from which to delete the documents.
+ * @param docs - The documents to be deleted.
+ * @returns A promise that resolves when the cleanup is complete.
+ */
+export async function cleanupDocs<TDocType extends BaseDocument>(
+  repo: BaseRepository<TDocType>,
+  docs: TDocType[]
+) {
+  const idsToDelete = docs.map((doc) => doc._id);
+  const deleteResult = await repo.deleteList(idsToDelete);
+  expect(deleteResult.acknowledged).toBeTruthy();
+  const findResult = await repo.getList(idsToDelete);
+  expect(findResult.length).toBe(0);
+}

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"DbSchemaUpdater.d.ts","sourceRoot":"./src/","sources":["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

@@ -1,21 +1,16 @@
-"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 TaskValidator_1 = __importDefault(require("../validators/dashboard/TaskValidator"));
-const UserConfigValidator_1 = __importDefault(require("../validators/dashboard/UserConfigValidator"));
+import ApiKeyValidator from '../validators/common/ApiKeyValidator.js';
+import UserValidator from '../validators/common/UserValidator.js';
+import DashboardTaskValidator from '../validators/dashboard/TaskValidator.js';
+import DashboardUserConfigValidator from '../validators/dashboard/UserConfigValidator.js';
 /**
  * A class that can be used to validate and update the DB and all repositories.
  */
-class DbSchemaUpdater {
+export default 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);
-        await new TaskValidator_1.default().validateRepositoryInDb(dryRun);
+        await new UserValidator().validateRepositoryInDb(dryRun);
+        await new ApiKeyValidator().validateRepositoryInDb(dryRun);
+        await new DashboardUserConfigValidator().validateRepositoryInDb(dryRun);
+        await new DashboardTaskValidator().validateRepositoryInDb(dryRun);
     }
 }
-exports.default = DbSchemaUpdater;
+//# sourceMappingURL=DbSchemaUpdater.js.map

package/lib/util/DbSchemaUpdater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbSchemaUpdater.js","sourceRoot":"./src/","sources":["util/DbSchemaUpdater.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,yCAAyC,CAAC;AACtE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,sBAAsB,MAAM,0CAA0C,CAAC;AAC9E,OAAO,4BAA4B,MAAM,gDAAgD,CAAC;AAE1F;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,MAAM,GAAG,KAAK;QACjD,MAAM,IAAI,aAAa,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,IAAI,eAAe,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,IAAI,4BAA4B,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACxE,MAAM,IAAI,sBAAsB,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;CACF"}

package/lib/util/DbSchemaUpdater.ts

@@ -0,0 +1,16 @@
+import ApiKeyValidator from '../validators/common/ApiKeyValidator.js';
+import UserValidator from '../validators/common/UserValidator.js';
+import DashboardTaskValidator from '../validators/dashboard/TaskValidator.js';
+import DashboardUserConfigValidator from '../validators/dashboard/UserConfigValidator.js';
+
+/**
+ * A class that can be used to validate and update the DB and all repositories.
+ */
+export default class DbSchemaUpdater {
+  static async updateSchemaForAllRepos(dryRun = false): Promise<void> {
+    await new UserValidator().validateRepositoryInDb(dryRun);
+    await new ApiKeyValidator().validateRepositoryInDb(dryRun);
+    await new DashboardUserConfigValidator().validateRepositoryInDb(dryRun);
+    await new DashboardTaskValidator().validateRepositoryInDb(dryRun);
+  }
+}

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,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"}
+{"version":3,"file":"DocumentCleaner.d.ts","sourceRoot":"./src/","sources":["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/util/DocumentCleaner.js

@@ -1,10 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * A class which contains some standard methods for cleaning update documents
  * before they are sent to the database.
  */
-class CleanDocument {
+export default class CleanDocument {
     static id(updateDoc) {
         const docCopy = { ...updateDoc };
         delete docCopy._id;
@@ -21,4 +19,4 @@ class CleanDocument {
         return docCopy;
     }
 }
-exports.default = CleanDocument;
+//# sourceMappingURL=DocumentCleaner.js.map

package/lib/util/DocumentCleaner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentCleaner.js","sourceRoot":"./src/","sources":["util/DocumentCleaner.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,MAAM,CAAC,EAAE,CAAgC,SAA4B;QACnE,MAAM,OAAO,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC,GAAG,CAAC;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,MAAM,CAAkC,SAA4B;QACzE,MAAM,OAAO,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC,MAAM,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,OAAO,CACZ,SAA4B;QAE5B,MAAM,OAAO,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC,OAAO,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/lib/util/DocumentCleaner.ts

@@ -0,0 +1,31 @@
+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>) {
+    const docCopy = { ...updateDoc };
+    delete docCopy._id;
+    return docCopy;
+  }
+
+  static userId<TDocType extends RequiredUserId>(updateDoc: Partial<TDocType>) {
+    const docCopy = { ...updateDoc };
+    delete docCopy.userId;
+    return docCopy;
+  }
+
+  static docType<TDocType extends BaseDocumentWithType>(
+    updateDoc: Partial<TDocType>
+  ) {
+    const docCopy = { ...updateDoc };
+    delete docCopy.docType;
+    return docCopy;
+  }
+}

package/lib/util/DocumentDb.d.ts

@@ -1,5 +1,8 @@
-import { Collection } from 'mongodb';
 import { Document } from 'bson';
+import { Collection } from 'mongodb';
+/**
+ * A utility class for interacting with a MongoDB database.
+ */
 export default class DocumentDb {
     private static DB_NAME;
     private static mongoClient;

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

@@ -1 +1 @@
-{"version":3,"file":"DocumentDb.d.ts","sourceRoot":"","sources":["../../src/util/DocumentDb.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAmB,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,MAAM,CAAC,OAAO,CAAa;IAEnC,OAAO,CAAC,MAAM,CAAC,WAAW,CAA0B;IAEpD,OAAO,CAAC,MAAM,CAAC,EAAE,CAAiB;mBAEb,SAAS;WAiBjB,aAAa,CAAC,QAAQ,SAAS,QAAQ,EAClD,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;WAQnB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAKhD"}
+{"version":3,"file":"DocumentDb.d.ts","sourceRoot":"./src/","sources":["util/DocumentDb.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,UAAU,EAAmB,MAAM,SAAS,CAAC;AAEtD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,MAAM,CAAC,OAAO,CAAa;IAEnC,OAAO,CAAC,MAAM,CAAC,WAAW,CAA0B;IAEpD,OAAO,CAAC,MAAM,CAAC,EAAE,CAAiB;mBAEb,SAAS;WAiBjB,aAAa,CAAC,QAAQ,SAAS,QAAQ,EAClD,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;WAQnB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAKhD"}

package/lib/util/DocumentDb.js

@@ -1,20 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const be_ts_lib_1 = require("@aneuhold/be-ts-lib");
-const mongodb_1 = require("mongodb");
-class DocumentDb {
+import { ConfigService } from '@aneuhold/be-ts-lib';
+import { MongoClient } from 'mongodb';
+/**
+ * A utility class for interacting with a MongoDB database.
+ */
+export default class DocumentDb {
     static DB_NAME = 'default';
     static mongoClient;
     static db;
     static async getClient() {
-        if (!be_ts_lib_1.ConfigService.isInitialized) {
+        if (!ConfigService.isInitialized) {
             // Hard-coded local for now until there are move envs.
-            await be_ts_lib_1.ConfigService.useConfig('local');
+            await ConfigService.useConfig('local');
         }
-        const { config } = be_ts_lib_1.ConfigService;
+        const { config } = ConfigService;
         if (!this.mongoClient) {
             const mongoDbConnectionString = `mongodb+srv://${config.mongoRootUsername}:${config.mongoRootPassword}@${config.mongoUrl}/?retryWrites=true&w=majority`;
-            this.mongoClient = new mongodb_1.MongoClient(mongoDbConnectionString);
+            this.mongoClient = new MongoClient(mongoDbConnectionString);
         }
         // Connecting every time is evidently the correct way to do it. This is
         // because it will not do anything and just return if it is already
@@ -35,4 +36,4 @@ class DocumentDb {
         }
     }
 }
-exports.default = DocumentDb;
+//# sourceMappingURL=DocumentDb.js.map

package/lib/util/DocumentDb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentDb.js","sourceRoot":"./src/","sources":["util/DocumentDb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAkB,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IACrB,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAE3B,MAAM,CAAC,WAAW,CAA0B;IAE5C,MAAM,CAAC,EAAE,CAAiB;IAE1B,MAAM,CAAC,KAAK,CAAC,SAAS;QAC5B,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;YACjC,sDAAsD;YACtD,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,uBAAuB,GAAG,iBAAiB,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,QAAQ,+BAA+B,CAAC;YACxJ,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,uBAAuB,CAAC,CAAC;QAC9D,CAAC;QACD,uEAAuE;QACvE,mEAAmE;QACnE,aAAa;QACb,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CACxB,cAAsB;QAEtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;YACnB,UAAU,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,UAAU,CAAC,EAAE,CAAC,UAAU,CAAW,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,iBAAiB;QAC5B,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;YAC3B,MAAM,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACvC,CAAC;IACH,CAAC"}

package/lib/util/DocumentDb.ts

@@ -0,0 +1,47 @@
+import { ConfigService } from '@aneuhold/be-ts-lib';
+import { Document } from 'bson';
+import { Collection, Db, MongoClient } from 'mongodb';
+
+/**
+ * A utility class for interacting with a MongoDB database.
+ */
+export default class DocumentDb {
+  private static DB_NAME = 'default';
+
+  private static mongoClient: MongoClient | undefined;
+
+  private static db: Db | undefined;
+
+  private static async getClient(): Promise<MongoClient> {
+    if (!ConfigService.isInitialized) {
+      // Hard-coded local for now until there are move envs.
+      await ConfigService.useConfig('local');
+    }
+    const { config } = ConfigService;
+    if (!this.mongoClient) {
+      const mongoDbConnectionString = `mongodb+srv://${config.mongoRootUsername}:${config.mongoRootPassword}@${config.mongoUrl}/?retryWrites=true&w=majority`;
+      this.mongoClient = new MongoClient(mongoDbConnectionString);
+    }
+    // Connecting every time is evidently the correct way to do it. This is
+    // because it will not do anything and just return if it is already
+    // connected.
+    await this.mongoClient.connect();
+    return this.mongoClient;
+  }
+
+  static async getCollection<TDocType extends Document>(
+    collectionName: string
+  ): Promise<Collection<TDocType>> {
+    const client = await this.getClient();
+    if (!DocumentDb.db) {
+      DocumentDb.db = client.db(DocumentDb.DB_NAME);
+    }
+    return DocumentDb.db.collection<TDocType>(collectionName);
+  }
+
+  static async closeDbConnection(): Promise<void> {
+    if (DocumentDb.mongoClient) {
+      await DocumentDb.mongoClient.close();
+    }
+  }
+}

package/lib/validators/BaseValidator.d.ts

@@ -33,9 +33,17 @@ export default abstract class IValidator<TBaseType extends BaseDocument> {
     /**
      * 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 runStandardValidationForRepository(input: {
         dryRun: boolean;
@@ -48,6 +56,9 @@ export default abstract class IValidator<TBaseType extends BaseDocument> {
     }): Promise<void>;
     /**
      * Checks that all elements that exist in array1, exist in array2.
+     *
+     * @param array1
+     * @param array2
      */
     protected checkAllElementsExistInArr(array1: Array<unknown>, array2: Array<unknown>): boolean;
 }

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,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;IA0ED;;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":"./src/","sources":["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;;;;;;;;;;;;;;OAcG;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;IA0ED;;;;;OAKG;IACH,SAAS,CAAC,0BAA0B,CAClC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GACrB,OAAO;CAGX"}

package/lib/validators/BaseValidator.js

@@ -1,20 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectSchemaState = void 0;
-const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
-var ObjectSchemaState;
+import { Logger } from '@aneuhold/core-ts-lib';
+export 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 {
+})(ObjectSchemaState || (ObjectSchemaState = {}));
+export default class IValidator {
     /**
      * 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
      */
     async runStandardValidationForRepository(input) {
         const { dryRun, docName, allDocs, shouldDelete, documentValidator, deletionFunction, updateFunction } = input;
@@ -35,51 +40,54 @@ class IValidator {
         docsToValidate.forEach((doc) => {
             const { updatedDoc, errors } = documentValidator(doc);
             if (errors.length !== 0) {
-                core_ts_lib_1.Logger.error(`${docName} with ID: ${doc._id.toString()} is invalid. Errors:`);
+                Logger.error(`${docName} with ID: ${doc._id.toString()} is invalid. Errors:`);
                 numInvalidDocs += 1;
                 errors.forEach((error) => {
-                    core_ts_lib_1.Logger.error(error);
+                    Logger.error(error);
                 });
                 docsToUpdate.push(updatedDoc);
             }
         });
         if (dryRun) {
             if (numInvalidDocs === 0) {
-                core_ts_lib_1.Logger.success(`No invalid ${docName}s found.`);
+                Logger.success(`No invalid ${docName}s found.`);
             }
             else {
-                core_ts_lib_1.Logger.info(`Would update ${numInvalidDocs} ${docName}s in the database.`);
+                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.`);
+                Logger.success(`No ${docName}s to delete found.`);
             }
             else {
-                core_ts_lib_1.Logger.info(`Would delete ${docIdsToDelete.length} ${docName}s in the database.`);
+                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.`);
+            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.`);
+            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.`);
+            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.`);
+            Logger.success(`No ${docName}s to update found.`);
         }
     }
     /**
      * Checks that all elements that exist in array1, exist in array2.
+     *
+     * @param array1
+     * @param array2
      */
     checkAllElementsExistInArr(array1, array2) {
         return array1.every((value) => array2.includes(value));
     }
 }
-exports.default = IValidator;
+//# sourceMappingURL=BaseValidator.js.map

package/lib/validators/BaseValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseValidator.js","sourceRoot":"./src/","sources":["validators/BaseValidator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAG/C,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,2FAAqB,CAAA;IACrB,+FAAuB,CAAA;AACzB,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAED,MAAM,CAAC,OAAO,OAAgB,UAAU;IA8BtC;;;;;;;;;;;;;;OAcG;IACO,KAAK,CAAC,kCAAkC,CAAC,KAQlD;QACC,MAAM,EACJ,MAAM,EACN,OAAO,EACP,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACf,GAAG,KAAK,CAAC;QACV,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAqB,EAAE,CAAC;QAC5C,MAAM,YAAY,GAAqB,EAAE,CAAC;QAC1C,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,yCAAyC;QACzC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACtB,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,CAAC;QACH,oBAAoB;QACpB,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC7B,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM,CAAC,KAAK,CACV,GAAG,OAAO,aAAa,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,sBAAsB,CAChE,CAAC;gBACF,cAAc,IAAI,CAAC,CAAC;gBACpB,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACvB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC,CAAC,CAAC;gBACH,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,OAAO,CAAC,cAAc,OAAO,UAAU,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CACT,gBAAgB,cAAc,IAAI,OAAO,oBAAoB,CAC9D,CAAC;YACJ,CAAC;YACD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,CAAC,OAAO,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CACT,gBAAgB,cAAc,CAAC,MAAM,IAAI,OAAO,oBAAoB,CACrE,CAAC;YACJ,CAAC;YACD,OAAO;QACT,CAAC;QACD,qBAAqB;QACrB,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CACT,YAAY,cAAc,CAAC,MAAM,IAAI,OAAO,sBAAsB,CACnE,CAAC;YACF,MAAM,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;QACpD,CAAC;QACD,qCAAqC;QACrC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CACT,YAAY,YAAY,CAAC,MAAM,IAAI,OAAO,oBAAoB,CAC/D,CAAC;YACF,MAAM,cAAc,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACO,0BAA0B,CAClC,MAAsB,EACtB,MAAsB;QAEtB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;CACF"}