@aneuhold/be-ts-db-lib 1.0.1

package/README.md

@@ -0,0 +1,7 @@
+# Personal Backend Database Library
+
+This is used to actually interact with databases in personal projects.
+
+## Dependencies
+
+- [`core-ts-db-lib`](https://github.com/aneuhold/core-ts-db-lib)

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export {};
+export type {};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC;AAGV,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/repositories/BaseRepository.d.ts

@@ -0,0 +1,31 @@
+import { BaseDocument } from '@aneuhold/core-ts-db-lib';
+import { Collection, DeleteResult, UpdateResult } from 'mongodb';
+import { ObjectId } from 'bson';
+import IValidator from '../validators/BaseValidator';
+/**
+ * A base repository that implements a lot of the normal CRUD operations.
+ */
+export default abstract class BaseRepository<TBasetype extends BaseDocument> {
+    private validator;
+    protected collectionName: string;
+    private collection?;
+    constructor(collectionName: string, validator: IValidator<TBasetype>);
+    protected getCollection(): Promise<Collection<import("bson").Document>>;
+    insertNew(newDoc: TBasetype): Promise<TBasetype | null>;
+    get(filter: Partial<TBasetype>): Promise<TBasetype | null>;
+    getAll(): Promise<TBasetype[]>;
+    getList(docIds: ObjectId[]): Promise<TBasetype[]>;
+    delete(docId: ObjectId): Promise<DeleteResult>;
+    deleteList(docIds: ObjectId[]): Promise<DeleteResult>;
+    /**
+     * This should not be used except for testing purposes
+     */
+    deleteAll(): Promise<DeleteResult>;
+    /**
+     * Updates the provided doc in the DB.
+     *
+     * This base method strips the `_id` before updating.
+     */
+    update(updatedDoc: Partial<TBasetype>): Promise<UpdateResult>;
+}
+//# sourceMappingURL=BaseRepository.d.ts.map

package/lib/repositories/BaseRepository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseRepository.d.ts","sourceRoot":"","sources":["../../src/repositories/BaseRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,UAAU,MAAM,6BAA6B,CAAC;AAErD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,cAAc,CAAC,SAAS,SAAS,YAAY;IAOvE,OAAO,CAAC,SAAS;IANnB,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IAEjC,OAAO,CAAC,UAAU,CAAC,CAAa;gBAG9B,cAAc,EAAE,MAAM,EACd,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC;cAK1B,aAAa;IAOvB,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAUvD,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAM1D,MAAM,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAO9B,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMjD,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAK9C,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAK3D;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC;IAKxC;;;;OAIG;IACG,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;CAYpE"}

package/lib/repositories/BaseRepository.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const DocumentDb_1 = __importDefault(require("../util/DocumentDb"));
+/**
+ * A base repository that implements a lot of the normal CRUD operations.
+ */
+class BaseRepository {
+    validator;
+    collectionName;
+    collection;
+    constructor(collectionName, validator) {
+        this.validator = validator;
+        this.collectionName = collectionName;
+    }
+    async getCollection() {
+        if (!this.collection) {
+            this.collection = await DocumentDb_1.default.getCollection(this.collectionName);
+        }
+        return this.collection;
+    }
+    async insertNew(newDoc) {
+        const collection = await this.getCollection();
+        await this.validator.validateNewObject(newDoc);
+        const insertResult = await collection.insertOne(newDoc);
+        if (!insertResult.acknowledged) {
+            return null;
+        }
+        return newDoc;
+    }
+    async get(filter) {
+        const collection = await this.getCollection();
+        const result = await collection.findOne(filter);
+        return result;
+    }
+    async getAll() {
+        const collection = await this.getCollection();
+        const result = await collection.find().toArray();
+        // Set to unknown first because of some weird type things.
+        return result;
+    }
+    async getList(docIds) {
+        const collection = await this.getCollection();
+        const result = await collection.find({ _id: { $in: docIds } }).toArray();
+        return result;
+    }
+    async delete(docId) {
+        const collection = await this.getCollection();
+        return collection.deleteOne({ _id: docId });
+    }
+    async deleteList(docIds) {
+        const collection = await this.getCollection();
+        return collection.deleteMany({ _id: { $in: docIds } });
+    }
+    /**
+     * This should not be used except for testing purposes
+     */
+    async deleteAll() {
+        const collection = await this.getCollection();
+        return collection.deleteMany({});
+    }
+    /**
+     * Updates the provided doc in the DB.
+     *
+     * This base method strips the `_id` before updating.
+     */
+    async update(updatedDoc) {
+        const collection = await this.getCollection();
+        await this.validator.validateUpdateObject(updatedDoc);
+        const docId = updatedDoc._id;
+        // Create a copy so that there aren't side-effects
+        const docCopy = { ...updatedDoc };
+        delete docCopy._id;
+        return collection.updateOne({ _id: docId }, { $set: docCopy });
+    }
+}
+exports.default = BaseRepository;

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

@@ -0,0 +1,27 @@
+import { User } from '@aneuhold/core-ts-db-lib';
+import BaseRepository from '../BaseRepository';
+/**
+ * The repository that contains {@link User} documents.
+ */
+export default class UserRepository extends BaseRepository<User> {
+    private static COLLECTION_NAME;
+    private static singletonInstance;
+    private constructor();
+    /**
+     * Gets the singleton instance of the {@link UserRepository}.
+     */
+    static getRepo(): UserRepository;
+    /**
+     * Inserts a new user.
+     *
+     * This will add the default team that consists of just the user if it
+     * doesn't already exist. If it does exist, it will add that team to the
+     * user's {@link User.currentTeamsIncludingUser} array.
+     *
+     * @override
+     *
+     * @returns The user with the additional team, or null if the insert failed.
+     */
+    insertNew(newUser: User): Promise<User | null>;
+}
+//# sourceMappingURL=UserRepository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/UserRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAG/C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc,CAAC,IAAI,CAAC;IAC9D,OAAO,CAAC,MAAM,CAAC,eAAe,CAAW;IAEzC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAiB;IAEjD,OAAO;IAIP;;OAEG;WACW,OAAO;IAOrB;;;;;;;;;;OAUG;IACG,SAAS,CAAC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;CAQrD"}

package/lib/repositories/common/UserRepository.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseRepository_1 = __importDefault(require("../BaseRepository"));
+const UserValidator_1 = __importDefault(require("../../validators/common/UserValidator"));
+/**
+ * The repository that contains {@link User} documents.
+ */
+class UserRepository extends BaseRepository_1.default {
+    static COLLECTION_NAME = 'users';
+    static singletonInstance;
+    constructor() {
+        super(UserRepository.COLLECTION_NAME, new UserValidator_1.default());
+    }
+    /**
+     * Gets the singleton instance of the {@link UserRepository}.
+     */
+    static getRepo() {
+        if (!UserRepository.singletonInstance) {
+            UserRepository.singletonInstance = new UserRepository();
+        }
+        return UserRepository.singletonInstance;
+    }
+    /**
+     * Inserts a new user.
+     *
+     * This will add the default team that consists of just the user if it
+     * doesn't already exist. If it does exist, it will add that team to the
+     * user's {@link User.currentTeamsIncludingUser} array.
+     *
+     * @override
+     *
+     * @returns The user with the additional team, or null if the insert failed.
+     */
+    async insertNew(newUser) {
+        // Insert the new user first
+        const insertResult = await super.insertNew(newUser);
+        if (!insertResult) {
+            return null;
+        }
+        return newUser;
+    }
+}
+exports.default = UserRepository;

package/lib/tests/repositories/BaseRepository.spec.d.ts

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

package/lib/tests/repositories/BaseRepository.spec.d.ts.map

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

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

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = __importDefault(require("crypto"));
+const core_ts_db_lib_1 = require("@aneuhold/core-ts-db-lib");
+const UserRepository_1 = __importDefault(require("../../repositories/common/UserRepository"));
+const testsUtil_1 = require("../testsUtil");
+const DocumentDb_1 = __importDefault(require("../../util/DocumentDb"));
+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 createResult = await userRepository.insertNew(newUser);
+    expect(createResult).toBeTruthy();
+    await (0, testsUtil_1.cleanupDoc)(userRepository, newUser);
+});
+afterAll(async () => {
+    return DocumentDb_1.default.closeDbConnection();
+});

