@managemint-solutions/entities 1.24.0 → 1.26.0

package/dist/audit-trail/enum/index.d.ts

@@ -11,6 +11,7 @@ export declare enum AuditTrailEntityType {
     USER = "users",
     PERMISSION = "permissions",
     STATUS = "statuses",
+    LABEL = "labels",
     ADDITIONAL_DETAILS = "additional_details",
     SUPPORTING_FILES = "supporting_files",
     NOTES = "notes",

package/dist/audit-trail/enum/index.js

@@ -16,6 +16,7 @@ var AuditTrailEntityType;
     AuditTrailEntityType["USER"] = "users";
     AuditTrailEntityType["PERMISSION"] = "permissions";
     AuditTrailEntityType["STATUS"] = "statuses";
+    AuditTrailEntityType["LABEL"] = "labels";
     AuditTrailEntityType["ADDITIONAL_DETAILS"] = "additional_details";
     AuditTrailEntityType["SUPPORTING_FILES"] = "supporting_files";
     AuditTrailEntityType["NOTES"] = "notes";

package/dist/labels/dto/index.d.ts

@@ -0,0 +1,18 @@
+import { LabelEntityTypes } from "../enum";
+export type LabelIdDto = {
+    labelId: string;
+};
+export type GetLabelsDto = {
+    entity: LabelEntityTypes;
+};
+export type AddLabelDto = {
+    name: string;
+    colour: string;
+    entity: LabelEntityTypes;
+    description?: string | null;
+};
+export type UpdateLabelDto = {
+    name: string;
+    colour: string;
+    description?: string | null;
+};

package/dist/labels/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/labels/enum/index.d.ts

@@ -0,0 +1,4 @@
+/** The entities a label catalogue exists for. Tasks only for now; a later entity adds a value. */
+export declare enum LabelEntityTypes {
+    TASK = "tasks"
+}

package/dist/labels/enum/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LabelEntityTypes = void 0;
+/** The entities a label catalogue exists for. Tasks only for now; a later entity adds a value. */
+var LabelEntityTypes;
+(function (LabelEntityTypes) {
+    LabelEntityTypes["TASK"] = "tasks";
+})(LabelEntityTypes || (exports.LabelEntityTypes = LabelEntityTypes = {}));
+;

package/dist/labels/index.d.ts

@@ -0,0 +1,13 @@
+import type { UUID } from 'crypto';
+/**
+ * A small coloured tag an organization defines for one entity type and pins to its rows -
+ * tasks for now. Like a status, a label is the organization's own catalogue entry: the
+ * row it is pinned to only references it.
+ */
+export type LabelEntity = {
+    mms_id: UUID;
+    name: string;
+    colour: string;
+    /** What the label is for, shown when hovering the chip; null when none was given. */
+    description: string | null;
+};

package/dist/labels/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/tasks/dto/index.d.ts

@@ -1,6 +1,15 @@
+import { TaskLinkType } from "../enum";
 export type TaskIdDto = {
     taskId: string;
 };
+export type TaskLinkIdDto = {
+    taskId: string;
+    linkedTaskId: string;
+};
+export type AddTaskLinkDto = {
+    linked_task_id: string;
+    link_type: TaskLinkType;
+};
 export type GetTasksDto = {
     search?: string | null;
     page: number;
@@ -18,6 +27,7 @@ export type GetTasksDto = {
     status_id_not_in?: string | null;
     completed?: boolean | null;
     priority_in?: string | null;
+    label_id_in?: string | null;
     archive: boolean;
 };
 export type CreateTaskDto = {
@@ -30,6 +40,7 @@ export type CreateTaskDto = {
     assigned_to_id?: string | null;
     project_id?: string | null;
     client_id?: string | null;
+    label_ids?: string[] | null;
 };
 export type UpdateTaskDto = {
     name: string;
@@ -41,4 +52,5 @@ export type UpdateTaskDto = {
     assigned_to_id?: string | null;
     project_id?: string | null;
     client_id?: string | null;
+    label_ids?: string[] | null;
 };

package/dist/tasks/enum/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * How one task is linked to another. A `child` link makes the linked task a subtask of the
+ * task it hangs off (a task has one parent at most); a `related` link has no direction and
+ * shows on both tasks.
+ */
+export declare enum TaskLinkType {
+    CHILD = "child",
+    RELATED = "related"
+}

package/dist/tasks/enum/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskLinkType = void 0;
+/**
+ * How one task is linked to another. A `child` link makes the linked task a subtask of the
+ * task it hangs off (a task has one parent at most); a `related` link has no direction and
+ * shows on both tasks.
+ */
+var TaskLinkType;
+(function (TaskLinkType) {
+    TaskLinkType["CHILD"] = "child";
+    TaskLinkType["RELATED"] = "related";
+})(TaskLinkType || (exports.TaskLinkType = TaskLinkType = {}));
+;

package/dist/tasks/index.d.ts

@@ -1,4 +1,5 @@
 import { ClientIdentity } from "../clients";
+import { LabelEntity } from "../labels";
 import { ProjectIdentity } from "../projects";
 import { StatusEntity } from "../status";
 import { UserIdentity } from "../users";
@@ -6,6 +7,17 @@ export type TaskIdentity = {
     mms_id: string;
     name: string;
 };
+/**
+ * A task as another task's link shows it: enough for a row with its reference, name, priority
+ * and status, and a click through to it.
+ */
+export type LinkedTask = {
+    mms_id: string;
+    task_number: number;
+    name: string;
+    status: StatusEntity | null;
+    priority: number;
+};
 export type TaskSummary = {
     mms_id: string;
     /** Sequential per organization, starting at 1; the human and integration-facing reference. */
@@ -14,6 +26,8 @@ export type TaskSummary = {
     start_date: Date;
     end_date: Date | null;
     status: StatusEntity | null;
+    /** The task's labels; empty when it has none. */
+    labels: LabelEntity[];
     priority: number;
     assigned_to: UserIdentity | null;
     project: ProjectIdentity | null;
@@ -31,10 +45,17 @@ export type TaskEntity = {
     start_date: Date;
     end_date: Date | null;
     status: StatusEntity | null;
+    labels: LabelEntity[];
     priority: number;
     assigned_to: UserIdentity | null;
     project: ProjectIdentity | null;
     client: ClientIdentity | null;
+    /** The task this one is a subtask of; null when it has none. */
+    parent: LinkedTask | null;
+    /** The tasks linked to this one as its subtasks. */
+    subtasks: LinkedTask[];
+    /** The tasks linked to this one as related, whichever task the link was made from. */
+    related: LinkedTask[];
     archived: boolean;
     archived_at: Date | null;
     archived_by: UserIdentity | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.24.0",
+  "version": "1.26.0",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {

package/dist/tasks/enum.ts/index.js

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