@neetru/cli 2.32.1 → 2.34.0

package/dist/commands/db-frontdoor.d.ts

@@ -0,0 +1,116 @@
+export type FrontDoorState = 'planning' | 'preparing' | 'verifying_app' | 'verifying_local' | 'enabled' | 'failed' | 'cancelled' | 'disabled';
+export interface FrontDoorLedger {
+    serverId: string | null;
+    frontDoorHost: string | null;
+    frontDoorCertNotAfter: string | null;
+}
+export interface FrontDoorOp {
+    opId: string;
+    state: FrontDoorState;
+    dbServerId: string;
+    appServerId: string;
+    host: string;
+    port: number;
+    allowedClientCidr: string | null;
+    frontDoorCertNotAfter: string | null;
+    preparedAt: string | null;
+    appVerifiedAt: string | null;
+    localVerifiedAt: string | null;
+    enabledAt: string | null;
+    failedAt: string | null;
+    cancelledAt: string | null;
+    disabledAt: string | null;
+    lastError: {
+        code: string;
+        message: string;
+        at: string;
+    } | null;
+    reason: string;
+    updatedAt: string;
+}
+export interface FrontDoorCheck {
+    name: string;
+    ok: boolean;
+    detail?: string;
+}
+export interface FrontDoorEnableResponse {
+    ok: true;
+    dbId: string;
+    dryRun: boolean;
+    done: boolean;
+    alreadyEnabled: boolean;
+    state: FrontDoorState;
+    preflight: {
+        ok: boolean;
+        checks: FrontDoorCheck[];
+    };
+    op: FrontDoorOp | null;
+    ledger: FrontDoorLedger | null;
+}
+export interface FrontDoorStatusResponse {
+    ok: true;
+    dbId: string;
+    ledger: FrontDoorLedger;
+    op: FrontDoorOp | null;
+}
+export interface FrontDoorDisableResponse {
+    ok: true;
+    dbId: string;
+    /**
+     * `host_kept` (Core #727, rodada 2): a ligação em curso foi cancelada, mas o
+     * endereço gravado no cadastro não é desta porta de entrada e FICOU.
+     */
+    outcome: 'disabled' | 'already_disabled' | 'host_kept';
+    previousFrontDoorHost: string | null;
+    opTransition: 'cancelled' | 'disabled' | null;
+    opId: string | null;
+    ledger: FrontDoorLedger | null;
+}
+/** O que cada estado quer dizer, em português simples. */
+export declare const STATE_LABELS: Record<FrontDoorState, string>;
+export declare function isInFlight(state: FrontDoorState | undefined): boolean;
+/** Nome legível de cada requisito do `--dry-run` (o Core manda o nome técnico). */
+export declare const CHECK_LABELS: Record<string, string>;
+/**
+ * O que fazer para cada código `FRONT_DOOR_*` que a rota devolve. A mensagem
+ * do Core (com VMs, IPs e o motivo do agente) vem antes; isto é o "e agora?".
+ */
+export declare const FRONT_DOOR_GUIDANCE: Record<string, string>;
+/** Mensagem do Core primeiro (dados reais), depois o que fazer. Pura. */
+export declare function describeFrontDoorError(code: string, serverMessage: string): string;
+export interface DbFrontdoorEnableOptions {
+    appServer?: string;
+    reason?: string;
+    dryRun?: boolean;
+    yes?: boolean;
+    mfaToken?: string;
+    json?: boolean;
+    /** Somente testes: intervalo da consulta de progresso (ms). Default 3000. */
+    pollIntervalMs?: number;
+    /** Somente testes: prazo total somando as voltas (ms). Default 20 min. */
+    timeoutMs?: number;
+    /** Somente testes: espera de cada POST no Core (s). Default 240 (o máximo da rota). */
+    waitSeconds?: number;
+}
+export declare function runDbFrontdoorEnable(dbId: string, opts?: DbFrontdoorEnableOptions): Promise<void>;
+export declare function runDbFrontdoorStatus(dbId: string, opts?: {
+    json?: boolean;
+}): Promise<void>;
+export interface DbFrontdoorDisableOptions {
+    reason?: string;
+    force?: boolean;
+    yes?: boolean;
+    mfaToken?: string;
+    json?: boolean;
+}
+/**
+ * Desligar (desfazer) — regras do Core #727 (rodada 2), decididas na transação:
+ *  - porta LIGADA por este comando pra um app noutra VM (o desfazer normal) ⇒
+ *    exige `--force`; idem quando não se sabe em que VM o app roda;
+ *  - ligação em curso sem endereço gravado ⇒ só cancela, sem `--force`;
+ *  - endereço gravado por OUTRA origem (ex.: mudança de VM do banco) nunca é
+ *    tirado por aqui: `host_kept` (cancelou a ligação em curso) ou
+ *    `FRONT_DOOR_HOST_NOT_OWNED` (409, nem com `--force`).
+ * Com `--force` a confirmação é forte: digitar o id do banco (ou `--yes`).
+ */
+export declare function runDbFrontdoorDisable(dbId: string, opts?: DbFrontdoorDisableOptions): Promise<void>;