@escape-game-over/atlas 0.1.18 → 0.1.20

package/docs/client-scripts.md

@@ -54,6 +54,13 @@ from the package root is the same question at build time: false, and the banner
 never reaches the HTML. Gate the render on that and keep the runtime check for
 the banner that is rendered. See NOT-BUILT.md on where the halves divide.
 
+**A script imports one path: `@escape-game-over/atlas/client`**, which re-exports
+every module above. It is browser-only — `element.ts` evaluates
+`class AtlasElement extends HTMLElement` as it loads, which throws in Node — so
+frontmatter and `astro.config.ts` cannot use it. A component's contract is the
+one thing both halves need, and it stays on `./astro/markup`, which touches
+nothing.
+
 ## Lifetimes are the recurring bug
 
 Every module here that binds a listener hands back the undo, and the undo is
@@ -408,9 +415,24 @@ const input = search.require<HTMLInputElement>(this).element;
   a list that quietly loses a row is the failure this exists to prevent.
 
 The kinds are data, not builders, for the reason `filters` gives:
-`text`, `number`, `list`, `choice` and `flag`, the first four optionally
-`optional`. A `flag` is off by being absent, never `"false"`, so a stylesheet can
-select it with a bare attribute.
+`text`, `number`, `list`, `template`, `choice` and `flag`, all but `flag`
+optionally `optional`. A `flag` is off by being absent, never `"false"`, so a
+stylesheet can select it with a bare attribute.
+
+A `template` is the one that keeps a sentence out of the script. It is written
+as the translated string with its placeholders left in, and read back as the
+function that fills them:
+
+```astro
+<p {...faq.line.attrs({ sentence: t("faq.matched", { count: "{count}" }) })}></p>
+```
+
+```ts
+line.element.textContent = line.values.sentence({ count: String(hits.size) });
+```
+
+So no script spells `"{count}"`, and a sentence that never says one of its own
+placeholders fails the build rather than shipping a brace to a reader.
 
 `write` sets fields back onto an element, for state a stylesheet reads — a
 dropdown that is blocked — so the script uses the names the template did.
@@ -470,6 +492,14 @@ faq.define(Faq);
   before they are read, so a broken nested copy cannot fail the outer lookup.
 - **The tag is written once.** `faq.tag` is what the template renders and
   `faq.define` registers the class under it.
+- **The names are checked in the editor.** A tag without a hyphen, or a role
+  that is not camelCase, is a compile error where it is written — the rules are
+  types, character by character, as in `i18n/placeholders.ts`. Nothing is
+  validated at run time, because a name that reached the browser malformed would
+  already have been refused there: by `setAttribute`, by `querySelectorAll`, or
+  by `customElements.define`.
+- **Most roles carry nothing**, and say so: `search: marker` rather than
+  `search: {}`, which reads like options somebody forgot to fill in.
 
 `tag` and `define` are the component's own keys, so no role may take them. A role
 that lives outside every instance, such as a footer button that reopens a

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@escape-game-over/atlas",
-    "version": "0.1.18",
+    "version": "0.1.20",
     "type": "module",
     "description": "Typed, data-driven machinery for static multi-locale, multi-deployment Astro sites.",
     "private": false,
@@ -17,6 +17,7 @@
         "./astro/images": "./src/astro/images.ts",
         "./astro/background-video": "./src/astro/background-video.ts",
         "./astro/carousel": "./src/astro/carousel.ts",
+        "./client": "./src/astro/client.ts",
         "./astro/consent": "./src/astro/consent.ts",
         "./astro/dev-log": "./src/astro/dev-log.ts",
         "./astro/dom": "./src/astro/dom.ts",

package/src/astro/client.ts

