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

package/README.md

@@ -4,6 +4,10 @@
 
 This is used to actually interact with databases in personal projects.
 
+## Manual Database Operations
+
+Go ahead and run these as code in a test in the BaseRepository.spec.ts file.
+
 ## Dependencies
 
 - [`core-ts-db-lib`](https://github.com/aneuhold/core-ts-db-lib)

package/lib/repositories/BaseRepository.d.ts

@@ -1,16 +1,26 @@
 import { BaseDocument } from '@aneuhold/core-ts-db-lib';
 import { Collection, DeleteResult, UpdateResult } from 'mongodb';
-import { ObjectId } from 'bson';
+import { Document, 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;
+    private defaultFilter?;
+    private defaultUpdateCleaner?;
     protected collectionName: string;
     private collection?;
-    constructor(collectionName: string, validator: IValidator<TBasetype>);
-    protected getCollection(): Promise<Collection<import("bson").Document>>;
+    /**
+     * Constructs a new base repository.
+     *
+     * @param defaultUpdateCleaner this is a function that will be run on the
+     * update object before it is sent to the DB. This is useful for removing
+     * fields that should not be updated. Only remove fields that are at the
+     * top-level of the object. _id is already removed.
+     */
+    constructor(collectionName: string, validator: IValidator<TBasetype>, defaultFilter?: Partial<TBasetype> | undefined, defaultUpdateCleaner?: ((doc: Partial<TBasetype>) => Partial<TBasetype>) | undefined);
+    protected getCollection(): Promise<Collection<Document>>;
     insertNew(newDoc: TBasetype): Promise<TBasetype | null>;
     get(filter: Partial<TBasetype>): Promise<TBasetype | null>;
     getAll(): Promise<TBasetype[]>;
@@ -27,5 +37,19 @@ export default abstract class BaseRepository<TBasetype extends BaseDocument> {
      * This base method strips the `_id` before updating.
      */
     update(updatedDoc: Partial<TBasetype>): Promise<UpdateResult>;
+    /**
+     * Gets the filter with the default filter applied if there is one.
+     *
+     * This is purposefully changing the type because of some weird restrictions
+     * with the `mongodb` package types.
+     */
+    private getFilterWithDefault;
+    /**
+     * Cleans the update object by removing the `_id` field and running the
+     * default update cleaner if there is one.
+     *
+     * Returns a shallow copy of the object.
+     */
+    private cleanUpdateObject;
 }
 //# sourceMappingURL=BaseRepository.d.ts.map

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

@@ -1 +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"}
+{"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,EAAU,YAAY,EAAE,MAAM,SAAS,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,UAAU,MAAM,6BAA6B,CAAC;AAGrD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,cAAc,CAAC,SAAS,SAAS,YAAY;IAevE,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,aAAa,CAAC;IACtB,OAAO,CAAC,oBAAoB,CAAC;IAhB/B,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IAEjC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;;;OAOG;gBAED,cAAc,EAAE,MAAM,EACd,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,EAChC,aAAa,CAAC,gCAAoB,EAClC,oBAAoB,CAAC,SACtB,QAAQ,SAAS,CAAC,KACpB,QAAQ,SAAS,CAAC,aAAA;cAKT,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;IAQjD,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;IAWnE;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAS5B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;CAO1B"}

package/lib/repositories/BaseRepository.js

@@ -4,15 +4,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const DocumentDb_1 = __importDefault(require("../util/DocumentDb"));
+const DocumentCleaner_1 = __importDefault(require("../util/DocumentCleaner"));
 /**
  * A base repository that implements a lot of the normal CRUD operations.
  */
 class BaseRepository {
     validator;
+    defaultFilter;
+    defaultUpdateCleaner;
     collectionName;
     collection;
-    constructor(collectionName, validator) {
+    /**
+     * Constructs a new base repository.
+     *
+     * @param defaultUpdateCleaner this is a function that will be run on the
+     * update object before it is sent to the DB. This is useful for removing
+     * fields that should not be updated. Only remove fields that are at the
+     * top-level of the object. _id is already removed.
+     */
+    constructor(collectionName, validator, defaultFilter, defaultUpdateCleaner) {
         this.validator = validator;
+        this.defaultFilter = defaultFilter;
+        this.defaultUpdateCleaner = defaultUpdateCleaner;
         this.collectionName = collectionName;
     }
     async getCollection() {
@@ -32,18 +45,20 @@ class BaseRepository {
     }
     async get(filter) {
         const collection = await this.getCollection();
-        const result = await collection.findOne(filter);
+        const result = await collection.findOne(this.getFilterWithDefault(filter));
         return result;
     }
     async getAll() {
         const collection = await this.getCollection();
-        const result = await collection.find().toArray();
+        const result = await collection.find(this.getFilterWithDefault()).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();
+        const result = await collection
+            .find(this.getFilterWithDefault({ _id: { $in: docIds } }))
+            .toArray();
         return result;
     }
     async delete(docId) {
@@ -59,7 +74,7 @@ class BaseRepository {
      */
     async deleteAll() {
         const collection = await this.getCollection();
-        return collection.deleteMany({});
+        return collection.deleteMany(this.getFilterWithDefault());
     }
     /**
      * Updates the provided doc in the DB.
@@ -70,10 +85,31 @@ class BaseRepository {
         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 });
+        const cleanedDoc = this.cleanUpdateObject(updatedDoc);
+        return collection.updateOne({ _id: docId }, { $set: cleanedDoc });
+    }
+    /**
+     * Gets the filter with the default filter applied if there is one.
+     *
+     * This is purposefully changing the type because of some weird restrictions
+     * with the `mongodb` package types.
+     */
+    getFilterWithDefault(filter = {}) {
+        if (!this.defaultFilter) {
+            return filter;
+        }
+        return { ...filter, ...this.defaultFilter };
+    }
+    /**
+     * Cleans the update object by removing the `_id` field and running the
+     * default update cleaner if there is one.
+     *
+     * Returns a shallow copy of the object.
+     */
+    cleanUpdateObject(updatedDoc) {
+        return this.defaultUpdateCleaner
+            ? this.defaultUpdateCleaner(DocumentCleaner_1.default.id(updatedDoc))
+            : DocumentCleaner_1.default.id(updatedDoc);
     }
 }
 exports.default = BaseRepository;

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,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"}
+{"version":3,"file":"UserRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/common/UserRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAK/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;IAcpD;;;;;;OAMG;IACG,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IASrD;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAS5D;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC;CAQzC"}

package/lib/repositories/common/UserRepository.js

@@ -7,6 +7,7 @@ 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"));
+const UserConfigRepository_1 = __importDefault(require("../dashboard/UserConfigRepository"));
 /**
  * The repository that contains {@link User} documents.
  */
@@ -33,12 +34,14 @@ class UserRepository extends BaseRepository_1.default {
      * @override
      */
     async insertNew(newUser) {
-        // 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));
+        if (insertResult.projectAccess.dashboard) {
+            await UserConfigRepository_1.default.getRepo().insertNew(new core_ts_db_lib_1.DashboardUserConfig(newUser._id));
+        }
         return newUser;
     }
     /**
@@ -51,7 +54,8 @@ class UserRepository extends BaseRepository_1.default {
     async delete(userId) {
         const [deleteResult] = await Promise.all([
             super.delete(userId),
-            ApiKeyRepository_1.default.getRepo().deleteByUserId(userId)
+            ApiKeyRepository_1.default.getRepo().deleteByUserId(userId),
+            UserConfigRepository_1.default.getRepo().deleteByUserId(userId)
         ]);
         return deleteResult;
     }
@@ -65,7 +69,8 @@ class UserRepository extends BaseRepository_1.default {
     async deleteList(userIds) {
         const [deleteResult] = await Promise.all([
             super.deleteList(userIds),
-            ApiKeyRepository_1.default.getRepo().deleteByUserIds(userIds)
+            ApiKeyRepository_1.default.getRepo().deleteByUserIds(userIds),
+            UserConfigRepository_1.default.getRepo().deleteByUserIds(userIds)
         ]);
         return deleteResult;
     }
@@ -77,7 +82,8 @@ class UserRepository extends BaseRepository_1.default {
     async deleteAll() {
         const [deleteResult] = await Promise.all([
             super.deleteAll(),
-            ApiKeyRepository_1.default.getRepo().deleteAll()
+            ApiKeyRepository_1.default.getRepo().deleteAll(),
+            UserConfigRepository_1.default.getRepo().deleteAll()
         ]);
         return deleteResult;
     }

package/lib/repositories/dashboard/DashboardBaseRepository.d.ts

@@ -0,0 +1,11 @@
+import { BaseDocumentWithType } from '@aneuhold/core-ts-db-lib';
+import BaseRepository from '../BaseRepository';
+import IValidator from '../../validators/BaseValidator';
+/**
+ * A base repository for the `dashboard` collection.
+ */
+export default abstract class DashboardBaseRepository<TBaseType extends BaseDocumentWithType> extends BaseRepository<TBaseType> {
+    private static COLLECTION_NAME;
+    constructor(docType: string, validator: IValidator<TBaseType>, updateCleaner?: (doc: Partial<TBaseType>) => Partial<TBaseType>);
+}
+//# sourceMappingURL=DashboardBaseRepository.d.ts.map

package/lib/repositories/dashboard/DashboardBaseRepository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DashboardBaseRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/dashboard/DashboardBaseRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAC/C,OAAO,UAAU,MAAM,gCAAgC,CAAC;AAGxD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,uBAAuB,CACnD,SAAS,SAAS,oBAAoB,CACtC,SAAQ,cAAc,CAAC,SAAS,CAAC;IACjC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAe;gBAG3C,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,EAChC,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC;CAclE"}

package/lib/repositories/dashboard/DashboardBaseRepository.js

@@ -0,0 +1,21 @@
+"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 DocumentCleaner_1 = __importDefault(require("../../util/DocumentCleaner"));
+/**
+ * A base repository for the `dashboard` collection.
+ */
+class DashboardBaseRepository extends BaseRepository_1.default {
+    static COLLECTION_NAME = 'dashboard';
+    constructor(docType, validator, updateCleaner) {
+        const defaultUpdateCleaner = (updatedDoc) => updateCleaner
+            ? updateCleaner(DocumentCleaner_1.default.docType(updatedDoc))
+            : DocumentCleaner_1.default.docType(updatedDoc);
+        const defaultFilter = { docType };
+        super(DashboardBaseRepository.COLLECTION_NAME, validator, defaultFilter, defaultUpdateCleaner);
+    }
+}
+exports.default = DashboardBaseRepository;

package/lib/repositories/dashboard/UserConfigRepository.d.ts

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

package/lib/repositories/dashboard/UserConfigRepository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserConfigRepository.d.ts","sourceRoot":"","sources":["../../../src/repositories/dashboard/UserConfigRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAIhE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,6BAA8B,SAAQ,uBAAuB,CAAC,mBAAmB,CAAC;IACrG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAgC;IAEhE,OAAO;IAQP;;OAEG;WACW,OAAO;IAQf,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/dashboard/UserConfigRepository.js

@@ -0,0 +1,37 @@
+"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 DashboardBaseRepository_1 = __importDefault(require("./DashboardBaseRepository"));
+const UserConfigValidator_1 = __importDefault(require("../../validators/dashboard/UserConfigValidator"));
+const DocumentCleaner_1 = __importDefault(require("../../util/DocumentCleaner"));
+/**
+ * The repository that contains {@link DashboardUserConfig} documents.
+ */
+class DashboardUserConfigRepository extends DashboardBaseRepository_1.default {
+    static singletonInstance;
+    constructor() {
+        super(core_ts_db_lib_1.DashboardUserConfig.docType, new UserConfigValidator_1.default(), DocumentCleaner_1.default.userId);
+    }
+    /**
+     * Gets the singleton instance of the {@link DashboardUserConfigRepository}.
+     */
+    static getRepo() {
+        if (!DashboardUserConfigRepository.singletonInstance) {
+            DashboardUserConfigRepository.singletonInstance =
+                new DashboardUserConfigRepository();
+        }
+        return DashboardUserConfigRepository.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 = DashboardUserConfigRepository;

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

@@ -8,6 +8,7 @@ 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"));
 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());
@@ -23,6 +24,17 @@ it.skip('can add a new test user', async () => {
     const createResult = await userRepository.insertNew(newUser);
     expect(createResult).toBeTruthy();
 });
+it('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 newConfig = new core_ts_db_lib_1.DashboardUserConfig(user._id);
+        newConfig.enableDevMode = true;
+        await configRepo.insertNew(newConfig);
+    }
+});
 afterAll(async () => {
     return DocumentDb_1.default.closeDbConnection();
 });

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

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

package/lib/tests/repositories/{UserRepository.spec.js → common/UserRepository.spec.js}

@@ -5,10 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (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 ApiKeyRepository_1 = __importDefault(require("../../repositories/common/ApiKeyRepository"));
+const UserRepository_1 = __importDefault(require("../../../repositories/common/UserRepository"));
+const testsUtil_1 = require("../../testsUtil");
+const ApiKeyRepository_1 = __importDefault(require("../../../repositories/common/ApiKeyRepository"));
+const DocumentDb_1 = __importDefault(require("../../../util/DocumentDb"));
 const userRepo = UserRepository_1.default.getRepo();
 describe('Create operations', () => {
     it('can create a new user', async () => {

package/lib/tests/repositories/dashboard/UserConfigRepository.spec.d.ts

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

package/lib/tests/repositories/dashboard/UserConfigRepository.spec.d.ts.map

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

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

@@ -0,0 +1,50 @@
+"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"));
+const UserConfigRepository_1 = __importDefault(require("../../../repositories/dashboard/UserConfigRepository"));
+const userRepo = UserRepository_1.default.getRepo();
+const configRepo = UserConfigRepository_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
+        const newUser = await createNewTestUser();
+        const newConfig = await configRepo.get({ userId: newUser._id });
+        expect(newConfig).toBeTruthy();
+        if (!newConfig) {
+            return;
+        }
+        await (0, testsUtil_1.cleanupDoc)(userRepo, newUser);
+    });
+});
+describe('Update operations', () => {
+    it('can update an existing user config', async () => {
+        const newUser = await createNewTestUser();
+        const newConfig = await configRepo.get({ userId: newUser._id });
+        expect(newConfig).toBeTruthy();
+        if (!newConfig) {
+            return;
+        }
+        newConfig.enableDevMode = true;
+        await configRepo.update(newConfig);
+        const updatedConfig = await configRepo.get({ _id: newConfig._id });
+        expect(updatedConfig?.enableDevMode).toBe(true);
+        await (0, testsUtil_1.cleanupDoc)(userRepo, newUser);
+    });
+});
+afterAll(async () => {
+    return DocumentDb_1.default.closeDbConnection();
+});
+async function createNewTestUser() {
+    const newUser = new core_ts_db_lib_1.User(`${crypto_1.default.randomUUID()}userconfigtest`);
+    newUser.projectAccess.dashboard = true;
+    const insertResult = await userRepo.insertNew(newUser);
+    expect(insertResult).toBeTruthy();
+    return newUser;
+}

package/lib/util/DocumentCleaner.d.ts

@@ -0,0 +1,11 @@
+import { BaseDocument, BaseDocumentWithType, BaseDocumentWithUserId } 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 docType<TDocType extends BaseDocumentWithType>(updateDoc: Partial<TDocType>): Partial<TDocType>;
+}
+//# sourceMappingURL=DocumentCleaner.d.ts.map

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

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

package/lib/util/DocumentCleaner.js

@@ -0,0 +1,24 @@
+"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 {
+    static id(updateDoc) {
+        const docCopy = { ...updateDoc };
+        delete docCopy._id;
+        return docCopy;
+    }
+    static userId(updateDoc) {
+        const docCopy = { ...updateDoc };
+        delete docCopy.userId;
+        return docCopy;
+    }
+    static docType(updateDoc) {
+        const docCopy = { ...updateDoc };
+        delete docCopy.docType;
+        return docCopy;
+    }
+}
+exports.default = CleanDocument;

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

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

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

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

package/lib/validators/dashboard/UserConfigValidator.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_ts_lib_1 = require("@aneuhold/core-ts-lib");
+const BaseValidator_1 = __importDefault(require("../BaseValidator"));
+const UserConfigRepository_1 = __importDefault(require("../../repositories/dashboard/UserConfigRepository"));
+const UserRepository_1 = __importDefault(require("../../repositories/common/UserRepository"));
+class DashboardUserConfigValidator extends BaseValidator_1.default {
+    async validateNewObject(newUserConfig) {
+        // Check if the config already exists for the user
+        const configRepo = UserConfigRepository_1.default.getRepo();
+        const existingConfig = await configRepo.get({
+            userId: newUserConfig.userId
+        });
+        if (existingConfig) {
+            core_ts_lib_1.ErrorUtils.throwError(`Config already exists for user: ${newUserConfig.userId}`, newUserConfig);
+        }
+        const userRepo = UserRepository_1.default.getRepo();
+        const user = await userRepo.get({ _id: newUserConfig.userId });
+        if (!user) {
+            core_ts_lib_1.ErrorUtils.throwError(`User does not exist: ${newUserConfig.userId}`, newUserConfig);
+        }
+    }
+    async validateUpdateObject(updatedUserConfig) {
+        // Check if an id is defined
+        if (!updatedUserConfig._id) {
+            core_ts_lib_1.ErrorUtils.throwError(`No _id defined for DashboardUserConfig update.`, updatedUserConfig);
+        }
+    }
+}
+exports.default = DashboardUserConfigValidator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/be-ts-db-lib",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "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",
@@ -36,9 +36,9 @@
     "test": "jest"
   },
   "dependencies": {
-    "@aneuhold/be-ts-lib": "^1.0.3",
-    "@aneuhold/core-ts-db-lib": "^1.0.3",
-    "@aneuhold/core-ts-lib": "^1.1.7",
+    "@aneuhold/be-ts-lib": "^1.0.5",
+    "@aneuhold/core-ts-db-lib": "^1.0.8",
+    "@aneuhold/core-ts-lib": "^1.1.8",
     "bson": "^6.2.0",
     "mongodb": "^6.3.0"
   },

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

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