mitre-form-component 0.1.4 → 2.1.0

package/dist/index.d.ts

@@ -5,15 +5,24 @@ interface Product {
     name: string;
 }
 
+type Ambiente = "homol" | "prod";
+
 declare enum PreferenciaContato {
     Whatsapp = "Whatsapp",
     Email = "Email",
     Ligacao = "Liga\u00E7\u00E3o"
 }
+
+type Canal = "form" | "chat" | "whatsapp";
 interface MitreFormComponentProps {
     products: Product[];
-    apiUrl: string;
-    apiToken: string;
+    /**
+     * Define de qual config interno o componente lê `apiUrl`, `apiToken`,
+     * `whatsappPhone` e `chatUrl`. Default `"homol"`.
+     */
+    ambiente?: Ambiente;
+    /** Default `"form"`. Ver doc/canal-feature.md. */
+    canal?: Canal;
     showHeader?: boolean;
     title?: string;
     subtitle?: string;
@@ -28,7 +37,28 @@ interface MitreFormComponentProps {
     inputTextColor?: string;
     inputPlaceholderColor?: string;
     showPreferenciaContato?: boolean;
+    /** Opcional. Repassado no body do POST /leads e no `virtual_obj` (modo chat). */
+    idProdutoTerceiro?: string | number;
+    /** Opcional. Repassado no body do POST /leads e no `virtual_obj` (modo chat). */
+    idEmpreendimento?: string | number;
+    /**
+     * Default: `true` em `canal === "chat"` / `"whatsapp"` (paridade com `atendimento.html`),
+     * `false` em `canal === "form"`. Passe `false` para forçar criação do evento.
+     */
+    naoCriarEvento?: boolean;
+    /**
+     * Callback chamado após o POST `/leads` retornar sucesso, em qualquer canal.
+     * Útil para tracking (GTM, Analytics), redirect customizado ou logging na landing.
+     * O componente continua exibindo a UI de sucesso (mensagem em `canal=form`, modal
+     * em `canal=whatsapp`/`canal=chat`) independente do callback.
+     */
     onSuccess?: (requestBody: RequestBody, leadId: string) => void;
+    /**
+     * Callback chamado quando o POST `/leads` falha, em qualquer canal. Útil para
+     * tracking de erro (Sentry, Datadog, GTM). O componente continua exibindo a UI
+     * de erro (alert em `canal=form`, modal em `canal=whatsapp`/`canal=chat`)
+     * independente do callback.
+     */
     onError?: (error: Error) => void;
 }
 interface RequestBody {
@@ -42,7 +72,27 @@ interface RequestBody {
     utm_campaign?: string;
     utm_term?: string;
     preferencia_contato?: string;
+    /** Presente quando `canal !== "form"`. */
+    canal?: Canal;
+    /**
+     * Presente (e sempre `true`) quando `canal !== "form"`. Paridade com o fluxo legado
+     * `atendimento.html`, cujo `<form id="chat-form">` enviava o hidden `is_chat=true`
+     * em ambos os canais (chat e whatsapp).
+     */
+    is_chat?: boolean;
+    /** Presente quando `canal !== "form"`. `window.location.href` no momento do submit. */
+    pagina?: string;
+    /** Presente quando a prop homônima for informada e `canal !== "form"`. */
+    idProdutoTerceiro?: string | number;
+    /** Presente quando a prop homônima for informada e `canal !== "form"`. */
+    idEmpreendimento?: string | number;
+    /**
+     * Presente quando o flag efetivo é `true`. Por default vai `true` em
+     * `canal === "chat"` / `canal === "whatsapp"`; pode ser desligado com
+     * `naoCriarEvento={false}`.
+     */
+    naoCriarEvento?: boolean;
 }
 declare const MitreFormComponent: React.ForwardRefExoticComponent<MitreFormComponentProps & React.RefAttributes<HTMLDivElement>>;
 
-export { MitreFormComponent, type MitreFormComponentProps, PreferenciaContato, type RequestBody };
+export { type Ambiente, type Canal, MitreFormComponent, type MitreFormComponentProps, PreferenciaContato, type RequestBody };