hobots 2.3.0 → 2.4.0

package/dist/protocol.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/protocol.ts"],"sourcesContent":["/**\n * Tipos do protocolo do Hobots (SDK → servidor).\n *\n * Este arquivo é a fonte de verdade do wire format e só pode reexportar tipos:\n * o app valida os payloads com zod e trava o drift via `satisfies z.ZodType<...>`\n * contra estes tipos (importados de `hobots/protocol`).\n */\n\nimport type { MachineSnapshot } from './machine-protocol';\n\n// Wire format de tasks (agente ↔ servidor) — reexportado aqui para o app\n// consumir tudo de `hobots/protocol`.\nexport type {\n  RunStatus,\n  RunUpdateStatus,\n  RunLogLevel,\n  RunLogEntry,\n  InstanceInfo,\n  PollRequest,\n  RunDescriptor,\n  PollResponse,\n  RunError,\n  RunProgress,\n  RunUpdateRequest,\n  RunUpdateResponse,\n  RunItemStatus,\n  RunItemInput,\n  RunItemsCreateRequest,\n  RunItemsCreateResponse,\n  RunAttachmentContentType,\n  RunAttachmentCreateRequest,\n  RunAttachmentCreateResponse,\n  RunAttachmentConfirmRequest,\n  RunAttachmentConfirmResponse,\n} from './tasks/protocol';\n\n// Snapshot de recursos da máquina — usado no heartbeat, no poll e em contexts.machine.\nexport type { MachineProcess, MachineSnapshot } from './machine-protocol';\n\n/**\n * Tipo de um evento — o que ele é, não o quanto ele fala. Só 'fatal', 'error' e\n * 'warning' viram issue; 'success' é ingerido e nunca abre issue.\n * Ruído de log não é evento: para isso existem os logs da execução (RunLogLevel)\n * e as breadcrumbs, que têm níveis próprios com 'debug'/'info'.\n */\nexport type EventType = 'fatal' | 'error' | 'warning' | 'success';\n\n/** Nível de uma breadcrumb — trilha do que aconteceu antes, aqui log é bem-vindo. */\nexport type BreadcrumbLevel = 'debug' | 'info' | 'warning' | 'error' | 'fatal';\n\n/** Frames em ordem innermost-first (mesma ordem impressa pelo V8). */\nexport interface StackFrame {\n  function?: string;\n  filename?: string;\n  lineno?: number;\n  colno?: number;\n  in_app: boolean;\n}\n\nexport interface Breadcrumb {\n  /** ISO 8601 */\n  timestamp: string;\n  type?: string;\n  category?: string;\n  message?: string;\n  level?: BreadcrumbLevel;\n  data?: Record<string, unknown>;\n}\n\nexport interface ExceptionData {\n  type: string;\n  value: string;\n  stacktrace?: { frames: StackFrame[] };\n}\n\nexport interface EventUser {\n  id?: string;\n  username?: string;\n  email?: string;\n}\n\nexport interface EventPayload {\n  /** uuid v4 sem hífens (32 hex), gerado pelo SDK */\n  event_id: string;\n  /** ISO 8601 */\n  timestamp: string;\n  type: EventType;\n  message?: string;\n  exception?: ExceptionData;\n  /** Override de agrupamento; quando ausente o servidor calcula pelo stack trace */\n  fingerprint?: string[];\n  breadcrumbs?: Breadcrumb[];\n  tags?: Record<string, string>;\n  user?: EventUser;\n  contexts?: Record<string, Record<string, unknown>>;\n  extra?: Record<string, unknown>;\n  release?: string;\n  environment?: string;\n}\n\n/** Status de uma step (etapa). `warning` = terminou, mas merece atenção (não é falha). */\nexport type StepStatus = 'ok' | 'warning' | 'error' | 'cancelled';\n\nexport interface StepData {\n  /** 16 hex */\n  step_id: string;\n  parent_step_id?: string;\n  op?: string;\n  description?: string;\n  status?: StepStatus;\n  /** ISO 8601 */\n  start_timestamp: string;\n  /** ISO 8601 (fim da step) */\n  timestamp: string;\n  data?: Record<string, unknown>;\n}\n\nexport interface TransactionPayload {\n  event_id: string;\n  name: string;\n  op?: string;\n  status: string;\n  start_timestamp: string;\n  timestamp: string;\n  steps: StepData[];\n  tags?: Record<string, string>;\n  release?: string;\n  environment?: string;\n  /** Correlaciona esta transaction a uma execução de task (ctx.tx dentro de um task handler) */\n  run_id?: string;\n}\n\nexport interface HeartbeatPayload {\n  instance_id: string;\n  name?: string;\n  interval_ms: number;\n  /** ISO 8601 */\n  timestamp: string;\n  metadata?: Record<string, unknown>;\n  release?: string;\n  /** Recursos da máquina no momento do beat (CPU, memória, disco, processo) */\n  machine?: MachineSnapshot;\n}\n\nexport type EnvelopeItem =\n  | { type: 'event'; payload: EventPayload }\n  | { type: 'transaction'; payload: TransactionPayload }\n  | { type: 'heartbeat'; payload: HeartbeatPayload };\n\nexport interface Envelope {\n  sdk: { name: string; version: string };\n  /** ISO 8601 */\n  sent_at: string;\n  items: EnvelopeItem[];\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../src/protocol.ts"],"sourcesContent":["/**\n * Tipos do protocolo do Hobots (SDK → servidor).\n *\n * Este arquivo é a fonte de verdade do wire format e só pode reexportar tipos:\n * o app valida os payloads com zod e trava o drift via `satisfies z.ZodType<...>`\n * contra estes tipos (importados de `hobots/protocol`).\n */\n\nimport type { EnvironmentInput } from './environment-protocol';\nimport type { MachineSnapshot } from './machine-protocol';\n\n// Wire format de tasks (agente ↔ servidor) — reexportado aqui para o app\n// consumir tudo de `hobots/protocol`.\nexport type {\n  RunStatus,\n  RunUpdateStatus,\n  RunLogLevel,\n  RunLogEntry,\n  InstanceInfo,\n  PollRequest,\n  RunDescriptor,\n  PollResponse,\n  RunError,\n  RunProgress,\n  RunUpdateRequest,\n  RunUpdateResponse,\n  RunItemStatus,\n  RunItemInput,\n  RunItemsCreateRequest,\n  RunItemsCreateResponse,\n  RunAttachmentContentType,\n  RunAttachmentCreateRequest,\n  RunAttachmentCreateResponse,\n  RunAttachmentConfirmRequest,\n  RunAttachmentConfirmResponse,\n} from './tasks/protocol';\n\n// Snapshot de recursos da máquina — usado no heartbeat, no poll e em contexts.machine.\nexport type { MachineProcess, MachineSnapshot } from './machine-protocol';\nexport type { Environment, EnvironmentInput } from './environment-protocol';\n\n/**\n * Tipo de um evento — o que ele é, não o quanto ele fala. Só 'fatal', 'error' e\n * 'warning' viram issue; 'success' é ingerido e nunca abre issue.\n * Ruído de log não é evento: para isso existem os logs da execução (RunLogLevel)\n * e as breadcrumbs, que têm níveis próprios com 'debug'/'info'.\n */\nexport type EventType = 'fatal' | 'error' | 'warning' | 'success';\n\n/** Nível de uma breadcrumb — trilha do que aconteceu antes, aqui log é bem-vindo. */\nexport type BreadcrumbLevel = 'debug' | 'info' | 'warning' | 'error' | 'fatal';\n\n/** Frames em ordem innermost-first (mesma ordem impressa pelo V8). */\nexport interface StackFrame {\n  function?: string;\n  filename?: string;\n  lineno?: number;\n  colno?: number;\n  in_app: boolean;\n}\n\nexport interface Breadcrumb {\n  /** ISO 8601 */\n  timestamp: string;\n  type?: string;\n  category?: string;\n  message?: string;\n  level?: BreadcrumbLevel;\n  data?: Record<string, unknown>;\n}\n\nexport interface ExceptionData {\n  type: string;\n  value: string;\n  stacktrace?: { frames: StackFrame[] };\n}\n\nexport interface EventUser {\n  id?: string;\n  username?: string;\n  email?: string;\n}\n\nexport interface EventPayload {\n  /** uuid v4 sem hífens (32 hex), gerado pelo SDK */\n  event_id: string;\n  /** ISO 8601 */\n  timestamp: string;\n  type: EventType;\n  message?: string;\n  exception?: ExceptionData;\n  /** Override de agrupamento; quando ausente o servidor calcula pelo stack trace */\n  fingerprint?: string[];\n  breadcrumbs?: Breadcrumb[];\n  tags?: Record<string, string>;\n  user?: EventUser;\n  contexts?: Record<string, Record<string, unknown>>;\n  extra?: Record<string, unknown>;\n  release?: string;\n  environment?: EnvironmentInput;\n}\n\n/** Status de uma step (etapa). `warning` = terminou, mas merece atenção (não é falha). */\nexport type StepStatus = 'ok' | 'warning' | 'error' | 'cancelled';\n\nexport interface StepData {\n  /** 16 hex */\n  step_id: string;\n  parent_step_id?: string;\n  op?: string;\n  description?: string;\n  status?: StepStatus;\n  /** ISO 8601 */\n  start_timestamp: string;\n  /** ISO 8601 (fim da step) */\n  timestamp: string;\n  data?: Record<string, unknown>;\n}\n\nexport interface TransactionPayload {\n  event_id: string;\n  name: string;\n  op?: string;\n  status: string;\n  start_timestamp: string;\n  timestamp: string;\n  steps: StepData[];\n  tags?: Record<string, string>;\n  release?: string;\n  environment?: EnvironmentInput;\n  /** Correlaciona esta transaction a uma execução de task (ctx.tx dentro de um task handler) */\n  run_id?: string;\n}\n\nexport interface HeartbeatPayload {\n  instance_id: string;\n  name?: string;\n  interval_ms: number;\n  /** ISO 8601 */\n  timestamp: string;\n  metadata?: Record<string, unknown>;\n  release?: string;\n  /** Ambiente da instância — é ele que o app exibe e que as regras de alerta filtram */\n  environment?: EnvironmentInput;\n  /** Recursos da máquina no momento do beat (CPU, memória, disco, processo) */\n  machine?: MachineSnapshot;\n}\n\nexport type EnvelopeItem =\n  | { type: 'event'; payload: EventPayload }\n  | { type: 'transaction'; payload: TransactionPayload }\n  | { type: 'heartbeat'; payload: HeartbeatPayload };\n\nexport interface Envelope {\n  sdk: { name: string; version: string };\n  /** ISO 8601 */\n  sent_at: string;\n  items: EnvelopeItem[];\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/protocol.d.cts

