@escape-game-over/atlas 0.1.49 → 0.1.51

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@escape-game-over/atlas",
-    "version": "0.1.49",
+    "version": "0.1.51",
     "type": "module",
     "description": "Typed, data-driven machinery for static multi-locale, multi-deployment Astro sites.",
     "private": false,

package/src/astro/Document.astro

@@ -13,6 +13,9 @@
  * A site with a lead form passes `rememberCampaign`, so the `utm_*` tags a
  * visit landed with survive to the page the form is on; see `attribution.ts`.
  *
+ * It sends a reader arriving from elsewhere to the page in the language they
+ * last chose; see `RememberLocale.astro`. `rememberLocale={false}` turns it off.
+ *
  * `fonts={site.fonts}` writes the `@font-face` rules and preloads for the
  * faces `siteFonts(site)` registered in the Astro config.
  *
@@ -29,6 +32,7 @@ import type { Fonts } from "../fonts.ts";
 import type { PageMeta } from "../site/index.ts";
 import MetaTags from "./MetaTags.astro";
 import RememberCampaign from "./RememberCampaign.astro";
+import RememberLocale from "./RememberLocale.astro";
 import ScrollRestore from "./ScrollRestore.astro";
 
 interface Props {
@@ -41,6 +45,8 @@ interface Props {
     readonly restoreScroll?: boolean;
     /** Off unless stated: a site with no lead form has nothing to keep them for. */
     readonly rememberCampaign?: boolean;
+    /** Defaults to `true`. */
+    readonly rememberLocale?: boolean;
 }
 
 const {
@@ -50,6 +56,7 @@ const {
     body,
     restoreScroll = true,
     rememberCampaign = false,
+    rememberLocale = true,
 } = Astro.props;
 ---
 
@@ -62,6 +69,7 @@ const {
     <head>
         <slot name="head-start" />
         <MetaTags tags={meta.tags} />
+        {rememberLocale && <RememberLocale />}
         {Object.entries(fonts).map(([key, font]) => (
             <Font cssVariable={`--${key}`} preload={font.preload === true} />
         ))}

package/src/astro/RememberLocale.astro

@@ -0,0 +1,23 @@
+---
+/**
+ * Opens a page in the language its reader chose, however they reached it.
+ *
+ * The choice is the locale of the last page reached from inside the site, so
+ * using the language switcher makes it and a shared link does not. Arriving
+ * from anywhere else, a reader is sent to this page in their chosen locale when
+ * the head lists an alternate for it. Crawlers keep no storage, so they are
+ * never sent anywhere.
+ *
+ * Rendered by `Document` after the head tags, whose alternates it reads.
+ * Inline and blocking, so the wrong language is never painted.
+ */
+import { inlineScript } from "./inline-script.ts";
+import source from "./remember-locale.ts?raw";
+
+const code = await inlineScript(source);
+---
+
+<script
+    is:inline
+    set:html={code}
+/>

package/src/astro/remember-locale.ts

@@ -0,0 +1,35 @@
+// The body of `RememberLocale.astro`'s inline script. A classic script: no
+// imports or exports, and the block keeps its names out of the global scope.
+{
+    const KEY = "atlas-locale";
+    const current = document.documentElement.lang;
+
+    const remember = () => {
+        // Came from this site: the visitor is browsing, or just switched
+        // language. Either way, this locale is their choice.
+        if (document.referrer.startsWith(`${location.origin}/`)) {
+            localStorage.setItem(KEY, current);
+            return;
+        }
+
+        const chosen = localStorage.getItem(KEY);
+        if (chosen === null || chosen === current) return;
+
+        // No alternate means this page is not built in that locale.
+        const alternate = document.querySelector<HTMLLinkElement>(
+            `link[rel="alternate"][hreflang="${CSS.escape(chosen)}"]`
+        );
+        if (alternate === null) return;
+
+        // Path only: alternates carry the production origin, not a preview's.
+        location.replace(
+            new URL(alternate.href).pathname + location.search + location.hash
+        );
+    };
+
+    try {
+        remember();
+    } catch {
+        // Storage is blocked in some private windows.
+    }
+}

package/src/astro/scroll-restore.ts

@@ -36,6 +36,12 @@
 
     restore(history.state);
 
+    // A page back from the back/forward cache runs no script, and with
+    // `manual` Safari shows it at the top.
+    addEventListener("pageshow", (event) => {
+        if (event.persisted) restore(history.state);
+    });
+
     // Filters push entries on the same page; `manual` turned off restoring
     // those too. A frame later, so the filtered list has re-rendered first.
     addEventListener("popstate", (event) => {