@poveste/plugin-nuxt 0.5.3 → 0.6.1

package/dist/index.d.ts

@@ -1,2 +1,10 @@
 import type { Plugin } from 'poveste';
-export declare function HstNuxt(): Plugin;
+export interface HstNuxtOptions {
+    /**
+     * Client plugins to drop from the story sandbox, matched against each
+     * plugin's resolved `src` (string `includes` or `RegExp`). Added on top of
+     * the built-in defaults, not replacing them.
+     */
+    excludePlugins?: (string | RegExp)[];
+}
+export declare function HstNuxt(options?: HstNuxtOptions): Plugin;

package/dist/index.js

@@ -9,12 +9,17 @@ const ignorePlugins = [
     'nuxt:dynamic-base-path',
     'nuxt:import-protection',
 ];
-export function HstNuxt() {
+// Some Nuxt modules register client plugins that assume a full Nuxt runtime the
+// headless story sandbox can't provide, so they 500 the iframe on entry boot;
+// @nuxtjs/i18n's are dropped by default (#65), and `excludePlugins` drops more
+// without patching this package (#277).
+const DEFAULT_EXCLUDED_PLUGINS = [/[\\/]@nuxtjs[\\/]i18n[\\/].*[\\/]plugins[\\/]/];
+export function HstNuxt(options = {}) {
     let nuxt;
     return {
         name: '@poveste/plugin-nuxt',
         async defaultConfig() {
-            const nuxtViteConfig = await useNuxtViteConfig();
+            const nuxtViteConfig = await useNuxtViteConfig([...DEFAULT_EXCLUDED_PLUGINS, ...(options.excludePlugins ?? [])]);
             const { viteConfig } = nuxtViteConfig;
             nuxt = nuxtViteConfig.nuxt; // We save it to close it later
             const plugins = viteConfig.plugins.filter((p) => !ignorePlugins.includes(p?.name));
@@ -98,7 +103,7 @@ export async function setupVue3 () {
         },
     };
 }
-async function useNuxtViteConfig() {
+async function useNuxtViteConfig(excludePlugins) {
     const { loadNuxt, buildNuxt } = await import('@nuxt/kit');
     const nuxt = await loadNuxt({
         // cwd: process.cwd(),
@@ -128,6 +133,16 @@ async function useNuxtViteConfig() {
     }
     const runtimeDir = fileURLToPath(new URL('../runtime', import.meta.url));
     nuxt.options.build.templates.push({ src: join(runtimeDir, 'composables.mjs'), filename: 'poveste/composables.mjs' }, { src: join(runtimeDir, 'components.mjs'), filename: 'poveste/components.mjs' });
+    // Drop the sandbox-incompatible client plugins named by `excludePlugins`, so
+    // they don't 500 the story iframe on entry boot. See DEFAULT_EXCLUDED_PLUGINS.
+    nuxt.hook('app:resolve', (app) => {
+        app.plugins = app.plugins.filter((p) => {
+            const src = p.src ?? '';
+            // `match`, not `test`: it doesn't advance a caller's /g regex `lastIndex`, so
+            // matching stays stateless without mutating an input we don't own.
+            return !excludePlugins.some(pattern => typeof pattern === 'string' ? src.includes(pattern) : src.match(pattern) !== null);
+        });
+    });
     nuxt.hook('app:templates', (app) => {
         app.templates = app.templates.filter(template => template.filename !== 'app-component.mjs');
         app.templates.push({ src: join(runtimeDir, 'app-component.mjs'), filename: 'app-component.mjs' });
@@ -159,6 +174,14 @@ async function useNuxtViteConfig() {
                 nuxt.hook('vite:configResolved', (config, { isClient }) => {
                     if (isClient) {
                         resolve(config);
+                        // The resolved config is all this instance is for. Left running,
+                        // `buildNuxt` goes on to build the Nuxt client, start Nitro and
+                        // open Nuxt's own dev server — seconds of work on every `poveste
+                        // dev` and `poveste build`, a `NUXT_B7005` warning for the entry
+                        // it does not have, and an HMR socket on 24678 that collides with
+                        // any other Nuxt dev server on the machine (#220, #221). The catch
+                        // below has always known this sentinel; nothing threw it.
+                        throw new Error('_stop_');
                     }
                 });
             });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@poveste/plugin-nuxt",
   "type": "module",
-  "version": "0.5.3",
+  "version": "0.6.1",
   "description": "Poveste plugin to integrate with Nuxt 4",
   "author": {
     "name": "Sorin Gitlan"
@@ -24,8 +24,8 @@
   "types": "./dist/index.d.ts",
   "peerDependencies": {
     "nuxt": "^4.5.0",
-    "@poveste/plugin-vue": "^0.5.3",
-    "poveste": "^0.5.3"
+    "@poveste/plugin-vue": "^0.6.1",
+    "poveste": "^0.6.1"
   },
   "dependencies": {
     "@nuxt/kit": "^4.5.2",
@@ -39,7 +39,7 @@
     "@types/node": "^22.10.1",
     "typescript": "5.6.3",
     "vite": "^8.2.0",
-    "poveste": "0.5.3"
+    "poveste": "0.6.1"
   },
   "scripts": {
     "build": "rimraf dist && tsc -d",

package/src/index.ts

@@ -14,13 +14,28 @@ const ignorePlugins = [
   'nuxt:import-protection',
 ]
 
-export function HstNuxt(): Plugin {
+export interface HstNuxtOptions {
+  /**
+   * Client plugins to drop from the story sandbox, matched against each
+   * plugin's resolved `src` (string `includes` or `RegExp`). Added on top of
+   * the built-in defaults, not replacing them.
+   */
+  excludePlugins?: (string | RegExp)[]
+}
+
+// Some Nuxt modules register client plugins that assume a full Nuxt runtime the
+// headless story sandbox can't provide, so they 500 the iframe on entry boot;
+// @nuxtjs/i18n's are dropped by default (#65), and `excludePlugins` drops more
+// without patching this package (#277).
+const DEFAULT_EXCLUDED_PLUGINS: (string | RegExp)[] = [/[\\/]@nuxtjs[\\/]i18n[\\/].*[\\/]plugins[\\/]/]
+
+export function HstNuxt(options: HstNuxtOptions = {}): Plugin {
   let nuxt: Nuxt
   return {
     name: '@poveste/plugin-nuxt',
 
     async defaultConfig() {
-      const nuxtViteConfig = await useNuxtViteConfig()
+      const nuxtViteConfig = await useNuxtViteConfig([...DEFAULT_EXCLUDED_PLUGINS, ...(options.excludePlugins ?? [])])
       const { viteConfig } = nuxtViteConfig
 
       nuxt = nuxtViteConfig.nuxt // We save it to close it later
@@ -111,7 +126,7 @@ export async function setupVue3 () {
   }
 }
 
-async function useNuxtViteConfig() {
+async function useNuxtViteConfig(excludePlugins: (string | RegExp)[]) {
   const { loadNuxt, buildNuxt } = await import('@nuxt/kit')
   const nuxt = await loadNuxt({
     // cwd: process.cwd(),
@@ -145,6 +160,18 @@ async function useNuxtViteConfig() {
     { src: join(runtimeDir, 'components.mjs'), filename: 'poveste/components.mjs' },
   )
 
+  // Drop the sandbox-incompatible client plugins named by `excludePlugins`, so
+  // they don't 500 the story iframe on entry boot. See DEFAULT_EXCLUDED_PLUGINS.
+  nuxt.hook('app:resolve', (app) => {
+    app.plugins = app.plugins.filter((p) => {
+      const src = p.src ?? ''
+      // `match`, not `test`: it doesn't advance a caller's /g regex `lastIndex`, so
+      // matching stays stateless without mutating an input we don't own.
+      return !excludePlugins.some(pattern =>
+        typeof pattern === 'string' ? src.includes(pattern) : src.match(pattern) !== null)
+    })
+  })
+
   nuxt.hook('app:templates', (app) => {
     app.templates = app.templates.filter(template => template.filename !== 'app-component.mjs')
     app.templates.push({ src: join(runtimeDir, 'app-component.mjs'), filename: 'app-component.mjs' })
@@ -179,6 +206,14 @@ async function useNuxtViteConfig() {
         nuxt.hook('vite:configResolved', (config, { isClient }) => {
           if (isClient) {
             resolve(config as any)
+            // The resolved config is all this instance is for. Left running,
+            // `buildNuxt` goes on to build the Nuxt client, start Nitro and
+            // open Nuxt's own dev server — seconds of work on every `poveste
+            // dev` and `poveste build`, a `NUXT_B7005` warning for the entry
+            // it does not have, and an HMR socket on 24678 that collides with
+            // any other Nuxt dev server on the machine (#220, #221). The catch
+            // below has always known this sentinel; nothing threw it.
+            throw new Error('_stop_')
           }
         })
       })