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

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

@@ -1,51 +1,13 @@
-import { buildModule, middlewareModule, SDKApi } from '@alokai/connect/sdk';
-import React, { PropsWithChildren, ReactNode } from 'react';
+import { SDKApi, buildModule, middlewareModule } from '@alokai/connect/sdk';
 import { cookies } from 'next/headers';
+import React, { PropsWithChildren, ReactNode } from 'react';
 
-declare const defaultMethodsRequestConfig: {
-    readonly unifiedCommerce: {
-        readonly middlewareModule: {
-            readonly getCategory: {
-                readonly method: "GET";
-            };
-            readonly getCategories: {
-                readonly method: "GET";
-            };
-            readonly getProductDetails: {
-                readonly method: "GET";
-            };
-            readonly getProductReviews: {
-                readonly method: "GET";
-            };
-            readonly getProducts: {
-                readonly method: "GET";
-            };
-            readonly getCurrencies: {
-                readonly method: "GET";
-            };
-            readonly searchProducts: {
-                readonly method: "GET";
-            };
-        };
-    };
-    readonly unifiedCms: {
-        readonly middlewareModule: {
-            readonly getPage: {
-                readonly method: "GET";
-            };
-            readonly getEntries: {
-                readonly method: "GET";
-            };
-        };
-    };
-};
-
-type Maybe<TType> = TType | null;
+type Maybe<TType> = null | TType;
 
 type SfContract = {
     SfCart: unknown;
-    SfCustomer: unknown;
     SfCurrency: unknown;
+    SfCustomer: unknown;
     SfLocale: unknown;
 };
 interface SfStateProps<TSfContract extends SfContract> {
@@ -55,12 +17,12 @@ interface SfStateProps<TSfContract extends SfContract> {
     locales: TSfContract["SfLocale"][];
 }
 interface SfState<TSfContract extends SfContract> extends SfStateProps<TSfContract> {
-    cart: TSfContract["SfCart"] | null | undefined;
-    customer: TSfContract["SfCustomer"] | null | undefined;
-    setCart: (cart?: TSfContract["SfCart"] | null) => void;
+    cart: null | TSfContract["SfCart"] | undefined;
+    customer: null | TSfContract["SfCustomer"] | undefined;
+    setCart: (cart?: null | TSfContract["SfCart"]) => void;
     setCurrencies: (currencies: TSfContract["SfCurrency"][]) => void;
     setCurrency: (currency: TSfContract["SfCurrency"]) => void;
-    setCustomer: (customer?: TSfContract["SfCustomer"] | null) => void;
+    setCustomer: (customer?: null | TSfContract["SfCustomer"]) => void;
     setLocale: (locale: TSfContract["SfLocale"]) => void;
     setLocales: (locales: TSfContract["SfLocale"][]) => void;
 }
@@ -68,43 +30,76 @@ declare function createSfStateProvider<TSfContract extends SfContract>(): {
     SfStateProvider: ({ children, initialData, }: {
         initialData: SfStateProps<TSfContract>;
     } & PropsWithChildren) => React.JSX.Element;
-    useSfCurrencyState: () => [
-        TSfContract["SfCurrency"],
-        (currency: TSfContract["SfCurrency"]) => void
+    useSfCartState: () => [
+        null | TSfContract["SfCart"] | undefined,
+        (cart?: null | TSfContract["SfCart"]) => void
     ];
     useSfCurrenciesState: () => [
         TSfContract["SfCurrency"][],
         (currencies: TSfContract["SfCurrency"][]) => void
     ];
-    useSfLocaleState: () => [
-        TSfContract["SfLocale"],
-        (locale: TSfContract["SfLocale"]) => void
+    useSfCurrencyState: () => [
+        TSfContract["SfCurrency"],
+        (currency: TSfContract["SfCurrency"]) => void
+    ];
+    useSfCustomerState: () => [
+        null | TSfContract["SfCustomer"] | undefined,
+        (customer?: null | TSfContract["SfCustomer"]) => void
     ];
     useSfLocalesState: () => [
         TSfContract["SfLocale"][],
         (locales: TSfContract["SfLocale"][]) => void
     ];
-    useSfCartState: () => [
-        TSfContract["SfCart"] | null | undefined,
-        (cart?: TSfContract["SfCart"] | null) => void
-    ];
-    useSfCustomerState: () => [
-        TSfContract["SfCustomer"] | null | undefined,
-        (customer?: TSfContract["SfCustomer"] | null) => void
+    useSfLocaleState: () => [
+        TSfContract["SfLocale"],
+        (locale: TSfContract["SfLocale"]) => void
     ];
 };
 
+declare const defaultMethodsRequestConfig: {
+    readonly unifiedCms: {
+        readonly middlewareModule: {
+            readonly getEntries: {
+                readonly method: "GET";
+            };
+            readonly getPage: {
+                readonly method: "GET";
+            };
+        };
+    };
+    readonly unifiedCommerce: {
+        readonly middlewareModule: {
+            readonly getCategories: {
+                readonly method: "GET";
+            };
+            readonly getCategory: {
+                readonly method: "GET";
+            };
+            readonly getCurrencies: {
+                readonly method: "GET";
+            };
+            readonly getProductDetails: {
+                readonly method: "GET";
+            };
+            readonly getProductReviews: {
+                readonly method: "GET";
+            };
+            readonly getProducts: {
+                readonly method: "GET";
+            };
+            readonly searchProducts: {
+                readonly method: "GET";
+            };
+        };
+    };
+};
+
 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.
@@ -112,6 +107,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 {
     /**
@@ -122,43 +122,47 @@ interface MultistoreConfig {
     enabled: boolean;
 }
 interface CreateSdkOptions {
-    multistore?: MultistoreConfig;
     middleware: MiddlewareConfig;
+    multistore?: MultistoreConfig;
 }
 type Cookies = ReturnType<typeof cookies>;
-type NextHeaders = Record<string, string | string[] | undefined> | Headers;
+type NextHeaders = Headers | Record<string, string | string[] | undefined>;
 type GetSdkContext = {
+    /**
+     * A function that returns the current locale string;
+     */
+    getLocale?: () => string;
     /**
      * A function that returns the request headers.
      */
-    getRequestHeaders?: () => NextHeaders | {
-        headers: NextHeaders;
+    getRequestHeaders?: () => {
         cookies: Cookies;
-    };
+        headers: NextHeaders;
+    } | NextHeaders;
 };
 type DynamicContext = {
     getRequestHeaders: () => Record<string, string | string[]>;
 };
 type StaticContext = {
     buildModule: typeof buildModule;
-    middlewareModule: typeof middlewareModule;
-    /**
-     * @deprecated Use `config.defaultMethodsRequestConfig` instead.
-     */
-    defaults: typeof defaultMethodsRequestConfig;
     config: {
         apiUrl: string;
-        ssrApiUrl: string;
-        defaultMethodsRequestConfig: typeof defaultMethodsRequestConfig;
         cdnCacheBustingId: string;
+        defaultMethodsRequestConfig: typeof defaultMethodsRequestConfig;
+        ssrApiUrl: string;
     };
+    /**
+     * @deprecated Use `config.defaultMethodsRequestConfig` instead.
+     */
+    defaults: typeof defaultMethodsRequestConfig;
+    middlewareModule: typeof middlewareModule;
 };
 type InjectedContext = DynamicContext & StaticContext;
 type Config<TConfig> = (context: InjectedContext) => TConfig;
 type AlokaiProviderProps<TSdk, TSfContract extends SfContract> = {
     children: ReactNode;
-    sdk: TSdk;
     initialData: SfStateProps<TSfContract>;
+    sdk: TSdk;
 };
 interface CreateSdkReturn<TConfig extends Record<string, any>> {
     /**
@@ -176,9 +180,10 @@ interface CreateSdkReturn<TConfig extends Record<string, any>> {
      * import type { GetServerSideProps } from "next";
      * import { getSdk } from "../../sdk.config";
      *
-     * export const getServerSideProps: GetServerSideProps = async ({ req }) => {
-     *  const sdk = getSdk({
+     * export const getServerSideProps: GetServerSideProps = async ({ req, locale }) => {
+     *  const sdk = await getSdk({
      *    getRequestHeaders: () => req.headers,
+     *    getLocale: () => locale,
      *  });
      *  const { products } = await sdk.unified.getProducts();
      *
@@ -195,8 +200,10 @@ interface CreateSdkReturn<TConfig extends Record<string, any>> {
      * import { getSdk } from "../../sdk.config";
      *
      * export default async function SsrPage() {
-     *  const sdk = getSdk({
+     *  const locale = await getLocale();
+     *  const sdk = await getSdk({
      *    getRequestHeaders: () => headers(),
+     *    getLocale: () => locale,
      *  });
      *  const { products } = await sdk.unified.getProducts();
      *
@@ -209,12 +216,12 @@ interface CreateSdkReturn<TConfig extends Record<string, any>> {
 type CreateSdkContextReturn<TSdk extends SDKApi<any>, TSfContract extends SfContract> = Readonly<{
     AlokaiProvider: ({ children, }: AlokaiProviderProps<TSdk, TSfContract>) => JSX.Element;
     useSdk: () => TSdk;
-    useSfCurrencyState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCurrencyState"];
-    useSfCurrenciesState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCurrenciesState"];
-    useSfLocaleState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocaleState"];
-    useSfLocalesState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocalesState"];
     useSfCartState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCartState"];
+    useSfCurrenciesState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCurrenciesState"];
+    useSfCurrencyState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCurrencyState"];
     useSfCustomerState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCustomerState"];
+    useSfLocalesState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocalesState"];
+    useSfLocaleState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocaleState"];
 }>;
 
-export { type CreateSdkOptions as C, type Maybe as M, type SfContract as S, type Config as a, type CreateSdkReturn as b, type CreateSdkContextReturn as c, type SfStateProps as d, type SfState as e, createSfStateProvider 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.3",
+  "version": "6.0.0-rc.5",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -20,7 +20,8 @@
   ],
   "scripts": {
     "build": "tsup",
-    "lint": "biome ci .",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "format": "prettier --write .",
     "test:unit": "vitest run",
     "version": "cp CHANGELOG.md ../../docs/enterprise/content/storefront/6.change-log/next.md"
@@ -29,7 +30,7 @@
     "zustand": "^4.5.4"
   },
   "devDependencies": {
-    "@alokai/connect": "^1.0.0-rc.2",
+    "@alokai/connect": "^1.0.0-rc.4",
     "@types/react": "18.3.2",
     "@types/react-dom": "18.3.0",
     "react-dom": "18.3.1",
@@ -37,10 +38,10 @@
     "tsup": "8.3.0",
     "vitest": "2.1.5",
     "react": "18.3.1",
-    "next": "14.2.23"
+    "next": "14.2.25"
   },
   "peerDependencies": {
-    "@alokai/connect": "^1.0.0-rc.2",
+    "@alokai/connect": "^1.0.0-rc.4",
     "react": "^18.2.0",
     "next": "^13.4.7 || ^14.0.0"
   },