@aneuhold/be-ts-db-lib 1.0.2 → 1.0.4

package/README.md

@@ -1,5 +1,7 @@
 # Personal Backend Database Library
 
+![npm](https://img.shields.io/npm/v/%40aneuhold%2Fbe-ts-db-lib)
+
 This is used to actually interact with databases in personal projects.
 
 ## Dependencies

package/lib/index.d.ts

@@ -1,3 +1,6 @@
-export {};
+import ApiKeyRepository from './repositories/common/ApiKeyRepository';
+import UserRepository from './repositories/common/UserRepository';
+import DocumentDb from './util/DocumentDb';
+export { UserRepository, ApiKeyRepository, DocumentDb };
 export type {};
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC;AAGV,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,wCAAwC,CAAC;AACtE,OAAO,cAAc,MAAM,sCAAsC,CAAC;AAClE,OAAO,UAAU,MAAM,mBAAmB,CAAC;AAG3C,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAC;AAGxD,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -1,2 +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.DocumentDb = exports.ApiKeyRepository = exports.UserRepository = void 0;
+const ApiKeyRepository_1 = __importDefault(require("./repositories/common/ApiKeyRepository"));
+exports.ApiKeyRepository = ApiKeyRepository_1.default;
+const UserRepository_1 = __importDefault(require("./repositories/common/UserRepository"));
+exports.UserRepository = UserRepository_1.default;
+const DocumentDb_1 = __importDefault(require("./util/DocumentDb"));
+exports.DocumentDb = DocumentDb_1.default;

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

@@ -0,0 +1,19 @@
+import { ApiKey } from '@aneuhold/core-ts-db-lib';
+import { DeleteResult } from 'mongodb';
+import { ObjectId } from 'bson';
+import BaseRepository from '../BaseRepository';
+/**
+ * The repository that contains {@link User} documents.
+ */
+export default class ApiKeyRepository extends BaseRepository<ApiKey> {
+    private static COLLECTION_NAME;
+    private static singletonInstance;
+    private constructor();
+    /**
+     * Gets the singleton instance of the {@link ApiKeyRepository}.
+     */
+    static getRepo(): ApiKeyRepository;
+    deleteByUserId(userId: ObjectId): Promise<DeleteResult>;
+    deleteByUserIds(userIds: ObjectId[]): Promise<DeleteResult>;
+}
+//# sourceMappingURL=ApiKeyRepository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKeyRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/ApiKeyRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAG/C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,cAAc,CAAC,MAAM,CAAC;IAClE,OAAO,CAAC,MAAM,CAAC,eAAe,CAAa;IAE3C,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmB;IAEnD,OAAO;IAIP;;OAEG;WACW,OAAO;IAOf,cAAc,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAKvD,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;CAIlE"}

package/lib/repositories/common/ApiKeyRepository.js

@@ -0,0 +1,35 @@
+"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 ApiKeyValidator_1 = __importDefault(require("../../validators/common/ApiKeyValidator"));
+/**
+ * The repository that contains {@link User} documents.
+ */
+class ApiKeyRepository extends BaseRepository_1.default {
+    static COLLECTION_NAME = 'apiKeys';
+    static singletonInstance;
+    constructor() {
+        super(ApiKeyRepository.COLLECTION_NAME, new ApiKeyValidator_1.default());
+    }
+    /**
+     * Gets the singleton instance of the {@link ApiKeyRepository}.
+     */
+    static getRepo() {
+        if (!ApiKeyRepository.singletonInstance) {
+            ApiKeyRepository.singletonInstance = new ApiKeyRepository();
+        }
+        return ApiKeyRepository.singletonInstance;
+    }
+    async deleteByUserId(userId) {
+        const collection = await this.getCollection();
+        return collection.deleteOne({ userId });
+    }
+    async deleteByUserIds(userIds) {
+        const collection = await this.getCollection();
+        return collection.deleteMany({ userId: { $in: userIds } });
+    }
+}
+exports.default = ApiKeyRepository;

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

@@ -1,4 +1,6 @@
 import { User } from '@aneuhold/core-ts-db-lib';
+import { DeleteResult } from 'mongodb';
+import { ObjectId } from 'bson';
 import BaseRepository from '../BaseRepository';
 /**
  * The repository that contains {@link User} documents.
@@ -14,14 +16,32 @@ export default class UserRepository extends BaseRepository<User> {
     /**
      * 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.
+     * This will create a new API key for the user as well.
      *
      * @override
-     *
-     * @returns The user with the additional team, or null if the insert failed.
      */
     insertNew(newUser: User): Promise<User | null>;
+    /**
+     * Deletes a user.
+     *
+     * This will delete the API key for the user as well if there is one.
+     *
+     * @override
+     */
+    delete(userId: ObjectId): Promise<DeleteResult>;
+    /**
+     * Deletes a list of users.
+     *
+     * This will delete the API keys for the users as well if there are any.
+     *
+     * @override
+     */
+    deleteList(userIds: ObjectId[]): Promise<DeleteResult>;
+    /**
+     * This should not be used except for testing purposes
+     *
+     * @override
+     */
+    deleteAll(): Promise<DeleteResult>;
 }
 //# sourceMappingURL=UserRepository.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"UserRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/UserRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,cAAc,MAAM,mBAAmB,CAAC;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"}
+{"version":3,"file":"UserRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/UserRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAI/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;;;;;;OAMG;IACG,SAAS,CAAC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAUpD;;;;;;OAMG;IACG,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAQrD;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAQ5D;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC;CAOzC"}

