@aurea-uds/contracts 0.61.0 → 0.62.1

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # @aurea-uds/contracts
2
2
 
3
- O contrato do projeto **Aurea UDS**, em JSON legível por máquina.
3
+ The contract of the **Aurea UDS** project, as machine-readable JSON.
4
4
 
5
5
  ```bash
6
6
  pnpm add @aurea-uds/contracts
@@ -10,33 +10,31 @@ pnpm add @aurea-uds/contracts
10
10
  import contract from "@aurea-uds/contracts/contract" with {type: "json"};
11
11
  ```
12
12
 
13
- Ele diz o que o design system promete — identidade, o vocabulário do catálogo, as listas de
14
- valores contra as quais as fichas dos componentes são conferidas — numa forma que uma ferramenta
15
- lê, em vez de um parágrafo que uma pessoa tem de interpretar.
13
+ It states what the design system promises — identity, the catalog vocabulary, the lists of values that
14
+ each component's record is checked against — in a form a tool can read, instead of a paragraph a person
15
+ has to interpret.
16
16
 
17
- ## A superfície da API
17
+ ## The API surface
18
18
 
19
19
  ```js
20
20
  import surface from "@aurea-uds/contracts/api-surface" with {type: "json"};
21
21
  ```
22
22
 
23
- Todo componente que o `@aurea-uds/react` exporta, com as props e — quando o tipo é uma união de
24
- textos fixos — os valores que cada prop aceita. Ela é **derivada**, não escrita: o build lê as
25
- declarações que o compilador do TypeScript gera, então herança, `Omit`, `Pick` e apelidos em
26
- cadeia são resolvidos pelo compilador, e não por palpite. Editá-la à mão é justamente o defeito
27
- que ela existe para evitar.
23
+ Every component `@aurea-uds/react` exports, with its props and — when the type is a union of fixed
24
+ strings — the values each prop accepts. It is **derived**, not written: the build reads the declarations
25
+ the TypeScript compiler emits, so inheritance, `Omit`, `Pick` and chained aliases are resolved by the
26
+ compiler, not by guesswork. Editing it by hand is exactly the defect it exists to prevent.
28
27
 
29
- É ela que deixa uma ferramenta responder "que variantes este componente aceita?" sem ler o nosso
30
- código nem confiar na nossa prosa — e é contra ela que o validador confere as fichas de cada
31
- componente, para as duas não divergirem.
28
+ It lets a tool answer "which variants does this component accept?" without reading our code or trusting
29
+ our prose — and it is what each component's record is checked against, so the two never drift apart.
32
30
 
33
- ## O que não está aqui
31
+ ## What is not here
34
32
 
35
- As fichas de cada componente moram no repositório, não neste pacote. Elas geram o catálogo e
36
- deixam o validador conferir a biblioteca contra ela mesma; nada fora do build as usa. Se você
37
- precisar delas, abra uma issue pedindo, e elas ganham uma entrada. A superfície da API acima é a
38
- parte dessa resposta de que uma ferramenta precisa, e é por isso que ela vai no pacote.
33
+ The component records live in the repository, not in this package. They generate the catalog and let the
34
+ library be checked against itself; nothing outside the build uses them. If you need them, open an issue
35
+ asking for it, and they get an entry point. The API surface above is the part of that answer a tool
36
+ needs, which is why it ships in the package.
39
37
 
40
- ## Licença
38
+ ## License
41
39
 
42
40
  Apache-2.0.
@@ -42,6 +42,11 @@
42
42
  "xl"
43
43
  ]
44
44
  },
45
+ "IconButtonProps": {
46
+ "module": "actions",
47
+ "raw": "IconButtonBase & ({ name: AureaIcon; icon?: undefined; } | { icon: AureaIcon; name?: undefined; })",
48
+ "union": null
49
+ },
45
50
  "AureaFile": {
46
51
  "module": "arquivo",
47
52
  "raw": "{ uri: string; name: string; size?: number; mimeType?: string; }",
@@ -2551,16 +2556,22 @@
2551
2556
  "type": "boolean",
2552
2557
  "values": null
2553
2558
  },
2559
+ {
2560
+ "name": "label",
2561
+ "optional": false,
2562
+ "type": "string",
2563
+ "values": null
2564
+ },
2554
2565
  {
2555
2566
  "name": "name",
2556
2567
  "optional": false,
2557
- "type": "AureaIcon",
2568
+ "type": "AureaIcon | undefined",
2558
2569
  "values": null
2559
2570
  },
2560
2571
  {
2561
- "name": "label",
2572
+ "name": "icon",
2562
2573
  "optional": false,
2563
- "type": "string",
2574
+ "type": "undefined | AureaIcon",
2564
2575
  "values": null
2565
2576
  }
2566
2577
  ]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "Aurea — Universal Design System",
3
- "version": "0.61.0",
3
+ "version": "0.62.1",
4
4
  "status": "organized-source-of-truth",
5
5
  "language": "pt-BR",
6
6
  "fonts": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurea-uds/contracts",
3
- "version": "0.61.0",
3
+ "version": "0.62.1",
4
4
  "description": "O contrato do projeto Aurea UDS, em JSON legível por máquina.",
5
5
  "keywords": [
6
6
  "aurea",