@towa-digital/storyblok-nuxt-cv 0.1.3 → 0.2.0

package/README.md

@@ -60,7 +60,7 @@ built-in webhook route are on by default.
 
 Then create a **story publish webhook** in Storyblok
 (Settings → Webhooks, story events) pointing at
-`https://<site>/api/storyblokCvWebhook`, set a secret, and provide it as
+`https://<site>/api/storyblok-cv-webhook`, set a secret, and provide it as
 `NUXT_STORYBLOK_CV_WEBHOOK_SECRET`.
 
 ## Configuration
@@ -69,10 +69,11 @@ Then create a **story publish webhook** in Storyblok
 export default defineNuxtConfig({
   storyblokCv: {
     token: undefined,          // default: auto-detected from @storyblok/nuxt config; env NUXT_STORYBLOK_CV_TOKEN
-    region: 'eu',              // eu | us | ap | ca | cn — or apiHost: 'https://...'
+    region: 'eu',              // eu | us | ap | ca | cn
+    endpoint: undefined,       // full API endpoint incl. /v2 (like @storyblok/nuxt); overrides region — for proxied spaces
     storage: 'storyblok-cv',   // nitro storage mount name
-    endpoint: '/api/storyblokCv',        // GET current cv; false to disable
-    webhook: true,             // built-in route /api/storyblokCvWebhook; string = custom route; false = use refreshStoryblokCv() yourself
+    statusRoute: '/api/storyblok-cv',     // GET current cv; false to disable
+    webhook: true,             // built-in route /api/storyblok-cv-webhook; string = custom route; false = use refreshStoryblokCv() yourself
     ttl: false,                // e.g. 60_000 — background refresh when the stored cv is older (serverless/multi-instance)
     onStartup: true,           // populate the store once at boot
   },
@@ -146,7 +147,7 @@ Prefer throttling over hard filtering if you reach for this.
 Don't trust a single "looks fresh" check. Use the lab method from the audit
 playbook (`docs/detection.md` Step 7): instrumented production build, publish
 via **form mode** (not the visual editor), sample repeatedly, test the warmed
-URL shape. Quick sanity check in production: `GET /api/storyblokCv` before and
+URL shape. Quick sanity check in production: `GET /api/storyblok-cv` before and
 after a publish — the value must change without a restart.
 
 ## Development

package/dist/module.d.mts

@@ -11,21 +11,27 @@ interface ModuleOptions {
      * Overridable at runtime via `NUXT_STORYBLOK_CV_TOKEN`.
      */
     token?: string;
-    /** Storyblok API region. Ignored when `apiHost` is set. */
+    /** Storyblok API region. Ignored when `endpoint` is set. */
     region?: 'eu' | 'us' | 'ap' | 'ca' | 'cn';
-    /** Full API host override, e.g. for proxies. */
-    apiHost?: string;
+    /**
+     * Full Storyblok API endpoint **including the version segment**, exactly as
+     * `@storyblok/nuxt` / storyblok-js-client expect it (e.g.
+     * `https://api.storyblok.com/v2`). Set this for proxied spaces — pass the
+     * same value as the render client's `apiOptions.endpoint`, no surgery. When
+     * unset, derived from `region`.
+     */
+    endpoint?: string;
     /**
      * Nitro storage mount the `cv` is stored under. The default (unmounted) is
      * per-process memory — fine for a single Node process. For PM2 cluster mount
      * an `fs` driver, for multi-node mount Redis, in the host's `nitro.storage`.
      */
     storage?: string;
-    /** GET endpoint exposing the current `cv` (client re-pins, debugging). `false` disables. */
-    endpoint?: string | false;
+    /** GET route exposing the current `cv` (client re-pins, debugging). `false` disables. */
+    statusRoute?: string | false;
     /**
      * Built-in Storyblok publish webhook. `true` registers it at
-     * `/api/storyblokCvWebhook`, a string sets the route, `false` disables it —
+     * `/api/storyblok-cv-webhook`, a string sets the route, `false` disables it —
      * then call the auto-imported `refreshStoryblokCv()` from your own webhook
      * handler instead. Requires `NUXT_STORYBLOK_CV_WEBHOOK_SECRET`.
      */
@@ -46,7 +52,7 @@ declare module '@nuxt/schema' {
     interface RuntimeConfig {
         storyblokCv: {
             token: string;
-            apiHost: string;
+            endpoint: string;
             storage: string;
             ttl: number;
             onStartup: boolean;

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=3.10.0"
   },
-  "version": "0.1.3",
+  "version": "0.2.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -1,12 +1,12 @@
 import { defineNuxtModule, createResolver, useLogger, addServerHandler, addServerPlugin, addServerImports, addPlugin, addTypeTemplate } from '@nuxt/kit';
 import { defu } from 'defu';
 
-const API_HOSTS = {
-  eu: "https://api.storyblok.com",
-  us: "https://api-us.storyblok.com",
-  ap: "https://api-ap.storyblok.com",
-  ca: "https://api-ca.storyblok.com",
-  cn: "https://api.storyblokchina.cn"
+const API_ENDPOINTS = {
+  eu: "https://api.storyblok.com/v2",
+  us: "https://api-us.storyblok.com/v2",
+  ap: "https://api-ap.storyblok.com/v2",
+  ca: "https://api-ca.storyblok.com/v2",
+  cn: "https://api.storyblokchina.cn/v2"
 };
 const module$1 = defineNuxtModule({
   meta: {
@@ -19,7 +19,7 @@ const module$1 = defineNuxtModule({
     debug: false,
     region: "eu",
     storage: "storyblok-cv",
-    endpoint: "/api/storyblokCv",
+    statusRoute: "/api/storyblok-cv",
     webhook: true,
     ttl: false,
     onStartup: true
@@ -42,7 +42,7 @@ const module$1 = defineNuxtModule({
       nuxt.options.runtimeConfig.storyblokCv,
       {
         token: token ?? "",
-        apiHost: options.apiHost || API_HOSTS[options.region] || API_HOSTS.eu,
+        endpoint: options.endpoint || API_ENDPOINTS[options.region] || API_ENDPOINTS.eu,
         storage: options.storage,
         ttl: options.ttl === false ? 0 : options.ttl ?? 0,
         onStartup: options.onStartup !== false,
@@ -53,16 +53,16 @@ const module$1 = defineNuxtModule({
       middleware: true,
       handler: resolver.resolve("./runtime/server/middleware/cv")
     });
-    if (options.endpoint) {
+    if (options.statusRoute) {
       addServerHandler({
-        route: options.endpoint,
+        route: options.statusRoute,
         method: "get",
         handler: resolver.resolve("./runtime/server/api/cv.get")
       });
     }
     if (options.webhook) {
       addServerHandler({
-        route: typeof options.webhook === "string" ? options.webhook : "/api/storyblokCvWebhook",
+        route: typeof options.webhook === "string" ? options.webhook : "/api/storyblok-cv-webhook",
         method: "post",
         handler: resolver.resolve("./runtime/server/api/webhook.post")
       });

package/dist/runtime/server/utils/cv.js

@@ -3,12 +3,12 @@ import { useRuntimeConfig, useStorage } from "#imports";
 const KEY = "current";
 const store = () => useStorage(useRuntimeConfig().storyblokCv.storage);
 export async function getLiveStoryblokCv() {
-  const { token, apiHost } = useRuntimeConfig().storyblokCv;
+  const { token, endpoint } = useRuntimeConfig().storyblokCv;
   if (!token) {
     throw new Error("[storyblok-cv] no access token configured");
   }
-  const response = await $fetch("/v2/cdn/spaces/me", {
-    baseURL: apiHost,
+  const response = await $fetch("cdn/spaces/me", {
+    baseURL: endpoint,
     query: { token }
   });
   return response?.space?.version ?? 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@towa-digital/storyblok-nuxt-cv",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Keeps Storyblok published content fresh on long-running Nuxt servers by bridging the live cache version (cv) to the render client — no redeploy after publish.",
   "repository": "github:towa-digital/storyblok-nuxt-cv",
   "author": {