evo360-types 1.3.713 → 1.3.717

package/dist/apps/evo-med/appointment/zod-schemas.d.ts

@@ -278,12 +278,12 @@ export declare const zAppointmentRescheduleSchema: z.ZodObject<{
     userRef?: any;
     external_id?: string | null | undefined;
     user_name?: string | undefined;
+    reason?: string | undefined;
     appointmentSource?: {
         code: string;
         name: string;
         external_id?: string | null | undefined;
     } | undefined;
-    reason?: string | undefined;
     oldStartDate?: Date | undefined;
     oldEndDate?: Date | undefined;
     newStartDate?: Date | undefined;
@@ -293,12 +293,12 @@ export declare const zAppointmentRescheduleSchema: z.ZodObject<{
     userRef?: any;
     external_id?: string | null | undefined;
     user_name?: string | undefined;
+    reason?: string | undefined;
     appointmentSource?: {
         code: string;
         name: string;
         external_id?: string | null | undefined;
     } | undefined;
-    reason?: string | undefined;
     oldStartDate?: unknown;
     oldEndDate?: unknown;
     newStartDate?: unknown;
@@ -650,12 +650,12 @@ export declare const zAppointmentSchema: z.ZodObject<{
         userRef?: any;
         external_id?: string | null | undefined;
         user_name?: string | undefined;
+        reason?: string | undefined;
         appointmentSource?: {
             code: string;
             name: string;
             external_id?: string | null | undefined;
         } | undefined;
-        reason?: string | undefined;
         oldStartDate?: Date | undefined;
         oldEndDate?: Date | undefined;
         newStartDate?: Date | undefined;
@@ -665,12 +665,12 @@ export declare const zAppointmentSchema: z.ZodObject<{
         userRef?: any;
         external_id?: string | null | undefined;
         user_name?: string | undefined;
+        reason?: string | undefined;
         appointmentSource?: {
             code: string;
             name: string;
             external_id?: string | null | undefined;
         } | undefined;
-        reason?: string | undefined;
         oldStartDate?: unknown;
         oldEndDate?: unknown;
         newStartDate?: unknown;
@@ -1017,12 +1017,12 @@ export declare const zAppointmentSchema: z.ZodObject<{
         userRef?: any;
         external_id?: string | null | undefined;
         user_name?: string | undefined;
+        reason?: string | undefined;
         appointmentSource?: {
             code: string;
             name: string;
             external_id?: string | null | undefined;
         } | undefined;
-        reason?: string | undefined;
         oldStartDate?: Date | undefined;
         oldEndDate?: Date | undefined;
         newStartDate?: Date | undefined;
@@ -1032,12 +1032,12 @@ export declare const zAppointmentSchema: z.ZodObject<{
         userRef?: any;
         external_id?: string | null | undefined;
         user_name?: string | undefined;
+        reason?: string | undefined;
         appointmentSource?: {
             code: string;
             name: string;
             external_id?: string | null | undefined;
         } | undefined;
-        reason?: string | undefined;
         oldStartDate?: unknown;
         oldEndDate?: unknown;
         newStartDate?: unknown;
@@ -1384,12 +1384,12 @@ export declare const zAppointmentSchema: z.ZodObject<{
         userRef?: any;
         external_id?: string | null | undefined;
         user_name?: string | undefined;
+        reason?: string | undefined;
         appointmentSource?: {
             code: string;
             name: string;
             external_id?: string | null | undefined;
         } | undefined;
-        reason?: string | undefined;
         oldStartDate?: Date | undefined;
         oldEndDate?: Date | undefined;
         newStartDate?: Date | undefined;
@@ -1399,12 +1399,12 @@ export declare const zAppointmentSchema: z.ZodObject<{
         userRef?: any;
         external_id?: string | null | undefined;
         user_name?: string | undefined;
+        reason?: string | undefined;
         appointmentSource?: {
             code: string;
             name: string;
             external_id?: string | null | undefined;
         } | undefined;
-        reason?: string | undefined;
         oldStartDate?: unknown;
         oldEndDate?: unknown;
         newStartDate?: unknown;

package/dist/index.d.ts

@@ -58,6 +58,7 @@ export * from "./apps/evo-chat/waba-template/zod-schemas";
 export * from "./apps/evo-chat/waba-setup/zod-schemas";
 export * from "./apps/evo-chat/ig-setup/zod-schemas";
 export * from "./apps/evo-chat/quick-reply/zod-schemas";
+export * from "./apps/evo-chat/forward/zod-schemas";
 export * from "./apps/evo-hub-ia/channel/zod-schemas";
 export * from "./apps/evo-hub-ia/v1/zod-schemas";
 export * from "./apps/evo-hub-ia/v1/adapter-tool-registry";

package/dist/index.js

@@ -76,6 +76,7 @@ __exportStar(require("./apps/evo-chat/waba-template/zod-schemas"), exports);
 __exportStar(require("./apps/evo-chat/waba-setup/zod-schemas"), exports);
 __exportStar(require("./apps/evo-chat/ig-setup/zod-schemas"), exports);
 __exportStar(require("./apps/evo-chat/quick-reply/zod-schemas"), exports);
+__exportStar(require("./apps/evo-chat/forward/zod-schemas"), exports);
 __exportStar(require("./apps/evo-hub-ia/channel/zod-schemas"), exports);
 __exportStar(require("./apps/evo-hub-ia/v1/zod-schemas"), exports);
 __exportStar(require("./apps/evo-hub-ia/v1/adapter-tool-registry"), exports);

package/dist/index.ts

@@ -61,6 +61,7 @@ export * from "./apps/evo-chat/waba-template/zod-schemas";
 export * from "./apps/evo-chat/waba-setup/zod-schemas";
 export * from "./apps/evo-chat/ig-setup/zod-schemas";
 export * from "./apps/evo-chat/quick-reply/zod-schemas";
+export * from "./apps/evo-chat/forward/zod-schemas";
 export * from "./apps/evo-hub-ia/channel/zod-schemas";
 export * from "./apps/evo-hub-ia/v1/zod-schemas";
 export * from "./apps/evo-hub-ia/v1/adapter-tool-registry";

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

@@ -227,7 +227,18 @@ export interface ICampaignChannelCounters {
     failed?: number;
     clicked?: number;
     replied?: number;
+    /**
+     * Ticket outcome of sends whose policy asked to close the ticket (F6). Recorded by
+     * the hub-omni at the moment it decides. `kept_open` is the RULE (patient already had
+     * an open ticket — the campaign never ends a live attendance); `close_failed` is a
+     * defect (close attempted, did not happen).
+     */
+    ticket_closed?: number;
+    ticket_kept_open?: number;
+    ticket_close_failed?: number;
 }
+/** What happened to the ticket of a campaign send that asked to close it (F6). */
+export type CampaignTicketOutcome = "closed" | "kept_open" | "close_failed";
 export interface ICampaignCounters {
     raw?: number;
     unique?: number;
@@ -330,6 +341,26 @@ export interface ICampaign extends IFireDoc {
     finished_at?: Date | null;
     cancel_reason?: string | null;
     error_reason?: string | null;
+    /**
+     * Why the campaign is paused, when the SYSTEM paused it (F6 circuit breaker).
+     * `null`/absent on an operator pause and cleared on resume — its presence is what
+     * tells the screen "the platform stopped this, here is the cause".
+     */
+    pause_reason?: ICampaignPauseReason | null;
+}
+/**
+ * System pause (F6). A provider error that fails EVERY recipient the same way
+ * (account payment, account restricted, template paused/disabled, broken media)
+ * stops the dispatch instead of burning the rest of the list.
+ */
+export interface ICampaignPauseReason {
+    kind: "provider_systemic_error";
+    channel: CampaignChannel;
+    error_code: string;
+    error_message?: string | null;
+    /** Recipient whose failure tripped the breaker — the operator can open it. */
+    recipient_id?: string | null;
+    at: Date;
 }
 export type CampaignBucketSourceType = "leads" | "patients" | "appointments" | "csv";
 export interface ICampaignBucketCsvFile {
@@ -417,6 +448,16 @@ export interface ICampaignRecipientChannelState {
     failed_at?: Date | null;
     /** Provider error text that accompanies `failed_at`. */
     error?: string | null;
+    /**
+     * Provider error CODE that accompanies `failed_at` (F6). Kept apart from `error`
+     * because the code is what the operator-facing breakdown groups by and what the
+     * circuit breaker decides on; parsing it back out of the text would be guessing.
+     * String, not number: providers other than Meta do not promise numeric codes.
+     */
+    error_code?: string | null;
+    /** Ticket outcome when the policy asked to close it (F6) — see ICampaignChannelCounters. */
+    ticket_outcome?: CampaignTicketOutcome | null;
+    ticket_id?: string | null;
 }
 /**
  * Why a recipient was kept out. Closed union: every value here HAS a writer in

package/dist/types/evo-campaigns/index.ts

@@ -304,8 +304,20 @@ export interface ICampaignChannelCounters {
   failed?: number;
   clicked?: number;
   replied?: number;
+  /**
+   * Ticket outcome of sends whose policy asked to close the ticket (F6). Recorded by
+   * the hub-omni at the moment it decides. `kept_open` is the RULE (patient already had
+   * an open ticket — the campaign never ends a live attendance); `close_failed` is a
+   * defect (close attempted, did not happen).
+   */
+  ticket_closed?: number;
+  ticket_kept_open?: number;
+  ticket_close_failed?: number;
 }
 
+/** What happened to the ticket of a campaign send that asked to close it (F6). */
+export type CampaignTicketOutcome = "closed" | "kept_open" | "close_failed";
+
 export interface ICampaignCounters {
   raw?: number;
   unique?: number;
@@ -422,6 +434,27 @@ export interface ICampaign extends IFireDoc {
   finished_at?: Date | null;
   cancel_reason?: string | null;
   error_reason?: string | null;
+  /**
+   * Why the campaign is paused, when the SYSTEM paused it (F6 circuit breaker).
+   * `null`/absent on an operator pause and cleared on resume — its presence is what
+   * tells the screen "the platform stopped this, here is the cause".
+   */
+  pause_reason?: ICampaignPauseReason | null;
+}
+
+/**
+ * System pause (F6). A provider error that fails EVERY recipient the same way
+ * (account payment, account restricted, template paused/disabled, broken media)
+ * stops the dispatch instead of burning the rest of the list.
+ */
+export interface ICampaignPauseReason {
+  kind: "provider_systemic_error";
+  channel: CampaignChannel;
+  error_code: string;
+  error_message?: string | null;
+  /** Recipient whose failure tripped the breaker — the operator can open it. */
+  recipient_id?: string | null;
+  at: Date;
 }
 
 // ----- Bucket ---------------------------------------------------------------
@@ -550,6 +583,16 @@ export interface ICampaignRecipientChannelState {
   failed_at?: Date | null;
   /** Provider error text that accompanies `failed_at`. */
   error?: string | null;
+  /**
+   * Provider error CODE that accompanies `failed_at` (F6). Kept apart from `error`
+   * because the code is what the operator-facing breakdown groups by and what the
+   * circuit breaker decides on; parsing it back out of the text would be guessing.
+   * String, not number: providers other than Meta do not promise numeric codes.
+   */
+  error_code?: string | null;
+  /** Ticket outcome when the policy asked to close it (F6) — see ICampaignChannelCounters. */
+  ticket_outcome?: CampaignTicketOutcome | null;
+  ticket_id?: string | null;
 }
 
 /**

package/dist/types/evo-chat/forward/index.d.ts

@@ -0,0 +1,168 @@
+import type { IFireDoc } from "../../shared";
+import type { IThreadMessage } from "../thread-message";
+/**
+ * feat-282 — encaminhamento de mensagens no Hub Omni.
+ *
+ * A Cloud API da Meta não tem forward: o encaminhamento é nosso. Cada ação do
+ * operador vira um LOTE (`IForwardBatch`) em
+ * `tenants/{t}/apps/evo-chat/forwards/{forwardId}`, com um item por
+ * (destinatário × mensagem) na subcoleção `items/` e, por destinatário, um item
+ * `intro` opcional (texto de apresentação). Cada entrega é uma mensagem NORMAL de
+ * saída na thread de destino, com o bloco `forward` (`IMessageForward`) apontando
+ * para a origem. A mensagem de origem só ganha `forward_count`.
+ */
+export declare const FORWARDS_COLLECTION: "forwards";
+export declare const FORWARD_ITEMS_COLLECTION: "items";
+/** Tetos do lote (plan.md D6). Constantes de plataforma, sem config por tenant. */
+export declare const FORWARD_MAX_MESSAGES = 20;
+export declare const FORWARD_MAX_RECIPIENTS = 10;
+export declare const FORWARD_INTRO_MAX_CHARS = 1000;
+/** Lote `running` sem atualização há mais que isto é mostrado como interrompido. */
+export declare const FORWARD_STALE_AFTER_MS: number;
+/** Evento de timeline gravado na thread de ORIGEM ao criar o lote. */
+export declare const FORWARD_TIMELINE_EVENT_TYPE: "messages_forwarded";
+export type ForwardBatchStatus = "running" | "done" | "done_with_failures";
+export type ForwardItemStatus = "pending" | "sending" | "sent" | "failed" | "skipped";
+/** Motivos decididos na pré-validação (item nasce `skipped`, nenhuma chamada ao provedor). */
+export type ForwardSkipReason = "window_closed" | "type_not_supported" | "media_too_large" | "media_unavailable" | "channel_not_supported";
+/** Motivos de falha no envio (item passou por `sending`). */
+export type ForwardFailReason = "provider_error" | "window_closed" | "send_budget_exceeded" | "interrupted";
+export type ForwardItemReason = ForwardSkipReason | ForwardFailReason;
+export type ForwardContentKind = "text" | "image" | "video" | "audio" | "document";
+/** Canais aceitos como DESTINO na F1. E-mail e SMS ficam para a F2. */
+export type ForwardDestinationKind = "whatsapp" | "instagram";
+export type ForwardRecipientProvider = "hub-waba" | "hub-instagram";
+export type ForwardSpecialKind = "doctor" | "secretary" | "employee";
+export interface IForwardActor {
+    user_id: string;
+    display_name: string;
+}
+export interface IForwardSource {
+    thread_id: string;
+    ticket_id: string;
+    /** Departamento do ticket de origem: é onde o ticket novo do destino abre (Q4-A). */
+    department_id: string | null;
+    contact_id: string;
+    contact_name: string;
+    channel_id: string | null;
+    channel_type: string | null;
+}
+export interface IForwardRecipient {
+    thread_id: string;
+    contact_id: string;
+    contact_name: string;
+    channel_id: string;
+    channel_type: string;
+    provider: ForwardRecipientProvider;
+    special_kind?: ForwardSpecialKind | null;
+}
+export interface IForwardDispatchState {
+    claimed_at: Date;
+    finished_at?: Date | null;
+}
+export interface IForwardCounts {
+    total: number;
+    sent: number;
+    failed: number;
+    skipped: number;
+}
+export interface IForwardBatch extends IFireDoc {
+    forward_id: string;
+    tenant: string;
+    created_by: IForwardActor;
+    source: IForwardSource;
+    /** Ordem cronológica da origem (o backend ordena por `created_at`, não pelo payload). */
+    message_ids: string[];
+    intro_text: string | null;
+    recipients: IForwardRecipient[];
+    status: ForwardBatchStatus;
+    counts: IForwardCounts;
+    /** Destinatários com pelo menos um item `pending` (os que recebem mensagem PubSub). */
+    recipients_to_dispatch: number;
+    recipients_done: number;
+    /** Chave = `thread_id` do destinatário. Claim do worker contra entrega duplicada. */
+    dispatch?: Record<string, IForwardDispatchState>;
+    finished_at?: Date | null;
+}
+export interface IForwardItem {
+    /** `${recipient_thread_id}__${message_id}` ou `${recipient_thread_id}__intro`. */
+    item_id: string;
+    forward_id: string;
+    recipient_thread_id: string;
+    recipient_index: number;
+    /** 0 = intro; 1..N = mensagens na ordem da origem. */
+    seq: number;
+    kind: "intro" | "message";
+    message_id: string | null;
+    content_kind: ForwardContentKind;
+    status: ForwardItemStatus;
+    reason?: ForwardItemReason | null;
+    error?: string | null;
+    error_code?: number | null;
+    dest_message_id?: string | null;
+    sent_at?: Date | null;
+    updated_at?: Date;
+}
+export type ForwardWindowState = "open" | "human_agent" | "closed";
+export interface IForwardPlanItem {
+    item_id: string;
+    kind: "intro" | "message";
+    message_id: string | null;
+    status: "pending" | "skipped";
+    reason?: ForwardSkipReason;
+}
+export interface IForwardPlanRecipient {
+    thread_id: string;
+    channel_id: string;
+    channel_type: string;
+    contact_name: string;
+    window: ForwardWindowState;
+    needs_ticket: boolean;
+    items: IForwardPlanItem[];
+}
+export interface IForwardPlan {
+    recipients: IForwardPlanRecipient[];
+    counts: {
+        total: number;
+        pending: number;
+        skipped: number;
+    };
+}
+export interface IMessageForward {
+    forward_id: string;
+    /** Ponte para o item do lote (o status-processor reflete falha assíncrona por aqui). */
+    item_id: string;
+    /** Vazio no item `intro`: o front não mostra selo quando está vazio. */
+    source_message_id: string;
+    source_thread_id: string;
+    source_ticket_id: string;
+    source_contact_id: string;
+    source_contact_name: string;
+    source_channel_type: string | null;
+    source_direction: "in" | "out";
+    source_created_at: Date;
+    forwarded_by: IForwardActor;
+    forwarded_at: Date;
+}
+export type ForwardableMessage = Pick<IThreadMessage, "type" | "direction" | "channel_type" | "body" | "media" | "template"> & {
+    revoked?: unknown;
+    deleted_at?: unknown;
+};
+export type ForwardContentResolution = {
+    ok: true;
+    kind: ForwardContentKind;
+    text?: string;
+} | {
+    ok: false;
+    reason: ForwardSkipReason;
+};
+/**
+ * Decide se uma mensagem pode ser encaminhada e como vira conteúdo no destino.
+ *
+ * `dest = null` é a checagem agnóstica do modo de seleção no front (sem canal
+ * escolhido). A regra que depende do destino é só uma: documento não vai para
+ * Instagram. O teto de tamanho NÃO fica aqui: depende do objeto no Storage.
+ */
+export declare function resolveForwardContent(m: ForwardableMessage, dest: ForwardDestinationKind | null): ForwardContentResolution;
+/** Id determinístico do item: um destinatário aparece uma vez no lote, então é único. */
+export declare function buildForwardItemId(recipientThreadId: string, messageId: string | null): string;

package/dist/types/evo-chat/forward/index.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FORWARD_TIMELINE_EVENT_TYPE = exports.FORWARD_STALE_AFTER_MS = exports.FORWARD_INTRO_MAX_CHARS = exports.FORWARD_MAX_RECIPIENTS = exports.FORWARD_MAX_MESSAGES = exports.FORWARD_ITEMS_COLLECTION = exports.FORWARDS_COLLECTION = void 0;
+exports.resolveForwardContent = resolveForwardContent;
+exports.buildForwardItemId = buildForwardItemId;
+/**
+ * feat-282 — encaminhamento de mensagens no Hub Omni.
+ *
+ * A Cloud API da Meta não tem forward: o encaminhamento é nosso. Cada ação do
+ * operador vira um LOTE (`IForwardBatch`) em
+ * `tenants/{t}/apps/evo-chat/forwards/{forwardId}`, com um item por
+ * (destinatário × mensagem) na subcoleção `items/` e, por destinatário, um item
+ * `intro` opcional (texto de apresentação). Cada entrega é uma mensagem NORMAL de
+ * saída na thread de destino, com o bloco `forward` (`IMessageForward`) apontando
+ * para a origem. A mensagem de origem só ganha `forward_count`.
+ */
+// ── Constants ──
+exports.FORWARDS_COLLECTION = "forwards";
+exports.FORWARD_ITEMS_COLLECTION = "items";
+/** Tetos do lote (plan.md D6). Constantes de plataforma, sem config por tenant. */
+exports.FORWARD_MAX_MESSAGES = 20;
+exports.FORWARD_MAX_RECIPIENTS = 10;
+exports.FORWARD_INTRO_MAX_CHARS = 1000;
+/** Lote `running` sem atualização há mais que isto é mostrado como interrompido. */
+exports.FORWARD_STALE_AFTER_MS = 10 * 60 * 1000;
+/** Evento de timeline gravado na thread de ORIGEM ao criar o lote. */
+exports.FORWARD_TIMELINE_EVENT_TYPE = "messages_forwarded";
+const MEDIA_KINDS = new Set(["image", "video", "audio", "document"]);
+/** Canais que não entram na F1 nem como origem (e-mail, SMS). */
+const UNSUPPORTED_SOURCE_CHANNELS = new Set(["email", "sms"]);
+/**
+ * Decide se uma mensagem pode ser encaminhada e como vira conteúdo no destino.
+ *
+ * `dest = null` é a checagem agnóstica do modo de seleção no front (sem canal
+ * escolhido). A regra que depende do destino é só uma: documento não vai para
+ * Instagram. O teto de tamanho NÃO fica aqui: depende do objeto no Storage.
+ */
+function resolveForwardContent(m, dest) {
+    const direction = String(m.direction ?? "").toLowerCase();
+    if (direction !== "in" && direction !== "out")
+        return { ok: false, reason: "type_not_supported" };
+    if (m.revoked === true)
+        return { ok: false, reason: "type_not_supported" };
+    if (m.deleted_at !== undefined && m.deleted_at !== null)
+        return { ok: false, reason: "type_not_supported" };
+    const channelType = String(m.channel_type ?? "").toLowerCase();
+    if (UNSUPPORTED_SOURCE_CHANNELS.has(channelType))
+        return { ok: false, reason: "type_not_supported" };
+    const type = String(m.type ?? "").toLowerCase();
+    if (type === "text") {
+        const text = (m.body?.text ?? "").trim();
+        if (!text)
+            return { ok: false, reason: "type_not_supported" };
+        return { ok: true, kind: "text", text };
+    }
+    if (type === "template") {
+        const text = (m.template?.rendered?.text ?? "").trim();
+        if (!text)
+            return { ok: false, reason: "type_not_supported" };
+        return { ok: true, kind: "text", text };
+    }
+    if (MEDIA_KINDS.has(type)) {
+        const uri = (m.media?.gcs_uri ?? "").trim();
+        if (!uri)
+            return { ok: false, reason: "media_unavailable" };
+        if (type === "document" && dest === "instagram")
+            return { ok: false, reason: "type_not_supported" };
+        return { ok: true, kind: type };
+    }
+    return { ok: false, reason: "type_not_supported" };
+}
+/** Id determinístico do item: um destinatário aparece uma vez no lote, então é único. */
+function buildForwardItemId(recipientThreadId, messageId) {
+    return `${recipientThreadId}__${messageId ?? "intro"}`;
+}