@vue-storefront/next 0.0.0-20250722194236

package/dist/index.d.mts

@@ -0,0 +1,180 @@
+import * as _alokai_connect_logger from '@alokai/connect/logger';
+import { NextRequest, NextResponse } from 'next/server';
+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-B9h_AU7R.mjs';
+import 'next/headers';
+import 'react';
+
+type LogVerbosity = "alert" | "critical" | "debug" | "emergency" | "error" | "info" | "notice" | "warning";
+type LoggerOptions = Partial<{
+    includeStackTrace: boolean;
+    verbosity: LogVerbosity;
+}>;
+
+declare const createLogger: (options?: LoggerOptions) => _alokai_connect_logger.LoggerInterface;
+
+type NextMiddleware = (request: NextRequest) => NextResponse | Promise<NextResponse>;
+/**
+ * Creates an Alokai middleware wrapper that adds pathname information to request headers.
+ * This is required for proper pathname handling during SSR in Next.js.
+ *
+ * @example
+ * ```ts
+ * // middleware.ts
+ * import { createAlokaiMiddleware } from '@alokai/next';
+ *
+ * export default createAlokaiMiddleware((request) => {
+ *   // Your middleware logic here
+ * });
+ * ```
+ *
+ * @param middleware - The Next.js middleware function to wrap
+ * @returns A wrapped middleware function that adds pathname to request headers
+ */
+declare function createAlokaiMiddleware(middleware: NextMiddleware): (request: NextRequest) => NextResponse<unknown> | Promise<NextResponse<unknown>>;
+
+/**
+ * Creates an SDK for the given configuration definition.
+ * @param options - The options for creating the SDK.
+ * @param configDefinition - The configuration definition for the SDK.
+ * @returns An object containing the `getSdk` function.
+ * @example
+ * ```tsx
+ * import { contentfulModule } from "@vsf-enterprise/contentful-sdk";
+ * import { CreateSdkOptions, createSdk } from "@vue-storefront/next";
+ * import type { UnifiedApiEndpoints } from "../storefront-middleware/types";
+ *
+ * const options: CreateSdkOptions = {
+ *   middleware: {
+ *     apiUrl: "http://localhost:4000",
+ *     ssrApiUrl: "http://localhost:4000",
+ *     cdnCacheBustingId: "no-cache-busting-id-set",
+ *   },
+ *   multistore: {
+ *    enabled: false,
+ *   },
+ * };
+ *
+ * export const { getSdk, createSdkContext } = createSdk(
+ *   options,
+ *   ({ buildModule, middlewareModule, config, getRequestHeaders }) => ({
+ *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
+ *       apiUrl: config.apiUrl + "/commerce",
+ *       ssrApiUrl: config.ssrApiUrl + "/commerce",
+ *       cdnCacheBustingId: config.cdnCacheBustingId,
+ *       defaultRequestConfig: {
+ *         headers: getRequestHeaders(),
+ *       },
+ *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
+ *     }),
+ *     contentful: buildModule(contentfulModule, {
+ *       apiUrl: config.apiUrl + "/cntf",
+ *       ssrApiUrl: config.ssrApiUrl + "/cntf",
+ *     }),
+ *   }),
+ * );
+ * ```
+ */
+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 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<UnifiedEndpoints>, {
+ *       apiUrl: `${config.apiUrl}/commerce/unified`,
+ *       ssrApiUrl: `${config.ssrApiUrl}/commerce/unified`,
+ *       cdnCacheBustingId: config.cdnCacheBustingId,
+ *       defaultRequestConfig: {
+ *         getConfigSwitcherHeader,
+ *         headers: getRequestHeaders(),
+ *       },
+ *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
+ *     }),
+ *   }),
+ * );
+ * ```
+ *
+ * @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;
+};
+/**
+ * Helper function to resolve the SDK options based on the configuration.
+ *
+ * @privateRemarks
+ * For now this file only verifies the type of the input and simply returns it.
+ * However, in the future we might need it to perform true input resolution.
+ *
+ * @param input - The options for creating the SDK.
+ * @param options - The configuration object, that allows to customize the API Url creation on enabled multistore.
+ *
+ * @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, defineSdkModule, resolveSdkOptions };

package/dist/index.d.ts

@@ -0,0 +1,180 @@
+import * as _alokai_connect_logger from '@alokai/connect/logger';
+import { NextRequest, NextResponse } from 'next/server';
+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-B9h_AU7R.js';
+import 'next/headers';
+import 'react';
+
+type LogVerbosity = "alert" | "critical" | "debug" | "emergency" | "error" | "info" | "notice" | "warning";
+type LoggerOptions = Partial<{
+    includeStackTrace: boolean;
+    verbosity: LogVerbosity;
+}>;
+
+declare const createLogger: (options?: LoggerOptions) => _alokai_connect_logger.LoggerInterface;
+
+type NextMiddleware = (request: NextRequest) => NextResponse | Promise<NextResponse>;
+/**
+ * Creates an Alokai middleware wrapper that adds pathname information to request headers.
+ * This is required for proper pathname handling during SSR in Next.js.
+ *
+ * @example
+ * ```ts
+ * // middleware.ts
+ * import { createAlokaiMiddleware } from '@alokai/next';
+ *
+ * export default createAlokaiMiddleware((request) => {
+ *   // Your middleware logic here
+ * });
+ * ```
+ *
+ * @param middleware - The Next.js middleware function to wrap
+ * @returns A wrapped middleware function that adds pathname to request headers
+ */
+declare function createAlokaiMiddleware(middleware: NextMiddleware): (request: NextRequest) => NextResponse<unknown> | Promise<NextResponse<unknown>>;
+
+/**
+ * Creates an SDK for the given configuration definition.
+ * @param options - The options for creating the SDK.
+ * @param configDefinition - The configuration definition for the SDK.
+ * @returns An object containing the `getSdk` function.
+ * @example
+ * ```tsx
+ * import { contentfulModule } from "@vsf-enterprise/contentful-sdk";
+ * import { CreateSdkOptions, createSdk } from "@vue-storefront/next";
+ * import type { UnifiedApiEndpoints } from "../storefront-middleware/types";
+ *
+ * const options: CreateSdkOptions = {
+ *   middleware: {
+ *     apiUrl: "http://localhost:4000",
+ *     ssrApiUrl: "http://localhost:4000",
+ *     cdnCacheBustingId: "no-cache-busting-id-set",
+ *   },
+ *   multistore: {
+ *    enabled: false,
+ *   },
+ * };
+ *
+ * export const { getSdk, createSdkContext } = createSdk(
+ *   options,
+ *   ({ buildModule, middlewareModule, config, getRequestHeaders }) => ({
+ *     unified: buildModule(middlewareModule<UnifiedApiEndpoints>, {
+ *       apiUrl: config.apiUrl + "/commerce",
+ *       ssrApiUrl: config.ssrApiUrl + "/commerce",
+ *       cdnCacheBustingId: config.cdnCacheBustingId,
+ *       defaultRequestConfig: {
+ *         headers: getRequestHeaders(),
+ *       },
+ *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
+ *     }),
+ *     contentful: buildModule(contentfulModule, {
+ *       apiUrl: config.apiUrl + "/cntf",
+ *       ssrApiUrl: config.ssrApiUrl + "/cntf",
+ *     }),
+ *   }),
+ * );
+ * ```
+ */
+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 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<UnifiedEndpoints>, {
+ *       apiUrl: `${config.apiUrl}/commerce/unified`,
+ *       ssrApiUrl: `${config.ssrApiUrl}/commerce/unified`,
+ *       cdnCacheBustingId: config.cdnCacheBustingId,
+ *       defaultRequestConfig: {
+ *         getConfigSwitcherHeader,
+ *         headers: getRequestHeaders(),
+ *       },
+ *       methodsRequestConfig: config.defaultMethodsRequestConfig.unifiedCommerce.middlewareModule,
+ *     }),
+ *   }),
+ * );
+ * ```
+ *
+ * @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;
+};
+/**
+ * Helper function to resolve the SDK options based on the configuration.
+ *
+ * @privateRemarks
+ * For now this file only verifies the type of the input and simply returns it.
+ * However, in the future we might need it to perform true input resolution.
+ *
+ * @param input - The options for creating the SDK.
+ * @param options - The configuration object, that allows to customize the API Url creation on enabled multistore.
+ *
+ * @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, defineSdkModule, resolveSdkOptions };

package/dist/index.js

@@ -0,0 +1,202 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createAlokaiMiddleware: () => createAlokaiMiddleware,
+  createLogger: () => createLogger,
+  createSdk: () => createSdk,
+  defineGetConfigSwitcherHeader: () => import_sdk2.defineGetConfigSwitcherHeader,
+  defineSdkConfig: () => defineSdkConfig,
+  defineSdkModule: () => defineSdkModule,
+  resolveSdkOptions: () => resolveSdkOptions
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/logger/index.ts
+var import_logger = require("@alokai/connect/logger");
+
+// src/logger/injectMetadata.ts
+function injectMetadata(logger, externalData) {
+  return new Proxy(logger, {
+    get(target, prop) {
+      const targetProp = target[prop];
+      if (typeof targetProp === "function") {
+        return (...args) => {
+          const [logData, metadata] = args;
+          targetProp(logData, __spreadValues(__spreadValues({}, metadata), externalData));
+        };
+      }
+      return targetProp;
+    }
+  });
+}
+
+// src/logger/index.ts
+var createLogger = (options) => {
+  const logger = import_logger.LoggerFactory.create(import_logger.LoggerType.ConsolaGcp, options);
+  return injectMetadata(logger, {
+    alokai: {
+      context: "storefront"
+    }
+  });
+};
+
+// src/middleware.ts
+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);
+  };
+}
+
+// src/sdk/index.tsx
+var import_sdk = require("@alokai/connect/sdk");
+
+// src/sdk/helpers/defaultConfigs.ts
+var defaultMethodsRequestConfig = {
+  unifiedCms: {
+    middlewareModule: {
+      getEntries: { method: "GET" },
+      getPage: { method: "GET" }
+    }
+  },
+  unifiedCommerce: {
+    middlewareModule: {
+      getCategories: { method: "GET" },
+      getCategory: { method: "GET" },
+      getCurrencies: { method: "GET" },
+      getProductDetails: { method: "GET" },
+      getProductReviews: { method: "GET" },
+      getProducts: { method: "GET" },
+      searchProducts: { method: "GET" }
+    }
+  }
+};
+
+// src/sdk/helpers/resolveDynamicContext.ts
+var BLACKLISTED_HEADERS = /* @__PURE__ */ new Set(["host"]);
+function isAppRouterHeaders(headers) {
+  return !!headers && "entries" in headers;
+}
+function isFlatNextHeaders(headers) {
+  return !!headers && !("headers" in headers);
+}
+function normalizeRequestHeaders(requestHeaders) {
+  const { cookies, headers = {} } = isFlatNextHeaders(requestHeaders) ? { cookies: void 0, headers: requestHeaders } : {
+    cookies: requestHeaders == null ? void 0 : requestHeaders.cookies,
+    headers: requestHeaders == null ? void 0 : requestHeaders.headers
+  };
+  const normalizedHeaders = isAppRouterHeaders(headers) ? Object.fromEntries(headers.entries()) : headers;
+  if (cookies) {
+    normalizedHeaders.cookie = cookies.toString();
+  }
+  return normalizedHeaders;
+}
+function resolveDynamicContext(context) {
+  return __spreadProps(__spreadValues({}, context), {
+    getRequestHeaders() {
+      var _a;
+      const normalizedHeaders = normalizeRequestHeaders(
+        (_a = context.getRequestHeaders) == null ? void 0 : _a.call(context)
+      );
+      const requestHeaders = Object.fromEntries(
+        Object.entries(normalizedHeaders).filter(
+          ([key]) => !BLACKLISTED_HEADERS.has(key)
+        )
+      );
+      if (context.getLocale) {
+        requestHeaders["x-alokai-locale"] = context.getLocale();
+      }
+      return requestHeaders;
+    }
+  });
+}
+
+// src/sdk/index.tsx
+var import_sdk2 = require("@alokai/connect/sdk");
+function createSdk(options, configDefinition) {
+  function getSdk(dynamicContext = {}) {
+    var _a;
+    const { getRequestHeaders } = resolveDynamicContext(dynamicContext);
+    const resolvedConfig = configDefinition({
+      buildModule: import_sdk.buildModule,
+      config: {
+        apiUrl: options.middleware.apiUrl,
+        cdnCacheBustingId: (_a = options.middleware.cdnCacheBustingId) != null ? _a : "no-cache-busting-id-set",
+        defaultMethodsRequestConfig,
+        ssrApiUrl: options.middleware.ssrApiUrl
+      },
+      defaults: defaultMethodsRequestConfig,
+      getRequestHeaders,
+      middlewareModule: import_sdk.middlewareModule
+    });
+    return (0, import_sdk.initSDK)(resolvedConfig);
+  }
+  return {
+    getSdk
+  };
+}
+function defineSdkConfig(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,
+  defineSdkModule,
+  resolveSdkOptions
+});