@@ -0,0 +1,23 @@
+/**
+ * Everything a client script needs, from one import.
+ *
+ * ```ts
+ * import { AtlasElement, filters, searchBox } from "@escape-game-over/atlas/client";
+ * ```
+ *
+ * **Browser only.** `element.ts` evaluates `class AtlasElement extends
+ * HTMLElement` as this module loads, which throws in Node — so frontmatter and
+ * `astro.config.ts` must not import it. A component's contract is the one thing
+ * both halves need, and it stays on `astro/markup`, which touches nothing.
+ */
+
+export * from "./background-video.ts";
+export * from "./carousel.ts";
+export * from "./consent.ts";
+export * from "./dev-log.ts";
+export * from "./dom.ts";
+export * from "./element.ts";
+export * from "./filters.ts";
+export * from "./filters-view.ts";
+export * from "./markup.ts";
+export * from "./youtube.ts";

package/src/astro/dom.ts

@@ -1,40 +1,20 @@
 /**
- * Scoped element lookups, without the ceremony.
- *
- * `querySelector` returns `Element`, so anything that wants to set `hidden`,
- * read `dataset` or call `focus` has to say `<HTMLElement>` at every call — long
- * enough that the line wraps, on lookups that are otherwise trivial. And
- * `querySelectorAll` returns a `NodeList`, which needs spreading before it will
- * `map` or `entries`. Both are noise, and both hide the one thing worth reading:
- * what is being looked for.
+ * Scoped element lookups, typed.
  *
  * ```ts
  * const { one, all } = within(root);
- * const track = one("[data-carousel-track]");
  * const dots = all<HTMLButtonElement>("[data-carousel-dot]");
  * ```
  *
- * The root is bound once, which is the point: a client script that looks
- * everything up inside the element it was given cannot reach a second copy of
- * itself elsewhere on the page. `document` is a valid root, and should appear
- * exactly once per script — to find the roots.
+ * The root is bound once, so a script cannot reach a second copy of itself
+ * elsewhere on the page. `document` belongs in one place per script: finding
+ * the roots.
  *
  * **A selector with a combinator still matches against the whole document.**
- * `within(form).one("form p")` can match a `<p>` whose ancestor `<form>` is not
- * the one bound here; only the final filter is scoped. Simple selectors — an
- * attribute, a class — are unaffected, which is what these are for. Use
- * `:scope` if a combinator is ever genuinely needed.
+ * `within(form).one("form p")` can match a `<p>` under a different form; only
+ * the final filter is scoped. Use `:scope` if a combinator is needed.
  */
 