package/lib/tests/repositories/UserRepository.spec.d.ts

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

package/lib/tests/repositories/UserRepository.spec.d.ts.map

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

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

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = __importDefault(require("crypto"));
+const core_ts_db_lib_1 = require("@aneuhold/core-ts-db-lib");
+const testsUtil_1 = require("../testsUtil");
+const UserRepository_1 = __importDefault(require("../../repositories/common/UserRepository"));
+const DocumentDb_1 = __importDefault(require("../../util/DocumentDb"));
+const userRepo = UserRepository_1.default.getRepo();
+describe('Create operations', () => {
+    it('throws if the username is a duplicate username', async () => {
+        const duplicateUserName = `${crypto_1.default.randomUUID()}`;
+        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);
+        expect(insertResult).toBeTruthy();
+        await (0, testsUtil_1.expectToThrow)(async () => {
+            await userRepo.insertNew(newUser2);
+        });
+        await (0, testsUtil_1.cleanupDoc)(userRepo, newUser1);
+    });
+});
+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 newUser = new core_ts_db_lib_1.User(userName1);
+        // Insert the user
+        const insertResult = await userRepo.insertNew(newUser);
+        expect(insertResult).toBeTruthy();
+        // Try to update the user
+        newUser.userName = userName2;
+        const updateResult = await userRepo.update(newUser);
+        expect(updateResult.acknowledged).toBeTruthy();
+        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());
+        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 newUser = new core_ts_db_lib_1.User(userName1);
+        const userWithOtherUserName = new core_ts_db_lib_1.User(userName2);
+        // Insert the users
+        const insertResult1 = await userRepo.insertNew(newUser);
+        expect(insertResult1).toBeTruthy();
+        const insertResult2 = await userRepo.insertNew(userWithOtherUserName);
+        expect(insertResult2).toBeTruthy();
+        // Try to update the first user
+        newUser.userName = userName2;
+        await (0, testsUtil_1.expectToThrow)(async () => {
+            await userRepo.update(newUser);
+        });
+        await Promise.all([
+            (0, testsUtil_1.cleanupDoc)(userRepo, newUser),
+            (0, testsUtil_1.cleanupDoc)(userRepo, userWithOtherUserName)
+        ]);
+    });
+    it('throws if the user doesnt exist', async () => {
+        const newUser = new core_ts_db_lib_1.User(crypto_1.default.randomUUID());
+        // Try to update the user
+        await (0, testsUtil_1.expectToThrow)(async () => {
+            await userRepo.update(newUser);
+        });
+    });
+});
+/**
+ * Deletes all users!
+ *
+ * Make sure that the local DB you are working on doesn't have important
+ * state before turning skip off on this one.
+ *
+ * To just do a cleanup, put `only` after `it`. So `it.only('can delete all users'`
+ */
+it.skip('can delete all users', async () => {
+    const result = await userRepo.deleteAll();
+    expect(result.acknowledged).toBeTruthy();
+});
+afterAll(async () => {
+    return DocumentDb_1.default.closeDbConnection();
+});

