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

package/README.md

@@ -3,3 +3,9 @@
 ![npm](https://img.shields.io/npm/v/%40aneuhold%2Fcore-ts-db-lib)
 
 This is used to export types used in various places for database interactions in personal projects.
+
+## Document structure
+
+Project-specific documents can be held in a single collection. So those should inherit from the `BaseDocumentWithType` class.
+
+When different document types are held under a specific collection, they should get their own folder.

package/lib/documents/BaseDocument.d.ts

@@ -1,9 +1,9 @@
-import { ObjectId, Document } from 'bson';
+import { ObjectId } from 'bson';
 /**
  * A base document which other types that will be stored in a document DB can
  * inherit from.
  */
-export default interface BaseDocument extends Document {
+export default abstract class BaseDocument extends Document {
     _id: ObjectId;
 }
 //# sourceMappingURL=BaseDocument.d.ts.map

package/lib/documents/BaseDocument.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDocument.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,YAAa,SAAQ,QAAQ;IACpD,GAAG,EAAE,QAAQ,CAAC;CACf"}
+{"version":3,"file":"BaseDocument.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAY,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,YAAa,SAAQ,QAAQ;IACzD,GAAG,WAAkB;CACtB"}

package/lib/documents/BaseDocument.js

@@ -1,2 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const bson_1 = require("bson");
+/**
+ * A base document which other types that will be stored in a document DB can
+ * inherit from.
+ */
+class BaseDocument extends Document {
+    _id = new bson_1.ObjectId();
+}
+exports.default = BaseDocument;

package/lib/documents/BaseDocumentWithOwner.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=BaseDocumentWithOwner.d.ts.map

package/lib/documents/BaseDocumentWithOwner.d.ts.map

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

package/lib/documents/BaseDocumentWithOwner.js

@@ -0,0 +1 @@
+"use strict";

package/lib/documents/BaseDocumentWithType.d.ts

@@ -0,0 +1,5 @@
+import BaseDocument from './BaseDocument';
+export default abstract class BaseDocumentWithType extends BaseDocument {
+    abstract docType: string;
+}
+//# sourceMappingURL=BaseDocumentWithType.d.ts.map

package/lib/documents/BaseDocumentWithType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseDocumentWithType.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocumentWithType.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAE1C,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,oBAAqB,SAAQ,YAAY;IACrE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

package/lib/documents/BaseDocumentWithType.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseDocument_1 = __importDefault(require("./BaseDocument"));
+class BaseDocumentWithType extends BaseDocument_1.default {
+}
+exports.default = BaseDocumentWithType;

package/lib/documents/BaseDocumentWithUserId.d.ts

@@ -0,0 +1,10 @@
+import { ObjectId } from 'bson';
+import BaseDocument from './BaseDocument';
+/**
+ * A base document type that has a user ID associated with it. This is useful
+ * for filtering on all documents that a user has access to.
+ */
+export default abstract class BaseDocumentWithUserId extends BaseDocument {
+    abstract userId: ObjectId;
+}
+//# sourceMappingURL=BaseDocumentWithUserId.d.ts.map

package/lib/documents/BaseDocumentWithUserId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseDocumentWithUserId.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocumentWithUserId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,sBAAuB,SAAQ,YAAY;IACvE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B"}

package/lib/documents/BaseDocumentWithUserId.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseDocument_1 = __importDefault(require("./BaseDocument"));
+/**
+ * A base document type that has a user ID associated with it. This is useful
+ * for filtering on all documents that a user has access to.
+ */
+class BaseDocumentWithUserId extends BaseDocument_1.default {
+}
+exports.default = BaseDocumentWithUserId;

package/lib/documents/common/ApiKey.d.ts

@@ -1,11 +1,11 @@
 import { ObjectId } from 'bson';
 import BaseDocument from '../BaseDocument';
+import BaseDocumentWithUserId from '../BaseDocumentWithUserId';
 /**
  * A document containing an API key for a particular user. This is stored
  * separately from the {@link User} document to enhance security a bit.
  */
-export default class ApiKey implements BaseDocument {
-    _id: ObjectId;
+export default class ApiKey extends BaseDocument implements BaseDocumentWithUserId {
     /**
      * The API key for the user. This is indexed in the DB.
      */

package/lib/documents/common/ApiKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKey.d.ts","sourceRoot":"","sources":["../../../src/documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,YAAW,YAAY;IACjD,GAAG,WAAkB;IAErB;;OAEG;IACH,GAAG,sDAAuB;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAG7B"}
+{"version":3,"file":"ApiKey.d.ts","sourceRoot":"","sources":["../../../src/documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,sBAAsB,MAAM,2BAA2B,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MACnB,SAAQ,YACR,YAAW,sBAAsB;IAEjC;;OAEG;IACH,GAAG,sDAAuB;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}

package/lib/documents/common/ApiKey.js

@@ -3,14 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const bson_1 = require("bson");
 const crypto_1 = __importDefault(require("crypto"));
+const BaseDocument_1 = __importDefault(require("../BaseDocument"));
 /**
  * A document containing an API key for a particular user. This is stored
  * separately from the {@link User} document to enhance security a bit.
  */
-class ApiKey {
-    _id = new bson_1.ObjectId();
+class ApiKey extends BaseDocument_1.default {
     /**
      * The API key for the user. This is indexed in the DB.
      */
@@ -23,6 +22,7 @@ class ApiKey {
      * Constructs a new {@link ApiKey} for the provided user.
      */
     constructor(userId) {
+        super();
         this.userId = userId;
     }
 }

package/lib/documents/common/User.d.ts

@@ -5,7 +5,7 @@ import BaseDocument from '../BaseDocument';
  * other documents that need to reference a user, instead of cluttering the
  * key user information.
  */
-export default class User implements BaseDocument {
+export default class User extends BaseDocument {
     _id: ObjectId;
     userName: string;
     password?: string;

package/lib/documents/common/User.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,YAAW,YAAY;IAC/C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAG7B"}
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}

package/lib/documents/common/User.js

@@ -1,12 +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 bson_1 = require("bson");
+const BaseDocument_1 = __importDefault(require("../BaseDocument"));
 /**
  * A standard user of all personal projects. This should be linked to from
  * other documents that need to reference a user, instead of cluttering the
  * key user information.
  */
-class User {
+class User extends BaseDocument_1.default {
     _id = new bson_1.ObjectId();
     userName;
     password;
@@ -19,6 +23,7 @@ class User {
      * Constructs a new {@link User} with default values.
      */
     constructor(userName) {
+        super();
         this.userName = userName;
     }
 }

package/lib/documents/dashboard/UserConfig.d.ts

@@ -0,0 +1,17 @@
+import { ObjectId } from 'bson';
+import BaseDocumentWithType from '../BaseDocumentWithType';
+import BaseDocumentWithUserId from '../BaseDocumentWithUserId';
+export default class DashboardUserConfig extends BaseDocumentWithType implements BaseDocumentWithUserId {
+    static docType: string;
+    docType: string;
+    /**
+     * The owner of this config.
+     */
+    userId: ObjectId;
+    /**
+     * Whether or not to enable dev mode for the user.
+     */
+    enableDevMode: boolean;
+    constructor(ownerId: ObjectId);
+}
+//# sourceMappingURL=UserConfig.d.ts.map

package/lib/documents/dashboard/UserConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserConfig.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/UserConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,sBAAsB,MAAM,2BAA2B,CAAC;AAE/D,MAAM,CAAC,OAAO,OAAO,mBACnB,SAAQ,oBACR,YAAW,sBAAsB;IAEjC,MAAM,CAAC,OAAO,SAAgB;IAE9B,OAAO,SAA+B;IAEtC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,aAAa,UAAS;gBAEV,OAAO,EAAE,QAAQ;CAI9B"}

package/lib/documents/dashboard/UserConfig.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseDocumentWithType_1 = __importDefault(require("../BaseDocumentWithType"));
+class DashboardUserConfig extends BaseDocumentWithType_1.default {
+    static docType = 'userConfig';
+    docType = DashboardUserConfig.docType;
+    /**
+     * The owner of this config.
+     */
+    userId;
+    /**
+     * Whether or not to enable dev mode for the user.
+     */
+    enableDevMode = false;
+    constructor(ownerId) {
+        super();
+        this.userId = ownerId;
+    }
+}
+exports.default = DashboardUserConfig;

package/lib/index.d.ts

@@ -1,6 +1,9 @@
 import BaseDocument from './documents/BaseDocument';
+import BaseDocumentWithType from './documents/BaseDocumentWithType';
+import BaseDocumentWithUserId from './documents/BaseDocumentWithUserId';
 import ApiKey from './documents/common/ApiKey';
 import User from './documents/common/User';
-export { User, ApiKey };
-export type { BaseDocument };
+import DashboardUserConfig from './documents/dashboard/UserConfig';
+export { User, ApiKey, DashboardUserConfig, BaseDocument, BaseDocumentWithType, BaseDocumentWithUserId };
+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":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAG3C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAGxB,YAAY,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AACxE,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAC3C,OAAO,mBAAmB,MAAM,kCAAkC,CAAC;AAGnE,OAAO,EACL,IAAI,EACJ,MAAM,EACN,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,sBAAsB,EACvB,CAAC;AAGF,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -3,8 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiKey = exports.User = void 0;
+exports.BaseDocumentWithUserId = exports.BaseDocumentWithType = exports.BaseDocument = exports.DashboardUserConfig = exports.ApiKey = exports.User = void 0;
+const BaseDocument_1 = __importDefault(require("./documents/BaseDocument"));
+exports.BaseDocument = BaseDocument_1.default;
+const BaseDocumentWithType_1 = __importDefault(require("./documents/BaseDocumentWithType"));
+exports.BaseDocumentWithType = BaseDocumentWithType_1.default;
+const BaseDocumentWithUserId_1 = __importDefault(require("./documents/BaseDocumentWithUserId"));
+exports.BaseDocumentWithUserId = BaseDocumentWithUserId_1.default;
 const ApiKey_1 = __importDefault(require("./documents/common/ApiKey"));
 exports.ApiKey = ApiKey_1.default;
 const User_1 = __importDefault(require("./documents/common/User"));
 exports.User = User_1.default;
+const UserConfig_1 = __importDefault(require("./documents/dashboard/UserConfig"));
+exports.DashboardUserConfig = UserConfig_1.default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/core-ts-db-lib",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A core database library used for personal projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",