hobots 5.2.0 → 6.1.0

package/README.md

@@ -112,7 +112,7 @@ A opção passada em `register()`/`start()` tem precedência sobre a env — út
 | --- | --- |
 | `hobots.log.debug/info/warn/error/success(msg, ...rest)` | Log da execução, enviado incrementalmente ao app (e ecoado no terminal como `[hobots] INFO …`). Aceita vários argumentos como `console.log` — `hobots.log.info('nota', numero, 'ok')` — cada um vira texto, unidos por espaço. Um `hobots.image(...)` como **último** argumento pendura um print na linha. **Nunca lança** — pode ir em `finally`. |
 | `hobots.items.succeeded(payload?, { id, image }?)` · `.failed(msg, payload?, …)` · `.occurrence(msg, payload?, …)` · `.add({...})` | **A entrega do robô**: cada item processado, com status e atributos (viram colunas no app — declare-as com a opção `items: { columns: [...] }` do `register`/`start`). `image` pendura um print no item. Bufferizado, em lotes. |
-| `hobots.items.each(lista, async (el, item) => …, { id: 'campo', payload, retries: 1, retryDelayMs: 5000, skipDone: true }?)` | **Loop com o contrato garantido**: cada elemento vira etapa + item; exceção no handler = nova tentativa e, esgotada, item `failed` com a mensagem e o loop **segue** até o fim; `throw new Occurrence(msg)` = item `occurrence`, sem repetir; na reexecução do mesmo trabalho pula o que já deu `succeeded`/`occurrence`; progresso automático; `hobots.flush()` ao fim de cada ciclo (`flush: false` desliga). Só cancelamento/timeout interrompem. No handler, `item.data({ nf: 123 })` vai guardando os atributos do item sem decidir o desfecho — entram no `succeeded`/`failed`/`occurrence`, inclusive nos implícitos. |
+| `hobots.items.each(lista, async (item, index?) => …, { id: 'campo', payload, retries: 1, retryDelayMs: 5000, skipDone: true }?)` | **Loop com o contrato garantido**: o handler recebe o handle do item (e, se declarar, o índice) — o elemento é `item.value` e a posição, `item.index`; sem `payload`, os campos do elemento (objeto simples) viram as colunas do item (`payload: false` desliga); cada elemento vira etapa + item; exceção no handler = nova tentativa e, esgotada, item `failed` com a mensagem e o loop **segue** até o fim; `throw new Occurrence(msg)` = item `occurrence`, sem repetir; na reexecução do mesmo trabalho pula o que já deu `succeeded`/`occurrence`; progresso automático; `hobots.flush()` ao fim de cada ciclo (`flush: false` desliga). Só cancelamento/timeout interrompem. No handler, `item.data({ nf: 123 })` vai guardando os atributos do item sem decidir o desfecho — entram no `succeeded`/`failed`/`occurrence`, inclusive nos implícitos. |
 | `hobots.progress.total(n)` · `.advance(k = 1)` · `.set(atual, total?)` · `.current` · `.snapshot` | Barra, percentual e tempo restante na execução. Sem `total()` nada é enviado. |
 | `hobots.flush(timeoutMs?)` | **Entrega já** o que a execução fez: as etapas raiz finalizadas viram transactions parciais (waterfall na Central sem esperar a run terminar) e itens, logs e progresso pendentes saem sem esperar o throttle. `step` (raiz) e cada ciclo do `items.each` já chamam sozinhos; à mão, para o resto da rodada de um agente `start()`. Aguarda com teto (15 s) e nunca lança. |
 | `hobots.step(nome, async etapa => …, { retries = 1, retryDelayMs = 5_000, flush = true }?)` | Uma **etapa** no waterfall de performance da execução: roda a função, **tenta de novo** se ela lançar (`retries: 0` desliga — use em etapas não idempotentes) e fecha a etapa. Resolve com o retorno da função. `hobots.step` dentro de outra vira sub-etapa. A etapa raiz faz `flush()` ao terminar (`flush: false` desliga). O handle `etapa` tem `warning(motivo, { image }?)`, `image(png)` e `data(chave, valor)`. |
@@ -231,6 +231,8 @@ Sem handler próprio de sinal, um `SIGINT`/`SIGTERM` (ou erro fatal) com execuç
 
 ## Changelog resumido
 
