@aneuhold/core-ts-db-lib 1.0.20 → 1.0.22

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

@@ -2,6 +2,7 @@ import { ObjectId } from 'bson';
 import BaseDocumentWithType from '../BaseDocumentWithType';
 import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
 import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+import { RecurrenceInfo } from '../../embedded-types/dashboard/task/RecurrenceInfo';
 export declare const validateDashboardTask: DocumentValidator<DashboardTask>;
 /**
  * Gets all the children task IDs for the given parent task IDs.
@@ -48,6 +49,17 @@ export default class DashboardTask extends BaseDocumentWithType implements Requi
      * double check for this when displaying things.
      */
     sharedWith: ObjectId[];
+    /**
+     * The recurrence info for this task if there is any. This is ignored
+     * if {@link parentRecurringTask} is set.
+     */
+    recurrenceInfo?: RecurrenceInfo;
+    /**
+     * The ID of the parent recurring task if there is one. Users should not
+     * be able to share the current task if this is set to a value. It would
+     * get confusing for the user it was shared with.
+     */
+    parentRecurringTask?: ObjectId;
     title: string;
     completed: boolean;
     /**

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

@@ -1 +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,CAmBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,iBACxB,aAAa,EAAE,iBACd,QAAQ,EAAE,KACxB,QAAQ,EA2BV,CAAC;AAyBF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,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;;;;;;;;;;;OAWG;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"}
+{"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;AAC/E,OAAO,EACL,cAAc,EAEf,MAAM,oDAAoD,CAAC;AAE5D,eAAO,MAAM,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,CAqBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,iBACxB,aAAa,EAAE,iBACd,QAAQ,EAAE,KACxB,QAAQ,EA2BV,CAAC;AAyBF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,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;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,QAAQ,EAAE,CAAM;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,QAAQ,CAAC;IAE/B,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

@@ -7,6 +7,7 @@ exports.getDashboardTaskChildrenIds = exports.validateDashboardTask = void 0;
 const bson_1 = require("bson");
 const BaseDocumentWithType_1 = __importDefault(require("../BaseDocumentWithType"));
 const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
+const RecurrenceInfo_1 = require("../../embedded-types/dashboard/task/RecurrenceInfo");
 const validateDashboardTask = (task) => {
     const errors = [];
     const validate = new ValidateUtil_1.default(task, errors);
@@ -15,12 +16,14 @@ const validateDashboardTask = (task) => {
     validate.boolean('completed', exampleTask.completed);
     validate.optionalString('description');
     validate.array('sharedWith', exampleTask.sharedWith);
+    validate.optionalObject('recurrenceInfo');
     validate.array('tags', exampleTask.tags);
     validate.string('category', exampleTask.category);
     validate.object('createdDate', exampleTask.createdDate);
     validate.object('lastUpdatedDate', exampleTask.lastUpdatedDate);
     validate.optionalObject('startDate');
     validate.optionalObject('dueDate');
+    (0, RecurrenceInfo_1.validateRecurrenceInfo)(task, errors);
     return { updatedDoc: task, errors };
 };
 exports.validateDashboardTask = validateDashboardTask;
@@ -105,6 +108,17 @@ class DashboardTask extends BaseDocumentWithType_1.default {
      * double check for this when displaying things.
      */
     sharedWith = [];
+    /**
+     * The recurrence info for this task if there is any. This is ignored
+     * if {@link parentRecurringTask} is set.
+     */
+    recurrenceInfo;
+    /**
+     * The ID of the parent recurring task if there is one. Users should not
+     * be able to share the current task if this is set to a value. It would
+     * get confusing for the user it was shared with.
+     */
+    parentRecurringTask;
     title = '';
     completed = false;
     /**

package/lib/embedded-types/dashboard/task/RecurrenceInfo.d.ts

@@ -0,0 +1,62 @@
+import DashboardTask from '../../../documents/dashboard/Task';
+export declare function validateRecurrenceInfo(task: DashboardTask, errors: string[]): void;
+export type RecurrenceInfo = {
+    frequency: RecurrenceFrequency;
+    recurrenceBasis: RecurrenceBasis;
+    recurrenceEffect: RecurrenceEffect;
+};
+export type RecurrenceFrequency = {
+    type: RecurrenceFrequencyType;
+    everyXTimeUnit?: {
+        timeUnit: 'day' | 'week' | 'month' | 'year';
+        /**
+         * The number of time units that should pass before the task recurs.
+         */
+        x: number;
+    };
+    /**
+     * The set of week days that the task should recur on. This is 0-6 with 0
+     * being Sunday.
+     */
+    weekDaySet?: Set<number>;
+    everyXWeekdayOfMonth?: {
+        weekDay: number;
+        /**
+         * The week of the month that the task should recur on. This is 0-4 with 0
+         * being the first week of the month. If this is 'last', then it will
+         * recur on the last week of the month.
+         */
+        weekOfMonth: number | 'last';
+    };
+};
+export declare enum RecurrenceFrequencyType {
+    everyXTimeUnit = "everyXTimeUnit",
+    weekDaySet = "weekDaySet",
+    everyXWeekdayOfMonth = "everyXWeekdayOfMonth",
+    lastDayOfMonth = "lastDayOfMonth"
+}
+/**
+ * The basis of date movement for a recurring task.
+ */
+export declare enum RecurrenceBasis {
+    startDate = "startDate",
+    dueDate = "dueDate"
+}
+export declare enum RecurrenceEffect {
+    /**
+     * Automatically refreshes the task when the {@link RecurrenceBasis} triggers.
+     */
+    rollOnBasis = "rollOnBasis",
+    /**
+     * Moves the task forward from the completed date and doesn't reset the task
+     * when the {@link RecurrenceBasis} triggers.
+     */
+    rollOnCompletion = "rollOnCompletion",
+    /**
+     * When the {@link RecurrenceBasis} triggers, and the current task isn't
+     * completed, makes a duplicate task and clears {@link RecurrenceInfo} on
+     * the original task.
+     */
+    stack = "stack"
+}
+//# sourceMappingURL=RecurrenceInfo.d.ts.map

