@ofidj/generator-fidj 3.10.2 → 3.13.0

package/README.md

@@ -51,19 +51,35 @@ one.
 - `--logo <image>` and `--favicon <image>`: the app's own marks, copied into `public/brand/`. The logo sits beside the app name at the top of the sign-in panel; the favicon goes in the browser tab. Both fall back to the Fidj mark, so neither is ever blank. Accepts `.png`, `.svg`, `.gif`, `.jpg`, `.webp` or `.ico` under 512KB — an animated GIF works as a logo, and as a favicon in the browsers that animate one.
 - `--api-endpoint`: select the API (default: hosted sandbox).
 - `--sdk-path` or `FIDJ_SDK_DIR`: use a built local SDK during coordinated development.
+- `--entry-path` or `FIDJ_ENTRY_DIR`: same, for a built local `@ofidj/entry` — the sign-in and account screens, the agreement and the design system. Point it at that package's `dist`, as with the SDK.
 - `--local` or `FIDJ_LOCAL=true`: use the loopback API/console. Test credentials stay in the validation guide, outside the content app UI. Supply the matching local app ID; `FIDJ_APP_ID` can override it.
 - `--replace`: regenerate only a destination containing `.fidj-generated`; unmarked projects are protected.
 
-The generated shell paints from one design system: `src/tokens.css` holds every
-colour, family and radius, and `src/style.css` may not introduce a literal of
-its own. Fonts are self-hosted under `public/fonts` and served from the build
-manifest, so a generated site stays statically hostable and makes no
-third-party request on sign-in. fidj-app consumes the same tokens, which is why
-a style change lands here first.
+**The entry is a dependency, not a copy.** `@ofidj/entry` carries the sign-in
+and account screens, the service agreement, the provider window, the version
+badge and the design system; the generated app imports them the way it imports
+the SDK. They used to be files in this template, which meant the only way to
+ship a fix was to regenerate every app — and meant Fidj's own console had to be
+generated to reach them. A style change now lands in that package, and this
+template is what remains genuinely the generator's: the shells that hold the
+screens, the content app and the Notes app.
+
+This is an architecture boundary, not only a packaging detail: never copy a
+credential, signup, recovery or agreement component into a generated output.
+The template may compose a shell and call `@ofidj/entry` after dynamic rendering,
+but the markup rules and browser behavior such as password reveal belong in
+`fidj-entry`. A fix there must reach Fidj, mleweb and newly generated apps
+without maintaining parallel component implementations.
+
+The design system is `@ofidj/entry`'s `tokens.css` — every colour, family and
+radius — and its `style.css`, which may not introduce a literal of its own.
+Fonts are self-hosted under `public/fonts` and served from the build manifest,
+so a generated site stays statically hostable and makes no third-party request
+on sign-in.
 
 Generation writes `.env.example`, `.env` and public `app.config.json`. Static configuration is embedded at build time: regenerate/rebuild when changing endpoints. Notes server configuration is read at runtime. Do not place secrets in any public configuration or content input.
 
-For unpublished coordinated changes, build the sibling SDK and pass `--sdk-path` with its absolute `dist` path. Committed templates use registry dependency `@ofidj/node ^3.7.3`; a registry-only install is not validated until coordinated versions are published.
+For unpublished coordinated changes, build the sibling SDK and entry packages and pass `--sdk-path` and `--entry-path` with their absolute `dist` paths. Committed templates name registry ranges for both; a registry-only install is not validated until coordinated versions are published.
 
 Every generated app carries a fixed bottom-right badge naming the Fidj it runs:
 `fidj@<version>`, taken from the SDK it was generated with — the `--sdk-path`
@@ -106,10 +122,11 @@ The generated content app opens on `/#/signin`. Sign in, or choose **Enter anony
 is the one control on the screen wearing `--fidj-accent`, because it is the one
 that belongs to Fidj rather than to the app — and it is the path where the app
 never sees a password. An app generated with `--signin both` keeps its own
-email-and-password form under an *Inline form* disclosure, with its service
-agreement: opening it folds the Fidj door away, because the two are alternatives
-rather than a list. That agreement gates the app's own door and nothing else, so
-an agreement that fails to load never shuts the Fidj door.
+email-and-password form under an *Inline form* disclosure: opening it folds the
+Fidj door away, because the two are alternatives rather than a list. Whichever
+door is taken runs the same two screens — credentials, with the verification
+wait appearing beneath them on the create path, and then the agreement — so the
+button is a shortcut to the flow, not a different one.
 
 Pressing it opens Fidj in a browser window of its own rather than navigating
 away. Fidj's screens are served from another origin and refuse to be framed, so
