@clxmedia/types 1.0.195 → 1.0.196
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/tasks/index.d.ts +42 -33
- package/dist/core/tasks/index.js +0 -1
- package/package.json +2 -2
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { CLiQUserLocator, CLiQUserLocatorSlug } from "../auth";
|
|
2
2
|
import { CLXFormRuleSet } from "../clxforms";
|
|
3
3
|
import type { EnterpriseEventSlugs } from "../events";
|
|
4
|
-
export type CLXSortDirection =
|
|
4
|
+
export type CLXSortDirection = "asc" | "desc";
|
|
5
5
|
export type ISODateString = `${number}-${number}-${number}`;
|
|
6
|
-
export type CLXTaskStatus =
|
|
6
|
+
export type CLXTaskStatus = "pending" | "open" | "done";
|
|
7
7
|
export type CLXTaskFilter = {
|
|
8
8
|
cliq_user_locator_slug?: CLiQUserLocatorSlug;
|
|
9
9
|
my_tasks?: boolean;
|
|
@@ -50,27 +50,27 @@ export type CLXProjectInstance = {
|
|
|
50
50
|
archived_at: Date | null;
|
|
51
51
|
steps: CLXProjectStepInstance[];
|
|
52
52
|
};
|
|
53
|
-
export type CLXTaskActionType =
|
|
53
|
+
export type CLXTaskActionType = "create" | "activate" | "assign" | "comment" | "notify" | "start" | "reject" | "skip" | "complete" | "verify" | "close";
|
|
54
54
|
export type CLXTaskTargetNone = {
|
|
55
|
-
type:
|
|
55
|
+
type: "none";
|
|
56
56
|
};
|
|
57
|
-
export type CLXTaskTargetType =
|
|
57
|
+
export type CLXTaskTargetType = "snapshot" | "access_request" | "form_collab";
|
|
58
58
|
export type CLXTaskTarget = {
|
|
59
59
|
type: CLXTaskTargetType;
|
|
60
60
|
id: number;
|
|
61
61
|
};
|
|
62
62
|
export type TimeDelay = {
|
|
63
|
-
unit:
|
|
63
|
+
unit: "seconds" | "minutes" | "hours" | "days" | "business_days";
|
|
64
64
|
value: number;
|
|
65
|
-
} |
|
|
66
|
-
export type CLXTaskNotificationType =
|
|
65
|
+
} | "immediately";
|
|
66
|
+
export type CLXTaskNotificationType = "default" | "initial_notify" | "first_reminder" | "second_reminder" | "third_reminder" | "final_reminder" | "alert";
|
|
67
67
|
export type ProjectReminderScheduleEntry = {
|
|
68
68
|
reminder_type: string;
|
|
69
69
|
delay: TimeDelay;
|
|
70
70
|
recipients: ProjectReminderRecipients;
|
|
71
71
|
};
|
|
72
72
|
export type Origin = {
|
|
73
|
-
type:
|
|
73
|
+
type: "task" | "project_step" | "project";
|
|
74
74
|
id: number;
|
|
75
75
|
name: string;
|
|
76
76
|
entity: {
|
|
@@ -83,7 +83,7 @@ export type Origin = {
|
|
|
83
83
|
};
|
|
84
84
|
};
|
|
85
85
|
export type TaskNotificationRecipientLocator = CLiQUserLocator | {
|
|
86
|
-
type:
|
|
86
|
+
type: "current_assignee";
|
|
87
87
|
};
|
|
88
88
|
export type TaskNotificationRecipients = {
|
|
89
89
|
to: TaskNotificationRecipientLocator | TaskNotificationRecipientLocator[];
|
|
@@ -127,10 +127,10 @@ type OriginLocatorBase = {
|
|
|
127
127
|
id: number;
|
|
128
128
|
};
|
|
129
129
|
export type TaskOriginLocator = OriginLocatorBase & {
|
|
130
|
-
type:
|
|
130
|
+
type: "task";
|
|
131
131
|
};
|
|
132
132
|
export type ProjectOriginLocator = OriginLocatorBase & {
|
|
133
|
-
type:
|
|
133
|
+
type: "project_step" | "project";
|
|
134
134
|
};
|
|
135
135
|
export type OriginLocator = TaskOriginLocator | ProjectOriginLocator;
|
|
136
136
|
export type TaskReminderScheduleEntry = {
|
|
@@ -145,24 +145,24 @@ export type TaskReminderConfig = {
|
|
|
145
145
|
schedule: TaskReminderScheduleEntry[];
|
|
146
146
|
};
|
|
147
147
|
export type TaskActivateReminderConfig = TaskReminderConfig & {
|
|
148
|
-
target_status:
|
|
149
|
-
origin_status:
|
|
148
|
+
target_status: "activate";
|
|
149
|
+
origin_status: "create";
|
|
150
150
|
};
|
|
151
151
|
export type TaskStartReminderConfig = TaskReminderConfig & {
|
|
152
|
-
target_status:
|
|
153
|
-
origin_status:
|
|
152
|
+
target_status: "start";
|
|
153
|
+
origin_status: "activate";
|
|
154
154
|
};
|
|
155
155
|
export type TaskCompleteReminderConfig = TaskReminderConfig & {
|
|
156
|
-
target_status:
|
|
157
|
-
origin_status:
|
|
156
|
+
target_status: "complete";
|
|
157
|
+
origin_status: "start";
|
|
158
158
|
};
|
|
159
159
|
export type TaskVerifyReminderConfig = TaskReminderConfig & {
|
|
160
|
-
target_status:
|
|
161
|
-
origin_status:
|
|
160
|
+
target_status: "verify";
|
|
161
|
+
origin_status: "complete";
|
|
162
162
|
};
|
|
163
163
|
export type TaskCloseReminderConfig = TaskReminderConfig & {
|
|
164
|
-
target_status:
|
|
165
|
-
origin_status:
|
|
164
|
+
target_status: "close";
|
|
165
|
+
origin_status: "verify";
|
|
166
166
|
};
|
|
167
167
|
export type TaskReminderScheduleConfig = {
|
|
168
168
|
activate?: TaskActivateReminderConfig;
|
|
@@ -174,16 +174,16 @@ export type TaskReminderScheduleConfig = {
|
|
|
174
174
|
export type TaskReminderConfigTypes = TaskActivateReminderConfig | TaskStartReminderConfig | TaskCompleteReminderConfig | TaskVerifyReminderConfig | TaskCloseReminderConfig;
|
|
175
175
|
export type ProjectReminderConfigTypes = ProjectActivateReminderConfig | ProjectCompleteReminderConfig | ProjectArchiveReminderConfig;
|
|
176
176
|
export type ProjectActivateReminderConfig = ProjectReminderConfig & {
|
|
177
|
-
target_status:
|
|
178
|
-
origin_status:
|
|
177
|
+
target_status: "activate";
|
|
178
|
+
origin_status: "create";
|
|
179
179
|
};
|
|
180
180
|
export type ProjectCompleteReminderConfig = ProjectReminderConfig & {
|
|
181
|
-
target_status:
|
|
182
|
-
origin_status:
|
|
181
|
+
target_status: "complete";
|
|
182
|
+
origin_status: "activate";
|
|
183
183
|
};
|
|
184
184
|
export type ProjectArchiveReminderConfig = ProjectReminderConfig & {
|
|
185
|
-
target_status:
|
|
186
|
-
origin_status:
|
|
185
|
+
target_status: "archive";
|
|
186
|
+
origin_status: "complete";
|
|
187
187
|
};
|
|
188
188
|
export type ProjectReminderScheduleConfig = {
|
|
189
189
|
activate?: ProjectActivateReminderConfig;
|
|
@@ -195,7 +195,7 @@ export type ProjectReminderConfig = {
|
|
|
195
195
|
template_slug: string;
|
|
196
196
|
schedule: ProjectReminderScheduleEntry[];
|
|
197
197
|
};
|
|
198
|
-
export type CLXPriority =
|
|
198
|
+
export type CLXPriority = "low" | "normal" | "urgent";
|
|
199
199
|
export type CLXTaskChecklistItem = {
|
|
200
200
|
guid: string;
|
|
201
201
|
description: string;
|
|
@@ -215,11 +215,11 @@ export type CLXTaskMetaData = {
|
|
|
215
215
|
priority?: CLXPriority;
|
|
216
216
|
checklist?: CLXTaskChecklistItem[];
|
|
217
217
|
};
|
|
218
|
-
export type CLXTaskTriggerConstraint =
|
|
218
|
+
export type CLXTaskTriggerConstraint = "event_user_to_onboarding_recipient_match" | "project_id_match";
|
|
219
219
|
export type CLXTaskTriggerConfig = {
|
|
220
220
|
constraints: CLXTaskTriggerConstraint[];
|
|
221
221
|
};
|
|
222
|
-
export type CLXTaskTriggerAction =
|
|
222
|
+
export type CLXTaskTriggerAction = "activate" | "start" | "complete" | "close" | "require" | "optional" | "delete";
|
|
223
223
|
export type CLXTaskTrigger = {
|
|
224
224
|
trigger_slug: EnterpriseEventSlugs;
|
|
225
225
|
action_type: CLXTaskTriggerAction;
|
|
@@ -235,7 +235,7 @@ export type CLXTaskBase = {
|
|
|
235
235
|
slug: string;
|
|
236
236
|
is_active: boolean;
|
|
237
237
|
};
|
|
238
|
-
export type CLXTaskResolution =
|
|
238
|
+
export type CLXTaskResolution = "done" | "skipped" | "none";
|
|
239
239
|
export type CLXTask = CLXTaskBase & {
|
|
240
240
|
id: number;
|
|
241
241
|
is_required: boolean;
|
|
@@ -274,11 +274,20 @@ export type CLXTaskWithStatus = CLXTask & {
|
|
|
274
274
|
completed_at: Date | null;
|
|
275
275
|
verified_at: Date | null;
|
|
276
276
|
skipped_at: Date | null;
|
|
277
|
-
responsibility:
|
|
277
|
+
responsibility: "internal" | "external";
|
|
278
278
|
status: CLXTaskStatus;
|
|
279
279
|
};
|
|
280
280
|
export type CLXTaskWithHistory = CLXTaskWithStatus & {
|
|
281
281
|
history: CLXTaskHistoryEntry[];
|
|
282
|
+
project_step?: {
|
|
283
|
+
id: number;
|
|
284
|
+
name: string;
|
|
285
|
+
project: {
|
|
286
|
+
id: number;
|
|
287
|
+
name: string;
|
|
288
|
+
slug: string;
|
|
289
|
+
};
|
|
290
|
+
};
|
|
282
291
|
};
|
|
283
292
|
export type TaskHistoryArchive = {
|
|
284
293
|
id: number;
|
package/dist/core/tasks/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clxmedia/types",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.196",
|
|
4
4
|
"description": "Conversion Logix TypeScript type definitions",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -106,4 +106,4 @@
|
|
|
106
106
|
"url": "git+https://github.com/adsupnow/clxmedia-type-definitions.git"
|
|
107
107
|
},
|
|
108
108
|
"bugs": "https://github.com/adsupnow/clxmedia-type-definitions"
|
|
109
|
-
}
|
|
109
|
+
}
|