@vue-storefront/nuxt 4.0.1 → 4.1.0

package/dist/module.d.mts

@@ -11,6 +11,13 @@ interface MiddlewareConfig {
      * @example "http://localhost:4000"
      */
     ssrApiUrl?: string;
+    /**
+     * This is identifier used to invalidate the cache on CDN when the assets change.
+     * Usually it's a commit hash.
+     * @example "2c106d9619c71c3082c9b59b1d72817363c8ecb9"
+     * @default "no-cache-busting-id-set"
+     */
+    cdnCacheBustingId?: string;
 }
 interface MultistoreConfig {
     /**

package/dist/module.d.ts

@@ -11,6 +11,13 @@ interface MiddlewareConfig {
      * @example "http://localhost:4000"
      */
     ssrApiUrl?: string;
+    /**
+     * This is identifier used to invalidate the cache on CDN when the assets change.
+     * Usually it's a commit hash.
+     * @example "2c106d9619c71c3082c9b59b1d72817363c8ecb9"
+     * @default "no-cache-busting-id-set"
+     */
+    cdnCacheBustingId?: string;
 }
 interface MultistoreConfig {
     /**

package/dist/module.json

@@ -4,5 +4,9 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "4.0.1"
+  "version": "4.1.0",
+  "builder": {
+    "@nuxt/module-builder": "0.7.1",
+    "unbuild": "2.0.0"
+  }
 }

package/dist/module.mjs

@@ -12,7 +12,8 @@ const module = defineNuxtModule({
   },
   defaults: {
     middleware: {
-      apiUrl: "http://localhost:4000"
+      apiUrl: "http://localhost:4000",
+      cdnCacheBustingId: "no-cache-busting-id-set"
     },
     multistore: {
       enabled: false
@@ -21,12 +22,18 @@ const module = defineNuxtModule({
   setup(options, nuxt) {
     const projectLayer = nuxt.options._layers[0];
     const projectRootResolver = createResolver(projectLayer.config.rootDir);
-    const buildDirResolver = createResolver(nuxt.options.buildDir);
+    const buildDirectoryResolver = createResolver(nuxt.options.buildDir);
     const localResolver = createResolver(import.meta.url);
     nuxt.options.runtimeConfig.public.vsf = defu(
       nuxt.options.runtimeConfig.public?.vsf,
       options
     );
+    nuxt.options.runtimeConfig.public.alokai = defu(
+      nuxt.options.runtimeConfig.public?.alokai,
+      { middleware: { cdnCacheBustingId: process.env?.GIT_SHA } },
+      nuxt.options.runtimeConfig.public?.vsf,
+      options
+    );
     nuxt.options.app.head.meta = [
       ...nuxt.options.app.head.meta ?? [],
       {
@@ -43,7 +50,7 @@ export type SdkConfig = ${genInlineTypeImport(
       `
     });
     addTypeTemplate({
-      filename: "vsfModule.d.ts",
+      filename: "alokaiModule.d.ts",
       src: localResolver.resolve("./runtime/types.template")
     });
     addImports({
@@ -52,8 +59,8 @@ export type SdkConfig = ${genInlineTypeImport(
       from: localResolver.resolve("./runtime/utils/composeMiddlewareUrl")
     });
     addImports({
-      name: "getDefaults",
-      as: "getDefaults",
+      name: "getDefaultMethodsRequestConfig",
+      as: "getDefaultMethodsRequestConfig",
       from: localResolver.resolve("./runtime/utils/defaults")
     });
     addTemplate({
@@ -71,17 +78,17 @@ export type SdkConfig = ${genInlineTypeImport(
     });
     addPluginTemplate({
       src: localResolver.resolve("./runtime/plugin.template"),
-      filename: "vsfSdkPlugin.ts",
+      filename: "alokaiSdkPlugin.ts",
       write: true
     });
     addImportsSources([
       {
         imports: ["useSdk"],
-        from: buildDirResolver.resolve("useSdk.ts")
+        from: buildDirectoryResolver.resolve("useSdk.ts")
       },
       {
         imports: ["defineSdkConfig"],
-        from: buildDirResolver.resolve("defineSdkConfig.ts")
+        from: buildDirectoryResolver.resolve("defineSdkConfig.ts")
       }
     ]);
   }

package/dist/runtime/defineSdkConfig.template

@@ -1,10 +1,14 @@
 import { buildModule, middlewareModule } from "@vue-storefront/sdk";
-import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders, getDefaults } from "#imports";
-import { SdkModuleOptions } from "./vsfModule";
+import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders, getDefaultMethodsRequestConfig } from "#imports";
+import { SdkModuleOptions } from "./alokaiModule";
 
 type InjectedContext = {
   buildModule: typeof buildModule;
   middlewareModule: typeof middlewareModule;
+  /**
+   * @deprecated
+   * Use `config.middlewareUrl` instead.
+   */
   middlewareUrl: string;
   /**
    * @deprecated
@@ -12,10 +16,15 @@ type InjectedContext = {
    */
   getCookieHeader: () => Record<string, string>;
   getRequestHeaders: () => Record<string, string>;
-  defaults: ReturnType<typeof getDefaults>;
+  /**
+   * @deprecated
+   * Use `config.defaults` instead.
+   */
+  defaults: ReturnType<typeof getDefaultMethodsRequestConfig>;
   config: {
     middlewareUrl: string;
-    defaults: ReturnType<typeof getDefaults>;
+    defaultMethodsRequestConfig: ReturnType<typeof getDefaultMethodsRequestConfig>;
+    cdnCacheBustingId: string;
   };
 };
 