@@ -1,3 +1,25 @@
+/**
+ * Ambiente lógico onde o robô roda.
+ *
+ * Arquivo-folha do protocolo (não importa nada): referenciado pelo heartbeat, pelo
+ * poll de tasks (`InstanceInfo.environment`) e pelos eventos/transactions, e
+ * reexportado por `hobots/protocol`.
+ *
+ * A fonte única do vocabulário (rótulos em pt-BR, apelidos legados aceitos e a
+ * normalização) vive no servidor, em packages/utils/src/environments.ts — o SDK é
+ * publicado sozinho no npm e não depende do monorepo, então o union é redeclarado
+ * aqui. O servidor normaliza o que chega: valores antigos de texto livre ('prod',
+ * 'qa', 'homologacao') continuam sendo aceitos e classificados.
+ */
+type Environment = 'development' | 'testing' | 'staging' | 'production';
+/**
+ * O que o wire realmente aceita: o ambiente canônico ou uma string legada que o
+ * servidor normaliza ('prod', 'qa', 'homologacao'...). O `string & {}` preserva o
+ * autocomplete dos quatro valores sem fechar a porta para o que já roda em campo
+ * — e mantém os `satisfies z.ZodType<...>` da api fechando contra `z.string()`.
+ */
+type EnvironmentInput = Environment | (string & {});
+
 /**
  * Snapshot dos recursos da máquina onde a instância roda.
  *
@@ -82,6 +104,8 @@ interface InstanceInfo {
     version?: string;
     /** Hostname da máquina */
     host?: string;
