@vue-storefront/nuxt 9.0.0-rc.4 → 9.0.0-rc.6

package/dist/module.json

@@ -4,7 +4,7 @@
   },
   "configKey": "alokai",
   "name": "@vue-storefront/nuxt",
-  "version": "9.0.0-rc.4",
+  "version": "9.0.0-rc.6",
   "builder": {
     "@nuxt/module-builder": "0.7.1",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, installModule, addTypeTemplate, addImports, addTemplate, addPluginTemplate, addImportsSources } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, installModule, addTypeTemplate, addImports, addTemplate, addPluginTemplate, addImportsSources, addServerHandler } from '@nuxt/kit';
 import { defu } from 'defu';
 import { genInlineTypeImport } from 'knitwork';
 
@@ -48,6 +48,11 @@ const module = defineNuxtModule({
         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: () => `
@@ -78,6 +83,16 @@ export type SdkConfig = ${genInlineTypeImport(
       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({
       filename: "useSfState.ts",
       src: localResolver.resolve("./runtime/useSfState.template"),
@@ -111,7 +126,13 @@ export type SdkConfig = ${genInlineTypeImport(
       },
       {
         from: buildDirectoryResolver.resolve("defineSdkConfig.ts"),
-        imports: ["defineSdkConfig"]
+        imports: ["defineSdkConfig", "defineSdkModule"]
+      },
+      {
+        from: buildDirectoryResolver.resolve(
+          "defineGetConfigSwitcherHeader.ts"
+        ),
+        imports: ["defineGetConfigSwitcherHeader"]
       },
       {
         from: buildDirectoryResolver.resolve("useSfState.ts"),
@@ -122,6 +143,10 @@ export type SdkConfig = ${genInlineTypeImport(
         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,3 +1,4 @@
+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';
@@ -32,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();
@@ -73,7 +102,7 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
       ...useRequestHeaders()
     });
 
-    return config({
+    const context = {
       buildModule,
       middlewareModule,
       getCookieHeader,
@@ -85,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.
  * 
@@ -110,4 +192,4 @@ function resolveOptions(
 
 type ResolveSdkOptionsConfig = {
   customSuffix: string;
-}
+}

package/dist/runtime/serverMiddleware.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, void>;
+export default _default;

package/dist/runtime/serverMiddleware.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "9.0.0-rc.4",
+  "version": "9.0.0-rc.6",
   "description": "Alokai dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
@@ -33,14 +33,14 @@
     "pinia": "^2.1.7"
   },
   "devDependencies": {
-    "@alokai/connect": "^1.0.0-rc.3",
+    "@alokai/connect": "^1.0.0-rc.4",
     "@types/node": "^18.11.17",
     "@nuxt/devtools": "1.3.8",
     "@nuxt/module-builder": "0.7.1",
     "nuxt": "3.12.2"
   },
   "peerDependencies": {
-    "@alokai/connect": "^1.0.0-rc.3"
+    "@alokai/connect": "^1.0.0-rc.4"
   },
   "publishConfig": {
     "access": "public"