package/lib/tests/testsUtil.d.ts

@@ -0,0 +1,9 @@
+import { BaseDocument } from '@aneuhold/core-ts-db-lib';
+import BaseRepository from '../repositories/BaseRepository';
+export declare function expectToThrow(func: () => Promise<void>): Promise<void>;
+/**
+ * Removes the provided doc from the DB
+ */
+export declare function cleanupDoc<TDocType extends BaseDocument>(repo: BaseRepository<TDocType>, doc: TDocType): Promise<void>;
+export declare function cleanupDocs<TDocType extends BaseDocument>(repo: BaseRepository<TDocType>, docs: TDocType[]): Promise<void>;
+//# sourceMappingURL=testsUtil.d.ts.map

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

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

package/lib/tests/testsUtil.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanupDocs = exports.cleanupDoc = exports.expectToThrow = void 0;
+async function expectToThrow(func) {
+    let threwError = false;
+    try {
+        await func();
+    }
+    catch {
+        threwError = true;
+    }
+    expect(threwError).toBeTruthy();
+}
+exports.expectToThrow = expectToThrow;
+/**
+ * Removes the provided doc from the DB
+ */
+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();
+}
+exports.cleanupDoc = cleanupDoc;
+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);
+}
+exports.cleanupDocs = cleanupDocs;

package/lib/util/DocumentDb.d.ts

@@ -0,0 +1,11 @@
+import { Collection } from 'mongodb';
+import { Document } from 'bson';
+export default class DocumentDb {
+    private static DB_NAME;
+    private static mongoClient;
+    private static db;
+    private static getClient;
+    static getCollection<TDocType extends Document>(collectionName: string): Promise<Collection<TDocType>>;
+    static closeDbConnection(): Promise<void>;
+}
+//# sourceMappingURL=DocumentDb.d.ts.map

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

@@ -0,0 +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,CAAc;IAExC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAK;mBAED,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

