@sia-ui/cli 0.3.0 → 0.3.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +168 -0
  2. package/README.md +183 -3
  3. package/package.json +9 -9
package/CHANGELOG.md ADDED
@@ -0,0 +1,168 @@
1
+ # @sia-ui/cli
2
+
3
+ ## 0.3.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Expose public contribution flow on npm
8
+
9
+ ## 0.3.0
10
+
11
+ ### Minor Changes
12
+
13
+ - Une ressource se déclare une fois, cinq composants refondus, et une
14
+ documentation qui décrit le produit plutôt que son développement.
15
+
16
+ ## Déclarer une ressource
17
+
18
+ `defineResource` décrit un objet métier **une seule fois**. Les colonnes du
19
+ tableau, les champs du formulaire, les lignes de la vue de détail, la
20
+ validation, les clés de recherche et les quatre règles de droits en sont
21
+ dérivés — et chaque dérivation reste remplaçable par la prop correspondante.
22
+
23
+ ```tsx
24
+ <CrudPage resource={FACTURE} data={factures} can={can}
25
+ onSubmit={…} onDelete={…} />
26
+ ```
27
+
28
+ Le rendu se déduit du type : un `currency` s'affiche formaté et aligné à
29
+ droite, un `select` avec ses `tones` devient une pastille, une `date` passe
30
+ par le format local. `permissions: "auto"` applique la convention
31
+ `<nom>.<verbe>`.
32
+
33
+ ## Les quatre opérations ouvrent leurs propres boîtes
34
+
35
+ `CrudPage` n'appelle plus seulement un gestionnaire : déclarer `fields` et
36
+ `onSubmit` suffit à obtenir un formulaire vide en création, le même prérempli
37
+ en modification, et une vue de détail. `onCreate`, `onEdit` et `onView`
38
+ restent la porte de sortie vers une page dédiée — fournis, ils passent devant
39
+ la boîte.
40
+
41
+ Les boîtes n'inventent rien : `Modal` pour la boîte, `Form` pour la saisie,
42
+ `Descriptions` pour la lecture.
43
+
44
+ ## Cinq composants refondus
45
+ - **`Sidebar`** — le rail réduit n'enferme plus ses sous-menus : ils sortent
46
+ en volet. Profondeur illimitée, droits en cascade, trois variantes.
47
+ - **`AppShell`** — se branche sur n'importe quel routeur par une seule
48
+ chaîne, l'adresse courante. Trois états de barre, tiroir ou onglets bas sur
49
+ mobile, filtrage des droits fait une seule fois.
50
+ - **`Avatar`** — teinte dérivée du nom, repli peint sous l'image, quatre états
51
+ de présence, et des piles qui résument leur surplus.
52
+ - **`DataTable`** — actions de ligne avec droits et confirmation, sélection et
53
+ barre groupée, vue en cartes, trois densités, états de chargement, d'erreur
54
+ et de vide.
55
+ - **`CrudPage`** — réécrit : il tenait en neuf lignes et n'offrait aucune des
56
+ quatre opérations qui lui donnent son nom.
57
+
58
+ ## Ruptures
59
+ - `CrudPage` : `actions` portait des nœuds d'en-tête, ils vont dans
60
+ `headerActions`. `data` est requis, et `columns` l'est aussi à moins qu'une
61
+ `resource` ne les fournisse.
62
+ - `Sidebar` et `AppShell` : les props ont changé. Voir
63
+ [La navigation latérale](https://beatjo.github.io/sia-ui-site/guides/navigation)
64
+ et [La coquille d'application](https://beatjo.github.io/sia-ui-site/guides/coquille-application).
65
+
66
+ ## Documentation
67
+
68
+ Les cent trois composants ont désormais une page de référence — ce qu'ils
69
+ font, comment les installer, et **toutes** leurs props avec type et valeur par
70
+ défaut. Ces pages sont écrites par le code : les props viennent des types, les
71
+ descriptions de leurs commentaires, la commande d'installation du registre.
72
+
73
+ Le catalogue est passé de seize sections en deux langues à neuf, ordonnées du
74
+ plus général au plus assemblé. Les comptes rendus de développement ont été
75
+ retirés de la documentation : ils décrivaient un chemin parcouru, pas un
76
+ produit.
77
+
78
+ ## 0.2.2
79
+
80
+ ### Patch Changes
81
+
82
+ - Restore the sia-ui executable
83
+
84
+ ## 0.2.1
85
+
86
+ ### Patch Changes
87
+
88
+ - Include component styles in the CLI registry
89
+
90
+ ## 0.2.0
91
+
92
+ ### Minor Changes
93
+
94
+ - e4e4a72: Annonces, session et droits, formulaires sans dépendance, et vingt entrées de
95
+ registre de plus.
96
+
97
+ ## Composants
98
+ - **Annonces** — `toast()` s'appelle hors de React, variante `loading`, boutons
99
+ d'action, six coins réglables par annonce, balayage pour écarter, suivi de
100
+ promesse.
101
+ - **Session et droits** — `createSessionStore` avec sa machine à quatre états,
102
+ `createAccessLayer` à évaluateur injecté, `RequireSession` sans routeur.
103
+ - **Formulaires** — le contrat `FormAdapter` et `useLocalForm`, sans
104
+ dépendance. `Form` est écrit sur le contrat : il n'importe ni
105
+ react-hook-form ni zod, et se câble à l'un ou l'autre par un adaptateur.
106
+ - **Vingt entrées de registre de plus** — `progress`, `dropdown-menu`,
107
+ `accordion`, `sidebar`, `breadcrumb`, `steps`, `toggle`, `scroll-area`,
108
+ `hover-card`, `aspect-ratio`, `input-number`, `password-input`,
109
+ `phone-input`, `chart`, `require-session`, `form`…
110
+ - **Thème** — mode `system`, persistance et script anti-clignotement dans
111
+ `SiaProvider`, en remplacement de `next-themes`.
112
+
113
+ ## `@sia-ui/api`
114
+
115
+ Le client HTTP typé est un paquet à part : ni React, ni DOM, ni tokens. Il
116
+ s'installe seul, et copier un `Badge` depuis le registre ne l'entraîne pas.
117
+
118
+ ## Utilitaires
119
+
120
+ `@sia-ui/utils` passe de six à quatorze modules : `query`, `async`,
121
+ `collection`, `object`, `validation`, `file`, `clipboard`, `locale`.
122
+
123
+ ## Archives
124
+ - Plus de sourcemaps : elles pesaient environ soixante pour cent de chaque
125
+ archive — `@sia-ui/react-web` passe de 2,1 Mo à 759 Ko.
126
+ - Chaque paquet porte enfin la licence MIT qu'il annonce.
127
+
128
+ ## Vitrine en ligne
129
+
130
+ Trois surfaces publiées sur GitHub Pages à chaque poussée sur `main` : la
131
+ documentation à la racine, le catalogue Storybook sous `/storybook/`, la
132
+ démonstration sous `/preview/`. Le site de documentation est construit depuis
133
+ les fichiers de `docs/` eux-mêmes, qui restent du Markdown ordinaire.
134
+
135
+ ## Le registre n'est plus une voie sans retour
136
+
137
+ Installer était jusqu'ici définitif : plus rien ne disait ce qu'on avait, ce
138
+ qu'on avait retouché, ni ce qui avait bougé en amont — donc rien ne permettait
139
+ de corriger ni de déprécier une entrée après coup.
140
+ - **`sia-ui.lock.json`**, écrit à chaque `add` : version, date et empreinte de
141
+ chaque fichier copié.
142
+ - **Quatre commandes** : `diff`, `remove`, `doctor`, `list --outdated`.
143
+ `remove` refuse de casser un voisin ou d'effacer un fichier retouché.
144
+ - **Cycle de vie des entrées** — `experimental`, `stable`, `deprecated`,
145
+ `removed` — avec `replacedBy`. `add` refuse ce qui est retiré, `doctor`
146
+ signale ce qui est déprécié chez qui l'a déjà installé.
147
+ - **Journal du registre**, entrée par entrée, dont `pnpm check:changelog`
148
+ refuse qu'il mente.
149
+ - **Registre servi en HTTP**, versionné par l'URL : `…/r/v1/`. Corriger une
150
+ entrée n'oblige plus à republier la CLI.
151
+
152
+ ## Corrections
153
+ - La case à cocher et le bouton radio masquaient leur contrôle natif en
154
+ `opacity:0`. Le navigateur le peignait encore sous le visuel personnalisé, et
155
+ ce dessin clignotait au clic. Les deux utilisent désormais la recette
156
+ partagée `.sia-visually-hidden`, qui le découpe hors du rendu sans le retirer
157
+ du clavier.
158
+ - Une case à cocher non contrôlée ne se peignait jamais cochée : l'`<input>`
159
+ basculait, mais la classe qui dessine la case ne suivait pas.
160
+ - Le curseur de survol des graphes était ovale, et le tracé de la courbe
161
+ haché : les marqueurs sont sortis du SVG, qui est étiré sans conserver ses
162
+ proportions.
163
+ - L'entrée `drawer` du registre était impossible à installer — elle importait
164
+ deux dossiers que la CLI ne copie pas.
165
+
166
+ ### Patch Changes
167
+
168
+ - Include component styles when installing registry components
package/README.md CHANGED
@@ -17,7 +17,11 @@ add <nom> --overwrite écrase une copie existante
17
17
  Les chemins d'installation viennent de `sia-ui.json` :
18
18
 
19
19
  ```json
20
- { "components": "src/components", "lib": "src/lib", "styles": "src/styles/sia-ui.css" }
20
+ {
21
+ "components": "src/components",
22
+ "lib": "src/lib",
23
+ "styles": "src/styles/sia-ui.css"
24
+ }
21
25
  ```
22
26
 
23
27
  La CLI copie le fichier source tel quel et **annonce les paquets npm à
@@ -44,8 +48,184 @@ add src/components/DataTable/styles.css
44
48
  ```
45
49
 
46
50
  Une chose s'écrit au niveau le plus bas où elle a du sens, et une seule fois.
47
- Voir [la documentation](https://github.com/BeatJo/sia-ui/tree/main/docs).
51
+ Voir [la documentation](https://beatjo.github.io/sia-ui-site).
52
+
53
+ ## Contribuer
54
+
55
+ Le code source principal de SIA UI est privé pour le moment. Les retours publics passent par le dépôt `BeatJo/sia-ui-site` : bugs, demandes de composants, corrections de documentation et questions d'usage.
56
+
57
+ - Signaler un bug : https://github.com/BeatJo/sia-ui-site/issues
58
+ - Lire la documentation : https://beatjo.github.io/sia-ui-site/
59
+ - Voir la démonstration : https://beatjo.github.io/sia-ui-site/preview/
60
+
61
+ Les contributions directes au code des packages se font sur invitation dans le dépôt source privé.
62
+ ## Journal des changements
63
+
64
+ Le contenu ci-dessous reprend intégralement `CHANGELOG.md` pour rester visible sur npm.
65
+
66
+ # @sia-ui/cli
67
+
68
+ ## 0.3.0
69
+
70
+ ### Minor Changes
71
+
72
+ - Une ressource se déclare une fois, cinq composants refondus, et une
73
+ documentation qui décrit le produit plutôt que son développement.
74
+
75
+ ## Déclarer une ressource
76
+
77
+ `defineResource` décrit un objet métier **une seule fois**. Les colonnes du
78
+ tableau, les champs du formulaire, les lignes de la vue de détail, la
79
+ validation, les clés de recherche et les quatre règles de droits en sont
80
+ dérivés — et chaque dérivation reste remplaçable par la prop correspondante.
81
+
82
+ ```tsx
83
+ <CrudPage resource={FACTURE} data={factures} can={can}
84
+ onSubmit={…} onDelete={…} />
85
+ ```
86
+
87
+ Le rendu se déduit du type : un `currency` s'affiche formaté et aligné à
88
+ droite, un `select` avec ses `tones` devient une pastille, une `date` passe
89
+ par le format local. `permissions: "auto"` applique la convention
90
+ `<nom>.<verbe>`.
91
+
92
+ ## Les quatre opérations ouvrent leurs propres boîtes
93
+
94
+ `CrudPage` n'appelle plus seulement un gestionnaire : déclarer `fields` et
95
+ `onSubmit` suffit à obtenir un formulaire vide en création, le même prérempli
96
+ en modification, et une vue de détail. `onCreate`, `onEdit` et `onView`
97
+ restent la porte de sortie vers une page dédiée — fournis, ils passent devant
98
+ la boîte.
99
+
100
+ Les boîtes n'inventent rien : `Modal` pour la boîte, `Form` pour la saisie,
101
+ `Descriptions` pour la lecture.
102
+
103
+ ## Cinq composants refondus
104
+ - **`Sidebar`** — le rail réduit n'enferme plus ses sous-menus : ils sortent
105
+ en volet. Profondeur illimitée, droits en cascade, trois variantes.
106
+ - **`AppShell`** — se branche sur n'importe quel routeur par une seule
107
+ chaîne, l'adresse courante. Trois états de barre, tiroir ou onglets bas sur
108
+ mobile, filtrage des droits fait une seule fois.
109
+ - **`Avatar`** — teinte dérivée du nom, repli peint sous l'image, quatre états
110
+ de présence, et des piles qui résument leur surplus.
111
+ - **`DataTable`** — actions de ligne avec droits et confirmation, sélection et
112
+ barre groupée, vue en cartes, trois densités, états de chargement, d'erreur
113
+ et de vide.
114
+ - **`CrudPage`** — réécrit : il tenait en neuf lignes et n'offrait aucune des
115
+ quatre opérations qui lui donnent son nom.
116
+
117
+ ## Ruptures
118
+ - `CrudPage` : `actions` portait des nœuds d'en-tête, ils vont dans
119
+ `headerActions`. `data` est requis, et `columns` l'est aussi à moins qu'une
120
+ `resource` ne les fournisse.
121
+ - `Sidebar` et `AppShell` : les props ont changé. Voir
122
+ [La navigation latérale](https://beatjo.github.io/sia-ui-site/guides/navigation)
123
+ et [La coquille d'application](https://beatjo.github.io/sia-ui-site/guides/coquille-application).
124
+
125
+ ## Documentation
126
+
127
+ Les cent trois composants ont désormais une page de référence — ce qu'ils
128
+ font, comment les installer, et **toutes** leurs props avec type et valeur par
129
+ défaut. Ces pages sont écrites par le code : les props viennent des types, les
130
+ descriptions de leurs commentaires, la commande d'installation du registre.
131
+
132
+ Le catalogue est passé de seize sections en deux langues à neuf, ordonnées du
133
+ plus général au plus assemblé. Les comptes rendus de développement ont été
134
+ retirés de la documentation : ils décrivaient un chemin parcouru, pas un
135
+ produit.
136
+
137
+ ## 0.2.2
138
+
139
+ ### Patch Changes
140
+
141
+ - Restore the sia-ui executable
142
+
143
+ ## 0.2.1
144
+
145
+ ### Patch Changes
146
+
147
+ - Include component styles in the CLI registry
148
+
149
+ ## 0.2.0
150
+
151
+ ### Minor Changes
152
+
153
+ - e4e4a72: Annonces, session et droits, formulaires sans dépendance, et vingt entrées de
154
+ registre de plus.
155
+
156
+ ## Composants
157
+ - **Annonces** — `toast()` s'appelle hors de React, variante `loading`, boutons
158
+ d'action, six coins réglables par annonce, balayage pour écarter, suivi de
159
+ promesse.
160
+ - **Session et droits** — `createSessionStore` avec sa machine à quatre états,
161
+ `createAccessLayer` à évaluateur injecté, `RequireSession` sans routeur.
162
+ - **Formulaires** — le contrat `FormAdapter` et `useLocalForm`, sans
163
+ dépendance. `Form` est écrit sur le contrat : il n'importe ni
164
+ react-hook-form ni zod, et se câble à l'un ou l'autre par un adaptateur.
165
+ - **Vingt entrées de registre de plus** — `progress`, `dropdown-menu`,
166
+ `accordion`, `sidebar`, `breadcrumb`, `steps`, `toggle`, `scroll-area`,
167
+ `hover-card`, `aspect-ratio`, `input-number`, `password-input`,
168
+ `phone-input`, `chart`, `require-session`, `form`…
169
+ - **Thème** — mode `system`, persistance et script anti-clignotement dans
170
+ `SiaProvider`, en remplacement de `next-themes`.
171
+
172
+ ## `@sia-ui/api`
173
+
174
+ Le client HTTP typé est un paquet à part : ni React, ni DOM, ni tokens. Il
175
+ s'installe seul, et copier un `Badge` depuis le registre ne l'entraîne pas.
176
+
177
+ ## Utilitaires
178
+
179
+ `@sia-ui/utils` passe de six à quatorze modules : `query`, `async`,
180
+ `collection`, `object`, `validation`, `file`, `clipboard`, `locale`.
181
+
182
+ ## Archives
183
+ - Plus de sourcemaps : elles pesaient environ soixante pour cent de chaque
184
+ archive — `@sia-ui/react-web` passe de 2,1 Mo à 759 Ko.
185
+ - Chaque paquet porte enfin la licence MIT qu'il annonce.
186
+
187
+ ## Vitrine en ligne
188
+
189
+ Trois surfaces publiées sur GitHub Pages à chaque poussée sur `main` : la
190
+ documentation à la racine, le catalogue Storybook sous `/storybook/`, la
191
+ démonstration sous `/preview/`. Le site de documentation est construit depuis
192
+ les fichiers de `docs/` eux-mêmes, qui restent du Markdown ordinaire.
193
+
194
+ ## Le registre n'est plus une voie sans retour
195
+
196
+ Installer était jusqu'ici définitif : plus rien ne disait ce qu'on avait, ce
197
+ qu'on avait retouché, ni ce qui avait bougé en amont — donc rien ne permettait
198
+ de corriger ni de déprécier une entrée après coup.
199
+ - **`sia-ui.lock.json`**, écrit à chaque `add` : version, date et empreinte de
200
+ chaque fichier copié.
201
+ - **Quatre commandes** : `diff`, `remove`, `doctor`, `list --outdated`.
202
+ `remove` refuse de casser un voisin ou d'effacer un fichier retouché.
203
+ - **Cycle de vie des entrées** — `experimental`, `stable`, `deprecated`,
204
+ `removed` — avec `replacedBy`. `add` refuse ce qui est retiré, `doctor`
205
+ signale ce qui est déprécié chez qui l'a déjà installé.
206
+ - **Journal du registre**, entrée par entrée, dont `pnpm check:changelog`
207
+ refuse qu'il mente.
208
+ - **Registre servi en HTTP**, versionné par l'URL : `…/r/v1/`. Corriger une
209
+ entrée n'oblige plus à republier la CLI.
210
+
211
+ ## Corrections
212
+ - La case à cocher et le bouton radio masquaient leur contrôle natif en
213
+ `opacity:0`. Le navigateur le peignait encore sous le visuel personnalisé, et
214
+ ce dessin clignotait au clic. Les deux utilisent désormais la recette
215
+ partagée `.sia-visually-hidden`, qui le découpe hors du rendu sans le retirer
216
+ du clavier.
217
+ - Une case à cocher non contrôlée ne se peignait jamais cochée : l'`<input>`
218
+ basculait, mais la classe qui dessine la case ne suivait pas.
219
+ - Le curseur de survol des graphes était ovale, et le tracé de la courbe
220
+ haché : les marqueurs sont sortis du SVG, qui est étiré sans conserver ses
221
+ proportions.
222
+ - L'entrée `drawer` du registre était impossible à installer — elle importait
223
+ deux dossiers que la CLI ne copie pas.
224
+
225
+ ### Patch Changes
48
226
 
49
- ## Licence
227
+ - Include component styles when installing registry components
228
+
229
+ ## Licence
50
230
 
51
231
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sia-ui/cli",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Install SIA UI components progressively into an application.",
5
5
  "keywords": [
6
6
  "sia-ui",
@@ -11,19 +11,19 @@
11
11
  ],
12
12
  "license": "MIT",
13
13
  "author": "Ivan Mbella",
14
- "homepage": "https://github.com/BeatJo/sia-ui#readme",
14
+ "homepage": "https://beatjo.github.io/sia-ui-site/",
15
15
  "bugs": {
16
- "url": "https://github.com/BeatJo/sia-ui/issues"
16
+ "url": "https://github.com/BeatJo/sia-ui-site/issues"
17
17
  },
18
18
  "repository": {
19
19
  "type": "git",
20
- "url": "git+https://github.com/BeatJo/sia-ui.git",
21
- "directory": "packages/cli"
20
+ "url": "git+https://github.com/BeatJo/sia-ui-site.git"
22
21
  },
23
22
  "type": "module",
24
23
  "files": [
25
24
  "dist",
26
25
  "README.md",
26
+ "CHANGELOG.md",
27
27
  "LICENSE"
28
28
  ],
29
29
  "bin": {
@@ -39,10 +39,10 @@
39
39
  "react-dom": "^19.2.3",
40
40
  "typescript": "^5.9.3",
41
41
  "vitest": "^4.0.16",
42
- "@sia-ui/tokens": "0.3.0",
43
- "@sia-ui/react": "0.3.0",
44
- "@sia-ui/headless": "0.3.0",
45
- "@sia-ui/utils": "0.3.0"
42
+ "@sia-ui/tokens": "0.3.1",
43
+ "@sia-ui/headless": "0.3.1",
44
+ "@sia-ui/utils": "0.3.1",
45
+ "@sia-ui/react": "0.3.1"
46
46
  },
47
47
  "scripts": {
48
48
  "build": "node scripts/build.mjs",