@indos/bibliotheque 2.2.0 → 2.3.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/CHANGELOG.md CHANGED
@@ -2,6 +2,16 @@
2
2
 
3
3
  Écrit pour le développeur d'une app du client, qui monte la version de la bibliothèque dans son dépôt : une section par version publiée sur npm. Une version qui demande un geste dans l'app a sa rubrique « Ruptures » : le geste, les versions exactes de React, Vite et TanStack à reprendre, et le core que demande la majeure.
4
4
 
5
+ ## 2.3.0
6
+
7
+ Le serveur de développement relaie à l'app tout ce qui n'est pas à lui.
8
+
9
+ - `npm run dev` garde ce qui est à lui sous la base de l'app : les modules de Vite, les fichiers de `espace/`, le websocket du rechargement à chaud, et le `GET` d'un écran du manifeste, dont il sert la page à chaud (`<base><écran>` et ce qui est dessous, `<base>reglages`, et, pour une app à choses, l'écran d'une chose et la chose seule). Il relaie tout le reste à l'app lancée en local (`INDOS_APP`), quelle qu'en soit la méthode, websockets compris, sans le chemin de l'app, avec son origine et son hôte : un fichier que sert l'app, comme un PDF, une page qu'elle rend elle-même, le direct, s'ouvrent depuis la page servie à chaud.
10
+ - Pour une app qui n'a que des réglages, sans écran, la racine du serveur de développement (`http://localhost:5173/<nom>/`, et le retour après la connexion) mène à `/<nom>/reglages`.
11
+ - Le README du modèle d'une app (`modeles/app-du-client/README.md`) relie l'aperçu local, `npm run dev`, à l'espace où l'app est installée, au domaine de son serveur : une app pas encore installée y est fermée, et ses outils répondent 403. Il dit aussi ce que le serveur de développement sert à chaud et ce qu'il relaie à l'app.
12
+
13
+ Pour monter : `"@indos/bibliotheque": "2.3.0"` dans ses `dependencies`, puis `npm install` et `npm test`. Les versions de React, Vite et TanStack et le core demandé ne changent pas.
14
+
5
15
  ## 2.2.0
6
16
 
7
17
  Le modèle d'une app dans le paquet, ses tests dans sa construction.
@@ -35,8 +35,8 @@ Dans le dossier de l'app :
35
35
  - `docker build .` : l'image, ses tests compris ; le journal dit le test qui échoue.
36
36
  - `npm run build` : construire la page dans `dist/`.
37
37
  - `ADRESSE=http://localhost:3000/<nom> DATABASE_URL=postgres://… npm start` : lancer l'app sur le port 3000, la page construite, avec une Postgres locale.
38
- - `npm run dev` : la page à chaud sur `http://localhost:5173/<nom>/entrees`, dans Chrome ou Firefox, reliée au core de `INDOS_CORE` et à l'app lancée en local dans un autre terminal :
39
- - relié au banc d'essai : l'app lancée avec `ADRESSE=http://localhost:5173/<nom> CORE_ADRESSE=https://essai-sources.indos.ch`, puis `INDOS_CORE=https://essai-sources.indos.ch npm run dev` ;
38
+ - `npm run dev` : la page à chaud sur `http://localhost:5173/<nom>/entrees`, dans Chrome ou Firefox, reliée au core de `INDOS_CORE` et à l'app lancée en local dans un autre terminal. Les écrans du manifeste et leurs modules sont servis à chaud ; tout le reste sous `/<nom>/`, quelle qu'en soit la méthode, va à l'app : ses outils, un fichier qu'elle sert, un websocket :
39
+ - relié à l'espace où l'app est installée, au domaine du serveur (le `domaine` du `serveur.json` du dépôt du serveur) : l'app lancée avec `ADRESSE=http://localhost:5173/<nom> CORE_ADRESSE=https://<domaine>`, puis `INDOS_CORE=https://<domaine> npm run dev`. Une app pas encore installée y est fermée : ses outils répondent 403 ;
40
40
  - relié à un core local, dont l'`ADRESSE` est en `http://localhost:<port>` et où l'app est déclarée avec le lien `http://localhost:5173/<nom>` : la même chose avec `http://localhost:<port>`.
41
41
 
42
42
  ## Ce que le kit attend
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@indos/bibliotheque",
3
- "version": "2.2.0",
3
+ "version": "2.3.0",
4
4
  "description": "La bibliothèque des apps d'Indos : le serveur, le MCP, la base et la page de l'espace d'une app.",
5
5
  "license": "MIT",
6
6
  "type": "module",
package/src/vite.d.ts CHANGED
@@ -1,4 +1,5 @@
1
- import { type ProxyOptions } from 'vite';
1
+ import type { IncomingMessage } from 'node:http';
2
+ import { type InlineConfig, type ProxyOptions } from 'vite';
2
3
  export declare const portDeDeveloppement = 5173;
