@vue-storefront/nuxt 3.1.0 → 4.0.0

package/dist/module.json

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

package/dist/module.mjs

@@ -1,5 +1,6 @@
 import { defineNuxtModule, createResolver, addTypeTemplate, addImports, addTemplate, addPluginTemplate, addImportsSources } from '@nuxt/kit';
 import { genInlineTypeImport } from 'knitwork';
+import { defu } from 'defu';
 
 const module = defineNuxtModule({
   meta: {
@@ -22,6 +23,10 @@ const module = defineNuxtModule({
     const projectRootResolver = createResolver(projectLayer.config.rootDir);
     const buildDirResolver = createResolver(nuxt.options.buildDir);
     const localResolver = createResolver(import.meta.url);
+    nuxt.options.runtimeConfig.public.vsf = defu(
+      nuxt.options.runtimeConfig.public?.vsf,
+      options
+    );
     nuxt.options.app.head.meta = [
       ...nuxt.options.app.head.meta ?? [],
       {
@@ -46,6 +51,11 @@ export type SdkConfig = ${genInlineTypeImport(
       as: "composeMiddlewareUrl",
       from: localResolver.resolve("./runtime/utils/composeMiddlewareUrl")
     });
+    addImports({
+      name: "getDefaults",
+      as: "getDefaults",
+      from: localResolver.resolve("./runtime/utils/defaults")
+    });
     addTemplate({
       src: localResolver.resolve("./runtime/useSdk.template"),
       filename: "useSdk.ts",

package/dist/runtime/defineSdkConfig.template

@@ -1,5 +1,5 @@
 import { buildModule, middlewareModule } from "@vue-storefront/sdk";
-import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders } from "#imports";
+import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders, getDefaults } from "#imports";
 import { SdkModuleOptions } from "./vsfModule";
 
 type InjectedContext = {
@@ -12,6 +12,11 @@ type InjectedContext = {
    */
   getCookieHeader: () => Record<string, string>;
   getRequestHeaders: () => Record<string, string>;
+  defaults: ReturnType<typeof getDefaults>;
+  config: {
+    middlewareUrl: string;
+    defaults: ReturnType<typeof getDefaults>;
+  };
 };
 
 type Config<TConfig> = (context: InjectedContext) => TConfig;
@@ -30,7 +35,7 @@ const moduleConfig: SdkModuleOptions = <%= options.moduleConfig %>;
   *   ContentfulModuleType,
   * } from "@vsf-enterprise/contentful-sdk";
   * import type { UnifiedApiEndpoints } from "../storefront-middleware/types";
-  * 
+  *
   * export default defineSdkConfig(
   *   ({ buildModule, middlewareModule, middlewareUrl, getCookieHeader }) => ({
   *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
@@ -48,15 +53,10 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
   return () => {
     const nuxtApp = useNuxtApp()
     const runtimeConfig = useRuntimeConfig();
-    const { middleware, multistore } = runtimeConfig.public;
-    const resolvedOptions = {
-      middleware: middleware ?? moduleConfig.middleware,
-      multistore: multistore ?? moduleConfig.multistore,
-    }
 
     const requestHeaders = useRequestHeaders(["x-forwarded-host", "host"]);
     const middlewareUrl = composeMiddlewareUrl({
-      options: resolvedOptions,
+      options: runtimeConfig.public.vsf,
       headers: requestHeaders,
     });
 
@@ -66,9 +66,14 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
     return config({
       buildModule,
       middlewareModule,
-      middlewareUrl,
       getCookieHeader,
-      getRequestHeaders
+      getRequestHeaders,
+      defaults: getDefaults(),
+      middlewareUrl,
+      config: {
+        defaults: getDefaults(),
+        middlewareUrl,
+      }
     });
   }
 }

package/dist/runtime/utils/defaults.d.ts

@@ -0,0 +1,32 @@
+export declare function getDefaults(): {
+    readonly unifiedCommerce: {
+        readonly middlewareModule: {
+            readonly defaultMethodsRequestConfig: {
+                readonly getCategories: {
+                    readonly method: "GET";
+                };
+                readonly getProductDetails: {
+                    readonly method: "GET";
+                };
+                readonly getProductReviews: {
+                    readonly method: "GET";
+                };
+                readonly getProducts: {
+                    readonly method: "GET";
+                };
+                readonly searchProducts: {
+                    readonly method: "GET";
+                };
+            };
+        };
+    };
+    readonly unifiedCms: {
+        readonly middlewareModule: {
+            readonly defaultMethodsRequestConfig: {
+                readonly getEntries: {
+                    readonly method: "GET";
+                };
+            };
+        };
+    };
+};

package/dist/runtime/utils/defaults.mjs

@@ -0,0 +1,4 @@
+import { contextConfig } from "@storefront/shared";
+export function getDefaults() {
+  return contextConfig;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Vue Storefront dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
@@ -20,18 +20,19 @@
     "build": "nuxt-module-build build && yarn build:app",
     "build:app": "cd __tests__/app && yarn build",
     "dev": "cd __tests__/app && yarn dev",
-    "dev:middleware": "cd ../../shared/src/__tests__/middleware && 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/getSuccess dev localhost:3000/ssr \"yarn test:e2e\"",
-    "test:e2e": "cd ../../shared/ && yarn test:e2e",
+    "test:e2e:run": "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",
     "@nuxt/schema": "^3.7.4",
-    "@vue-storefront/sdk": "^1.4.0",
-    "knitwork": "^1.0.0"
+    "@vue-storefront/sdk": "^3.1.0",
+    "knitwork": "^1.0.0",
+    "defu": "^6.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

package/CHANGELOG.md

@@ -1,54 +0,0 @@
-# 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.
-
-## 3.0.1
-
-- **[CHANGED]** Set `@vue-storefront/sdk` as a dependency instead of a peer dependency
-
-## 3.0.0
-
-- **[BREAKING]** Rewritten from scratch. Now the package exports a Nuxt module which allows to initialize the Vue Storefront SDK.