@@ -37,13 +46,15 @@ const moduleConfig: SdkModuleOptions = <%= options.moduleConfig %>;
   * import type { UnifiedApiEndpoints } from "../storefront-middleware/types";
   *
   * export default defineSdkConfig(
-  *   ({ buildModule, middlewareModule, middlewareUrl, getCookieHeader }) => ({
+  *   ({ buildModule, middlewareModule, config, getCookieHeader }) => ({
   *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
-  *       apiUrl: middlewareUrl + "/commerce",
+  *       apiUrl: config.middlewareUrl + "/commerce",
   *       defaultRequestConfig: { headers: { ...getCookieHeader() } },
+  *       cdnCacheBustingId: config.cdnCacheBustingId,
+  *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
   *     }),
   *     contentful: buildModule(contentfulModule, {
-  *       apiUrl: middlewareUrl + "/cntf",
+  *       apiUrl: config.middlewareUrl + "/cntf",
   *     }),
   *   }),
   * );
@@ -56,7 +67,7 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
 
     const requestHeaders = useRequestHeaders(["x-forwarded-host", "host"]);
     const middlewareUrl = composeMiddlewareUrl({
-      options: runtimeConfig.public.vsf,
+      options: runtimeConfig.public.alokai,
       headers: requestHeaders,
     });
 
@@ -68,11 +79,12 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
       middlewareModule,
       getCookieHeader,
       getRequestHeaders,
-      defaults: getDefaults(),
+      defaults: getDefaultMethodsRequestConfig(),
       middlewareUrl,
       config: {
-        defaults: getDefaults(),
+        defaultMethodsRequestConfig: getDefaultMethodsRequestConfig(),
         middlewareUrl,
+        cdnCacheBustingId: runtimeConfig.public.alokai.middleware.cdnCacheBustingId,
       }
     });
   }

package/dist/runtime/plugin.template

@@ -8,7 +8,7 @@ export default defineNuxtPlugin(() => {
 
   return {
     provide: {
-      vsf: { sdk }
+      alokai: { sdk }
     }
   }
 })

package/dist/runtime/types.template