+    /** Ambiente da instância — mesmo valor do heartbeat; agentes poll-only só o informam aqui */
+    environment?: EnvironmentInput;
     /** Tasks registradas no agente */
     tasks?: string[];
     /**
@@ -275,7 +299,7 @@ interface EventPayload {
     contexts?: Record<string, Record<string, unknown>>;
     extra?: Record<string, unknown>;
     release?: string;
-    environment?: string;
+    environment?: EnvironmentInput;
 }
 /** Status de uma step (etapa). `warning` = terminou, mas merece atenção (não é falha). */
 type StepStatus = 'ok' | 'warning' | 'error' | 'cancelled';
@@ -302,7 +326,7 @@ interface TransactionPayload {
     steps: StepData[];
     tags?: Record<string, string>;
     release?: string;
-    environment?: string;
+    environment?: EnvironmentInput;
     /** Correlaciona esta transaction a uma execução de task (ctx.tx dentro de um task handler) */
     run_id?: string;
 }
@@ -314,6 +338,8 @@ interface HeartbeatPayload {
     timestamp: string;
     metadata?: Record<string, unknown>;
     release?: string;
+    /** Ambiente da instância — é ele que o app exibe e que as regras de alerta filtram */
+    environment?: EnvironmentInput;
     /** Recursos da máquina no momento do beat (CPU, memória, disco, processo) */
     machine?: MachineSnapshot;
 }
