@mostajs/wagon-ui 0.1.0 → 0.2.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
  **Auteur** : Dr Hamid MADANI <drmdh@msn.com>
4
4
 
5
+
6
+ ## 0.2.0 — 2026-10-02
7
+
8
+ - **Affichage PC, tablette, mobile** : en-tête repliable derrière un **menu hamburger** (sans script : case à
9
+ cocher + CSS, compatible avec une CSP stricte), tableaux défilants, champs pleine largeur, grille des tarifs
10
+ sur une colonne sous 760 px.
11
+ - **Documentation publique** (`pageDocumentation`, `rechercheDocumentation`) : la mise en page des sites de
12
+ référence d'API — en-tête, onglets (Guides, Recettes, Référence API…), recherche, barre latérale par sections
13
+ (repliée derrière un hamburger sur mobile), sommaire « Sur cette page », lien vers la version Markdown ; fr, en, ar.
14
+ - Essais T-WUI-10 à 12, écrits avant le code, chacun confronté à un sabotage.
5
15
  ## 0.1.0 — 2026-10-01
6
16
  Première version : les pages du wagon de mdseal (mise en page, accueil, tarifs, inscription, connexion par mot
7
17
  de passe ou par code, espace client, administration des paliers et de l'usage, pages légales, introuvable), en
package/README.md CHANGED
@@ -38,3 +38,19 @@ La logique vient des modules : comptes (`@mostajs/comptes`), abonnements et quot
38
38
  (`@mostajs/subscriptions-plan`), connexion (`@mostajs/auth-lite`, `@mostajs/auth-plug`).
39
39
 
40
40
  Voir `llms.txt` pour l'API complète.
41
+
42
+
43
+ ## Documentation publique (0.2)
44
+
45
+ ```js
46
+ const html = ui.pageDocumentation({
47
+ lang: 'fr', version: 'v1', base: 'https://acme.test',
48
+ onglets: [{ href: '/docs', libelle: 'Guides' }, { href: '/docs/api', libelle: 'Référence API' }], onglet: '/docs',
49
+ sections: [{ titre: 'Bien démarrer', pages: [{ href: '/docs', titre: 'Vue d’ensemble' }] }], actif: '/docs',
50
+ titre: 'Vue d’ensemble', sousTitre: '…', contenu: '<h2 id="a">…</h2>', sommaire: [{ id: 'a', titre: '…' }],
51
+ markdown: '/docs/index.md',
52
+ });
53
+ ```
54
+
55
+ La recherche est un formulaire GET vers `recherche` (par défaut `/docs/recherche?q=`) : l'application cherche
56
+ dans ses pages et rend `ui.rechercheDocumentation({ lang, q, resultats })` dans `pageDocumentation`.
package/llms.txt CHANGED
@@ -29,3 +29,5 @@ Rendre les écrans communs à tout SaaS, identiques d'un produit à l'autre, san
29
29
  - `legal({ html })` n'échappe pas `html` : il doit venir des textes de l'éditeur (mostajs/templates), jamais d'un formulaire.
30
30
  - Les prix sont en CENTIMES. `-1` = sans limite ; `0` = non compris.
31
31
  - Une ressource sans `parPeriode` s'affiche « libellé : n ».
32
+
33
+ - 0.2 : `pageDocumentation({ lang, onglets, onglet, sections, actif, titre, sousTitre, contenu, sommaire, markdown, version, base, recherche, q })`, `rechercheDocumentation({ lang, q, resultats })` ; menu hamburger sans script dans `page()`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mostajs/wagon-ui",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "Les pages du wagon d'un SaaS — mise en page (langues, pied légal, en-têtes pour les moteurs), accueil, tarifs, inscription, connexion (mot de passe ou code), espace client (palier, jauges, clés, factures, gestion de l'abonnement), administration (paliers, usage), pages légales — en fr, en, ar. Extraites de mdseal, sans ce qu'il vend : l'identité et les ressources mesurées viennent de la configuration. Vues pures, zéro dépendance.",
5
5
  "license": "AGPL-3.0-or-later",
6
6
  "author": "Dr Hamid MADANI <drmdh@msn.com>",
package/src/i18n/ar.js CHANGED
@@ -7,7 +7,17 @@ export const ar = {
7
7
  "apropos": "حول",
8
8
  "legal": "قانوني"
9
9
  },