@@ -1,13 +1,33 @@
 export interface MiddlewareConfig {
+  /**
+   * The URL of the middleware.
+   * @example "http://localhost:4000"
+   */
   apiUrl: string;
+  /**
+   * The URL of the middleware for server-side rendering.
+   * @example "http://localhost:4000"
+   */
   ssrApiUrl?: string;
+  /**
+   * This is identifier used to invalidate the cache on CDN when the assets change.
+   * Usually it's a commit hash.
+   * @example "2c106d9619c71c3082c9b59b1d72817363c8ecb9"
+   * @default "no-cache-busting-id-set"
+   */
+  cdnCacheBustingId?: string;
 }
 
 export interface MultistoreConfig {
+  /**
+   * Whether the multistore is enabled or not.
+   * @example false
+   * @default false
+   */
   enabled: boolean;
 }
 
 export interface SdkModuleOptions {
   middleware: MiddlewareConfig;
   multistore?: MultistoreConfig;
-}
+}

package/dist/runtime/useSdk.template

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

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

@@ -4,7 +4,6 @@ interface ComposeMiddlewareUrlParams {
     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;

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

@@ -1,31 +1,27 @@
-export declare function getDefaults(): {
+export declare function getDefaultMethodsRequestConfig(): {
     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 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";
-                };
+            readonly getEntries: {
+                readonly method: "GET";
             };
         };
     };

package/dist/runtime/utils/defaults.js

@@ -0,0 +1,18 @@
+export function getDefaultMethodsRequestConfig() {
+  return {
+    unifiedCommerce: {
+      middlewareModule: {
+        getCategories: { method: "GET" },
+        getProductDetails: { method: "GET" },
+        getProductReviews: { method: "GET" },
+        getProducts: { method: "GET" },
+        searchProducts: { method: "GET" }
+      }
+    },
+    unifiedCms: {
+      middlewareModule: {
+        getEntries: { method: "GET" }
+      }
+    }
+  };
+}

package/dist/types.d.mts

@@ -1,7 +1,30 @@
 
-import {  } from './module'
+import type {  } from './module.js'
 
+  export interface ModuleOptions {
+ middleware: {
+  /** @default "http://localhost:4000" */
+  apiUrl: string,
 
+  /** @default "no-cache-busting-id-set" */
+  cdnCacheBustingId: string,
+ },
 
+ multistore: {
+  /** @default false */
+  enabled: boolean,
+ },
+}
 
-export { default } from './module'
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['vsf']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['vsf']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['vsf']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['vsf']?: ModuleOptions }
+}
+
+
+export type { default } from './module.js'

package/dist/types.d.ts

@@ -1,7 +1,30 @@
 
-import {  } from './module'
+import type {  } from './module'
 
+  export interface ModuleOptions {
+ middleware: {
+  /** @default "http://localhost:4000" */
+  apiUrl: string,
 
+  /** @default "no-cache-busting-id-set" */
+  cdnCacheBustingId: string,
+ },
 
+ multistore: {
+  /** @default false */
+  enabled: boolean,
+ },
+}
 
-export { default } from './module'
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['vsf']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['vsf']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['vsf']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['vsf']?: ModuleOptions }
+}
+
+
+export type { default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Vue Storefront dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "nuxt-module-build build && yarn build:app",
+    "build": "nuxt-module-build build",
     "build:app": "cd __tests__/app && yarn build",
     "dev": "cd __tests__/app && yarn dev",
     "dev:middleware": "cd ../shared/src/__tests__/middleware && yarn dev",
@@ -36,11 +36,11 @@
   },
   "devDependencies": {
     "@types/node": "^18.11.17",
-    "@nuxt/devtools": "^1.0.0",
-    "@nuxt/module-builder": "0.5.2",
-    "@nuxt/test-utils": "3.7.4",
-    "nuxt": "3.7.4",
+    "@nuxt/devtools": "1.3.3",
+    "@nuxt/module-builder": "0.7.1",
+    "@nuxt/test-utils": "3.13.1",
+    "nuxt": "3.12.2",
     "start-server-and-test": "^2.0.3",
-    "vitest": "^0.34.6"
+    "vitest": "1.6.0"
   }
 }

package/dist/runtime/utils/defaults.mjs

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