@lexnode/legal-data-sdk 1.24.0 → 1.25.0
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/README.md +19 -0
- package/package.json +1 -1
- package/schema.d.ts +26 -2
package/README.md
CHANGED
|
@@ -302,6 +302,25 @@ if (meta.partialIndex) {
|
|
|
302
302
|
}
|
|
303
303
|
```
|
|
304
304
|
|
|
305
|
+
Antes de recusar a resposta parcial que veio sem o processo porque partes do
|
|
306
|
+
índice ficaram fora, o motor consulta a fonte de novo — até duas vezes, com uma
|
|
307
|
+
pausa curta, enquanto a espera couber.
|
|
308
|
+
|
|
309
|
+
**`meta.otherInstances`: o número tem outro documento na fonte.** A fonte pode
|
|
310
|
+
guardar mais de um documento por número — em geral um por instância (1º grau,
|
|
311
|
+
2º grau, turma recursal…), às vezes dois no mesmo grau —, e o motor serve e
|
|
312
|
+
guarda um só: o de `data`, cujo grau está em `degree`. Quando a resposta da
|
|
313
|
+
fonte trouxe outros, `meta.otherInstances` lista cada um com o grau (`grau`), a
|
|
314
|
+
data em que a fonte o atualizou (`updatedAt`) e o órgão julgador (`courtBody`,
|
|
315
|
+
quando vem). A lista não sai para processo restrito e não inclui documento que o
|
|
316
|
+
motor classificaria como segredo de justiça.
|
|
317
|
+
|
|
318
|
+
```ts
|
|
319
|
+
for (const outra of meta.otherInstances ?? []) {
|
|
320
|
+
// Ex.: { grau: "G1", updatedAt: "2026-04-15T12:00:00.000Z" }
|
|
321
|
+
}
|
|
322
|
+
```
|
|
323
|
+
|
|
305
324
|
**Agentes têm a espera deles.** No canal para agentes (MCP), as tools
|
|
306
325
|
`ler_processo` e `consultar_processo` escolhem a espera em `maxWaitSeconds`, na
|
|
307
326
|
mesma faixa e com padrão de 120 s; esse canal não passa pelo SDK.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lexnode/legal-data-sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.25.0",
|
|
4
4
|
"description": "Cliente TypeScript do LexNode, o motor de dados jur\u00eddicos do Brasil: transporte tipado, erros classificados, verifica\u00e7\u00e3o de webhook e os tipos gerados do contrato OpenAPI.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://www.lexnode.com.br/docs",
|
package/schema.d.ts
CHANGED
|
@@ -159,7 +159,7 @@ export interface paths {
|
|
|
159
159
|
};
|
|
160
160
|
/**
|
|
161
161
|
* Obter um processo pelo número
|
|
162
|
-
* @description Retorna o registro exato do processo para o tribunal e o número informados, com resolução cache-first quando disponível. `waitSeconds` escolhe quanto esperar pela fonte processual. Quando a fonte responde com parte do índice e o processo está na parte que respondeu, ele é servido e `meta.partialIndex` diz quantas partes falharam (`shardsFailed`), de quantas (`shardsTotal`) e se o prazo interno da fonte estourou (`timedOut`): outra instância do mesmo número, se existir, pode não ter vindo. A exceção é o processo que veio de uma instância diferente da que o acervo já guarda do número: a guardada pode estar na parte que não respondeu, e a resposta parcial não é servida. Resposta parcial que não serve o processo — sem ele, ou com a outra instância — é 502 `UPSTREAM_UNAVAILABLE` retentável, nunca 404.
|
|
162
|
+
* @description Retorna o registro exato do processo para o tribunal e o número informados, com resolução cache-first quando disponível. `waitSeconds` escolhe quanto esperar pela fonte processual. Quando a fonte responde com parte do índice e o processo está na parte que respondeu, ele é servido e `meta.partialIndex` diz quantas partes falharam (`shardsFailed`), de quantas (`shardsTotal`) e se o prazo interno da fonte estourou (`timedOut`): outra instância do mesmo número, se existir, pode não ter vindo. A exceção é o processo que veio de uma instância diferente da que o acervo já guarda do número: a guardada pode estar na parte que não respondeu, e a resposta parcial não é servida. Resposta parcial que não serve o processo — sem ele, ou com a outra instância — é 502 `UPSTREAM_UNAVAILABLE` retentável, nunca 404; antes dela, o motor consulta a fonte de novo, até duas vezes, enquanto o prazo de `waitSeconds` couber. Quando a resposta traz mais de um documento do número — em geral um por instância, mas dois podem ser do mesmo grau —, o motor serve e guarda um só, o de `data` (grau em `degree`), e `meta.otherInstances` lista os outros que vieram: grau, data de atualização na fonte e órgão julgador.
|
|
163
163
|
*
|
|
164
164
|
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
165
165
|
*/
|
|
@@ -203,7 +203,7 @@ export interface paths {
|
|
|
203
203
|
};
|
|
204
204
|
/**
|
|
205
205
|
* Obter um snapshot vivo do processo
|
|
206
|
-
* @description Busca o hit exato do processo no upstream do CNJ e retorna o registro normalizado do processo, o payload bruto da fonte e as movimentações CNJ normalizadas. `waitSeconds` escolhe quanto esperar pela fonte processual. Quando a fonte responde com parte do índice e o processo está na parte que respondeu, ele é servido e `meta.partialIndex` diz quantas partes falharam (`shardsFailed`), de quantas (`shardsTotal`) e se o prazo interno da fonte estourou (`timedOut`): outra instância do mesmo número, se existir, pode não ter vindo. A exceção é o processo que veio de uma instância diferente da que o acervo já guarda do número: a guardada pode estar na parte que não respondeu, e a resposta parcial não é servida. Resposta parcial que não serve o processo — sem ele, ou com a outra instância — é 502 `UPSTREAM_UNAVAILABLE` retentável, nunca 404.
|
|
206
|
+
* @description Busca o hit exato do processo no upstream do CNJ e retorna o registro normalizado do processo, o payload bruto da fonte e as movimentações CNJ normalizadas. `waitSeconds` escolhe quanto esperar pela fonte processual. Quando a fonte responde com parte do índice e o processo está na parte que respondeu, ele é servido e `meta.partialIndex` diz quantas partes falharam (`shardsFailed`), de quantas (`shardsTotal`) e se o prazo interno da fonte estourou (`timedOut`): outra instância do mesmo número, se existir, pode não ter vindo. A exceção é o processo que veio de uma instância diferente da que o acervo já guarda do número: a guardada pode estar na parte que não respondeu, e a resposta parcial não é servida. Resposta parcial que não serve o processo — sem ele, ou com a outra instância — é 502 `UPSTREAM_UNAVAILABLE` retentável, nunca 404; antes dela, o motor consulta a fonte de novo, até duas vezes, enquanto o prazo de `waitSeconds` couber. Quando a resposta traz mais de um documento do número — em geral um por instância, mas dois podem ser do mesmo grau —, o motor serve e guarda um só, o de `data` (grau em `degree`), e `meta.otherInstances` lista os outros que vieram: grau, data de atualização na fonte e órgão julgador.
|
|
207
207
|
*
|
|
208
208
|
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
209
209
|
*/
|
|
@@ -2131,6 +2131,18 @@ export interface operations {
|
|
|
2131
2131
|
/** @description A fonte estourou o próprio prazo interno e devolveu só o que deu tempo de olhar. */
|
|
2132
2132
|
timedOut: boolean;
|
|
2133
2133
|
};
|
|
2134
|
+
/** @description Presente só quando a resposta da fonte trouxe mais de um documento do número — em geral de instâncias diferentes, mas dois podem ter o mesmo `grau`. O motor serve e guarda um só (o de `data`, que diz o grau em `degree`); estes são os outros que vieram na mesma resposta. Não inclui documento que o motor classificaria como segredo de justiça, e não aparece quando o processo servido é restrito. */
|
|
2135
|
+
otherInstances?: {
|
|
2136
|
+
/** @description O grau deste documento na fonte: G1, G2, JE, TR… */
|
|
2137
|
+
grau: string | null;
|
|
2138
|
+
/**
|
|
2139
|
+
* Format: date-time
|
|
2140
|
+
* @description Quando a fonte atualizou este documento pela última vez.
|
|
2141
|
+
*/
|
|
2142
|
+
updatedAt: string | null;
|
|
2143
|
+
/** @description O órgão julgador deste documento, quando a fonte o traz. */
|
|
2144
|
+
courtBody?: string;
|
|
2145
|
+
}[];
|
|
2134
2146
|
} & {
|
|
2135
2147
|
[key: string]: unknown;
|
|
2136
2148
|
};
|
|
@@ -2764,6 +2776,18 @@ export interface operations {
|
|
|
2764
2776
|
/** @description A fonte estourou o próprio prazo interno e devolveu só o que deu tempo de olhar. */
|
|
2765
2777
|
timedOut: boolean;
|
|
2766
2778
|
};
|
|
2779
|
+
/** @description Presente só quando a resposta da fonte trouxe mais de um documento do número — em geral de instâncias diferentes, mas dois podem ter o mesmo `grau`. O motor serve e guarda um só (o de `data`, que diz o grau em `degree`); estes são os outros que vieram na mesma resposta. Não inclui documento que o motor classificaria como segredo de justiça, e não aparece quando o processo servido é restrito. */
|
|
2780
|
+
otherInstances?: {
|
|
2781
|
+
/** @description O grau deste documento na fonte: G1, G2, JE, TR… */
|
|
2782
|
+
grau: string | null;
|
|
2783
|
+
/**
|
|
2784
|
+
* Format: date-time
|
|
2785
|
+
* @description Quando a fonte atualizou este documento pela última vez.
|
|
2786
|
+
*/
|
|
2787
|
+
updatedAt: string | null;
|
|
2788
|
+
/** @description O órgão julgador deste documento, quando a fonte o traz. */
|
|
2789
|
+
courtBody?: string;
|
|
2790
|
+
}[];
|
|
2767
2791
|
} & {
|
|
2768
2792
|
[key: string]: unknown;
|
|
2769
2793
|
};
|