create-shapio 0.5.8 → 0.5.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-shapio",
-  "version": "0.5.8",
+  "version": "0.5.9",
   "description": "Scaffold a new Shapio project (npx create-shapio my-cms) or a site starter (--site astro|next|sveltekit)",
   "license": "Apache-2.0",
   "homepage": "https://shapio.dev",

package/templates/astro/package.json

@@ -22,8 +22,8 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.8",
-    "@shapio/visual": "^0.5.8",
+    "@shapio/client": "^0.5.9",
+    "@shapio/visual": "^0.5.9",
     "astro": "7.3.5"
   },
   "devDependencies": {

package/templates/astro/scripts/incrementalBuild.ts

@@ -74,21 +74,29 @@ const slugAt = async (change: SnapshotChange, locale: string, snapshot: number):
 };
 
 /**
- * The models whose entries have a route of their own, found by slug. Any other model (a redirect type a user
- * adds, say) maps to no route here: it may have no `slug` field, and Astro's incremental build still decides
- * page by page what to rebuild.
+ * The route key of the change's family root. A type that extends another is listed under a nested route key
+ * (`articles/guides`); its entries are in the root's list and use the root's pages, so a Guide that extends
+ * Article rebuilds article pages.
  */
-const SLUG_ROUTED_MODELS = new Set(['page', 'article']);
+const familyOf = (change: SnapshotChange): string => change.routeKey.split('/')[0] ?? change.routeKey;
+
+/**
+ * The families whose entries have a route of their own, found by slug (by their root's route key). Any other
+ * model (a redirect type a user adds, say) maps to no route here: it may have no `slug` field, and Astro's
+ * incremental build still decides page by page what to rebuild.
+ */
+const SLUG_ROUTED_FAMILIES = new Set(['pages', 'articles']);
 
 /** Site routes (src/pages) an entry change touches. */
 const routesOf = async (change: SnapshotChange, from: number, to: number): Promise<string[]> => {
   const routes: string[] = [];
+  const family = familyOf(change);
   for (const { locale, change: kind } of change.locales) {
-    if (change.modelKey === 'author') {
+    if (family === 'authors') {
       routes.push(`/${locale}/articles/`);
       continue;
     }
-    if (!SLUG_ROUTED_MODELS.has(change.modelKey)) {
+    if (!SLUG_ROUTED_FAMILIES.has(family)) {
       continue;
     }
     // An unpublished entry's route is where it was; the others are where they are now.
@@ -96,9 +104,9 @@ const routesOf = async (change: SnapshotChange, from: number, to: number): Promi
     if (slug === null) {
       continue;
     }
-    if (change.modelKey === 'page') {
+    if (family === 'pages') {
       routes.push(slug === 'home' ? `/${locale}/` : `/${locale}/${slug}/`);
-    } else if (change.modelKey === 'article') {
+    } else if (family === 'articles') {
       routes.push(`/${locale}/articles/${slug}/`, `/${locale}/articles/`);
     }
   }

package/templates/astro/src/lib/preview.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, it } from 'vitest';
+import { parsePreviewUrl } from './preview.js';
+
+const url = (model: string) =>
+  new URL(`http://localhost:4321/preview/?model=${encodeURIComponent(model)}&id=e1&locale=fr#token=shpv_x`);
+
+describe('parsePreviewUrl', () => {
+  it('reads an allowlisted route key', () => {
+    expect(parsePreviewUrl(url('articles'))).toEqual({
+      token: 'shpv_x',
+      modelKey: 'articles',
+      family: 'articles',
+      entryId: 'e1',
+      locale: 'fr',
+    });
+  });
+
+  it('accepts a type nested under an allowlisted one and renders it as its family', () => {
+    expect(parsePreviewUrl(url('articles/guides'))).toMatchObject({
+      modelKey: 'articles/guides',
+      family: 'articles',
+    });
+  });
+
+  it('refuses other models and anything that is not a route key', () => {
+    expect(parsePreviewUrl(url('authors'))).toBeUndefined();
+    expect(parsePreviewUrl(url('authors/articles'))).toBeUndefined();
+    expect(parsePreviewUrl(url('articles/../admin'))).toBeUndefined();
+    expect(parsePreviewUrl(url('articles/'))).toBeUndefined();
+  });
+});

package/templates/astro/src/lib/preview.ts

@@ -6,36 +6,59 @@ import type { Article, DeliveryItem, Page } from './types.js';
 /**
  * Preview: Shapio opens `/preview/?model={modelKey}&id={entryId}&locale={locale}#token={token}` (the
  * connection's preview URL template). `{modelKey}` is the model's route key, as in the delivery and preview
- * APIs: the plural API ID of a collection (`pages`, `articles`). The token sits in the fragment, so it never reaches a server log or a
+ * APIs: the plural API ID of a collection (`pages`, `articles`), nested under its parent's for a type that
+ * extends another (`articles/guides`). The token sits in the fragment, so it never reaches a server log or a
  * Referer header; it is a scoped, expiring preview token, never an admin credential. The draft is read from
  * `/api/preview/content/...` and rendered with the same functions as the published pages.
  */
 export const PREVIEW_MODELS = ['pages', 'articles'] as const;
 
+/** One API ID: what each segment of a route key must be. */
+const API_ID = /^[_A-Za-z][_0-9A-Za-z]*$/;
+
 export type PreviewRequest = {
   token: string;
-  modelKey: (typeof PREVIEW_MODELS)[number];
+  /** The route key from the URL: one of PREVIEW_MODELS, or a type nested under one (`articles/guides`). */
+  modelKey: string;
+  /** The family root the draft renders as: a type that extends Article renders as an article. */
+  family: (typeof PREVIEW_MODELS)[number];
   entryId: string;
   locale: string;
 };
 
+/** The allowlisted family of a route key, or undefined for anything else. */
+const familyOf = (modelKey: string): PreviewRequest['family'] | undefined => {
+  const segments = modelKey.split('/');
+  const root = segments[0] ?? '';
+  return segments.every((segment) => API_ID.test(segment)) &&
+    (PREVIEW_MODELS as readonly string[]).includes(root)
+    ? (root as PreviewRequest['family'])
+    : undefined;
+};
+
 /** Reads the request from a preview URL; undefined when something is missing or unknown. */
 export const parsePreviewUrl = (url: URL): PreviewRequest | undefined => {
   const fragment = new URLSearchParams(url.hash.slice(1));
   const token = fragment.get('token') ?? url.searchParams.get('token');
-  const modelKey = url.searchParams.get('model');
+  const modelKey = url.searchParams.get('model') ?? '';
   const entryId = url.searchParams.get('id');
-  if (!token || !entryId || !(PREVIEW_MODELS as readonly string[]).includes(modelKey ?? '')) {
+  const family = familyOf(modelKey);
+  if (!token || !entryId || !family) {
     return undefined;
   }
   return {
     token,
-    modelKey: modelKey as PreviewRequest['modelKey'],
+    modelKey,
+    family,
     entryId,
     locale: url.searchParams.get('locale') ?? DEFAULT_LOCALE,
   };
 };
 
+/** The preview API path of a route key: each segment encoded, the `/` between them kept. */
+const previewPath = (modelKey: string, entryId: string) =>
+  `/api/preview/content/${modelKey.split('/').map(encodeURIComponent).join('/')}/${encodeURIComponent(entryId)}`;
+
 /** Fetches the draft through the preview API and renders it. */
 export const loadPreview = async (
   shapioUrl: string,
@@ -45,14 +68,14 @@ export const loadPreview = async (
   const params = new URLSearchParams({
     locale: request.locale,
     richText: 'html',
-    ...(request.modelKey === 'articles' ? { populate: 'author' } : {}),
+    ...(request.family === 'articles' ? { populate: 'author' } : {}),
   });
   const { data } = await client.request<DeliveryItem<Page | Article>>(
-    `/api/preview/content/${encodeURIComponent(request.modelKey)}/${encodeURIComponent(request.entryId)}?${params.toString()}`,
+    `${previewPath(request.modelKey, request.entryId)}?${params.toString()}`,
   );
   const context = { locale: request.locale, strings: stringsFor(request.locale) };
   return {
     title: data.title,
-    html: request.modelKey === 'pages' ? renderPage(data as Page) : renderArticle(data as Article, context),
+    html: request.family === 'pages' ? renderPage(data as Page) : renderArticle(data as Article, context),
   };
 };

package/templates/next/package.json

@@ -18,9 +18,9 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.8",
-    "@shapio/local": "0.5.8",
-    "@shapio/visual": "^0.5.8",
+    "@shapio/client": "^0.5.9",
+    "@shapio/local": "0.5.9",
+    "@shapio/visual": "^0.5.9",
     "next": "16.3.8",
     "react": "19.3.0",
     "react-dom": "19.3.0"

package/templates/next/src/lib/revalidationTags.test.ts

@@ -23,6 +23,25 @@ describe('changeTags', () => {
     ]);
   });
 
+  it("revalidates a child kind's entry under its own route key and every ancestor's", () => {
+    expect(
+      changeTags(
+        [
+          { routeKey: 'posts/guides', id: 'g1' },
+          { routeKey: 'posts', id: 'p1' },
+        ],
+        false,
+        undefined,
+      ),
+    ).toEqual([
+      'shapio:posts',
+      'shapio:posts/guides',
+      'shapio:posts/guides:g1',
+      'shapio:posts:g1',
+      'shapio:posts:p1',
+    ]);
+  });
+
   it('revalidates the site tag (every read) after a schema change', () => {
     expect(changeTags([{ routeKey: 'articles', id: 'a1' }], true, 'marketing')).toEqual([
       'shapio:site:marketing',

package/templates/next/src/lib/revalidationTags.ts

@@ -12,8 +12,9 @@ export const siteTags = (siteKey: string | undefined): string[] => [shapioTags.s
 
 /**
  * The tags to revalidate for the entries that changed between two snapshots: each entry's model and the entry
- * itself. A schema change (fields added, converted or removed) can change any read, so it revalidates the
- * site tag, which every read carries.
+ * itself, under its route key and every ancestor's (a Guide that extends Post is also in the Posts list, so
+ * `posts/guides` revalidates `posts` too). A schema change (fields added, converted or removed) can change any
+ * read, so it revalidates the site tag, which every read carries.
  */
 export const changeTags = (
   changes: readonly ChangedEntryRef[],
@@ -23,8 +24,6 @@ export const changeTags = (
   if (schemaChanged) {
     return siteTags(siteKey);
   }
-  const tags = new Set(
-    changes.flatMap(({ routeKey, id }) => [shapioTags.model(routeKey), shapioTags.entry(routeKey, id)]),
-  );
+  const tags = new Set(changes.flatMap(({ routeKey, id }) => shapioTags.changed(routeKey, id)));
   return [...tags].sort();
 };

package/templates/sveltekit/package.json

@@ -23,8 +23,8 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.8",
-    "@shapio/visual": "^0.5.8"
+    "@shapio/client": "^0.5.9",
+    "@shapio/visual": "^0.5.9"
   },
   "devDependencies": {
     "@sveltejs/adapter-static": "4.0.0",