Skip to content

Commit 31a00c7

Browse files
lsliwaradioluzlsliwaradioluz
authored
[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
1 parent 6e7adc3 commit 31a00c7

File tree

10 files changed

+86
-24
lines changed

10 files changed

+86
-24
lines changed

‎.changeset/lucky-zebras-destroy.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@vue-storefront/sdk": major
3+
---
4+
5+
[CHANGED] The `ssrApiUrl` module option is now required by the `buildModule()` function.

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

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,15 @@ export function getSdkOptions() {
5151
const ssrApiUrl = env('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_SSR_API_URL');
5252
const cdnCacheBustingId = env('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_CDN_CACHE_BUSTING_ID') ?? 'no-cache-busting-id-set';
5353
const isMultiStoreEnabled = env('NEXT_PUBLIC_ALOKAI_MULTISTORE_ENABLED') === 'true';
54+
5455
if (!apiUrl) {
5556
throw new Error('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_API_URL is required to run the app');
5657
}
5758

59+
if (!ssrApiUrl) {
60+
throw new Error('NEXT_PUBLIC_ALOKAI_MIDDLEWARE_SSR_API_URL is required to run the app');
61+
}
62+
5863
const options = resolveSdkOptions({
5964
middleware: {
6065
apiUrl,
@@ -80,13 +85,15 @@ import type { CommerceEndpoints, UnifiedEndpoints } from "storefront-middleware/
8085
export function getSdkConfig() {
8186
return defineSdkConfig(({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
8287
commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
83-
apiUrl: config.middlewareUrl + "/commerce",
88+
apiUrl: config.apiUrl + "/commerce",
89+
ssrApiUrl: config.ssrApiUrl + "/commerce",
8490
defaultRequestConfig: {
8591
headers: getRequestHeaders(),
8692
},
8793
}),
8894
cms: buildModule(contentfulModule, {
89-
apiUrl: config.middlewareUrl + "/cms",
95+
apiUrl: config.apiUrl + "/cms",
96+
ssrApiUrl: config.ssrApiUrl + "/cms",
9097
}),
9198
}));
9299
}
@@ -378,13 +385,15 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
378385
export default defineSdkConfig(
379386
({ buildModule, config, middlewareModule getRequestHeaders }) => ({
380387
commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
381-
apiUrl: config.middlewareUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
388+
apiUrl: config.apiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
389+
ssrApiUrl: config.ssrApiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
382390
defaultRequestConfig: {
383391
headers: getRequestHeaders(),
384392
},
385393
}),
386394
cms: buildModule(contentfulModule, {
387-
apiUrl: config.middlewareUrl + "/cms",
395+
apiUrl: config.apiUrl + "/cms",
396+
ssrApiUrl: config.ssrApiUrl + "/cms",
388397
}),
389398
})
390399
);

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ export const { getSdk } = createSdk(
2525
options,
2626
({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
2727
commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
28-
apiUrl: config.middlewareUrl + "/commerce",
28+
apiUrl: config.apiUrl + "/commerce",
29+
ssrApiUrl: config.ssrApiUrl + "/commerce",
2930
defaultRequestConfig: {
3031
headers: getRequestHeaders(),
3132
},
@@ -43,7 +44,8 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
4344
export default defineSdkConfig(
4445
({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
4546
commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
46-
apiUrl: config.middlewareUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
47+
apiUrl: config.apiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
48+
ssrApiUrl: config.ssrApiUrl + "/commerce", // SAP Commerce Cloud integration is available at /commerce endpoint
4749
defaultRequestConfig: {
4850
headers: getRequestHeaders(),
4951
},
@@ -124,7 +126,7 @@ export const sdk = initSDK({
124126
The `middlewareModule` accepts the following options:
125127

126128
- `apiUrl` - the URL of the middleware server,
127-
- `ssrApiUrl` - (Optional) the URL of the middleware server during SSR,
129+
- `ssrApiUrl` - the URL of the middleware server during SSR,
128130
- `defaultRequestConfig` - (Optional) default request config for each request,
129131
- `httpClient` - (Optional) a custom HTTP client,
130132
- `errorHandler` - (Optional) a custom error handler for HTTP requests.
@@ -376,7 +378,8 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
376378
export function getSdkConfig() {
377379
return defineSdkConfig(({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
378380
commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
379-
apiUrl: config.middlewareUrl + "/commerce",
381+
apiUrl: config.apiUrl + "/commerce",
382+
ssrApiUrl: config.ssrApiUrl + "/commerce",
380383
defaultRequestConfig: {
381384
headers: getRequestHeaders(),
382385
},
@@ -393,7 +396,8 @@ import { UnifiedEndpoints } from "storefront-middleware/types";
393396
export default defineSdkConfig(
394397
({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
395398
commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
396-
apiUrl: config.middlewareUrl + "/commerce",
399+
apiUrl: config.apiUrl + "/commerce",
400+
ssrApiUrl: config.ssrApiUrl + "/commerce",
397401
defaultRequestConfig: {
398402
headers: getRequestHeaders(),
399403
},

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ export const { getSdk } = createSdk(
4848
options,
4949
({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
5050
sapcc: buildModule(middlewareModule<Endpoints>, {
51-
apiUrl: config.middlewareUrl + "/sapcc",
51+
apiUrl: config.apiUrl + "/sapcc",
52+
ssrApiUrl: config.ssrApiUrl + "/sapcc",
5253
defaultRequestConfig: {
5354
headers: getRequestHeaders(),
5455
},

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,10 @@ export const { getSdk } = createSdk(
213213
({ buildModule, config, middlewareModule, getRequestHeaders }) => ({
214214
- sapcc: buildModule(middlewareModule<Endpoints>, {
215215
+ unified: buildModule(middlewareModule<UnifiedEndpoints>, {
216-
- apiUrl: config.middlewareUrl + "/sapcc",
217-
+ apiUrl: config.middlewareUrl + "/commerce",
216+
- apiUrl: config.apiUrl + "/sapcc",
217+
+ apiUrl: config.apiUrl + "/commerce",
218+
- ssrApiUrl: config.ssrApiUrl + "/sapcc",
219+
+ ssrApiUrl: config.ssrApiUrl + "/commerce",
218220
defaultRequestConfig: {
219221
headers: getRequestHeaders(),
220222
},

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ import type { Endpoints } from "@vsf-enterprise/sapcc-api";
4242
export default defineSdkConfig(
4343
({ buildModule, middlewareModule, getRequestHeaders, config }) => ({
4444
sapcc: buildModule(middlewareModule<Endpoints>, {
45-
apiUrl: config.middlewareUrl + "/sapcc",
45+
apiUrl: config.apiUrl + "/sapcc",
46+
ssrApiUrl: config.ssrApiUrl + "/sapcc",
4647
defaultRequestConfig: {
4748
headers: getRequestHeaders(),
4849
},

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,10 @@ export default defineSdkConfig(
205205
({ buildModule, middlewareModule, getRequestHeaders, config }) => ({
206206
- sapcc: buildModule(middlewareModule<Endpoints>, {
207207
+ commerce: buildModule(middlewareModule<UnifiedEndpoints>, {
208-
- apiUrl: config.middlewareUrl + "/sapcc",
209-
+ apiUrl: config.middlewareUrl + "/commerce",
208+
- apiUrl: config.apiUrl + "/sapcc",
209+
+ apiUrl: config.apiUrl + "/commerce",
210+
- ssrApiUrl: config.ssrApiUrl + "/sapcc",
211+
+ ssrApiUrl: config.ssrApiUrl + "/commerce",
210212
defaultRequestConfig: {
211213
headers: getRequestHeaders(),
212214
},

0 commit comments

Comments
 (0)