@gjsify/site 0.0.0-stage → 0.63.1-next.236

package/lib/site.js

@@ -0,0 +1,161 @@
+// The two things a consumer asks of this package: render the pages of a repository, and keep the
+// page catalogues in sync with the strings the renderer can emit. `cli.ts` is argv parsing on top.
+import { createHash } from 'node:crypto';
+import { existsSync } from 'node:fs';
+import { copyFile, mkdir, readFile, readdir, rm, writeFile } from 'node:fs/promises';
+import { basename, dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { catalogMsgids, configMsgids, rendererMsgids, syncCatalogs } from './render/i18n.js';
+import { processImage } from './render/images.js';
+import { renderPage, renderRoot } from './render/pages.js';
+import { UI_SOURCE_LANGUAGE, loadCatalogs, loadSiteData, mergeCatalogs, parseSiteConfig, translator, } from './site-data/index.js';
+/**
+ * This package's own directory: `lib/` holds the client bundle, `po/` the page catalogues.
+ *
+ * Both `src/site.ts` and the emitted `lib/site.js` sit one level below it, so the module's own URL
+ * answers this — except from a bundle, where the inlined module reports the outfile's location. A
+ * caller that knows better passes `packageDir`.
+ */
+const packageDir = resolve(dirname(fileURLToPath(import.meta.url)), '..');
+const poDir = (dir = packageDir) => join(dir, 'po');
+const clientDir = (dir = packageDir) => join(dir, 'lib/client');
+/** Where the renderer's translator calls are read from when this package's own catalogue is synced. */
+const rendererDir = (dir = packageDir) => join(dir, 'src/render');
+/** `options.packageDir` when given, else the install this module was loaded from. */
+const selfDir = (given) => (given === undefined ? packageDir : resolve(given));
+export function defaultCacheDir(root) {
+    return join(root, 'node_modules/.cache/gjsify-site');
+}
+async function readConfig(root) {
+    const manifest = JSON.parse(await readFile(join(root, 'package.json'), 'utf8'));
+    return parseSiteConfig(manifest);
+}
+/** Short, stable and enough to bust a cache: the first bytes of the content's SHA-256. */
+function contentHash(content) {
+    return createHash('sha256').update(content).digest('hex').slice(0, 8);
+}
+/**
+ * Stages the client bundle and the stylesheet this package ships, under content-addressed names.
+ * Both are built once, when the package is built — a site build neither needs a bundler nor an
+ * opinion about one.
+ */
+async function stageClientAssets(base, out, self) {
+    const assetDir = join(out, 'assets');
+    await mkdir(assetDir, { recursive: true });
+    const staged = await Promise.all(['js', 'css'].map(async (extension) => {
+        const content = await readFile(join(clientDir(self), `site.${extension}`));
+        const name = `site-${contentHash(content)}.${extension}`;
+        await writeFile(join(assetDir, name), content);
+        return `${base}assets/${name}`;
+    }));
+    return { js: staged[0], css: [staged[1]] };
+}
+/** Keyed by slug, which is what a `Screenshot` carries and the renderer looks up. */
+async function processScreenshots(data, { out }, cacheDir) {
+    const options = {
+        outDir: join(out, 'img'),
+        cacheDir: join(cacheDir, 'images'),
+        urlBase: `${data.config.base}img/`,
+    };
+    const entries = await Promise.all(data.screenshots.map(async (screenshot) => [screenshot.slug, await processImage(screenshot.file, screenshot.slug, options)]));
+    return new Map(entries);
+}
+async function publishIcon(data, { root, out }) {
+    if (!data.app.icon)
+        return undefined;
+    const name = basename(data.app.icon);
+    await copyFile(resolve(root, data.app.icon), join(out, name));
+    return `${data.config.base}${name}`;
+}
+/**
+ * The page catalogues: the ones this package ships, overlaid with the consumer's own. A consumer
+ * writes its captions and download labels itself, so only it can translate them.
+ */
+async function loadPageCatalogs(config, root, self, warn) {
+    const base = await loadCatalogs(poDir(self), config.languages);
+    const catalogs = config.pageTranslations
+        ? mergeCatalogs(base, await loadCatalogs(resolve(root, config.pageTranslations), config.languages))
+        : base;
+    if (warn) {
+        const own = configMsgids(config);
+        for (const language of config.languages) {
+            if (language === UI_SOURCE_LANGUAGE)
+                continue;
+            const missing = own.filter((msgid) => !catalogs[language]?.get(msgid));
+            if (missing.length === 0)
+                continue;
+            warn(`${language}: ${missing.length} string(s) from gjsify.site are untranslated, e.g. "${missing[0]}". ` +
+                'Run "gjsify site i18n" to write them to gjsify.site.pageTranslations.');
+        }
+    }
+    return catalogs;
+}
+/** Renders one static page per configured language, plus the language-picking root page. */
+export async function buildSite(options) {
+    const target = { root: resolve(options.root), out: resolve(options.out) };
+    const cacheDir = options.cacheDir === false ? undefined : (options.cacheDir ?? defaultCacheDir(target.root));
+    const self = selfDir(options.packageDir);
+    const config = await readConfig(target.root);
+    await rm(target.out, { recursive: true, force: true });
+    await mkdir(target.out, { recursive: true });
+    const assets = await stageClientAssets(config.base, target.out, self);
+    const catalogs = await loadPageCatalogs(config, target.root, self, options.warn);
+    const data = await loadSiteData({
+        root: target.root,
+        screenshotCacheDir: join(cacheDir ?? defaultCacheDir(target.root), 'screenshots'),
+        offline: options.offline ?? false,
+        githubToken: options.githubToken,
+        network: cacheDir ? { cacheDir: join(cacheDir, 'http') } : {},
+        warn: options.warn,
+    });
+    const images = await processScreenshots(data, target, cacheDir ?? defaultCacheDir(target.root));
+    const iconUrl = await publishIcon(data, target);
+    for (const lang of data.config.languages) {
+        const html = renderPage({ data, lang, t: translator(catalogs[lang]), assets, images, iconUrl });
+        await mkdir(join(target.out, lang), { recursive: true });
+        await writeFile(join(target.out, lang, 'index.html'), html);
+    }
+    await writeFile(join(target.out, 'index.html'), renderRoot(data, assets, iconUrl));
+    return { languages: [...data.config.languages], screenshots: images.size };
+}
+/** The languages this package keeps a catalogue for: whichever `po/<lang>.po` files exist. */
+async function packageLanguages(dir) {
+    const files = await readdir(dir);
+    return files.filter((file) => file.endsWith('.po')).map((file) => basename(file, '.po'));
+}
+/**
+ * Keeps gettext catalogues in sync with the strings that can actually be emitted — this package's
+ * own `po/` when called without a root, otherwise the consumer's `pageTranslations`.
+ */
+export async function syncSiteI18n(options = {}) {
+    const check = options.check ?? false;
+    const self = selfDir(options.packageDir);
+    if (options.root === undefined) {
+        const renderers = rendererDir(self);
+        if (!existsSync(renderers)) {
+            throw new Error(`${renderers} does not exist: the package catalogue is synced from a source checkout`);
+        }
+        return syncCatalogs({
+            dir: poDir(self),
+            languages: await packageLanguages(poDir(self)),
+            msgids: await rendererMsgids(renderers),
+            check,
+            pot: true,
+            base: self,
+        });
+    }
+    const root = resolve(options.root);
+    const config = await readConfig(root);
+    const shipped = await catalogMsgids(join(poDir(self), 'site.pot'));
+    const msgids = configMsgids(config).filter((msgid) => !shipped.has(msgid));
+    if (msgids.length === 0)
+        return { stale: [], untranslated: [] };
+    if (!config.pageTranslations) {
+        throw new Error(`gjsify.site introduces ${msgids.length} string(s) of its own, e.g. "${msgids[0]}". ` +
+            'Set gjsify.site.pageTranslations to the directory their catalogues should live in.');
+    }
+    const dir = resolve(root, config.pageTranslations);
+    if (!check)
+        await mkdir(dir, { recursive: true });
+    return syncCatalogs({ dir, languages: config.languages, msgids, check, base: root });
+}

package/package.json

@@ -1,6 +1,79 @@
 {
-  "name": "@gjsify/site",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@gjsify/site",
+    "version": "0.63.1-next.236",
+    "description": "Static landing page generator for a GNOME-style app, rendered from its AppStream metainfo — downloads, screenshots, release notes, support links, no JavaScript required.",
+    "type": "module",
+    "main": "lib/index.js",
+    "module": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./lib/index.d.ts",
+            "default": "./lib/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "lib",
+        "po"
+    ],
+    "scripts": {
+        "clear": "gjsify clear lib tsconfig.tsbuildinfo test.gjs.mjs test.node.mjs dist",
+        "check": "gjsify tsc --noEmit",
+        "build": "gjsify tsc -p tsconfig.build.json && gjsify run build:client && gjsify copy src/styles/site.css lib/client/site.css",
+        "build:client": "gjsify build src/client/main.ts --app browser --outfile lib/client/site.js",
+        "build:test": "gjsify run build:test:gjs && gjsify run build:test:node",
+        "build:test:gjs": "gjsify build src/test.gjs.mts --app gjs --outfile test.gjs.mjs",
+        "build:test:node": "gjsify build src/test.mts --app node --outfile test.node.mjs",
+        "test": "gjsify run build:test && gjsify run test:node && gjsify run test:gjs",
+        "test:gjs": "gjsify run test.gjs.mjs",
+        "test:node": "node test.node.mjs",
+        "test:bun": "bun test.node.mjs",
+        "test:deno": "deno run -A --no-lock --node-modules-dir=none --min-dep-age=0 test.node.mjs",
+        "test:cross-runtime": "gjsify run build:test:node && gjsify run test:node && gjsify run test:bun && gjsify run test:deno",
+        "test:gjs-on-node": "gjsify build src/test.node-gi.mts --app node --outfile dist/test.node-gi.mjs && node dist/test.node-gi.mjs",
+        "i18n": "gjsify site i18n --package"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/gjsify/gjsify.git",
+        "directory": "packages/infra/site"
+    },
+    "bugs": {
+        "url": "https://github.com/gjsify/gjsify/issues"
+    },
+    "homepage": "https://github.com/gjsify/gjsify/tree/main/packages/infra/site#readme",
+    "keywords": [
+        "appstream",
+        "metainfo",
+        "static-site",
+        "landing-page",
+        "gnome",
+        "flathub"
+    ],
+    "license": "MIT",
+    "dependencies": {
+        "@girs/gdkpixbuf-2.0": "5.4.0",
+        "@gjsify/console": "0.63.1-next.236",
+        "@gjsify/crypto": "0.63.1-next.236",
+        "@gjsify/fs": "0.63.1-next.236",
+        "@gjsify/module": "0.63.1-next.236",
+        "@gjsify/os": "0.63.1-next.236",
+        "@gjsify/path": "0.63.1-next.236",
+        "@gjsify/process": "0.63.1-next.236",
+        "@gjsify/url": "0.63.1-next.236",
+        "fast-xml-parser": "^5.11.2",
+        "qrcode-generator": "^2.0.4"
+    },
+    "devDependencies": {
+        "@gjsify/cli": "0.63.1-next.236",
+        "@gjsify/node-gi": "file:../../node-gi/node-gi",
+        "@gjsify/unit": "0.63.1-next.236",
+        "@types/node": "^25.9.2",
+        "typescript": "^6.0.3"
+    },
+    "gjsify": {
+        "tier": 2
+    },
+    "gitHead": "d4ae412daabae9cb89f4fa11ee7279a308c9e4be"
+}