@@ -0,0 +1,38 @@
+"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 {
+    static DB_NAME = 'default';
+    static mongoClient;
+    static db;
+    static async getClient() {
+        if (!be_ts_lib_1.ConfigService.isInitialized) {
+            // Hard-coded local for now until there are move envs.
+            await be_ts_lib_1.ConfigService.useConfig('local');
+        }
+        const { config } = be_ts_lib_1.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);
+        }
+        // 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(collectionName) {
+        const client = await this.getClient();
+        if (!this.db) {
+            DocumentDb.db = client.db(DocumentDb.DB_NAME);
+        }
+        return DocumentDb.db.collection(collectionName);
+    }
+    static async closeDbConnection() {
+        if (DocumentDb.mongoClient) {
+            await DocumentDb.mongoClient.close();
+        }
+    }
+}
+exports.default = DocumentDb;

package/lib/validators/BaseValidator.d.ts

@@ -0,0 +1,19 @@
+import { BaseDocument } from '@aneuhold/core-ts-db-lib';
+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>;
+    /**
+     * Checks that all elements that exist in array1, exist in array2.
+     */
+    protected checkAllElementsExistInArr(array1: Array<unknown>, array2: Array<unknown>): boolean;
+}
+//# sourceMappingURL=BaseValidator.d.ts.map

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

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

package/lib/validators/BaseValidator.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class IValidator {
+    /**
+     * Checks that all elements that exist in array1, exist in array2.
+     */
+    checkAllElementsExistInArr(array1, array2) {
+        return array1.every((value) => array2.includes(value));
+    }
+}
+exports.default = IValidator;

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

@@ -0,0 +1,11 @@
+import { User } from '@aneuhold/core-ts-db-lib';
+import IValidator from '../BaseValidator';
+export default class UserValidator extends IValidator<User> {
+    validateNewObject(newUser: User): Promise<void>;
+    validateUpdateObject(userToUpdate: Partial<User>): Promise<void>;
+    /**
+     * Checks if the username exists already and throws an error if it does.
+     */
+    private checkIfUserNameExists;
+}
+//# sourceMappingURL=UserValidator.d.ts.map

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

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

package/lib/validators/common/UserValidator.js

@@ -0,0 +1,46 @@
+"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"));
+class UserValidator extends BaseValidator_1.default {
+    async validateNewObject(newUser) {
+        // Check if the username already exists
+        const userRepo = UserRepository_1.default.getRepo();
+        await this.checkIfUserNameExists(userRepo, newUser.userName);
+    }
+    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);
+        }
+        // Check to see if the user exists
+        const userRepo = UserRepository_1.default.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} 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);
+        }
+    }
+    /**
+     * Checks if the username exists already and throws an error if it does.
+     */
+    async checkIfUserNameExists(userRepo, userName) {
+        const userNameSearchResult = await userRepo.get({
+            userName
+        });
+        if (userNameSearchResult) {
+            core_ts_lib_1.ErrorUtils.throwError('Username already exists', { userName });
+        }
+    }
+}
+exports.default = UserValidator;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@aneuhold/be-ts-db-lib",
+  "version": "1.0.1",
+  "description": "A backend database library meant to actually interact with various databases in personal projects",
+  "author": "Anton G Neuhold Jr <agneuhold@gmail.com>",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aneuhold/be-ts-db-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/aneuhold/be-ts-db-lib/issues"
+  },
+  "homepage": "https://github.com/aneuhold/be-ts-db-lib#readme",
+  "files": [
+    "lib/**/*"
+  ],
+  "keywords": [
+    "Scripting",
+    "Node.js"
+  ],
+  "scripts": {
+    "pushpub": "npm run build && npm version patch && git push && npm publish --access public",
+    "build": "tsc",
+    "watch": "tsc -w",
+    "link:local": "cd lib && yarn link",
+    "link:coredb": "yarn link @aneuhold/core-ts-db-lib",
+    "link:bets": "yarn link @aneuhold/be-ts-lib",
+    "unlink:local": "cd lib && yarn unlink",
+    "unlink:coredb": "yarn unlink @aneuhold/core-ts-db-lib && yarn install --force",
+    "unlink:bets": "yarn unlink @aneuhold/be-ts-lib && yarn install --force",
+    "upgrade:all": "yarn upgrade --latest",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@aneuhold/be-ts-lib": "^1.0.2",
+    "@aneuhold/core-ts-db-lib": "^1.0.1",
+    "@aneuhold/core-ts-lib": "^1.1.6",
+    "bson": "^6.2.0",
+    "mongodb": "^6.3.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.10.4",
+    "@types/node-fetch": "^2.6.9",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "eslint": "^8.35.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.1",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.2.1",
+    "typescript": "^5.3.3"
+  }
+}