e0cc87118c
nuxt-site-config copies every NUXT_SITE_* variable into the public site config, so NUXT_SITE_CACHE_PURGE_TOKEN reached every page's payload as cachePurgeToken (and NUXT_SITE_CACHE_ALLOW_PROXIED as cacheAllowProxied). - The purge settings move to runtimeConfig cachePurge.token (NUXT_CACHE_PURGE_TOKEN) and cachePurge.allowProxied (NUXT_CACHE_PURGE_ALLOW_PROXIED), outside that prefix. - The old siteCache.* names keep working for one release: a non-empty new token wins, either allowProxied flag turns it on, and one deprecation warning per process names the variables (never a value). - The shared Nitro plugin server/plugins/site-cache-purge.ts strips cachePurgeToken and cacheAllowProxied from nuxt-site-config's stack on site-config:init, so a site on the old names leaks nothing either; it does nothing without nuxt-site-config. - The shared lib, route and plugin and tests/sitePurge.test.ts are byte-identical in vue-journal-layer, vue-menu-layer and vue-faq-layer, with three sha256 pins. - README: new names, the deprecation, the stripping and the advice to rotate a token ever set under the old name.
95 lines
4.0 KiB
TypeScript
95 lines
4.0 KiB
TypeScript
// vue-journal-layer: reusable Journal views as a Nuxt layer. An app consumes
|
|
// it with `extends: ['vue-journal-layer']`.
|
|
//
|
|
// Every path below is absolute and built from this file's directory: a
|
|
// relative or ~ path in a layer config resolves against the consuming
|
|
// project, not the layer.
|
|
import { fileURLToPath } from 'node:url'
|
|
|
|
const currentDir = fileURLToPath(new URL('.', import.meta.url))
|
|
|
|
export default defineNuxtConfig({
|
|
compatibilityDate: '2025-07-15',
|
|
devtools: { enabled: false },
|
|
|
|
// The consuming app may have no app/pages directory; the Journal pages are
|
|
// registered by the journal module, so the router must be on regardless.
|
|
pages: true,
|
|
|
|
// Declared once here, so the app never re-lists them (two copies of
|
|
// @nuxtjs/i18n split locale state).
|
|
modules: ['@nuxt/fonts', '@nuxtjs/i18n', '@nuxtjs/seo', `${currentDir}lib/journal-module.ts`],
|
|
|
|
// Tokens first, then the neutral styles that use them. The app's own css
|
|
// array loads after these, so its token overrides win.
|
|
css: [`${currentDir}app/assets/css/journal-tokens.css`, `${currentDir}app/assets/css/journal-base.css`],
|
|
|
|
runtimeConfig: {
|
|
journal: {
|
|
// Server-only base for SSR fetches (NUXT_JOURNAL_API_BASE). It never
|
|
// comes from request input.
|
|
apiBase: 'http://127.0.0.1:8096/_journal/api/v1',
|
|
// Server-only bearer token of the old Journal purge route
|
|
// POST /api/__journal__/cache/purge (NUXT_JOURNAL_CACHE_PURGE_TOKEN),
|
|
// kept for one release; new sites use cachePurge.token. Shorter
|
|
// than 32 characters, the route answers 404.
|
|
cachePurgeToken: '',
|
|
},
|
|
cachePurge: {
|
|
// Server-only bearer token of the shared site cache purge route
|
|
// POST /api/__site__/cache/purge (NUXT_CACHE_PURGE_TOKEN), the
|
|
// backend's site_cache.purge_token. Shorter than 32 characters, the
|
|
// route answers 404. Not under NUXT_SITE_: nuxt-site-config copies
|
|
// every NUXT_SITE_* variable into the site config, which is published
|
|
// in every page's payload.
|
|
token: '',
|
|
// NUXT_CACHE_PURGE_ALLOW_PROXIED: set it to true when the backend
|
|
// reaches the site through a TLS-terminating proxy (an https
|
|
// site_cache.purge_url on another host), which adds X-Forwarded-For,
|
|
// X-Real-IP or Forwarded. The route then accepts proxied requests and
|
|
// the bearer token is the only gate; unset, it answers 404 to any
|
|
// proxied request.
|
|
allowProxied: false,
|
|
},
|
|
// Deprecated (one release): the earlier names of cachePurge.token
|
|
// (NUXT_SITE_CACHE_PURGE_TOKEN) and cachePurge.allowProxied
|
|
// (NUXT_SITE_CACHE_ALLOW_PROXIED), read when the new ones are unset. The
|
|
// layer's server/plugins/site-cache-purge.ts strips them from the site
|
|
// config and logs a deprecation warning.
|
|
siteCache: {
|
|
purgeToken: '',
|
|
allowProxied: false,
|
|
},
|
|
public: {
|
|
journal: {
|
|
// Same-origin base for browser fetches (NUXT_PUBLIC_JOURNAL_API_BASE).
|
|
apiBase: '/_journal/api/v1',
|
|
},
|
|
},
|
|
},
|
|
|
|
// The Journal's internal routes and the shared site routes are never
|
|
// route-cached. Nitro wraps every handler matching an app rule such as
|
|
// '/**': { swr } in its cached handler, which keys by path, does not skip
|
|
// POST and hides request headers, so the purge routes would answer from the
|
|
// cache without running.
|
|
routeRules: {
|
|
'/api/__journal__/**': { cache: false },
|
|
'/api/__site__/**': { cache: false },
|
|
},
|
|
|
|
// No OG image rendering at runtime.
|
|
ogImage: { enabled: false },
|
|
|
|
// Paginated listings keep ?page=N in their canonical URL. nuxt-seo-utils
|
|
// already whitelists page by default; set explicitly to lock the behaviour.
|
|
seo: { canonicalQueryWhitelist: ['page'] },
|
|
|
|
// Journal posts and categories come from the API through the layer's
|
|
// sitemap source; locs are built from journal.routes. One flat sitemap.
|
|
sitemap: { sources: ['/api/__sitemap__/journal'], autoI18n: false },
|
|
|
|
// i18n: the layer declares no locales. The journal module registers the
|
|
// layer's pl/en strings only for locales the app enables.
|
|
})
|