package/po/de.po

@@ -0,0 +1,265 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: gjsify-site\n"
+"Language: de\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+msgid "Website"
+msgstr "Webseite"
+
+msgid "Help"
+msgstr "Hilfe"
+
+msgid "FAQ"
+msgstr "FAQ"
+
+msgid "Source code"
+msgstr "Quellcode"
+
+msgid "Report an issue"
+msgstr "Fehler melden"
+
+msgid "Contribute"
+msgstr "Mitmachen"
+
+msgid "Help translate"
+msgstr "Beim Übersetzen helfen"
+
+msgid "Contact"
+msgstr "Kontakt"
+
+msgid "Donate"
+msgstr "Spenden"
+
+msgid "Linux"
+msgstr "Linux"
+
+msgid "macOS"
+msgstr "macOS"
+
+msgid "Windows"
+msgstr "Windows"
+
+msgid "Android"
+msgstr "Android"
+
+msgid "Web"
+msgstr "Web"
+
+msgid "Firefox"
+msgstr "Firefox"
+
+msgid "Chromium"
+msgstr "Chromium"
+
+msgid "Install from Flathub"
+msgstr "Über Flathub installieren"
+
+msgid "Build from source"
+msgstr "Aus dem Quellcode bauen"
+
+msgid "Try in browser"
+msgstr "Im Browser ausprobieren"
+
+msgid "Add to {browser}"
+msgstr "Zu {browser} hinzufügen"
+
+msgid "Install for {browser}"
+msgstr "Für {browser} installieren"
+
+msgid "Download for {os}"
+msgstr "Für {os} herunterladen"
+
+msgid "Screenshot {number}"
+msgstr "Bildschirmfoto {number}"
+
+msgid "{number} of {total}"
+msgstr "{number} von {total}"
+
+msgid "slide"
+msgstr "Folie"
+
+msgid "View full screen"
+msgstr "Vollbild anzeigen"
+
+msgid "Screenshots"
+msgstr "Bildschirmfotos"
+
+msgid "carousel"
+msgstr "Karussell"
+
+msgid "Previous screenshot"
+msgstr "Vorheriges Bildschirmfoto"
+
+msgid "Next screenshot"
+msgstr "Nächstes Bildschirmfoto"
+
+msgid "Close"
+msgstr "Schließen"
+
+msgid "Recommended"
+msgstr "Empfohlen"
+
+msgid "Not yet available"
+msgstr "Noch nicht verfügbar"
+
+msgid "All releases"
+msgstr "Alle Versionen"
+
+msgid "Apple Silicon is assumed. Pick the Intel build if your Mac has an Intel processor."
+msgstr "Apple Silicon wird angenommen. Für Macs mit Intel-Prozessor die Intel-Variante wählen."
+
+msgid "All download options"
+msgstr "Alle Download-Optionen"
+
+msgid "Operating system"
+msgstr "Betriebssystem"
+
+msgid "All releases on GitHub"
+msgstr "Alle Versionen auf GitHub"
+
+msgid "Download size"
+msgstr "Downloadgröße"
+
+msgid "License"
+msgstr "Lizenz"
+
+msgid "Browsers"
+msgstr "Browser"
+
+msgid "Platforms"
+msgstr "Plattformen"
+
+msgid "All ages"
+msgstr "Alle Altersgruppen"
+
+msgid "{age}+"
+msgstr "ab {age}"
+
+msgid "Age rating"
+msgstr "Altersfreigabe"
+
+msgid "Installs"
+msgstr "Installationen"
+
+msgid "Show more"
+msgstr "Mehr anzeigen"
+
+msgid "Show less"
+msgstr "Weniger anzeigen"
+
+msgid "Changes in version {version}"
+msgstr "Änderungen in Version {version}"
+
+msgid "Older releases"
+msgstr "Ältere Versionen"
+
+msgid "Links"
+msgstr "Links"
+
+msgid "Copied"
+msgstr "Kopiert"
+
+msgid "Copy"
+msgstr "Kopieren"
+
+msgid "Bank transfer"
+msgstr "Banküberweisung"
+
+msgid "Recipient"
+msgstr "Empfänger"
+
+msgid "Reference"
+msgstr "Verwendungszweck"
+
+msgid "QR code for a bank transfer"
+msgstr "QR-Code für eine Banküberweisung"
+
+msgid "Scan with your banking app"
+msgstr "Mit der Banking-App scannen"
+
+msgid "Support this project"
+msgstr "Dieses Projekt unterstützen"
+
+msgid "Categories"
+msgstr "Kategorien"
+
+msgid "Keywords"
+msgstr "Stichwörter"
+
+msgid "Architectures"
+msgstr "Architekturen"
+
+msgid "Language"
+msgstr "Sprache"
+
+msgid "by {developer}"
+msgstr "von {developer}"
+
+msgid "{app} is licensed under {license}."
+msgstr "{app} steht unter der Lizenz {license}."
+
+msgid "This page reproduces text licensed under {license}."
+msgstr "Diese Seite gibt Texte unter der Lizenz {license} wieder."
+
+msgid "Made with {project}"
+msgstr "Gemacht mit {project}"
+
+msgid "Flathub"
+msgstr "Flathub"
+
+msgid "Flatpak bundle"
+msgstr "Flatpak-Bundle"
+
+msgid "AppImage"
+msgstr "AppImage"
+
+msgid "Debian package"
+msgstr "Debian-Paket"
+
+msgid "RPM package"
+msgstr "RPM-Paket"
+
+msgid "Windows installer"
+msgstr "Windows-Installer"
+
+msgid "Windows portable"
+msgstr "Windows (portabel)"
+
+msgid "macOS app"
+msgstr "macOS-App"
+
+msgid "macOS disk image"
+msgstr "macOS-Disk-Image"
+
+msgid "Android package"
+msgstr "Android-Paket"
+
+msgid "Web build"
+msgstr "Web-Version"
+
+msgid "Firefox Add-ons"
+msgstr "Firefox-Add-ons"
+
+msgid "Signed Firefox add-on"
+msgstr "Signiertes Firefox-Add-on"
+
+msgid "Firefox extension"
+msgstr "Firefox-Erweiterung"
+
+msgid "Chrome Web Store"
+msgstr "Chrome Web Store"
+
+msgid "Chromium extension"
+msgstr "Chromium-Erweiterung"
+
+msgid "ZIP archive"
+msgstr "ZIP-Archiv"
+
+msgid "Store"
+msgstr "Store"
+
+msgid "Firefox add-on"
+msgstr "Firefox-Add-on"