@aneuhold/core-ts-db-lib 1.0.121 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Anton G Neuhold Jr]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,20 +1,63 @@
 # Personal Core Database Library
 
-![npm](https://img.shields.io/npm/v/%40aneuhold%2Fcore-ts-db-lib)
+[![JSR](https://jsr.io/badges/@aneuhold/core-ts-db-lib)](https://jsr.io/@aneuhold/core-ts-db-lib)
+[![NPM](https://img.shields.io/npm/v/%40aneuhold%2Fcore-ts-db-lib)](https://www.npmjs.com/package/@aneuhold/core-ts-db-lib)
 
 This is used to export types used in various places for database interactions in personal projects.
 
-## Document structure
+## 📦 Installation
+
+To add to a repo, follow the instructions below for your environment:
+
+### For Node using NPM
+
+Run `yarn add @aneuhold/core-ts-db-lib`
+
+### For Node using JSR
+
+The below instructions still allow for things like Renovate to work, and normal commands with yarn such as `yarn up`.
+
+1. Add the required JSR configuration to a `.yarnrc.yml` file if not there already:
+   ```yml
+   npmScopes:
+     jsr:
+       npmRegistryServer: 'https://npm.jsr.io'
+   ```
+1. Add the package with `yarn add @jsr/aneuhold__core-ts-db-lib`
+
+### For Deno
+
+Run `deno add jsr:@aneuhold/core-ts-db-lib`
+
+## 🟢 Usage
+
+Pull in one of the services and use it like so:
+
+```ts
+import { DocumentService } from '@aneuhold/core-ts-db-lib';
+// If using Node with JSR
+// import { DocumentService } from '@jsr/aneuhold__core-ts-db-lib';
+
+export default function deepCopy() {
+  DocumentService.deepCopy({ someProperty: 'someString' });
+}
+```
+
+[See full documentation on usage at JSR!](https://jsr.io/@aneuhold/core-ts-db-lib/doc)
+
+## 🛠️ Development
+
+### 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.
 
-## Guidelines
+### Guidelines
 
-- Note that documents cannot have really special types or classes with functions. For example `Set` cannot be used.
+> Note that documents cannot have really special types or classes with functions. For example `Set` cannot be used.
 
-## Updating an existing document
+### Updating an existing document
 
 If a property is being moved or a new required property is added, then take the
 following steps

package/lib/documents/BaseDocument.d.ts

@@ -1,4 +1,4 @@
-import { ObjectId, Document } from 'bson';
+import { Document, ObjectId } from 'bson';
 /**
  * A base document which other types that will be stored in a document DB can
  * inherit from.

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,CAAC,QAAQ,OAAO,YAAa,YAAW,QAAQ;IAC5D,GAAG,WAAkB;CACtB"}
+{"version":3,"file":"BaseDocument.d.ts","sourceRoot":"./src/","sources":["documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,YAAa,YAAW,QAAQ;IAC5D,GAAG,EAAE,QAAQ,CAAkB;CAChC"}

package/lib/documents/BaseDocument.js

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

package/lib/documents/BaseDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseDocument.js","sourceRoot":"./src/","sources":["documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAgB,YAAY;IACxC,GAAG,GAAa,IAAI,QAAQ,EAAE,CAAC;CAChC"}

package/lib/documents/BaseDocument.ts

@@ -0,0 +1,9 @@
+import { Document, ObjectId } from 'bson';
+
+/**
+ * A base document which other types that will be stored in a document DB can
+ * inherit from.
+ */
+export default abstract class BaseDocument implements Document {
+  _id: ObjectId = new ObjectId();
+}

package/lib/documents/BaseDocumentWithType.d.ts

@@ -1,4 +1,4 @@
-import BaseDocument from './BaseDocument';
+import BaseDocument from './BaseDocument.js';
 export default abstract class BaseDocumentWithType extends BaseDocument {
     abstract docType: string;
 }

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

@@ -1 +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"}
+{"version":3,"file":"BaseDocumentWithType.d.ts","sourceRoot":"./src/","sources":["documents/BaseDocumentWithType.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,oBAAqB,SAAQ,YAAY;IACrE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

package/lib/documents/BaseDocumentWithType.js

@@ -1,9 +1,4 @@
-"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 {
+import BaseDocument from './BaseDocument.js';
+export default class BaseDocumentWithType extends BaseDocument {
 }
-exports.default = BaseDocumentWithType;
+//# sourceMappingURL=BaseDocumentWithType.js.map

package/lib/documents/BaseDocumentWithType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseDocumentWithType.js","sourceRoot":"./src/","sources":["documents/BaseDocumentWithType.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAgB,oBAAqB,SAAQ,YAAY;CAEtE"}

package/lib/documents/BaseDocumentWithType.ts

@@ -0,0 +1,5 @@
+import BaseDocument from './BaseDocument.js';
+
+export default abstract class BaseDocumentWithType extends BaseDocument {
+  abstract docType: string;
+}

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

@@ -1,7 +1,8 @@
 import { ObjectId } from 'bson';
-import BaseDocument from '../BaseDocument';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
-import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+import { UUID } from 'crypto';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
+import BaseDocument from '../BaseDocument.js';
 export declare const validateApiKey: DocumentValidator<ApiKey>;
 /**
  * A document containing an API key for a particular user. This is stored
@@ -11,7 +12,7 @@ export default class ApiKey extends BaseDocument implements RequiredUserId {
     /**
      * The API key for the user. This is indexed in the DB.
      */
-    key: `${string}-${string}-${string}-${string}-${string}`;
+    key: UUID;
     /**
      * The user ID that this key is for. This field is indexed in the database.
      */

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;AAC3C,OAAO,cAAc,MAAM,4CAA4C,CAAC;AAExE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,eAAO,MAAM,cAAc,EAAE,iBAAiB,CAAC,MAAM,CAQpD,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAa,YAAW,cAAc;IACxE;;OAEG;IACH,GAAG,sDAAuB;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}
+{"version":3,"file":"ApiKey.d.ts","sourceRoot":"./src/","sources":["documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAe,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,eAAO,MAAM,cAAc,EAAE,iBAAiB,CAAC,MAAM,CAQpD,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAa,YAAW,cAAc;IACxE;;OAEG;IACH,GAAG,EAAE,IAAI,CAAuB;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}

package/lib/documents/common/ApiKey.js

@@ -1,30 +1,23 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateApiKey = void 0;
-const bson_1 = require("bson");
-const crypto_1 = __importDefault(require("crypto"));
-const BaseDocument_1 = __importDefault(require("../BaseDocument"));
-const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
-const validateApiKey = (apiKey) => {
+import { ObjectId } from 'bson';
+import crypto from 'crypto';
+import Validate from '../../schemas/validators/ValidateUtil.js';
+import BaseDocument from '../BaseDocument.js';
+export const validateApiKey = (apiKey) => {
     const errors = [];
-    const exampleApiKey = new ApiKey(new bson_1.ObjectId());
-    const validate = new ValidateUtil_1.default(apiKey, errors);
+    const exampleApiKey = new ApiKey(new ObjectId());
+    const validate = new Validate(apiKey, errors);
     validate.string('key', exampleApiKey.key);
     return { updatedDoc: apiKey, errors };
 };
-exports.validateApiKey = validateApiKey;
 /**
  * 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 extends BaseDocument_1.default {
+export default class ApiKey extends BaseDocument {
     /**
      * The API key for the user. This is indexed in the DB.
      */
-    key = crypto_1.default.randomUUID();
+    key = crypto.randomUUID();
     /**
      * The user ID that this key is for. This field is indexed in the database.
      */
@@ -37,4 +30,4 @@ class ApiKey extends BaseDocument_1.default {
         this.userId = userId;
     }
 }
-exports.default = ApiKey;
+//# sourceMappingURL=ApiKey.js.map

package/lib/documents/common/ApiKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKey.js","sourceRoot":"./src/","sources":["documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,MAAgB,MAAM,QAAQ,CAAC;AAGtC,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,MAAM,CAAC,MAAM,cAAc,GAA8B,CAAC,MAAc,EAAE,EAAE;IAC1E,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAY;IAC9C;;OAEG;IACH,GAAG,GAAS,MAAM,CAAC,UAAU,EAAE,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAW;IAEjB;;OAEG;IACH,YAAY,MAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF"}

package/lib/documents/common/ApiKey.ts

@@ -0,0 +1,40 @@
+import { ObjectId } from 'bson';
+import crypto, { UUID } from 'crypto';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
+import Validate from '../../schemas/validators/ValidateUtil.js';
+import BaseDocument from '../BaseDocument.js';
+
+export const validateApiKey: DocumentValidator<ApiKey> = (apiKey: ApiKey) => {
+  const errors: string[] = [];
+  const exampleApiKey = new ApiKey(new ObjectId());
+  const validate = new Validate(apiKey, errors);
+
+  validate.string('key', exampleApiKey.key);
+
+  return { updatedDoc: apiKey, errors };
+};
+
+/**
+ * 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 extends BaseDocument implements RequiredUserId {
+  /**
+   * The API key for the user. This is indexed in the DB.
+   */
+  key: UUID = crypto.randomUUID();
+
+  /**
+   * The user ID that this key is for. This field is indexed in the database.
+   */
+  userId: ObjectId;
+
+  /**
+   * Constructs a new {@link ApiKey} for the provided user.
+   */
+  constructor(userId: ObjectId) {
+    super();
+    this.userId = userId;
+  }
+}

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

@@ -1,6 +1,6 @@
 import { ObjectId } from 'bson';
-import BaseDocument from '../BaseDocument';
-import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
+import BaseDocument from '../BaseDocument.js';
 /**
  * A User CTO which can be used to reference a User with only the necessary
  * information.

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;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAG/E;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,QAAQ,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAkBhD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}
+{"version":3,"file":"User.d.ts","sourceRoot":"./src/","sources":["documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,QAAQ,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAkBhD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,EAAE,QAAQ,CAAkB;IAE/B,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}

package/lib/documents/common/User.js

@@ -1,15 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateUser = void 0;
-const bson_1 = require("bson");
-const BaseDocument_1 = __importDefault(require("../BaseDocument"));
-const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
-const validateUser = (user) => {
+import { ObjectId } from 'bson';
+import Validate from '../../schemas/validators/ValidateUtil.js';
+import BaseDocument from '../BaseDocument.js';
+export const validateUser = (user) => {
     const errors = [];
-    const validate = new ValidateUtil_1.default(user, errors);
+    const validate = new Validate(user, errors);
     const exampleUser = new User('example');
     validate.string('userName', 'UsernameUnknown');
     validate.optionalString('password');
@@ -21,14 +15,13 @@ const validateUser = (user) => {
     validate.boolean('projectAccess.dashboard', exampleUser.projectAccess.dashboard);
     return { updatedDoc: user, errors };
 };
-exports.validateUser = validateUser;
 /**
  * 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 extends BaseDocument_1.default {
-    _id = new bson_1.ObjectId();
+export default class User extends BaseDocument {
+    _id = new ObjectId();
     userName;
     email;
     auth = {};
@@ -43,4 +36,4 @@ class User extends BaseDocument_1.default {
         this.userName = userName;
     }
 }
-exports.default = User;
+//# sourceMappingURL=User.js.map

package/lib/documents/common/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"./src/","sources":["documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAW9C,MAAM,CAAC,MAAM,YAAY,GAA4B,CAAC,IAAI,EAAE,EAAE;IAC5D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IAExC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAC/C,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAC1C,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5D,QAAQ,CAAC,OAAO,CACd,yBAAyB,EACzB,WAAW,CAAC,aAAa,CAAC,SAAS,CACpC,CAAC;IAEF,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,GAAa,IAAI,QAAQ,EAAE,CAAC;IAE/B,QAAQ,CAAS;IAEjB,KAAK,CAAU;IAEf,IAAI,GAGA,EAAE,CAAC;IAEP,aAAa,GAAG;QACd,SAAS,EAAE,IAAI;KAChB,CAAC;IAEF;;OAEG;IACH,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF"}

package/lib/documents/common/User.ts

@@ -0,0 +1,63 @@
+import { ObjectId } from 'bson';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
+import Validate from '../../schemas/validators/ValidateUtil.js';
+import BaseDocument from '../BaseDocument.js';
+
+/**
+ * A User CTO which can be used to reference a User with only the necessary
+ * information.
+ */
+export type UserCTO = {
+  _id: ObjectId;
+  userName: string;
+};
+
+export const validateUser: DocumentValidator<User> = (user) => {
+  const errors: string[] = [];
+  const validate = new Validate(user, errors);
+  const exampleUser = new User('example');
+
+  validate.string('userName', 'UsernameUnknown');
+  validate.optionalString('password');
+  validate.optionalString('email');
+  validate.object('auth', exampleUser.auth);
+  validate.optionalString('auth.password');
+  validate.optionalString('auth.googleId');
+  validate.object('projectAccess', exampleUser.projectAccess);
+  validate.boolean(
+    'projectAccess.dashboard',
+    exampleUser.projectAccess.dashboard
+  );
+
+  return { updatedDoc: user, errors };
+};
+
+/**
+ * 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.
+ */
+export default class User extends BaseDocument {
+  _id: ObjectId = new ObjectId();
+
+  userName: string;
+
+  email?: string;
+
+  auth: {
+    password?: string;
+    googleId?: string;
+  } = {};
+
+  projectAccess = {
+    dashboard: true
+  };
+
+  /**
+   * Constructs a new {@link User} with default values.
+   */
+  constructor(userName: string) {
+    super();
+    this.userName = userName;
+  }
+}

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

@@ -1,8 +1,8 @@
 import { ObjectId } from 'bson';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
-import BaseDocumentWithType from '../BaseDocumentWithType';
-import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName';
-import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
+import BaseDocumentWithType from '../BaseDocumentWithType.js';
+import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
 export declare const validateNonogramKatanaItem: DocumentValidator<NonogramKatanaItem>;
 /**
  * An item in the Nonogram Katana game.

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

@@ -1 +1 @@
-{"version":3,"file":"NonogramKatanaItem.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,4CAA4C,CAAC;AACxE,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,sBAAsB,MAAM,4DAA4D,CAAC;AAChG,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,eAAO,MAAM,0BAA0B,EAAE,iBAAiB,CACxD,kBAAkB,CAOnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAAwB;IAEtC,OAAO,SAA8B;IAErC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB,QAAQ,EAAE,sBAAsB,CAAC;IAEjC,aAAa,EAAE,MAAM,CAAK;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;gBAET,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,sBAAsB;CAKhE"}
+{"version":3,"file":"NonogramKatanaItem.d.ts","sourceRoot":"./src/","sources":["documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAC9D,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AACnG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,eAAO,MAAM,0BAA0B,EAAE,iBAAiB,CACxD,kBAAkB,CAOnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAAwB;IAEtC,OAAO,SAA8B;IAErC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB,QAAQ,EAAE,sBAAsB,CAAC;IAEjC,aAAa,EAAE,MAAM,CAAK;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;gBAET,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,sBAAsB;CAKhE"}

package/lib/documents/dashboard/NonogramKatanaItem.js

@@ -1,20 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateNonogramKatanaItem = void 0;
-const BaseDocumentWithType_1 = __importDefault(require("../BaseDocumentWithType"));
-const validateNonogramKatanaItem = (item) => {
+import BaseDocumentWithType from '../BaseDocumentWithType.js';
+export const validateNonogramKatanaItem = (item) => {
     const errors = [];
     // No validation at the moment.
     return { updatedDoc: item, errors };
 };
-exports.validateNonogramKatanaItem = validateNonogramKatanaItem;
 /**
  * An item in the Nonogram Katana game.
  */
-class NonogramKatanaItem extends BaseDocumentWithType_1.default {
+export default class NonogramKatanaItem extends BaseDocumentWithType {
     static docType = 'nonogramKatanaItem';
     docType = NonogramKatanaItem.docType;
     /**
@@ -36,4 +29,4 @@ class NonogramKatanaItem extends BaseDocumentWithType_1.default {
         this.itemName = itemName;
     }
 }
-exports.default = NonogramKatanaItem;
+//# sourceMappingURL=NonogramKatanaItem.js.map

package/lib/documents/dashboard/NonogramKatanaItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NonogramKatanaItem.js","sourceRoot":"./src/","sources":["documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AAEA,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAI9D,MAAM,CAAC,MAAM,0BAA0B,GAEnC,CAAC,IAAwB,EAAE,EAAE;IAC/B,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,+BAA+B;IAE/B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBACnB,SAAQ,oBAAoB;IAG5B,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC;IAEtC,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,MAAM,CAAW;IAEjB,QAAQ,CAAyB;IAEjC,aAAa,GAAW,CAAC,CAAC;IAE1B,UAAU,CAAU;IAEpB,UAAU,CAAU;IAEpB,UAAU,CAAU;IAEpB;;OAEG;IACH,QAAQ,GAAW,CAAC,CAAC;IAErB,YAAY,OAAiB,EAAE,QAAgC;QAC7D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC"}

package/lib/documents/dashboard/NonogramKatanaItem.ts

@@ -0,0 +1,53 @@
+import { ObjectId } from 'bson';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
+import BaseDocumentWithType from '../BaseDocumentWithType.js';
+import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
+
+export const validateNonogramKatanaItem: DocumentValidator<
+  NonogramKatanaItem
+> = (item: NonogramKatanaItem) => {
+  const errors: string[] = [];
+
+  // No validation at the moment.
+
+  return { updatedDoc: item, errors };
+};
+
+/**
+ * An item in the Nonogram Katana game.
+ */
+export default class NonogramKatanaItem
+  extends BaseDocumentWithType
+  implements RequiredUserId
+{
+  static docType = 'nonogramKatanaItem';
+
+  docType = NonogramKatanaItem.docType;
+
+  /**
+   * The owner of this Nonogram Katana item.
+   */
+  userId: ObjectId;
+
+  itemName: NonogramKatanaItemName;
+
+  currentAmount: number = 0;
+
+  storageCap?: number;
+
+  minDesired?: number;
+
+  maxDesired?: number;
+
+  /**
+   * Priority, where the higher the number, the higher up the list it is.
+   */
+  priority: number = 0;
+
+  constructor(ownerId: ObjectId, itemName: NonogramKatanaItemName) {
+    super();
+    this.userId = ownerId;
+    this.itemName = itemName;
+  }
+}

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

@@ -1,9 +1,9 @@
 import { ObjectId } from 'bson';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
-import BaseDocumentWithType from '../BaseDocumentWithType';
-import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName';
-import NonogramKatanaUpgradeName from '../../embedded-types/dashboard/nonogramKatanaUpgrade/UpgradeName';
-import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
+import BaseDocumentWithType from '../BaseDocumentWithType.js';
+import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
+import NonogramKatanaUpgradeName from '../../embedded-types/dashboard/nonogramKatanaUpgrade/UpgradeName.js';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
 export declare const validateNonogramKatanaUpgrade: DocumentValidator<NonogramKatanaUpgrade>;
 /**
  * An upgrade in the Nonogram Katana game.

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

@@ -1 +1 @@
-{"version":3,"file":"NonogramKatanaUpgrade.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,4CAA4C,CAAC;AACxE,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,sBAAsB,MAAM,4DAA4D,CAAC;AAChG,OAAO,yBAAyB,MAAM,kEAAkE,CAAC;AACzG,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,eAAO,MAAM,6BAA6B,EAAE,iBAAiB,CAC3D,qBAAqB,CAOtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,qBACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAA2B;IAEzC,OAAO,SAAiC;IAExC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB,WAAW,EAAE,yBAAyB,CAAC;IAEvC,SAAS,EAAE,OAAO,CAAS;IAE3B,kBAAkB,EAAE;SAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,EAAE,MAAM;KAAE,CAAM;IAEtE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;gBAET,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,yBAAyB;CAKtE"}
+{"version":3,"file":"NonogramKatanaUpgrade.d.ts","sourceRoot":"./src/","sources":["documents/dashboard/NonogramKatanaUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAC9D,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AACnG,OAAO,yBAAyB,MAAM,qEAAqE,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,eAAO,MAAM,6BAA6B,EAAE,iBAAiB,CAC3D,qBAAqB,CAOtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,qBACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAA2B;IAEzC,OAAO,SAAiC;IAExC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB,WAAW,EAAE,yBAAyB,CAAC;IAEvC,SAAS,EAAE,OAAO,CAAS;IAE3B,kBAAkB,EAAE;SAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,EAAE,MAAM;KAAE,CAAM;IAEtE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;gBAET,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,yBAAyB;CAKtE"}

package/lib/documents/dashboard/NonogramKatanaUpgrade.js

@@ -1,20 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateNonogramKatanaUpgrade = void 0;
-const BaseDocumentWithType_1 = __importDefault(require("../BaseDocumentWithType"));
-const validateNonogramKatanaUpgrade = (upgrade) => {
+import BaseDocumentWithType from '../BaseDocumentWithType.js';
+export const validateNonogramKatanaUpgrade = (upgrade) => {
     const errors = [];
     // No validation at the moment.
     return { updatedDoc: upgrade, errors };
 };
-exports.validateNonogramKatanaUpgrade = validateNonogramKatanaUpgrade;
 /**
  * An upgrade in the Nonogram Katana game.
  */
-class NonogramKatanaUpgrade extends BaseDocumentWithType_1.default {
+export default class NonogramKatanaUpgrade extends BaseDocumentWithType {
     static docType = 'nonogramKatanaUpgrade';
     docType = NonogramKatanaUpgrade.docType;
     /**
@@ -34,4 +27,4 @@ class NonogramKatanaUpgrade extends BaseDocumentWithType_1.default {
         this.upgradeName = upgradeName;
     }
 }
-exports.default = NonogramKatanaUpgrade;
+//# sourceMappingURL=NonogramKatanaUpgrade.js.map

package/lib/documents/dashboard/NonogramKatanaUpgrade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NonogramKatanaUpgrade.js","sourceRoot":"./src/","sources":["documents/dashboard/NonogramKatanaUpgrade.ts"],"names":[],"mappings":"AAEA,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAK9D,MAAM,CAAC,MAAM,6BAA6B,GAEtC,CAAC,OAA8B,EAAE,EAAE;IACrC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,+BAA+B;IAE/B,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AACzC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,qBACnB,SAAQ,oBAAoB;IAG5B,MAAM,CAAC,OAAO,GAAG,uBAAuB,CAAC;IAEzC,OAAO,GAAG,qBAAqB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,MAAM,CAAW;IAEjB,WAAW,CAA4B;IAEvC,SAAS,GAAY,KAAK,CAAC;IAE3B,kBAAkB,GAAiD,EAAE,CAAC;IAEtE;;OAEG;IACH,QAAQ,GAAW,CAAC,CAAC;IAErB,YAAY,OAAiB,EAAE,WAAsC;QACnE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC"}