evo360-types 1.3.784 → 1.3.787
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apps/evo-chat/forward/zod-schemas.d.ts +4 -4
- package/dist/apps/evo-finops/zod-schemas.d.ts +465 -30
- package/dist/apps/evo-finops/zod-schemas.js +123 -2
- package/dist/apps/evo-finops/zod-schemas.ts +131 -0
- package/dist/types/evo-finops/common/contract.d.ts +8 -0
- package/dist/types/evo-finops/common/contract.ts +8 -0
- package/dist/types/evo-finops/common/proposal.d.ts +25 -0
- package/dist/types/evo-finops/common/proposal.ts +28 -0
- package/dist/types/nex-vendas/adhesion.d.ts +253 -0
- package/dist/types/nex-vendas/adhesion.js +15 -0
- package/dist/types/nex-vendas/adhesion.ts +280 -0
- package/dist/types/nex-vendas/index.d.ts +3 -0
- package/dist/types/nex-vendas/index.js +3 -0
- package/dist/types/nex-vendas/index.ts +3 -0
- package/dist/types/nex-vendas/journey.d.ts +82 -4
- package/dist/types/nex-vendas/journey.ts +86 -3
- package/dist/types/nex-vendas/notifications.d.ts +14 -0
- package/dist/types/nex-vendas/notifications.js +21 -0
- package/dist/types/nex-vendas/notifications.ts +21 -0
- package/dist/types/nex-vendas/offer.d.ts +129 -0
- package/dist/types/nex-vendas/offer.js +10 -0
- package/dist/types/nex-vendas/offer.ts +154 -0
- package/package.json +1 -1
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { IFireGlobalDoc } from '../shared';
|
|
2
2
|
import type { INexFinopsProposalPublic, NexFinopsProposalOrigem } from '../evo-finops/common/proposal';
|
|
3
3
|
import type { NexFinopsContractStatus } from '../evo-finops/common/contract';
|
|
4
|
+
import type { INexVendasJourneyAcceptanceRef, INexVendasJourneyAdhesionDocument, NexVendasContractType } from './adhesion';
|
|
5
|
+
import type { INexVendasAttribution } from './offer';
|
|
4
6
|
/**
|
|
5
7
|
* União completa dos estados da jornada de contratação (visão §5.2). A feat-130
|
|
6
8
|
* implementa até `contrato_assinado`; `aguardando_pagamento`/`pago` são da
|
|
@@ -18,8 +20,12 @@ export declare const NEX_VENDAS_JOURNEY_OPEN_STATUSES: readonly string[];
|
|
|
18
20
|
/**
|
|
19
21
|
* Próximo passo que a página pública deve mostrar. Derivado do status — o shop
|
|
20
22
|
* não reimplementa a máquina, só obedece.
|
|
23
|
+
*
|
|
24
|
+
* `accept` é o aceite da PROPOSTA. `accept_contract` (feat-325) é o passo de
|
|
25
|
+
* contrato na adesão: `dados_coletados` com `contract_type === 'adesao'` devolve
|
|
26
|
+
* `accept_contract` no lugar de `sign`.
|
|
21
27
|
*/
|
|
22
|
-
export type NexVendasJourneyNextStep = 'accept' | 'data' | 'sign' | 'payment' | 'wait' | 'done';
|
|
28
|
+
export type NexVendasJourneyNextStep = 'accept' | 'data' | 'sign' | 'accept_contract' | 'payment' | 'wait' | 'done';
|
|
23
29
|
/**
|
|
24
30
|
* `unavailable`: não há provider de assinatura configurado. A jornada avança
|
|
25
31
|
* mesmo assim (o dado foi coletado); a página pública mostra "link de assinatura
|
|
@@ -28,8 +34,12 @@ export type NexVendasJourneyNextStep = 'accept' | 'data' | 'sign' | 'payment' |
|
|
|
28
34
|
export type NexVendasJourneySignatureStatus = 'none' | 'pending' | 'signed' | 'unavailable';
|
|
29
35
|
export interface INexVendasJourneySignature {
|
|
30
36
|
status: NexVendasJourneySignatureStatus;
|
|
31
|
-
/**
|
|
32
|
-
|
|
37
|
+
/**
|
|
38
|
+
* Nome do provider que emitiu o envelope (ex.: `d4sign`). `adesao` (feat-325 D3)
|
|
39
|
+
* = aceite por clique: `status: 'signed'`, `signed_at` = data do aceite,
|
|
40
|
+
* `envelope_id`/`sign_url` null. As telas mostram "Contrato aceito".
|
|
41
|
+
*/
|
|
42
|
+
provider?: 'd4sign' | 'adesao' | (string & {}) | null;
|
|
33
43
|
/** Id do documento/envelope no provider — chave de busca do webhook. */
|
|
34
44
|
envelope_id?: string | null;
|
|
35
45
|
sign_url?: string | null;
|
|
@@ -241,6 +251,11 @@ export interface INexVendasJourneyPaymentPublic {
|
|
|
241
251
|
* DAL grava: aquela é auditoria campo-a-campo, esta é a narrativa do funil.
|
|
242
252
|
*/
|
|
243
253
|
export interface INexVendasJourneyEvent {
|
|
254
|
+
/**
|
|
255
|
+
* Aberto (string). `data` tipado por evento: `proposal_accepted` →
|
|
256
|
+
* `INexVendasJourneyProposalAcceptedEventData`; `contract_accepted` →
|
|
257
|
+
* `INexVendasJourneyContractAcceptedEventData`.
|
|
258
|
+
*/
|
|
244
259
|
type: string;
|
|
245
260
|
at: Date;
|
|
246
261
|
/** `system`, `customer` ou o id do usuário de backoffice. */
|
|
@@ -294,7 +309,9 @@ export interface INexVendasJourneyLeadRef {
|
|
|
294
309
|
* quando o vendedor edita o `html_content`, e o "já feito" é decidido por
|
|
295
310
|
* comparação de hash antes do claim, não pela presença do campo.
|
|
296
311
|
*/
|
|
297
|
-
export type NexVendasJourneySlot = 'contract' | 'signature' | 'payment' | 'proposal_pdf'
|
|
312
|
+
export type NexVendasJourneySlot = 'contract' | 'signature' | 'payment' | 'proposal_pdf'
|
|
313
|
+
/** feat-325 — render do quadro-resumo da adesão. Mutex puro, como `proposal_pdf`. */
|
|
314
|
+
| 'adhesion_document';
|
|
298
315
|
/**
|
|
299
316
|
* Marca de reserva de um slot, gravada e liberada dentro de transaction.
|
|
300
317
|
*
|
|
@@ -319,6 +336,15 @@ export interface INexVendasJourney extends IFireGlobalDoc {
|
|
|
319
336
|
short_code: string;
|
|
320
337
|
status: NexVendasJourneyStatus;
|
|
321
338
|
origem: NexFinopsProposalOrigem;
|
|
339
|
+
/**
|
|
340
|
+
* Cópia congelada do tipo do modelo de contrato, gravada no submit dos dados
|
|
341
|
+
* (feat-325 D2); imutável depois disso. Ausente = `assinatura_eletronica`.
|
|
342
|
+
*/
|
|
343
|
+
contract_type?: NexVendasContractType | null;
|
|
344
|
+
/** feat-326 — cópia da atribuição da proposta (jornadas de oferta). */
|
|
345
|
+
attribution?: INexVendasAttribution | null;
|
|
346
|
+
/** feat-326 — cópia de `proposal.offer_slug` (chip "Self-service" no dashboard). */
|
|
347
|
+
offer_slug?: string | null;
|
|
322
348
|
proposal_ref: string;
|
|
323
349
|
contract_ref?: string | null;
|
|
324
350
|
tenant_ref?: string | null;
|
|
@@ -344,6 +370,10 @@ export interface INexVendasJourney extends IFireGlobalDoc {
|
|
|
344
370
|
* sem anexo.
|
|
345
371
|
*/
|
|
346
372
|
proposal_pdf?: INexVendasJourneyProposalPdf | null;
|
|
373
|
+
/** feat-325 — quadro-resumo + CG congeladas exibidos no passo de aceite (só adesão). */
|
|
374
|
+
adhesion_document?: INexVendasJourneyAdhesionDocument | null;
|
|
375
|
+
/** feat-325 — resumo do aceite por adesão (registro completo em `acceptances/`). */
|
|
376
|
+
acceptance?: INexVendasJourneyAcceptanceRef | null;
|
|
347
377
|
/**
|
|
348
378
|
* Espelho PLANO de todo id externo de pagamento que a jornada já produziu —
|
|
349
379
|
* checkout, cobrança, assinatura e link, **inclusive os superseded**.
|
|
@@ -422,6 +452,54 @@ export interface INexVendasJourneyPublic {
|
|
|
422
452
|
contract: {
|
|
423
453
|
status: NexFinopsContractStatus;
|
|
424
454
|
} | null;
|
|
455
|
+
/**
|
|
456
|
+
* feat-325 — tipo de formalização. O shop ramifica o passo de contrato por ele.
|
|
457
|
+
* Ausente em backend anterior à feat-325 (= `assinatura_eletronica`).
|
|
458
|
+
*/
|
|
459
|
+
contract_type?: NexVendasContractType;
|
|
460
|
+
/** feat-325 — aceite já feito; null antes do aceite ou fora da adesão. */
|
|
461
|
+
acceptance?: INexVendasJourneyAcceptancePublic | null;
|
|
462
|
+
/**
|
|
463
|
+
* feat-325 — documentos da adesão (URLs assinadas curtas + hashes). Antes do
|
|
464
|
+
* aceite: rascunho atual; depois: cópias de evidência, por `document_access_days`.
|
|
465
|
+
* null fora da adesão ou com a janela de acesso vencida.
|
|
466
|
+
*/
|
|
467
|
+
documents?: INexVendasJourneyAdhesionDocumentsPublic | null;
|
|
468
|
+
/**
|
|
469
|
+
* feat-325 D5 — declaração exibida ao lado do checkbox. O texto vem do backend
|
|
470
|
+
* (uma fonte só); `version` volta no corpo do aceite. null fora da adesão.
|
|
471
|
+
*/
|
|
472
|
+
declaration?: {
|
|
473
|
+
version: string;
|
|
474
|
+
text: string;
|
|
475
|
+
} | null;
|
|
476
|
+
}
|
|
477
|
+
/** Aceite na projeção pública: sem IP, user-agent nem ids internos. */
|
|
478
|
+
export interface INexVendasJourneyAcceptancePublic {
|
|
479
|
+
protocol: string;
|
|
480
|
+
accepted_at: Date;
|
|
481
|
+
}
|
|
482
|
+
/** Um documento da adesão na projeção pública. */
|
|
483
|
+
export interface INexVendasJourneyDocumentPublic {
|
|
484
|
+
/** URL assinada de vida curta (GET direto do PDF). */
|
|
485
|
+
url: string;
|
|
486
|
+
/** SHA-256 hex dos bytes — o shop confere e devolve no aceite. */
|
|
487
|
+
sha256: string;
|
|
488
|
+
}
|
|
489
|
+
export interface INexVendasJourneyAdhesionDocumentsPublic {
|
|
490
|
+
/** Condições Gerais. */
|
|
491
|
+
cg: INexVendasJourneyDocumentPublic & {
|
|
492
|
+
version: string;
|
|
493
|
+
filename: string | null;
|
|
494
|
+
};
|
|
495
|
+
/** Quadro-resumo da jornada. */
|
|
496
|
+
summary: INexVendasJourneyDocumentPublic & {
|
|
497
|
+
issued_on: string | null;
|
|
498
|
+
};
|
|
499
|
+
/** Comprovante do aceite; null antes do aceite ou enquanto não gerado. */
|
|
500
|
+
receipt: INexVendasJourneyDocumentPublic | null;
|
|
501
|
+
/** Quando as URLs assinadas expiram (o shop refaz o GET depois disso). */
|
|
502
|
+
urls_expire_at: Date;
|
|
425
503
|
}
|
|
426
504
|
/** Falha de verificação devolvida no 422 de `POST /journeys/:short_code/data`. */
|
|
427
505
|
export interface INexVendasJourneyVerificationFailure {
|
|
@@ -4,6 +4,12 @@ import type {
|
|
|
4
4
|
NexFinopsProposalOrigem,
|
|
5
5
|
} from '../evo-finops/common/proposal';
|
|
6
6
|
import type { NexFinopsContractStatus } from '../evo-finops/common/contract';
|
|
7
|
+
import type {
|
|
8
|
+
INexVendasJourneyAcceptanceRef,
|
|
9
|
+
INexVendasJourneyAdhesionDocument,
|
|
10
|
+
NexVendasContractType,
|
|
11
|
+
} from './adhesion';
|
|
12
|
+
import type { INexVendasAttribution } from './offer';
|
|
7
13
|
|
|
8
14
|
// ── Status ──
|
|
9
15
|
|
|
@@ -57,11 +63,16 @@ export const NEX_VENDAS_JOURNEY_OPEN_STATUSES: readonly string[] = [
|
|
|
57
63
|
/**
|
|
58
64
|
* Próximo passo que a página pública deve mostrar. Derivado do status — o shop
|
|
59
65
|
* não reimplementa a máquina, só obedece.
|
|
66
|
+
*
|
|
67
|
+
* `accept` é o aceite da PROPOSTA. `accept_contract` (feat-325) é o passo de
|
|
68
|
+
* contrato na adesão: `dados_coletados` com `contract_type === 'adesao'` devolve
|
|
69
|
+
* `accept_contract` no lugar de `sign`.
|
|
60
70
|
*/
|
|
61
71
|
export type NexVendasJourneyNextStep =
|
|
62
72
|
| 'accept'
|
|
63
73
|
| 'data'
|
|
64
74
|
| 'sign'
|
|
75
|
+
| 'accept_contract'
|
|
65
76
|
| 'payment'
|
|
66
77
|
| 'wait'
|
|
67
78
|
| 'done';
|
|
@@ -81,8 +92,12 @@ export type NexVendasJourneySignatureStatus =
|
|
|
81
92
|
|
|
82
93
|
export interface INexVendasJourneySignature {
|
|
83
94
|
status: NexVendasJourneySignatureStatus;
|
|
84
|
-
/**
|
|
85
|
-
|
|
95
|
+
/**
|
|
96
|
+
* Nome do provider que emitiu o envelope (ex.: `d4sign`). `adesao` (feat-325 D3)
|
|
97
|
+
* = aceite por clique: `status: 'signed'`, `signed_at` = data do aceite,
|
|
98
|
+
* `envelope_id`/`sign_url` null. As telas mostram "Contrato aceito".
|
|
99
|
+
*/
|
|
100
|
+
provider?: 'd4sign' | 'adesao' | (string & {}) | null;
|
|
86
101
|
/** Id do documento/envelope no provider — chave de busca do webhook. */
|
|
87
102
|
envelope_id?: string | null;
|
|
88
103
|
sign_url?: string | null;
|
|
@@ -339,6 +354,11 @@ export interface INexVendasJourneyPaymentPublic {
|
|
|
339
354
|
* DAL grava: aquela é auditoria campo-a-campo, esta é a narrativa do funil.
|
|
340
355
|
*/
|
|
341
356
|
export interface INexVendasJourneyEvent {
|
|
357
|
+
/**
|
|
358
|
+
* Aberto (string). `data` tipado por evento: `proposal_accepted` →
|
|
359
|
+
* `INexVendasJourneyProposalAcceptedEventData`; `contract_accepted` →
|
|
360
|
+
* `INexVendasJourneyContractAcceptedEventData`.
|
|
361
|
+
*/
|
|
342
362
|
type: string;
|
|
343
363
|
at: Date;
|
|
344
364
|
/** `system`, `customer` ou o id do usuário de backoffice. */
|
|
@@ -405,7 +425,13 @@ export interface INexVendasJourneyLeadRef {
|
|
|
405
425
|
* quando o vendedor edita o `html_content`, e o "já feito" é decidido por
|
|
406
426
|
* comparação de hash antes do claim, não pela presença do campo.
|
|
407
427
|
*/
|
|
408
|
-
export type NexVendasJourneySlot =
|
|
428
|
+
export type NexVendasJourneySlot =
|
|
429
|
+
| 'contract'
|
|
430
|
+
| 'signature'
|
|
431
|
+
| 'payment'
|
|
432
|
+
| 'proposal_pdf'
|
|
433
|
+
/** feat-325 — render do quadro-resumo da adesão. Mutex puro, como `proposal_pdf`. */
|
|
434
|
+
| 'adhesion_document';
|
|
409
435
|
|
|
410
436
|
/**
|
|
411
437
|
* Marca de reserva de um slot, gravada e liberada dentro de transaction.
|
|
@@ -434,6 +460,15 @@ export interface INexVendasJourney extends IFireGlobalDoc {
|
|
|
434
460
|
short_code: string;
|
|
435
461
|
status: NexVendasJourneyStatus;
|
|
436
462
|
origem: NexFinopsProposalOrigem;
|
|
463
|
+
/**
|
|
464
|
+
* Cópia congelada do tipo do modelo de contrato, gravada no submit dos dados
|
|
465
|
+
* (feat-325 D2); imutável depois disso. Ausente = `assinatura_eletronica`.
|
|
466
|
+
*/
|
|
467
|
+
contract_type?: NexVendasContractType | null;
|
|
468
|
+
/** feat-326 — cópia da atribuição da proposta (jornadas de oferta). */
|
|
469
|
+
attribution?: INexVendasAttribution | null;
|
|
470
|
+
/** feat-326 — cópia de `proposal.offer_slug` (chip "Self-service" no dashboard). */
|
|
471
|
+
offer_slug?: string | null;
|
|
437
472
|
|
|
438
473
|
// Vínculos (paths Firestore, não DocumentReference — o doc é lido por HTTP)
|
|
439
474
|
proposal_ref: string;
|
|
@@ -464,6 +499,11 @@ export interface INexVendasJourney extends IFireGlobalDoc {
|
|
|
464
499
|
*/
|
|
465
500
|
proposal_pdf?: INexVendasJourneyProposalPdf | null;
|
|
466
501
|
|
|
502
|
+
/** feat-325 — quadro-resumo + CG congeladas exibidos no passo de aceite (só adesão). */
|
|
503
|
+
adhesion_document?: INexVendasJourneyAdhesionDocument | null;
|
|
504
|
+
/** feat-325 — resumo do aceite por adesão (registro completo em `acceptances/`). */
|
|
505
|
+
acceptance?: INexVendasJourneyAcceptanceRef | null;
|
|
506
|
+
|
|
467
507
|
/**
|
|
468
508
|
* Espelho PLANO de todo id externo de pagamento que a jornada já produziu —
|
|
469
509
|
* checkout, cobrança, assinatura e link, **inclusive os superseded**.
|
|
@@ -549,6 +589,49 @@ export interface INexVendasJourneyPublic {
|
|
|
549
589
|
};
|
|
550
590
|
payment: INexVendasJourneyPaymentPublic;
|
|
551
591
|
contract: { status: NexFinopsContractStatus } | null;
|
|
592
|
+
/**
|
|
593
|
+
* feat-325 — tipo de formalização. O shop ramifica o passo de contrato por ele.
|
|
594
|
+
* Ausente em backend anterior à feat-325 (= `assinatura_eletronica`).
|
|
595
|
+
*/
|
|
596
|
+
contract_type?: NexVendasContractType;
|
|
597
|
+
/** feat-325 — aceite já feito; null antes do aceite ou fora da adesão. */
|
|
598
|
+
acceptance?: INexVendasJourneyAcceptancePublic | null;
|
|
599
|
+
/**
|
|
600
|
+
* feat-325 — documentos da adesão (URLs assinadas curtas + hashes). Antes do
|
|
601
|
+
* aceite: rascunho atual; depois: cópias de evidência, por `document_access_days`.
|
|
602
|
+
* null fora da adesão ou com a janela de acesso vencida.
|
|
603
|
+
*/
|
|
604
|
+
documents?: INexVendasJourneyAdhesionDocumentsPublic | null;
|
|
605
|
+
/**
|
|
606
|
+
* feat-325 D5 — declaração exibida ao lado do checkbox. O texto vem do backend
|
|
607
|
+
* (uma fonte só); `version` volta no corpo do aceite. null fora da adesão.
|
|
608
|
+
*/
|
|
609
|
+
declaration?: { version: string; text: string } | null;
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
/** Aceite na projeção pública: sem IP, user-agent nem ids internos. */
|
|
613
|
+
export interface INexVendasJourneyAcceptancePublic {
|
|
614
|
+
protocol: string;
|
|
615
|
+
accepted_at: Date;
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
/** Um documento da adesão na projeção pública. */
|
|
619
|
+
export interface INexVendasJourneyDocumentPublic {
|
|
620
|
+
/** URL assinada de vida curta (GET direto do PDF). */
|
|
621
|
+
url: string;
|
|
622
|
+
/** SHA-256 hex dos bytes — o shop confere e devolve no aceite. */
|
|
623
|
+
sha256: string;
|
|
624
|
+
}
|
|
625
|
+
|
|
626
|
+
export interface INexVendasJourneyAdhesionDocumentsPublic {
|
|
627
|
+
/** Condições Gerais. */
|
|
628
|
+
cg: INexVendasJourneyDocumentPublic & { version: string; filename: string | null };
|
|
629
|
+
/** Quadro-resumo da jornada. */
|
|
630
|
+
summary: INexVendasJourneyDocumentPublic & { issued_on: string | null };
|
|
631
|
+
/** Comprovante do aceite; null antes do aceite ou enquanto não gerado. */
|
|
632
|
+
receipt: INexVendasJourneyDocumentPublic | null;
|
|
633
|
+
/** Quando as URLs assinadas expiram (o shop refaz o GET depois disso). */
|
|
634
|
+
urls_expire_at: Date;
|
|
552
635
|
}
|
|
553
636
|
|
|
554
637
|
// ── Verificações plugáveis (D1) ──
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Chaves de `core/nexus/apps/nex-vendas/config/notifications` (matriz
|
|
3
|
+
* `configs[chave] → { enabled, channels[kind] }`, mantida pelo `@evo/nex-model`
|
|
4
|
+
* em `vendas-notification-config.ts`). Espelhada aqui para o Nexus e o backend
|
|
5
|
+
* falarem do mesmo catálogo.
|
|
6
|
+
*
|
|
7
|
+
* - `journey_signed`: passo f — contrato assinado (D4Sign), siga para o pagamento;
|
|
8
|
+
* - `journey_accepted` (feat-325 D13): passo f na adesão — contrato aceito, com
|
|
9
|
+
* protocolo. Sem fallback para `journey_signed` (o texto "assinado" estaria
|
|
10
|
+
* errado); configurada é pré-requisito para ativar um modelo de adesão;
|
|
11
|
+
* - `journey_welcome`: passo h — boas-vindas após o 1º pagamento.
|
|
12
|
+
*/
|
|
13
|
+
export declare const NEX_VENDAS_NOTIFICATION_KEYS: readonly ["journey_signed", "journey_accepted", "journey_welcome"];
|
|
14
|
+
export type NexVendasNotificationKey = (typeof NEX_VENDAS_NOTIFICATION_KEYS)[number];
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// ── Chaves da matriz de notificação de vendas ──
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.NEX_VENDAS_NOTIFICATION_KEYS = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Chaves de `core/nexus/apps/nex-vendas/config/notifications` (matriz
|
|
7
|
+
* `configs[chave] → { enabled, channels[kind] }`, mantida pelo `@evo/nex-model`
|
|
8
|
+
* em `vendas-notification-config.ts`). Espelhada aqui para o Nexus e o backend
|
|
9
|
+
* falarem do mesmo catálogo.
|
|
10
|
+
*
|
|
11
|
+
* - `journey_signed`: passo f — contrato assinado (D4Sign), siga para o pagamento;
|
|
12
|
+
* - `journey_accepted` (feat-325 D13): passo f na adesão — contrato aceito, com
|
|
13
|
+
* protocolo. Sem fallback para `journey_signed` (o texto "assinado" estaria
|
|
14
|
+
* errado); configurada é pré-requisito para ativar um modelo de adesão;
|
|
15
|
+
* - `journey_welcome`: passo h — boas-vindas após o 1º pagamento.
|
|
16
|
+
*/
|
|
17
|
+
exports.NEX_VENDAS_NOTIFICATION_KEYS = [
|
|
18
|
+
'journey_signed',
|
|
19
|
+
'journey_accepted',
|
|
20
|
+
'journey_welcome',
|
|
21
|
+
];
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// ── Chaves da matriz de notificação de vendas ──
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Chaves de `core/nexus/apps/nex-vendas/config/notifications` (matriz
|
|
5
|
+
* `configs[chave] → { enabled, channels[kind] }`, mantida pelo `@evo/nex-model`
|
|
6
|
+
* em `vendas-notification-config.ts`). Espelhada aqui para o Nexus e o backend
|
|
7
|
+
* falarem do mesmo catálogo.
|
|
8
|
+
*
|
|
9
|
+
* - `journey_signed`: passo f — contrato assinado (D4Sign), siga para o pagamento;
|
|
10
|
+
* - `journey_accepted` (feat-325 D13): passo f na adesão — contrato aceito, com
|
|
11
|
+
* protocolo. Sem fallback para `journey_signed` (o texto "assinado" estaria
|
|
12
|
+
* errado); configurada é pré-requisito para ativar um modelo de adesão;
|
|
13
|
+
* - `journey_welcome`: passo h — boas-vindas após o 1º pagamento.
|
|
14
|
+
*/
|
|
15
|
+
export const NEX_VENDAS_NOTIFICATION_KEYS = [
|
|
16
|
+
'journey_signed',
|
|
17
|
+
'journey_accepted',
|
|
18
|
+
'journey_welcome',
|
|
19
|
+
] as const;
|
|
20
|
+
|
|
21
|
+
export type NexVendasNotificationKey = (typeof NEX_VENDAS_NOTIFICATION_KEYS)[number];
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type { IFireGlobalDoc } from '../shared';
|
|
2
|
+
import type { NexFinopsProposalLoyaltyPeriod, NexFinopsProposalOrigem, NexFinopsProposalPaymentMethod } from '../evo-finops/common/proposal';
|
|
3
|
+
import type { INexFinopsContractAllowance } from '../evo-finops/common/contract';
|
|
4
|
+
import type { NexVendasContractType } from './adhesion';
|
|
5
|
+
/**
|
|
6
|
+
* Origem de marketing do `start`, capturada pelo shop (query string + `document.referrer`)
|
|
7
|
+
* e gravada server-side, sem cookie, na proposta e na jornada. Cada campo é `null`
|
|
8
|
+
* quando ausente.
|
|
9
|
+
*/
|
|
10
|
+
export interface INexVendasAttribution {
|
|
11
|
+
utm_source?: string | null;
|
|
12
|
+
utm_medium?: string | null;
|
|
13
|
+
utm_campaign?: string | null;
|
|
14
|
+
utm_term?: string | null;
|
|
15
|
+
utm_content?: string | null;
|
|
16
|
+
gclid?: string | null;
|
|
17
|
+
referrer?: string | null;
|
|
18
|
+
/** Slug do site do shop (`site-hm`, `lp-dermato`…). */
|
|
19
|
+
site?: string | null;
|
|
20
|
+
/** Caminho da página de entrada (`/site-hm/o/clinica-essencial`). */
|
|
21
|
+
landing_path?: string | null;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* `data.via` do evento `proposal_accepted` da jornada:
|
|
25
|
+
* - `shop`: o cliente clicou "Aceitar" na página da proposta (caminho original);
|
|
26
|
+
* - `offer_start`: aceite implícito no "Contratar" da oferta (feat-326 D4).
|
|
27
|
+
* Ausente = `shop` (eventos anteriores à feat-326).
|
|
28
|
+
*/
|
|
29
|
+
export type NexVendasProposalAcceptedVia = 'shop' | 'offer_start';
|
|
30
|
+
/** `data` do evento `proposal_accepted`. */
|
|
31
|
+
export interface INexVendasJourneyProposalAcceptedEventData {
|
|
32
|
+
via?: NexVendasProposalAcceptedVia | null;
|
|
33
|
+
/** Só com `via: 'offer_start'`. */
|
|
34
|
+
offer_slug?: string | null;
|
|
35
|
+
}
|
|
36
|
+
/** Collection `core/nexus/apps/nex-vendas/offers/{slug}`. */
|
|
37
|
+
export declare const NEX_VENDAS_OFFERS_COLLECTION = "offers";
|
|
38
|
+
/** `created_by` gravado na proposta gerada pelo `start` de uma oferta. */
|
|
39
|
+
export declare const NEX_VENDAS_OFFER_PROPOSAL_CREATED_BY = "system:offer";
|
|
40
|
+
/** D13 — validade padrão da proposta gerada pela oferta, em dias. */
|
|
41
|
+
export declare const NEX_VENDAS_OFFER_DEFAULT_PROPOSAL_VALID_DAYS = 7;
|
|
42
|
+
/**
|
|
43
|
+
* Oferta padrão: o MOLDE da proposta que o `POST /offers/:slug/start` gera. A
|
|
44
|
+
* proposta é cópia congelada — editar a oferta não muda propostas já geradas.
|
|
45
|
+
* Preço e condições vêm SÓ daqui; texto de marketing é código no shop.
|
|
46
|
+
*
|
|
47
|
+
* Doc id = `slug` (imutável; entra na URL `/:site/o/:slug`).
|
|
48
|
+
*/
|
|
49
|
+
export interface INexVendasOffer extends IFireGlobalDoc {
|
|
50
|
+
slug: string;
|
|
51
|
+
/** Nome interno/vitrine. */
|
|
52
|
+
name: string;
|
|
53
|
+
/** Título curto da vitrine. */
|
|
54
|
+
headline: string;
|
|
55
|
+
description?: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* Corpo HTML da proposta gerada (o mesmo campo que o vendedor preenche na
|
|
58
|
+
* proposta). Ausente/null = proposta gerada com `html_content` vazio.
|
|
59
|
+
*/
|
|
60
|
+
html_content?: string | null;
|
|
61
|
+
/** Mensalidade base em reais (decimal). */
|
|
62
|
+
base_amount: number;
|
|
63
|
+
/** Dia de vencimento copiado para a proposta (1–31). */
|
|
64
|
+
due_day: number;
|
|
65
|
+
/** D10 — v1 aceita só `['card_subscription']` (validado no backend). */
|
|
66
|
+
accepted_payment_methods: NexFinopsProposalPaymentMethod[];
|
|
67
|
+
loyalty_period: NexFinopsProposalLoyaltyPeriod;
|
|
68
|
+
/** D11 — modelo de adesão por padrão; D4Sign permitido para piloto. */
|
|
69
|
+
contract_template_key: string;
|
|
70
|
+
/** Cópia DERIVADA do modelo (backend grava; valor do cliente HTTP é sobrescrito). */
|
|
71
|
+
contract_type?: NexVendasContractType | null;
|
|
72
|
+
/** D12 — `null` na v1 (sem franquia). */
|
|
73
|
+
allowances: Record<string, INexFinopsContractAllowance> | null;
|
|
74
|
+
terms?: string | null;
|
|
75
|
+
/** D13 — `valid_until` da proposta = hoje (SP) + N dias. Padrão 7. */
|
|
76
|
+
proposal_valid_days: number;
|
|
77
|
+
/** Slug do site do shop que exibe a oferta; o `start` confere o site informado. */
|
|
78
|
+
site: string;
|
|
79
|
+
/** `origem` gravado na proposta gerada. Ausente = `site-hm`. */
|
|
80
|
+
origem?: NexFinopsProposalOrigem | null;
|
|
81
|
+
/** Inativa ⇒ `GET` e `start` respondem 404. */
|
|
82
|
+
active: boolean;
|
|
83
|
+
/** Aparece na vitrine `/:site/`. Não listada mas ativa = só por URL direta. */
|
|
84
|
+
listed: boolean;
|
|
85
|
+
/** Uid do usuário Nexus que criou. */
|
|
86
|
+
created_by: string;
|
|
87
|
+
/** Contador de `start` bem-sucedidos (incrementado pelo backend). */
|
|
88
|
+
start_count?: number | null;
|
|
89
|
+
last_start_at?: Date | null;
|
|
90
|
+
}
|
|
91
|
+
/** Projeção pública da oferta (`GET /offers/:slug` e vitrine). Sem campos internos. */
|
|
92
|
+
export interface INexVendasOfferPublic {
|
|
93
|
+
slug: string;
|
|
94
|
+
name: string;
|
|
95
|
+
headline: string;
|
|
96
|
+
description: string | null;
|
|
97
|
+
html_content: string | null;
|
|
98
|
+
base_amount: number;
|
|
99
|
+
due_day: number;
|
|
100
|
+
accepted_payment_methods: NexFinopsProposalPaymentMethod[];
|
|
101
|
+
/** Fidelidade por extenso, pronta para exibir, ou null sem fidelidade. */
|
|
102
|
+
loyalty_period_label: string | null;
|
|
103
|
+
contract_type: NexVendasContractType;
|
|
104
|
+
terms: string | null;
|
|
105
|
+
site: string;
|
|
106
|
+
}
|
|
107
|
+
/** Vitrine: `GET /offers?site=…` lista as ofertas `active && listed` do site. */
|
|
108
|
+
export interface INexVendasOfferListPublic {
|
|
109
|
+
offers: INexVendasOfferPublic[];
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Corpo de `POST /offers/:slug/start` (público). IP e user-agent vêm da requisição.
|
|
113
|
+
* `client_request_id` (UUID do navegador) torna o `start` idempotente por 24 h.
|
|
114
|
+
*/
|
|
115
|
+
export interface INexVendasOfferStartRequest {
|
|
116
|
+
name: string;
|
|
117
|
+
email: string;
|
|
118
|
+
/** Telefone BR; o backend normaliza para E.164. */
|
|
119
|
+
phone: string;
|
|
120
|
+
client_request_id: string;
|
|
121
|
+
turnstile_token: string;
|
|
122
|
+
attribution?: INexVendasAttribution | null;
|
|
123
|
+
privacy_accepted: true;
|
|
124
|
+
}
|
|
125
|
+
/** Resposta do `start`: o shop grava o cookie de retomada e navega para `/:site/j/:short_code/dados`. */
|
|
126
|
+
export interface INexVendasOfferStartResponse {
|
|
127
|
+
ok: true;
|
|
128
|
+
short_code: string;
|
|
129
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NEX_VENDAS_OFFER_DEFAULT_PROPOSAL_VALID_DAYS = exports.NEX_VENDAS_OFFER_PROPOSAL_CREATED_BY = exports.NEX_VENDAS_OFFERS_COLLECTION = void 0;
|
|
4
|
+
// ── Oferta (feat-326 D3) ──
|
|
5
|
+
/** Collection `core/nexus/apps/nex-vendas/offers/{slug}`. */
|
|
6
|
+
exports.NEX_VENDAS_OFFERS_COLLECTION = 'offers';
|
|
7
|
+
/** `created_by` gravado na proposta gerada pelo `start` de uma oferta. */
|
|
8
|
+
exports.NEX_VENDAS_OFFER_PROPOSAL_CREATED_BY = 'system:offer';
|
|
9
|
+
/** D13 — validade padrão da proposta gerada pela oferta, em dias. */
|
|
10
|
+
exports.NEX_VENDAS_OFFER_DEFAULT_PROPOSAL_VALID_DAYS = 7;
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
import type { IFireGlobalDoc } from '../shared';
|
|
2
|
+
import type {
|
|
3
|
+
NexFinopsProposalLoyaltyPeriod,
|
|
4
|
+
NexFinopsProposalOrigem,
|
|
5
|
+
NexFinopsProposalPaymentMethod,
|
|
6
|
+
} from '../evo-finops/common/proposal';
|
|
7
|
+
import type { INexFinopsContractAllowance } from '../evo-finops/common/contract';
|
|
8
|
+
import type { NexVendasContractType } from './adhesion';
|
|
9
|
+
|
|
10
|
+
// ── Atribuição (feat-326 D14) ──
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Origem de marketing do `start`, capturada pelo shop (query string + `document.referrer`)
|
|
14
|
+
* e gravada server-side, sem cookie, na proposta e na jornada. Cada campo é `null`
|
|
15
|
+
* quando ausente.
|
|
16
|
+
*/
|
|
17
|
+
export interface INexVendasAttribution {
|
|
18
|
+
utm_source?: string | null;
|
|
19
|
+
utm_medium?: string | null;
|
|
20
|
+
utm_campaign?: string | null;
|
|
21
|
+
utm_term?: string | null;
|
|
22
|
+
utm_content?: string | null;
|
|
23
|
+
gclid?: string | null;
|
|
24
|
+
referrer?: string | null;
|
|
25
|
+
/** Slug do site do shop (`site-hm`, `lp-dermato`…). */
|
|
26
|
+
site?: string | null;
|
|
27
|
+
/** Caminho da página de entrada (`/site-hm/o/clinica-essencial`). */
|
|
28
|
+
landing_path?: string | null;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* `data.via` do evento `proposal_accepted` da jornada:
|
|
33
|
+
* - `shop`: o cliente clicou "Aceitar" na página da proposta (caminho original);
|
|
34
|
+
* - `offer_start`: aceite implícito no "Contratar" da oferta (feat-326 D4).
|
|
35
|
+
* Ausente = `shop` (eventos anteriores à feat-326).
|
|
36
|
+
*/
|
|
37
|
+
export type NexVendasProposalAcceptedVia = 'shop' | 'offer_start';
|
|
38
|
+
|
|
39
|
+
/** `data` do evento `proposal_accepted`. */
|
|
40
|
+
export interface INexVendasJourneyProposalAcceptedEventData {
|
|
41
|
+
via?: NexVendasProposalAcceptedVia | null;
|
|
42
|
+
/** Só com `via: 'offer_start'`. */
|
|
43
|
+
offer_slug?: string | null;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// ── Oferta (feat-326 D3) ──
|
|
47
|
+
|
|
48
|
+
/** Collection `core/nexus/apps/nex-vendas/offers/{slug}`. */
|
|
49
|
+
export const NEX_VENDAS_OFFERS_COLLECTION = 'offers';
|
|
50
|
+
|
|
51
|
+
/** `created_by` gravado na proposta gerada pelo `start` de uma oferta. */
|
|
52
|
+
export const NEX_VENDAS_OFFER_PROPOSAL_CREATED_BY = 'system:offer';
|
|
53
|
+
|
|
54
|
+
/** D13 — validade padrão da proposta gerada pela oferta, em dias. */
|
|
55
|
+
export const NEX_VENDAS_OFFER_DEFAULT_PROPOSAL_VALID_DAYS = 7;
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Oferta padrão: o MOLDE da proposta que o `POST /offers/:slug/start` gera. A
|
|
59
|
+
* proposta é cópia congelada — editar a oferta não muda propostas já geradas.
|
|
60
|
+
* Preço e condições vêm SÓ daqui; texto de marketing é código no shop.
|
|
61
|
+
*
|
|
62
|
+
* Doc id = `slug` (imutável; entra na URL `/:site/o/:slug`).
|
|
63
|
+
*/
|
|
64
|
+
export interface INexVendasOffer extends IFireGlobalDoc {
|
|
65
|
+
slug: string;
|
|
66
|
+
/** Nome interno/vitrine. */
|
|
67
|
+
name: string;
|
|
68
|
+
/** Título curto da vitrine. */
|
|
69
|
+
headline: string;
|
|
70
|
+
description?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* Corpo HTML da proposta gerada (o mesmo campo que o vendedor preenche na
|
|
73
|
+
* proposta). Ausente/null = proposta gerada com `html_content` vazio.
|
|
74
|
+
*/
|
|
75
|
+
html_content?: string | null;
|
|
76
|
+
|
|
77
|
+
// Condições copiadas para a proposta
|
|
78
|
+
/** Mensalidade base em reais (decimal). */
|
|
79
|
+
base_amount: number;
|
|
80
|
+
/** Dia de vencimento copiado para a proposta (1–31). */
|
|
81
|
+
due_day: number;
|
|
82
|
+
/** D10 — v1 aceita só `['card_subscription']` (validado no backend). */
|
|
83
|
+
accepted_payment_methods: NexFinopsProposalPaymentMethod[];
|
|
84
|
+
loyalty_period: NexFinopsProposalLoyaltyPeriod;
|
|
85
|
+
/** D11 — modelo de adesão por padrão; D4Sign permitido para piloto. */
|
|
86
|
+
contract_template_key: string;
|
|
87
|
+
/** Cópia DERIVADA do modelo (backend grava; valor do cliente HTTP é sobrescrito). */
|
|
88
|
+
contract_type?: NexVendasContractType | null;
|
|
89
|
+
/** D12 — `null` na v1 (sem franquia). */
|
|
90
|
+
allowances: Record<string, INexFinopsContractAllowance> | null;
|
|
91
|
+
terms?: string | null;
|
|
92
|
+
/** D13 — `valid_until` da proposta = hoje (SP) + N dias. Padrão 7. */
|
|
93
|
+
proposal_valid_days: number;
|
|
94
|
+
|
|
95
|
+
// Exposição
|
|
96
|
+
/** Slug do site do shop que exibe a oferta; o `start` confere o site informado. */
|
|
97
|
+
site: string;
|
|
98
|
+
/** `origem` gravado na proposta gerada. Ausente = `site-hm`. */
|
|
99
|
+
origem?: NexFinopsProposalOrigem | null;
|
|
100
|
+
/** Inativa ⇒ `GET` e `start` respondem 404. */
|
|
101
|
+
active: boolean;
|
|
102
|
+
/** Aparece na vitrine `/:site/`. Não listada mas ativa = só por URL direta. */
|
|
103
|
+
listed: boolean;
|
|
104
|
+
|
|
105
|
+
// Auditoria
|
|
106
|
+
/** Uid do usuário Nexus que criou. */
|
|
107
|
+
created_by: string;
|
|
108
|
+
/** Contador de `start` bem-sucedidos (incrementado pelo backend). */
|
|
109
|
+
start_count?: number | null;
|
|
110
|
+
last_start_at?: Date | null;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/** Projeção pública da oferta (`GET /offers/:slug` e vitrine). Sem campos internos. */
|
|
114
|
+
export interface INexVendasOfferPublic {
|
|
115
|
+
slug: string;
|
|
116
|
+
name: string;
|
|
117
|
+
headline: string;
|
|
118
|
+
description: string | null;
|
|
119
|
+
html_content: string | null;
|
|
120
|
+
base_amount: number;
|
|
121
|
+
due_day: number;
|
|
122
|
+
accepted_payment_methods: NexFinopsProposalPaymentMethod[];
|
|
123
|
+
/** Fidelidade por extenso, pronta para exibir, ou null sem fidelidade. */
|
|
124
|
+
loyalty_period_label: string | null;
|
|
125
|
+
contract_type: NexVendasContractType;
|
|
126
|
+
terms: string | null;
|
|
127
|
+
site: string;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/** Vitrine: `GET /offers?site=…` lista as ofertas `active && listed` do site. */
|
|
131
|
+
export interface INexVendasOfferListPublic {
|
|
132
|
+
offers: INexVendasOfferPublic[];
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Corpo de `POST /offers/:slug/start` (público). IP e user-agent vêm da requisição.
|
|
137
|
+
* `client_request_id` (UUID do navegador) torna o `start` idempotente por 24 h.
|
|
138
|
+
*/
|
|
139
|
+
export interface INexVendasOfferStartRequest {
|
|
140
|
+
name: string;
|
|
141
|
+
email: string;
|
|
142
|
+
/** Telefone BR; o backend normaliza para E.164. */
|
|
143
|
+
phone: string;
|
|
144
|
+
client_request_id: string;
|
|
145
|
+
turnstile_token: string;
|
|
146
|
+
attribution?: INexVendasAttribution | null;
|
|
147
|
+
privacy_accepted: true;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/** Resposta do `start`: o shop grava o cookie de retomada e navega para `/:site/j/:short_code/dados`. */
|
|
151
|
+
export interface INexVendasOfferStartResponse {
|
|
152
|
+
ok: true;
|
|
153
|
+
short_code: string;
|
|
154
|
+
}
|