Updated @vue-storefront/nuxt to latest sdk version & set cdnCacheBust…

…ingId as optional for sdk (#7189) * updated @vue-storefront/nuxt to latest sdk version & set cdnCacheBustingId option in sdk as optional * chore: changed planned version * docs: regenerated changeset * feat: cr tweaks * feat: cdnCacheBustingId is not being attached to the url when not provided * feat: adjusted code to match types
vuestorefront · Jun 17, 2024 · 9703ef9 · 9703ef9
1 parent 877c7b1
commit 9703ef9
Show file tree

Hide file tree

Showing 13 changed files with 63 additions and 15 deletions.
diff --git a/.changeset/four-walls-fail.md b/.changeset/four-walls-fail.md
@@ -0,0 +1,5 @@
+---
+"@vue-storefront/next": minor
+---
+
+- **[ADDED]** Added .config parameter in createSdk callback
diff --git a/.changeset/grumpy-boats-thank.md b/.changeset/grumpy-boats-thank.md
@@ -0,0 +1,5 @@
+---
+"@vue-storefront/sdk": minor
+---
+
+- **[CHANGED]** cdnCacheBustingId is now optional
diff --git a/.changeset/thin-grapes-exist.md b/.changeset/thin-grapes-exist.md
@@ -0,0 +1,7 @@
+---
+"@vue-storefront/nuxt": major
+---
+
+- **[CHANGED]** Updated core sdk dependency to latest version
+- **[ADDED]** Added .config parameter in createSdk callback
+
diff --git a/packages/next/src/sdk/index.tsx b/packages/next/src/sdk/index.tsx
@@ -58,7 +58,11 @@ export function createSdk<TConfig extends Record<string, any>>(
       buildModule,
       middlewareModule,
       getRequestHeaders,
-      middlewareUrl
+      middlewareUrl,
+      config: {
+        middlewareUrl,
+        defaults: contextConfig,
+      }
     });
 
     return initSDK(resolvedConfig);

diff --git a/packages/next/src/sdk/types.ts b/packages/next/src/sdk/types.ts
@@ -19,6 +19,10 @@ export type StaticContext = {
   middlewareModule: typeof middlewareModule;
   middlewareUrl: string;
   defaults: typeof contextConfig;
+  config: {
+    middlewareUrl: string;
+    defaults: typeof contextConfig;
+  };
 };
 
 type InjectedContext = DynamicContext & StaticContext;

diff --git a/packages/nuxt/package.json b/packages/nuxt/package.json
@@ -30,7 +30,7 @@
   "dependencies": {
     "@nuxt/kit": "^3.7.4",
     "@nuxt/schema": "^3.7.4",
-    "@vue-storefront/sdk": "^1.4.0",
+    "@vue-storefront/sdk": "^3.0.0",
     "knitwork": "^1.0.0",
     "defu": "^6.0.0"
   },

diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -67,6 +67,12 @@ export type SdkConfig = ${genInlineTypeImport(
       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",

diff --git a/packages/nuxt/src/runtime/defineSdkConfig.template b/packages/nuxt/src/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;
@@ -61,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,
+      }
     });
   }
 }
diff --git a/packages/nuxt/src/runtime/utils/defaults.ts b/packages/nuxt/src/runtime/utils/defaults.ts
@@ -0,0 +1,5 @@
+import { contextConfig } from "@storefront/shared";
+
+export function getDefaults() {
+  return contextConfig;
+}
diff --git a/packages/nuxt/tsconfig.json b/packages/nuxt/tsconfig.json
@@ -1,3 +1,8 @@
 {
-  "extends": "./.nuxt/tsconfig.json"
+  "extends": "./.nuxt/tsconfig.json",
+  "compilerOptions": {
+    "paths": {
+      "@storefront/shared": ["../shared"]
+    }
+  },
 }
diff --git a/packages/sdk/src/modules/middlewareModule/types.ts b/packages/sdk/src/modules/middlewareModule/types.ts
@@ -263,7 +263,7 @@ export type Options<
   /**
    * Unique identifier for CDN cache busting.
    */
-  cdnCacheBustingId: string;
+  cdnCacheBustingId?: string;
 };
 
 /**

diff --git a/packages/sdk/src/modules/middlewareModule/utils/getRequestSender.ts b/packages/sdk/src/modules/middlewareModule/utils/getRequestSender.ts
@@ -22,7 +22,7 @@ export const getRequestSender = (options: Options): RequestSender => {
     ssrApiUrl,
     defaultRequestConfig = {},
     methodsRequestConfig = {},
-    cdnCacheBustingId,
+    cdnCacheBustingId = undefined,
   } = options;
 
   const getUrl = (
@@ -48,9 +48,11 @@ export const getRequestSender = (options: Options): RequestSender => {
     // If there are query params, append them to the URL as `?body=[<strignified query params>]`
     const serializedBody = encodeURIComponent(JSON.stringify(params));
     // Serialize CDN cache busting ID
-    const serializedCdnCacheBustingId = encodeURIComponent(cdnCacheBustingId);
+    const serializedCdnCacheBustingId = cdnCacheBustingId
+      ? `&cdnCacheBustingId=${encodeURIComponent(cdnCacheBustingId)}`
+      : "";
 
-    return `${url}?body=${serializedBody}&cdnCacheBustingId=${serializedCdnCacheBustingId}`;
+    return `${url}?body=${serializedBody}${serializedCdnCacheBustingId}`;
   };
 
   const getConfig = (

diff --git a/yarn.lock b/yarn.lock
@@ -5038,11 +5038,6 @@
     rollup "^2.59.0"
     rollup-plugin-typescript2 "^0.35.0"
 
-"@vue-storefront/sdk@^1.4.0":
-  version "1.5.0"
-  resolved "https://registry.yarnpkg.com/@vue-storefront/sdk/-/sdk-1.5.0.tgz#f283eb57a5113e355206a0590dab874a6739e8e8"
-  integrity sha512-dV6CBCx3XcEdd9EmAtvyY5sPecRMYMDCpMcbbDKvRgzAh+VjCjvSr11PvRqHx3lSYeKQcQdQZtgkk95lEz07YQ==
-
 "@vue-storefront/theme-utilities@^0.2.0":
   version "0.2.0"
   resolved "https://registry.npmjs.org/@vue-storefront/theme-utilities/-/theme-utilities-0.2.0.tgz#c4dde4801c4413b51e354d9b0df7064d34c9572e"