@shopware/nuxt-module 1.4.0 → 1.4.2

package/README.md

@@ -74,7 +74,7 @@ Now you can use any composable function you need without extra import:
 The information about the session is kept in a cookie (`sw-context-token`) and used in every request made by any composable or directly, invoked by `api instance`:
 
 ```html
-<script>
+<script setup>
   const { apiClient } = useShopwareContext();
   const apiResponse = await apiClient.invoke(/** params omitted */);
 </script>
@@ -114,25 +114,58 @@ More about Nuxt configuration can be found [HERE](https://nuxt.com/docs/getting-
 }
 ```
 
+## Register custom API types (tailored for your Shopware instance)
+
+To use custom API types generated by the `api-gen` package, create a `shopware.d.ts` file in your project and register the types for the `#shopware` module. This enables type-safe usage of your custom API types throughout your Nuxt application.
+
+**Example of using a local type definitions:**
+
+```ts
+// shopware.d.ts
+declare module "#shopware" {
+  import type { createAPIClient } from "@shopware/api-client";
+
+  // Use default Shopware types:
+  // export type operations =
+  //  import("@shopware/api-client/store-api-types").operations;
+  // export type Schemas =
+  // import("@shopware/api-client/store-api-types").components["schemas"];
+
+  // Or use your locally generated types (placed in ./api-types folder):
+   export type operations = import("./api-types/storeApiTypes").operations;
+   export type Schemas = import("./api-types/storeApiTypes").components["schemas"];
+
+  // Export your own Api Client definition:
+  export type ApiClient = ReturnType<typeof createAPIClient<operations>>;
+}
+```
+
+Import your custom types from local files and export them as shown above. This approach keeps your types local, allows merging or overriding defaults, and ensures full type safety for API operations and schemas.
+
+### Apply custom types for `@shopware/api-client`
+
+ The API Client instance is aware of your custom API types thanks to declaring `#shopware` module from the step above. So now, whenever `apiClient` instance is used, the proper types are registered.
+
 ## Links
 
 - [📘 Documentation](https://frontends.shopware.com)
 
-- [👥 Community](https://shopwarecommunity.slack.com) (`#composable-frontends`)
+- [📦 API Gen - Types Generator for Shopware 6 OpenAPI Schema](https://npmjs.com/@shopware/api-gen)
+
+- [📦 API Client - REST API Client for Shopware 6](https://npmjs.com/@shopware/api-client)
+
+- [👥 Community](https://discord.com/channels/1308047705309708348/1405501315160739951) (`#composable-frontend`)
 <!-- AUTO GENERATED CHANGELOG -->
 
 ## Changelog
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/nuxt-module/CHANGELOG.md)
 
-### Latest changes: 1.4.0
-
-### Minor Changes
-
-- [#1812](https://github.com/shopware/frontends/pull/1812) [`c28810d`](https://github.com/shopware/frontends/commit/c28810d0ca503b97c232438e200bbf5ba5dab403) Thanks [@patzick](https://github.com/patzick)! - `useShopwareContext` - added `browserLocale` field. With nuxt-module it's automatically injected into context. Should be used for proper date formatting.
+### Latest changes: 1.4.2
 
 ### Patch Changes
 
-- Updated dependencies [[`d016d6b`](https://github.com/shopware/frontends/commit/d016d6b845bff9a148405a74dae88d7fc81ec99c), [`c28810d`](https://github.com/shopware/frontends/commit/c28810d0ca503b97c232438e200bbf5ba5dab403), [`a7ff606`](https://github.com/shopware/frontends/commit/a7ff60681d1a164d5c9f2020c506262e96fad5dc), [`d016d6b`](https://github.com/shopware/frontends/commit/d016d6b845bff9a148405a74dae88d7fc81ec99c), [`bd70905`](https://github.com/shopware/frontends/commit/bd70905b8443fd57d8d8cb3cfc6501a9117dea49)]:
-  - @shopware/api-client@1.3.0
-  - @shopware/composables@1.9.0
+- Updated dependencies [[`87771c3`](https://github.com/shopware/frontends/commit/87771c3b7a4521fcdba43cb4c967b61f5db01b3e), [`22ff62e`](https://github.com/shopware/frontends/commit/22ff62e354f024599d64ea8096af57695248851c), [`a44d871`](https://github.com/shopware/frontends/commit/a44d8712d9ae5ee196c03ac8b894f3d1392d0e68), [`e43d9b7`](https://github.com/shopware/frontends/commit/e43d9b7f559af21be8b66f2021cea2d14940e4aa), [`2cbda25`](https://github.com/shopware/frontends/commit/2cbda257a1056454e12f2fba9052f83eecb6d986), [`2cbda25`](https://github.com/shopware/frontends/commit/2cbda257a1056454e12f2fba9052f83eecb6d986), [`7fe2ef9`](https://github.com/shopware/frontends/commit/7fe2ef96a9d9d156683b85d31f0a660458c9fbfd), [`70dcf95`](https://github.com/shopware/frontends/commit/70dcf95d4370c63964d877a5cab113a53f93ca19), [`56cd178`](https://github.com/shopware/frontends/commit/56cd178e25fe2399b7170ccac3044e980621f041), [`c647baf`](https://github.com/shopware/frontends/commit/c647baf93e7174b849f5961ee5803add99d78602), [`e1fae3e`](https://github.com/shopware/frontends/commit/e1fae3eb6430e5c8e133456fbaf7f215f80c36f6), [`c647baf`](https://github.com/shopware/frontends/commit/c647baf93e7174b849f5961ee5803add99d78602), [`c77daa6`](https://github.com/shopware/frontends/commit/c77daa6a11e96c7f3688b16f7da010b54c7f5e8b)]:
+  - @shopware/composables@1.10.0
+  - @shopware/helpers@1.6.0
+  - @shopware/api-client@1.4.0

package/dist/index.d.mts

@@ -24,26 +24,5 @@ type ShopwareNuxtOptions = {
      */
     useUserContextInSSR?: boolean;
 };
-declare module "@nuxt/schema" {
-    interface NuxtConfig {
-        shopware?: ShopwareNuxtOptions;
-    }
-    interface NuxtOptions {
-        shopware?: ShopwareNuxtOptions;
-    }
-    interface ApiClientConfig {
-        headers?: {
-            [key: string]: string;
-        };
-    }
-    interface RuntimeConfig {
-        shopware?: Pick<ShopwareNuxtOptions, "endpoint" | "shopwareEndpoint" | "useUserContextInSSR">;
-        apiClientConfig?: ApiClientConfig;
-    }
-    interface PublicRuntimeConfig {
-        shopware: ShopwareNuxtOptions;
-        apiClientConfig?: ApiClientConfig;
-    }
-}
 
 export { type ShopwareNuxtOptions, _default as default };

package/dist/index.d.ts

@@ -24,26 +24,5 @@ type ShopwareNuxtOptions = {
      */
     useUserContextInSSR?: boolean;
 };
-declare module "@nuxt/schema" {
-    interface NuxtConfig {
-        shopware?: ShopwareNuxtOptions;
-    }
-    interface NuxtOptions {
-        shopware?: ShopwareNuxtOptions;
-    }
-    interface ApiClientConfig {
-        headers?: {
-            [key: string]: string;
-        };
-    }
-    interface RuntimeConfig {
-        shopware?: Pick<ShopwareNuxtOptions, "endpoint" | "shopwareEndpoint" | "useUserContextInSSR">;
-        apiClientConfig?: ApiClientConfig;
-    }
-    interface PublicRuntimeConfig {
-        shopware: ShopwareNuxtOptions;
-        apiClientConfig?: ApiClientConfig;
-    }
-}
 
 export { type ShopwareNuxtOptions, _default as default };

package/dist/index.mjs

@@ -21,22 +21,23 @@ const index = defineNuxtModule({
   async setup(options, nuxt) {
     const logger = useLogger(MODULE_ID);
     const resolver = createResolver(import.meta.url);
+    const shopwareConfig = nuxt.options.runtimeConfig?.public?.shopware ?? void 0;
     nuxt.options.runtimeConfig.public.shopware = defu(
       nuxt.options.runtimeConfig.public.shopware || {},
       options || {}
     );
-    if (isConfigDeprecated(nuxt.options?.runtimeConfig?.public?.shopware)) {
+    if (isConfigDeprecated(shopwareConfig)) {
       logger.warn(
         "You are using deprecated configuration (shopwareEndpoint or shopwareAccessToken). 'shopware' prefix is not needed anymore. Please update your _nuxt.config.ts_ "
       );
     }
-    if (nuxt.options?.runtimeConfig?.shopware?.endpoint) {
+    if (shopwareConfig?.endpoint) {
       logger.info(
-        `You are using SSR Shopware API endpoint: ${nuxt.options.runtimeConfig.shopware.endpoint}`
+        `You are using SSR Shopware API endpoint: ${shopwareConfig.endpoint}`
       );
     }
     logger.info(
-      `CSR Shopware API endpoint: ${nuxt.options.runtimeConfig.public?.shopware?.endpoint ?? nuxt.options.runtimeConfig.public?.shopware?.shopwareEndpoint}`
+      `CSR Shopware API endpoint: ${shopwareConfig?.endpoint ?? shopwareConfig?.shopwareEndpoint}`
     );
     addPlugin({
       src: resolver.resolve("../plugin.ts")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/nuxt-module",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Nuxt 3 module for Shopware Frontends",
   "author": "Shopware",
   "repository": {
@@ -34,18 +34,19 @@
     "index.cjs"
   ],
   "dependencies": {
-    "@nuxt/kit": "3.16.2",
+    "@nuxt/kit": "4.2.1",
     "defu": "6.1.4",
+    "h3": "1.15.4",
     "js-cookie": "3.0.5",
-    "@shopware/composables": "1.9.0",
-    "@shopware/helpers": "1.4.0",
-    "@shopware/api-client": "1.3.0"
+    "@shopware/composables": "1.10.0",
+    "@shopware/helpers": "1.6.0",
+    "@shopware/api-client": "1.4.0"
   },
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
-    "@nuxt/schema": "3.16.2",
-    "nuxt": "3.16.2",
-    "typescript": "5.8.3",
+    "@nuxt/schema": "4.2.1",
+    "nuxt": "4.2.1",
+    "typescript": "5.9.3",
     "unbuild": "2.0.0",
     "tsconfig": "0.0.0"
   },

package/plugin.ts

@@ -12,6 +12,7 @@ import {
   useState,
 } from "#imports";
 import type { ApiClient } from "#shopware";
+import type { ShopwareNuxtOptions } from "./src";
 
 declare module "#app" {
   interface NuxtApp {
@@ -27,12 +28,17 @@ declare module "vue" {
 
 export default defineNuxtPlugin((NuxtApp) => {
   const runtimeConfig = useRuntimeConfig();
+
+  const shopwareRuntimeConfigPublic = runtimeConfig.public
+    .shopware as ShopwareNuxtOptions;
+  const shopwareRuntimeConfig = runtimeConfig.shopware as ShopwareNuxtOptions;
+
   const shopwareEndpointCSR =
-    runtimeConfig.public?.shopware?.endpoint ??
-    runtimeConfig.public?.shopware?.shopwareEndpoint;
+    shopwareRuntimeConfigPublic?.endpoint ??
+    shopwareRuntimeConfigPublic?.shopwareEndpoint;
 
   const shopwareEndpointSSR =
-    (NuxtApp.ssrContext && runtimeConfig.shopware?.endpoint) ||
+    (NuxtApp.ssrContext && shopwareRuntimeConfig?.endpoint) ||
     shopwareEndpointCSR;
 
   const shopwareEndpoint = import.meta.server
@@ -40,8 +46,8 @@ export default defineNuxtPlugin((NuxtApp) => {
     : shopwareEndpointCSR;
 
   const shopwareAccessToken =
-    runtimeConfig.public?.shopware?.accessToken ??
-    runtimeConfig.public?.shopware?.shopwareAccessToken;
+    shopwareRuntimeConfigPublic?.accessToken ??
+    shopwareRuntimeConfigPublic?.shopwareAccessToken;
 
   if (!shopwareEndpoint || !shopwareAccessToken) {
     throw new Error(
@@ -51,13 +57,17 @@ export default defineNuxtPlugin((NuxtApp) => {
 
   const shouldUseSessionContextInServerRender =
     !NuxtApp.ssrContext ||
-    !!runtimeConfig.public?.shopware?.useUserContextInSSR ||
-    !!runtimeConfig?.shopware?.useUserContextInSSR;
+    !!shopwareRuntimeConfigPublic?.useUserContextInSSR ||
+    !!shopwareRuntimeConfig?.useUserContextInSSR;
 
   const contextTokenFromCookie = NuxtApp.ssrContext
-    ? getCookie(NuxtApp.ssrContext?.event, "sw-context-token")
+    ? getCookie(NuxtApp.ssrContext.event, "sw-context-token")
     : Cookies.get("sw-context-token");
 
+  type ApiClientConfig = {
+    headers?: Record<string, string>;
+  };
+
   const apiClient = createAPIClient({
     baseURL: shopwareEndpoint,
     accessToken: shopwareAccessToken,
@@ -65,8 +75,9 @@ export default defineNuxtPlugin((NuxtApp) => {
       ? contextTokenFromCookie
       : "",
     defaultHeaders:
-      (NuxtApp.ssrContext && runtimeConfig.apiClientConfig?.headers) ||
-      runtimeConfig.public?.apiClientConfig?.headers,
+      (NuxtApp.ssrContext &&
+        (runtimeConfig.apiClientConfig as ApiClientConfig)?.headers) ||
+      (runtimeConfig.public?.apiClientConfig as ApiClientConfig)?.headers,
   });
 
   apiClient.hook("onContextChanged", (newContextToken) => {
@@ -101,9 +112,11 @@ export default defineNuxtPlugin((NuxtApp) => {
 
   NuxtApp.vueApp.provide("apiClient", apiClient);
   // Shopware context
-  const shopwareContext = createShopwareContext(NuxtApp.vueApp, {
+  // TODO fix type App<Element>
+  // biome-ignore lint: ignore type error
+  const shopwareContext = createShopwareContext(NuxtApp.vueApp as any, {
     enableDevtools: true,
-    devStorefrontUrl: runtimeConfig.public.shopware?.devStorefrontUrl || null,
+    devStorefrontUrl: shopwareRuntimeConfigPublic?.devStorefrontUrl || null,
     browserLocale,
   });
   NuxtApp.vueApp.provide("shopware", shopwareContext);