@@ -337,4 +363,4 @@ interface Envelope {
     items: EnvelopeItem[];
 }
 
-export type { Breadcrumb, BreadcrumbLevel, Envelope, EnvelopeItem, EventPayload, EventType, EventUser, ExceptionData, HeartbeatPayload, InstanceInfo, MachineProcess, MachineSnapshot, PollRequest, PollResponse, RunAttachmentConfirmRequest, RunAttachmentConfirmResponse, RunAttachmentContentType, RunAttachmentCreateRequest, RunAttachmentCreateResponse, RunDescriptor, RunError, RunItemInput, RunItemStatus, RunItemsCreateRequest, RunItemsCreateResponse, RunLogEntry, RunLogLevel, RunProgress, RunStatus, RunUpdateRequest, RunUpdateResponse, RunUpdateStatus, StackFrame, StepData, StepStatus, TransactionPayload };
+export type { Breadcrumb, BreadcrumbLevel, Envelope, EnvelopeItem, Environment, EnvironmentInput, EventPayload, EventType, EventUser, ExceptionData, HeartbeatPayload, InstanceInfo, MachineProcess, MachineSnapshot, PollRequest, PollResponse, RunAttachmentConfirmRequest, RunAttachmentConfirmResponse, RunAttachmentContentType, RunAttachmentCreateRequest, RunAttachmentCreateResponse, RunDescriptor, RunError, RunItemInput, RunItemStatus, RunItemsCreateRequest, RunItemsCreateResponse, RunLogEntry, RunLogLevel, RunProgress, RunStatus, RunUpdateRequest, RunUpdateResponse, RunUpdateStatus, StackFrame, StepData, StepStatus, TransactionPayload };

package/dist/protocol.d.ts