+- **6.1.0** — cada item do `items.each` termina com uma linha `[item] FINISH <chave> (<ms>)` no log, no nível do desfecho (`success`/`error`/`warning`), no lugar do `[step] FINISH item — …`; `item.message` com o motivo. Detalhes no [CHANGELOG](./CHANGELOG.md).
+- **6.0.0** — **breaking**: o handler de `items.each` recebe o handle do item, `async (item, index) => …` (`index` opcional); o elemento da lista é `item.value` e a posição, `item.index`. Migração: `async (conta, item, i) => …` → `async (item, i) => { const conta = item.value; … }`. `options.id`/`payload`/`description` continuam recebendo `(element, index)`. **Payload padrão:** sem `options.payload`, os campos do elemento (objeto simples, cópia rasa) viram o payload base do item; `options.payload` substitui, `payload: false` desliga. Detalhes no [CHANGELOG](./CHANGELOG.md).
 - **5.2.0** — **`item.data(payload)`** no handle do `items.each`: guarda atributos do item sem registrar desfecho; mescla a cada chamada e entra em qualquer desfecho (inclusive nos implícitos), entre o `options.payload` do `each` e o payload da chamada de desfecho; zera na nova tentativa. Detalhes no [CHANGELOG](./CHANGELOG.md).
 - **5.1.0** — `items.each` com **nova tentativa por item** (`retries: 1`, `retryDelayMs: 5000`; uma etapa só por elemento, `warning` quando a repetição deu certo, `error` + item `failed` quando esgotou), **`Occurrence`** exportada (`throw new Occurrence(msg, payload?, { image }?)` no handler = item `occurrence`, sem repetir), `id` por campo (`'numero'`), chave composta (`['cnpj', 'competencia']`) ou função — padrão: o campo `id` do elemento — e **reexecução sem repetir**: ao executar novamente o trabalho, pula os ids já `succeeded`/`occurrence` (`skipDone: true`; `POST /v1/runs/{id}/items/done`); resultado com `skipped`; `item.id` sempre `string`, `item.attempt`. Detalhes no [CHANGELOG](./CHANGELOG.md).
 - **5.0.0** — **uma API só de etapas** (breaking): `hobots.step(nome, fn, { retries, retryDelayMs }?)` abre a etapa, tenta de novo quando `fn` lança (default 1 tentativa extra) e fecha; `fn` recebe o handle `etapa` (`warning`/`image`/`data`); `hobots.step` dentro de outra (ou do handler do `items.each`) vira sub-etapa. `hobots.transaction`, `ctx.transaction` e os tipos `Transaction`/`Step`/`StepOutcomeOptions` foram removidos; `item.step` é o handle novo. Modo local ecoa `[hobots:step] FINISH …`. Nomes de etapa são recortados em 2048 no cliente. Flush automático ao fim da etapa raiz e de cada ciclo do `items.each` (`flush: false` desliga). Antes/depois no [CHANGELOG](./CHANGELOG.md).

package/dist/index.cjs

@@ -45,7 +45,7 @@ module.exports = __toCommonJS(src_exports);
 
 // src/utils.ts
 var SDK_NAME = "hobots";
-var SDK_VERSION = true ? "5.2.0" : "0.0.0-dev";
+var SDK_VERSION = true ? "6.1.0" : "0.0.0-dev";
 function isNode() {
   return typeof process !== "undefined" && typeof process.versions?.node === "string";
 }
