@clxmedia/types 1.0.138 → 1.0.140

package/dist/core/index.d.ts

@@ -4,4 +4,3 @@ export * as eventlog from './eventlog';
 export * as events from './events';
 export * as auth from './auth';
 export * as tasks from './tasks';
-export * as projects from './projects';

package/dist/core/index.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.projects = exports.tasks = exports.auth = exports.events = exports.eventlog = exports.clxforms = exports.credstore = void 0;
+exports.tasks = exports.auth = exports.events = exports.eventlog = exports.clxforms = exports.credstore = void 0;
 exports.credstore = require("./credstore");
 exports.clxforms = require("./clxforms");
 exports.eventlog = require("./eventlog");
 exports.events = require("./events");
 exports.auth = require("./auth");
 exports.tasks = require("./tasks");
-exports.projects = require("./projects");

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

@@ -34,6 +34,34 @@ export type PagedResult<T> = {
     take: number;
     skip: number;
 };
+export type CLXProjectActionType = "activate" | "complete" | "create" | "notify" | "archive";
+export type CLXProjectStepInstance = {
+    id: number;
+    project_id: number;
+    name: string;
+    status: CLXTaskStatus;
+    project_tasks: CLXTaskWithStatus[];
+};
+export type CLXUserInstance = {
+    id: number;
+    email: string;
+    name: string;
+};
+export type CLXProjectDetails = {
+    implementation_specialist?: CLXUserInstance;
+    client_service_analyst?: CLXUserInstance;
+};
+export type CLXProjectInstance = {
+    id: number;
+    master_id: number;
+    name: string;
+    slug: string;
+    details?: CLXProjectDetails;
+    created_at: Date;
+    updated_at: Date;
+    archived_at: Date | null;
+    steps: CLXProjectStepInstance[];
+};
 export type CLXTaskActionType = 'create' | 'activate' | 'assign' | 'comment' | 'notify' | 'start' | 'reject' | 'skip' | 'complete' | 'verify' | 'close';
 export type CLXTaskTargetNone = {
     type: 'none';
@@ -47,27 +75,157 @@ export type TimeDelay = {
     value: number;
 } | 'immediately';
 export type CLXTaskNotificationType = 'default' | 'initial_notify' | 'first_reminder' | 'second_reminder' | 'third_reminder' | 'final_reminder' | 'alert';
-export type CLXTaskReminderScheduleEntry = {
+export type ProjectReminderScheduleEntry = {
+    reminder_type: string;
     delay: TimeDelay;
-    type: 'start' | 'complete' | 'verify';
-    notificationSlug: string;
-    notificationType: CLXTaskNotificationType;
-    recipient: CLXTaskAssignment | 'current_assignee';
-};
-export type CLXTaskNotificationDefinition = {
-    on_action: CLXTaskActionType;
-    recipient: CLXTaskAssignment;
-    notificationSlug: string;
+    recipients: ProjectReminderRecipients;
+};
+export type Origin = {
+    type: 'task' | 'project_step' | 'project';
+    id: number;
+    name: string;
+    entity: {
+        master_id: number;
+        name: string;
+    };
+    resource?: {
+        label: string;
+        path: string;
+    };
+};
+export type ProjectNotificationRecipients = {
+    to: ProjectNotificationRecipientLocator;
+    cc?: ProjectNotificationRecipientLocator;
+    bcc?: ProjectNotificationRecipientLocator;
+};
+export type TaskNotificationRecipients = {
+    to: TaskNotificationRecipientLocator;
+    cc?: TaskNotificationRecipientLocator;
+    bcc?: TaskNotificationRecipientLocator;
+};
+export type NotificationRecipientType = 'user' | 'group' | 'right';
+export type NotificationRecipientLocator = {
+    recipientType: NotificationRecipientType;
+    recipient: string | null;
+};
+export type ProjectNotificationRecipientType = 'user' | 'group' | 'right' | 'role';
+export type TaskNotificationRecipientType = 'user' | 'group' | 'right' | 'role' | 'current_assignee';
+export type TaskNotificationRecipientLocator = {
+    recipientType: TaskNotificationRecipientType;
+    recipient: string;
+};
+export type ProjectNotificationRecipientLocator = {
+    recipientType: ProjectNotificationRecipientType;
+    recipient: string;
+};
+export type TaskNotificationConfig = {
+    onAction: CLXTaskActionType;
+    templateSlug: string;
+    recipients: TaskNotificationRecipients;
     repeatable: boolean;
 };
+export type ProjectNotificationConfig = {
+    onAction: CLXProjectActionType;
+    templateSlug: string;
+    recipients: ProjectNotificationRecipients;
+    repeatable: boolean;
+};
+export type ProjectNotificationConfigs = {
+    configs: ProjectNotificationConfig[];
+};
+export type ProjectReminderRecipients = {
+    to: ProjectNotificationRecipientLocator;
+    cc?: ProjectNotificationRecipientLocator;
+    bcc?: ProjectNotificationRecipientLocator;
+};
+export type TaskReminderRecipients = {
+    to: TaskNotificationRecipientLocator;
+    cc?: TaskNotificationRecipientLocator;
+    bcc?: TaskNotificationRecipientLocator;
+};
+export type ReminderRecipients = TaskReminderRecipients | ProjectReminderRecipients;
+type OriginLocatorBase = {
+    type?: string;
+    origin_time: number;
+    id: number;
+};
+export type TaskOriginLocator = OriginLocatorBase & {
+    type: 'task';
+};
+export type ProjectOriginLocator = OriginLocatorBase & {
+    type: 'project_step' | 'project';
+};
+export type OriginLocator = TaskOriginLocator | ProjectOriginLocator;
+export type TaskReminderScheduleEntry = {
+    reminder_type: CLXTaskNotificationType;
+    delay: TimeDelay;
+    recipients: TaskReminderRecipients;
+};
+export type ReminderScheduleEntry = TaskReminderScheduleEntry | ProjectReminderScheduleEntry;
+export type TaskReminderConfig = {
+    origin_status: CLXTaskActionType;
+    template_slug: string;
+    schedule: TaskReminderScheduleEntry[];
+};
+export type TaskActivateReminderConfig = TaskReminderConfig & {
+    target_status: 'activate';
+    origin_status: 'create';
+};
+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 | TaskStartReminderConfig | TaskCompleteReminderConfig | TaskVerifyReminderConfig | TaskCloseReminderConfig;
+export type ProjectReminderConfigTypes = ProjectActivateReminderConfig | ProjectCompleteReminderConfig | ProjectArchiveReminderConfig;
+export type ProjectActivateReminderConfig = ProjectReminderConfig & {
+    target_status: 'activate';
+    origin_status: 'create';
+};
+export type ProjectCompleteReminderConfig = ProjectReminderConfig & {
+    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 CLXTaskMetaData = {
     verifier: CLXTaskAssignment | null;
     resource?: {
         path: string;
         label: string;
     };
-    reminder_schedule?: CLXTaskReminderScheduleEntry[];
-    notifications?: CLXTaskNotificationDefinition[];
+    reminders?: TaskReminderScheduleConfig;
+    notifications?: TaskNotificationConfig[];
 };
 export type CLXTaskTriggerConstraint = 'event_user_to_onboarding_recipient_match' | 'project_id_match';
 export type CLXTaskTriggerConfig = {
@@ -132,3 +290,26 @@ export type CLXTaskWithHistory = CLXTaskWithStatus & {
     history: CLXTaskHistoryEntry[];
     triggers: CLXTaskTrigger[];
 };
+export type TaskHistoryArchive = {
+    id: number;
+    action_type: CLXTaskActionType;
+    action_by_user: string;
+    description?: string;
+    action_slug?: string;
+    created_at: Date;
+};
+export type TaskArchive = {
+    id: number;
+    slug: string;
+    master_id: number;
+    name: string;
+    created_at: Date;
+    is_required: boolean;
+    requires_verification: boolean;
+    activated_at: Date;
+    completed_at: Date;
+    closed_at: Date;
+    resolution: string;
+    history: TaskHistoryArchive[];
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/types",
-  "version": "1.0.138",
+  "version": "1.0.140",
   "description": "Conversion Logix TypeScript type definitions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,10 +25,6 @@
       "types": "./dist/core/tasks/index.d.ts",
       "default": "./dist/core/tasks/index.js"
     },
-    "./core/projects": {
-      "types": "./dist/core/projects/index.d.ts",
-      "default": "./dist/core/projects/index.js"
-    },
     "./core/clxforms": {
       "types": "./dist/core/clxforms/index.d.ts",
       "default": "./dist/core/clxforms/index.js"
@@ -65,9 +61,6 @@
       "core/tasks": [
         "dist/core/tasks/index.d.ts"
       ],
-      "core/projects": [
-        "dist/core/projects/index.d.ts"
-      ],
       "core/clxforms": [
         "dist/core/clxforms/index.d.ts"
       ],

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

@@ -1,38 +0,0 @@
-import type { EnterpriseEventSlugs } from "../events";
-import type { CLXTaskAssignment, CLXTaskWithStatus } from "../tasks";
-export type CLXProjectStepInstance = {
-    id: number;
-    project_id: number;
-    name: string;
-    project_tasks: CLXTaskWithStatus[];
-};
-export type CLXUserInstance = {
-    id: number;
-    email: string;
-    name: string;
-};
-export type CLXProjectDetails = {
-    implementation_specialist?: CLXUserInstance;
-    client_service_analyst?: CLXUserInstance;
-};
-export type CLXProjectNotificationDefinition = {
-    id: number;
-    on_event_slug: EnterpriseEventSlugs;
-    recipient: CLXTaskAssignment;
-    notificationSlug: string;
-    repeatable: boolean;
-    created_at: Date;
-    sent_at: Date | null;
-}[];
-export type CLXProjectInstance = {
-    id: number;
-    master_id: number;
-    name: string;
-    slug: string;
-    notifications?: CLXProjectNotificationDefinition[];
-    details?: CLXProjectDetails;
-    created_at: Date;
-    updated_at: Date;
-    archived_at: Date | null;
-    steps: CLXProjectStepInstance[];
-};

package/dist/core/projects/index.js

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