evo360-types 1.3.141 → 1.3.144

package/dist/types/evo-task/index.d.ts

@@ -1,94 +1,228 @@
 export * from "./fb_collections";
 import type { FirestoreDocumentReference, IFireDoc, ITag } from "../shared";
-export type TaskAction = "CREATE_TASK" | "DELETE_TASK" | "UPDATE_TASK";
-export declare enum ITaskAction {
-    Create_task = "CREATE_TASK",
-    Delete_task = "DELETE_TASK",
-    Update_task = "UPDATE_TASK"
-}
-export type TaskStatus = "not_started" | "in_progress" | "completed" | "cancelled" | "on_hold";
-export declare enum ITaskStatus {
-    NotStarted = "not_started",
-    InProgress = "in_progress",
-    Completed = "completed",
-    Cancelled = "cancelled",
-    OnHold = "on_hold"
-}
-export type TaskPriority = "low" | "medium" | "high";
-export declare enum ITaskPriority {
-    Low = "low",
-    Medium = "medium",
-    High = "high"
+export declare const EvoTaskCollections: {
+    readonly Tasks: "tasks";
+    readonly Executions: "executions";
+    readonly Comments: "comments";
+    readonly Logs: "logs";
+};
+export type EvoTaskCollectionName = (typeof EvoTaskCollections)[keyof typeof EvoTaskCollections];
+export declare const TaskActionEnum: {
+    readonly CreateTask: "CREATE_TASK";
+    readonly DeleteTask: "DELETE_TASK";
+    readonly UpdateTask: "UPDATE_TASK";
+};
+export type TaskAction = (typeof TaskActionEnum)[keyof typeof TaskActionEnum];
+export declare const TaskStatusEnum: {
+    readonly NotStarted: "not_started";
+    readonly InProgress: "in_progress";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Cancelled: "cancelled";
+    readonly OnHold: "on_hold";
+    readonly Suppressed: "suppressed";
+};
+export type TaskStatus = (typeof TaskStatusEnum)[keyof typeof TaskStatusEnum];
+export declare const TaskPriorityEnum: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+export type TaskPriority = (typeof TaskPriorityEnum)[keyof typeof TaskPriorityEnum];
+export declare const TaskSourceEnum: {
+    readonly User: "user";
+    readonly AutomationHub: "automation_hub";
+    readonly System: "system";
+};
+export type TaskSource = (typeof TaskSourceEnum)[keyof typeof TaskSourceEnum];
+export declare const TaskModeEnum: {
+    readonly Human: "human";
+    readonly Auto: "auto";
+};
+export type TaskMode = (typeof TaskModeEnum)[keyof typeof TaskModeEnum];
+export declare const TaskAutoHandlerEnum: {
+    readonly Notifications: "notifications";
+    readonly AIAgent: "ai_agent";
+    readonly Invoices: "invoices";
+    readonly Webhook: "webhook";
+    readonly Custom: "custom";
+};
+export type TaskAutoHandler = (typeof TaskAutoHandlerEnum)[keyof typeof TaskAutoHandlerEnum];
+export declare const TaskRetryStrategyEnum: {
+    readonly Fixed: "fixed";
+    readonly Exponential: "exponential";
+};
+export type TaskRetryStrategy = (typeof TaskRetryStrategyEnum)[keyof typeof TaskRetryStrategyEnum];
+export interface ITaskRetryPolicy {
+    max_attempts: number;
+    attempt: number;
+    strategy: TaskRetryStrategy;
+    backoff_seconds: number;
+    next_attempt_at?: Date;
+    last_error?: {
+        message: string;
+        code?: string | number;
+        at: Date;
+        details?: Record<string, unknown>;
+    };
+    [key: string]: unknown;
 }
-export type IATaskType = "data_analysis" | "content_generation" | "classification" | "extraction" | "summarization" | "translation" | "sentiment_analysis" | "question_answering" | "send_reminder" | "request_contact_info" | "request_operator_info" | "confirm_appointment" | "send_documents" | "create_appointment" | "reschedule_appointment" | "cancel_appointment" | "financial_charge" | "custom";
-export declare enum IIATaskType {
-    DataAnalysis = "data_analysis",
-    ContentGeneration = "content_generation",
-    Classification = "classification",
-    Extraction = "extraction",
-    Summarization = "summarization",
-    Translation = "translation",
-    SentimentAnalysis = "sentiment_analysis",
-    QuestionAnswering = "question_answering",
-    SendReminder = "send_reminder",
-    RequestContactInfo = "request_contact_info",
-    RequestOperatorInfo = "request_operator_info",
-    ConfirmAppointment = "confirm_appointment",
-    SendDocuments = "send_documents",
-    CreateAppointment = "create_appointment",
-    RescheduleAppointment = "reschedule_appointment",
-    CancelAppointment = "cancel_appointment",
-    FinancialCharge = "financial_charge",
-    Custom = "custom"
+export interface ITaskLock {
+    locked_by: string;
+    lock_until: Date;
+    [key: string]: unknown;
 }
-export type TaskExternalObjectType = "crm_lead" | "med_patient" | "med_professional" | "med_appointment" | "chat_contact";
-export declare enum ITaskExternalObjectType {
-    CrmLead = "crm_lead",
-    MedPatient = "med_patient",
-    MedProfessional = "med_professional",
-    MedAppointment = "med_appointment",
-    ChatContact = "chat_contact"
+export declare const TaskDedupScopeEnum: {
+    readonly PerRecipient: "per_recipient";
+    readonly PerRecipientAndObject: "per_recipient_and_object";
+    readonly Custom: "custom";
+};
+export type TaskDedupScope = (typeof TaskDedupScopeEnum)[keyof typeof TaskDedupScopeEnum];
+export declare const TaskDedupWindowEnum: {
+    readonly SameDay: "same_day";
+    readonly NHours: "n_hours";
+    readonly Custom: "custom";
+};
+export type TaskDedupWindow = (typeof TaskDedupWindowEnum)[keyof typeof TaskDedupWindowEnum];
+export interface ITaskDedup {
+    enabled: boolean;
+    key: string;
+    group_key?: string;
+    scope?: TaskDedupScope;
+    window?: TaskDedupWindow;
+    window_hours?: number;
+    importance?: number;
+    [key: string]: unknown;
 }
+export declare const TaskExternalObjectTypeEnum: {
+    readonly CrmLead: "crm_lead";
+    readonly MedPatient: "med_patient";
+    readonly MedProfessional: "med_professional";
+    readonly MedAppointment: "med_appointment";
+    readonly ChatContact: "chat_contact";
+};
+export type TaskExternalObjectType = (typeof TaskExternalObjectTypeEnum)[keyof typeof TaskExternalObjectTypeEnum];
 export interface ITaskExternalLink {
     type: TaskExternalObjectType;
     id: string;
+    label?: string;
+    [key: string]: unknown;
+}
+export interface ITaskUserAssignee {
+    kind: "user";
+    name?: string;
+    ref?: FirestoreDocumentReference;
+    [key: string]: unknown;
+}
+export interface ITaskSchedule {
+    execute_at?: Date;
+    due_at?: Date;
+    timezone?: string;
+    [key: string]: unknown;
+}
+export interface ITaskAutoSpec {
+    handler: TaskAutoHandler;
+    kind: string;
+    version?: number | string;
+    payload: Record<string, unknown>;
+    idempotency_key?: string;
     [key: string]: unknown;
 }
-export interface ITask extends IFireDoc {
+export interface ITaskOnFailure {
+    handoff_to_user?: {
+        name?: string;
+        ref?: FirestoreDocumentReference;
+    };
+    create_handoff_task?: {
+        title?: string;
+        description?: string;
+        priority?: TaskPriority;
+        tags?: ITag[] | null;
+    };
+    auto_fallbacks?: Array<{
+        handler: TaskAutoHandler;
+        kind: string;
+        payload: Record<string, unknown>;
+    }>;
+    [key: string]: unknown;
+}
+export interface ITaskBase extends IFireDoc {
     title: string;
     description?: string;
-    creatorName: string;
-    creatorRef?: FirestoreDocumentReference;
-    startDate: Date;
-    dueDate?: Date;
     status: TaskStatus;
     priority?: TaskPriority;
-    assigneeName?: string;
-    assigneeRef?: FirestoreDocumentReference;
+    importance?: number;
+    source: TaskSource;
+    creator: {
+        name: string;
+        ref?: FirestoreDocumentReference;
+    };
+    schedule?: ITaskSchedule;
     tags?: ITag[] | null;
-    ia_assigned?: boolean;
-    ia_agent?: string;
-    ia_duescheduled?: Date;
-    ia_task_type?: IATaskType;
-    ia_result?: string;
-    ia_result_code?: number;
-    ia_started_at?: Date;
-    ia_completed_at?: Date;
-    ia_error?: string;
-    ia_retry_count?: number;
-    ia_metadata?: Record<string, unknown>;
-    ia_prompt?: string;
-    ia_model?: string;
-    ia_progress?: number;
     externalLinks?: ITaskExternalLink[];
+    idempotency_key?: string;
+    dedup?: ITaskDedup;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export interface IHumanTask extends ITaskBase {
+    mode: "human";
+    assignee?: ITaskUserAssignee;
+}
+export interface IAutoTask extends ITaskBase {
+    mode: "auto";
+    schedule: ITaskSchedule & {
+        execute_at: Date;
+    };
+    lock?: ITaskLock;
+    retry?: ITaskRetryPolicy;
+    on_failure?: ITaskOnFailure;
+    auto: ITaskAutoSpec;
+}
+export type ITask = IHumanTask | IAutoTask;
+export declare const TaskExecutionStatusEnum: {
+    readonly Success: "success";
+    readonly Error: "error";
+    readonly Retry: "retry";
+};
+export type TaskExecutionStatus = (typeof TaskExecutionStatusEnum)[keyof typeof TaskExecutionStatusEnum];
+export interface ITaskExecution extends IFireDoc {
+    taskId: string;
+    handler: TaskAutoHandler;
+    kind: string;
+    status: TaskExecutionStatus;
+    attempt: number;
+    started_at: Date;
+    completed_at?: Date;
+    result?: Record<string, unknown>;
+    error?: {
+        message: string;
+        code?: string | number;
+        details?: Record<string, unknown>;
+    };
+    provider?: {
+        name?: string;
+        message_id?: string;
+        [key: string]: unknown;
+    };
     [key: string]: unknown;
 }
 export interface ITaskComment extends IFireDoc {
     taskId: string;
     text: string;
-    authorName: string;
-    authorRef?: FirestoreDocumentReference;
+    author: {
+        name: string;
+        ref?: FirestoreDocumentReference;
+    };
     edited?: boolean;
     edited_at?: Date;
     [key: string]: unknown;
 }
+export interface ITaskLog extends IFireDoc {
+    taskId: string;
+    level: "debug" | "info" | "warn" | "error";
+    message: string;
+    data?: Record<string, unknown>;
+    at: Date;
+    [key: string]: unknown;
+}

package/dist/types/evo-task/index.js

@@ -14,54 +14,96 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ITaskExternalObjectType = exports.IIATaskType = exports.ITaskPriority = exports.ITaskStatus = exports.ITaskAction = void 0;
+exports.TaskExecutionStatusEnum = exports.TaskExternalObjectTypeEnum = exports.TaskDedupWindowEnum = exports.TaskDedupScopeEnum = exports.TaskRetryStrategyEnum = exports.TaskAutoHandlerEnum = exports.TaskModeEnum = exports.TaskSourceEnum = exports.TaskPriorityEnum = exports.TaskStatusEnum = exports.TaskActionEnum = exports.EvoTaskCollections = void 0;
 __exportStar(require("./fb_collections"), exports);
-var ITaskAction;
-(function (ITaskAction) {
-    ITaskAction["Create_task"] = "CREATE_TASK";
-    ITaskAction["Delete_task"] = "DELETE_TASK";
-    ITaskAction["Update_task"] = "UPDATE_TASK";
-})(ITaskAction || (exports.ITaskAction = ITaskAction = {}));
-var ITaskStatus;
-(function (ITaskStatus) {
-    ITaskStatus["NotStarted"] = "not_started";
-    ITaskStatus["InProgress"] = "in_progress";
-    ITaskStatus["Completed"] = "completed";
-    ITaskStatus["Cancelled"] = "cancelled";
-    ITaskStatus["OnHold"] = "on_hold";
-})(ITaskStatus || (exports.ITaskStatus = ITaskStatus = {}));
-var ITaskPriority;
-(function (ITaskPriority) {
-    ITaskPriority["Low"] = "low";
-    ITaskPriority["Medium"] = "medium";
-    ITaskPriority["High"] = "high";
-})(ITaskPriority || (exports.ITaskPriority = ITaskPriority = {}));
-var IIATaskType;
-(function (IIATaskType) {
-    IIATaskType["DataAnalysis"] = "data_analysis";
-    IIATaskType["ContentGeneration"] = "content_generation";
-    IIATaskType["Classification"] = "classification";
-    IIATaskType["Extraction"] = "extraction";
-    IIATaskType["Summarization"] = "summarization";
-    IIATaskType["Translation"] = "translation";
-    IIATaskType["SentimentAnalysis"] = "sentiment_analysis";
-    IIATaskType["QuestionAnswering"] = "question_answering";
-    IIATaskType["SendReminder"] = "send_reminder";
-    IIATaskType["RequestContactInfo"] = "request_contact_info";
-    IIATaskType["RequestOperatorInfo"] = "request_operator_info";
-    IIATaskType["ConfirmAppointment"] = "confirm_appointment";
-    IIATaskType["SendDocuments"] = "send_documents";
-    IIATaskType["CreateAppointment"] = "create_appointment";
-    IIATaskType["RescheduleAppointment"] = "reschedule_appointment";
-    IIATaskType["CancelAppointment"] = "cancel_appointment";
-    IIATaskType["FinancialCharge"] = "financial_charge";
-    IIATaskType["Custom"] = "custom";
-})(IIATaskType || (exports.IIATaskType = IIATaskType = {}));
-var ITaskExternalObjectType;
-(function (ITaskExternalObjectType) {
-    ITaskExternalObjectType["CrmLead"] = "crm_lead";
-    ITaskExternalObjectType["MedPatient"] = "med_patient";
-    ITaskExternalObjectType["MedProfessional"] = "med_professional";
-    ITaskExternalObjectType["MedAppointment"] = "med_appointment";
-    ITaskExternalObjectType["ChatContact"] = "chat_contact";
-})(ITaskExternalObjectType || (exports.ITaskExternalObjectType = ITaskExternalObjectType = {}));
+// ======================================================
+// evo-task (Tasks)
+//
+// Design goals:
+// - Single, generic Task model used by humans and automation
+// - AUTO tasks are executed by Task Runner (in evo-task-runner)
+// - Payloads for specific handlers (notifications, AI, invoices, etc.)
+//   live in their own modules; here we keep the contract generic
+// - Sub-collections (executions/comments/logs) keep lists fast
+// ======================================================
+// ----- Firestore collection conventions (per tenant)
+// Root: /tenants/{tenant}/apps/evo-task/tasks/{taskId}
+exports.EvoTaskCollections = {
+    Tasks: "tasks",
+    Executions: "executions",
+    Comments: "comments",
+    Logs: "logs",
+};
+// ----- Activities tracking
+exports.TaskActionEnum = {
+    CreateTask: "CREATE_TASK",
+    DeleteTask: "DELETE_TASK",
+    UpdateTask: "UPDATE_TASK",
+};
+// ----- Task lifecycle status
+// Keep the human-friendly lifecycle states (legacy-friendly): not_started / in_progress.
+exports.TaskStatusEnum = {
+    NotStarted: "not_started",
+    InProgress: "in_progress",
+    Completed: "completed",
+    Failed: "failed", // final failure (after retries)
+    Cancelled: "cancelled",
+    OnHold: "on_hold",
+    Suppressed: "suppressed", // intentionally skipped (e.g., dedup)
+};
+// ----- Task priority (human-friendly)
+exports.TaskPriorityEnum = {
+    Low: "low",
+    Medium: "medium",
+    High: "high",
+};
+// ----- Task source (who created it)
+exports.TaskSourceEnum = {
+    User: "user",
+    AutomationHub: "automation_hub",
+    System: "system",
+};
+// ----- Task execution mode
+exports.TaskModeEnum = {
+    Human: "human",
+    Auto: "auto",
+};
+// ----- AUTO task handler (which executor processes the task)
+// Keep it open for future modules; these are logical handler identifiers.
+exports.TaskAutoHandlerEnum = {
+    Notifications: "notifications",
+    AIAgent: "ai_agent",
+    Invoices: "invoices",
+    Webhook: "webhook",
+    Custom: "custom",
+};
+// ----- Retry policy
+exports.TaskRetryStrategyEnum = {
+    Fixed: "fixed",
+    Exponential: "exponential",
+};
+// ----- Dedup / suppression (optional)
+exports.TaskDedupScopeEnum = {
+    PerRecipient: "per_recipient",
+    PerRecipientAndObject: "per_recipient_and_object",
+    Custom: "custom",
+};
+exports.TaskDedupWindowEnum = {
+    SameDay: "same_day",
+    NHours: "n_hours",
+    Custom: "custom",
+};
+// ----- External object links (for unified UI views)
+exports.TaskExternalObjectTypeEnum = {
+    CrmLead: "crm_lead",
+    MedPatient: "med_patient",
+    MedProfessional: "med_professional",
+    MedAppointment: "med_appointment",
+    ChatContact: "chat_contact",
+};
+// ----- Task execution attempts (sub-collection: tasks/{taskId}/executions)
+exports.TaskExecutionStatusEnum = {
+    Success: "success",
+    Error: "error",
+    Retry: "retry",
+};