@vue-storefront/nuxt 6.2.0 → 8.0.0

package/README.md

@@ -67,7 +67,7 @@ export default defineSdkConfig(
     contentful: buildModule<ContentfulModuleType>(contentfulModule, {
       apiUrl: middlewareUrl + "/cntf",
     }),
-  }),
+  })
 );
 ```
 

package/dist/module.d.mts

@@ -10,7 +10,7 @@ interface MiddlewareConfig {
      * The URL of the middleware for server-side rendering.
      * @example "http://localhost:4000"
      */
-    ssrApiUrl?: string;
+    ssrApiUrl: string;
     /**
      * This is identifier used to invalidate the cache on CDN when the assets change.
      * Usually it's a commit hash.

package/dist/module.d.ts

@@ -10,7 +10,7 @@ interface MiddlewareConfig {
      * The URL of the middleware for server-side rendering.
      * @example "http://localhost:4000"
      */
-    ssrApiUrl?: string;
+    ssrApiUrl: string;
     /**
      * This is identifier used to invalidate the cache on CDN when the assets change.
      * Usually it's a commit hash.

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "6.2.0",
+  "version": "8.0.0",
   "builder": {
     "@nuxt/module-builder": "0.7.1",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -11,9 +11,17 @@ const module = defineNuxtModule({
     }
   },
   defaults: {
+    /**
+     * In the `middleware` object, both `apiUrl` and `ssrApiUrl` keys have to be
+     * present to allow Nuxt replacing them with the actual values from the
+     * .env file at runtime.
+     * 
+     * https://nuxt.com/docs/guide/going-further/runtime-config
+     */
     middleware: {
-      apiUrl: "http://localhost:4000",
-      cdnCacheBustingId: "no-cache-busting-id-set"
+      apiUrl: "",
+      cdnCacheBustingId: "no-cache-busting-id-set",
+      ssrApiUrl: ""
     },
     multistore: {
       enabled: false
@@ -37,7 +45,7 @@ const module = defineNuxtModule({
       ...nuxt.options.app.head.meta ?? [],
       {
         name: "generator",
-        content: "Vue Storefront 2"
+        content: "Alokai Storefront"
       }
     ];
     addTypeTemplate({
@@ -52,11 +60,6 @@ export type SdkConfig = ${genInlineTypeImport(
       filename: "alokaiModule.d.ts",
       src: localResolver.resolve("./runtime/types.template")
     });
-    addImports({
-      name: "composeMiddlewareUrl",
-      as: "composeMiddlewareUrl",
-      from: localResolver.resolve("./runtime/utils/composeMiddlewareUrl")
-    });
     addImports({
       name: "getDefaultMethodsRequestConfig",
       as: "getDefaultMethodsRequestConfig",

package/dist/runtime/defineSdkConfig.template

@@ -1,15 +1,10 @@
 import { buildModule, middlewareModule } from "@vue-storefront/sdk";
-import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders, getDefaultMethodsRequestConfig } from "#imports";
+import { useNuxtApp, useRequestHeaders, getDefaultMethodsRequestConfig } from "#imports";
 import type { AlokaiModuleOptions } from "./alokaiModule";
 
 type InjectedContext = {
   buildModule: typeof buildModule;
   middlewareModule: typeof middlewareModule;
-  /**
-   * @deprecated
-   * Use `config.middlewareUrl` instead.
-   */
-  middlewareUrl: string;
   /**
    * @deprecated
    * Use `getRequestHeaders` instead.
@@ -22,7 +17,8 @@ type InjectedContext = {
    */
   defaults: ReturnType<typeof getDefaultMethodsRequestConfig>;
   config: {
-    middlewareUrl: string;
+    apiUrl: string;
+    ssrApiUrl: string;
     defaultMethodsRequestConfig: ReturnType<typeof getDefaultMethodsRequestConfig>;
     cdnCacheBustingId: string;
   };
@@ -48,13 +44,15 @@ const moduleConfig: AlokaiModuleOptions = <%= options.moduleConfig %>;
   * export default defineSdkConfig(
   *   ({ buildModule, middlewareModule, config, getCookieHeader }) => ({
   *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
-  *       apiUrl: config.middlewareUrl + "/commerce",
+  *       apiUrl: config.apiUrl + "/commerce",
+  *       ssrApiUrl: config.ssrApiUrl + "/commerce",
   *       defaultRequestConfig: { headers: { ...getCookieHeader() } },
   *       cdnCacheBustingId: config.cdnCacheBustingId,
   *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
   *     }),
   *     contentful: buildModule(contentfulModule, {
-  *       apiUrl: config.middlewareUrl + "/cntf",
+  *       apiUrl: config.apiUrl + "/cntf",
+  *       ssrApiUrl: config.ssrApiUrl + "/cntf",
   *     })
   *   }),
   * );
@@ -68,11 +66,6 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
     const requestHeaders = useRequestHeaders(["x-forwarded-host", "host"]);
     const resolvedOptions = resolveOptions(runtimeConfig.public.alokai);
 
-    const middlewareUrl = composeMiddlewareUrl({
-      options: resolvedOptions,
-      headers: requestHeaders,
-    });
-
     const getCookieHeader = () => useRequestHeaders(["cookie"]);
     const getRequestHeaders = () => useRequestHeaders();
 
@@ -82,35 +75,32 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
       getCookieHeader,
       getRequestHeaders,
       defaults: getDefaultMethodsRequestConfig(),
-      middlewareUrl,
       config: {
+        apiUrl: resolvedOptions.middleware.apiUrl,
+        ssrApiUrl: resolvedOptions.middleware.ssrApiUrl,
         defaultMethodsRequestConfig: getDefaultMethodsRequestConfig(),
-        middlewareUrl,
         cdnCacheBustingId: runtimeConfig.public.alokai.middleware.cdnCacheBustingId,
       }
     });
   }
 }
 
+/**
+ * Helper function to resolve the SDK options based on the configuration.
+ * 
+ * @privateRemarks
+ * For now this file only verifies the type of the input and simply returns it.
+ * However, in the future we might need it to perform true input resolution.
+ * 
+ * @param input - The options for creating the SDK.
+ * @param options - The configuration object, that allows to customize the API Url creation on enabled multistore.
+ *
+ * @returns The resolved SDK options.
+ */
 function resolveOptions(
   input: Omit<AlokaiModuleOptions, 'logger'>,
-  options: Partial<ResolveSdkOptionsConfig> = {}
+  _options: Partial<ResolveSdkOptionsConfig> = {}
 ): AlokaiModuleOptions {
-  if (input?.multistore?.enabled) {
-    return {
-      middleware: {
-        // This is a dummy URL, the localhost domain will be replaced by the actual domain in the browser
-        // in composeMiddlewareUrl function. The server-side rendering will use ssrApiUrl.
-        apiUrl: `https://localhost/${options?.customSuffix ?? "api"}`,
-        cdnCacheBustingId: input.middleware?.cdnCacheBustingId,
-        ssrApiUrl: input.middleware?.ssrApiUrl ?? input.middleware.apiUrl,
-      },
-      multistore: {
-        enabled: true,
-      },
-    };
-  }
-
   return input;
 }
 

