@vue-storefront/next 6.0.0-rc.4 → 6.0.0-rc.5

package/dist/client.d.mts

@@ -1,6 +1,6 @@
 import { SDKApi } from '@alokai/connect/sdk';
-import { S as SfContract, C as CreateSdkContextReturn } from './types-BCNzbTr2.mjs';
-export { M as Maybe, b as SfState, a as SfStateProps, c as createSfStateProvider } from './types-BCNzbTr2.mjs';
+import { S as SfContract, C as CreateSdkContextReturn } from './types-glZZCnsn.mjs';
+export { M as Maybe, b as SfState, a as SfStateProps, c as createSfStateProvider } from './types-glZZCnsn.mjs';
 import 'next/headers';
 import 'react';
 

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { SDKApi } from '@alokai/connect/sdk';
-import { S as SfContract, C as CreateSdkContextReturn } from './types-BCNzbTr2.js';
-export { M as Maybe, b as SfState, a as SfStateProps, c as createSfStateProvider } from './types-BCNzbTr2.js';
+import { S as SfContract, C as CreateSdkContextReturn } from './types-glZZCnsn.js';
+export { M as Maybe, b as SfState, a as SfStateProps, c as createSfStateProvider } from './types-glZZCnsn.js';
 import 'next/headers';
 import 'react';
 

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import * as _alokai_connect_logger from '@alokai/connect/logger';
 import { NextRequest, NextResponse } from 'next/server';
-import { d as CreateSdkOptions, e as Config, f as CreateSdkReturn } from './types-BCNzbTr2.mjs';
-import '@alokai/connect/sdk';
+import { buildModule } from '@alokai/connect/sdk';
+export { defineGetConfigSwitcherHeader } from '@alokai/connect/sdk';
+import { d as CreateSdkOptions, e as Config, f as CreateSdkReturn, I as InjectedContext } from './types-glZZCnsn.mjs';
 import 'next/headers';
 import 'react';
 
@@ -32,24 +33,6 @@ type NextMiddleware = (request: NextRequest) => NextResponse | Promise<NextRespo
  * @returns A wrapped middleware function that adds pathname to request headers
  */
 declare function createAlokaiMiddleware(middleware: NextMiddleware): (request: NextRequest) => NextResponse<unknown> | Promise<NextResponse<unknown>>;
-/**
- * Retrieves the pathname from the request headers.
- * This function requires the `createAlokaiMiddleware` to be used in the middleware.ts file.
- *
- * @note This function is available only on the server side.
- * @note This function will return undefined for all non-matching requests https://nextjs.org/docs/app/building-your-application/routing/middleware#matcher
- *
- * @param headers - The request headers
- * @returns The pathname from the request headers
- *
- * @example
- * ```ts
- * import headers from "next/headers";
- *
- * const pathname = getPathnameFromRequestHeaders(headers());
- * ```
- */
-declare function getPathnameFromRequestHeaders(headers: Record<string, string | string[] | undefined>): string | undefined;
 
 /**
  * Creates an SDK for the given configuration definition.
@@ -96,29 +79,59 @@ declare function getPathnameFromRequestHeaders(headers: Record<string, string |
 declare function createSdk<TConfig extends Record<string, any>>(options: CreateSdkOptions, configDefinition: Config<TConfig>): CreateSdkReturn<TConfig>;
 /**
  * Creates a configuration definition for the SDK.
- * @param config The configuration definition for the SDK.
+ * @param config The configuration definition for the SDK or a record of SDK modules
  * @returns An object containing SDK configuration
  * @example
+ * Using a function:
  * ```tsx
+ * import type { UnifiedEndpoints } from 'storefront-middleware/types';
+ * import { getConfigSwitcherHeader } from './utils';
+ *
  * const config = defineSdkConfig(
  *   ({ buildModule, middlewareModule, config, getRequestHeaders }) => ({
- *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
- *       apiUrl: config.apiUrl + "/commerce",
- *       ssrApiUrl: config.ssrApiUrl + "/commerce",
+ *     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:
+ * ```tsx
+ * import { defineSdkModule } from '@vue-storefront/next';
+ * 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,
+ *   }),
+ * );
+ *
+ * const config = defineSdkConfig({
+ *   unified,
+ * });
+ * ```
  */
 declare function defineSdkConfig<TConfig extends Record<string, any>>(config: Config<TConfig>): Config<TConfig>;
