evo360-types 1.3.713 → 1.3.717

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

@@ -0,0 +1,256 @@
+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`.
+ */
+
+// ── Constants ──
+
+export const FORWARDS_COLLECTION = "forwards" as const;
+export const FORWARD_ITEMS_COLLECTION = "items" as const;
+
+/** Tetos do lote (plan.md D6). Constantes de plataforma, sem config por tenant. */
+export const FORWARD_MAX_MESSAGES = 20;
+export const FORWARD_MAX_RECIPIENTS = 10;
+export const FORWARD_INTRO_MAX_CHARS = 1000;
+
+/** Lote `running` sem atualização há mais que isto é mostrado como interrompido. */
+export const FORWARD_STALE_AFTER_MS = 10 * 60 * 1000;
+
+/** Evento de timeline gravado na thread de ORIGEM ao criar o lote. */
+export const FORWARD_TIMELINE_EVENT_TYPE = "messages_forwarded" as const;
+
+// ── Enums ──
+
+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";
+
+// ── Batch ──
+
+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;
+}
+
+// ── Item ──
+
+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;
+}
+
+// ── Plan (resposta do `dry_run` e do POST) ──
+
+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 };
+}
+
+// ── Bloco gravado na mensagem de DESTINO ──
+
+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;
+}
+
+// ── Matriz tipo × canal (pura; usada pelo backend na pré-validação e pelo front na seleção) ──
+
+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 };
+
+const MEDIA_KINDS: ReadonlySet<string> = new Set(["image", "video", "audio", "document"]);
+
+/** Canais que não entram na F1 nem como origem (e-mail, SMS). */
+const UNSUPPORTED_SOURCE_CHANNELS: ReadonlySet<string> = 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.
+ */
+export function resolveForwardContent(
+  m: ForwardableMessage,
+  dest: ForwardDestinationKind | null,
+): ForwardContentResolution {
+  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 as ForwardContentKind };
+  }
+
+  return { ok: false, reason: "type_not_supported" };
+}
+
+/** Id determinístico do item: um destinatário aparece uma vez no lote, então é único. */
+export function buildForwardItemId(recipientThreadId: string, messageId: string | null): string {
+  return `${recipientThreadId}__${messageId ?? "intro"}`;
+}

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

@@ -14,11 +14,14 @@ export * from "./waba-history-import";
 export * from "./ig-setup";
 export * from "./quick-reply";
 export * from "./search";
+export * from "./forward";
 export declare const EvoChatPermissions: {
     readonly Read: "evo_chat_read";
     readonly Write: "evo_chat_write";
     readonly InboxManage: "evo_chat_inbox_manage";
     readonly TicketClose: "evo_chat_ticket_close";
     readonly TicketTransfer: "evo_chat_ticket_transfer";
+    /** feat-254 B2: baixar anexo de e-mail bloqueado pela política (quarentena). Sem papel padrão. */
+    readonly QuarantineRead: "evo_chat_quarantine_read";
 };
 export type EvoChatPermissions = (typeof EvoChatPermissions)[keyof typeof EvoChatPermissions];

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

@@ -31,6 +31,7 @@ __exportStar(require("./waba-history-import"), exports);
 __exportStar(require("./ig-setup"), exports);
 __exportStar(require("./quick-reply"), exports);
 __exportStar(require("./search"), exports);
+__exportStar(require("./forward"), exports);
 // Permissões para o evo-chat
 exports.EvoChatPermissions = {
     Read: "evo_chat_read",
@@ -38,4 +39,6 @@ exports.EvoChatPermissions = {
     InboxManage: "evo_chat_inbox_manage",
     TicketClose: "evo_chat_ticket_close",
     TicketTransfer: "evo_chat_ticket_transfer",
+    /** feat-254 B2: baixar anexo de e-mail bloqueado pela política (quarentena). Sem papel padrão. */
+    QuarantineRead: "evo_chat_quarantine_read",
 };

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

@@ -14,6 +14,7 @@ export * from "./waba-history-import";
 export * from "./ig-setup";
 export * from "./quick-reply";
 export * from "./search";
+export * from "./forward";
 
 // Permissões para o evo-chat
 export const EvoChatPermissions = {
@@ -22,6 +23,8 @@ export const EvoChatPermissions = {
   InboxManage: "evo_chat_inbox_manage",
   TicketClose: "evo_chat_ticket_close",
   TicketTransfer: "evo_chat_ticket_transfer",
+  /** feat-254 B2: baixar anexo de e-mail bloqueado pela política (quarentena). Sem papel padrão. */
+  QuarantineRead: "evo_chat_quarantine_read",
 } as const;
 
 export type EvoChatPermissions =

package/dist/types/evo-chat/thread-message/index.d.ts

@@ -1,5 +1,6 @@
 import { IFireDoc } from "../../shared";
 import type { IMessageCall } from "../call-session";
+import type { IMessageForward } from "../forward";
 export type EvoChatMessageType = 'text' | 'image' | 'audio' | 'video' | 'document' | 'sticker' | 'location' | 'contacts' | 'interactive' | 'reaction' | 'template' | 'system' | 'call';
 export type MessageDirection = 'in' | 'out';
 export interface IMessageStatus {
@@ -159,6 +160,9 @@ export interface IThreadMessage extends IFireDoc {
         rendered?: IRenderedTemplateSnapshot;
     };
     context?: IMessageContext;
+    forward?: IMessageForward;
+    /** feat-282: na mensagem de ORIGEM, quantas entregas de encaminhamento já saíram dela. */
+    forward_count?: number;
     call?: IMessageCall;
     provider_message_id?: string;
     status?: IMessageStatus;

package/dist/types/evo-chat/thread-message/index.ts

@@ -1,5 +1,6 @@
 import { IFireDoc } from "../../shared";
 import type { IMessageCall } from "../call-session";
+import type { IMessageForward } from "../forward";
 
 // ── Message type/direction enums ──
 
@@ -197,6 +198,11 @@ export interface IThreadMessage extends IFireDoc {
   };
   context?: IMessageContext;
 
+  // feat-282: presente na mensagem de DESTINO de um encaminhamento (ver ../forward).
+  forward?: IMessageForward;
+  /** feat-282: na mensagem de ORIGEM, quantas entregas de encaminhamento já saíram dela. */
+  forward_count?: number;
+
   // Call timeline projection (feat-029). Fonte de verdade em ICallSession.
   call?: IMessageCall;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evo360-types",
-  "version": "1.3.713",
+  "version": "1.3.717",
   "description": "HREVO360 Shared Types",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",