-/**
- * Constrained to `Element` but defaulting to `HTMLElement`.
- *
- * The default is what almost every lookup wants — `hidden`, `dataset` and
- * `focus` all live on `HTMLElement`, and having to name it at each call is the
- * noise this exists to remove. The wider constraint is for the rest: inline
- * `<svg>` and `<use>` are `SVGElement`, which is an `Element` and not an
- * `HTMLElement`, so a narrower bound would refuse a perfectly ordinary lookup.
- */
 export interface Within {
     /** The first match inside the root, or `null`. */
     one<T extends Element = HTMLElement>(selector: string): T | null;
@@ -42,6 +22,8 @@ export interface Within {
     all<T extends Element = HTMLElement>(selector: string): T[];
 }
 
+// `HTMLElement` by default because `hidden`, `dataset` and `focus` live there;
+// the bound stays `Element` so inline `<svg>` lookups are not refused.
 export function within(root: ParentNode): Within {
     return {
         one: <T extends Element = HTMLElement>(selector: string) =>

package/src/astro/element.ts

@@ -1,20 +1,13 @@
 import { reportDevError } from "./dev-log.ts";
-import { within } from "./dom.ts";
 
 /**
- * A base for custom elements, holding the parts every one of them gets wrong.
- *
- * In `astro/` because it touches the DOM, which the core is type-checked
- * without — this, `consent.ts`, `carousel.ts` and `dom.ts` are the folder
- * allowed it.
+ * A base for custom elements: two lifetimes, and one abort signal.
  *
  * ```ts
  * class Thing extends AtlasElement {
- *     #count = 0;
- *
- *     protected setup(): void { … }        // once, ever
- *     protected connect(): void {          // every time it enters the document
- *         this.require("form").addEventListener("submit", this.#send, {
+ *     protected setup(): void { … }        // once, ever: what the element is
+ *     protected connect(): void {          // every connection: bind with signal
+ *         this.querySelector("form")?.addEventListener("submit", send, {
  *             signal: this.signal,
  *         });
  *     }
@@ -22,75 +15,49 @@ import { within } from "./dom.ts";
  * customElements.define("atlas-thing", Thing);
  * ```
  *
- * **Two lifetimes, and confusing them is the whole reason this class exists.**
- * An element is constructed once and may be connected many times: moving it in
- * the DOM runs `disconnectedCallback` then `connectedCallback` again. So
- * `setup` is for what the element *is* — state, defaults, anything a reader
- * would be annoyed to lose — and `connect` is for what a connection *owns* —
- * listeners, timers, observers. Anything registered with `signal` is torn down
- * on every disconnect and re-registered on every connect, so a re-entry rebinds
- * rather than duplicating.
- *
- * **Subclasses implement `setup`, `connect` and `disconnect` — never
- * `connectedCallback` or `disconnectedCallback`.** Overriding those replaces
- * this class's, the controller is never created, and every listener leaks on
- * each disconnect. `connect` is abstract, so forgetting it is a compile error;
- * the adjacent mistake is caught at construction in development, below.
+ * - **An element is constructed once and connected many times.** Moving it in
+ *   the DOM runs `disconnectedCallback` then `connectedCallback` again, so
+ *   state belongs in `setup` and listeners in `connect`. Anything registered
+ *   with `signal` is dropped on disconnect and rebound on the next connect.
+ * - **Override `setup`, `connect` and `disconnect`, never the callbacks.**
+ *   Overriding `connectedCallback` skips the controller and leaks every
+ *   listener; that mistake throws in development, below.
+ * - **The defining script must stay a deferred module.** Astro emits
+ *   `<script src>` as `type="module"`, so the element has its children when it
+ *   is upgraded. `is:inline` runs it too early and every lookup finds nothing.
+ * - **`attributeChangedCallback` runs before `connectedCallback`**, where
+ *   `signal` is not readable yet. Record what changed and act on it in
+ *   `connect`.
+ * - **`disconnect` is not a destructor.** A move fires it and connects again a
+ *   moment later, so it is connection teardown and nothing else.
  *
- * **The script that defines a subclass must stay a deferred module.** Astro
- * emits `<script>` and `<script src="./…">` as `type="module"`, which runs after
- * the document is parsed, so an element has its children by the time it is
- * upgraded. `is:inline` opts out and runs the script where it sits — usually
- * above the element it wires — and every lookup then finds nothing. The
- * protection comes from the bundling, not from custom elements.
- *
- * **`attributeChangedCallback` runs before `connectedCallback`** for attributes
- * present in the initial markup, so `signal` is not available there and reading
- * it throws. A subclass with `observedAttributes` should record what changed and
- * act on it in `connect`.
- *
- * What is deliberately *not* modelled is destruction. `disconnect` fires on
- * every move, so it is connection teardown and nothing else — it is not the
- * place to flush state or release something genuinely scarce, because the
- * element may well be back a microtask later.
+ * See docs/client-scripts.md.
  */
 export abstract class AtlasElement extends HTMLElement {
     /**
-     * Cancels this connection's listeners, and only this connection's.
-     *
-     * Remade on every connect rather than held in a field initializer, because
-     * an `AbortController` is single-use: a controller that outlived the first
-     * connection would come back already aborted, `addEventListener` with an
-     * aborted signal silently adds nothing, and the element would return looking
-     * perfectly normal and be inert forever.
+     * This connection's listeners, and only this connection's. Remade on every
+     * connect: an `AbortController` is single-use, and a reused one comes back
+     * already aborted, leaving the element inert but normal-looking.
      */
     #ac?: AbortController;
 
-    /** Whether `setup` has run. See the two-lifetimes note above. */
     #ready = false;
 
     constructor() {
         super();
-        // Written as the bare expression Vite substitutes: `import.meta.env.DEV`
-        // is replaced with a literal, so this collapses to `if (false)` and the
-        // method below is dropped from the bundle. An optional chain would be
-        // replaced as `import.meta.env` instead — an object literal, whose
-        // `.DEV` a minifier has to fold rather than simply delete.
+        // The bare expression Vite substitutes, so this collapses to
+        // `if (false)` and the method below leaves the bundle.
         if (import.meta.env.DEV) this.#assertHooks();
     }
 
     /**
-     * Refuses a subclass that overrode the wrong lifecycle method.
-     *
-     * An override is an *own* property of the subclass prototype, where the
-     * inherited one is not — so walking up to this class's prototype finds it.
-     * The loop rather than a single check, because an intermediate base class
-     * could be the one that got it wrong.
+     * Refuses a subclass that overrode the wrong lifecycle method. An override
+     * is an *own* property of the subclass prototype; the loop covers an
+     * intermediate base class that got it wrong.
      */
     #assertHooks(): void {
-        // A tuple array rather than an object: `Object.entries` widens its keys
-        // back to `string`, so the pairing would stop being checked exactly
-        // where a typo would matter.
+        // A tuple array, not an object: `Object.entries` would widen the keys
+        // back to `string` and stop checking the pairing.
         const wrong = [
             ["connectedCallback", "connect"],
             ["disconnectedCallback", "disconnect"],
@@ -106,11 +73,8 @@ export abstract class AtlasElement extends HTMLElement {
                     const error = new Error(
                         `override "${hook}", not "${callback}" — see AtlasElement`
                     );
-                    // Reported before throwing: this runs during upgrade, so
-                    // `connectedCallback`'s catch has not been entered and the
-                    // throw would surface only as an uncaught error in the
-                    // console — invisible, for the one mistake this whole
-                    // apparatus exists to catch.
+                    // Reported before throwing: this runs during upgrade, where
+                    // a throw would only surface as an uncaught console error.
                     reportDevError(this.constructor.name, error);
                     throw error;
                 }
@@ -120,10 +84,7 @@ export abstract class AtlasElement extends HTMLElement {
 
     /**
      * Pass to `addEventListener`, observers, anything that should stop when the
-     * element leaves the document.
-     *
-     * Throws when read outside a connection, which is a programming error
-     * rather than a state to handle: there is nothing sensible to return.
+     * element leaves the document. Throws outside a connection.
      */
     protected get signal(): AbortSignal {
         if (!this.#ac) {
@@ -135,25 +96,17 @@ export abstract class AtlasElement extends HTMLElement {
     }
 
     connectedCallback(): void {
-        // Insurance. The spec pairs the callbacks, so this should never find a
-        // live controller — but if it ever did, overwriting one would orphan
-        // every listener it owned, silently, which is the failure this class
-        // exists to make impossible.
+        // Insurance: overwriting a live controller would orphan its listeners.
         this.#ac?.abort();
         this.#ac = new AbortController();
 
-        // Caught here so one broken element logs and sits inert rather than
-        // taking its siblings with it: the browser calls this once per element,
-        // so the blast radius is already one. That is what lets `require`
-        // throw instead of returning something every call site has to check.
+        // Caught so one broken element logs and sits inert rather than taking
+        // its siblings with it — which is what lets `require` throw.
         try {
             if (!this.#ready) {
                 this.setup();
-                // Only once it returned. Setting the flag first would mean a
-                // `setup` that threw was never retried, and the next connect
-                // would run `connect` against state that was never initialized
-                // — a component that renders perfectly and does nothing, which
-                // is the failure this class exists to make impossible.
+                // Only once it returned, so a `setup` that threw is retried
+                // rather than leaving `connect` to run against nothing.
                 this.#ready = true;
             }
             this.connect();
@@ -163,18 +116,13 @@ export abstract class AtlasElement extends HTMLElement {
     }
 
     disconnectedCallback(): void {
-        // Idempotent, so `adoptedCallback` can delegate here without running a
-        // subclass's teardown twice.
+        // Idempotent, so `adoptedCallback` can delegate here.
         if (!this.#ac) return;
         this.#ac.abort();
 
-        // Caught for the same reason as `connect`, and it matters more: a
-        // throw here escapes into whatever is swapping the DOM — a router, a
-        // view transition — rather than staying in the component.
         try {
             // Before `#ac` is cleared, so `this.signal` is readable and already
-            // aborted: an async continuation can check `signal.aborted` and
-            // bail rather than finishing against a detached element.
+            // aborted: an async continuation can check it and bail.
             this.disconnect();
         } catch (error) {
             this.#report(error);
@@ -183,13 +131,7 @@ export abstract class AtlasElement extends HTMLElement {
         this.#ac = undefined;
     }
 
-    /**
-     * Fires when the element moves to another document.
-     *
-     * Delegates, because the controller belongs to the connection in the old
-     * document and nothing else would tear it down. Exotic — `adoptNode` and
-     * iframe work — and one line either way.
-     */
+    /** Moving to another document ends the old document's connection. */
     adoptedCallback(): void {
         this.disconnectedCallback();
     }
@@ -202,58 +144,12 @@ export abstract class AtlasElement extends HTMLElement {
         console.error(`${this.localName}:`, error);
     }
 
-    /**
-     * Runs once per element, before its first `connect`.
-     *
-     * Where state belongs. A move re-runs `connect` but never this, so anything
-     * initialised here survives one — which is the difference between a reader
-     * coming back to the slide they left and coming back to the first one.
-     */
+    /** Runs once per element, before its first `connect`. State belongs here. */
     protected setup(): void {}
 
     /** Runs on every connect, with `signal` and the children both available. */
     protected abstract connect(): void;
 
-    /**
-     * Runs on every disconnect, once the signal has been aborted.
-     *
-     * `signal` is still readable here and reports `aborted` — which is what an
-     * async continuation should check before touching a now-detached element.
-     * What it is *not* is a destructor: a move fires this and then `connect`
-     * again a moment later, so it is connection teardown and nothing else.
-     * Flushing state or releasing something scarce does not belong here.
-     *
-     * Empty by default: anything registered with `signal` is already gone, and
-     * most elements have nothing else to undo.
-     */
+    /** Runs on every disconnect, once the signal has been aborted. */
     protected disconnect(): void {}
-
-    /** The first match inside this element, or `null`. */
-    protected one<T extends Element = HTMLElement>(selector: string): T | null {
-        return within(this).one<T>(selector);
-    }
-
-    /** Every match inside this element, as an array. */
-    protected all<T extends Element = HTMLElement>(selector: string): T[] {
-        return within(this).all<T>(selector);
-    }
-
-    /**
-     * The first match, or a thrown error naming what was missing.
-     *
-     * Throws rather than returning `T | null`, because a nullable return puts an
-     * `?.` at every call site — and that optional chain swallows the failure
-     * just as thoroughly as the missing element did, which is the thing worth
-     * avoiding. `connectedCallback` catches it, so one element with broken
-     * markup logs and stops while every other element on the page is untouched.
-     */
-    protected require<T extends Element = HTMLElement>(selector: string): T {
-        const found = this.one<T>(selector);
-        if (!found) {
-            throw new Error(
-                `nothing matched "${selector}" — is the script still a deferred module?`
-            );
-        }
-        return found;
-    }
 }