@aneuhold/core-ts-db-lib 1.0.13 → 1.0.14

package/README.md

@@ -23,7 +23,9 @@ following steps
 1. Run the migration with `yarn migrate:dry` then `yarn migrate`
 1. Run validation to ensure everything is alright with `yarn validate:dry` then `yarn validate` if needed
 1. Run tests
+1. Update tests if needed then re-validate
 1. Push a new version of the `be-ts-db-lib` to NPM
 1. Pull the new versions into `digital-ocean-functions` and deploy
 1. Pull the new versions into `core-ts-api-lib` and push to NPM
 1. Pull the new versions into any relevant frontends and deploy
+1. Test out the frontends to make sure it works okay and double check MongoDB directly

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

@@ -0,0 +1,52 @@
+import { ObjectId } from 'bson';
+import BaseDocumentWithType from '../BaseDocumentWithType';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+export declare const validateDashboardTask: DocumentValidator<DashboardTask>;
+export default class DashboardTask extends BaseDocumentWithType implements RequiredUserId {
+    static docType: string;
+    docType: string;
+    /**
+     * The owner of this task.
+     */
+    userId: ObjectId;
+    /**
+     * The different users this task is shared with. This should be indexed
+     * somehow.
+     */
+    sharedWith: ObjectId[];
+    title: string;
+    completed: boolean;
+    /**
+     * The ID of the parent task if there is one.
+     */
+    parentTaskId?: ObjectId;
+    /**
+     * The description of the task. This is purposefully optional in case the
+     * user wants to just use the title. This also helps the frontend
+     * differentiate between a task that has no description and a task that has
+     * an empty description.
+     */
+    description?: string;
+    /**
+     * The date this task was created.
+     */
+    createdDate: Date;
+    /**
+     * The date this task was last updated.
+     */
+    lastUpdatedDate: Date;
+    startDate?: Date;
+    dueDate?: Date;
+    /**
+     * User-assigned tags for this task.
+     */
+    tags: string[];
+    /**
+     * System-assigned category for this task. This should be used to determine
+     * where this task should be displayed.
+     */
+    category: string;
+    constructor(ownerId: ObjectId);
+}
+//# sourceMappingURL=Task.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,cAAc,MAAM,4CAA4C,CAAC;AAExE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,eAAO,MAAM,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,CAclE,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,aACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAAU;IAExB,OAAO,SAAyB;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,QAAQ,EAAE,CAAM;IAE5B,KAAK,SAAM;IAEX,SAAS,UAAS;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,OAAc;IAEzB;;OAEG;IACH,eAAe,OAAc;IAE7B,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAM;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAa;gBAEjB,OAAO,EAAE,QAAQ;CAI9B"}

package/lib/documents/dashboard/Task.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDashboardTask = void 0;
+const bson_1 = require("bson");
+const BaseDocumentWithType_1 = __importDefault(require("../BaseDocumentWithType"));
+const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
+const validateDashboardTask = (task) => {
+    const errors = [];
+    const validate = new ValidateUtil_1.default(task, errors);
+    const exampleTask = new DashboardTask(new bson_1.ObjectId());
+    validate.string('title', exampleTask.title);
+    validate.boolean('completed', exampleTask.completed);
+    validate.optionalString('description');
+    validate.array('tags', exampleTask.tags);
+    validate.string('category', exampleTask.category);
+    return { updatedDoc: task, errors };
+};
+exports.validateDashboardTask = validateDashboardTask;
+class DashboardTask extends BaseDocumentWithType_1.default {
+    static docType = 'task';
+    docType = DashboardTask.docType;
+    /**
+     * The owner of this task.
+     */
+    userId;
+    /**
+     * The different users this task is shared with. This should be indexed
+     * somehow.
+     */
+    sharedWith = [];
+    title = '';
+    completed = false;
+    /**
+     * The ID of the parent task if there is one.
+     */
+    parentTaskId;
+    /**
+     * The description of the task. This is purposefully optional in case the
+     * user wants to just use the title. This also helps the frontend
+     * differentiate between a task that has no description and a task that has
+     * an empty description.
+     */
+    description;
+    /**
+     * The date this task was created.
+     */
+    createdDate = new Date();
+    /**
+     * The date this task was last updated.
+     */
+    lastUpdatedDate = new Date();
+    startDate;
+    dueDate;
+    /**
+     * User-assigned tags for this task.
+     */
+    tags = [];
+    /**
+     * System-assigned category for this task. This should be used to determine
+     * where this task should be displayed.
+     */
+    category = 'default';
+    constructor(ownerId) {
+        super();
+        this.userId = ownerId;
+    }
+}
+exports.default = DashboardTask;

package/lib/schemas/validators/ValidateUtil.d.ts

@@ -26,6 +26,7 @@ export default class Validate {
     object(fieldName: string, defaultValue: object): void;
     number(fieldName: string, defaultValue: number): void;
     boolean(fieldName: string, defaultValue: boolean): void;
+    array(fieldName: string, defaultValue: unknown[]): void;
     /**
      * Checks if the provided field path is valid. In other words, if the
      * field path is of length 1, it always returns true. If the field path

package/lib/schemas/validators/ValidateUtil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ValidateUtil.d.ts","sourceRoot":"","sources":["../../../src/schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAOA,KAAK,eAAe,GAAG;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKzB,OAAO,CAAC,WAAW;IAJrB,YAAY,EAAE,eAAe,CAAC;gBAG5B,YAAY,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE;IAK/B,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,eAAe,CAAC,SAAS,EAAE,MAAM;IAUjC,aAAa,CAAC,SAAS,EAAE,MAAM;IAU/B,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO;IAUhD;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,WAAW;CAWpB"}
+{"version":3,"file":"ValidateUtil.d.ts","sourceRoot":"","sources":["../../../src/schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAOA,KAAK,eAAe,GAAG;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKzB,OAAO,CAAC,WAAW;IAJrB,YAAY,EAAE,eAAe,CAAC;gBAG5B,YAAY,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE;IAK/B,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,eAAe,CAAC,SAAS,EAAE,MAAM;IAUjC,aAAa,CAAC,SAAS,EAAE,MAAM;IAU/B,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO;IAUhD,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE;IAUhD;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,WAAW;CAWpB"}

package/lib/schemas/validators/ValidateUtil.js

@@ -77,6 +77,13 @@ class Validate {
             this.updateField(fieldName, defaultValue);
         }
     }
+    array(fieldName, defaultValue) {
+        if (this.fieldPathIsValid(fieldName) &&
+            !Array.isArray(this.getField(fieldName))) {
+            this.errorsArray.push(`${fieldName} must be an array`);
+            this.updateField(fieldName, defaultValue);
+        }
+    }
     /**
      * Checks if the provided field path is valid. In other words, if the
      * field path is of length 1, it always returns true. If the field path

package/package.json

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