package/lib/repositories/common/UserRepository.js

@@ -3,8 +3,10 @@ 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 BaseRepository_1 = __importDefault(require("../BaseRepository"));
 const UserValidator_1 = __importDefault(require("../../validators/common/UserValidator"));
+const ApiKeyRepository_1 = __importDefault(require("./ApiKeyRepository"));
 /**
  * The repository that contains {@link User} documents.
  */
@@ -26,21 +28,58 @@ class UserRepository extends BaseRepository_1.default {
     /**
      * 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.
+     * This will create a new API key for the user as well.
      *
      * @override
-     *
-     * @returns The user with the additional team, or null if the insert failed.
      */
     async insertNew(newUser) {
-        // Insert the new user first
+        // Insert the new user then the new API Key
         const insertResult = await super.insertNew(newUser);
         if (!insertResult) {
             return null;
         }
+        await ApiKeyRepository_1.default.getRepo().insertNew(new core_ts_db_lib_1.ApiKey(newUser._id));
         return newUser;
     }
+    /**
+     * Deletes a user.
+     *
+     * This will delete the API key for the user as well if there is one.
+     *
+     * @override
+     */
+    async delete(userId) {
+        const [deleteResult] = await Promise.all([
+            super.delete(userId),
+            ApiKeyRepository_1.default.getRepo().deleteByUserId(userId)
+        ]);
+        return deleteResult;
+    }
+    /**
+     * Deletes a list of users.
+     *
+     * This will delete the API keys for the users as well if there are any.
+     *
+     * @override
+     */
+    async deleteList(userIds) {
+        const [deleteResult] = await Promise.all([
+            super.deleteList(userIds),
+            ApiKeyRepository_1.default.getRepo().deleteByUserIds(userIds)
+        ]);
+        return deleteResult;
+    }
+    /**
+     * This should not be used except for testing purposes
+     *
+     * @override
+     */
+    async deleteAll() {
+        const [deleteResult] = await Promise.all([
+            super.deleteAll(),
+            ApiKeyRepository_1.default.getRepo().deleteAll()
+        ]);
+        return deleteResult;
+    }
 }
 exports.default = UserRepository;

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

@@ -15,6 +15,14 @@ it('can create a new document and delete it', async () => {
     expect(createResult).toBeTruthy();
     await (0, testsUtil_1.cleanupDoc)(userRepository, newUser);
 });
+// -- Manual Database Operations Section -- //
+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();
+    const createResult = await userRepository.insertNew(newUser);
+    expect(createResult).toBeTruthy();
+});
 afterAll(async () => {
     return DocumentDb_1.default.closeDbConnection();
 });

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

@@ -8,8 +8,29 @@ 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 ApiKeyRepository_1 = __importDefault(require("../../repositories/common/ApiKeyRepository"));
 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 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 insertResult = await userRepo.insertNew(newUser);
+        expect(insertResult).toBeTruthy();
+        const apiKey = await ApiKeyRepository_1.default.getRepo().get({
+            userId: newUser._id
+        });
+        expect(apiKey).toBeTruthy();
+        await (0, testsUtil_1.cleanupDoc)(userRepo, newUser);
+        const apiKeyThatShouldNotExist = await ApiKeyRepository_1.default.getRepo().get({
+            userId: newUser._id
+        });
+        expect(apiKeyThatShouldNotExist).toBeFalsy();
+    });
     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);

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

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

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

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

package/lib/validators/common/ApiKeyValidator.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+const UserRepository_1 = __importDefault(require("../../repositories/common/UserRepository"));
+const BaseValidator_1 = __importDefault(require("../BaseValidator"));
+const ApiKeyRepository_1 = __importDefault(require("../../repositories/common/ApiKeyRepository"));
+class ApiKeyValidator extends BaseValidator_1.default {
+    async validateNewObject(newApiKey) {
+        // Check if the user exists
+        const userRepo = UserRepository_1.default.getRepo();
+        const userInDb = await userRepo.get({ _id: newApiKey.userId });
+        if (!userInDb) {
+            core_ts_lib_1.ErrorUtils.throwError(`User with ID: ${newApiKey.userId} does not exist in the database.`, newApiKey);
+            return;
+        }
+        // Check if the user already has an API key
+        const apiKeyRepo = ApiKeyRepository_1.default.getRepo();
+        const apiKeyInDb = await apiKeyRepo.get({ userId: newApiKey.userId });
+        if (apiKeyInDb) {
+            core_ts_lib_1.ErrorUtils.throwError(`User with ID: ${newApiKey.userId} already has an API key.`, newApiKey);
+        }
+    }
+    async validateUpdateObject(updatedApiKey) {
+        // Throw, because API keys should not be updated. Only created and deleted.
+        core_ts_lib_1.ErrorUtils.throwError(`API keys should not be updated at this time. Only created and deleted.`, updatedApiKey);
+    }
+}
+exports.default = ApiKeyValidator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/be-ts-db-lib",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "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",
@@ -32,12 +32,13 @@
     "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",
+    "upgrade:core": "yarn upgrade --latest --pattern @aneuhold",
     "test": "jest"
   },
   "dependencies": {
     "@aneuhold/be-ts-lib": "^1.0.3",
-    "@aneuhold/core-ts-db-lib": "^1.0.1",
-    "@aneuhold/core-ts-lib": "^1.1.6",
+    "@aneuhold/core-ts-db-lib": "^1.0.3",
+    "@aneuhold/core-ts-lib": "^1.1.7",
     "bson": "^6.2.0",
     "mongodb": "^6.3.0"
   },