+declare function defineSdkConfig<TModules extends Record<string, DefineSdkModule>>(modules: TModules): (context: InjectedContext) => {
+    [K in keyof TModules]: ReturnType<TModules[K]>;
+};
 type ResolveSdkOptionsConfig = {
     customSuffix: string;
 };
@@ -135,5 +148,33 @@ type ResolveSdkOptionsConfig = {
  * @returns The resolved SDK options.
  */
 declare function resolveSdkOptions(input: CreateSdkOptions, _options?: Partial<ResolveSdkOptionsConfig>): CreateSdkOptions;
+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
+ * ```tsx
+ * import { defineSdkModule } from '@vue-storefront/next';
+ * 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,
+ *   }),
+ * );
+ * ```
+ */
+declare function defineSdkModule<TModuleDefinition extends DefineSdkModule>(moduleDefinition: TModuleDefinition): TModuleDefinition;
 
-export { CreateSdkOptions, createAlokaiMiddleware, createLogger, createSdk, defineSdkConfig, getPathnameFromRequestHeaders, resolveSdkOptions };
+export { CreateSdkOptions, createAlokaiMiddleware, createLogger, createSdk, defineSdkConfig, defineSdkModule, resolveSdkOptions };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as _alokai_connect_logger from '@alokai/connect/logger';
 import { NextRequest, NextResponse } from 'next/server';
-import { d as CreateSdkOptions, e as Config, f as CreateSdkReturn } from './types-BCNzbTr2.js';
-import '@alokai/connect/sdk';
+import { buildModule } from '@alokai/connect/sdk';
+export { defineGetConfigSwitcherHeader } from '@alokai/connect/sdk';
+import { d as CreateSdkOptions, e as Config, f as CreateSdkReturn, I as InjectedContext } from './types-glZZCnsn.js';
 import 'next/headers';
 import 'react';
 
@@ -32,24 +33,6 @@ type NextMiddleware = (request: NextRequest) => NextResponse | Promise<NextRespo
  * @returns A wrapped middleware function that adds pathname to request headers
  */
 declare function createAlokaiMiddleware(middleware: NextMiddleware): (request: NextRequest) => NextResponse<unknown> | Promise<NextResponse<unknown>>;
-/**
- * Retrieves the pathname from the request headers.
- * This function requires the `createAlokaiMiddleware` to be used in the middleware.ts file.
- *
- * @note This function is available only on the server side.
- * @note This function will return undefined for all non-matching requests https://nextjs.org/docs/app/building-your-application/routing/middleware#matcher
- *
- * @param headers - The request headers
- * @returns The pathname from the request headers
- *
- * @example
- * ```ts
- * import headers from "next/headers";
- *
- * const pathname = getPathnameFromRequestHeaders(headers());
- * ```
- */
-declare function getPathnameFromRequestHeaders(headers: Record<string, string | string[] | undefined>): string | undefined;
 
 /**
  * Creates an SDK for the given configuration definition.
@@ -96,29 +79,59 @@ declare function getPathnameFromRequestHeaders(headers: Record<string, string |
 declare function createSdk<TConfig extends Record<string, any>>(options: CreateSdkOptions, configDefinition: Config<TConfig>): CreateSdkReturn<TConfig>;
 /**
  * Creates a configuration definition for the SDK.
- * @param config The configuration definition for the SDK.
+ * @param config The configuration definition for the SDK or a record of SDK modules
  * @returns An object containing SDK configuration
  * @example
+ * Using a function:
  * ```tsx
+ * import type { UnifiedEndpoints } from 'storefront-middleware/types';
+ * import { getConfigSwitcherHeader } from './utils';
+ *
  * const config = defineSdkConfig(
  *   ({ buildModule, middlewareModule, config, getRequestHeaders }) => ({
- *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
- *       apiUrl: config.apiUrl + "/commerce",
- *       ssrApiUrl: config.ssrApiUrl + "/commerce",
+ *     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:
+ * ```tsx
+ * import { defineSdkModule } from '@vue-storefront/next';
+ * 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,
+ *   }),
+ * );
+ *
+ * const config = defineSdkConfig({
+ *   unified,
+ * });
+ * ```
  */
 declare function defineSdkConfig<TConfig extends Record<string, any>>(config: Config<TConfig>): Config<TConfig>;
+declare function defineSdkConfig<TModules extends Record<string, DefineSdkModule>>(modules: TModules): (context: InjectedContext) => {
+    [K in keyof TModules]: ReturnType<TModules[K]>;
+};
 type ResolveSdkOptionsConfig = {
     customSuffix: string;
 };
@@ -135,5 +148,33 @@ type ResolveSdkOptionsConfig = {
  * @returns The resolved SDK options.
  */
 declare function resolveSdkOptions(input: CreateSdkOptions, _options?: Partial<ResolveSdkOptionsConfig>): CreateSdkOptions;
+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
+ * ```tsx
+ * import { defineSdkModule } from '@vue-storefront/next';
+ * 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,
+ *   }),
+ * );
+ * ```
+ */
+declare function defineSdkModule<TModuleDefinition extends DefineSdkModule>(moduleDefinition: TModuleDefinition): TModuleDefinition;
 
-export { CreateSdkOptions, createAlokaiMiddleware, createLogger, createSdk, defineSdkConfig, getPathnameFromRequestHeaders, resolveSdkOptions };
+export { CreateSdkOptions, createAlokaiMiddleware, createLogger, createSdk, defineSdkConfig, defineSdkModule, resolveSdkOptions };

package/dist/index.js

@@ -40,8 +40,9 @@ __export(src_exports, {
   createAlokaiMiddleware: () => createAlokaiMiddleware,
   createLogger: () => createLogger,
   createSdk: () => createSdk,
+  defineGetConfigSwitcherHeader: () => import_sdk2.defineGetConfigSwitcherHeader,
   defineSdkConfig: () => defineSdkConfig,
-  getPathnameFromRequestHeaders: () => getPathnameFromRequestHeaders,
+  defineSdkModule: () => defineSdkModule,
   resolveSdkOptions: () => resolveSdkOptions
 });
 module.exports = __toCommonJS(src_exports);
@@ -80,12 +81,10 @@ function createAlokaiMiddleware(middleware) {
   return (request) => {
     const nextUrl = request.nextUrl.clone();
     request.headers.append("x-pathname", nextUrl.pathname);
+    request.headers.append("x-search", nextUrl.search);
     return middleware(request);
   };
 }
-function getPathnameFromRequestHeaders(headers) {
-  return headers["x-pathname"];
-}
 
 // src/sdk/index.tsx
 var import_sdk = require("@alokai/connect/sdk");
@@ -151,6 +150,7 @@ function resolveDynamicContext(context) {
 }
 
 // src/sdk/index.tsx
+var import_sdk2 = require("@alokai/connect/sdk");
 function createSdk(options, configDefinition) {
   function getSdk(dynamicContext = {}) {
     var _a;
@@ -174,17 +174,29 @@ function createSdk(options, configDefinition) {
   };
 }
 function defineSdkConfig(config) {
-  return config;
+  if (typeof config === "function") {
+    return config;
+  }
+  return buildModules(config);
 }
 function resolveSdkOptions(input, _options = {}) {
   return input;
 }
+function defineSdkModule(moduleDefinition) {
+  return moduleDefinition;
+}
+function buildModules(modules) {
+  return (context) => Object.fromEntries(
+    Object.entries(modules).map(([key, module2]) => [key, module2(context)])
+  );
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createAlokaiMiddleware,
   createLogger,
   createSdk,
+  defineGetConfigSwitcherHeader,
   defineSdkConfig,
-  getPathnameFromRequestHeaders,
+  defineSdkModule,
   resolveSdkOptions
 });

package/dist/index.mjs

@@ -37,12 +37,10 @@ function createAlokaiMiddleware(middleware) {
   return (request) => {
     const nextUrl = request.nextUrl.clone();
     request.headers.append("x-pathname", nextUrl.pathname);
+    request.headers.append("x-search", nextUrl.search);
     return middleware(request);
   };
 }
-function getPathnameFromRequestHeaders(headers) {
-  return headers["x-pathname"];
-}
 
 // src/sdk/index.tsx
 import { buildModule, initSDK, middlewareModule } from "@alokai/connect/sdk";
@@ -108,6 +106,7 @@ function resolveDynamicContext(context) {
 }
 
 // src/sdk/index.tsx
+import { defineGetConfigSwitcherHeader } from "@alokai/connect/sdk";
 function createSdk(options, configDefinition) {
   function getSdk(dynamicContext = {}) {
     var _a;
@@ -131,16 +130,28 @@ function createSdk(options, configDefinition) {
   };
 }
 function defineSdkConfig(config) {
-  return config;
+  if (typeof config === "function") {
+    return config;
+  }
+  return buildModules(config);
 }
 function resolveSdkOptions(input, _options = {}) {
   return input;
 }
+function defineSdkModule(moduleDefinition) {
+  return moduleDefinition;
+}
+function buildModules(modules) {
+  return (context) => Object.fromEntries(
+    Object.entries(modules).map(([key, module]) => [key, module(context)])
+  );
+}
 export {
   createAlokaiMiddleware,
   createLogger,
   createSdk,
+  defineGetConfigSwitcherHeader,
   defineSdkConfig,
-  getPathnameFromRequestHeaders,
+  defineSdkModule,
   resolveSdkOptions
 };

package/dist/{types-BCNzbTr2.d.mts → types-glZZCnsn.d.mts}

@@ -224,4 +224,4 @@ type CreateSdkContextReturn<TSdk extends SDKApi<any>, TSfContract extends SfCont
     useSfLocaleState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocaleState"];
 }>;
 
-export { type CreateSdkContextReturn as C, type Maybe as M, type SfContract as S, type SfStateProps as a, type SfState as b, createSfStateProvider as c, type CreateSdkOptions as d, type Config as e, type CreateSdkReturn as f };
+export { type CreateSdkContextReturn as C, type InjectedContext as I, type Maybe as M, type SfContract as S, type SfStateProps as a, type SfState as b, createSfStateProvider as c, type CreateSdkOptions as d, type Config as e, type CreateSdkReturn as f };

package/dist/{types-BCNzbTr2.d.ts → types-glZZCnsn.d.ts}

@@ -224,4 +224,4 @@ type CreateSdkContextReturn<TSdk extends SDKApi<any>, TSfContract extends SfCont
     useSfLocaleState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocaleState"];
 }>;
 
-export { type CreateSdkContextReturn as C, type Maybe as M, type SfContract as S, type SfStateProps as a, type SfState as b, createSfStateProvider as c, type CreateSdkOptions as d, type Config as e, type CreateSdkReturn as f };
+export { type CreateSdkContextReturn as C, type InjectedContext as I, type Maybe as M, type SfContract as S, type SfStateProps as a, type SfState as b, createSfStateProvider as c, type CreateSdkOptions as d, type Config as e, type CreateSdkReturn as f };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@vue-storefront/next",
   "description": "Alokai dedicated features for Next.js",
   "license": "MIT",
-  "version": "6.0.0-rc.4",
+  "version": "6.0.0-rc.5",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -30,7 +30,7 @@
     "zustand": "^4.5.4"
   },
   "devDependencies": {
-    "@alokai/connect": "^1.0.0-rc.3",
+    "@alokai/connect": "^1.0.0-rc.4",
     "@types/react": "18.3.2",
     "@types/react-dom": "18.3.0",
     "react-dom": "18.3.1",
@@ -41,7 +41,7 @@
     "next": "14.2.25"
   },
   "peerDependencies": {
-    "@alokai/connect": "^1.0.0-rc.3",
+    "@alokai/connect": "^1.0.0-rc.4",
     "react": "^18.2.0",
     "next": "^13.4.7 || ^14.0.0"
   },