package/lib/embedded-types/dashboard/task/RecurrenceInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecurrenceInfo.d.ts","sourceRoot":"","sources":["../../../../src/embedded-types/dashboard/task/RecurrenceInfo.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,mCAAmC,CAAC;AAE9D,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAwB3E;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,cAAc,CAAC,EAAE;QACf,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAC5C;;WAEG;QACH,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF;;;OAGG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,oBAAoB,CAAC,EAAE;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB;;;;WAIG;QACH,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,oBAAY,uBAAuB;IACjC,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,oBAAoB,yBAAyB;IAC7C,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;;OAGG;IACH,gBAAgB,qBAAqB;IACrC;;;;OAIG;IACH,KAAK,UAAU;CAChB"}

package/lib/embedded-types/dashboard/task/RecurrenceInfo.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecurrenceEffect = exports.RecurrenceBasis = exports.RecurrenceFrequencyType = exports.validateRecurrenceInfo = void 0;
+function validateRecurrenceInfo(task, errors) {
+    const recurrenceErrors = [];
+    if (!task.recurrenceInfo) {
+        return;
+    }
+    if (!task.recurrenceInfo.frequency) {
+        recurrenceErrors.push('RecurrenceInfo frequency is required.');
+    }
+    if (!task.recurrenceInfo.recurrenceBasis) {
+        recurrenceErrors.push('RecurrenceInfo recurrenceBasis is required.');
+    }
+    if (!task.recurrenceInfo.recurrenceEffect) {
+        recurrenceErrors.push('RecurrenceInfo recurrenceEffect is required.');
+    }
+    // Write more if this later if there are any changes to the data model so it
+    // can be correctly converted.
+    if (recurrenceErrors.length > 0) {
+        // eslint-disable-next-line no-param-reassign
+        task.recurrenceInfo = undefined;
+    }
+    errors.push(...recurrenceErrors);
+}
+exports.validateRecurrenceInfo = validateRecurrenceInfo;
+var RecurrenceFrequencyType;
+(function (RecurrenceFrequencyType) {
+    RecurrenceFrequencyType["everyXTimeUnit"] = "everyXTimeUnit";
+    RecurrenceFrequencyType["weekDaySet"] = "weekDaySet";
+    RecurrenceFrequencyType["everyXWeekdayOfMonth"] = "everyXWeekdayOfMonth";
+    RecurrenceFrequencyType["lastDayOfMonth"] = "lastDayOfMonth";
+})(RecurrenceFrequencyType || (exports.RecurrenceFrequencyType = RecurrenceFrequencyType = {}));
+/**
+ * The basis of date movement for a recurring task.
+ */
+var RecurrenceBasis;
+(function (RecurrenceBasis) {
+    RecurrenceBasis["startDate"] = "startDate";
+    RecurrenceBasis["dueDate"] = "dueDate";
+})(RecurrenceBasis || (exports.RecurrenceBasis = RecurrenceBasis = {}));
+var RecurrenceEffect;
+(function (RecurrenceEffect) {
+    /**
+     * Automatically refreshes the task when the {@link RecurrenceBasis} triggers.
+     */
+    RecurrenceEffect["rollOnBasis"] = "rollOnBasis";
+    /**
+     * Moves the task forward from the completed date and doesn't reset the task
+     * when the {@link RecurrenceBasis} triggers.
+     */
+    RecurrenceEffect["rollOnCompletion"] = "rollOnCompletion";
+    /**
+     * When the {@link RecurrenceBasis} triggers, and the current task isn't
+     * completed, makes a duplicate task and clears {@link RecurrenceInfo} on
+     * the original task.
+     */
+    RecurrenceEffect["stack"] = "stack";
+})(RecurrenceEffect || (exports.RecurrenceEffect = RecurrenceEffect = {}));

