@clxmedia/types 1.0.203 → 1.0.205

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

@@ -1,5 +1,5 @@
 import type { CLiQUserLocator, CLiQUserLocatorSlug } from "../auth";
-import type { CLXFormRuleSet } from "../clxforms";
+import { CLXFormRuleSet } from "../clxforms";
 import type { EnterpriseEventSlugs } from "../events";
 export type CLXSortDirection = "asc" | "desc";
 export type ISODateString = `${number}-${number}-${number}`;
@@ -10,6 +10,7 @@ export type CLXTaskFilter = {
     master_id?: number;
     include_closed?: boolean;
     slug?: string;
+    awaiting_verification?: boolean;
     take?: number;
     skip?: number;
     sort_by?: string;
@@ -21,13 +22,13 @@ export type PagedResult<T> = {
     take: number;
     skip: number;
 };
-export type CLXProjectActionType = "create" | "activate" | "complete" | "notify" | "archive";
+export type CLXProjectActionType = "activate" | "complete" | "create" | "notify" | "archive";
 export type CLXProjectStepInstance = {
     id: number;
     project_id: number;
     name: string;
     status: CLXTaskStatus;
-    project_tasks: CLXTask[];
+    project_tasks: CLXTaskWithStatus[];
 };
 export type CLXUserInstance = {
     id: number;
@@ -49,7 +50,7 @@ export type CLXProjectInstance = {
     archived_at: Date | null;
     steps: CLXProjectStepInstance[];
 };
-export type CLXTaskActionType = "create" | "activate" | "assign" | "comment" | "notify" | "skip" | "complete";
+export type CLXTaskActionType = "create" | "activate" | "assign" | "comment" | "notify" | "start" | "reject" | "skip" | "complete" | "verify" | "close";
 export type CLXTaskTargetNone = {
     type: "none";
 };
@@ -144,37 +145,57 @@ export type TaskReminderConfig = {
     schedule: TaskReminderScheduleEntry[];
 };
 export type TaskActivateReminderConfig = TaskReminderConfig & {
-    origin_status: "create";
     target_status: "activate";
+    origin_status: "create";
 };
-export type TaskCompleteReminderConfig = TaskReminderConfig & {
+export type TaskStartReminderConfig = TaskReminderConfig & {
+    target_status: "start";
     origin_status: "activate";
+};
+export type TaskCompleteReminderConfig = TaskReminderConfig & {
     target_status: "complete";
+    origin_status: "start";
+};
+export type TaskVerifyReminderConfig = TaskReminderConfig & {
+    target_status: "verify";
+    origin_status: "complete";
+};
+export type TaskCloseReminderConfig = TaskReminderConfig & {
+    target_status: "close";
+    origin_status: "verify";
 };
 export type TaskReminderScheduleConfig = {
     activate?: TaskActivateReminderConfig;
+    start?: TaskStartReminderConfig;
     complete?: TaskCompleteReminderConfig;
+    verify?: TaskVerifyReminderConfig;
+    close?: TaskCloseReminderConfig;
 };
-export type TaskReminderConfigTypes = TaskActivateReminderConfig | TaskCompleteReminderConfig;
-export type ProjectReminderConfigTypes = ProjectActivateReminderConfig | ProjectCompleteReminderConfig;
+export type TaskReminderConfigTypes = TaskActivateReminderConfig | TaskStartReminderConfig | TaskCompleteReminderConfig | TaskVerifyReminderConfig | TaskCloseReminderConfig;
+export type ProjectReminderConfigTypes = ProjectActivateReminderConfig | ProjectCompleteReminderConfig | ProjectArchiveReminderConfig;
 export type ProjectActivateReminderConfig = ProjectReminderConfig & {
-    origin_status: "create";
     target_status: "activate";
+    origin_status: "create";
 };
 export type ProjectCompleteReminderConfig = ProjectReminderConfig & {
-    origin_status: "activate";
     target_status: "complete";
+    origin_status: "activate";
+};
+export type ProjectArchiveReminderConfig = ProjectReminderConfig & {
+    target_status: "archive";
+    origin_status: "complete";
 };
 export type ProjectReminderScheduleConfig = {
     activate?: ProjectActivateReminderConfig;
     complete?: ProjectCompleteReminderConfig;
+    archive?: ProjectArchiveReminderConfig;
 };
 export type ProjectReminderConfig = {
     origin_status: CLXProjectActionType;
     template_slug: string;
     schedule: ProjectReminderScheduleEntry[];
 };
-export type CLXPriority = number;
+export type CLXPriority = "low" | "normal" | "urgent";
 export type CLXTaskChecklistItem = {
     guid: string;
     description: string;
@@ -182,6 +203,7 @@ export type CLXTaskChecklistItem = {
     is_done: boolean;
 };
 export type CLXTaskMetaData = {
+    verifier: CLiQUserLocator | null;
     resource?: {
         path: string;
         label: string;
@@ -191,12 +213,13 @@ export type CLXTaskMetaData = {
     notifications?: TaskNotificationConfig[];
     due_date?: ISODateString;
     priority?: CLXPriority;
+    checklist?: CLXTaskChecklistItem[];
 };
 export type CLXTaskTriggerConstraint = "event_user_to_onboarding_recipient_match" | "project_id_match";
 export type CLXTaskTriggerConfig = {
     constraints: CLXTaskTriggerConstraint[];
 };
-export type CLXTaskTriggerAction = "activate" | "skip" | "complete" | "require" | "optional" | "delete";
+export type CLXTaskTriggerAction = "activate" | "start" | "complete" | "close" | "require" | "optional" | "delete";
 export type CLXTaskTrigger = {
     trigger_slug: EnterpriseEventSlugs;
     action_type: CLXTaskTriggerAction;
@@ -210,39 +233,28 @@ export type CLXTaskBase = {
     id: number;
     name: string;
     slug: string;
+    is_active: boolean;
 };
 export type CLXTaskResolution = "done" | "skipped" | "none";
-export type CLXTaskTag = {
-    id: number;
-    task_id: number;
-    name: string;
-    added_by_user_id?: number;
-    comment?: string;
-    created_at: Date;
-};
 export type CLXTask = CLXTaskBase & {
     id: number;
     is_required: boolean;
     conditions: CLXFormRuleSet | any;
     project_step_id?: number;
+    updated_at?: Date;
+    requires_verification: boolean;
+    depends_on?: CLXTaskBase;
     internal_only: boolean;
     meta_data?: CLXTaskMetaData;
     description?: string;
     instructions?: string;
-    due_at: Date | null;
     created_at: Date;
-    updated_at?: Date;
     closed_at: Date | null;
     master_id: number;
     entity_name: string;
     assignment: CLiQUserLocator | null;
     target: CLXTaskTargetNone | CLXTaskTarget;
     resolution: CLXTaskResolution;
-    priority: number;
-    activated_at: Date | null;
-    responsibility: "internal" | "external";
-    status: CLXTaskStatus;
-    tags: CLXTaskTag[];
 };
 export type CLXTaskHistoryEntry = {
     id: number;
@@ -256,26 +268,17 @@ export type CLXTaskHistoryEntry = {
         email: string;
     };
 };
-export type TaskChecklistItem = {
-    id: number;
-    task_id: number;
-    description: string;
-    required: boolean;
-    completed_by: number | null;
-    order_num: number;
+export type CLXTaskWithStatus = CLXTask & {
+    activated_at: Date | null;
+    started_at: Date | null;
+    completed_at: Date | null;
+    verified_at: Date | null;
+    skipped_at: Date | null;
+    responsibility: "internal" | "external";
+    status: CLXTaskStatus;
 };
-export type CLXTaskWithHistory = CLXTask & {
+export type CLXTaskWithHistory = CLXTaskWithStatus & {
     history: CLXTaskHistoryEntry[];
-    checklist?: TaskChecklistItem[];
-    project_step?: {
-        id: number;
-        name: string;
-        project: {
-            id: number;
-            name: string;
-            slug: string;
-        };
-    };
 };
 export type TaskHistoryArchive = {
     id: number;
@@ -292,7 +295,9 @@ export type TaskArchive = {
     name: string;
     created_at: Date;
     is_required: boolean;
+    requires_verification: boolean;
     activated_at: Date;
+    completed_at: Date;
     closed_at: Date;
     resolution: string;
     history: TaskHistoryArchive[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/types",
-  "version": "1.0.203",
+  "version": "1.0.205",
   "description": "Conversion Logix TypeScript type definitions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",