evo360-types 1.3.811 → 1.3.816
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-csq/zod-schemas.d.ts +62 -62
- package/dist/apps/evo-finops/zod-schemas.d.ts +304 -22
- package/dist/apps/evo-finops/zod-schemas.js +65 -7
- package/dist/apps/evo-finops/zod-schemas.ts +68 -5
- package/dist/apps/evo-modules/zod-schemas.d.ts +4 -4
- package/dist/types/evo-finops/common/contract.d.ts +10 -0
- package/dist/types/evo-finops/common/contract.ts +13 -0
- package/dist/types/evo-finops/common/proposal.d.ts +13 -0
- package/dist/types/evo-finops/common/proposal.ts +16 -0
- package/dist/types/nex-vendas/adhesion.d.ts +37 -4
- package/dist/types/nex-vendas/adhesion.ts +38 -4
- package/dist/types/nex-vendas/index.d.ts +1 -0
- package/dist/types/nex-vendas/index.js +1 -0
- package/dist/types/nex-vendas/index.ts +1 -0
- package/dist/types/nex-vendas/journey.d.ts +8 -0
- package/dist/types/nex-vendas/journey.ts +6 -0
- package/dist/types/nex-vendas/offer-package.d.ts +165 -0
- package/dist/types/nex-vendas/offer-package.js +255 -0
- package/dist/types/nex-vendas/offer-package.ts +387 -0
- package/dist/types/nex-vendas/offer.d.ts +15 -1
- package/dist/types/nex-vendas/offer.ts +15 -1
- package/package.json +1 -1
|
@@ -976,7 +976,11 @@ export const zNexFinopsProposalWriteSchema = z
|
|
|
976
976
|
* sobrescrito). Está no schema para o backend não perder o campo no `.strip()`.
|
|
977
977
|
*/
|
|
978
978
|
contract_type: zNexVendasContractTypeSchema.optional().nullable(),
|
|
979
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* feat-326 — preenchidos pelo `start` da oferta; no CRUD do vendedor ficam ausentes.
|
|
981
|
+
* feat-353: `package` (cópia congelada do pacote) NÃO entra aqui de propósito — só o
|
|
982
|
+
* `start` grava, direto no documento; o PUT/POST de proposta descarta.
|
|
983
|
+
*/
|
|
980
984
|
offer_slug: z.string().max(64).optional().nullable(),
|
|
981
985
|
attribution: zNexVendasAttributionSchema.optional().nullable(),
|
|
982
986
|
client_request_id: z.string().max(64).optional().nullable(),
|
|
@@ -1144,6 +1148,50 @@ export const zNexFinopsContractAllowancesSchema = z.record(
|
|
|
1144
1148
|
zNexFinopsContractAllowanceSchema,
|
|
1145
1149
|
);
|
|
1146
1150
|
|
|
1151
|
+
// ---- Nexus Vendas — pacote da oferta (feat-353) ----
|
|
1152
|
+
//
|
|
1153
|
+
// Só a FORMA (chave/tipo). Regras de negócio (todos os módulos do catálogo
|
|
1154
|
+
// declarados, capability do catálogo com o tipo do default, franquia de módulo
|
|
1155
|
+
// desligado, `list_amount > base_amount`, categoria ≠ SSR, tabela existente…)
|
|
1156
|
+
// ficam no backend (`validateOfferPackage`).
|
|
1157
|
+
|
|
1158
|
+
/** Estado de um módulo no pacote (`INexVendasPackageModule`). */
|
|
1159
|
+
export const zNexVendasPackageModuleSchema = z
|
|
1160
|
+
.object({
|
|
1161
|
+
enabled: z.boolean(),
|
|
1162
|
+
capabilities: z
|
|
1163
|
+
.record(z.string().min(1).max(64), z.union([z.boolean(), z.number().finite(), z.string().max(255)]))
|
|
1164
|
+
.nullable()
|
|
1165
|
+
.optional(),
|
|
1166
|
+
})
|
|
1167
|
+
.strip();
|
|
1168
|
+
|
|
1169
|
+
/** Módulos do pacote por chave do catálogo (`PLATFORM_MODULE_CATALOG`). */
|
|
1170
|
+
export const zNexVendasPackageModulesSchema = z.record(z.string().min(1).max(64), zNexVendasPackageModuleSchema);
|
|
1171
|
+
|
|
1172
|
+
/** Franquia só exibida (`INexVendasPackageDisplayAllowance`). */
|
|
1173
|
+
export const zNexVendasPackageDisplayAllowanceSchema = z
|
|
1174
|
+
.object({
|
|
1175
|
+
metric: z.string().min(1).max(64),
|
|
1176
|
+
included: z.number().int().nonnegative(),
|
|
1177
|
+
})
|
|
1178
|
+
.strip();
|
|
1179
|
+
|
|
1180
|
+
/** Pacote comercial da oferta (`INexVendasOfferPackage`). Cobre TODOS os campos. */
|
|
1181
|
+
export const zNexVendasOfferPackageSchema = z
|
|
1182
|
+
.object({
|
|
1183
|
+
price_table_id: z.string().min(1).max(128),
|
|
1184
|
+
list_amount: z.number().finite().nonnegative().nullable().optional(),
|
|
1185
|
+
fixed_service_category: z.string().min(1).max(32).nullable().optional(),
|
|
1186
|
+
fixed_service_description: z.string().max(255).nullable().optional(),
|
|
1187
|
+
modules: zNexVendasPackageModulesSchema,
|
|
1188
|
+
allowances: zNexFinopsContractAllowancesSchema,
|
|
1189
|
+
display_allowances: z.array(zNexVendasPackageDisplayAllowanceSchema).max(20).nullable().optional(),
|
|
1190
|
+
not_included: z.array(z.string().min(1).max(255)).max(20).nullable().optional(),
|
|
1191
|
+
highlights: z.array(z.string().min(1).max(255)).max(20).nullable().optional(),
|
|
1192
|
+
})
|
|
1193
|
+
.strip();
|
|
1194
|
+
|
|
1147
1195
|
/**
|
|
1148
1196
|
* Gatilho de alerta: **fração** da franquia, não percentual — `0.8` é 80%.
|
|
1149
1197
|
* `0` é rejeitado porque dispararia em qualquer consumo.
|
|
@@ -1179,6 +1227,10 @@ export const zNexFinopsContractAllowancesWriteSchema = z
|
|
|
1179
1227
|
nfse_fee_reimbursement: z.boolean().optional().nullable(),
|
|
1180
1228
|
/** feat-328 — tabela de preço do contrato. Ausente/null = tabela padrão. */
|
|
1181
1229
|
price_table_id: z.string().min(1).nullable().optional(),
|
|
1230
|
+
/** feat-353 — snapshot dos módulos vendidos (autoritativo no runner da feat-297). */
|
|
1231
|
+
package_modules: zNexVendasPackageModulesSchema.nullable().optional(),
|
|
1232
|
+
/** feat-353 — slug da oferta de origem. */
|
|
1233
|
+
offer_slug: z.string().max(64).nullable().optional(),
|
|
1182
1234
|
})
|
|
1183
1235
|
.strip();
|
|
1184
1236
|
|
|
@@ -1379,18 +1431,26 @@ export const zNfseFeeReimbursementExecuteSchema = z
|
|
|
1379
1431
|
const zSha256HexSchema = z.string().regex(/^[a-f0-9]{64}$/, "sha256 must be 64 lowercase hex chars");
|
|
1380
1432
|
|
|
1381
1433
|
/**
|
|
1382
|
-
* Corpo de `POST /journeys/:short_code/
|
|
1434
|
+
* Corpo de `POST /journeys/:short_code/acceptance` (público). IP, user-agent,
|
|
1383
1435
|
* idioma e trace vêm da requisição, nunca do corpo.
|
|
1436
|
+
*
|
|
1437
|
+
* feat-353: `contract_sha256` (contrato consolidado) OU o par legado
|
|
1438
|
+
* `cg_sha256` + `summary_sha256` — qual deles vale é decidido pelo documento da
|
|
1439
|
+
* jornada no backend.
|
|
1384
1440
|
*/
|
|
1385
1441
|
export const zNexVendasAcceptanceRequestSchema = z
|
|
1386
1442
|
.object({
|
|
1387
|
-
|
|
1388
|
-
|
|
1443
|
+
contract_sha256: zSha256HexSchema.optional(),
|
|
1444
|
+
cg_sha256: zSha256HexSchema.optional(),
|
|
1445
|
+
summary_sha256: zSha256HexSchema.optional(),
|
|
1389
1446
|
declaration_version: z.string().min(1).max(64),
|
|
1390
1447
|
viewed_to_end: z.boolean(),
|
|
1391
1448
|
client_request_id: z.string().min(8).max(64),
|
|
1392
1449
|
})
|
|
1393
|
-
.strip()
|
|
1450
|
+
.strip()
|
|
1451
|
+
.refine((body) => Boolean(body.contract_sha256) || (Boolean(body.cg_sha256) && Boolean(body.summary_sha256)), {
|
|
1452
|
+
message: "contract_sha256 (or cg_sha256 + summary_sha256) is required",
|
|
1453
|
+
});
|
|
1394
1454
|
|
|
1395
1455
|
/** Bloco `adhesion` do modelo de contrato (metadados das CG gravados pelo backend no upload). */
|
|
1396
1456
|
export const zNexVendasContractTemplateAdhesionSchema = z
|
|
@@ -1450,7 +1510,10 @@ export const zNexVendasOfferWriteSchema = z
|
|
|
1450
1510
|
loyalty_period: zNexFinopsProposalLoyaltyPeriodSchema,
|
|
1451
1511
|
contract_template_key: z.string().min(1).max(64),
|
|
1452
1512
|
contract_type: zNexVendasContractTypeSchema.optional().nullable(),
|
|
1513
|
+
/** @deprecated feat-353 — usar `package.allowances` (o backend força null). */
|
|
1453
1514
|
allowances: zNexFinopsContractAllowancesSchema.nullable(),
|
|
1515
|
+
/** feat-353 — pacote comercial. Ausente/null = oferta v1. */
|
|
1516
|
+
package: zNexVendasOfferPackageSchema.nullable().optional(),
|
|
1454
1517
|
terms: z.string().optional().nullable(),
|
|
1455
1518
|
proposal_valid_days: z.number().int().min(1).max(90),
|
|
1456
1519
|
site: z.string().min(1).max(64),
|
|
@@ -65,13 +65,13 @@ export declare const zModuleChangeRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
65
65
|
suspend?: boolean | undefined;
|
|
66
66
|
};
|
|
67
67
|
reason: string;
|
|
68
|
-
action: "trial" | "enable" | "disable" | "override" | "configure";
|
|
69
68
|
module: string;
|
|
69
|
+
action: "trial" | "override" | "enable" | "disable" | "configure";
|
|
70
70
|
}, {
|
|
71
71
|
tenant: string;
|
|
72
72
|
reason: string;
|
|
73
|
-
action: "trial" | "enable" | "disable" | "override" | "configure";
|
|
74
73
|
module: string;
|
|
74
|
+
action: "trial" | "override" | "enable" | "disable" | "configure";
|
|
75
75
|
params?: {
|
|
76
76
|
capabilities?: Record<string, string | number | boolean> | undefined;
|
|
77
77
|
expires_at?: unknown;
|
|
@@ -91,13 +91,13 @@ export declare const zModuleChangeRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
91
91
|
suspend?: boolean | undefined;
|
|
92
92
|
};
|
|
93
93
|
reason: string;
|
|
94
|
-
action: "trial" | "enable" | "disable" | "override" | "configure";
|
|
95
94
|
module: string;
|
|
95
|
+
action: "trial" | "override" | "enable" | "disable" | "configure";
|
|
96
96
|
}, {
|
|
97
97
|
tenant: string;
|
|
98
98
|
reason: string;
|
|
99
|
-
action: "trial" | "enable" | "disable" | "override" | "configure";
|
|
100
99
|
module: string;
|
|
100
|
+
action: "trial" | "override" | "enable" | "disable" | "configure";
|
|
101
101
|
params?: {
|
|
102
102
|
capabilities?: Record<string, string | number | boolean> | undefined;
|
|
103
103
|
expires_at?: unknown;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { NexFinopsBillingMode } from './billing-statement';
|
|
2
2
|
import type { IFireGlobalDoc } from '../../shared';
|
|
3
3
|
import type { NexVendasContractType } from '../../nex-vendas/adhesion';
|
|
4
|
+
import type { INexVendasPackageModule } from '../../nex-vendas/offer-package';
|
|
4
5
|
/**
|
|
5
6
|
* `cancellation_requested`: o cliente pediu o cancelamento e o contrato está em
|
|
6
7
|
* processo de encerramento — mas **continua em vigência** e continua faturando
|
|
@@ -228,6 +229,15 @@ export interface INexFinopsContract extends IFireGlobalDoc {
|
|
|
228
229
|
* (validação de escrita entra na F5; até lá o campo só é lido).
|
|
229
230
|
*/
|
|
230
231
|
billing_mode?: NexFinopsBillingMode;
|
|
232
|
+
/**
|
|
233
|
+
* Snapshot dos módulos vendidos (cópia de `proposal.package.modules`).
|
|
234
|
+
* Presente ⇒ o runner da feat-297 trata como AUTORITATIVO (liga só os
|
|
235
|
+
* `enabled`, exclui defaults desligados, aplica `capabilities`). Ausente =
|
|
236
|
+
* defaults do catálogo (comportamento anterior). Mudar não re-provisiona.
|
|
237
|
+
*/
|
|
238
|
+
package_modules?: Record<string, INexVendasPackageModule> | null;
|
|
239
|
+
/** Slug da oferta de origem (auditoria/relatório). Ausente = contrato sem oferta. */
|
|
240
|
+
offer_slug?: string | null;
|
|
231
241
|
}
|
|
232
242
|
export declare const NEX_FINOPS_CONTRACT_STATUS_TRANSITIONS: Record<NexFinopsContractStatus, NexFinopsContractStatus[]>;
|
|
233
243
|
/**
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { NexFinopsBillingMode } from './billing-statement';
|
|
2
2
|
import type { IFireGlobalDoc } from '../../shared';
|
|
3
3
|
import type { NexVendasContractType } from '../../nex-vendas/adhesion';
|
|
4
|
+
import type { INexVendasPackageModule } from '../../nex-vendas/offer-package';
|
|
4
5
|
|
|
5
6
|
// ── Status & Recurrence ──
|
|
6
7
|
|
|
@@ -269,6 +270,18 @@ export interface INexFinopsContract extends IFireGlobalDoc {
|
|
|
269
270
|
* (validação de escrita entra na F5; até lá o campo só é lido).
|
|
270
271
|
*/
|
|
271
272
|
billing_mode?: NexFinopsBillingMode;
|
|
273
|
+
|
|
274
|
+
// ── Pacote da oferta (feat-353) ──
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* Snapshot dos módulos vendidos (cópia de `proposal.package.modules`).
|
|
278
|
+
* Presente ⇒ o runner da feat-297 trata como AUTORITATIVO (liga só os
|
|
279
|
+
* `enabled`, exclui defaults desligados, aplica `capabilities`). Ausente =
|
|
280
|
+
* defaults do catálogo (comportamento anterior). Mudar não re-provisiona.
|
|
281
|
+
*/
|
|
282
|
+
package_modules?: Record<string, INexVendasPackageModule> | null;
|
|
283
|
+
/** Slug da oferta de origem (auditoria/relatório). Ausente = contrato sem oferta. */
|
|
284
|
+
offer_slug?: string | null;
|
|
272
285
|
}
|
|
273
286
|
|
|
274
287
|
// ── Status transitions ──
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { IFireGlobalDoc } from '../../shared';
|
|
2
2
|
import type { NexVendasContractType } from '../../nex-vendas/adhesion';
|
|
3
3
|
import type { INexVendasAttribution } from '../../nex-vendas/offer';
|
|
4
|
+
import type { INexVendasOfferPackage, INexVendasPackageDisplay } from '../../nex-vendas/offer-package';
|
|
4
5
|
/**
|
|
5
6
|
* `viewed` é carimbado pelo endpoint público no primeiro acesso ao `short_code`.
|
|
6
7
|
* `expired` é **derivado** de `valid_until` na leitura (não há cron): o documento
|
|
@@ -111,6 +112,12 @@ export interface INexFinopsProposal extends IFireGlobalDoc {
|
|
|
111
112
|
* para a proposta gerada por oferta. Ausente em propostas anteriores à feat-326.
|
|
112
113
|
*/
|
|
113
114
|
created_by?: string | null;
|
|
115
|
+
/**
|
|
116
|
+
* Cópia CONGELADA de `offer.package` no `start`. Só o backend grava (como
|
|
117
|
+
* `offer_slug`): NÃO entra no `zNexFinopsProposalWriteSchema`. Ausente =
|
|
118
|
+
* proposta sem pacote (vendedor ou oferta v1).
|
|
119
|
+
*/
|
|
120
|
+
package?: INexVendasOfferPackage | null;
|
|
114
121
|
}
|
|
115
122
|
/** O que o endpoint sem auth expõe. Sem ids internos, sem dado sensível. */
|
|
116
123
|
export interface INexFinopsProposalPublic {
|
|
@@ -160,6 +167,12 @@ export interface INexFinopsProposalPublic {
|
|
|
160
167
|
prefill_masked: {
|
|
161
168
|
name: string | null;
|
|
162
169
|
};
|
|
170
|
+
/**
|
|
171
|
+
* feat-353 — pacote pronto para exibir, do snapshot da proposta + tabela de preço
|
|
172
|
+
* resolvida NA LEITURA (o contrato é atrelado à tabela, não congela). Ausente/null =
|
|
173
|
+
* proposta sem pacote ou backend anterior à feat-353.
|
|
174
|
+
*/
|
|
175
|
+
package_display?: INexVendasPackageDisplay | null;
|
|
163
176
|
}
|
|
164
177
|
/** Mesmos campos de `INexFinopsProposalPrefill`, cada um `null` quando ausente. */
|
|
165
178
|
export interface INexFinopsProposalPublicPrefill {
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { IFireGlobalDoc } from '../../shared';
|
|
2
2
|
import type { NexVendasContractType } from '../../nex-vendas/adhesion';
|
|
3
3
|
import type { INexVendasAttribution } from '../../nex-vendas/offer';
|
|
4
|
+
import type { INexVendasOfferPackage, INexVendasPackageDisplay } from '../../nex-vendas/offer-package';
|
|
4
5
|
|
|
5
6
|
// ── Status, origem e formas de pagamento ──
|
|
6
7
|
|
|
@@ -147,6 +148,15 @@ export interface INexFinopsProposal extends IFireGlobalDoc {
|
|
|
147
148
|
* para a proposta gerada por oferta. Ausente em propostas anteriores à feat-326.
|
|
148
149
|
*/
|
|
149
150
|
created_by?: string | null;
|
|
151
|
+
|
|
152
|
+
// ── Pacote (feat-353) ──
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Cópia CONGELADA de `offer.package` no `start`. Só o backend grava (como
|
|
156
|
+
* `offer_slug`): NÃO entra no `zNexFinopsProposalWriteSchema`. Ausente =
|
|
157
|
+
* proposta sem pacote (vendedor ou oferta v1).
|
|
158
|
+
*/
|
|
159
|
+
package?: INexVendasOfferPackage | null;
|
|
150
160
|
}
|
|
151
161
|
|
|
152
162
|
// ── Projeção pública ──
|
|
@@ -197,6 +207,12 @@ export interface INexFinopsProposalPublic {
|
|
|
197
207
|
* ainda não lê `prefill`.
|
|
198
208
|
*/
|
|
199
209
|
prefill_masked: { name: string | null };
|
|
210
|
+
/**
|
|
211
|
+
* feat-353 — pacote pronto para exibir, do snapshot da proposta + tabela de preço
|
|
212
|
+
* resolvida NA LEITURA (o contrato é atrelado à tabela, não congela). Ausente/null =
|
|
213
|
+
* proposta sem pacote ou backend anterior à feat-353.
|
|
214
|
+
*/
|
|
215
|
+
package_display?: INexVendasPackageDisplay | null;
|
|
200
216
|
}
|
|
201
217
|
|
|
202
218
|
/** Mesmos campos de `INexFinopsProposalPrefill`, cada um `null` quando ausente. */
|
|
@@ -77,6 +77,16 @@ export interface INexVendasJourneyAdhesionDocument {
|
|
|
77
77
|
rendered_at: Date;
|
|
78
78
|
/** Quantas vezes o quadro foi regerado por correção de dados (teto D10). */
|
|
79
79
|
corrections_count: number;
|
|
80
|
+
/**
|
|
81
|
+
* feat-353 — CONTRATO CONSOLIDADO: um PDF só, com as páginas do quadro-resumo
|
|
82
|
+
* preenchido seguidas das páginas das CG (`cg_sha256`). É o documento que o shop
|
|
83
|
+
* oferece, que o aceite amarra (hash dos BYTES) e que vai no e-mail.
|
|
84
|
+
* Ausente em documento anterior à feat-353 (quadro e CG separados): a jornada em
|
|
85
|
+
* `dados_coletados` sem ele regera o documento (motivo `missing`).
|
|
86
|
+
*/
|
|
87
|
+
contract_sha256?: string | null;
|
|
88
|
+
/** feat-353 — caminho do contrato consolidado pendente no bucket de evidências. */
|
|
89
|
+
contract_storage_path?: string | null;
|
|
80
90
|
}
|
|
81
91
|
/**
|
|
82
92
|
* Resumo do aceite gravado na jornada (o registro completo é `INexVendasAcceptance`).
|
|
@@ -105,6 +115,8 @@ export interface INexVendasJourneyContractAcceptedEventData {
|
|
|
105
115
|
cg_sha256: string;
|
|
106
116
|
cg_version: string;
|
|
107
117
|
declaration_version: string;
|
|
118
|
+
/** feat-353 — hash do contrato consolidado aceito. Ausente em aceite anterior à feat-353. */
|
|
119
|
+
contract_sha256?: string | null;
|
|
108
120
|
}
|
|
109
121
|
/** Collection `core/nexus/apps/nex-vendas/acceptances/{acceptance_id}` (append-only). */
|
|
110
122
|
export declare const NEX_VENDAS_ACCEPTANCES_COLLECTION = "acceptances";
|
|
@@ -122,6 +134,15 @@ export interface INexVendasAcceptanceSummary {
|
|
|
122
134
|
storage_path: string;
|
|
123
135
|
issued_on?: string | null;
|
|
124
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* feat-353 — contrato consolidado aceito (quadro-resumo preenchido + CG num PDF só).
|
|
139
|
+
* `sha256` dos BYTES; é o hash que o shop devolveu no aceite.
|
|
140
|
+
*/
|
|
141
|
+
export interface INexVendasAcceptanceContract {
|
|
142
|
+
sha256: string;
|
|
143
|
+
/** Caminho da cópia no bucket de evidências (`{short_code}/{acceptance_id}/contract.pdf`). */
|
|
144
|
+
storage_path: string;
|
|
145
|
+
}
|
|
125
146
|
/** Declaração exibida ao lado do checkbox, como estava no momento do aceite. */
|
|
126
147
|
export interface INexVendasAcceptanceDeclaration {
|
|
127
148
|
version: string;
|
|
@@ -196,8 +217,14 @@ export interface INexVendasAcceptance {
|
|
|
196
217
|
contract_type: 'adesao';
|
|
197
218
|
template_key: string;
|
|
198
219
|
template_revision: number;
|
|
220
|
+
/** CG ORIGINAIS (versão do modelo): o `sha256` é o do PDF das CG, não o do consolidado. */
|
|
199
221
|
cg: INexVendasAcceptanceCg;
|
|
200
222
|
summary: INexVendasAcceptanceSummary;
|
|
223
|
+
/**
|
|
224
|
+
* feat-353 — contrato consolidado aceito. Ausente/null em aceite anterior à
|
|
225
|
+
* feat-353 (o cliente recebeu quadro e CG separados).
|
|
226
|
+
*/
|
|
227
|
+
contract?: INexVendasAcceptanceContract | null;
|
|
201
228
|
declaration: INexVendasAcceptanceDeclaration;
|
|
202
229
|
identity: INexVendasAcceptanceIdentity;
|
|
203
230
|
client: INexVendasAcceptanceClient;
|
|
@@ -213,15 +240,21 @@ export interface INexVendasAcceptance {
|
|
|
213
240
|
created_at: Date;
|
|
214
241
|
}
|
|
215
242
|
/**
|
|
216
|
-
* Corpo de `POST /journeys/:short_code/
|
|
243
|
+
* Corpo de `POST /journeys/:short_code/acceptance` (público, `short_code`).
|
|
217
244
|
*
|
|
218
|
-
* Os hashes são dos BYTES que o shop
|
|
245
|
+
* Os hashes são dos BYTES que o shop baixou; divergência do documento atual ⇒ 409
|
|
219
246
|
* `document_changed` e nada é gravado. IP, user-agent, idioma e trace o servidor lê
|
|
220
247
|
* da requisição — nunca do corpo.
|
|
248
|
+
*
|
|
249
|
+
* feat-353: documento com contrato consolidado exige `contract_sha256`
|
|
250
|
+
* (`cg_sha256`/`summary_sha256` opcionais; se vierem, também são conferidos).
|
|
251
|
+
* Documento anterior (sem consolidado) exige `cg_sha256` + `summary_sha256`.
|
|
221
252
|
*/
|
|
222
253
|
export interface INexVendasAcceptanceRequest {
|
|
223
|
-
|
|
224
|
-
|
|
254
|
+
/** feat-353 — SHA-256 dos bytes do contrato consolidado. */
|
|
255
|
+
contract_sha256?: string | null;
|
|
256
|
+
cg_sha256?: string | null;
|
|
257
|
+
summary_sha256?: string | null;
|
|
225
258
|
declaration_version: string;
|
|
226
259
|
viewed_to_end: boolean;
|
|
227
260
|
/** UUID gerado pelo navegador por tentativa de aceite. */
|
|
@@ -90,6 +90,16 @@ export interface INexVendasJourneyAdhesionDocument {
|
|
|
90
90
|
rendered_at: Date;
|
|
91
91
|
/** Quantas vezes o quadro foi regerado por correção de dados (teto D10). */
|
|
92
92
|
corrections_count: number;
|
|
93
|
+
/**
|
|
94
|
+
* feat-353 — CONTRATO CONSOLIDADO: um PDF só, com as páginas do quadro-resumo
|
|
95
|
+
* preenchido seguidas das páginas das CG (`cg_sha256`). É o documento que o shop
|
|
96
|
+
* oferece, que o aceite amarra (hash dos BYTES) e que vai no e-mail.
|
|
97
|
+
* Ausente em documento anterior à feat-353 (quadro e CG separados): a jornada em
|
|
98
|
+
* `dados_coletados` sem ele regera o documento (motivo `missing`).
|
|
99
|
+
*/
|
|
100
|
+
contract_sha256?: string | null;
|
|
101
|
+
/** feat-353 — caminho do contrato consolidado pendente no bucket de evidências. */
|
|
102
|
+
contract_storage_path?: string | null;
|
|
93
103
|
}
|
|
94
104
|
|
|
95
105
|
/**
|
|
@@ -120,6 +130,8 @@ export interface INexVendasJourneyContractAcceptedEventData {
|
|
|
120
130
|
cg_sha256: string;
|
|
121
131
|
cg_version: string;
|
|
122
132
|
declaration_version: string;
|
|
133
|
+
/** feat-353 — hash do contrato consolidado aceito. Ausente em aceite anterior à feat-353. */
|
|
134
|
+
contract_sha256?: string | null;
|
|
123
135
|
}
|
|
124
136
|
|
|
125
137
|
// ── Registro imutável do aceite ──
|
|
@@ -143,6 +155,16 @@ export interface INexVendasAcceptanceSummary {
|
|
|
143
155
|
issued_on?: string | null;
|
|
144
156
|
}
|
|
145
157
|
|
|
158
|
+
/**
|
|
159
|
+
* feat-353 — contrato consolidado aceito (quadro-resumo preenchido + CG num PDF só).
|
|
160
|
+
* `sha256` dos BYTES; é o hash que o shop devolveu no aceite.
|
|
161
|
+
*/
|
|
162
|
+
export interface INexVendasAcceptanceContract {
|
|
163
|
+
sha256: string;
|
|
164
|
+
/** Caminho da cópia no bucket de evidências (`{short_code}/{acceptance_id}/contract.pdf`). */
|
|
165
|
+
storage_path: string;
|
|
166
|
+
}
|
|
167
|
+
|
|
146
168
|
/** Declaração exibida ao lado do checkbox, como estava no momento do aceite. */
|
|
147
169
|
export interface INexVendasAcceptanceDeclaration {
|
|
148
170
|
version: string;
|
|
@@ -219,8 +241,14 @@ export interface INexVendasAcceptance {
|
|
|
219
241
|
contract_type: 'adesao';
|
|
220
242
|
template_key: string;
|
|
221
243
|
template_revision: number;
|
|
244
|
+
/** CG ORIGINAIS (versão do modelo): o `sha256` é o do PDF das CG, não o do consolidado. */
|
|
222
245
|
cg: INexVendasAcceptanceCg;
|
|
223
246
|
summary: INexVendasAcceptanceSummary;
|
|
247
|
+
/**
|
|
248
|
+
* feat-353 — contrato consolidado aceito. Ausente/null em aceite anterior à
|
|
249
|
+
* feat-353 (o cliente recebeu quadro e CG separados).
|
|
250
|
+
*/
|
|
251
|
+
contract?: INexVendasAcceptanceContract | null;
|
|
224
252
|
declaration: INexVendasAcceptanceDeclaration;
|
|
225
253
|
identity: INexVendasAcceptanceIdentity;
|
|
226
254
|
client: INexVendasAcceptanceClient;
|
|
@@ -237,15 +265,21 @@ export interface INexVendasAcceptance {
|
|
|
237
265
|
}
|
|
238
266
|
|
|
239
267
|
/**
|
|
240
|
-
* Corpo de `POST /journeys/:short_code/
|
|
268
|
+
* Corpo de `POST /journeys/:short_code/acceptance` (público, `short_code`).
|
|
241
269
|
*
|
|
242
|
-
* Os hashes são dos BYTES que o shop
|
|
270
|
+
* Os hashes são dos BYTES que o shop baixou; divergência do documento atual ⇒ 409
|
|
243
271
|
* `document_changed` e nada é gravado. IP, user-agent, idioma e trace o servidor lê
|
|
244
272
|
* da requisição — nunca do corpo.
|
|
273
|
+
*
|
|
274
|
+
* feat-353: documento com contrato consolidado exige `contract_sha256`
|
|
275
|
+
* (`cg_sha256`/`summary_sha256` opcionais; se vierem, também são conferidos).
|
|
276
|
+
* Documento anterior (sem consolidado) exige `cg_sha256` + `summary_sha256`.
|
|
245
277
|
*/
|
|
246
278
|
export interface INexVendasAcceptanceRequest {
|
|
247
|
-
|
|
248
|
-
|
|
279
|
+
/** feat-353 — SHA-256 dos bytes do contrato consolidado. */
|
|
280
|
+
contract_sha256?: string | null;
|
|
281
|
+
cg_sha256?: string | null;
|
|
282
|
+
summary_sha256?: string | null;
|
|
249
283
|
declaration_version: string;
|
|
250
284
|
viewed_to_end: boolean;
|
|
251
285
|
/** UUID gerado pelo navegador por tentativa de aceite. */
|
|
@@ -496,6 +496,14 @@ export interface INexVendasJourneyAdhesionDocumentsPublic {
|
|
|
496
496
|
summary: INexVendasJourneyDocumentPublic & {
|
|
497
497
|
issued_on: string | null;
|
|
498
498
|
};
|
|
499
|
+
/**
|
|
500
|
+
* feat-353 — contrato consolidado (quadro-resumo preenchido + CG num PDF só). É o
|
|
501
|
+
* documento que o shop oferece e cujo hash devolve no aceite. null/ausente em
|
|
502
|
+
* documento anterior à feat-353 (aí valem `cg` + `summary`).
|
|
503
|
+
*/
|
|
504
|
+
contract?: (INexVendasJourneyDocumentPublic & {
|
|
505
|
+
filename: string;
|
|
506
|
+
}) | null;
|
|
499
507
|
/** Comprovante do aceite; null antes do aceite ou enquanto não gerado. */
|
|
500
508
|
receipt: INexVendasJourneyDocumentPublic | null;
|
|
501
509
|
/** Quando as URLs assinadas expiram (o shop refaz o GET depois disso). */
|
|
@@ -628,6 +628,12 @@ export interface INexVendasJourneyAdhesionDocumentsPublic {
|
|
|
628
628
|
cg: INexVendasJourneyDocumentPublic & { version: string; filename: string | null };
|
|
629
629
|
/** Quadro-resumo da jornada. */
|
|
630
630
|
summary: INexVendasJourneyDocumentPublic & { issued_on: string | null };
|
|
631
|
+
/**
|
|
632
|
+
* feat-353 — contrato consolidado (quadro-resumo preenchido + CG num PDF só). É o
|
|
633
|
+
* documento que o shop oferece e cujo hash devolve no aceite. null/ausente em
|
|
634
|
+
* documento anterior à feat-353 (aí valem `cg` + `summary`).
|
|
635
|
+
*/
|
|
636
|
+
contract?: (INexVendasJourneyDocumentPublic & { filename: string }) | null;
|
|
631
637
|
/** Comprovante do aceite; null antes do aceite ou enquanto não gerado. */
|
|
632
638
|
receipt: INexVendasJourneyDocumentPublic | null;
|
|
633
639
|
/** Quando as URLs assinadas expiram (o shop refaz o GET depois disso). */
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import type { INexFinopsContractAllowance } from '../evo-finops/common/contract';
|
|
2
|
+
import type { ResolvedPriceTable } from '../evo-finops/common/price-table';
|
|
3
|
+
/** Estado de um módulo do catálogo (`PLATFORM_MODULE_CATALOG`) no pacote. */
|
|
4
|
+
export interface INexVendasPackageModule {
|
|
5
|
+
enabled: boolean;
|
|
6
|
+
/**
|
|
7
|
+
* Só chaves de `def.capabilities`, com o tipo do default (validado no backend).
|
|
8
|
+
* Ausente/null = defaults do catálogo. Merge raso sobre os defaults.
|
|
9
|
+
*/
|
|
10
|
+
capabilities?: Record<string, boolean | number | string> | null;
|
|
11
|
+
}
|
|
12
|
+
/** Franquia só de apresentação (NÃO vai ao contrato). Ex.: atendimentos humanos 500. */
|
|
13
|
+
export interface INexVendasPackageDisplayAllowance {
|
|
14
|
+
/** Chave do `NexFinopsMetricCatalog`. Não pode repetir chave de `allowances` (backend). */
|
|
15
|
+
metric: string;
|
|
16
|
+
included: number;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Pacote comercial da oferta (feat-328 Q1 "oferta = pacote"). A proposta guarda
|
|
20
|
+
* cópia congelada; o contrato recebe só parâmetros comerciais (allowances,
|
|
21
|
+
* price_table_id, item fixo, package_modules).
|
|
22
|
+
*
|
|
23
|
+
* Regras de negócio (todos os módulos do catálogo declarados, capability válida,
|
|
24
|
+
* franquia de módulo desligado, `list_amount > base_amount`, categoria ≠ `SSR`…)
|
|
25
|
+
* ficam no backend (`validateOfferPackage`); o zod só confere a forma.
|
|
26
|
+
*/
|
|
27
|
+
export interface INexVendasOfferPackage {
|
|
28
|
+
/** Tabela que precifica excedente e adicionais. Contrato ATRELADO (não congela). */
|
|
29
|
+
price_table_id: string;
|
|
30
|
+
/** Preço "de" — SÓ apresentação (shop, quadro). Contrato/Asaas usam `base_amount`. Deve ser > base_amount. */
|
|
31
|
+
list_amount?: number | null;
|
|
32
|
+
/**
|
|
33
|
+
* Categoria `billing_services` do item fixo (`services[0]` do contrato).
|
|
34
|
+
* Nunca `SSR` (viraria base de atendimentos no extrato). Ausente = `APPHM`
|
|
35
|
+
* (`NEX_VENDAS_PACKAGE_DEFAULT_FIXED_SERVICE_CATEGORY`).
|
|
36
|
+
*/
|
|
37
|
+
fixed_service_category?: string | null;
|
|
38
|
+
/** Descrição do item fixo (linha da cobrança/NFS-e). Ausente = `offer.name`. */
|
|
39
|
+
fixed_service_description?: string | null;
|
|
40
|
+
/** TODO módulo do catálogo declarado (ligado ou desligado) — validação D13 no backend. */
|
|
41
|
+
modules: Record<string, INexVendasPackageModule>;
|
|
42
|
+
/** Franquias APLICADAS — mesmo formato/zod do contrato; vão para `contract.allowances`. */
|
|
43
|
+
allowances: Record<string, INexFinopsContractAllowance>;
|
|
44
|
+
/** Franquias EXIBIDAS — só apresentação (o contrato não recebe). */
|
|
45
|
+
display_allowances?: INexVendasPackageDisplayAllowance[] | null;
|
|
46
|
+
/** Itens fora do pacote que não são módulo (ex.: "Secretárias Hub Médica"). */
|
|
47
|
+
not_included?: string[] | null;
|
|
48
|
+
/** Destaques curtos do card (opcional). */
|
|
49
|
+
highlights?: string[] | null;
|
|
50
|
+
}
|
|
51
|
+
/** Módulo incluído no pacote, pronto para exibir. */
|
|
52
|
+
export interface INexVendasPackageDisplayModule {
|
|
53
|
+
key: string;
|
|
54
|
+
label: string;
|
|
55
|
+
/** Sub-opções LIGADAS, em texto do cliente ("gravação", "transcrição"). */
|
|
56
|
+
details: string[];
|
|
57
|
+
}
|
|
58
|
+
/** Módulo fora do pacote. */
|
|
59
|
+
export interface INexVendasPackageDisplayExcludedModule {
|
|
60
|
+
key: string;
|
|
61
|
+
label: string;
|
|
62
|
+
}
|
|
63
|
+
/** Franquia por extenso. `applied: false` = só exibida (não vai ao contrato, sem excedente). */
|
|
64
|
+
export interface INexVendasPackageDisplayAllowanceItem {
|
|
65
|
+
metric: string;
|
|
66
|
+
included: number;
|
|
67
|
+
/** "100 atendimentos com a HubIA". */
|
|
68
|
+
text: string;
|
|
69
|
+
applied: boolean;
|
|
70
|
+
}
|
|
71
|
+
/** Preço do excedente de uma métrica com franquia APLICADA. */
|
|
72
|
+
export interface INexVendasPackageDisplayExcess {
|
|
73
|
+
metric: string;
|
|
74
|
+
unit_price: number;
|
|
75
|
+
/** "R$ 1,45 por atendimento com a HubIA". */
|
|
76
|
+
text: string;
|
|
77
|
+
}
|
|
78
|
+
/** Adicional opcional (upsell): módulo DESLIGADO no pacote com linha `recurring` na tabela. */
|
|
79
|
+
export interface INexVendasPackageDisplayAddon {
|
|
80
|
+
key: string;
|
|
81
|
+
label: string;
|
|
82
|
+
/** Valor mensal (BRL). */
|
|
83
|
+
amount: number;
|
|
84
|
+
}
|
|
85
|
+
/** Projeção pronta para exibir — mesma função para shop, proposta pública e quadro. */
|
|
86
|
+
export interface INexVendasPackageDisplay {
|
|
87
|
+
list_amount: number | null;
|
|
88
|
+
/** Inteiro, derivado: round((list - base) / list × 100). null sem `list_amount` (ou list ≤ base). */
|
|
89
|
+
discount_percent: number | null;
|
|
90
|
+
modules_included: INexVendasPackageDisplayModule[];
|
|
91
|
+
modules_excluded: INexVendasPackageDisplayExcludedModule[];
|
|
92
|
+
/** Aplicadas + exibidas, na ordem fixa de `NEX_VENDAS_PACKAGE_ALLOWANCE_TEXT`. */
|
|
93
|
+
allowances: INexVendasPackageDisplayAllowanceItem[];
|
|
94
|
+
/** Excedente das métricas com franquia APLICADA, da tabela resolvida. Vazio sem tabela. */
|
|
95
|
+
excess: INexVendasPackageDisplayExcess[];
|
|
96
|
+
/** Adicionais opcionais (NFS-e 55, Prontuário 175 na `calFvw`). Vazio sem tabela. */
|
|
97
|
+
addons: INexVendasPackageDisplayAddon[];
|
|
98
|
+
not_included: string[];
|
|
99
|
+
highlights: string[];
|
|
100
|
+
}
|
|
101
|
+
/** Item fixo do contrato quando o pacote não informa: "Acesso a plataforma de atendimento". */
|
|
102
|
+
export declare const NEX_VENDAS_PACKAGE_DEFAULT_FIXED_SERVICE_CATEGORY = "APPHM";
|
|
103
|
+
/**
|
|
104
|
+
* Categorias proibidas no item fixo do pacote. `SSR` vira `ssr_base` no extrato e
|
|
105
|
+
* liga a regra regressiva de atendimentos (`billing-statement-compute.ts`).
|
|
106
|
+
*/
|
|
107
|
+
export declare const NEX_VENDAS_PACKAGE_FORBIDDEN_FIXED_SERVICE_CATEGORIES: readonly string[];
|
|
108
|
+
/**
|
|
109
|
+
* Rótulos para o CLIENTE (glossário da fix-352), separados dos rótulos de
|
|
110
|
+
* catálogo/Nexus (`PLATFORM_MODULE_CATALOG[k].label`). Módulo sem rótulo aqui
|
|
111
|
+
* cai no rótulo do catálogo.
|
|
112
|
+
*/
|
|
113
|
+
export declare const NEX_VENDAS_PACKAGE_MODULE_LABELS: Readonly<Record<string, string>>;
|
|
114
|
+
/**
|
|
115
|
+
* Sub-opções exibidas ao cliente quando LIGADAS. Capability fora deste mapa não
|
|
116
|
+
* aparece (ex.: `auto_admit`, detalhe operacional).
|
|
117
|
+
*/
|
|
118
|
+
export declare const NEX_VENDAS_PACKAGE_CAPABILITY_LABELS: Readonly<Record<string, Readonly<Record<string, string>>>>;
|
|
119
|
+
/**
|
|
120
|
+
* Texto por extenso das franquias (`{n}` = quantidade). A ORDEM de declaração é
|
|
121
|
+
* a ordem fixa de exibição. Métrica fora daqui vai para o fim, na ordem do
|
|
122
|
+
* `NexFinopsMetricCatalog`, com texto genérico ("Rótulo: n").
|
|
123
|
+
*
|
|
124
|
+
* O texto do excedente reaproveita `one` sem o `{n}`: "R$ 1,45 por atendimento com a HubIA".
|
|
125
|
+
*/
|
|
126
|
+
export declare const NEX_VENDAS_PACKAGE_ALLOWANCE_TEXT: Readonly<Record<string, {
|
|
127
|
+
one: string;
|
|
128
|
+
other: string;
|
|
129
|
+
}>>;
|
|
130
|
+
/**
|
|
131
|
+
* Mapa métrica → módulo para as métricas SEM `allowance_metrics` no catálogo
|
|
132
|
+
* (o catálogo só declara `teleconsultations_unrecorded` na telemedicina). Use
|
|
133
|
+
* `getPackageMetricModule`, que consulta o catálogo primeiro.
|
|
134
|
+
* Métrica sem módulo (atendimentos, SMS, e-mail) não aparece aqui.
|
|
135
|
+
*/
|
|
136
|
+
export declare const NEX_VENDAS_PACKAGE_METRIC_MODULE: Readonly<Record<string, string>>;
|
|
137
|
+
/**
|
|
138
|
+
* Módulo do catálogo do qual a métrica depende (`allowance_metrics` do catálogo,
|
|
139
|
+
* depois `NEX_VENDAS_PACKAGE_METRIC_MODULE`). null = métrica sem módulo.
|
|
140
|
+
* Usado pelo backend na regra `package_allowance_module_off`.
|
|
141
|
+
*/
|
|
142
|
+
export declare function getPackageMetricModule(metric: string): string | null;
|
|
143
|
+
/** Rótulo do módulo para o cliente (mapa do cliente → catálogo → chave). */
|
|
144
|
+
export declare function getPackageModuleLabel(key: string): string;
|
|
145
|
+
/** "R$ 1,45" / "R$ 1.234,50" — determinístico, sem depender do ICU do runtime. */
|
|
146
|
+
export declare function formatPackageBRL(amount: number): string;
|
|
147
|
+
/** Texto por extenso da franquia ("100 atendimentos com a HubIA"). */
|
|
148
|
+
export declare function formatPackageAllowanceText(metric: string, included: number): string;
|
|
149
|
+
/**
|
|
150
|
+
* Projeção do pacote para exibir. Função PURA (sem Firestore): o backend resolve
|
|
151
|
+
* a tabela (`resolvePriceTableLines(tables, pkg.price_table_id)`) e chama; o
|
|
152
|
+
* shop/Nexus só exibem o resultado (`package_display`).
|
|
153
|
+
*
|
|
154
|
+
* - `resolved: null` (tabela não resolveu) ⇒ `excess` e `addons` vazios; o resto sai igual.
|
|
155
|
+
* - Excedente: só métrica com franquia APLICADA e linha `usage` resolvida
|
|
156
|
+
* (`disabled`/ausente não aparece). Teto por faixas (`cap`) não é exibido.
|
|
157
|
+
* - Adicionais: só módulo declarado `enabled: false` com linha `recurring` resolvida.
|
|
158
|
+
* - Sub-opções: capabilities efetivas (default do catálogo + override do pacote)
|
|
159
|
+
* que estão `true` e têm rótulo em `NEX_VENDAS_PACKAGE_CAPABILITY_LABELS`.
|
|
160
|
+
*/
|
|
161
|
+
export declare function buildPackageDisplay(input: {
|
|
162
|
+
pkg: INexVendasOfferPackage;
|
|
163
|
+
base_amount: number;
|
|
164
|
+
resolved: ResolvedPriceTable | null;
|
|
165
|
+
}): INexVendasPackageDisplay;
|