@olenbetong/appframe-vite 6.9.0 → 6.10.0

package/README.md

@@ -83,8 +83,11 @@ build then leaves `react`, `react/jsx-runtime`, `react/jsx-dev-runtime`, `react-
 which the template's import map resolves to `@olenbetong/synergi-platform` — one cached React
 per page, shared with the site chrome. The `af.data` global redirect (`dataGlobal`) then only
 applies to the dev server, which has no import map. The build also writes `dist/platform.json`
-with the versions the app compiled against; `scripts/app-deploy.ts` refuses to deploy when the
-target article renders no import map or its platform carries other versions (override with
+with the platform version the app was built alongside (the workspace's
+`packages/synergi-platform`) and the versions it compiled against; `scripts/app-deploy.ts` pins
+the article to that platform version (its `PlatformHead` and `PlatformStyles` blocks) and
+refuses to deploy when the article is not on a 2026 template, that version is not served on the
+target site, or its manifest carries other versions than the app (override with
 `--allow-platform-mismatch`).
 
 ## What it does (at a glance)

package/lib/build.d.ts

@@ -22,14 +22,20 @@ export declare function usesPlatform(appframe: {
  */
 export declare const PLATFORM_UPSTREAM: string[];
 export type PlatformManifest = {
+    /**
+     * The `@olenbetong/synergi-platform` version the app was built alongside - the one its
+     * article is pinned to on deploy. Missing when the build found no platform package.
+     */
+    platform?: string;
     /** The package versions the app resolved at build time. */
     upstream: Record<string, string>;
 };
 /**
- * Writes `dist/platform.json` after a platform build: the versions of the platform packages the
- * app was compiled against. The deploy script compares it with the manifest of the platform the
- * target site serves, since an app compiled against one React and run on another is a runtime
- * error, not a build error.
+ * Writes `dist/platform.json` after a platform build: the platform version the app was built
+ * alongside and the versions of the platform packages it compiled against. The deploy pins the
+ * article to that platform version (its `PlatformHead` block) and compares the versions with the
+ * manifest that version serves on the target site, since an app compiled against one React and
+ * run on another is a runtime error, not a build error.
  */
 export declare function platformManifest(): Plugin;
 export declare function addAppframeBuildConfig(config: UserConfig): Promise<UserConfig>;

package/lib/build.js

@@ -1,6 +1,6 @@
 import { existsSync } from "node:fs";
 import { readFile, writeFile } from "node:fs/promises";
-import { resolve } from "node:path";
+import { dirname, resolve } from "node:path";
 import { visualizer } from "rollup-plugin-visualizer";
 import { esmExternalRequirePlugin } from "vite";
 import { importJson } from "./importJson.js";
@@ -70,17 +70,47 @@ export const PLATFORM_UPSTREAM = [
     "@olenbetong/appframe-ds",
 ];
 /**
- * Writes `dist/platform.json` after a platform build: the versions of the platform packages the
- * app was compiled against. The deploy script compares it with the manifest of the platform the
- * target site serves, since an app compiled against one React and run on another is a runtime
- * error, not a build error.
+ * The platform package's version as the app sees it: its own copy under node_modules when it
+ * depends on `@olenbetong/synergi-platform`, otherwise the workspace's `packages/synergi-platform`
+ * found by walking up from the app - every app lives in the monorepo next to it.
+ */
+async function platformVersion(cwd) {
+    let candidates = [resolve(cwd, "node_modules", "@olenbetong", "synergi-platform", "package.json")];
+    let dir = cwd;
+    while (true) {
+        candidates.push(resolve(dir, "packages", "synergi-platform", "package.json"));
+        let parent = dirname(dir);
+        if (parent === dir)
+            break;
+        dir = parent;
+    }
+    for (let file of candidates) {
+        try {
+            return JSON.parse(await readFile(file, "utf8")).version;
+        }
+        catch {
+            // Not here; try the next candidate.
+        }
+    }
+    return undefined;
+}
+/**
+ * Writes `dist/platform.json` after a platform build: the platform version the app was built
+ * alongside and the versions of the platform packages it compiled against. The deploy pins the
+ * article to that platform version (its `PlatformHead` block) and compares the versions with the
+ * manifest that version serves on the target site, since an app compiled against one React and
+ * run on another is a runtime error, not a build error.
  */
 export function platformManifest() {
     return {
         name: "appframe:platform-manifest",
         apply: "build",
         async writeBundle() {
-            let manifest = { upstream: {} };
+            let manifest = { platform: await platformVersion(process.cwd()), upstream: {} };
+            if (manifest.platform === undefined) {
+                delete manifest.platform;
+                this.warn("No @olenbetong/synergi-platform package found; dist/platform.json records no platform version and the app cannot be deployed to a platform article.");
+            }
             for (let name of PLATFORM_UPSTREAM) {
                 let file = resolve(process.cwd(), "node_modules", name, "package.json");
                 try {

package/lib/index.js

@@ -22,19 +22,27 @@ let lastHostname;
 let watcher;
 let resourcesWatcher = null;
 let resourcesDebounce = null;
-try {
-    let appPkgUrl = `file://${process.cwd()}/package.json`;
-    watcher = watch(appPkgUrl).on("all", async () => {
-        if (server) {
-            let { hostname } = await getLoginInfo();
-            if (lastHostname !== hostname) {
-                server.restart(false);
+/**
+ * Restarts the dev server when the app's package.json changes its hostname. Started with the
+ * dev server, never at import: a watcher keeps node alive, and the deploy and release scripts
+ * import this package for its exports without ever running a server.
+ */
+function watchAppPackage() {
+    watcher?.close();
+    try {
+        let appPkgUrl = `file://${process.cwd()}/package.json`;
+        watcher = watch(appPkgUrl).on("all", async () => {
+            if (server) {
+                let { hostname } = await getLoginInfo();
+                if (lastHostname !== hostname) {
+                    server.restart(false);
+                }
             }
-        }
-    });
-}
-catch (error) {
-    console.log(createLogMessage(`failed to watch package.json: ${error.message}`, { type: "warn" }));
+        });
+    }
+    catch (error) {
+        console.log(createLogMessage(`failed to watch package.json: ${error.message}`, { type: "warn" }));
+    }
 }
 const jsonParser = bodyParser.json();
 export default function appframe(options = {}) {
@@ -121,10 +129,10 @@ export default function appframe(options = {}) {
                 },
             };
             if (command === "build") {
-                watcher.close();
                 await addAppframeBuildConfig(config);
             }
             else {
+                watchAppPackage();
                 let proxy = config.server?.proxy ?? {};
                 let routes = getProxyRoutes();
                 let { hostname, username, password } = await getLoginInfo();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olenbetong/appframe-vite",
-  "version": "6.9.0",
+  "version": "6.10.0",
   "description": "Tools to use and deploy Vite applications to Appframe",
   "main": "./lib/index.js",
   "type": "module",