@vue-storefront/nuxt 3.0.2 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Change log
 
+## 3.1.0
+
+- **[ADDED]** `middlewareModule` to `defineSdkConfig` params.
+
+```diff [sdk.config.ts]
+- import { UnifiedApiExtension } from "storefront-middleware/types"
++ import { UnifiedEndpoints } from "storefront-middleware/types"
+
+export default defineSdkConfig(
+-  ({ buildModule, middlewareUrl, getRequestHeaders }) => ({
+-    commerce: buildModule(unifiedModule<UnifiedApiExtension>, {
+-      apiUrl: `${middlewareUrl}/commerce`,
+-      requestOptions: { headers: getRequestHeaders },
++  ({ buildModule, middlewareModule, middlewareUrl, getRequestHeaders }) => ({
++      commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
++        apiUrl: `${middlewareUrl}/commerce`,
++        defaultRequestConfig: { headers: getRequestHeaders() },
+      }),
+  })
+);
+```
+
+- **[CHANGED]** deprecate `getCookieHeader`, use `getRequestHeaders` instead
+
+```diff [sdk.config.ts]
+export default defineSdkConfig(
+-  ({ buildModule, middlewareModule, middlewareUrl, getCookieHeader }) => ({
++  ({ buildModule, middlewareModule, middlewareUrl, getRequestHeaders }) => ({
+      commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
+        apiUrl: `${middlewareUrl}/commerce`,
+-        defaultRequestConfig: { headers: getCookieHeader() }, // Only cookie header is included.
++        defaultRequestConfig: { headers: getRequestHeaders() }, // All headers are included.
+      }),
+  })
+);
+```
+
+## 3.0.3
+
+- **[CHANGED]** `@nuxt/kit` locked `3.7.4` version to `@nuxt/kit@^3.7.4`
+
 ## 3.0.2
 
 - **[FIXED]** Multi-store URL calculation, now working correctly in the browser.

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "3.0.2"
+  "version": "3.1.0"
 }

package/dist/runtime/defineSdkConfig.template

@@ -1,11 +1,17 @@
-import { buildModule } from "@vue-storefront/sdk";
+import { buildModule, middlewareModule } from "@vue-storefront/sdk";
 import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders } from "#imports";
 import { SdkModuleOptions } from "./vsfModule";
 
 type InjectedContext = {
   buildModule: typeof buildModule;
+  middlewareModule: typeof middlewareModule;
   middlewareUrl: string;
+  /**
+   * @deprecated
+   * Use `getRequestHeaders` instead.
+   */
   getCookieHeader: () => Record<string, string>;
+  getRequestHeaders: () => Record<string, string>;
 };
 
 type Config<TConfig> = (context: InjectedContext) => TConfig;
@@ -23,18 +29,15 @@ const moduleConfig: SdkModuleOptions = <%= options.moduleConfig %>;
   *   contentfulModule,
   *   ContentfulModuleType,
   * } from "@vsf-enterprise/contentful-sdk";
-  * import { unifiedModule } from "@vsf-enterprise/unified-sdk";
-  * import type { UnifiedApiExtension } from "../storefront-middleware/middleware.config";
+  * import type { UnifiedApiEndpoints } from "../storefront-middleware/types";
   * 
   * export default defineSdkConfig(
-  *   ({ buildModule, middlewareUrl, getCookieHeader }) => ({
-  *     unified: buildModule(unifiedModule<UnifiedApiExtension>, {
+  *   ({ buildModule, middlewareModule, middlewareUrl, getCookieHeader }) => ({
+  *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
   *       apiUrl: middlewareUrl + "/commerce",
-  *       requestOptions: {
-  *         headers: getCookieHeader,
-  *       },
+  *       defaultRequestConfig: { headers: { ...getCookieHeader() } },
   *     }),
-  *     contentful: buildModule<ContentfulModuleType>(contentfulModule, {
+  *     contentful: buildModule(contentfulModule, {
   *       apiUrl: middlewareUrl + "/cntf",
   *     }),
   *   }),
@@ -58,11 +61,14 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
     });
 
     const getCookieHeader = () => useRequestHeaders(["cookie"]);
+    const getRequestHeaders = () => useRequestHeaders();
 
     return config({
       buildModule,
+      middlewareModule,
       middlewareUrl,
-      getCookieHeader
+      getCookieHeader,
+      getRequestHeaders
     });
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Vue Storefront dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
@@ -22,23 +22,22 @@
     "dev": "cd __tests__/app && yarn dev",
     "dev:middleware": "cd ../../shared/src/__tests__/middleware && yarn dev",
     "lint": "eslint --ext .vue,.js,.ts .",
-    "test": "start-server-and-test dev:middleware localhost:4000/test_integration/success dev localhost:3000/ssr \"yarn test:e2e\"",
+    "test": "start-server-and-test dev:middleware localhost:4000/test_integration/getSuccess dev localhost:3000/ssr \"yarn test:e2e\"",
     "test:e2e": "cd ../../shared/ && yarn test:e2e",
     "test:watch": "vitest watch",
     "prepare": "nuxi prepare"
   },
   "dependencies": {
-    "@nuxt/kit": "3.7.4",
-    "@vue-storefront/sdk": "^1.0.0",
+    "@nuxt/kit": "^3.7.4",
+    "@nuxt/schema": "^3.7.4",
+    "@vue-storefront/sdk": "^1.4.0",
     "knitwork": "^1.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",
     "@nuxt/devtools": "^1.0.0",
     "@nuxt/module-builder": "0.5.2",
-    "@nuxt/schema": "3.7.4",
     "@nuxt/test-utils": "3.7.4",
-    "@vue-storefront/sdk": "*",
     "nuxt": "3.7.4",
     "start-server-and-test": "^2.0.3",
     "vitest": "^0.34.6"