package/dist/runtime/plugin.template

@@ -1,14 +1,23 @@
-import { initSDK } from "@vue-storefront/sdk"
-import sdkConfig from "~/sdk.config"
-import { defineNuxtPlugin } from '#app'
+import { initSDK, type SDKApi } from "@vue-storefront/sdk";
+import sdkConfig from "~/sdk.config";
+import type { SdkConfig } from "./sdk.config";
+import { defineNuxtPlugin } from '#app';
 
 export default defineNuxtPlugin(() => {
-  const config = sdkConfig();
-  const sdk = initSDK<typeof config>(config);
+  let sdk: SDKApi<ReturnType<SdkConfig>>;
+
+  const getSdk = () => {
+    if (!sdk) {
+      const config = sdkConfig();
+      sdk = initSDK(config);
+    }
+
+    return sdk;
+  };
 
   return {
     provide: {
-      alokai: { sdk }
-    }
-  }
-})
+      alokai: { getSdk },
+    },
+  };
+});

package/dist/runtime/types.template

@@ -8,7 +8,7 @@ export interface MiddlewareConfig {
    * The URL of the middleware for server-side rendering.
    * @example "http://localhost:4000"
    */
-  ssrApiUrl?: string;
+  ssrApiUrl: string;
   /**
    * This is identifier used to invalidate the cache on CDN when the assets change.
    * Usually it's a commit hash.

package/dist/runtime/useSdk.template

@@ -4,7 +4,7 @@ import { useNuxtApp } from "#imports";
 
 export const useSdk = () => {
   const nuxtApp = useNuxtApp();
-  const { sdk } = nuxtApp.$alokai as { sdk: SDKApi<ReturnType<SdkConfig>> };
+  const { getSdk } = nuxtApp.$alokai as { getSdk: ()=> SDKApi<ReturnType<SdkConfig>> };
 
-  return sdk;
+  return getSdk();
 };

package/dist/types.d.mts

@@ -3,11 +3,14 @@ import type {  } from './module.js'
 
   export interface ModuleOptions {
  middleware: {
-  /** @default "http://localhost:4000" */
+  /** @default "" */
   apiUrl: string,
 
   /** @default "no-cache-busting-id-set" */
   cdnCacheBustingId: string,
+
+  /** @default "" */
+  ssrApiUrl: string,
  },
 
  multistore: {

package/dist/types.d.ts

@@ -3,11 +3,14 @@ import type {  } from './module'
 
   export interface ModuleOptions {
  middleware: {
-  /** @default "http://localhost:4000" */
+  /** @default "" */
   apiUrl: string,
 
   /** @default "no-cache-busting-id-set" */
   cdnCacheBustingId: string,
+
+  /** @default "" */
+  ssrApiUrl: string,
  },
 
  multistore: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "6.2.0",
+  "version": "8.0.0",
   "description": "Alokai dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
@@ -20,7 +20,9 @@
     "build": "nuxt-module-build build",
     "lint": "biome ci .",
     "format": "prettier --write .",
-    "prepare": "nuxi prepare"
+    "prepare": "nuxi prepare",
+    "test:unit": "vitest run",
+    "version": "cp CHANGELOG.md ../../docs/content/storefront/6.change-log/nuxt.md"
   },
   "dependencies": {
     "@nuxt/kit": "^3.7.4",
@@ -35,13 +37,13 @@
     "@types/node": "^18.11.17",
     "@nuxt/devtools": "1.3.8",
     "@nuxt/module-builder": "0.7.1",
-    "@vue-storefront/sdk": "3.3.0",
+    "@vue-storefront/sdk": "3.4.1",
     "@vue-storefront/unified-data-model": "*",
     "@biomejs/biome": "1.9.2",
     "nuxt": "3.12.2"
   },
   "peerDependencies": {
-    "@vue-storefront/sdk": "3.3.0"
+    "@vue-storefront/sdk": "3.4.1"
   },
   "publishConfig": {
     "access": "public"

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

@@ -1,10 +0,0 @@
-import type { AlokaiModuleOptions } from "~/src/types";
-interface ComposeMiddlewareUrlParams {
-    options: AlokaiModuleOptions;
-    headers: Record<string, string | string[]>;
-}
-/**
- * @description A helper function to compute the middleware url. It will be used only internally in the package
- */
-export declare function composeMiddlewareUrl({ options, headers, }: ComposeMiddlewareUrlParams): string;
-export {};

package/dist/runtime/utils/composeMiddlewareUrl.js

@@ -1,34 +0,0 @@
-function calculateMiddlewareUrl({
-  options,
-  headers
-}) {
-  const { apiUrl, ssrApiUrl } = options.middleware;
-  if (typeof window !== "undefined") {
-    if (options.multistore?.enabled) {
-      const url2 = new URL(apiUrl);
-      url2.host = window.location.host;
-      return url2.href;
-    }
-    return apiUrl;
-  }
-  if (ssrApiUrl) {
-    return ssrApiUrl;
-  }
-  if (!options.multistore?.enabled) {
-    return apiUrl;
-  }
-  const forwardedHost = headers["x-forwarded-host"] ?? headers.host;
-  const url = new URL(apiUrl);
-  url.host = forwardedHost && [...forwardedHost].join("") || new URL(apiUrl).host;
-  return url.href;
-}
-function removeTrailingSlash(url) {
-  return url.replace(/\/$/, "");
-}
-export function composeMiddlewareUrl({
-  options,
-  headers
-}) {
-  const url = calculateMiddlewareUrl({ options, headers });
-  return removeTrailingSlash(url);
-}