@storyblok/nuxt 5.4.9 → 5.5.0

package/README.md

@@ -76,8 +76,9 @@ export default defineNuxtConfig({
 
 #### Options
 
-When you initialize the module, you can pass all [_@storyblok/vue_ options](https://github.com/storyblok/storyblok-vue#storyblok-api) plus a `bridge` option explained in our [JS SDK Storyblok bridge section](https://github.com/storyblok/storyblok-js#storyblok-bridge).
-If you want to use Storyblok inside `nuxt-devtools` you can use the option `devtools`, if enabled, make sure to have installed the @nuxt/devtools module and enable it on your nuxt config.
+When you initialize the module, you can pass all [_@storyblok/vue_ options](https://github.com/storyblok/storyblok-vue#storyblok-api) plus a `bridge` option explained in our [JS SDK Storyblok bridge section](https://github.com/storyblok/storyblok-js#storyblok-bridge) and a `enableSudoMode` option to define your own plugin (see below).
+
+> If you want to use Storyblok inside `nuxt-devtools` you can use the option `devtools`, if enabled, make sure to have installed the @nuxt/devtools module and enable it on your nuxt config.
 
 ```js
 // Defaults
@@ -91,6 +92,47 @@ If you want to use Storyblok inside `nuxt-devtools` you can use the option `devt
 }]
 ```
 
+**Define your own plugin**
+
+While the recommended approach covers most cases, there are specific instances where you may need to use the `enableSudoMode` option and disable our plugin, allowing you to incorporate your own.
+
+```js
+// nuxt.config.ts
+modules: [
+  [
+    "@storyblok/nuxt",
+    {
+      accessToken: "<your-access-token>",
+      enableSudoMode: true
+    }
+  ]
+];
+```
+
+To include additional functionalities in the SDK's `apiOptions`, such as custom cache methods, you can implement the following solution inside the plugins folder (autoimported):
+
+```js
+// plugins/storyblok.js
+import { StoryblokVue, apiPlugin } from "@storyblok/vue";
+
+export default defineNuxtPlugin(({ vueApp }) => {
+  vueApp.use(StoryblokVue, {
+    accessToken: "<your-access-token>",
+    apiOptions: {
+      cache: {
+        type: "custom",
+        custom: {
+          flush() {
+            console.log("all right");
+          }
+        }
+      }
+    },
+    use: [apiPlugin]
+  });
+});
+```
+
 #### Region parameter
 
 Possible values:

package/dist/module.d.ts

@@ -2,6 +2,7 @@ import * as _nuxt_schema from '@nuxt/schema';
 
 interface ModuleOptions {
     accessToken: string;
+    enableSudoMode: boolean;
     usePlugin: boolean;
     bridge: boolean;
     devtools: boolean;

package/dist/module.mjs

@@ -7,7 +7,9 @@ const module = defineNuxtModule({
   },
   defaults: {
     accessToken: "",
+    enableSudoMode: false,
     usePlugin: true,
+    // legacy opt. for enableSudoMode
     bridge: true,
     devtools: false,
     apiOptions: {}
@@ -22,7 +24,8 @@ const module = defineNuxtModule({
     nuxt.options.build.transpile.push("@storyblok/nuxt");
     nuxt.options.build.transpile.push("@storyblok/vue");
     nuxt.options.runtimeConfig.public.storyblok = options;
-    if (options.usePlugin !== false) {
+    const enablePluginCondition = options.usePlugin === true && options.enableSudoMode === false;
+    if (enablePluginCondition) {
       addPlugin(resolver.resolve("./runtime/plugin"));
     }
     const names = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyblok/nuxt",
-  "version": "5.4.9",
+  "version": "5.5.0",
   "description": "Storyblok Nuxt module",
   "type": "module",
   "exports": {
@@ -28,14 +28,14 @@
   },
   "dependencies": {
     "@nuxt/kit": "^3.4.2",
-    "@storyblok/vue": "^7.1.8"
+    "@storyblok/vue": "^7.1.9"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.1",
+    "@babel/core": "^7.22.5",
     "@cypress/vite-dev-server": "^5.0.5",
     "@nuxt/module-builder": "latest",
     "babel-jest": "^29.4.3",
-    "cypress": "^12.13.0",
+    "cypress": "^12.14.0",
     "eslint-plugin-cypress": "^2.13.3",
     "jest": "^29.4.3",
     "start-server-and-test": "^2.0.0",