3
4
  export declare function lirePiece(dossier: string): {
4
5
  nom: string;
@@ -7,11 +8,17 @@ export declare function lirePiece(dossier: string): {
7
8
  };
8
9
  export declare function scriptsEnLigne(html: string): string[];
9
10
  export declare function construireLaPage(dossier: string): Promise<void>;
11
+ export declare function cheminsGardes(dossier: string): (requete: IncomingMessage) => boolean;
10
12
  export declare function relais(options: {
11
13
  base: string;
12
14
  core: string;
13
15
  app: string;
16
+ garde: (requete: IncomingMessage) => boolean;
14
17
  }): Record<string, ProxyOptions>;
18
+ export declare function configurationDuDeveloppement(dossier: string, options: {
19
+ core: string;
20
+ app: string;
21
+ }): InlineConfig;
15
22
  export declare function developperLaPage(dossier: string, options: {
16
23
  core: string;
17
24
  app: string;
package/src/vite.js CHANGED
@@ -1,10 +1,11 @@
1
1
  import tailwindcss from '@tailwindcss/vite';
2
2
  import react from '@vitejs/plugin-react';
3
- import { existsSync, readFileSync } from 'node:fs';
4
- import { join } from 'node:path';
3
+ import { existsSync, readFileSync, statSync } from 'node:fs';
4
+ import { join, resolve, sep } from 'node:path';
5
5
  import { fileURLToPath } from 'node:url';
6
6
  import { build, createServer } from 'vite';
7
7
  import { startVitest } from 'vitest/node';
8
+ import { estUnEcranDesChoses } from './page.js';
8
9
  // La configuration Vite de la page de l'espace d'une pièce (bibliotheque/CLAUDE.md, « Écrire une
9
10
  // page ») : le dossier de la pièce a son `module.json` et sa page dans `espace/` (`espace/index.html`,
10
11
  // qui lance `espace/page.tsx`). `construireLaPage` écrit le dossier construit, `dist/` ;
@@ -29,12 +30,14 @@ const dependancesDuNavigateur = /^(react|react-dom|@tanstack\/react-router|@tans
29
30
  // Le port du serveur de développement.
30
31
  export const portDeDeveloppement = 5173;
31
32
  // Ce que le `module.json` de la pièce dit de sa page : son nom, sa base (`/` pour le core,
32
- // `/<app>/` pour une app) et son premier écran, où mène la racine en développement.
33
+ // `/<app>/` pour une app) et son premier écran, où mène la racine en développement : le premier de
34
+ // ses écrans, sinon ses réglages, comme la racine de l'app (`creerLaRacine`).
33
35
  export function lirePiece(dossier) {
34
36
  const manifeste = JSON.parse(readFileSync(join(dossier, 'module.json'), 'utf8'));
35
37
  const base = manifeste.nom === 'core' ? '/' : `/${manifeste.nom}/`;
36
38
  const [premier] = manifeste.ecrans ?? [];
37
- return { nom: manifeste.nom, base, premierEcran: premier ? `${base}${premier.nom}` : base };
39
+ const premierEcran = premier ? `${base}${premier.nom}` : manifeste.reglages ? `${base}reglages` : base;
40
+ return { nom: manifeste.nom, base, premierEcran };
38
41
  }
39
42
  // Les règles de la page, communes au build et au développement :
40
43
  // - les dépendances du navigateur se résolvent depuis la bibliothèque ;
@@ -93,13 +96,57 @@ function configuration(dossier, base) {
93
96
  export async function construireLaPage(dossier) {
94
97
  await build({ ...configuration(dossier, lirePiece(dossier).base), mode: 'production' });
95
98
  }
99
+ // Les chemins sous la base d'une app que le serveur de développement garde, sans les relayer à
100
+ // l'app : les siens, d'où Vite sert la page et ses modules (`@vite/client`, `@react-refresh`,
101
+ // `@fs/…`, `@id/…`, et chaque fichier du dossier `espace/`, comme `<base>page.tsx`) ; le websocket du
102
+ // rechargement à chaud (son protocole, `vite-hmr` ou `vite-ping`) ; et le `GET` d'un écran du
103
+ // manifeste, dont il sert la page : `<base><écran>` et ce qui est dessous, `<base>reglages` pour une
104
+ // app qui a des réglages, et, pour une app à choses (son écran `liste`), l'écran d'une chose et la
105
+ // chose seule (`estUnEcranDesChoses`). La fonction rendue le dit d'une requête.
106
+ export function cheminsGardes(dossier) {
107
+ const page = join(dossier, 'espace');
108
+ const { base } = lirePiece(dossier);
109
+ const manifeste = JSON.parse(readFileSync(join(dossier, 'module.json'), 'utf8'));
110
+ const ecrans = (manifeste.ecrans ?? []).map(({ nom }) => nom);
111
+ if (manifeste.reglages) {
112
+ ecrans.push('reglages');
113
+ }
114
+ const aChoses = ecrans.includes('liste');
115
+ function fichierDeLaPage(dansLaBase) {
116
+ try {
117
+ const fichier = resolve(page, decodeURIComponent(dansLaBase));
118
+ return fichier.startsWith(`${page}${sep}`) && statSync(fichier).isFile();
119
+ }
120
+ catch {
121
+ return false;
122
+ }
123
+ }
124
+ return function garde(requete) {
125
+ const chemin = new URL(requete.url ?? '/', 'http://localhost').pathname;
126
+ if (!chemin.startsWith(base)) {
127
+ return false;
128
+ }
129
+ const dansLaBase = chemin.slice(base.length);
130
+ if (dansLaBase.startsWith('@') || fichierDeLaPage(dansLaBase)) {
131
+ return true;
132
+ }
133
+ if (requete.headers.upgrade) {
134
+ return ['vite-hmr', 'vite-ping'].includes(requete.headers['sec-websocket-protocol'] ?? '');
135
+ }
136
+ if (requete.method !== 'GET' && requete.method !== 'HEAD') {
137
+ return false;
138
+ }
139
+ return ecrans.some((ecran) => dansLaBase === ecran || dansLaBase.startsWith(`${ecran}/`)) || (aChoses && estUnEcranDesChoses(`/${dansLaBase}`));
140
+ };
141
+ }
96
142
  // Les relais du serveur de développement. Vers le core : la connexion et l'auth, la session, le
97
143
  // thème et les gestes du core (sous `/espace/`), en lui présentant son origine et son hôte, ses
98
144
  // cookies posés pour le serveur de développement, et ses renvois vers lui-même ramenés au serveur
99
145
  // de développement. `/theme/variables.css` cite les polices à l'adresse publique du core : le relais
100
146
  // la ramène au serveur de développement, d'où la page charge les polices, de sa propre origine. Vers
101
- // l'app lancée en local (une app, pas le core) : ce qu'une page lui envoie sous sa base (ses outils,
102
- // ses gestes), sans le chemin de l'app, comme le proxy du serveur.
147
+ // l'app lancée en local (une app, pas le core) : tout ce qui est sous sa base et que `garde` ne
148
+ // garde pas, quelle qu'en soit la méthode, websockets compris, sans le chemin de l'app, comme le
149
+ // proxy du serveur, avec l'origine et l'hôte du serveur de développement.
103
150
  export function relais(options) {
104
151
  const origineDuCore = new URL(options.core).origin;
105
152
  const versLeCore = {
@@ -145,17 +192,17 @@ export function relais(options) {
145
192
  if (options.base !== '/') {
146
193
  relais[`^${options.base}`] = {
147
194
  target: new URL(options.app).origin,
148
- // La page elle-même et ses modules restent au serveur de développement.
149
- bypass: (requete) => (requete.method === 'POST' ? undefined : requete.url),
195
+ ws: true,
196
+ bypass: (requete) => (options.garde(requete) ? requete.url : undefined),
150
197
  rewrite: (chemin) => chemin.slice(options.base.length - 1),
151
198
  };
152
199
  }
153
200
  return relais;
154
201
  }
155
- // Sert la page de la pièce à chaud sur `http://localhost:5173`, reliée au core de `core` (le banc
156
- // d'essai ou un core local) et, pour une app, à l'app lancée en local à `app`. Après la connexion,
157
- // le core ramène à `/` : pour une app, la racine mène à son premier écran.
158
- export async function developperLaPage(dossier, options) {
202
+ // La configuration du serveur de développement de la pièce, sur `http://localhost:5173`, reliée au
203
+ // core de `core` (le banc d'essai ou un core local) et, pour une app, à l'app lancée en local à
204
+ // `app`. Après la connexion, le core ramène à `/` : pour une app, la racine mène à son premier écran.
205
+ export function configurationDuDeveloppement(dossier, options) {
159
206
  const piece = lirePiece(dossier);
160
207
  const racine = {
161
208
  name: 'indos:racine-en-developpement',
@@ -172,12 +219,16 @@ export async function developperLaPage(dossier, options) {
172
219
  },
173
220
  };
174
221
  const config = configuration(dossier, piece.base);
175
- const serveur = await createServer({
222
+ return {
176
223
  ...config,
177
224
  mode: 'development',
178
225
  plugins: [...(config.plugins ?? []), racine],
179
- server: { ...config.server, port: portDeDeveloppement, strictPort: true, proxy: relais({ base: piece.base, core: options.core, app: options.app }) },
180
- });
226
+ server: { ...config.server, port: portDeDeveloppement, strictPort: true, proxy: relais({ base: piece.base, core: options.core, app: options.app, garde: cheminsGardes(dossier) }) },
227
+ };
228
+ }
229
+ // Sert la page de la pièce à chaud sur `http://localhost:5173` (`configurationDuDeveloppement`).
230
+ export async function developperLaPage(dossier, options) {
231
+ const serveur = await createServer(configurationDuDeveloppement(dossier, options));
181
232
  await serveur.listen();
182
233
  serveur.printUrls();
183
234
  return serveur;