@@ -1547,6 +1547,10 @@ function stepId() {
 function stepLabel(op, description) {
   return [op, description].filter(Boolean).join(" \u2014 ") || "(sem nome)";
 }
+var ITEM_OP = "item";
+function lifecycleLabel(kind, op, description) {
+  return stepLabel(kind === "item" && op === ITEM_OP ? void 0 : op, description);
+}
 function errorText(error) {
   if (error instanceof Error) return error.message || error.name;
   return safeString(error);
@@ -1579,21 +1583,25 @@ function colorForStatus(status) {
   }
 }
 var Step = class {
-  constructor(transaction, parentStepId, op, description) {
+  constructor(transaction, parentStepId, op, description, kind = "step") {
     this.transaction = transaction;
     this.parentStepId = parentStepId;
     this.op = op;
     this.description = description;
+    this.kind = kind;
   }
   transaction;
   parentStepId;
   op;
   description;
+  kind;
   stepId = stepId();
   startTimestamp = nowISO();
   status = "ok";
   endTimestamp;
   _data;
+  // desfecho que a linha de FINISH reporta no lugar do status da etapa (item do `each`)
+  outcome;
   // ── API do bot ────────────────────────────────────────────────────────────
   warning(message, options) {
     if (this.status !== "error") this._setStatus("warning", message);
@@ -1632,6 +1640,13 @@ var Step = class {
     this._close();
     return this;
   }
+  /**
+   * Faz a linha de FINISH reportar `status`/`reason` em vez do status da etapa — o
+   * `items.each` usa para o log do item seguir o desfecho dele (sucesso/falha/ocorrência).
+   */
+  _setOutcome(status, reason) {
+    this.outcome = { status, reason };
+  }
   _setData(key, value) {
     this._data = { ...this._data, [key]: value };
   }
@@ -1663,14 +1678,15 @@ var Step = class {
   _close() {
     if (this.endTimestamp) return;
     this.endTimestamp = nowISO();
+    const { status, reason } = this.outcome ?? { status: this.status, reason: this.reason() };
     this.transaction.emit(
-      "step",
+      this.kind,
       "finish",
-      stepLabel(this.op, this.description),
+      lifecycleLabel(this.kind, this.op, this.description),
       this.startTimestamp,
       this.endTimestamp,
-      this.status,
-      this.reason()
+      status,
+      reason
     );
   }
   toJSON() {
@@ -1725,7 +1741,7 @@ var Transaction = class {
   emit(kind, phase, label, startTs, endTs, status, reason) {
     const durationMs = startTs && endTs ? new Date(endTs).getTime() - new Date(startTs).getTime() : void 0;
     const suffix = (durationMs != null ? ` (${durationMs}ms)` : "") + (reason ? `: ${reason}` : "");
-    const localFinish = this.echo && kind === "step" && phase === "finish";
+    const localFinish = this.echo && kind !== "transaction" && phase === "finish";
     if (this.client?.debug || localFinish) {
       const tag = colorize(`[hobots:${kind}] ${phase.toUpperCase()}`, phase === "finish" ? colorForStatus(status ?? "ok") : "cyan");
       console.log(`${tag} ${label}${suffix}`);
@@ -1772,13 +1788,16 @@ var Transaction = class {
     if (!step) return fn();
     return runWithStepScope({ transaction: this, step }, fn);
   }
-  /** Abre uma etapa sob a corrente (ou direta da transaction). Interno: o bot usa `step()`. */
-  start(op, description) {
+  /**
+   * Abre uma etapa sob a corrente (ou direta da transaction). Interno: o bot usa `step()`; o
+   * `items.each` abre com `kind: 'item'` (linhas `[item] START/FINISH`).
+   */
+  start(op, description, kind = "step") {
     this.stepGuard?.();
     const parent = this.currentStep();
-    const step = new Step(this, parent ? parent.stepId : this.stepId, op, description);
+    const step = new Step(this, parent ? parent.stepId : this.stepId, op, description, kind);
     this.steps.push(step);
-    this.emit("step", "start", stepLabel(op, description));
+    this.emit(kind, "start", lifecycleLabel(kind, op, description));
     return step;
   }
   /**
@@ -1925,13 +1944,15 @@ function thrownMessage(error) {
   return safeString(error);
 }
 var ItemHandle = class {
-  constructor(index, id, step, basePayload, sink) {
+  constructor(value, index, id, step, basePayload2, sink) {
+    this.value = value;
     this.index = index;
     this.step = step;
-    this.basePayload = basePayload;
+    this.basePayload = basePayload2;
     this.sink = sink;
     this.id = id ?? uuid4();
   }
+  value;
   index;
   step;
   basePayload;
@@ -1940,6 +1961,7 @@ var ItemHandle = class {
   id;
   reported = false;
   status;
+  message;
   attempt = 1;
   accumulated = {};
   data(payload) {
@@ -1961,6 +1983,7 @@ var ItemHandle = class {
     this.attempt = attempt;
     this.reported = false;
     this.status = void 0;
+    this.message = void 0;
     this.accumulated = {};
     if (this.step && (this.step.status === "error" || this.step.status === "warning")) {
       this.step._setStatus("ok");
@@ -1970,10 +1993,23 @@ var ItemHandle = class {
   record(status, message, payload, image3) {
     this.reported = true;
     this.status = status;
+    this.message = message;
     const merged = { ...this.basePayload ?? {}, ...this.accumulated, ...payload ?? {} };
     this.sink.report(status, message, Object.keys(merged).length > 0 ? merged : void 0, this.id, image3);
   }
 };
+function defaultPayload(element) {
+  if (typeof element !== "object" || element === null) return void 0;
+  const proto = Object.getPrototypeOf(element);
+  if (proto !== Object.prototype && proto !== null) return void 0;
+  const copy = { ...element };
+  return Object.keys(copy).length > 0 ? copy : void 0;
+}
+function basePayload(spec, element, index) {
+  if (spec === false) return void 0;
+  if (spec === void 0) return defaultPayload(element);
+  return spec(element, index);
+}
 function field(element, name) {
   if (typeof element !== "object" || element === null) return { present: false, value: void 0 };
   const record = element;
@@ -2009,6 +2045,10 @@ function knownLength(list) {
   const length = list?.length;
   return typeof length === "number" && Number.isInteger(length) && length >= 1 ? length : void 0;
 }
+var ITEM_LOG_STATUS = { succeeded: "ok", occurrence: "warning", failed: "error" };
+function setItemOutcome(step, status, message) {
+  step._setOutcome(ITEM_LOG_STATUS[status], status === "succeeded" ? void 0 : message);
+}
 function skippedMessage(count) {
   if (count === 1) return "1 item pulado: j\xE1 conclu\xEDdo neste trabalho numa execu\xE7\xE3o anterior";
   return `${count} itens pulados: j\xE1 conclu\xEDdos neste trabalho numa execu\xE7\xE3o anterior`;
@@ -2018,23 +2058,34 @@ async function eachItem(list, handler, options, sink) {
   const requested = options.retries ?? DEFAULT_EACH_RETRIES;
   const totalRetries = Number.isFinite(requested) ? Math.max(0, Math.floor(requested)) : DEFAULT_EACH_RETRIES;
   const explicitId = options.id !== void 0;
-  const length = options.progress === false ? void 0 : knownLength(list);
-  if (length !== void 0) sink.declareTotal(length);
   const done = options.skipDone === false ? void 0 : await sink.doneItemIds();
-  let index = 0;
-  for await (const element of list) {
+  const isDone = (id) => id !== void 0 && done !== void 0 && done.has(id);
+  const length = knownLength(list);
+  let entries;
+  if (length !== void 0 && done !== void 0 && done.size > 0) {
+    const pending = [];
+    let position = 0;
+    for await (const element of list) {
+      const id = resolveId(options.id, element, position, explicitId);
+      if (isDone(id)) result.skipped += 1;
+      else pending.push({ element, index: position, id });
+      position += 1;
+    }
+    if (options.progress !== false && pending.length > 0) sink.declareTotal(pending.length);
+    entries = pending;
+  } else {
+    if (options.progress !== false && length !== void 0) sink.declareTotal(length);
+    entries = lazyEntries(list, options.id, explicitId);
+  }
+  for await (const { element, index, id } of entries) {
     sink.checkCanceled();
-    const id = resolveId(options.id, element, index, explicitId);
-    if (done?.size && id !== void 0 && done.has(id)) {
-      result.total += 1;
+    if (isDone(id)) {
       result.skipped += 1;
-      if (options.progress !== false) sink.advance();
-      index += 1;
       continue;
     }
     const description = options.description?.(element, index) ?? id ?? `#${index + 1}`;
     const step = sink.startStep(options.op ?? "item", description);
-    const handle = new ItemHandle(index, id, step, options.payload?.(element, index), sink);
+    const handle = new ItemHandle(element, index, id, step, basePayload(options.payload, element, index), sink);
     const current = index;
     let attempts = 0;
     let lastFailure;
@@ -2043,7 +2094,7 @@ async function eachItem(list, handler, options, sink) {
         (attempt) => {
           attempts = attempt;
           if (attempt > 1) handle._nextAttempt(attempt);
-          return sink.stepScope(step, async () => handler(element, handle, current));
+          return sink.stepScope(step, async () => handler(handle, current));
         },
         {
           retries: totalRetries,
@@ -2079,20 +2130,34 @@ async function eachItem(list, handler, options, sink) {
       } else {
         const message = thrownMessage(error);
         if (!handle.reported) handle.failed(message);
-        step?._failed(error);
+        if (step) {
+          setItemOutcome(step, handle.status ?? "failed", handle.message);
+          step._failed(error);
+        }
         sink.logError(`item ${description} falhou: ${message}`);
       }
     }
-    step?._close();
+    const final = handle.status ?? "succeeded";
+    if (step) {
+      setItemOutcome(step, final, handle.message);
+      step._close();
+    }
     if (options.progress !== false) sink.advance();
     result.total += 1;
-    result[handle.status ?? "succeeded"] += 1;
-    index += 1;
+    result[final] += 1;
     if (options.flush !== false) await sink.flush();
   }
+  result.total += result.skipped;
   if (result.skipped > 0) sink.logInfo(skippedMessage(result.skipped));
   return result;
 }
+async function* lazyEntries(list, spec, explicit) {
+  let index = 0;
+  for await (const element of list) {
+    yield { element, index, id: resolveId(spec, element, index, explicit) };
+    index += 1;
+  }
+}
 function noteAttempts(step, attempts) {
   if (attempts > 1) step._setData("attempts", attempts);
 }
@@ -2478,7 +2543,7 @@ var RunReporter = class {
     tx.setStepGuard(checkCanceled);
     const eachSink = {
       report: (status, message, payload, id, image3) => this.addItem(status, message, payload, id, image3),
-      startStep: (op, description) => tx.start(op, description),
+      startStep: (op, description) => tx.start(op, description, "item"),
       stepScope: (step, fn) => tx.scope(step, fn),
       declareTotal: (total) => {
         if (this.progressTotal == null) this.setProgress(this.progressCurrent, total);