@@ -1,3 +1,25 @@
+/**
+ * Ambiente lógico onde o robô roda.
+ *
+ * Arquivo-folha do protocolo (não importa nada): referenciado pelo heartbeat, pelo
+ * poll de tasks (`InstanceInfo.environment`) e pelos eventos/transactions, e
+ * reexportado por `hobots/protocol`.
+ *
+ * A fonte única do vocabulário (rótulos em pt-BR, apelidos legados aceitos e a
+ * normalização) vive no servidor, em packages/utils/src/environments.ts — o SDK é
+ * publicado sozinho no npm e não depende do monorepo, então o union é redeclarado
+ * aqui. O servidor normaliza o que chega: valores antigos de texto livre ('prod',
+ * 'qa', 'homologacao') continuam sendo aceitos e classificados.
+ */
+type Environment = 'development' | 'testing' | 'staging' | 'production';
+/**
+ * O que o wire realmente aceita: o ambiente canônico ou uma string legada que o
+ * servidor normaliza ('prod', 'qa', 'homologacao'...). O `string & {}` preserva o
+ * autocomplete dos quatro valores sem fechar a porta para o que já roda em campo
+ * — e mantém os `satisfies z.ZodType<...>` da api fechando contra `z.string()`.
+ */
+type EnvironmentInput = Environment | (string & {});
+
 /**
  * Snapshot dos recursos da máquina onde a instância roda.
  *
@@ -82,6 +104,8 @@ interface InstanceInfo {
     version?: string;
     /** Hostname da máquina */
     host?: string;
+    /** Ambiente da instância — mesmo valor do heartbeat; agentes poll-only só o informam aqui */
+    environment?: EnvironmentInput;
     /** Tasks registradas no agente */
     tasks?: string[];
     /**
@@ -275,7 +299,7 @@ interface EventPayload {
     contexts?: Record<string, Record<string, unknown>>;
     extra?: Record<string, unknown>;
     release?: string;
-    environment?: string;
+    environment?: EnvironmentInput;
 }
 /** Status de uma step (etapa). `warning` = terminou, mas merece atenção (não é falha). */
 type StepStatus = 'ok' | 'warning' | 'error' | 'cancelled';
@@ -302,7 +326,7 @@ interface TransactionPayload {
     steps: StepData[];
     tags?: Record<string, string>;
     release?: string;
-    environment?: string;
+    environment?: EnvironmentInput;
     /** Correlaciona esta transaction a uma execução de task (ctx.tx dentro de um task handler) */
     run_id?: string;
 }
@@ -314,6 +338,8 @@ interface HeartbeatPayload {
     timestamp: string;
     metadata?: Record<string, unknown>;
     release?: string;
+    /** Ambiente da instância — é ele que o app exibe e que as regras de alerta filtram */
+    environment?: EnvironmentInput;
     /** Recursos da máquina no momento do beat (CPU, memória, disco, processo) */
     machine?: MachineSnapshot;
 }
@@ -337,4 +363,4 @@ interface Envelope {
     items: EnvelopeItem[];
 }
 
-export type { Breadcrumb, BreadcrumbLevel, Envelope, EnvelopeItem, EventPayload, EventType, EventUser, ExceptionData, HeartbeatPayload, InstanceInfo, MachineProcess, MachineSnapshot, PollRequest, PollResponse, RunAttachmentConfirmRequest, RunAttachmentConfirmResponse, RunAttachmentContentType, RunAttachmentCreateRequest, RunAttachmentCreateResponse, RunDescriptor, RunError, RunItemInput, RunItemStatus, RunItemsCreateRequest, RunItemsCreateResponse, RunLogEntry, RunLogLevel, RunProgress, RunStatus, RunUpdateRequest, RunUpdateResponse, RunUpdateStatus, StackFrame, StepData, StepStatus, TransactionPayload };
+export type { Breadcrumb, BreadcrumbLevel, Envelope, EnvelopeItem, Environment, EnvironmentInput, EventPayload, EventType, EventUser, ExceptionData, HeartbeatPayload, InstanceInfo, MachineProcess, MachineSnapshot, PollRequest, PollResponse, RunAttachmentConfirmRequest, RunAttachmentConfirmResponse, RunAttachmentContentType, RunAttachmentCreateRequest, RunAttachmentCreateResponse, RunDescriptor, RunError, RunItemInput, RunItemStatus, RunItemsCreateRequest, RunItemsCreateResponse, RunLogEntry, RunLogLevel, RunProgress, RunStatus, RunUpdateRequest, RunUpdateResponse, RunUpdateStatus, StackFrame, StepData, StepStatus, TransactionPayload };

