@lexnode/legal-data-sdk 1.0.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.
Files changed (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +40 -0
  3. package/package.json +27 -0
  4. package/schema.d.ts +13739 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 OG Sistemas
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,40 @@
1
+ # @lexnode/legal-data-sdk
2
+
3
+ Tipos TypeScript do contrato da API do **LexNode**, o motor de dados jurídicos
4
+ do Brasil: processos e movimentações, publicações dos diários oficiais,
5
+ jurisprudência, monitores e webhooks. O pacote traz **só tipos** — nenhum
6
+ cliente HTTP embutido —, para que você escolha o transporte e o compilador
7
+ confira o resto.
8
+
9
+ ## Instalação
10
+
11
+ ```sh
12
+ npm install -D @lexnode/legal-data-sdk
13
+ ```
14
+
15
+ ## Uso
16
+
17
+ Os tipos são gerados do documento OpenAPI publicado pela API e expõem as
18
+ interfaces `paths` e `operations`. Combine-os com o cliente de sua preferência
19
+ (por exemplo, `openapi-fetch`):
20
+
21
+ ```ts
22
+ import type { paths, operations } from "@lexnode/legal-data-sdk";
23
+
24
+ // Uma operação inteira, pela rota e pelo método:
25
+ type SearchProcesses = paths["/v1/processes/search"]["post"];
26
+
27
+ // Ou pelo operationId — aqui, o corpo de sucesso de listTribunals:
28
+ type Tribunals =
29
+ operations["listTribunals"]["responses"][200]["content"]["application/json"]["data"];
30
+ ```
31
+
32
+ ## Referências
33
+
34
+ - Documentação: <https://www.lexnode.com.br/docs>
35
+ - Contrato OpenAPI vigente: <https://api.lexnode.com.br/openapi.json>
36
+ - Changelog da API: <https://www.lexnode.com.br/changelog>
37
+
38
+ A versão deste pacote acompanha o campo `info.version` do documento OpenAPI. A
39
+ superfície `/v1` evolui de forma aditiva: campos e rotas só entram somando, e
40
+ uma mudança incompatível exige rota nova.
package/package.json ADDED
@@ -0,0 +1,27 @@
1
+ {
2
+ "name": "@lexnode/legal-data-sdk",
3
+ "version": "1.0.0",
4
+ "description": "TypeScript types for the LexNode legal-data engine: a generic B2B API over Brazilian court process, movement and publication data.",
5
+ "license": "MIT",
6
+ "homepage": "https://www.lexnode.com.br/docs",
7
+ "keywords": [
8
+ "lexnode",
9
+ "legal",
10
+ "brazil",
11
+ "cnj",
12
+ "djen",
13
+ "openapi",
14
+ "types",
15
+ "typescript"
16
+ ],
17
+ "private": false,
18
+ "types": "schema.d.ts",
19
+ "files": [
20
+ "schema.d.ts",
21
+ "README.md",
22
+ "LICENSE"
23
+ ],
24
+ "publishConfig": {
25
+ "access": "public"
26
+ }
27
+ }