package/lib/index.d.ts

@@ -4,8 +4,9 @@ import ApiKey, { validateApiKey } from './documents/common/ApiKey';
 import User, { UserCTO, validateUser } from './documents/common/User';
 import DashboardTask, { getDashboardTaskChildrenIds, validateDashboardTask } from './documents/dashboard/Task';
 import DashboardUserConfig, { validateDashboardUserConfig } from './documents/dashboard/UserConfig';
+import { RecurrenceBasis, RecurrenceEffect, RecurrenceFrequency, RecurrenceFrequencyType, RecurrenceInfo } from './embedded-types/dashboard/task/RecurrenceInfo';
 import RequiredUserId from './schemas/required-refs/RequiredUserId';
 import { DocumentValidator } from './schemas/validators/DocumentValidator';
-export { User, validateUser, ApiKey, validateApiKey, DashboardUserConfig, validateDashboardUserConfig, DashboardTask, validateDashboardTask, getDashboardTaskChildrenIds, BaseDocument, BaseDocumentWithType, RequiredUserId };
-export type { DocumentValidator, UserCTO };
+export { User, validateUser, ApiKey, validateApiKey, DashboardUserConfig, validateDashboardUserConfig, DashboardTask, RecurrenceFrequencyType, RecurrenceBasis, RecurrenceEffect, validateDashboardTask, getDashboardTaskChildrenIds, BaseDocument, BaseDocumentWithType, RequiredUserId };
+export type { DocumentValidator, UserCTO, RecurrenceInfo, RecurrenceFrequency };
 //# 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,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,MAAM,EAAE,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,IAAI,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,aAAa,EAAE,EACpB,2BAA2B,EAC3B,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,mBAAmB,EAAE,EAC1B,2BAA2B,EAC5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,cAAc,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAG3E,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,aAAa,EACb,qBAAqB,EACrB,2BAA2B,EAC3B,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACf,CAAC;AAGF,YAAY,EAAE,iBAAiB,EAAE,OAAO,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,MAAM,EAAE,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,IAAI,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,aAAa,EAAE,EACpB,2BAA2B,EAC3B,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,mBAAmB,EAAE,EAC1B,2BAA2B,EAC5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACf,MAAM,gDAAgD,CAAC;AACxD,OAAO,cAAc,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAG3E,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,aAAa,EACb,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACf,CAAC;AAGF,YAAY,EAAE,iBAAiB,EAAE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,CAAC"}

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiredUserId = exports.BaseDocumentWithType = exports.BaseDocument = exports.getDashboardTaskChildrenIds = exports.validateDashboardTask = exports.DashboardTask = exports.validateDashboardUserConfig = exports.DashboardUserConfig = exports.validateApiKey = exports.ApiKey = exports.validateUser = exports.User = void 0;
+exports.RequiredUserId = exports.BaseDocumentWithType = exports.BaseDocument = exports.getDashboardTaskChildrenIds = exports.validateDashboardTask = exports.RecurrenceEffect = exports.RecurrenceBasis = exports.RecurrenceFrequencyType = exports.DashboardTask = exports.validateDashboardUserConfig = exports.DashboardUserConfig = exports.validateApiKey = exports.ApiKey = exports.validateUser = exports.User = void 0;
 const BaseDocument_1 = __importDefault(require("./documents/BaseDocument"));
 exports.BaseDocument = BaseDocument_1.default;
 const BaseDocumentWithType_1 = __importDefault(require("./documents/BaseDocumentWithType"));
@@ -44,5 +44,9 @@ Object.defineProperty(exports, "validateDashboardTask", { enumerable: true, get:
 const UserConfig_1 = __importStar(require("./documents/dashboard/UserConfig"));
 exports.DashboardUserConfig = UserConfig_1.default;
 Object.defineProperty(exports, "validateDashboardUserConfig", { enumerable: true, get: function () { return UserConfig_1.validateDashboardUserConfig; } });
+const RecurrenceInfo_1 = require("./embedded-types/dashboard/task/RecurrenceInfo");
+Object.defineProperty(exports, "RecurrenceBasis", { enumerable: true, get: function () { return RecurrenceInfo_1.RecurrenceBasis; } });
+Object.defineProperty(exports, "RecurrenceEffect", { enumerable: true, get: function () { return RecurrenceInfo_1.RecurrenceEffect; } });
+Object.defineProperty(exports, "RecurrenceFrequencyType", { enumerable: true, get: function () { return RecurrenceInfo_1.RecurrenceFrequencyType; } });
 const RequiredUserId_1 = __importDefault(require("./schemas/required-refs/RequiredUserId"));
 exports.RequiredUserId = RequiredUserId_1.default;

package/package.json

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