@getrefino/onboarding 0.1.0-rc.2 → 0.1.0-rc.4

package/dist/templates-hosted.js

@@ -1,4 +1,18 @@
+/**
+ * Boilerplate for a site connected to Refino (hosted mode). Everything runs
+ * in the browser: the site holds two public constants and no secrets, no
+ * copy endpoint, no session endpoint and no repository credential. Refino
+ * authenticates the owner, authorizes the site, and loads and saves the
+ * copy file in the repository.
+ *
+ *   /edit  → Refino /editor/authorize (PKCE) → back to /edit?code&state
+ *          → POST Refino /api/editor/token → 12 h editor token in sessionStorage
+ *          → <RefinoProvider endpoint={Refino copy API} headers={bearer}>
+ */
+import { isInstallMethod } from "./install-method.js";
 import { TOOL_VERSION } from "./plan.js";
+import { createTemplateFactory } from "./template-file.js";
+import { COPY_EDITING_HOSTED_RC1, RC1, REFINO_CLIENT_RC1, REFINO_SITE_RC1 } from "./templates-legacy.js";
 export const DEFAULT_REFINO_APP_URL = "https://app.refino.dev";
 export const REFINO_SITE_ID_PATTERN = /^site_[a-f0-9]{32}$/;
 /** Public configuration; safe to ship to the browser and to commit. */
@@ -398,35 +412,70 @@ export function analyticsHosting(hosting) {
         return "unknown";
     return ["cloudflare", "vercel", "netlify"].includes(hosting) ? hosting : "other";
 }
+/**
+ * Recognise an earlier Refino's `refino/refino-site` module.
+ *
+ * This is the one generated file whose bytes depend on the site, so "is it
+ * untouched?" cannot be a lookup: the site id, the app URL and the install
+ * facts are read back out of the file, each released shape is re-rendered
+ * from exactly those values, and the result is compared byte for byte. A file
+ * that round-trips is that release's output and nothing else; a file that
+ * does not is the owner's and is never overwritten.
+ *
+ * It also answers the question the manifest cannot for a reconnected site:
+ * after `--refino-site <new id>` the generated bytes name a different site, so
+ * only re-rendering with the *old* id can show the file was untouched.
+ */
+const recognizeSiteModule = (current, render) => {
+    const siteId = /REFINO_SITE_ID\s*=\s*"(site_[a-f0-9]{32})"/.exec(current)?.[1];
+    const appUrl = /REFINO_APP_URL\s*=\s*"([^"]+)"/.exec(current)?.[1];
+    if (!siteId || !appUrl)
+        return null;
+    // Before the install facts existed there was nothing else to read.
+    if (render(REFINO_SITE_RC1({ siteId, appUrl })) === current)
+        return { version: RC1, content: current };
+    const read = (key) => new RegExp(`${key}:\\s*"([^"]*)"`).exec(current)?.[1];
+    const method = read("method");
+    const framework = read("framework");
+    const hosting = read("hosting");
+    const packageVersion = read("packageVersion");
+    if (method === undefined || framework === undefined || hosting === undefined || packageVersion === undefined)
+        return null;
+    if (!isInstallMethod(method))
+        return null;
+    const rendered = render(REFINO_SITE({ siteId, appUrl, installMethod: method, framework, hosting, packageVersion }));
+    return rendered === current ? { version: packageVersion, content: current } : null;
+};
+/** What 0.1.0-rc.1 wrote for the two hosted modules whose bodies have changed since. */
+const RC1_CLIENT = { version: RC1, content: REFINO_CLIENT_RC1 };
+const RC1_COPY_EDITING = { version: RC1, content: COPY_EDITING_HOSTED_RC1 };
 /** Files for a Refino-connected site. No server code, no secrets, in any framework. */
