create-nextly-app 0.0.2-alpha.73 → 0.0.2-alpha.74

package/dist/index.cjs

@@ -1,3 +1,3 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_create_nextly = require("./create-nextly-Q62KZJib.cjs");
+const require_create_nextly = require("./create-nextly-Decg8dye.cjs");
 exports.createNextly = require_create_nextly.createNextly;

package/dist/index.mjs

@@ -1 +1 @@
-export { t as createNextly } from "./create-nextly-CuWn_ITx.mjs";
+export { t as createNextly } from "./create-nextly-ChHdzG83.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nextly-app",
-  "version": "0.0.2-alpha.73",
+  "version": "0.0.2-alpha.74",
   "description": "CLI to scaffold Nextly in your Next.js project",
   "license": "MIT",
   "type": "module",
@@ -37,10 +37,10 @@
   },
   "devDependencies": {
     "@babel/types": "^7.29.7",
-    "@nextlyhq/eslint-plugin": "0.0.2-alpha.73",
-    "@nextlyhq/module-specifiers": "0.0.2-alpha.73",
-    "@nextlyhq/telemetry": "0.0.2-alpha.73",
-    "@nextlyhq/tsconfig": "0.0.2-alpha.73",
+    "@nextlyhq/eslint-plugin": "0.0.2-alpha.74",
+    "@nextlyhq/module-specifiers": "0.0.2-alpha.74",
+    "@nextlyhq/telemetry": "0.0.2-alpha.74",
+    "@nextlyhq/tsconfig": "0.0.2-alpha.74",
     "@testing-library/react": "^16.3.0",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.20.5",

package/skills/nextly-authentication/SKILL.md

@@ -7,7 +7,7 @@ description: >-
   code, and extra fields on users. Also use when asked to add login or
   sign-up to a Nextly site, so the answer matches what Nextly provides.
 metadata:
-  nextly-version: 0.0.2-alpha.73
+  nextly-version: 0.0.2-alpha.74
 ---
 
 # Authentication and access in Nextly

package/skills/nextly-collections/SKILL.md

@@ -9,7 +9,7 @@ description: >-
   not appear in the admin, a field change does not reach the database, or a
   page reading content fails to build.
 metadata:
-  nextly-version: 0.0.2-alpha.73
+  nextly-version: 0.0.2-alpha.74
 ---
 
 # Define a collection in Nextly

package/skills/nextly-deploy/SKILL.md

@@ -8,7 +8,7 @@ description: >-
   Also use when a deployed Nextly app has missing tables, refuses to start,
   or loses uploaded files.
 metadata:
-  nextly-version: 0.0.2-alpha.73
+  nextly-version: 0.0.2-alpha.74
 ---
 
 # Deploy a Nextly project

package/skills/nextly-install/SKILL.md

@@ -8,7 +8,7 @@ description: >-
   Nextly install shows no collections, fails to load nextly.config.ts, or its
   admin panel misbehaves after setup.
 metadata:
-  nextly-version: 0.0.2-alpha.73
+  nextly-version: 0.0.2-alpha.74
 ---
 
 # Install Nextly into an existing Next.js app

package/templates/base/src/app/admin/[[...params]]/layout.tsx

@@ -1,8 +1,10 @@
 import { connection } from "next/server";
 import { Suspense } from "react";
 import { getBrandingCss } from "nextly/config";
+import { checkAdminComponents } from "nextly/runtime";
 
 import config from "../../../../nextly.config";
+import { registeredComponentPaths } from "../../../types/generated/plugin-admin-components.generated";
 
 const brandingCss = getBrandingCss(config.admin?.branding);
 
@@ -26,9 +28,15 @@ export default function AdminLayout({
 /**
  * The admin renders for each request, never from a cache another user's
  * request filled. Beneath the layout's Suspense boundary, so under Cache
- * Components the shell above it still prerenders.
+ * Components the shell above it still prerenders: request work outside a
+ * boundary fails the build, in development too, where `checkAdminComponents`
+ * boots nextly.
  */
 async function ForThisRequest({ children }: { children: React.ReactNode }) {
   await connection();
+  // In development, the generated component map is written again when it
+  // falls behind the config, so a plugin added while `next dev` runs draws
+  // its components without a command. In production it does nothing.
+  await checkAdminComponents({ config, registeredComponentPaths });
   return children;
 }

package/templates/base/src/app/layout.tsx

@@ -3,6 +3,11 @@ import "@fontsource-variable/geist";
 import "@fontsource-variable/geist-mono";
 import "./globals.css";
 import { SITE_URL } from "@/lib/site-url";
+// Registers the app's "use cache" read function, and how Nextly starts when a
+// read finds it not started, for every route before any of them reads,
+// during `next build` too: under Cache Components Nextly's cached reads go
+// through that function, and `<SiteCode>` refuses to read without it.
+import "@/nextly/cached-read";
 
 /**
  * The faces are imported as STYLESHEETS from packages in `node_modules`, rather

package/templates/base/src/nextly/cached-read.ts

@@ -0,0 +1,52 @@
+/**
+ * Nextly's cached reads under Cache Components.
+ *
+ * Next.js caches non-fetch reads with `"use cache"` and `cacheTag` once Cache
+ * Components is on, and the directive works only in code Next.js compiles, so
+ * Nextly reads through this function of the app's own. It receives the read's
+ * key, its tags and its lifetime, and runs the reader Nextly registered for
+ * that key. The root layout imports this file, so it is registered on every
+ * route before anything is read: `<SiteCode>` refuses to read without it.
+ *
+ * The same import also tells Nextly how to start with the app's config when a
+ * read finds it not started, so the root layout's import both registers the
+ * cached read and covers a read made before any page starts Nextly, during
+ * `next build` too.
+ *
+ * It works with `cacheComponents: true` and Nextly's cache handlers in
+ * `next.config.ts`, as this app ships:
+ * https://nextlyhq.com/docs/guides/isr-caching#cache-components
+ */
+import { cacheLife, cacheTag } from "next/cache";
+import { getNextly, registerNextlyStart } from "nextly";
+import { registerCachedRead, runRegisteredRead } from "nextly/runtime";
+
+import config from "@nextly-config";
+
+export async function cachedRead(
+  key: string,
+  tags: string[],
+  revalidate: number | false
+): Promise<unknown> {
+  "use cache";
+  cacheTag(...tags);
+  // `revalidate: false` is tag-only, as everywhere in Nextly: only a write
+  // expires the entry, never time. Next.js's "max" profile revalidates monthly.
+  if (revalidate === false) {
+    cacheLife({ revalidate: Infinity, expire: Infinity });
+  } else {
+    // Expired at twice the revalidate, and never within 5 minutes: Next.js
+    // leaves an entry that expires sooner out of a static prerender.
+    cacheLife({ revalidate, expire: Math.max(revalidate * 2, 300) });
+  }
+  return runRegisteredRead(key);
+}
+
+registerCachedRead(cachedRead, process.env.__NEXT_CACHE_COMPONENTS);
+
+// Tells Nextly how this app starts it, for a read that finds it not started,
+// such as the root layout's `<SiteCode>` on `/_not-found` while `next build`
+// prerenders, where nothing else starts it. Nothing starts here: a page that
+// calls `getNextly` first is the start that counts. An app that passes
+// `getNextly` more than its config passes the same options here.
+registerNextlyStart(() => getNextly({ config }));

package/templates/blank/src/app/layout.tsx

@@ -4,6 +4,11 @@ import "@fontsource-variable/jetbrains-mono";
 
 import "./globals.css";
 import { SITE_URL } from "@/lib/site-url";
+// Registers the app's "use cache" read function, and how Nextly starts when a
+// read finds it not started, for every route before any of them reads,
+// during `next build` too: under Cache Components Nextly's cached reads go
+// through that function, and `<SiteCode>` refuses to read without it.
+import "@/nextly/cached-read";
 
 /**
  * The faces are imported as STYLESHEETS from packages in `node_modules`, rather

package/templates/plugin/dev/src/app/layout.tsx

@@ -1,5 +1,11 @@
 import type { ReactNode } from "react";
 
+// Registers the dev app's "use cache" read function, and how Nextly starts
+// when a read finds it not started, for every route before any of them
+// reads, during `next build` too: under Cache Components Nextly's cached
+// reads go through that function, and `<SiteCode>` refuses to read without it.
+import "../nextly/cached-read";
+
 export const metadata = {
   title: "{{pluginName}} — dev playground",
 };

package/templates/plugin/dev/src/nextly/cached-read.ts

@@ -0,0 +1,52 @@
+/**
+ * Nextly's cached reads under Cache Components, for the plugin's dev app.
+ *
+ * Next.js caches non-fetch reads with `"use cache"` and `cacheTag` once Cache
+ * Components is on, and the directive works only in code Next.js compiles, so
+ * Nextly reads through this function of the app's own. It receives the read's
+ * key, its tags and its lifetime, and runs the reader Nextly registered for
+ * that key. The root layout imports this file, so it is registered on every
+ * route before anything is read, as in an app `create-nextly-app` makes.
+ *
+ * The same import also tells Nextly how to start with the app's config when a
+ * read finds it not started, so the root layout's import both registers the
+ * cached read and covers a read made before any page starts Nextly, during
+ * `next build` too.
+ *
+ * It works with `cacheComponents: true` and Nextly's cache handlers in
+ * `next.config.ts`, as this dev app ships:
+ * https://nextlyhq.com/docs/guides/isr-caching#cache-components
+ */
+import { cacheLife, cacheTag } from "next/cache";
+import { getNextly, registerNextlyStart } from "nextly";
+import { registerCachedRead, runRegisteredRead } from "nextly/runtime";
+
+import config from "../../nextly.config";
+
+export async function cachedRead(
+  key: string,
+  tags: string[],
+  revalidate: number | false
+): Promise<unknown> {
+  "use cache";
+  cacheTag(...tags);
+  // `revalidate: false` is tag-only, as everywhere in Nextly: only a write
+  // expires the entry, never time. Next.js's "max" profile revalidates monthly.
+  if (revalidate === false) {
+    cacheLife({ revalidate: Infinity, expire: Infinity });
+  } else {
+    // Expired at twice the revalidate, and never within 5 minutes: Next.js
+    // leaves an entry that expires sooner out of a static prerender.
+    cacheLife({ revalidate, expire: Math.max(revalidate * 2, 300) });
+  }
+  return runRegisteredRead(key);
+}
+
+registerCachedRead(cachedRead, process.env.__NEXT_CACHE_COMPONENTS);
+
+// Tells Nextly how this app starts it, for a read that finds it not started,
+// such as the root layout's `<SiteCode>` on `/_not-found` while `next build`
+// prerenders, where nothing else starts it. Nothing starts here: a page that
+// calls `getNextly` first is the start that counts. An app that passes
+// `getNextly` more than its config passes the same options here.
+registerNextlyStart(() => getNextly({ config }));