10
+ "doc": {
11
+ "documentation": "التوثيق",
12
+ "rechercher": "بحث",
13
+ "surCettePage": "في هذه الصفحة",
14
+ "markdown": "عرض بصيغة Markdown",
15
+ "resultats": "نتائج البحث عن «{q}»",
16
+ "aucun": "لا توجد نتائج.",
17
+ "accueil": "الرئيسية"
18
+ },
10
19
  "layout": {
20
+ "menu": "القائمة",
11
21
  "auteur": "المؤلّف",
12
22
  "propulse": "مبنيّ على منظومة",
13
23
  "langue": "اللغة"
package/src/i18n/en.js CHANGED
@@ -7,7 +7,17 @@ export const en = {
7
7
  "apropos": "About",
8
8
  "legal": "Legal"
9
9
  },
10
+ "doc": {
11
+ "documentation": "Documentation",
12
+ "rechercher": "Search",
13
+ "surCettePage": "On this page",
14
+ "markdown": "View as Markdown",
15
+ "resultats": "Results for “{q}”",
16
+ "aucun": "No result.",
17
+ "accueil": "Home"
18
+ },
10
19
  "layout": {
20
+ "menu": "Menu",
11
21
  "auteur": "Author",
12
22
  "propulse": "built on the",
13
23
  "langue": "Language"
package/src/i18n/fr.js CHANGED
@@ -7,7 +7,17 @@ export const fr = {
7
7
  "apropos": "À propos",
8
8
  "legal": "Légal"
9
9
  },
10
+ "doc": {
11
+ "documentation": "Documentation",
12
+ "rechercher": "Rechercher",
13
+ "surCettePage": "Sur cette page",
14
+ "markdown": "Voir en Markdown",
15
+ "resultats": "Résultats pour « {q} »",
16
+ "aucun": "Aucun résultat.",
17
+ "accueil": "Accueil"
18
+ },
10
19
  "layout": {
20
+ "menu": "Menu",
11
21
  "auteur": "Auteur",
12
22
  "propulse": "propulsé par l’écosystème",
13
23
  "langue": "Langue"
package/src/index.js CHANGED
@@ -85,9 +85,49 @@ pre,code,kbd,samp{direction:ltr;text-align:left;unicode-bidi:isolate} [dir="rtl"
85
85
  .moi{margin-inline-start:auto;font-size:.9em} .moi a{color:var(--accent);text-decoration:none}
86
86
  .langues{margin-inline-start:.8em;font-size:.9em;color:var(--doux)} .langues a{color:var(--accent);text-decoration:none} .langues b{color:var(--brand)}
87
87
  .hint{color:var(--doux);font-size:.9em} footer{max-width:920px;margin:2rem auto 0;padding:1rem;border-top:1px solid var(--line);color:var(--doux);font-size:.9em}
88
- footer a{color:var(--accent)}`;
88
+ footer a{color:var(--accent)}
89
+ .menu{display:flex;align-items:center;gap:1.2rem;flex:1 1 auto;flex-wrap:wrap}
90
+ .bascule{position:absolute;opacity:0;width:1px;height:1px;pointer-events:none}
91
+ .burger{display:none;margin-inline-start:auto;font-size:1.5rem;line-height:1;cursor:pointer;padding:.2em .45em;border:1px solid var(--line);border-radius:6px;color:var(--brand);user-select:none}
92
+ .bascule:focus-visible+.burger{outline:2px solid var(--accent);outline-offset:2px}
93
+ table{display:block;max-width:100%;overflow-x:auto}
94
+ img,pre{max-width:100%} pre{overflow-x:auto}
95
+ @media (max-width: 760px){
96
+ .burger{display:block}
97
+ .menu{display:none;flex-basis:100%;flex-direction:column;align-items:stretch;gap:.4rem;padding-top:.4rem}
98
+ .bascule:checked ~ .menu{display:flex}
99
+ nav{flex-direction:column} nav a{padding:.55em .7em}
100
+ .moi,.langues{margin-inline-start:0}
101
+ header{padding:.7rem .8rem} main{padding:0 .8rem 1.5rem} h1{font-size:1.45rem}
102
+ input[type=text],input[type=email],input[type=password]{min-width:0;width:100%}
103
+ .champs label{flex:1 1 100%}
104
+ .grille-tarifs{grid-template-columns:1fr}
105
+ }`;
89
106
  }
90
107
 
108
+ /** La documentation (0.2) : la mise en page des sites de référence d'API — onglets, barre latérale, sommaire. */
109
+ const STYLE_DOC = `body{background:var(--surface)} .doc-tete{display:flex;align-items:center;gap:1rem;flex-wrap:wrap;padding:.8rem 1.2rem;background:var(--brand);color:var(--surface)}
110
+ .doc-tete .brand{color:var(--surface)} .doc-tete .doc-mot{opacity:.85} .doc-tete .version{font-size:.8em;border:1px solid currentColor;border-radius:4px;padding:0 .4em;opacity:.85}
111
+ .doc-tete .moi a,.doc-tete .langues a,.doc-tete .langues b{color:var(--surface)} .doc-tete .langues{color:var(--surface)}
112
+ .doc-barre{display:flex;align-items:center;gap:.6rem;flex-wrap:wrap;padding:.4rem 1.2rem;background:var(--brand);border-top:1px solid rgba(255,255,255,.15)}
113
+ .onglets{display:flex;gap:.3rem;flex-wrap:wrap} .onglets a{color:var(--surface);text-decoration:none;padding:.35em .8em;border-radius:6px;opacity:.9} .onglets a.on,.onglets a:hover{background:rgba(255,255,255,.16);opacity:1}
114
+ .recherche{margin-inline-start:auto} .recherche input{padding:.4em .7em;border-radius:6px;border:0;min-width:14em}
115
+ .doc{display:grid;grid-template-columns:16rem minmax(0,1fr) 14rem;max-width:1280px;margin:0 auto}
116
+ .laterale{border-inline-end:1px solid var(--line);padding:1.4rem 1rem;position:sticky;top:0;align-self:start;max-height:100vh;overflow:auto}
117
+ .laterale h3{font-size:.78rem;letter-spacing:.06em;text-transform:uppercase;color:var(--doux);margin:1.4em 0 .4em} .laterale h3:first-child{margin-top:0}
118
+ .laterale ul{list-style:none;margin:0;padding:0} .laterale a{display:block;padding:.35em .6em;border-radius:6px;color:var(--ink);text-decoration:none} .laterale a.on{background:var(--fond-doux);font-weight:600} .laterale a:hover{background:var(--survol)}
119
+ .doc-corps{padding:1.6rem 2.2rem 3rem;min-width:0} .doc-corps h1{margin:.1em 0 .2em;font-size:2.1rem} .doc-corps .lede{font-size:1.12rem;color:var(--doux);margin:.2em 0 1em}
120
+ .doc-corps hr{border:0;border-top:1px solid var(--line);margin:1.2em 0 1.6em} .doc-corps a.md{float:inline-end;font-size:.88em;border:1px solid var(--line);border-radius:6px;padding:.3em .7em;text-decoration:none;color:var(--accent)}
121
+ .sommaire{padding:1.6rem 1rem;position:sticky;top:0;align-self:start;font-size:.9em} .sommaire p{color:var(--doux);margin:0 0 .4em}
122
+ .sommaire ul{list-style:none;margin:0;padding:0;border-inline-start:2px solid var(--line)} .sommaire a{display:block;padding:.25em .8em;color:var(--doux);text-decoration:none} .sommaire a:hover{color:var(--accent)}
123
+ .doc-barre .burger{color:var(--surface);border-color:rgba(255,255,255,.4)}
124
+ @media (max-width: 1100px){ .doc{grid-template-columns:15rem minmax(0,1fr)} .sommaire{display:none} }
125
+ @media (max-width: 760px){
126
+ .doc{grid-template-columns:1fr} .laterale{display:none;position:static;max-height:none;border-inline-end:0;border-bottom:1px solid var(--line)}
127
+ .bascule:checked ~ .doc .laterale{display:block} .doc-barre .burger{display:block;margin-inline-start:0}
128
+ .recherche{flex-basis:100%} .recherche input{width:100%;min-width:0} .doc-corps{padding:1.2rem .9rem 2rem} .doc-corps h1{font-size:1.6rem}
129
+ }`;
130
+
91
131
  /** Un texte multilingue de la configuration : chaîne simple, ou { fr, en, ar }. */
92
132
  const dansLangue = (v, lang) => (v && typeof v === 'object' ? (v[lang] ?? v.fr ?? Object.values(v)[0] ?? '') : (v ?? ''));
93
133
  const remplir = (s, vars = {}) => String(s).replace(/\{(\w+)\}/g, (m, k) => (k in vars ? String(vars[k]) : m));
@@ -152,7 +192,7 @@ export function creerWagonUi({ marque, couleurs = {}, langues = ['fr', 'en', 'ar
152
192
  return `<!doctype html><html lang="${L}" dir="${dirDe(L)}"><head><meta charset="utf-8">
153
193
  <meta name="viewport" content="width=device-width, initial-scale=1"><title>${esc(titre)} — ${nom}</title>
154
194
  ${tete}<style>${STYLE}</style></head><body>
155
- <header><a class="brand" href="/">${marque.symbole ? `${esc(marque.symbole)} ` : ''}${nom}</a><nav>${nav.map(([h, l]) => `<a href="${lien(h)}"${actif === h ? ' class="on"' : ''}>${esc(l)}</a>`).join('')}</nav><span class="moi"><a href="${connecte ? '/compte' : '/connexion'}">${esc(tr(connecte ? 'espace.compte' : 'espace.seConnecter'))}</a>${connecte ? ` · <a href="/deconnexion">${esc(tr('espace.seDeconnecter'))}</a>` : ''}</span>${choixLangue}</header>
195
+ <header><a class="brand" href="/">${marque.symbole ? `${esc(marque.symbole)} ` : ''}${nom}</a><input type="checkbox" id="wagon-menu" class="bascule"><label for="wagon-menu" class="burger" aria-label="${esc(tr('layout.menu'))}">☰</label><div class="menu"><nav>${nav.map(([h, l]) => `<a href="${lien(h)}"${actif === h ? ' class="on"' : ''}>${esc(l)}</a>`).join('')}</nav><span class="moi"><a href="${connecte ? '/compte' : '/connexion'}">${esc(tr(connecte ? 'espace.compte' : 'espace.seConnecter'))}</a>${connecte ? ` · <a href="/deconnexion">${esc(tr('espace.seDeconnecter'))}</a>` : ''}</span>${choixLangue}</div></header>
156
196
  <main>${contenu}</main>
157
197
  <footer><b>${nom}</b>${slogan ? ` — ${esc(slogan)}` : ''} · ${esc(tr('layout.auteur'))} : <b>${esc(marque.auteur)}</b>${marque.courriel ? ` &lt;${esc(marque.courriel)}&gt;` : ''} · ${esc(marque.licence ?? 'AGPL-3.0')} · ${esc(tr('layout.propulse'))} <code>@mostajs/*</code><br><span class="legal">${DOCUMENTS_LEGAUX.map(([h, k]) => `<a href="/${h}">${esc(tr(`legal.${k}`))}</a>`).join(' · ')}</span></footer>
158
198
  </body></html>`;
@@ -393,6 +433,45 @@ ${anonyme ? `<h2>${esc(tr('usage.anonyme'))}</h2>
393
433
  : `<h1>${esc(tr(`legal.${cle}`))}</h1><p class="hint">${esc(tr('legal.indisponible'))}</p>`;
394
434
  },
395
435
 
436
+ /**
437
+ * 0.2 — LA DOCUMENTATION publique, page entière : en-tête, onglets (Guides, Recettes, Référence API…),
438
+ * recherche, barre latérale par sections, contenu, sommaire « Sur cette page », lien vers la version
439
+ * Markdown. `contenu` est du HTML rendu par l'application depuis SES textes (jamais d'un formulaire).
440
+ * Sans script : la barre latérale se replie derrière un hamburger sur mobile.
441
+ */
442
+ pageDocumentation({ lang, onglets = [], onglet = '', sections = [], actif = '', titre = '', sousTitre = '', contenu = '', sommaire = [], markdown = '', version = '', base = '', recherche = '/docs/recherche', q = '' }) {
443
+ const L = langueDe(lang); const tr = t(L);
444
+ const nom = esc(marque.nom);
445
+ const canonique = base && actif ? `${String(base).replace(/\/$/, '')}${actif}` : '';
446
+ const chemin = lien(actif || '/');
447
+ const choixLangue = LANGUES.length < 2 ? '' : `<span class="langues">${LANGUES.map((l) => (l === L ? `<b lang="${l}">${esc(LIBELLES_LANGUES[l])}</b>` : `<a href="${chemin}?lang=${l}" hreflang="${l}" lang="${l}" rel="alternate">${esc(LIBELLES_LANGUES[l])}</a>`)).join(' · ')}</span>`;
448
+ const lienPage = (p) => (p.externe
449
+ ? `<a href="${lien(p.href)}" rel="noopener" target="_blank">${esc(p.titre)} ↗</a>`
450
+ : `<a href="${lien(p.href)}"${p.href === actif ? ' class="on" aria-current="page"' : ''}>${esc(p.titre)}</a>`);
451
+ return `<!doctype html><html lang="${L}" dir="${dirDe(L)}"><head><meta charset="utf-8">
452
+ <meta name="viewport" content="width=device-width, initial-scale=1"><title>${esc(titre)} — ${esc(tr('doc.documentation'))} ${nom}</title>
453
+ ${canonique ? `<link rel="canonical" href="${esc(canonique)}">${sousTitre ? `<meta name="description" content="${esc(sousTitre)}">` : ''}` : ''}<style>${STYLE}${STYLE_DOC}</style></head><body>
454
+ <header class="doc-tete"><a class="brand" href="/">${marque.symbole ? `${esc(marque.symbole)} ` : ''}${nom}</a><span class="doc-mot">${esc(tr('doc.documentation'))}</span>${version ? `<span class="version">${esc(version)}</span>` : ''}<span class="moi"><a href="/">${esc(tr('doc.accueil'))}</a></span>${choixLangue}</header>
455
+ <input type="checkbox" id="doc-menu" class="bascule">
456
+ <div class="doc-barre"><label for="doc-menu" class="burger" aria-label="${esc(tr('layout.menu'))}">☰</label><nav class="onglets">${onglets.map((o) => `<a href="${lien(o.href)}"${o.href === onglet ? ' class="on"' : ''}>${esc(dansLangue(o.libelle, L))}</a>`).join('')}</nav><form class="recherche" method="get" action="${lien(recherche)}"><input type="search" name="q" value="${esc(q)}" placeholder="${esc(tr('doc.rechercher'))}" aria-label="${esc(tr('doc.rechercher'))}"></form></div>
457
+ <div class="doc">
458
+ <aside class="laterale">${sections.map((x) => `<h3>${esc(dansLangue(x.titre, L))}</h3><ul>${(x.pages ?? []).map((p) => `<li>${lienPage({ ...p, titre: dansLangue(p.titre, L) })}</li>`).join('')}</ul>`).join('')}</aside>
459
+ <main class="doc-corps">${markdown ? `<a class="md" href="${lien(markdown)}">${esc(tr('doc.markdown'))}</a>` : ''}<h1>${esc(titre)}</h1>${sousTitre ? `<p class="lede">${esc(sousTitre)}</p>` : ''}<hr>
460
+ ${contenu}</main>
461
+ <aside class="sommaire">${sommaire.length ? `<p>${esc(tr('doc.surCettePage'))}</p><ul>${sommaire.map((x) => `<li><a href="#${esc(String(x.id).replace(/[^A-Za-z0-9_-]/g, ''))}">${esc(x.titre)}</a></li>`).join('')}</ul>` : ''}</aside>
462
+ </div>
463
+ <footer><b>${nom}</b> · ${esc(tr('layout.auteur'))} : <b>${esc(marque.auteur)}</b> · ${esc(marque.licence ?? 'AGPL-3.0')}<br><span class="legal">${DOCUMENTS_LEGAUX.map(([h, k]) => `<a href="/${h}">${esc(tr(`legal.${k}`))}</a>`).join(' · ')}</span></footer>
464
+ </body></html>`;
465
+ },
466
+
467
+ /** Les résultats d'une recherche dans la documentation (le contenu de `pageDocumentation`). */
468
+ rechercheDocumentation({ lang, q = '', resultats = [] }) {
469
+ const tr = t(langueDe(lang));
470
+ return `<p class="lede">${esc(tr('doc.resultats', { q }))}</p>${resultats.length
471
+ ? `<ul class="resultats">${resultats.map((r) => `<li><a href="${lien(r.href)}">${esc(r.titre)}</a>${r.extrait ? `<br><span class="hint">${esc(r.extrait)}</span>` : ''}</li>`).join('')}</ul>`
472
+ : `<p>${esc(tr('doc.aucun'))}</p>`}`;
473
+ },
474
+
396
475
  introuvable({ lang }) {
397
476
  const tr = t(langueDe(lang));
398
477
  return `<h1>${esc(tr('erreur.introuvable'))}</h1><p>${esc(tr('erreur.introuvableTexte'))}</p><p><a href="/">${esc(tr('erreur.retour'))}</a></p>`;