@pylonsync/sdk 0.3.316 → 0.3.318

package/dist/index.d.ts

@@ -321,7 +321,7 @@ export interface RouteDefinition {
      * POST/PUT/PATCH/DELETE) — matched on its `path` for non-GET requests only,
      * never rendered as a page.
      */
-    kind?: "page" | "not-found" | "error" | "route" | "sitemap" | "robots";
+    kind?: "page" | "not-found" | "error" | "route" | "sitemap" | "robots" | "og-image";
 }
 export declare function defineRoute(route: RouteDefinition): RouteDefinition;
 export interface InputFieldDefinition {
@@ -474,7 +474,7 @@ export interface ManifestRoute {
     component?: string;
     layouts?: string[];
     /** "not-found" / "error" boundaries, or "route" form handlers; omitted for normal pages. */
-    kind?: "page" | "not-found" | "error" | "route" | "sitemap" | "robots";
+    kind?: "page" | "not-found" | "error" | "route" | "sitemap" | "robots" | "og-image";
 }
 export interface ManifestInputField {
     name: string;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.316",
+  "version": "0.3.318",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./dist/index.d.ts",

package/src/index.ts

@@ -429,7 +429,14 @@ export interface RouteDefinition {
    * POST/PUT/PATCH/DELETE) — matched on its `path` for non-GET requests only,
    * never rendered as a page.
    */
-  kind?: "page" | "not-found" | "error" | "route" | "sitemap" | "robots";
+  kind?:
+    | "page"
+    | "not-found"
+    | "error"
+    | "route"
+    | "sitemap"
+    | "robots"
+    | "og-image";
 }
 
 export function defineRoute(route: RouteDefinition): RouteDefinition {
@@ -630,7 +637,14 @@ export interface ManifestRoute {
   component?: string;
   layouts?: string[];
   /** "not-found" / "error" boundaries, or "route" form handlers; omitted for normal pages. */
-  kind?: "page" | "not-found" | "error" | "route" | "sitemap" | "robots";
+  kind?:
+    | "page"
+    | "not-found"
+    | "error"
+    | "route"
+    | "sitemap"
+    | "robots"
+    | "og-image";
 }
 
 export interface ManifestInputField {
@@ -990,6 +1004,11 @@ export async function discoverAppRoutes(opts?: {
   const pages: PageHit[] = [];
   const boundaries: BoundaryHit[] = [];
   const routeHandlers: RouteHandlerHit[] = [];
+  // `opengraph-image.{tsx,ts,jsx,js}` colocated with any segment. Each
+  // default-exports a function returning an `ImageResponse` (or React
+  // element); the SSR runtime renders it to a PNG on demand and pages under
+  // the segment get an auto `og:image` meta tag pointing at it.
+  const ogImages: RouteHandlerHit[] = [];
 
   // Resolve the first existing `<base>.{tsx,ts,jsx,js}` in `dir` and
   // return it as a cwd-relative, extension-less module path (or null).
@@ -1045,6 +1064,12 @@ export async function discoverAppRoutes(opts?: {
     if (routeHere) {
       routeHandlers.push({ segments: [...segments], component: routeHere });
     }
+    // Dynamic OG image colocated with this segment. Rendered to PNG on
+    // demand; never navigable/hydrated.
+    const ogImageHere = findModule(dir, "opengraph-image");
+    if (ogImageHere) {
+      ogImages.push({ segments: [...segments], component: ogImageHere });
+    }
     for (const e of entries) {
       if (!e.isDirectory()) continue;
       if (e.name.startsWith(".") || e.name === "node_modules") continue;
@@ -1152,7 +1177,26 @@ export async function discoverAppRoutes(opts?: {
     });
   }
 
-  return [...pageRoutes, ...boundaryRoutes, ...routeRoutes, ...dataRoutes];
+  // Dynamic OG image routes: `<segment>/opengraph-image` (root → just
+  // `/opengraph-image`). Matched like a page (params flow through) but
+  // served as a PNG by the SSR runtime — never rendered as HTML or hydrated.
+  const ogImageRoutes: RouteDefinition[] = ogImages.map((o) => ({
+    path:
+      o.segments.length === 0
+        ? "/opengraph-image"
+        : `${segmentsToPath(o.segments)}/opengraph-image`,
+    mode: "ssr" as const,
+    component: o.component,
+    kind: "og-image" as const,
+  }));
+
+  return [
+    ...pageRoutes,
+    ...boundaryRoutes,
+    ...routeRoutes,
+    ...dataRoutes,
+    ...ogImageRoutes,
+  ];
 }
 
 export function queriesToManifest(queries: QueryDefinition[]): ManifestQuery[] {

package/src/route-discovery.test.ts

@@ -0,0 +1,85 @@
+// Route discovery (discoverAppRoutes) — the app/ file-convention walk. Focus
+// here is the dynamic OG image convention (app/**/opengraph-image.tsx →
+// kind:"og-image"), which must produce a matchable route at
+// `<segment>/opengraph-image` (root → `/opengraph-image`) alongside the page.
+
+import { afterEach, describe, expect, test } from "bun:test";
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import { discoverAppRoutes } from "./index";
+
+describe("discoverAppRoutes — opengraph-image convention", () => {
+  const tmpdirs: string[] = [];
+  const prevCwd = process.cwd();
+  afterEach(() => {
+    process.chdir(prevCwd);
+    for (const d of tmpdirs.splice(0)) {
+      try {
+        fs.rmSync(d, { recursive: true, force: true });
+      } catch {
+        /* best effort */
+      }
+    }
+  });
+
+  // Materialize an app/ tree (relative file paths → contents) and chdir in.
+  function app(files: Record<string, string>): void {
+    const root = fs.mkdtempSync(path.join(os.tmpdir(), "pylon-routes-"));
+    tmpdirs.push(root);
+    for (const [rel, src] of Object.entries(files)) {
+      const abs = path.join(root, "app", rel);
+      fs.mkdirSync(path.dirname(abs), { recursive: true });
+      fs.writeFileSync(abs, src);
+    }
+    process.chdir(root);
+  }
+
+  const PAGE = "export default function P(){ return null; }";
+  const OG = "export default function OG(){ return null; }";
+
+  test("root opengraph-image → /opengraph-image kind:og-image", async () => {
+    app({ "page.tsx": PAGE, "opengraph-image.tsx": OG });
+    const routes = await discoverAppRoutes();
+    const og = routes.find((r) => r.path === "/opengraph-image");
+    expect(og).toBeDefined();
+    expect(og!.kind).toBe("og-image");
+    expect(og!.mode).toBe("ssr");
+    // The component points at the module (not "/page").
+    expect(og!.component).toMatch(/opengraph-image$/);
+  });
+
+  test("nested + dynamic-param segment → concrete pattern path", async () => {
+    app({
+      "page.tsx": PAGE,
+      "blog/[slug]/page.tsx": PAGE,
+      "blog/[slug]/opengraph-image.tsx": OG,
+    });
+    const routes = await discoverAppRoutes();
+    const og = routes.find((r) => r.kind === "og-image");
+    expect(og).toBeDefined();
+    // Dynamic segment tokenizes to `:slug`, matching the page route pattern.
+    expect(og!.path).toBe("/blog/:slug/opengraph-image");
+  });
+
+  test("multiple opengraph-images coexist (root default + per-section)", async () => {
+    app({
+      "page.tsx": PAGE,
+      "opengraph-image.tsx": OG,
+      "shop/page.tsx": PAGE,
+      "shop/opengraph-image.tsx": OG,
+    });
+    const routes = await discoverAppRoutes();
+    const ogPaths = routes
+      .filter((r) => r.kind === "og-image")
+      .map((r) => r.path)
+      .sort();
+    expect(ogPaths).toEqual(["/opengraph-image", "/shop/opengraph-image"]);
+  });
+
+  test("no opengraph-image → no og-image routes", async () => {
+    app({ "page.tsx": PAGE });
+    const routes = await discoverAppRoutes();
+    expect(routes.some((r) => r.kind === "og-image")).toBe(false);
+  });
+});