[DO NOT MERGE] fix(es-1487): resolve middleware url for custom domains docs update (#7388)

* chore: update docs

* refactor: require ssrApiUrl in buildModule

* docs: additional updates

Author: lsliwaradioluz

.changeset/lucky-zebras-destroy.md

@@ -0,0 +1,5 @@
+---
+"@vue-storefront/sdk": major
+---
+
+[CHANGED] The `ssrApiUrl` module option is now required by the `buildModule()` function.

docs/content/4.sdk/2.getting-started/1.index.md

@@ -51,10 +51,15 @@ export function getSdkOptions() {
   const ssrApiUrl = env('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_SSR_API_URL');
   const cdnCacheBustingId = env('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_CDN_CACHE_BUSTING_ID') ?? 'no-cache-busting-id-set';
   const isMultiStoreEnabled = env('NEXT_PUBLIC_ALOKAI_MULTISTORE_ENABLED') === 'true';
+  
   if (!apiUrl) {
     throw new Error('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_API_URL is required to run the app');
   }
 
+  if (!ssrApiUrl) {
+    throw new Error('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_SSR_API_URL is required to run the app');
+  }
+
   const options = resolveSdkOptions({
     middleware: {
       apiUrl,
@@ -80,13 +85,15 @@ import type { CommerceEndpoints, UnifiedEndpoints } from "storefront-middleware/
 export function getSdkConfig() {
   return defineSdkConfig(({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
     commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
-      apiUrl: config.middlewareUrl + "/commerce",
+      apiUrl: config.apiUrl + "/commerce",
+      ssrApiUrl: config.ssrApiUrl + "/commerce",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },
     }),
     cms: buildModule(contentfulModule, {
-      apiUrl: config.middlewareUrl + "/cms",
+      apiUrl: config.apiUrl + "/cms",
+      ssrApiUrl: config.ssrApiUrl + "/cms",
     }),
   }));
 }
@@ -378,13 +385,15 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
 export default defineSdkConfig(
   ({ buildModule, config, middlewareModule getRequestHeaders }) => ({
     commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
-      apiUrl: config.middlewareUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
+      apiUrl: config.apiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
+      ssrApiUrl: config.ssrApiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },
     }),
     cms: buildModule(contentfulModule, {
-      apiUrl: config.middlewareUrl + "/cms",
+      apiUrl: config.apiUrl + "/cms",
+      ssrApiUrl: config.ssrApiUrl + "/cms",
     }),
   })
 );

docs/content/4.sdk/2.getting-started/3.middleware-module.md

@@ -25,7 +25,8 @@ export const { getSdk } = createSdk(
   options,
   ({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
     commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
-      apiUrl: config.middlewareUrl + "/commerce",
+      apiUrl: config.apiUrl + "/commerce",
+      ssrApiUrl: config.ssrApiUrl + "/commerce",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },
@@ -43,7 +44,8 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
 export default defineSdkConfig(
   ({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
     commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
-      apiUrl: config.middlewareUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
+      apiUrl: config.apiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
+      ssrApiUrl: config.ssrApiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },
@@ -124,7 +126,7 @@ export const sdk = initSDK({
 The `middlewareModule` accepts the following options:
 
 - `apiUrl` - the URL of the middleware server,
-- `ssrApiUrl` - (Optional) the URL of the middleware server during SSR,
+- `ssrApiUrl` - the URL of the middleware server during SSR,
 - `defaultRequestConfig` - (Optional) default request config for each request,
 - `httpClient` - (Optional) a custom HTTP client,
 - `errorHandler` - (Optional) a custom error handler for HTTP requests.
@@ -376,7 +378,8 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
 export function getSdkConfig() {
   return defineSdkConfig(({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
     commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
-      apiUrl: config.middlewareUrl + "/commerce",
+      apiUrl: config.apiUrl + "/commerce",
+      ssrApiUrl: config.ssrApiUrl + "/commerce",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },
@@ -393,7 +396,8 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
 export default defineSdkConfig(
   ({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
     commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
-      apiUrl: config.middlewareUrl + "/commerce",
+      apiUrl: config.apiUrl + "/commerce",
+      ssrApiUrl: config.ssrApiUrl + "/commerce",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },

docs/content/guides/2.alokai-essentials/1.alokai-next-js/4.install-sdk.md

@@ -48,7 +48,8 @@ export const { getSdk } = createSdk(
   options,
   ({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
     sapcc: buildModule(middlewareModule<Endpoints>, {
-      apiUrl: config.middlewareUrl + "/sapcc",
+      apiUrl: config.apiUrl + "/sapcc",
+      ssrApiUrl: config.ssrApiUrl + "/sapcc",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },

docs/content/guides/2.alokai-essentials/1.alokai-next-js/9.udl.md

@@ -213,8 +213,10 @@ export const { getSdk } = createSdk(
   ({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
 -    sapcc: buildModule(middlewareModule<Endpoints>, {
 +    unified: buildModule(middlewareModule<UnifiedEndpoints>, {
--      apiUrl: config.middlewareUrl + "/sapcc",
-+      apiUrl: config.middlewareUrl + "/commerce",
+-      apiUrl: config.apiUrl + "/sapcc",
++      apiUrl: config.apiUrl + "/commerce",
+-      ssrApiUrl: config.ssrApiUrl + "/sapcc",
++      ssrApiUrl: config.ssrApiUrl + "/commerce",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },

docs/content/guides/2.alokai-essentials/3.alokai-nuxt/4.install-sdk.md

@@ -42,7 +42,8 @@ import type { Endpoints } from "@vsf-enterprise/sapcc-api";
 export default defineSdkConfig(
   ({ buildModule, middlewareModule, getRequestHeaders, config }) => ({
     sapcc: buildModule(middlewareModule<Endpoints>, {
-      apiUrl: config.middlewareUrl + "/sapcc",
+      apiUrl: config.apiUrl + "/sapcc",
+      ssrApiUrl: config.ssrApiUrl + "/sapcc",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },

docs/content/guides/2.alokai-essentials/3.alokai-nuxt/9.udl.md

@@ -205,8 +205,10 @@ export default defineSdkConfig(
   ({ buildModule, middlewareModule, getRequestHeaders, config }) => ({
 -    sapcc: buildModule(middlewareModule<Endpoints>, {
 +    commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
--      apiUrl: config.middlewareUrl + "/sapcc",
-+      apiUrl: config.middlewareUrl + "/commerce",
+-      apiUrl: config.apiUrl + "/sapcc",
++      apiUrl: config.apiUrl + "/commerce",
+-      ssrApiUrl: config.ssrApiUrl + "/sapcc",
++      ssrApiUrl: config.ssrApiUrl + "/commerce",
       defaultRequestConfig: {
         headers: getRequestHeaders(),
       },