@@ -161,11 +178,26 @@ A compatible issuer, REST API and registered callback without a fragment are pre
 
 ## Required service agreement
 
-All generated sign-in and account-creation forms (content, composed Fidj and
-Notes) share an unchecked required agreement checkbox. Both submit buttons stay
-disabled until it is checked. Reading the agreement opens an in-app dialog;
-failed agreement loading keeps sign-in blocked. Anonymous entry, when enabled,
-is not a login and does not record agreement acceptance.
+[The workspace README](../README.md#entry-one-flow-the-same-everywhere) defines
+the flow every Fidj sign-in surface follows, and this generator owns the
+implementation the others render. In short: the first screen asks for an email,
+a password, **Sign in** and **Create an account**, and gates neither; creating an
+account grows a verification wait beneath that same form rather than replacing
+it; and the agreement is its own screen, shown whenever the version recorded for
+this person and this app is not the current one, with its submit button
+read-only until the box is ticked.
+
+The agreement screen's markup, its loading and its disabled-button rule live in
+`@ofidj/entry` — one implementation for the app's own form, the composed Fidj
+console and the Fidj-hosted consent page of the beta OIDC provider — so an owner
+who publishes a new version changes one thing and every surface asks again.
+Anonymous entry, when enabled, is not a login and records no acceptance.
+
+Both generated entries render this. The content app and the Notes starter lost
+their checkbox beside the credentials and their local gate; each calls `login`,
+and the API's `409 agreement_required` is what puts the agreement screen on
+screen, carrying the version it compared against. `--signin button` delegates
+the whole question to Fidj and never had one.
 
 The text and version come from the app's public API metadata, not copied generator
 settings. The API records acceptance before issuing the app token, preserves

package/bin/create-fidj.cjs

@@ -9,6 +9,7 @@ try {
       "api-endpoint": { type: "string" },
       "oidc-issuer": { type: "string" },
       "sdk-path": { type: "string" },
+      "entry-path": { type: "string" },
       title: { type: "string" },
       welcome: { type: "string" },
       description: { type: "string" },
@@ -39,6 +40,7 @@ try {
       apiEndpoint: values["api-endpoint"],
       oidcIssuer: values["oidc-issuer"],
       sdkPath: values["sdk-path"] || process.env.FIDJ_SDK_DIR,
+      entryPath: values["entry-path"] || process.env.FIDJ_ENTRY_DIR,
       title: values.title,
       welcome: values.welcome,
       description: values.description,

package/generators/app/index.js

@@ -9,6 +9,7 @@ const TEXT_OPTIONS = [
   "api-endpoint",
   "oidc-issuer",
   "sdk-path",
+  "entry-path",
   "title",
   "welcome",
   "description",
@@ -99,6 +100,7 @@ module.exports = class extends Generator {
       moduleEntry: this.options["module-entry"],
       domain: this.options.domain,
       sdkPath: this.options["sdk-path"] || process.env.FIDJ_SDK_DIR,
+      entryPath: this.options["entry-path"] || process.env.FIDJ_ENTRY_DIR,
       oidcIssuer: this.options["oidc-issuer"],
       local: this.options.local || process.env.FIDJ_LOCAL === "true",
       replace: this.options.replace,

package/generators/app/templates/typescript/package.json

@@ -15,7 +15,8 @@
     "privacy:rehearse": "npm run build && node --test test/server.test.mjs"
   },
   "dependencies": {
-    "@ofidj/node": "^3.10.0"
+    "@ofidj/entry": "^3.13.0",
+    "@ofidj/node": "^3.13.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",

package/generators/app/templates/typescript/server/index.ts

@@ -342,7 +342,8 @@ if (require.main === module) {
     localDemo:
       process.env.LOCAL_DEMO === "true" &&
       host === "127.0.0.1" &&
-      ["localhost", "127.0.0.1"].includes(api.hostname),
+      (["localhost", "127.0.0.1"].includes(api.hostname) ||
+        api.hostname.endsWith(".localhost")),
   };
   createApp(settings, {
     dataDir: process.env.FIDJ_DATA_DIR,