-export function hostedFiles(plan) {
+export function hostedFiles(plan, factory) {
     const refino = plan.refino;
     if (!refino)
         return [];
+    const make = factory ?? createTemplateFactory(plan.repository.language);
     const dir = plan.integration.boilerplateDir;
     const files = [
-        {
-            path: `${dir}/refino-site.ts`,
-            content: REFINO_SITE({
-                ...refino,
-                framework: analyticsFramework(plan.repository.framework),
-                hosting: analyticsHosting(plan.repository.hosting),
-                packageVersion: TOOL_VERSION,
-            }),
-        },
-        { path: `${dir}/refino-client.ts`, content: REFINO_CLIENT },
-        { path: `${dir}/copy-editing.tsx`, content: COPY_EDITING_HOSTED },
-        { path: `${dir}/edit-page.tsx`, content: EDIT_PAGE_HOSTED },
+        make.machine(`${dir}/refino-site.ts`, REFINO_SITE({
+            ...refino,
+            framework: analyticsFramework(plan.repository.framework),
+            hosting: analyticsHosting(plan.repository.hosting),
+            packageVersion: TOOL_VERSION,
+        }), { recognize: recognizeSiteModule }),
+        make.machine(`${dir}/refino-client.ts`, REFINO_CLIENT, { previous: [RC1_CLIENT] }),
+        make.machine(`${dir}/copy-editing.tsx`, COPY_EDITING_HOSTED, { previous: [RC1_COPY_EDITING] }),
+        make.scaffold(`${dir}/edit-page.tsx`, EDIT_PAGE_HOSTED),
     ];
     const editPage = plan.files.find((file) => /(^|\/)edit(\/page)?\.\w+$/.test(file.path) && !file.path.startsWith(`${dir}/`))?.path;
     if (plan.repository.router === "next-app") {
         const routesDir = editPage?.replace(/\/edit\/page\.\w+$/, "") ?? "app";
-        files.push({ path: `${routesDir}/edit/layout.tsx`, content: EDIT_LAYOUT_HOSTED });
-        files.push({ path: `${routesDir}/edit/page.tsx`, content: EDIT_ROUTE_NEXT_HOSTED(relativeImport(`${routesDir}/edit/page.tsx`, `${dir}/edit-page.tsx`)) });
+        files.push(make.machine(`${routesDir}/edit/layout.tsx`, EDIT_LAYOUT_HOSTED));
+        files.push(make.machine(`${routesDir}/edit/page.tsx`, EDIT_ROUTE_NEXT_HOSTED(relativeImport(`${routesDir}/edit/page.tsx`, `${dir}/edit-page.tsx`))));
     }
     else if (plan.repository.router === "next-pages") {
         const routesDir = editPage?.replace(/\/edit\.\w+$/, "") ?? "pages";
-        files.push({ path: `${routesDir}/edit.tsx`, content: EDIT_PAGE_NEXT_PAGES_HOSTED(relativeImport(`${routesDir}/edit.tsx`, `${dir}/edit-page.tsx`)) });
+        files.push(make.machine(`${routesDir}/edit.tsx`, EDIT_PAGE_NEXT_PAGES_HOSTED(relativeImport(`${routesDir}/edit.tsx`, `${dir}/edit-page.tsx`))));
     }
     return files;
 }

package/dist/templates-legacy.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Byte-exact renderings of generated files as earlier Refino releases wrote
+ * them. They exist for one reason: a site onboarded before .refino/generated.json
+ * existed carries no record of what Refino wrote, so the only way to prove a
+ * generated file is untouched is to reproduce the old bytes and compare.
+ *
+ * Nothing here is ever written to a repository. It is read-only evidence.
+ *
+ * Maintenance: when a template body in templates.ts or templates-hosted.ts
+ * changes, copy the previous body here and list it in that file's `previous`
+ * renderings. `generated-templates.test.ts` fails until you do, because it
+ * pins the hash of every generated file.
+ */
+export interface LegacySiteConfig {
+    readonly siteId: string;
+    readonly appUrl: string;
+}
+/** The last release that wrote the bodies below. */
+export declare const RC1 = "0.1.0-rc.1";
+/** 0.1.0-rc.1 refino/refino-site.ts: the two public constants, before REFINO_INSTALL. */
+export declare const REFINO_SITE_RC1: (config: LegacySiteConfig) => string;
+/** 0.1.0-rc.1 refino/refino-client.ts: before reportEditorEvent and the install facts. */
+export declare const REFINO_CLIENT_RC1 = "/**\n * Browser-side Refino editor authorization for this site. No secrets here:\n * the site is a public client (OAuth 2.1 with PKCE). The editor token lives\n * in sessionStorage only (never localStorage, never a URL), is scoped to\n * this site, and Refino re-checks the account's entitlement on every load\n * and save. Never import this from server code.\n */\nimport { REFINO_APP_URL, REFINO_SITE_ID } from \"./refino-site\";\n\nconst PKCE_KEY = \"refino.pkce\";\nconst SESSION_KEY = \"refino.editor\";\nconst CALLBACK_PATH = \"/edit\";\n\nexport interface EditorSession {\n  readonly token: string;\n  /** Unix seconds. */\n  readonly expiresAt: number;\n  readonly siteId: string;\n}\n\ninterface PendingAuthorization {\n  readonly verifier: string;\n  readonly state: string;\n  readonly returnTo: string;\n}\n\nfunction base64url(bytes: Uint8Array): string {\n  let binary = \"\";\n  for (const byte of bytes) binary += String.fromCharCode(byte);\n  return btoa(binary).replace(/\\+/g, \"-\").replace(/\\//g, \"_\").replace(/=+$/, \"\");\n}\n\nfunction randomToken(bytes: number): string {\n  const buffer = new Uint8Array(bytes);\n  crypto.getRandomValues(buffer);\n  return base64url(buffer);\n}\n\nasync function sha256(text: string): Promise<string> {\n  const digest = await crypto.subtle.digest(\"SHA-256\", new TextEncoder().encode(text));\n  return base64url(new Uint8Array(digest));\n}\n\nfunction storage(): Storage | null {\n  try {\n    return typeof window === \"undefined\" ? null : window.sessionStorage;\n  } catch {\n    return null;\n  }\n}\n\nfunction readJson<T>(key: string): T | null {\n  const raw = storage()?.getItem(key);\n  if (!raw) return null;\n  try {\n    return JSON.parse(raw) as T;\n  } catch {\n    return null;\n  }\n}\n\n/** Only a path on this site, never another origin. */\nexport function safeReturnTo(value: string | null | undefined): string {\n  if (!value || !value.startsWith(\"/\") || value.startsWith(\"//\") || value.startsWith(\"/\\\\\") || value.length > 512) return \"/\";\n  return value;\n}\n\nexport function editorEndpoint(): string {\n  return `${REFINO_APP_URL}/api/sites/${REFINO_SITE_ID}/copy`;\n}\n\nexport function callbackUrl(): string {\n  return `${window.location.origin}${CALLBACK_PATH}`;\n}\n\n/** The current editor session, or null when there is none or it expired. */\nexport function readEditorSession(nowSeconds: number = Math.floor(Date.now() / 1000)): EditorSession | null {\n  const session = readJson<EditorSession>(SESSION_KEY);\n  if (!session || typeof session.token !== \"string\" || session.siteId !== REFINO_SITE_ID || typeof session.expiresAt !== \"number\") return null;\n  if (session.expiresAt <= nowSeconds) {\n    storage()?.removeItem(SESSION_KEY);\n    return null;\n  }\n  return session;\n}\n\nexport function clearEditorSession(): void {\n  storage()?.removeItem(SESSION_KEY);\n  storage()?.removeItem(PKCE_KEY);\n}\n\n/** Start the flow: remember the PKCE verifier and state, then go to Refino. */\nexport async function beginAuthorization(returnTo: string): Promise<void> {\n  const verifier = randomToken(32);\n  const state = randomToken(16);\n  const pending: PendingAuthorization = { verifier, state, returnTo: safeReturnTo(returnTo) };\n  storage()?.setItem(PKCE_KEY, JSON.stringify(pending));\n  const params = new URLSearchParams({\n    site_id: REFINO_SITE_ID,\n    redirect_uri: callbackUrl(),\n    code_challenge: await sha256(verifier),\n    code_challenge_method: \"S256\",\n    state,\n  });\n  window.location.assign(`${REFINO_APP_URL}/editor/authorize?${params.toString()}`);\n}\n\nexport type AuthorizationResult = { readonly ok: true; readonly returnTo: string } | { readonly ok: false; readonly error: string };\n\n/**\n * Finish the flow on /edit?code&state: check the state, exchange the code\n * with the verifier this browser kept, store the session, and scrub the\n * code from the URL. The token is never placed in a URL.\n */\nexport async function completeAuthorization(search: string = window.location.search): Promise<AuthorizationResult> {\n  const params = new URLSearchParams(search);\n  const code = params.get(\"code\");\n  const state = params.get(\"state\");\n  const pending = readJson<PendingAuthorization>(PKCE_KEY);\n  storage()?.removeItem(PKCE_KEY);\n  if (typeof window !== \"undefined\" && window.history.replaceState) window.history.replaceState(null, \"\", window.location.pathname);\n  if (!code || !state) return { ok: false, error: \"Refino did not return an authorization code.\" };\n  if (!pending || pending.state !== state) return { ok: false, error: \"Sign-in was interrupted (state mismatch). Start again.\" };\n\n  let response: Response;\n  try {\n    response = await fetch(`${REFINO_APP_URL}/api/editor/token`, {\n      method: \"POST\",\n      mode: \"cors\",\n      credentials: \"omit\",\n      headers: { \"content-type\": \"application/json\", accept: \"application/json\" },\n      body: JSON.stringify({ grant_type: \"authorization_code\", code, code_verifier: pending.verifier, site_id: REFINO_SITE_ID, redirect_uri: callbackUrl() }),\n    });\n  } catch {\n    return { ok: false, error: \"Could not reach Refino to finish signing in.\" };\n  }\n  const body = (await response.json().catch(() => null)) as { ok?: boolean; token?: string; expiresAt?: number; siteId?: string; error?: { message?: string } } | null;\n  if (!response.ok || !body?.ok || typeof body.token !== \"string\" || typeof body.expiresAt !== \"number\" || body.siteId !== REFINO_SITE_ID) {\n    return { ok: false, error: body?.error?.message ?? \"Refino did not accept the authorization.\" };\n  }\n  const session: EditorSession = { token: body.token, expiresAt: body.expiresAt, siteId: body.siteId };\n  storage()?.setItem(SESSION_KEY, JSON.stringify(session));\n  return { ok: true, returnTo: pending.returnTo };\n}\n";
+/** 0.1.0-rc.1 refino/copy-editing.tsx: before onEvent={reportEditorEvent}. */
+export declare const COPY_EDITING_HOSTED_RC1 = "\"use client\";\n\nimport type { CopyContent } from \"@getrefino/core\";\nimport { RefinoProvider } from \"@getrefino/react\";\nimport type { ReactNode } from \"react\";\nimport { useCallback, useEffect, useState } from \"react\";\n\nimport { clearEditorSession, editorEndpoint, readEditorSession } from \"./refino-client\";\nimport type { EditorSession } from \"./refino-client\";\n\ninterface CopyEditingProps {\n  content: CopyContent;\n  children: ReactNode;\n}\n\n/**\n * Hosted mode (Refino). Visitors get the plain site: the server never\n * decides edit mode, so pages can stay static. In the browser, an editor\n * session stored by /edit turns edit mode on; loads and saves go to Refino\n * with the session's bearer token, and Refino checks the site's\n * entitlement on every request.\n */\nexport function CopyEditing({ content, children }: CopyEditingProps) {\n  const [session, setSession] = useState<EditorSession | null>(null);\n\n  useEffect(() => {\n    // Read the session only after mount so server-rendered HTML never differs from the visitor's.\n    setSession(readEditorSession());\n  }, []);\n\n  // Read at request time (the provider keeps its options from the first render), so the\n  // token is always the one currently stored and never sent once the session is cleared.\n  const headers = useCallback((): Record<string, string> => {\n    const current = readEditorSession();\n    return current ? { authorization: `Bearer ${current.token}` } : {};\n  }, []);\n\n  const onExit = useCallback(async () => {\n    clearEditorSession();\n    window.location.assign(\"/\");\n  }, []);\n\n  return (\n    <RefinoProvider content={content} editing={session !== null} endpoint={editorEndpoint()} headers={headers} signInHref=\"/edit\" onExit={onExit}>\n      {children}\n    </RefinoProvider>\n  );\n}\n";

package/dist/templates-legacy.js

@@ -0,0 +1,221 @@
+/**
+ * Byte-exact renderings of generated files as earlier Refino releases wrote
+ * them. They exist for one reason: a site onboarded before .refino/generated.json
+ * existed carries no record of what Refino wrote, so the only way to prove a
+ * generated file is untouched is to reproduce the old bytes and compare.
+ *
+ * Nothing here is ever written to a repository. It is read-only evidence.
+ *
+ * Maintenance: when a template body in templates.ts or templates-hosted.ts
+ * changes, copy the previous body here and list it in that file's `previous`
+ * renderings. `generated-templates.test.ts` fails until you do, because it
+ * pins the hash of every generated file.
+ */
+/** The last release that wrote the bodies below. */
+export const RC1 = "0.1.0-rc.1";
+/** 0.1.0-rc.1 refino/refino-site.ts: the two public constants, before REFINO_INSTALL. */
+export const REFINO_SITE_RC1 = (config) => `/**
+ * Public Refino configuration for this site. Neither value is a secret:
+ * the site id appears in editor URLs and the app URL is where owners sign
+ * in. Generated by Refino; change it only when the site is
+ * reconnected to Refino.
+ */
+export const REFINO_SITE_ID = ${JSON.stringify(config.siteId)};
+export const REFINO_APP_URL = ${JSON.stringify(config.appUrl)};
+`;
+/** 0.1.0-rc.1 refino/refino-client.ts: before reportEditorEvent and the install facts. */
+export const REFINO_CLIENT_RC1 = `/**
+ * Browser-side Refino editor authorization for this site. No secrets here:
+ * the site is a public client (OAuth 2.1 with PKCE). The editor token lives
+ * in sessionStorage only (never localStorage, never a URL), is scoped to
+ * this site, and Refino re-checks the account's entitlement on every load
+ * and save. Never import this from server code.
+ */
+import { REFINO_APP_URL, REFINO_SITE_ID } from "./refino-site";
+
+const PKCE_KEY = "refino.pkce";
+const SESSION_KEY = "refino.editor";
+const CALLBACK_PATH = "/edit";
+
+export interface EditorSession {
+  readonly token: string;
+  /** Unix seconds. */
+  readonly expiresAt: number;
+  readonly siteId: string;
+}
+
+interface PendingAuthorization {
+  readonly verifier: string;
+  readonly state: string;
+  readonly returnTo: string;
+}
+
+function base64url(bytes: Uint8Array): string {
+  let binary = "";
+  for (const byte of bytes) binary += String.fromCharCode(byte);
+  return btoa(binary).replace(/\\+/g, "-").replace(/\\//g, "_").replace(/=+$/, "");
+}
+
+function randomToken(bytes: number): string {
+  const buffer = new Uint8Array(bytes);
+  crypto.getRandomValues(buffer);
+  return base64url(buffer);
+}
+
+async function sha256(text: string): Promise<string> {
+  const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(text));
+  return base64url(new Uint8Array(digest));
+}
+
+function storage(): Storage | null {
+  try {
+    return typeof window === "undefined" ? null : window.sessionStorage;
+  } catch {
+    return null;
+  }
+}
+
+function readJson<T>(key: string): T | null {
+  const raw = storage()?.getItem(key);
+  if (!raw) return null;
+  try {
+    return JSON.parse(raw) as T;
+  } catch {
+    return null;
+  }
+}
+
+/** Only a path on this site, never another origin. */
+export function safeReturnTo(value: string | null | undefined): string {
+  if (!value || !value.startsWith("/") || value.startsWith("//") || value.startsWith("/\\\\") || value.length > 512) return "/";
+  return value;
+}
+
+export function editorEndpoint(): string {
+  return \`\${REFINO_APP_URL}/api/sites/\${REFINO_SITE_ID}/copy\`;
+}
+
+export function callbackUrl(): string {
+  return \`\${window.location.origin}\${CALLBACK_PATH}\`;
+}
+
+/** The current editor session, or null when there is none or it expired. */
+export function readEditorSession(nowSeconds: number = Math.floor(Date.now() / 1000)): EditorSession | null {
+  const session = readJson<EditorSession>(SESSION_KEY);
+  if (!session || typeof session.token !== "string" || session.siteId !== REFINO_SITE_ID || typeof session.expiresAt !== "number") return null;
+  if (session.expiresAt <= nowSeconds) {
+    storage()?.removeItem(SESSION_KEY);
+    return null;
+  }
+  return session;
+}
+
+export function clearEditorSession(): void {
+  storage()?.removeItem(SESSION_KEY);
+  storage()?.removeItem(PKCE_KEY);
+}
+
+/** Start the flow: remember the PKCE verifier and state, then go to Refino. */
+export async function beginAuthorization(returnTo: string): Promise<void> {
+  const verifier = randomToken(32);
+  const state = randomToken(16);
+  const pending: PendingAuthorization = { verifier, state, returnTo: safeReturnTo(returnTo) };
+  storage()?.setItem(PKCE_KEY, JSON.stringify(pending));
+  const params = new URLSearchParams({
+    site_id: REFINO_SITE_ID,
+    redirect_uri: callbackUrl(),
+    code_challenge: await sha256(verifier),
+    code_challenge_method: "S256",
+    state,
+  });
+  window.location.assign(\`\${REFINO_APP_URL}/editor/authorize?\${params.toString()}\`);
+}
+
+export type AuthorizationResult = { readonly ok: true; readonly returnTo: string } | { readonly ok: false; readonly error: string };
+
+/**
+ * Finish the flow on /edit?code&state: check the state, exchange the code
+ * with the verifier this browser kept, store the session, and scrub the
+ * code from the URL. The token is never placed in a URL.
+ */
+export async function completeAuthorization(search: string = window.location.search): Promise<AuthorizationResult> {
+  const params = new URLSearchParams(search);
+  const code = params.get("code");
+  const state = params.get("state");
+  const pending = readJson<PendingAuthorization>(PKCE_KEY);
+  storage()?.removeItem(PKCE_KEY);
+  if (typeof window !== "undefined" && window.history.replaceState) window.history.replaceState(null, "", window.location.pathname);
+  if (!code || !state) return { ok: false, error: "Refino did not return an authorization code." };
+  if (!pending || pending.state !== state) return { ok: false, error: "Sign-in was interrupted (state mismatch). Start again." };
+
+  let response: Response;
+  try {
+    response = await fetch(\`\${REFINO_APP_URL}/api/editor/token\`, {
+      method: "POST",
+      mode: "cors",
+      credentials: "omit",
+      headers: { "content-type": "application/json", accept: "application/json" },
+      body: JSON.stringify({ grant_type: "authorization_code", code, code_verifier: pending.verifier, site_id: REFINO_SITE_ID, redirect_uri: callbackUrl() }),
+    });
+  } catch {
+    return { ok: false, error: "Could not reach Refino to finish signing in." };
+  }
+  const body = (await response.json().catch(() => null)) as { ok?: boolean; token?: string; expiresAt?: number; siteId?: string; error?: { message?: string } } | null;
+  if (!response.ok || !body?.ok || typeof body.token !== "string" || typeof body.expiresAt !== "number" || body.siteId !== REFINO_SITE_ID) {
+    return { ok: false, error: body?.error?.message ?? "Refino did not accept the authorization." };
+  }
+  const session: EditorSession = { token: body.token, expiresAt: body.expiresAt, siteId: body.siteId };
+  storage()?.setItem(SESSION_KEY, JSON.stringify(session));
+  return { ok: true, returnTo: pending.returnTo };
+}
+`;
+/** 0.1.0-rc.1 refino/copy-editing.tsx: before onEvent={reportEditorEvent}. */
+export const COPY_EDITING_HOSTED_RC1 = `"use client";
+
+import type { CopyContent } from "@getrefino/core";
+import { RefinoProvider } from "@getrefino/react";
+import type { ReactNode } from "react";
+import { useCallback, useEffect, useState } from "react";
+
+import { clearEditorSession, editorEndpoint, readEditorSession } from "./refino-client";
+import type { EditorSession } from "./refino-client";
+
+interface CopyEditingProps {
+  content: CopyContent;
+  children: ReactNode;
+}
+
+/**
+ * Hosted mode (Refino). Visitors get the plain site: the server never
+ * decides edit mode, so pages can stay static. In the browser, an editor
+ * session stored by /edit turns edit mode on; loads and saves go to Refino
+ * with the session's bearer token, and Refino checks the site's
+ * entitlement on every request.
+ */
+export function CopyEditing({ content, children }: CopyEditingProps) {
+  const [session, setSession] = useState<EditorSession | null>(null);
+
+  useEffect(() => {
+    // Read the session only after mount so server-rendered HTML never differs from the visitor's.
+    setSession(readEditorSession());
+  }, []);
+
+  // Read at request time (the provider keeps its options from the first render), so the
+  // token is always the one currently stored and never sent once the session is cleared.
+  const headers = useCallback((): Record<string, string> => {
+    const current = readEditorSession();
+    return current ? { authorization: \`Bearer \${current.token}\` } : {};
+  }, []);
+
+  const onExit = useCallback(async () => {
+    clearEditorSession();
+    window.location.assign("/");
+  }, []);
+
+  return (
+    <RefinoProvider content={content} editing={session !== null} endpoint={editorEndpoint()} headers={headers} signInHref="/edit" onExit={onExit}>
+      {children}
+    </RefinoProvider>
+  );
+}
+`;

package/dist/templates.d.ts

@@ -1,8 +1,6 @@
+import type { TemplateFile } from "./template-file.js";
 import type { MigrationPlan } from "./types.js";
-export interface TemplateFile {
-    readonly path: string;
-    readonly content: string;
-}
+export type { TemplateFile, TemplateRendering } from "./template-file.js";
 export declare const ENV_EXAMPLE_BLOCK = "\n# --- Refino (server-side only; never expose with NEXT_PUBLIC_/VITE_) ---\n# Edit-mode login. Both required in production; development falls back to password \"edit\".\nEDITOR_PASSWORD=\nEDITOR_SESSION_SECRET=\n# Persistence: \"local\" writes the copy file on disk (development), \"github\" commits it.\nCOPY_ADAPTER=local\n# GitHub persistence (COPY_ADAPTER=github): fine-grained token, Contents read/write, one repo.\nCOPY_GITHUB_TOKEN=\nCOPY_GITHUB_REPO=owner/name\nCOPY_GITHUB_BRANCH=main\nCOPY_FILE_PATH=\n";
 /** Files the apply step may create for a plan, in TS or JS as the project requires. */
 export declare function boilerplateFiles(plan: MigrationPlan): TemplateFile[];

package/dist/templates.js

@@ -1,11 +1,17 @@
 /**
- * Boilerplate written by `refino init --apply`. Each file is isolated
- * under `refino/` (or is a new route file) and is only written when it
- * does not already exist. Authored in TypeScript; JavaScript projects get a
- * transpiled copy.
+ * Boilerplate written by `refino init --agent`. Each file is isolated under
+ * `refino/` (or is a new route file). Authored in TypeScript; JavaScript
+ * projects get a transpiled copy.
+ *
+ * A file that already exists is refreshed only when Refino can prove the
+ * bytes on disk are still the ones it wrote (generated.ts); otherwise it is
+ * left exactly as it is and reported. Each entry therefore declares who owns
+ * it -- `machine` for Refino's runtime code, `scaffold` for a page the owner
+ * is invited to restyle -- and, when its body has changed since a released
+ * version, the byte-exact body that version wrote.
  */
-import ts from "typescript";
 import { BOILERPLATE_DIR } from "./plan.js";
+import { createTemplateFactory } from "./template-file.js";
 import { hostedFiles } from "./templates-hosted.js";
 const BOILERPLATE_DIR_NAME = BOILERPLATE_DIR;
 function relativeImport(fromFile, toFile) {
@@ -601,71 +607,56 @@ COPY_GITHUB_REPO=owner/name
 COPY_GITHUB_BRANCH=main
 COPY_FILE_PATH=
 `;
-function transpileToJs(path, source) {
-    const output = ts.transpileModule(source, {
-        compilerOptions: {
-            target: ts.ScriptTarget.ES2022,
-            module: ts.ModuleKind.ESNext,
-            jsx: ts.JsxEmit.Preserve,
-            removeComments: false,
-            verbatimModuleSyntax: false,
-        },
-        fileName: path,
-    });
-    return { path: path.replace(/\.tsx$/, ".jsx").replace(/\.ts$/, ".js"), content: output.outputText.replace(/^export \{\};\s*$/m, "").replace(/\n{3,}/g, "\n\n") };
-}
 /** Files the apply step may create for a plan, in TS or JS as the project requires. */
 export function boilerplateFiles(plan) {
-    if (plan.refino) {
-        const files = hostedFiles(plan);
-        return plan.repository.language === "javascript" ? files.map((file) => transpileToJs(file.path, file.content)) : files;
-    }
+    const make = createTemplateFactory(plan.repository.language);
+    if (plan.refino)
+        return hostedFiles(plan, make);
     const dir = plan.integration.boilerplateDir;
     const strategy = plan.integration.provider.strategy;
     const host = plan.integration.host;
     // Server-rendered hosts pass `editing` from a cookie check; everything else probes the session in the browser.
     const serverRenderedEditing = strategy === "next-app-root-layout" || strategy === "next-pages-app";
     const handlers = `${dir}/request-handlers.ts`;
+    // The self-hosted templates below are byte-identical to every release so
+    // far, so none of them carries a `previous` rendering yet.
     const files = [
-        { path: `${dir}/editor-auth.ts`, content: EDITOR_AUTH },
-        { path: `${dir}/content-adapter.ts`, content: CONTENT_ADAPTER(plan.contentFile.path) },
-        { path: handlers, content: REQUEST_HANDLERS },
-        { path: `${dir}/copy-editing.tsx`, content: serverRenderedEditing ? COPY_EDITING : COPY_EDITING_CLIENT_SESSION },
+        make.machine(`${dir}/editor-auth.ts`, EDITOR_AUTH),
+        make.machine(`${dir}/content-adapter.ts`, CONTENT_ADAPTER(plan.contentFile.path)),
+        make.machine(handlers, REQUEST_HANDLERS),
+        make.machine(`${dir}/copy-editing.tsx`, serverRenderedEditing ? COPY_EDITING : COPY_EDITING_CLIENT_SESSION),
     ];
     if (strategy === "next-app-root-layout-client-session") {
         const routesDir = plan.files.find((file) => /\/edit\/page\.\w+$/.test(file.path))?.path.replace(/\/edit\/page\.\w+$/, "") ?? "app";
-        files.push({ path: `${routesDir}/edit/layout.tsx`, content: EDIT_LAYOUT_STATIC });
-        files.push({ path: `${routesDir}/edit/page.tsx`, content: EDIT_PAGE_STATIC });
+        files.push(make.scaffold(`${routesDir}/edit/layout.tsx`, EDIT_LAYOUT_STATIC));
+        files.push(make.scaffold(`${routesDir}/edit/page.tsx`, EDIT_PAGE_STATIC));
     }
     const copyFile = host.copyEndpoint.replace(/\.\w+$/, ".ts");
     const sessionFile = host.sessionEndpoint.replace(/\.\w+$/, ".ts");
     switch (host.kind) {
         case "next-route-handlers": {
             const editPage = `${copyFile.replace(/\/api\/copy\/route\.ts$/, "")}/edit/page.tsx`;
-            files.push({ path: `${dir}/editor-session.ts`, content: EDITOR_SESSION_NEXT });
-            files.push({ path: copyFile, content: COPY_ROUTE_NEXT(relativeImport(copyFile, handlers)) });
-            files.push({ path: sessionFile, content: SESSION_ROUTE_NEXT(relativeImport(sessionFile, handlers)) });
-            files.push({ path: editPage, content: EDIT_PAGE_NEXT(relativeImport(editPage, `${dir}/editor-session.ts`)) });
+            files.push(make.machine(`${dir}/editor-session.ts`, EDITOR_SESSION_NEXT));
+            files.push(make.machine(copyFile, COPY_ROUTE_NEXT(relativeImport(copyFile, handlers))));
+            files.push(make.machine(sessionFile, SESSION_ROUTE_NEXT(relativeImport(sessionFile, handlers))));
+            files.push(make.scaffold(editPage, EDIT_PAGE_NEXT(relativeImport(editPage, `${dir}/editor-session.ts`))));
             break;
         }
         case "cloudflare-pages-functions":
-            files.push({ path: copyFile, content: CLOUDFLARE_FUNCTION("copy", relativeImport(copyFile, handlers)) });
-            files.push({ path: sessionFile, content: CLOUDFLARE_FUNCTION("edit-session", relativeImport(sessionFile, handlers)) });
+            files.push(make.machine(copyFile, CLOUDFLARE_FUNCTION("copy", relativeImport(copyFile, handlers))));
+            files.push(make.machine(sessionFile, CLOUDFLARE_FUNCTION("edit-session", relativeImport(sessionFile, handlers))));
             break;
         case "netlify-functions":
-            files.push({ path: copyFile, content: NETLIFY_FUNCTION("copy", relativeImport(copyFile, handlers)) });
-            files.push({ path: sessionFile, content: NETLIFY_FUNCTION("edit-session", relativeImport(sessionFile, handlers)) });
+            files.push(make.machine(copyFile, NETLIFY_FUNCTION("copy", relativeImport(copyFile, handlers))));
+            files.push(make.machine(sessionFile, NETLIFY_FUNCTION("edit-session", relativeImport(sessionFile, handlers))));
             break;
         case "vercel-functions":
-            files.push({ path: copyFile, content: VERCEL_FUNCTION("copy", relativeImport(copyFile, handlers)) });
-            files.push({ path: sessionFile, content: VERCEL_FUNCTION("edit-session", relativeImport(sessionFile, handlers)) });
+            files.push(make.machine(copyFile, VERCEL_FUNCTION("copy", relativeImport(copyFile, handlers))));
+            files.push(make.machine(sessionFile, VERCEL_FUNCTION("edit-session", relativeImport(sessionFile, handlers))));
             break;
         default:
             // next-api-routes, custom-server, unknown: the agent adapts request-handlers (see the instructions).
             break;
     }
-    if (plan.repository.language === "javascript") {
-        return files.map((file) => transpileToJs(file.path, file.content));
-    }
     return files;
 }

package/dist/types.d.ts

@@ -143,6 +143,68 @@ export interface HostIntegration {
     /** Runtime facts the agent and the owner need (filesystem, compatibility flags, variables). */
     readonly notes: readonly string[];
 }
+/**
+ * Who owns a file Refino generated.
+ *
+ * `machine`  Refino's own runtime code. It carries behaviour the editor and
+ *            the hosted service depend on, holds nothing a site is meant to
+ *            hand-write, and Refino refreshes it whenever it can prove the
+ *            bytes on disk are still the ones it wrote.
+ * `scaffold` A generated starting point the owner is invited to restyle (the
+ *            /edit pages). Refino refreshes an untouched one and never
+ *            argues with a restyled one.
+ *
+ * Everything Refino merges rather than owns -- the copy file, package.json,
+ * .env.example, refino.config.json -- is customer-owned and is not in this
+ * vocabulary at all: it is never overwritten, only merged.
+ */
+export type GeneratedOwnership = "machine" | "scaffold";
+/**
+ * What became of one generated file on an init run, or what verification
+ * found there.
+ *
+ * `create`     it did not exist; Refino wrote it.
+ * `current`    the bytes on disk are exactly what this version generates.
+ * `update`     stale, and provably untouched since Refino wrote it, so it was
+ *              (or can be) refreshed in place.
+ * `customized` changed locally, and Refino's own version of it has not moved
+ *              since: nothing to upgrade, nothing to warn about.
+ * `review`     changed locally *and* stale, or impossible to prove untouched.
+ *              Never overwritten; always reported.
+ */
+export type GeneratedFileStatus = "create" | "current" | "update" | "customized" | "review";
+/** One generated file, its ownership, and where its bytes came from. */
+export interface GeneratedFileState {
+    readonly path: string;
+    readonly ownership: GeneratedOwnership;
+    readonly status: GeneratedFileStatus;
+    /** Refino version whose output the bytes on disk match, when that is knowable. */
+    readonly from: string | null;
+    /** Refino version generating the desired bytes. */
+    readonly to: string;
+    /** Why this status, in one sentence. Always set for `review`. */
+    readonly reason: string;
+    /**
+     * For `review`: the repository-relative file Refino wrote the current
+     * template to, beside the original, so the difference can be read and
+     * merged by hand. The original is never touched.
+     */
+    readonly comparisonPath?: string;
+}
+/** `.refino/generated.json`: what Refino wrote, so a later run can tell. */
+export interface GeneratedManifest {
+    readonly version: 1;
+    /** Refino version that last wrote this manifest. */
+    readonly tool: string;
+    readonly files: Readonly<Record<string, GeneratedManifestEntry>>;
+}
+export interface GeneratedManifestEntry {
+    readonly ownership: GeneratedOwnership;
+    /** Refino version that wrote these bytes. */
+    readonly toolVersion: string;
+    /** sha256, hex, of the exact bytes Refino wrote. */
+    readonly sha256: string;
+}
 export interface PlannedFile {
     readonly path: string;
     readonly action: "create" | "merge" | "append" | "modify";
@@ -272,6 +334,19 @@ export interface ApplyResult {
         readonly reason: string;
     }[];
     readonly installCommand: string | null;
+    /**
+     * Every file Refino generates, and what this run did with it. `written`
+     * and `skipped` stay what they always were (the files this run touched or
+     * left alone); this is the upgrade story, and the only place a stale or
+     * locally modified generated file is visible.
+     */
+    readonly generated: readonly GeneratedFileState[];
+    /**
+     * True when a generated file was left in place although Refino's version
+     * of it has moved on. An installation with this set is not current, and no
+     * caller may report it as one.
+     */
+    readonly needsReview: boolean;
 }
 export type CheckStatus = "pass" | "fail" | "warn" | "skip";
 export interface VerificationCheck {