@vue-storefront/nuxt 9.0.0-rc.3 → 9.0.0-rc.5

package/README.md

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

package/dist/module.d.mts

@@ -6,11 +6,6 @@ interface MiddlewareConfig {
      * @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.
@@ -18,6 +13,11 @@ interface MiddlewareConfig {
      * @default "no-cache-busting-id-set"
      */
     cdnCacheBustingId?: string;
+    /**
+     * The URL of the middleware for server-side rendering.
+     * @example "http://localhost:4000"
+     */
+    ssrApiUrl: string;
 }
 interface MultistoreConfig {
     /**
@@ -27,15 +27,15 @@ interface MultistoreConfig {
      */
     enabled: boolean;
 }
-type LogVerbosity = "emergency" | "alert" | "critical" | "error" | "warning" | "notice" | "info" | "debug";
+type LogVerbosity = "alert" | "critical" | "debug" | "emergency" | "error" | "info" | "notice" | "warning";
 type LoggerOptions = Partial<{
-    verbosity: LogVerbosity;
     includeStackTrace: boolean;
+    verbosity: LogVerbosity;
 }>;
 interface AlokaiModuleOptions {
+    logger?: LoggerOptions;
     middleware: MiddlewareConfig;
     multistore?: MultistoreConfig;
-    logger?: LoggerOptions;
 }
 
 declare const _default: _nuxt_schema.NuxtModule<AlokaiModuleOptions, AlokaiModuleOptions, false>;

package/dist/module.d.ts

@@ -6,11 +6,6 @@ interface MiddlewareConfig {
      * @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.
@@ -18,6 +13,11 @@ interface MiddlewareConfig {
      * @default "no-cache-busting-id-set"
      */
     cdnCacheBustingId?: string;
+    /**
+     * The URL of the middleware for server-side rendering.
+     * @example "http://localhost:4000"
+     */
+    ssrApiUrl: string;
 }
 interface MultistoreConfig {
     /**
@@ -27,15 +27,15 @@ interface MultistoreConfig {
      */
     enabled: boolean;
 }
-type LogVerbosity = "emergency" | "alert" | "critical" | "error" | "warning" | "notice" | "info" | "debug";
+type LogVerbosity = "alert" | "critical" | "debug" | "emergency" | "error" | "info" | "notice" | "warning";
 type LoggerOptions = Partial<{
-    verbosity: LogVerbosity;
     includeStackTrace: boolean;
+    verbosity: LogVerbosity;
 }>;
 interface AlokaiModuleOptions {
+    logger?: LoggerOptions;
     middleware: MiddlewareConfig;
     multistore?: MultistoreConfig;
-    logger?: LoggerOptions;
 }
 
 declare const _default: _nuxt_schema.NuxtModule<AlokaiModuleOptions, AlokaiModuleOptions, false>;

package/dist/module.json

@@ -1,10 +1,10 @@
 {
-  "name": "@vue-storefront/nuxt",
-  "configKey": "alokai",
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "9.0.0-rc.3",
+  "configKey": "alokai",
+  "name": "@vue-storefront/nuxt",
+  "version": "9.0.0-rc.5",
   "builder": {
     "@nuxt/module-builder": "0.7.1",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,21 +1,18 @@
-import { defineNuxtModule, createResolver, installModule, addTypeTemplate, addImports, addTemplate, addPluginTemplate, addImportsSources } from '@nuxt/kit';
-import { genInlineTypeImport } from 'knitwork';
+import { defineNuxtModule, createResolver, installModule, addTypeTemplate, addImports, addTemplate, addPluginTemplate, addImportsSources, addServerHandler } from '@nuxt/kit';
 import { defu } from 'defu';
+import { genInlineTypeImport } from 'knitwork';
 
 const module = defineNuxtModule({
-  meta: {
-    name: "@vue-storefront/nuxt",
-    configKey: "alokai",
-    compatibility: {
-      nuxt: "^3.0.0"
-    }
-  },
   defaults: {
+    logger: {
+      includeStackTrace: false,
+      verbosity: "debug"
+    },
     /**
      * 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: {
@@ -25,12 +22,15 @@ const module = defineNuxtModule({
     },
     multistore: {
       enabled: false
-    },
-    logger: {
-      includeStackTrace: false,
-      verbosity: "debug"
     }
   },
+  meta: {
+    compatibility: {
+      nuxt: "^3.0.0"
+    },
+    configKey: "alokai",
+    name: "@vue-storefront/nuxt"
+  },
   async setup(options, nuxt) {
     const projectLayer = nuxt.options._layers[0];
     const projectRootResolver = createResolver(projectLayer.config.rootDir);
@@ -44,10 +44,15 @@ const module = defineNuxtModule({
     nuxt.options.app.head.meta = [
       ...nuxt.options.app.head.meta ?? [],
       {
-        name: "generator",
-        content: "Alokai Storefront"
+        content: "Alokai Storefront",
+        name: "generator"
       }
     ];
+    nuxt.hooks.hook("nitro:config", async (nitroConfig) => {
+      nitroConfig.externals = nitroConfig.externals || {};
+      nitroConfig.externals.inline = nitroConfig.externals.inline || [];
+      nitroConfig.externals.inline.push(localResolver.resolve("./runtime"));
+    });
     addTypeTemplate({
       filename: "sdk.config.d.ts",
       getContents: () => `
@@ -61,67 +66,87 @@ export type SdkConfig = ${genInlineTypeImport(
       src: localResolver.resolve("./runtime/types.template")
     });
     addImports({
-      name: "getDefaultMethodsRequestConfig",
       as: "getDefaultMethodsRequestConfig",
-      from: localResolver.resolve("./runtime/utils/defaults")
+      from: localResolver.resolve("./runtime/utils/defaults"),
+      name: "getDefaultMethodsRequestConfig"
     });
     addTemplate({
-      src: localResolver.resolve("./runtime/useSdk.template"),
       filename: "useSdk.ts",
+      src: localResolver.resolve("./runtime/useSdk.template"),
       write: true
     });
     addTemplate({
-      src: localResolver.resolve("./runtime/defineSdkConfig.template"),
       filename: "defineSdkConfig.ts",
-      write: true,
       options: {
         moduleConfig: JSON.stringify(options)
-      }
+      },
+      src: localResolver.resolve("./runtime/defineSdkConfig.template"),
+      write: true
+    });
+    addTemplate({
+      filename: "defineGetConfigSwitcherHeader.ts",
+      options: {
+        moduleConfig: JSON.stringify(options)
+      },
+      src: localResolver.resolve(
+        "./runtime/defineGetConfigSwitcherHeader.template"
+      ),
+      write: true
     });
     addTemplate({
-      src: localResolver.resolve("./runtime/useSfState.template"),
       filename: "useSfState.ts",
+      src: localResolver.resolve("./runtime/useSfState.template"),
       write: true
     });
     addTemplate({
-      src: localResolver.resolve("./runtime/logger.template"),
       filename: "logger.ts",
-      write: true,
       options: {
         moduleConfig: JSON.stringify(options)
-      }
+      },
+      src: localResolver.resolve("./runtime/logger.template"),
+      write: true
     });
     addTemplate({
-      src: localResolver.resolve("./runtime/errorHandler.template"),
       filename: "errorHandler.ts",
+      src: localResolver.resolve("./runtime/errorHandler.template"),
       write: true
     });
     addPluginTemplate({
-      src: localResolver.resolve("./runtime/plugin.template"),
       filename: "alokaiPlugin.ts",
-      write: true,
       options: {
         moduleConfig: JSON.stringify(options)
-      }
+      },
+      src: localResolver.resolve("./runtime/plugin.template"),
+      write: true
     });
     addImportsSources([
       {
-        imports: ["useSdk"],
-        from: buildDirectoryResolver.resolve("useSdk.ts")
+        from: buildDirectoryResolver.resolve("useSdk.ts"),
+        imports: ["useSdk"]
       },
       {
-        imports: ["defineSdkConfig"],
-        from: buildDirectoryResolver.resolve("defineSdkConfig.ts")
+        from: buildDirectoryResolver.resolve("defineSdkConfig.ts"),
+        imports: ["defineSdkConfig", "defineSdkModule"]
       },
       {
-        imports: ["useSfState"],
-        from: buildDirectoryResolver.resolve("useSfState.ts")
+        from: buildDirectoryResolver.resolve(
+          "defineGetConfigSwitcherHeader.ts"
+        ),
+        imports: ["defineGetConfigSwitcherHeader"]
       },
       {
-        imports: ["logger"],
-        from: buildDirectoryResolver.resolve("logger.ts")
+        from: buildDirectoryResolver.resolve("useSfState.ts"),
+        imports: ["useSfState"]
+      },
+      {
+        from: buildDirectoryResolver.resolve("logger.ts"),
+        imports: ["logger"]
       }
     ]);
+    addServerHandler({
+      handler: localResolver.resolve("./runtime/serverMiddleware"),
+      middleware: true
+    });
   }
 });
 

package/dist/runtime/defineGetConfigSwitcherHeader.template

@@ -0,0 +1 @@
+export { defineGetConfigSwitcherHeader } from '@alokai/connect/sdk';

package/dist/runtime/defineSdkConfig.template

@@ -1,5 +1,7 @@
+import type { Extension, Module } from "@alokai/connect/sdk";
 import { buildModule, middlewareModule } from "@alokai/connect/sdk";
 import { useNuxtApp, useRequestHeaders, getDefaultMethodsRequestConfig } from "#imports";
+import type { Composer } from '#i18n';
 import type { AlokaiModuleOptions } from "./alokaiModule";
 
 type InjectedContext = {
@@ -31,34 +33,62 @@ const moduleConfig: AlokaiModuleOptions = <%= options.moduleConfig %>;
 /**
   * Define SDK config function
   *
-  * @param config - Function that returns SDK config
+  * @param config - Function that returns SDK config or a record of SDK modules
   *
-  * @example
+  * @example Using a function:
   * ```ts
-  * import {
-  *   contentfulModule,
-  *   ContentfulModuleType,
-  * } from "@vsf-enterprise/contentful-sdk";
-  * import type { UnifiedApiEndpoints } from "../storefront-middleware/types";
+  * import type { UnifiedEndpoints } from 'storefront-middleware/types';
+  * import { getConfigSwitcherHeader } from './utils';
   *
   * export default defineSdkConfig(
-  *   ({ buildModule, middlewareModule, config, getCookieHeader }) => ({
-  *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
-  *       apiUrl: config.apiUrl + "/commerce",
-  *       ssrApiUrl: config.ssrApiUrl + "/commerce",
-  *       defaultRequestConfig: { headers: { ...getCookieHeader() } },
+  *   ({ buildModule, middlewareModule, config, getRequestHeaders }) => ({
+  *     unified: buildModule(middlewareModule<UnifiedEndpoints>, {
+  *       apiUrl: config.apiUrl + "/commerce/unified",
+  *       ssrApiUrl: config.ssrApiUrl + "/commerce/unified",
   *       cdnCacheBustingId: config.cdnCacheBustingId,
+  *       defaultRequestConfig: {
+  *         getConfigSwitcherHeader,
+  *         headers: getRequestHeaders(),
+  *       },
   *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
   *     }),
-  *     contentful: buildModule(contentfulModule, {
-  *       apiUrl: config.apiUrl + "/cntf",
-  *       ssrApiUrl: config.ssrApiUrl + "/cntf",
-  *     })
   *   }),
   * );
   * ```
+  *
+  * @example Using a record of modules:
+  * ```ts
+  * import { defineSdkModule } from '@vue-storefront/nuxt';
+  * import type { UnifiedEndpoints } from 'storefront-middleware/types';
+  * import { getConfigSwitcherHeader } from './utils';
+  *
+  * const unified = defineSdkModule(({ buildModule, config, getRequestHeaders, middlewareModule }) =>
+  *   buildModule(middlewareModule<UnifiedEndpoints>, {
+  *     apiUrl: config.apiUrl + "/commerce/unified",
+  *     ssrApiUrl: config.ssrApiUrl + "/commerce/unified",
+  *     cdnCacheBustingId: config.cdnCacheBustingId,
+  *     defaultRequestConfig: {
+  *       getConfigSwitcherHeader,
+  *       headers: getRequestHeaders(),
+  *     },
+  *     methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
+  *   }),
+  * );
+  *
+  * export default defineSdkConfig({
+  *   unified,
+  * });
+  * ```
   */
-export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
+export function defineSdkConfig<TConfig>(config: Config<TConfig>): () => TConfig;
+export function defineSdkConfig<TModules extends Record<string, DefineSdkModule>>(
+  modules: TModules,
+): () => {
+  [K in keyof TModules]: ReturnType<TModules[K]>;
+};
+export function defineSdkConfig<TConfig>(
+  config: Config<TConfig> | Record<string, DefineSdkModule>,
+) {
   return () => {
     const nuxtApp = useNuxtApp()
     const runtimeConfig = useRuntimeConfig();
@@ -67,9 +97,12 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
     const resolvedOptions = resolveOptions(runtimeConfig.public.alokai);
 
     const getCookieHeader = () => useRequestHeaders(["cookie"]);
-    const getRequestHeaders = () => useRequestHeaders();
+    const getRequestHeaders = () => ({
+      "x-alokai-locale": (nuxtApp as unknown as { $i18n: Composer }).$i18n?.locale?.value,
+      ...useRequestHeaders()
+    });
 
-    return config({
+    const context = {
       buildModule,
       middlewareModule,
       getCookieHeader,
@@ -81,10 +114,63 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
         defaultMethodsRequestConfig: getDefaultMethodsRequestConfig(),
         cdnCacheBustingId: runtimeConfig.public.alokai.middleware.cdnCacheBustingId,
       }
-    });
+    };
+
+    if (typeof config === 'function') {
+      return config(context);
+    }
+
+    return buildModules(config)(context);
   }
 }
 
+type DefineSdkModule = (
+  context: InjectedContext,
+) => ReturnType<typeof buildModule>;
+
+/**
+  * Defines an SDK module that can be used with defineSdkConfig.
+  * Each module is a function that takes the InjectedContext and returns a built module.
+  *
+  * @param moduleDefinition - A function that takes InjectedContext and returns a built module
+  *
+  * @example
+  * ```ts
+  * import { defineSdkModule } from '@vue-storefront/nuxt';
+  * import type { UnifiedEndpoints } from 'storefront-middleware/types';
+  * import { getConfigSwitcherHeader } from './utils';
+  *
+  * export const unified = defineSdkModule(({ buildModule, config, getRequestHeaders, middlewareModule }) =>
+  *   buildModule(middlewareModule<UnifiedEndpoints>, {
+  *     apiUrl: config.apiUrl + "/commerce/unified",
+  *     ssrApiUrl: config.ssrApiUrl + "/commerce/unified",
+  *     cdnCacheBustingId: config.cdnCacheBustingId,
+  *     defaultRequestConfig: {
+  *       getConfigSwitcherHeader,
+  *       headers: getRequestHeaders(),
+  *     },
+  *     methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
+  *   }),
+  * );
+  * ```
+  */
+export function defineSdkModule<TModuleDefinition extends DefineSdkModule>(
+  moduleDefinition: TModuleDefinition,
+) {
+  return moduleDefinition;
+}
+
+function buildModules<TModules extends Record<string, DefineSdkModule>>(
+  modules: TModules,
+) {
+  return (context: InjectedContext) =>
+    Object.fromEntries(
+      Object.entries(modules).map(([key, module]) => [key, module(context)]),
+    ) as {
+      [K in keyof TModules]: ReturnType<TModules[K]>;
+    };
+}
+
 /**
  * Helper function to resolve the SDK options based on the configuration.
  * 
@@ -106,4 +192,4 @@ function resolveOptions(
 
 type ResolveSdkOptionsConfig = {
   customSuffix: string;
-}
+}

package/dist/runtime/plugin.template

@@ -3,16 +3,9 @@ import sdkConfig from "~/sdk.config";
 import type { SdkConfig } from "./sdk.config";
 import { defineNuxtPlugin } from '#app';
 
-export default defineNuxtPlugin(() => {
-  let sdk: SDKApi<ReturnType<SdkConfig>>;
-
-  const getSdk = () => {
-    if (!sdk) {
-      const config = sdkConfig();
-      sdk = initSDK(config);
-    }
-
-    return sdk;
+export default defineNuxtPlugin((nuxtApp) => {
+  const getSdk: () => SDKApi<ReturnType<SdkConfig>> = () => {
+    return initSDK(sdkConfig());
   };
 
   return {

package/dist/runtime/serverMiddleware.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/runtime/serverMiddleware.js

@@ -0,0 +1,5 @@
+export default defineEventHandler((event) => {
+  const { pathname, search } = getRequestURL(event);
+  event.node.req.headers["x-pathname"] = pathname;
+  event.node.req.headers["x-search"] = search;
+});

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

@@ -1,35 +1,35 @@
 export declare function getDefaultMethodsRequestConfig(): {
-    readonly unifiedCommerce: {
+    readonly unifiedCms: {
         readonly middlewareModule: {
-            readonly getCategory: {
+            readonly getEntries: {
                 readonly method: "GET";
             };
-            readonly getCategories: {
+            readonly getPage: {
                 readonly method: "GET";
             };
-            readonly getProductDetails: {
+        };
+    };
+    readonly unifiedCommerce: {
+        readonly middlewareModule: {
+            readonly getCategories: {
                 readonly method: "GET";
             };
-            readonly getProductReviews: {
+            readonly getCategory: {
                 readonly method: "GET";
             };
-            readonly getProducts: {
+            readonly getCurrencies: {
                 readonly method: "GET";
             };
-            readonly getCurrencies: {
+            readonly getProductDetails: {
                 readonly method: "GET";
             };
-            readonly searchProducts: {
+            readonly getProductReviews: {
                 readonly method: "GET";
             };
-        };
-    };
-    readonly unifiedCms: {
-        readonly middlewareModule: {
-            readonly getPage: {
+            readonly getProducts: {
                 readonly method: "GET";
             };
-            readonly getEntries: {
+            readonly searchProducts: {
                 readonly method: "GET";
             };
         };

package/dist/runtime/utils/defaults.js

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

package/dist/types.d.mts

@@ -2,6 +2,14 @@
 import type {  } from './module.js'
 
   export interface ModuleOptions {
+ logger: {
+  /** @default false */
+  includeStackTrace: boolean,
+
+  /** @default "debug" */
+  verbosity: string,
+ },
+
  middleware: {
   /** @default "" */
   apiUrl: string,
@@ -17,14 +25,6 @@ import type {  } from './module.js'
   /** @default false */
   enabled: boolean,
  },
-
- logger: {
-  /** @default false */
-  includeStackTrace: boolean,
-
-  /** @default "debug" */
-  verbosity: string,
- },
 }
 
 declare module '@nuxt/schema' {

package/dist/types.d.ts

@@ -2,6 +2,14 @@
 import type {  } from './module'
 
   export interface ModuleOptions {
+ logger: {
+  /** @default false */
+  includeStackTrace: boolean,
+
+  /** @default "debug" */
+  verbosity: string,
+ },
+
  middleware: {
   /** @default "" */
   apiUrl: string,
@@ -17,14 +25,6 @@ import type {  } from './module'
   /** @default false */
   enabled: boolean,
  },
-
- logger: {
-  /** @default false */
-  includeStackTrace: boolean,
-
-  /** @default "debug" */
-  verbosity: string,
- },
 }
 
 declare module '@nuxt/schema' {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "9.0.0-rc.3",
+  "version": "9.0.0-rc.5",
   "description": "Alokai dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
@@ -18,7 +18,8 @@
   ],
   "scripts": {
     "build": "nuxt-module-build build",
-    "lint": "biome ci .",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "format": "prettier --write .",
     "prepare": "nuxi prepare",
     "version": "cp CHANGELOG.md ../../docs/enterprise/content/storefront/6.change-log/nuxt.md"
@@ -32,15 +33,14 @@
     "pinia": "^2.1.7"
   },
   "devDependencies": {
-    "@alokai/connect": "^1.0.0-rc.2",
+    "@alokai/connect": "^1.0.0-rc.4",
     "@types/node": "^18.11.17",
     "@nuxt/devtools": "1.3.8",
     "@nuxt/module-builder": "0.7.1",
-    "@biomejs/biome": "1.9.2",
     "nuxt": "3.12.2"
   },
   "peerDependencies": {
-    "@alokai/connect": "^1.0.0-rc.2"
+    "@alokai/connect": "^1.0.0-rc.4"
   },
   "publishConfig": {
     "access": "public"