package/docs/api-reference.md

@@ -95,7 +95,7 @@ No poll, o agente se identifica com `InstanceInfo` (`hobots/protocol`): o campo
 | Opção | Tipo | Default | Descrição |
 | --- | --- | --- | --- |
 | `clientSecret` | `string` | — | **obrigatório**; o Client Secret do agente (`hb_<64 hex>`), copiado em **Configurações → Agentes** |
-| `environment` | `string` | `'production'` | ambiente lógico |
+| `environment` | `'development' \| 'testing' \| 'staging' \| 'production'` | `'production'` | ambiente lógico — vai nos eventos **e** na identidade da instância; é por ele que as regras de alerta decidem se notificam |
 | `release` | `string` | — | versão do programa, ex. `robo-nfe@1.4.2` |
 | `instanceId` | `string` | **obrigatório** | identidade única da instância; heartbeat e poll de tasks convergem nela |
 | `tags` | `Record<string,string>` | — | tags aplicadas a todos os eventos |

package/docs/concepts.md

@@ -339,7 +339,7 @@ O que o torna especial é que ele é a identidade dos **dois** canais ao mesmo t
 
 ## Release e environment
 
-**`release`** é a versão do seu programa (`robo-nfe@1.4.2`) e **`environment`** é o ambiente lógico (`production`, `homologacao`). Os dois são anexados a **todo** item enviado: eventos e transactions.
+**`release`** é a versão do seu programa (`robo-nfe@1.4.2`) e **`environment`** é o ambiente lógico, um de quatro valores: `development`, `testing`, `staging` (homologação) e `production`. Os dois são anexados a **todo** item enviado: eventos e transactions — e o `environment` vai também na identidade da **instância**, pelo heartbeat e pelo poll.
 
 Servem a duas perguntas concretas:
 
@@ -348,6 +348,10 @@ Servem a duas perguntas concretas:
 
 `environment` default é `production`. Se você roda homologação sem definir isso, os dois ambientes se misturam na mesma issue — vale configurar no primeiro dia.
 
+E não é só organização: é o `environment` que decide **quem é notificado**. Cada regra de alerta lista os ambientes em que dispara, e por padrão só produção — um erro de homologação não acorda a lista de plantão, e uma máquina de testes que desliga no fim do expediente não vira alerta de madrugada. Para ser avisado em outro ambiente, marque-o na regra em **Alertas**.
+
+Valores antigos de texto livre (`prod`, `qa`, `homologacao`) continuam sendo aceitos — o servidor os classifica num dos quatro; o que ele não reconhece vira produção, para nunca silenciar um alerta por engano. O ambiente de uma instância também pode ser corrigido no app, na página dela: a partir daí ele ignora o que o robô declara, até você desfazer.
+
 ## Run
 
 Uma **run** (execução) é um pedido concreto de trabalho criado no app: alguém preencheu o formulário da task, ou uma automação disparou, e agora existe uma solicitação esperando um agente pegar.

package/docs/protocol.md

@@ -81,6 +81,7 @@ Corpo `PollRequest`:
     "name": "VM 01",
     "version": "2.0.0",
     "host": "vm-01",
+    "environment": "production", // ambiente da instância: development | testing | staging | production
     "tasks": ["processar-nfe"]
   },
   "max": 1,                       // quantas reivindicar (1..5)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hobots",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "SDK JavaScript da Hobots — telemetria (erros, transactions e heartbeats) e execução remota de tarefas sob demanda (tasks) para RPAs e integrações. Um único import e um único init().",
   "type": "module",
   "sideEffects": false,