@storyblok/nuxt 5.6.0 → 5.6.2

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -0,0 +1,13 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    accessToken: string;
+    enableSudoMode: boolean;
+    usePlugin: boolean;
+    bridge: boolean;
+    devtools: boolean;
+    apiOptions: any;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,5 @@
+{
+  "name": "@storyblok/nuxt",
+  "configKey": "storyblok",
+  "version": "5.6.2"
+}

package/{src/module.ts → dist/module.mjs}

@@ -1,66 +1,37 @@
-import {
-  defineNuxtModule,
-  addPlugin,
-  addComponentsDir,
-  addImports,
-  addImportsDir,
-  createResolver
-} from "@nuxt/kit";
-import { NuxtHookName } from "@nuxt/schema";
+import { defineNuxtModule, createResolver, addComponentsDir, addPlugin, addImports, addImportsDir } from '@nuxt/kit';
 
-export interface ModuleOptions {
-  accessToken: string,
-  enableSudoMode: boolean,
-  usePlugin: boolean, // legacy opt. for enableSudoMode
-  bridge: boolean, // storyblok bridge on/off
-  devtools: boolean, // enable nuxt/devtools integration
-  apiOptions: any, // storyblok-js-client options
-}
-
-export default defineNuxtModule<ModuleOptions>({
+const module = defineNuxtModule({
   meta: {
     name: "@storyblok/nuxt",
     configKey: "storyblok"
   },
   defaults: {
-    accessToken: '',
+    accessToken: "",
     enableSudoMode: false,
-    usePlugin: true, // legacy opt. for enableSudoMode
+    usePlugin: true,
+    // legacy opt. for enableSudoMode
     bridge: true,
     devtools: false,
-    apiOptions: {},
+    apiOptions: {}
   },
   setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
-
-    if(nuxt.options.vite.optimizeDeps) {
-      nuxt.options.vite.optimizeDeps.include =
-        nuxt.options.vite.optimizeDeps.include || [];
+    if (nuxt.options.vite.optimizeDeps) {
+      nuxt.options.vite.optimizeDeps.include = nuxt.options.vite.optimizeDeps.include || [];
       nuxt.options.vite.optimizeDeps.include.push("@storyblok/nuxt");
       nuxt.options.vite.optimizeDeps.include.push("@storyblok/vue");
-
-      nuxt.options.vite.optimizeDeps.exclude =
-        nuxt.options.vite.optimizeDeps.exclude || [];
+      nuxt.options.vite.optimizeDeps.exclude = nuxt.options.vite.optimizeDeps.exclude || [];
       nuxt.options.vite.optimizeDeps.exclude.push("fsevents");
     }
-
-
-    // Enable dirs
-    // nuxt.options.components.dirs = ["~/components/storyblok"];
     addComponentsDir({ path: "~/storyblok", global: true, pathPrefix: false });
-
     nuxt.options.build.transpile.push(resolver.resolve("./runtime"));
     nuxt.options.build.transpile.push("@storyblok/nuxt");
     nuxt.options.build.transpile.push("@storyblok/vue");
-
-    // Add plugin
     nuxt.options.runtimeConfig.public.storyblok = options;
     const enablePluginCondition = options.usePlugin === true && options.enableSudoMode === false;
     if (enablePluginCondition) {
       addPlugin(resolver.resolve("./runtime/plugin"));
     }
-
-    // Add auto imports
     const names = [
       "useStoryblok",
       "useStoryblokApi",
@@ -72,19 +43,20 @@ export default defineNuxtModule<ModuleOptions>({
       addImports({ name, as: name, from: "@storyblok/vue" });
     }
     addImportsDir(resolver.resolve("./runtime/composables"));
-
     if (options.devtools) {
-      nuxt.hook('devtools:customTabs' as NuxtHookName, (iframeTabs: Array<unknown>): void => {
+      nuxt.hook("devtools:customTabs", (iframeTabs) => {
         iframeTabs.push({
-          name: 'storyblok',
-          title: 'Storyblok',
-          icon: 'i-logos-storyblok-icon',
+          name: "storyblok",
+          title: "Storyblok",
+          icon: "i-logos-storyblok-icon",
           view: {
-            type: 'iframe',
-            src: 'https://app.storyblok.com/#!/me/spaces/'
+            type: "iframe",
+            src: "https://app.storyblok.com/#!/me/spaces/"
           }
-        })
-      })
+        });
+      });
     }
   }
 });
+
+export { module as default };

package/dist/runtime/composables/useAsyncStoryblok.d.ts

@@ -0,0 +1,2 @@
+import type { ISbStoriesParams, StoryblokBridgeConfigV2 } from '@storyblok/vue';
+export declare const useAsyncStoryblok: (url: string, apiOptions?: ISbStoriesParams, bridgeOptions?: StoryblokBridgeConfigV2) => Promise<any>;

package/{src/runtime/composables/useAsyncStoryblok.ts → dist/runtime/composables/useAsyncStoryblok.mjs}

@@ -1,33 +1,25 @@
 import { useStoryblokApi, useStoryblokBridge } from "@storyblok/vue";
-import type { ISbStoriesParams, StoryblokBridgeConfigV2, ISbStoryData } from '@storyblok/vue';
 import { useState, onMounted } from "#imports";
-
-export const useAsyncStoryblok = async (
-  url: string,
-  apiOptions: ISbStoriesParams = {},
-  bridgeOptions: StoryblokBridgeConfigV2 = {}
-) => {
+export const useAsyncStoryblok = async (url, apiOptions = {}, bridgeOptions = {}) => {
   const uniqueKey = `${JSON.stringify(apiOptions)}${url}`;
-  const story = useState<ISbStoryData>(`${uniqueKey}-state`);
+  const story = useState(`${uniqueKey}-state`);
   const storyblokApiInstance = useStoryblokApi();
-
   onMounted(() => {
     if (story.value && story.value.id) {
       useStoryblokBridge(
         story.value.id,
-        evStory => (story.value = evStory),
-        bridgeOptions,
+        (evStory) => story.value = evStory,
+        bridgeOptions
       );
     }
   });
-
   if (!story.value) {
     const { data } = await storyblokApiInstance.get(
       `cdn/stories/${url}`,
       apiOptions
     );
     story.value = data.story;
-  };
-
+  }
+  ;
   return story;
 };

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/{src/runtime/plugin.ts → dist/runtime/plugin.mjs}

@@ -1,6 +1,5 @@
 import { StoryblokVue, apiPlugin } from "@storyblok/vue";
 import { defineNuxtPlugin, useRuntimeConfig } from "#app";
-
 export default defineNuxtPlugin(({ vueApp }) => {
   let { storyblok } = useRuntimeConfig().public;
   storyblok = JSON.parse(JSON.stringify(storyblok));

package/dist/types.d.ts

@@ -0,0 +1,15 @@
+
+import { ModuleOptions } from './module'
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['storyblok']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['storyblok']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['storyblok']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['storyblok']?: ModuleOptions }
+}
+
+
+export { ModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyblok/nuxt",
-  "version": "5.6.0",
+  "version": "5.6.2",
   "description": "Storyblok Nuxt module",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -12,6 +12,9 @@
       "require": "./dist/module.cjs"
     }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "prepack": "nuxt-module-build",
     "build": "nuxt-module-build",

package/.editorconfig

@@ -1,12 +0,0 @@
-root = true
-
-[*]
-indent_size = 2
-indent_style = space
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

package/.eslintignore

@@ -1,3 +0,0 @@
-dist
-node_modules
-playground-e2e

package/.eslintrc

@@ -1,7 +0,0 @@
-{
-  "root": true,
-  "extends": ["@nuxt/eslint-config"],
-  "rules": {
-    "vue/multi-word-component-names": "off"
-  }
-}

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1 +0,0 @@
-blank_issues_enabled: false

package/.github/ISSUE_TEMPLATE/issue.bug.yml

@@ -1,68 +0,0 @@
-name: "\U0001F41E SDK Bug Report"
-description: Report an issue using Nuxt 3 Storyblok SDK
-labels: [pending-triage, pending-author]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        You're now going to fill out a bug report at the Nuxt 3 Storyblok SDK. Thanks a lot for taking the time and let's make Storyblok open source projects better together!
-  - type: textarea
-    id: bug-description
-    attributes:
-      label: Describe the issue you're facing
-      description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description so we can review it. Thanks in advance!
-      placeholder: My Nuxt 3 Storyblok SDK configuration is ... ## Expected behavior ... ## Current Behavior ...
-    validations:
-      required: true
-  - type: input
-    id: reproduction
-    attributes:
-      label: Reproduction
-      description: Please provide a link to a repo or Stackblitz that can reproduce the issue you ran into. A minimal reproduction is required, if a report is vague or has no reproduction, it will receive a "need reproduction" label.
-      placeholder: Reproduction URL
-    validations:
-      required: true
-  - type: textarea
-    id: reproduction-steps
-    attributes:
-      label: Steps to reproduce
-      description: Please provide any reproduction steps that may need to be described.
-      placeholder: List the commands or configuration you set when you faced the error, and describe with process you follow to get the error.
-  - type: textarea
-    id: system-info
-    attributes:
-      label: System Info
-      description: Output of `npx envinfo --system --npmPackages '{ nuxt, @storyblok/*}' --binaries --browsers`
-      render: shell
-      placeholder: System, Binaries, Browsers, Nuxt 3 & Storyblok SDK version
-    validations:
-      required: true
-  - type: dropdown
-    id: package-manager
-    attributes:
-      label: Used Package Manager
-      description: Select the used package manager
-      options:
-        - npm
-        - yarn
-        - pnpm
-    validations:
-      required: true
-  - type: textarea
-    id: logs
-    attributes:
-      label: Error logs (Optional)
-      description: |
-        Optional if provided reproduction. Please copy and paste the log text.
-  - type: checkboxes
-    id: checkboxes
-    attributes:
-      label: Validations
-      description: Before submitting the issue, please make sure you do the following
-      options:
-        - label: Follow our [Code of Conduct](https://www.storyblok.com/trust-center#code-of-conduct?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
-          required: true
-  - type: markdown
-    attributes:
-      value: |
-        > This template was inspired by the [Vite issue template](https://github.com/vitejs/vite/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml)

package/.github/ISSUE_TEMPLATE/issue.fr.yml

@@ -1,40 +0,0 @@
-name: "\U0001F58C SDK Feature Request"
-description: Propose a feature or improvement that the Storyblok SDK should have
-labels: [enhancement, pending-triage, pending-author]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for helping us improve the Storyblok open source project, you rock!
-  - type: textarea
-    id: feature-description
-    attributes:
-      label: Description
-      description: "Clear and concise description of what you want to include or enhance from the SDK. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this feature request, tell us in the description so we can review and be aware of it. Thanks in advance!"
-      placeholder: As a developer using Storyblok SDK I want [wish] so that [benefit].
-    validations:
-      required: true
-  - type: textarea
-    id: suggested-solution
-    attributes:
-      label: Suggested solution or improvement
-      description: "Link to the PR or what implementation you will expect from us (links to external examples if needed)."
-    validations:
-      required: true
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: Additional context
-      description: Any other context or screenshots about the feature request here.
-  - type: checkboxes
-    id: checkboxes
-    attributes:
-      label: Validations
-      description: Before submitting the feature request, please make sure you do the following
-      options:
-        - label: Follow our [Code of Conduct](https://www.storyblok.com/trust-center#code-of-conduct?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
-          required: true
-  - type: markdown
-    attributes:
-      value: |
-        > This template was inspired by the [Vite FR template](https://github.com/vitejs/vite/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml)

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "daily"
-      time: "05:00"
-    commit-message:
-      prefix: fix
-      prefix-development: chore
-      include: scope

package/.github/workflows/dependabot-automerge.yml

@@ -1,28 +0,0 @@
-# **** AUTOMERGE ****
-# Merge automatically the PR that contain a minor or patch update on the dependency you define in env.DEPENDENCY
-#  - Inspiration: https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request
-
-name: Dependabot auto-merge
-on: pull_request
-
-permissions:
-  pull-requests: write
-  contents: write
-
-jobs:
-  dependabot:
-    runs-on: ubuntu-latest
-    if: ${{ github.actor == 'dependabot[bot]' }}
-    steps:
-      - name: Dependabot metadata
-        id: metadata
-        uses: dependabot/fetch-metadata@v1.1.1
-        with:
-          github-token: "${{ secrets.GITHUB_TOKEN }}"
-      - name: Enable auto-merge for Dependabot PRs
-        if: ${{contains(steps.metadata.outputs.dependency-names, env.DEPENDENCY) && (steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor')}}
-        run: gh pr merge --auto --merge "$PR_URL"
-        env:
-          DEPENDENCY: "@storyblok/vue"
-          PR_URL: ${{github.event.pull_request.html_url}}
-          GITHUB_TOKEN: ${{secrets.DEPENDABOT_TOKEN}}

package/.github/workflows/release.yml

@@ -1,30 +0,0 @@
-name: Release CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: "18"
-          cache: "npm"
-      - name: Install dependencies
-        run: npm ci && cd playground && npm ci && cd ..
-      - name: Build lib
-        run: npm run build
-      - name: Cypress run
-        run: npm run test:e2e
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release

package/.husky/commit-msg

@@ -1,6 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx --no -- commitlint --edit "$1"
-# npx --no-install commitlint --edit
-

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged

package/.nuxtrc

@@ -1 +0,0 @@
-typescript.includeWorkspace=true

package/.prettierignore

@@ -1 +0,0 @@
-**/templates/plugin.js

package/cypress/.eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": ["plugin:cypress/recommended"]
-}

package/cypress/e2e/index.cy.ts

@@ -1,34 +0,0 @@
-describe("@storyblok/nuxt", () => {
-  describe("Composition API", () => {
-    beforeEach(() => {
-      // cy.intercept("https://api.storyblok.com/**", {
-      //   fixture: "stories.json"
-      // }).as("getStories");
-      cy.visit("/vue/test");
-    });
-
-    it("should fetch and render stories", () => {
-      it("Renders the expected story when loading the components", () => {
-        cy.get("[data-test=page]").should("exist");
-        cy.get("[data-test=grid]").should("exist");
-        cy.get("[data-test=feature]").should("have.length", 2);
-        cy.get("[data-test=teaser]").should("exist").and("have.text", "hello");
-      });
-    });
-  });
-
-  describe("Composition API - Long form", () => {
-    beforeEach(() => {
-      cy.visit("/vue");
-    });
-
-    it("should fetch and render stories", () => {
-      it("Renders the expected story when loading the components", () => {
-        cy.get("[data-test=page]").should("exist");
-        cy.get("[data-test=grid]").should("exist");
-        cy.get("[data-test=feature]").should("have.length", 3);
-        cy.get("[data-test=teaser]").should("exist").and("have.text", "hello");
-      });
-    });
-  });
-});

package/cypress/fixtures/stories.json

@@ -1,7 +0,0 @@
-{
-  "stories": [
-    { "name": "a", "id": 0 },
-    { "name": "b", "id": 1 },
-    { "name": "c", "id": 2 }
-  ]
-}

package/cypress/support/commands.ts

@@ -1,25 +0,0 @@
-// ***********************************************
-// This example commands.js shows you how to
-// create various custom commands and overwrite
-// existing commands.
-//
-// For more comprehensive examples of custom
-// commands please read more here:
-// https://on.cypress.io/custom-commands
-// ***********************************************
-//
-//
-// -- This is a parent command --
-// Cypress.Commands.add('login', (email, password) => { ... })
-//
-//
-// -- This is a child command --
-// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
-//
-//
-// -- This is a dual command --
-// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
-//
-//
-// -- This will overwrite an existing command --
-// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

package/cypress/support/e2e.ts

@@ -1,20 +0,0 @@
-// ***********************************************************
-// This example support/index.js is processed and
-// loaded automatically before your test files.
-//
-// This is a great place to put global configuration and
-// behavior that modifies Cypress.
-//
-// You can change the location of this file or turn off
-// automatically serving support files with the
-// 'supportFile' configuration option.
-//
-// You can read more here:
-// https://on.cypress.io/configuration
-// ***********************************************************
-
-// Import commands.js using ES2015 syntax:
-import "./commands";
-
-// Alternatively you can use CommonJS syntax:
-// require('./commands')

package/cypress.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from "cypress";
-
-export default defineConfig({
-  e2e: {
-    // We've imported your old cypress plugins here.
-    // You may want to clean this up later by importing these.
-    baseUrl: "http://localhost:3000",
-    viewportWidth: 1600,
-    viewportHeight: 1400
-  }
-});

package/playground/README.md

@@ -1,63 +0,0 @@
-# Nuxt 3 Minimal Starter
-
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
-
-## Setup
-
-Make sure to install the dependencies:
-
-```bash
-# npm
-npm install
-
-# pnpm
-pnpm install
-
-# yarn
-yarn install
-```
-
-## Development Server
-
-Start the development server on `http://localhost:3000`:
-
-```bash
-# npm
-npm run dev
-
-# pnpm
-pnpm run dev
-
-# yarn
-yarn dev
-```
-
-## Production
-
-Build the application for production:
-
-```bash
-# npm
-npm run build
-
-# pnpm
-pnpm run build
-
-# yarn
-yarn build
-```
-
-Locally preview production build:
-
-```bash
-# npm
-npm run preview
-
-# pnpm
-pnpm run preview
-
-# yarn
-yarn preview
-```
-
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

package/playground/app.vue

@@ -1,3 +0,0 @@
-<template>
-  <NuxtPage />
-</template>

package/playground/error.vue

@@ -1,22 +0,0 @@
-<template>
-  <div class="grid place-items-center h-screen text-center">
-    <div class="flex flex-col gap-y-4">
-      <h1 class="font-bold text-4xl">Error {{ error.statusCode }}</h1>
-      <p>{{ error.statusMessage }}</p>
-      <button
-        class="px-4 py-2 bg-green-600 text-white rounded-lg"
-        @click="handleError"
-      >
-        Clear errors
-      </button>
-    </div>
-  </div>
-</template>
-
-<script setup>
-defineProps({
-  error: Object
-});
-
-const handleError = () => clearError({ redirect: "/" });
-</script>