vite-wp 0.1.3 → 0.1.7

package/README.md

@@ -66,24 +66,7 @@ my-site/
 
   src/
     live.config.ts
-    pages/
-      [...slug].astro
-    templates/
-      pages/
-        front-page.astro
-        default.astro
-      posts/
-        single.astro
-        archive.astro
-      taxonomies/
-        taxonomy-[taxonomy].astro
-      search.astro
-      404.astro
-    wordpress/
-      client.ts
-      templates.ts
-      menus.ts
-      generated-types.ts
+    templates/             # optional template overrides
 
   wordpress/
     public/              # Composer-installed WordPress core
@@ -96,14 +79,13 @@ my-site/
 
 ## Templates
 
-The catch-all Astro route asks WordPress what the current URL is, then renders the first matching template from `src/templates`.
+ViteWP ships default templates from the package. Create files in `src/templates` only when you want to override them. Project templates always win over package defaults.
 
 Examples:
 
 ```txt
 src/templates/pages/front-page.astro
 src/templates/pages/page-about.astro
-src/templates/pages/default.astro
 src/templates/posts/single.astro
 src/templates/posts/archive.astro
 src/templates/taxonomies/category.astro

package/{starter/src → defaults}/templates/partials/Header.astro

@@ -1,5 +1,5 @@
 ---
-import { getMenuByLocation, getMenuBySlug } from '../../wordpress/menus.js';
+import { getMenuByLocation, getMenuBySlug } from 'vite-wp/wordpress/menus';
 
 interface Props {
   location?: string;

package/{starter/src → defaults}/templates/posts/archive.astro

@@ -1,6 +1,6 @@
 ---
 import Pagination from '../partials/Pagination.astro';
-import type { WpContentItem } from '../../wordpress/client.js';
+import type { WpContentItem } from 'vite-wp/wordpress';
 
 interface Props {
   title?: string;

package/{starter/src → defaults}/templates/search.astro

@@ -1,6 +1,6 @@
 ---
 import Pagination from './partials/Pagination.astro';
-import type { WpContentItem } from '../wordpress/client.js';
+import type { WpContentItem } from 'vite-wp/wordpress';
 
 interface Props {
   title?: string;

package/{starter/src → defaults}/templates/taxonomies/taxonomy-[taxonomy].astro

@@ -1,6 +1,6 @@
 ---
 import Pagination from '../partials/Pagination.astro';
-import type { WpContentItem } from '../../wordpress/client.js';
+import type { WpContentItem } from 'vite-wp/wordpress';
 
 interface Props {
   title?: string;

package/dist/astro.js

@@ -1,10 +1,18 @@
 import { existsSync } from 'node:fs';
+import { join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 export default function vitewp(_options = {}) {
     return {
         name: 'vitewp',
         hooks: {
-            'astro:config:setup': ({ command, addDevToolbarApp, logger }) => {
+            'astro:config:setup': ({ command, config, injectRoute, addDevToolbarApp, logger }) => {
+                if (!hasProjectCatchAllRoute(fileURLToPath(config.root))) {
+                    injectRoute({
+                        pattern: '/[...slug]',
+                        entrypoint: getDefaultRouteEntrypoint(),
+                        prerender: false,
+                    });
+                }
                 if (command === 'dev') {
                     addDevToolbarApp({
                         id: 'vitewp',
@@ -18,6 +26,20 @@ export default function vitewp(_options = {}) {
         },
     };
 }
+function hasProjectCatchAllRoute(root) {
+    return [
+        join(root, 'src/pages/[...slug].astro'),
+        join(root, 'src/pages/[...slug].ts'),
+        join(root, 'src/pages/[...slug].js'),
+    ].some((file) => existsSync(file));
+}
+function getDefaultRouteEntrypoint() {
+    const sourceEntrypoint = new URL('../runtime/route.astro', import.meta.url);
+    if (existsSync(fileURLToPath(sourceEntrypoint))) {
+        return sourceEntrypoint;
+    }
+    return new URL('../runtime/route.astro', import.meta.url);
+}
 function getDevToolbarEntrypoint() {
     const sourceEntrypoint = new URL('./dev-toolbar/vitewp-toolbar.ts', import.meta.url);
     if (existsSync(fileURLToPath(sourceEntrypoint))) {

package/dist/config.js

@@ -17,7 +17,7 @@ export async function loadViteWpConfig(root = process.cwd()) {
         .find((file) => existsSync(file));
     let userConfig = {};
     if (configFile) {
-        const loaded = await loadConfigFromFile({ command: 'serve', mode: 'development' }, configFile, root);
+        const loaded = await loadConfigFromFile({ command: 'serve', mode: 'development' }, configFile, root, undefined, undefined, 'runner');
         userConfig = (loaded?.config ?? {});
     }
     return {

package/dist/dev-toolbar/vitewp-toolbar.d.ts

@@ -12,6 +12,7 @@ interface ViteWpRouteInfo {
     postType: string | null;
     slug: string | null;
     template: string | null;
+    templateSource: 'project' | 'vite-wp' | null;
     totalPages: number | null;
 }
 declare global {

package/dist/dev-toolbar/vitewp-toolbar.js

@@ -98,6 +98,7 @@ function renderInfo(info) {
     <section class="grid">
       ${row('URL path', info.path)}
       ${row('Selected template', info.template ?? 'No template matched')}
+      ${row('Template source', info.templateSource ?? '—')}
       ${row('Live collection', info.liveCollection ? `${info.liveCollection.collection} → ${info.liveCollection.entryId}` : '—')}
       ${row('Post type', info.postType ?? '—')}
       ${row('Slug', info.slug ?? '—')}

package/dist/wordpress/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client.js';
+export * from './menus.js';
+export * from './templates.js';

package/dist/wordpress/index.js

@@ -0,0 +1,3 @@
+export * from './client.js';
+export * from './menus.js';
+export * from './templates.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-wp",
   "private": false,
-  "version": "0.1.3",
+  "version": "0.1.7",
   "type": "module",
   "bin": {
     "vite-wp": "dist/cli.js"
@@ -18,6 +18,26 @@
     "./content": {
       "types": "./dist/content.d.ts",
       "import": "./dist/content.js"
+    },
+    "./wordpress": {
+      "types": "./dist/wordpress/index.d.ts",
+      "import": "./dist/wordpress/index.js"
+    },
+    "./wordpress/client": {
+      "types": "./dist/wordpress/client.d.ts",
+      "import": "./dist/wordpress/client.js"
+    },
+    "./wordpress/menus": {
+      "types": "./dist/wordpress/menus.d.ts",
+      "import": "./dist/wordpress/menus.js"
+    },
+    "./wordpress/templates": {
+      "types": "./dist/wordpress/templates.d.ts",
+      "import": "./dist/wordpress/templates.js"
+    },
+    "./wordpress/schemas": {
+      "types": "./dist/wordpress/schemas.d.ts",
+      "import": "./dist/wordpress/schemas.js"
     }
   },
   "scripts": {
@@ -67,6 +87,8 @@
   },
   "files": [
     "dist",
+    "defaults",
+    "runtime",
     "starter",
     "README.md",
     "LICENSE"

package/{starter/src/pages/[...slug].astro → runtime/route.astro}

@@ -2,8 +2,8 @@
 export const prerender = false;
 
 import { getLiveEntry } from 'astro:content';
-import type { WpResolvedRoute } from '../wordpress/client.js';
-import { createTemplateContext, templateCandidates } from '../wordpress/templates.js';
+import type { WpResolvedRoute } from 'vite-wp/wordpress';
+import { createTemplateContext, templateCandidates } from 'vite-wp/wordpress/templates';
 
 type TemplateModule = {
   default: unknown;
@@ -25,9 +25,11 @@ if (!route) {
   Astro.response.statusText = 'Not Found';
 }
 
-const templates = import.meta.glob<TemplateModule>('../templates/**/*.astro');
+const projectTemplates = import.meta.glob<TemplateModule>('/src/templates/**/*.astro');
+const defaultTemplates = import.meta.glob<TemplateModule>('../defaults/templates/**/*.astro');
 let Template: any = null;
 let templatePath = '';
+let templateSource: 'project' | 'vite-wp' | null = null;
 const showDebug = import.meta.env.DEV;
 let context = null;
 
@@ -36,21 +38,29 @@ if (route) {
   candidates = templateCandidates(route);
 
   for (const candidate of candidates) {
-    const path = `../templates/${candidate}`;
-    const loader = templates[path];
+    const projectPath = `/src/templates/${candidate}`;
+    const defaultPath = `../defaults/templates/${candidate}`;
+    const projectLoader = projectTemplates[projectPath];
+    const defaultLoader = defaultTemplates[defaultPath];
+    const loader = projectLoader ?? defaultLoader;
 
     if (loader) {
       Template = (await loader()).default;
       templatePath = candidate;
+      templateSource = projectLoader ? 'project' : 'vite-wp';
       break;
     }
   }
 } else {
   candidates = ['404.astro'];
-  const loader = templates['../templates/404.astro'];
+  const projectLoader = projectTemplates['/src/templates/404.astro'];
+  const defaultLoader = defaultTemplates['../defaults/templates/404.astro'];
+  const loader = projectLoader ?? defaultLoader;
+
   if (loader) {
     Template = (await loader()).default;
     templatePath = '404.astro';
+    templateSource = projectLoader ? 'project' : 'vite-wp';
   }
 }
 
@@ -68,10 +78,11 @@ const toolbarRouteInfo = showDebug ? {
   page: context?.page ?? null,
   totalPages: context?.totalPages ?? null,
   template: templatePath || null,
+  templateSource,
   candidateTemplates: candidates,
 } : null;
 const toolbarRouteInfoJson = toolbarRouteInfo
-  ? JSON.stringify(toolbarRouteInfo).replaceAll('<', '\\u003c')
+  ? JSON.stringify(toolbarRouteInfo).replaceAll('<', '\u003c')
   : '';
 ---
 <html lang="en">
@@ -85,9 +96,7 @@ const toolbarRouteInfoJson = toolbarRouteInfo
   <body>
     <main>
       {Template && context ? (
-        <>
-          <Template {...context} />
-        </>
+        <Template {...context} />
       ) : Template ? (
         <Template slug={slug} />
       ) : (

package/starter/src/live.config.ts

@@ -1,6 +1,6 @@
 import { defineLiveCollection } from 'astro/content/config';
 import { wpMenuLoader, wpPostTypeLoader, wpRouteLoader } from 'vite-wp/content';
-import { wpContentItemSchema, wpMenuSchema, wpResolvedRouteSchema } from './wordpress/schemas.js';
+import { wpContentItemSchema, wpMenuSchema, wpResolvedRouteSchema } from 'vite-wp/wordpress/schemas';
 
 export const collections = {
   routes: defineLiveCollection({

package/starter/src/wordpress/client.ts

@@ -1,263 +0,0 @@
-export interface WpRenderedField {
-  rendered: string;
-}
-
-export interface WpContentItem {
-  id: number;
-  slug: string;
-  type: string;
-  link: string;
-  title: WpRenderedField;
-  content: WpRenderedField;
-  excerpt?: WpRenderedField;
-  date?: string;
-  modified?: string;
-}
-
-export interface WpArchivePayload {
-  items: WpContentItem[];
-  page: number;
-  perPage: number;
-  total: number;
-  totalPages: number;
-}
-
-interface BaseArchiveResolution {
-  found: true;
-  slug: string;
-  postType: string;
-  restBase: string;
-  title: string;
-  page?: number;
-}
-
-export type WpBridgeResolution =
-  | {
-      found: true;
-      kind: 'page' | 'single';
-      id: number;
-      slug: string;
-      postType: string;
-      restBase: string;
-      isFrontPage?: boolean;
-      isPostsPage?: boolean;
-    }
-  | (BaseArchiveResolution & {
-      kind: 'postsArchive' | 'postTypeArchive';
-    })
-  | (BaseArchiveResolution & {
-      kind: 'taxonomyArchive';
-      taxonomy: string;
-      taxonomyRestBase: string;
-      termId: number;
-      termName: string;
-    })
-  | (BaseArchiveResolution & {
-      kind: 'search';
-      search: string;
-    })
-  | {
-      found: false;
-      kind: 'notFound';
-    };
-
-export type WpResolvedRoute =
-  | {
-      kind: 'page';
-      postType: 'page';
-      restBase: 'pages';
-      slug: string;
-      item: WpContentItem;
-      isFrontPage?: boolean;
-    }
-  | {
-      kind: 'single';
-      postType: string;
-      restBase: string;
-      slug: string;
-      item: WpContentItem;
-    }
-  | {
-      kind: 'postsArchive' | 'postTypeArchive' | 'search';
-      postType: string;
-      restBase: string;
-      slug: string;
-      title: string;
-      items: WpContentItem[];
-      page: number;
-      perPage: number;
-      total: number;
-      totalPages: number;
-      search?: string;
-    }
-  | {
-      kind: 'taxonomyArchive';
-      postType: string;
-      restBase: string;
-      slug: string;
-      title: string;
-      items: WpContentItem[];
-      page: number;
-      perPage: number;
-      total: number;
-      totalPages: number;
-      taxonomy: string;
-      taxonomyRestBase: string;
-      termId: number;
-      termName: string;
-    };
-
-export async function resolveWordPressRoute(pathname: string): Promise<WpResolvedRoute | null> {
-  const resolution = await resolveViaWordPress(pathname);
-
-  if (!resolution.found) {
-    return null;
-  }
-
-  switch (resolution.kind) {
-    case 'postsArchive':
-    case 'postTypeArchive': {
-      const archive = await getArchive({
-        kind: resolution.kind,
-        postType: resolution.postType,
-        page: resolution.page ?? 1,
-      });
-      return {
-        kind: resolution.kind,
-        postType: resolution.postType,
-        restBase: resolution.restBase,
-        slug: resolution.slug,
-        title: resolution.title,
-        ...archive,
-      };
-    }
-    case 'taxonomyArchive': {
-      const archive = await getArchive({
-        kind: resolution.kind,
-        postType: resolution.postType,
-        taxonomy: resolution.taxonomy,
-        termId: resolution.termId,
-        page: resolution.page ?? 1,
-      });
-      return {
-        kind: 'taxonomyArchive',
-        postType: resolution.postType,
-        restBase: resolution.restBase,
-        slug: resolution.slug,
-        title: resolution.title,
-        taxonomy: resolution.taxonomy,
-        taxonomyRestBase: resolution.taxonomyRestBase,
-        termId: resolution.termId,
-        termName: resolution.termName,
-        ...archive,
-      };
-    }
-    case 'search': {
-      const archive = await getArchive({
-        kind: resolution.kind,
-        search: resolution.search,
-        page: resolution.page ?? 1,
-      });
-      return {
-        kind: 'search',
-        postType: resolution.postType,
-        restBase: resolution.restBase,
-        slug: resolution.slug,
-        title: resolution.title,
-        search: resolution.search,
-        ...archive,
-      };
-    }
-    case 'page':
-    case 'single':
-      break;
-  }
-
-  if (resolution.isPostsPage) {
-    const archive = await getArchive({ kind: 'postsArchive', postType: 'post', page: 1 });
-    return {
-      kind: 'postsArchive',
-      postType: 'post',
-      restBase: 'posts',
-      slug: resolution.slug,
-      title: '',
-      ...archive,
-    };
-  }
-
-  const item = await getById(resolution.restBase, resolution.id);
-
-  if (resolution.kind === 'page') {
-    return {
-      kind: 'page',
-      postType: 'page',
-      restBase: 'pages',
-      slug: resolution.slug,
-      item,
-      isFrontPage: resolution.isFrontPage,
-    };
-  }
-
-  return {
-    kind: 'single',
-    postType: resolution.postType,
-    restBase: resolution.restBase,
-    slug: resolution.slug,
-    item,
-  };
-}
-
-export function getWordPressApiBase() {
-  const base = getWordPressBaseUrl();
-  return `${base}/wp-json/wp/v2`;
-}
-
-export function getWordPressBaseUrl() {
-  return (process.env.VITEWP_PUBLIC_URL ?? process.env.WP_URL ?? 'http://localhost:3000').replace(/\/$/, '');
-}
-
-async function resolveViaWordPress(pathname: string) {
-  const url = new URL(`${getWordPressBaseUrl()}/wp-json/vitewp/v1/resolve`);
-  url.searchParams.set('path', pathname || '/');
-
-  const response = await fetch(url);
-
-  if (response.status === 404) {
-    return { found: false, kind: 'notFound' } satisfies WpBridgeResolution;
-  }
-
-  if (!response.ok) {
-    throw new Error(`ViteWP route resolution failed: ${response.status} ${response.statusText}`);
-  }
-
-  return response.json() as Promise<WpBridgeResolution>;
-}
-
-async function getById(restBase: string, id: number) {
-  const url = new URL(`${getWordPressApiBase()}/${restBase}/${id}`);
-  url.searchParams.set('_embed', '1');
-
-  return getJson<WpContentItem>(url);
-}
-
-async function getArchive(params: Record<string, string | number | undefined>) {
-  const url = new URL(`${getWordPressBaseUrl()}/wp-json/vitewp/v1/archive`);
-
-  for (const [key, value] of Object.entries(params)) {
-    if (value !== undefined) {
-      url.searchParams.set(key, String(value));
-    }
-  }
-
-  return getJson<WpArchivePayload>(url);
-}
-
-async function getJson<T>(url: URL): Promise<T> {
-  const response = await fetch(url);
-
-  if (!response.ok) {
-    throw new Error(`WordPress REST request failed: ${response.status} ${response.statusText}`);
-  }
-
-  return response.json() as Promise<T>;
-}

package/starter/src/wordpress/generated-types.ts

@@ -1,38 +0,0 @@
-// Generated by ViteWP. Do not edit by hand.
-
-export type WpPostType = "post" | "page" | "attachment";
-export type WpTaxonomy = "category" | "post_tag";
-
-export type WpRestBaseByPostType = {
-  "post": "posts";
-  "page": "pages";
-  "attachment": "media";
-};
-export type WpArchiveSlugByPostType = {
-  "post": null;
-  "page": null;
-  "attachment": null;
-};
-export type WpRestBaseByTaxonomy = {
-  "category": "categories";
-  "post_tag": "tags";
-};
-
-export interface WpRenderedField {
-  rendered: string;
-  protected?: boolean;
-}
-
-export interface WpContentItem<PostType extends WpPostType = WpPostType> {
-  id: number;
-  slug: string;
-  type: PostType;
-  link: string;
-  title: WpRenderedField;
-  content: WpRenderedField;
-  excerpt?: WpRenderedField;
-  date?: string;
-  modified?: string;
-}
-
-export interface WpArchiveItem<PostType extends WpPostType = WpPostType> extends WpContentItem<PostType> {}

package/starter/src/wordpress/menus.ts

@@ -1,51 +0,0 @@
-import { getWordPressBaseUrl } from './client.js';
-
-export interface WpMenuItem {
-  id: number;
-  parent: number;
-  title: string;
-  url: string;
-  target: string;
-  classes: string[];
-  object: string;
-  objectId: number;
-  type: string;
-}
-
-export interface WpMenu {
-  id: number;
-  slug: string;
-  name: string;
-  items: WpMenuItem[];
-}
-
-export interface WpMenusPayload {
-  locations: Record<string, number>;
-  menus: WpMenu[];
-}
-
-export async function getMenus(): Promise<WpMenusPayload> {
-  const response = await fetch(`${getWordPressBaseUrl()}/wp-json/vitewp/v1/menus`);
-
-  if (!response.ok) {
-    throw new Error(`Could not fetch WordPress menus: ${response.status} ${response.statusText}`);
-  }
-
-  return response.json() as Promise<WpMenusPayload>;
-}
-
-export async function getMenuByLocation(location: string): Promise<WpMenu | null> {
-  const payload = await getMenus();
-  const menuId = payload.locations[location];
-
-  if (!menuId) {
-    return null;
-  }
-
-  return payload.menus.find((menu) => menu.id === menuId) ?? null;
-}
-
-export async function getMenuBySlug(slug: string): Promise<WpMenu | null> {
-  const payload = await getMenus();
-  return payload.menus.find((menu) => menu.slug === slug) ?? null;
-}

package/starter/src/wordpress/schemas.ts

@@ -1,44 +0,0 @@
-import { z } from 'astro/zod';
-
-export const wpRenderedFieldSchema = z.looseObject({
-  rendered: z.string(),
-  protected: z.boolean().optional(),
-});
-
-export const wpContentItemSchema = z.looseObject({
-  id: z.number(),
-  slug: z.string(),
-  type: z.string(),
-  link: z.string(),
-  title: wpRenderedFieldSchema,
-  content: wpRenderedFieldSchema,
-  excerpt: wpRenderedFieldSchema.optional(),
-  date: z.string().optional(),
-  modified: z.string().optional(),
-});
-
-export const wpResolvedRouteSchema = z.looseObject({
-  kind: z.string(),
-  postType: z.string(),
-  restBase: z.string(),
-  slug: z.string(),
-});
-
-export const wpMenuItemSchema = z.looseObject({
-  id: z.number(),
-  parent: z.number(),
-  title: z.string(),
-  url: z.string(),
-  target: z.string(),
-  classes: z.array(z.string()),
-  object: z.string(),
-  objectId: z.number(),
-  type: z.string(),
-});
-
-export const wpMenuSchema = z.looseObject({
-  id: z.number(),
-  slug: z.string(),
-  name: z.string(),
-  items: z.array(wpMenuItemSchema),
-});

package/starter/src/wordpress/templates.ts

@@ -1,113 +0,0 @@
-import type { WpContentItem, WpResolvedRoute } from './client.js';
-
-export interface TemplateContext {
-  route: WpResolvedRoute;
-  title: string;
-  content: string;
-  excerpt: string;
-  slug: string;
-  postType: string;
-  items: WpContentItem[];
-  page: number;
-  perPage: number;
-  total: number;
-  totalPages: number;
-  search?: string;
-  taxonomy?: string;
-  termName?: string;
-}
-
-export function createTemplateContext(route: WpResolvedRoute): TemplateContext {
-  switch (route.kind) {
-    case 'postsArchive':
-    case 'postTypeArchive':
-    case 'search':
-      return {
-        route,
-        title: route.title,
-        content: '',
-        excerpt: '',
-        slug: route.slug,
-        postType: route.postType,
-        items: route.items,
-        page: route.page,
-        perPage: route.perPage,
-        total: route.total,
-        totalPages: route.totalPages,
-        search: route.search,
-      };
-    case 'taxonomyArchive':
-      return {
-        route,
-        title: route.title,
-        content: '',
-        excerpt: '',
-        slug: route.slug,
-        postType: route.postType,
-        items: route.items,
-        page: route.page,
-        perPage: route.perPage,
-        total: route.total,
-        totalPages: route.totalPages,
-        taxonomy: route.taxonomy,
-        termName: route.termName,
-      };
-    case 'page':
-    case 'single':
-      return {
-        route,
-        title: route.item.title.rendered,
-        content: route.item.content.rendered,
-        excerpt: route.item.excerpt?.rendered ?? '',
-        slug: route.slug,
-        postType: route.postType,
-        items: [],
-        page: 1,
-        perPage: 0,
-        total: 0,
-        totalPages: 0,
-      };
-  }
-}
-
-export function templateCandidates(route: WpResolvedRoute): string[] {
-  if (route.kind === 'search') {
-    return ['search.astro', 'posts/archive.astro'];
-  }
-
-  if (route.kind === 'taxonomyArchive') {
-    return [
-      `taxonomies/${route.taxonomy}-${route.slug}.astro`,
-      `taxonomies/${route.taxonomy}.astro`,
-      'taxonomies/taxonomy-[taxonomy].astro',
-      'posts/archive.astro',
-    ];
-  }
-
-  if (route.kind === 'postsArchive') {
-    return ['posts/archive.astro'];
-  }
-
-  if (route.kind === 'postTypeArchive') {
-    return [
-      `post-types/${route.postType}/archive.astro`,
-      'posts/archive.astro',
-    ];
-  }
-
-  if (route.kind === 'page') {
-    return [
-      ...(route.isFrontPage ? ['pages/front-page.astro'] : []),
-      `pages/page-${route.slug}.astro`,
-      'pages/default.astro',
-    ];
-  }
-
-  return [
-    `post-types/${route.postType}/single-${route.slug}.astro`,
-    `post-types/${route.postType}/single.astro`,
-    ...(route.postType === 'post' ? [] : ['posts/single.astro']),
-    `posts/single-${route.slug}.astro`,
-    'posts/single.astro',
-  ];
-}