evo360-types 1.3.802 → 1.3.804

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.
@@ -0,0 +1,50 @@
1
+ /**
2
+ * feat-333 F3 — aviso ao ativar rotina além da franquia.
3
+ *
4
+ * `POST evo_billing/me/automation/routine-allowance` devolve esta conta a quem pode
5
+ * ativar rotina (`hub_automation_write`), sem expor o resto do contrato. Os números
6
+ * vêm do extrato do mês corrente (mesmo motor da cobrança) e da contagem de rotinas
7
+ * ativas no Firestore.
8
+ *
9
+ * O aviso não bloqueia: a cobrança vem do pico registrado nos eventos, não do aceite.
10
+ */
11
+ /** Resposta da consulta do aviso. Valores em reais. */
12
+ export interface IRoutineAllowanceCheck {
13
+ /**
14
+ * `false` = sem aviso possível: tenant sem cliente ou sem contrato no mês, contrato
15
+ * sem franquia de rotinas, tabela sem preço da métrica ou contrato em `trial`.
16
+ */
17
+ applies: boolean;
18
+ /** `YYYY-MM`, horário de Brasília. */
19
+ competency: string;
20
+ /** Franquia somada dos contratos vigentes. `null` quando não há. */
21
+ included: number | null;
22
+ /** Preço por rotina acima da franquia, por mês. `null` quando não há. */
23
+ unit_price: number | null;
24
+ /** Pico de rotinas ativas no mês até agora. `null` = série indisponível. */
25
+ peak_month: number | null;
26
+ /** Rotinas ativas agora. */
27
+ active_now: number;
28
+ /** Quantas das rotinas pedidas estão inativas (as que a ativação liga). */
29
+ adding: number;
30
+ /** `active_now + adding`. */
31
+ active_after: number;
32
+ /** `applies && active_after > included`: a tela mostra o aviso. */
33
+ exceeds: boolean;
34
+ /** Quanto a ativação acrescenta à cobrança deste mês (pode ser 0 se o pico já estava acima). */
35
+ extra_this_month: number;
36
+ /** Excedente mensal enquanto as rotinas ficarem ativas: `max(0, active_after − included) × unit_price`. */
37
+ monthly_after: number;
38
+ }
39
+ /**
40
+ * O que a pessoa viu e aceitou, enviado no corpo de
41
+ * `POST hub_automation_admin/routines/:id/activate` e gravado em
42
+ * `params.allowance_ack` do evento `routine.activated` (autor e hora já estão no evento).
43
+ */
44
+ export interface IRoutineAllowanceAck {
45
+ competency: string;
46
+ included: number;
47
+ unit_price: number;
48
+ active_after: number;
49
+ extra_this_month: number;
50
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ /**
3
+ * feat-333 F3 — aviso ao ativar rotina além da franquia.
4
+ *
5
+ * `POST evo_billing/me/automation/routine-allowance` devolve esta conta a quem pode
6
+ * ativar rotina (`hub_automation_write`), sem expor o resto do contrato. Os números
7
+ * vêm do extrato do mês corrente (mesmo motor da cobrança) e da contagem de rotinas
8
+ * ativas no Firestore.
9
+ *
10
+ * O aviso não bloqueia: a cobrança vem do pico registrado nos eventos, não do aceite.
11
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,52 @@
1
+ /**
2
+ * feat-333 F3 — aviso ao ativar rotina além da franquia.
3
+ *
4
+ * `POST evo_billing/me/automation/routine-allowance` devolve esta conta a quem pode
5
+ * ativar rotina (`hub_automation_write`), sem expor o resto do contrato. Os números
6
+ * vêm do extrato do mês corrente (mesmo motor da cobrança) e da contagem de rotinas
7
+ * ativas no Firestore.
8
+ *
9
+ * O aviso não bloqueia: a cobrança vem do pico registrado nos eventos, não do aceite.
10
+ */
11
+
12
+ /** Resposta da consulta do aviso. Valores em reais. */
13
+ export interface IRoutineAllowanceCheck {
14
+ /**
15
+ * `false` = sem aviso possível: tenant sem cliente ou sem contrato no mês, contrato
16
+ * sem franquia de rotinas, tabela sem preço da métrica ou contrato em `trial`.
17
+ */
18
+ applies: boolean;
19
+ /** `YYYY-MM`, horário de Brasília. */
20
+ competency: string;
21
+ /** Franquia somada dos contratos vigentes. `null` quando não há. */
22
+ included: number | null;
23
+ /** Preço por rotina acima da franquia, por mês. `null` quando não há. */
24
+ unit_price: number | null;
25
+ /** Pico de rotinas ativas no mês até agora. `null` = série indisponível. */
26
+ peak_month: number | null;
27
+ /** Rotinas ativas agora. */
28
+ active_now: number;
29
+ /** Quantas das rotinas pedidas estão inativas (as que a ativação liga). */
30
+ adding: number;
31
+ /** `active_now + adding`. */
32
+ active_after: number;
33
+ /** `applies && active_after > included`: a tela mostra o aviso. */
34
+ exceeds: boolean;
35
+ /** Quanto a ativação acrescenta à cobrança deste mês (pode ser 0 se o pico já estava acima). */
36
+ extra_this_month: number;
37
+ /** Excedente mensal enquanto as rotinas ficarem ativas: `max(0, active_after − included) × unit_price`. */
38
+ monthly_after: number;
39
+ }
40
+
41
+ /**
42
+ * O que a pessoa viu e aceitou, enviado no corpo de
43
+ * `POST hub_automation_admin/routines/:id/activate` e gravado em
44
+ * `params.allowance_ack` do evento `routine.activated` (autor e hora já estão no evento).
45
+ */
46
+ export interface IRoutineAllowanceAck {
47
+ competency: string;
48
+ included: number;
49
+ unit_price: number;
50
+ active_after: number;
51
+ extra_this_month: number;
52
+ }
@@ -4,6 +4,7 @@ export * from "./common/taker";
4
4
  export * from "./common/contract";
5
5
  export * from "./common/price-table";
6
6
  export * from "./common/billing-statement";
7
+ export * from "./common/routine-allowance";
7
8
  export * from "./common/proposal";
8
9
  export * from "./common/billing";
9
10
  export * from "./common/payment-method";
@@ -21,6 +21,7 @@ __exportStar(require("./common/taker"), exports);
21
21
  __exportStar(require("./common/contract"), exports);
22
22
  __exportStar(require("./common/price-table"), exports);
23
23
  __exportStar(require("./common/billing-statement"), exports);
24
+ __exportStar(require("./common/routine-allowance"), exports);
24
25
  __exportStar(require("./common/proposal"), exports);
25
26
  __exportStar(require("./common/billing"), exports);
26
27
  __exportStar(require("./common/payment-method"), exports);
@@ -6,6 +6,7 @@ export * from "./common/taker";
6
6
  export * from "./common/contract";
7
7
  export * from "./common/price-table";
8
8
  export * from "./common/billing-statement";
9
+ export * from "./common/routine-allowance";
9
10
  export * from "./common/proposal";
10
11
  export * from "./common/billing";
11
12
  export * from "./common/payment-method";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "evo360-types",
3
- "version": "1.3.802",
3
+ "version": "1.3.804",
4
4
  "description": "HREVO360 Shared Types",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",