@aurea-uds/contracts 0.10.0 → 0.11.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 -21
- package/aurea.contract.json +2 -2
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @aurea-uds/contracts
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
O contrato do projeto **Aurea UDS**, em JSON legível por máquina.
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
6
|
pnpm add @aurea-uds/contracts
|
|
@@ -10,35 +10,33 @@ pnpm add @aurea-uds/contracts
|
|
|
10
10
|
import contract from "@aurea-uds/contracts/contract" with {type: "json"};
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
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.
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## A superfície da API
|
|
18
18
|
|
|
19
19
|
```js
|
|
20
20
|
import surface from "@aurea-uds/contracts/api-surface" with {type: "json"};
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
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.
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
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.
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## O que não está aqui
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
entry point. The API surface above is the part of that answer a tool actually needs, and it
|
|
40
|
-
ships for exactly that reason.
|
|
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.
|
|
41
39
|
|
|
42
|
-
##
|
|
40
|
+
## Licença
|
|
43
41
|
|
|
44
42
|
Apache-2.0.
|
package/aurea.contract.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Aurea — Universal Design System",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"status": "organized-source-of-truth",
|
|
5
5
|
"language": "pt-BR",
|
|
6
6
|
"fonts": {
|
|
@@ -200,7 +200,7 @@
|
|
|
200
200
|
"@aurea-uds/react",
|
|
201
201
|
"@aurea-uds/native"
|
|
202
202
|
],
|
|
203
|
-
"rule": "Artefatos derivam
|
|
203
|
+
"rule": "Artefatos derivam dos pacotes do monorepo; não editar manualmente fora deles.",
|
|
204
204
|
"mode": "workspace-packages",
|
|
205
205
|
"commands": {
|
|
206
206
|
"verify": "pnpm validate"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aurea-uds/contracts",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.11.0",
|
|
4
|
+
"description": "O contrato do projeto Aurea UDS, em JSON legível por máquina.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"aurea",
|
|
7
7
|
"design-system",
|
|
@@ -13,6 +13,10 @@
|
|
|
13
13
|
"url": "git+https://github.com/victor1mor/aurea-uds.git",
|
|
14
14
|
"directory": "packages/contracts"
|
|
15
15
|
},
|
|
16
|
+
"homepage": "https://github.com/victor1mor/aurea-uds/tree/main/packages/contracts#readme",
|
|
17
|
+
"bugs": {
|
|
18
|
+
"url": "https://github.com/victor1mor/aurea-uds/issues"
|
|
19
|
+
},
|
|
16
20
|
"publishConfig": {
|
|
17
21
|
"access": "public"
|
|
18
22
|
},
|