@sia-ui/api 0.1.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Ivan Mbella
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
+ # @sia-ui/api
2
+
3
+ Un client HTTP typé, ses services CRUD et ses greffons. Aucun rapport avec
4
+ l'interface : ni React, ni DOM, ni tokens.
5
+
6
+ ```bash
7
+ pnpm add @sia-ui/api
8
+ ```
9
+
10
+ Il est utilisable seul : rien n'oblige à prendre les composants pour avoir
11
+ le client, ni l'inverse.
12
+
13
+ ## Le transport est injecté, jamais importé
14
+
15
+ ```ts
16
+ import { createApiClient, createAuthPlugin } from "@sia-ui/api";
17
+
18
+ const api = createApiClient({
19
+ baseURL: "/api",
20
+ plugins: [createAuthPlugin({ getToken: () => tokens.access })],
21
+ });
22
+
23
+ const { items, meta } = await api.getPaginated<Client>("/clients", { page: 1 });
24
+ ```
25
+
26
+ `createFetchTransport()` par défaut, `createAxiosTransport(axios.create())` si
27
+ le projet utilise déjà axios. Le paquet ne dépend d'aucun des deux.
28
+
29
+ ## Ce qu'il contient
30
+
31
+ | | |
32
+ | --- | --- |
33
+ | `ApiClient` | requêtes, pagination, curseur, `head`, `getList` |
34
+ | `BaseService` | le CRUD d'une ressource, `removeMany`, `search` |
35
+ | `HttpError` | statut, corps, et `fields` — trois formes d'erreurs par champ |
36
+ | Greffons | auth, rafraîchissement de jeton, 401, journal, idempotence, lecture seule, signal d'en-tête |
37
+ | `TokenStorage` | mémoire ou navigateur, chaque accès protégé |
38
+ | Filtres | `$and` / `$or` portés par un en-tête plutôt que par l'URL |
39
+
40
+ Voir [docs/28-API-MODULE.md](../../docs/28-API-MODULE.md).