@vue-storefront/next 4.3.0 → 4.3.1

package/dist/client.d.mts

@@ -11,16 +11,33 @@ import 'react';
  * Create a new Alokai context somewhere in your application. It may be the `hooks/sdk.ts` file.
  *
  * ```tsx
+ * 'use client';
+ *
  * import { createAlokaiContext } from "@vue-storefront/next/client";
  * import type { Sdk } from './sdk.server';
+ * import type { SfContract } from 'storefront-middleware/types';
  *
- * export const [AlokaiProvider, useSdk] = createAlokaiContext<Sdk>();
+ * export const {
+ *  AlokaiProvider,
+ *  useSdk,
+ *  useSfCartState,
+ *  useSfCurrenciesState,
+ *  useSfCurrencyState,
+ *  useSfCustomerState,
+ * } = createAlokaiContext<Sdk, SfContract>();
  * ```
+ * This is also a place where you can import hooks for handling the state management.
+ * You can read more about the state management in the documentation https://docs.alokai.com/sdk/getting-started/state-management.
  * Then use the `AlokaiProvider` in the root component of your application.
  * For Pages Router it would be the `pages/_app.tsx` file,
  * and for the App Router it would be the `app/layout.tsx` file.
  * Finally, you can use the `useSdk` in any client component of your application.
- * @returns [AlokaiProvider, useSdk] - The SDK provider and the `useSdk` hook.
+ * @returns AlokaiProvider - The Alokai Context Provider.
+ * @returns useSdk - The SDK provider and the `useSdk` hook.
+ * @returns useSfCartState - Hook that return Cart state with `SfCart` type.
+ * @returns useSfCurrenciesState - Hook that return Currencies state with `SfCurrency` type.
+ * @returns useSfCurrencyState - Hook that return Currency state with `SfCurrency[]` type.
+ * @returns useSfCustomerState - Hook that return Customer state with `SfCustomer` type.
  */
 declare function createAlokaiContext<TSdk extends SDKApi<any>, TSfContract extends SfContract>(): CreateSdkContextReturn<TSdk, TSfContract>;
 

package/dist/client.d.ts

@@ -11,16 +11,33 @@ import 'react';
  * Create a new Alokai context somewhere in your application. It may be the `hooks/sdk.ts` file.
  *
  * ```tsx
+ * 'use client';
+ *
  * import { createAlokaiContext } from "@vue-storefront/next/client";
  * import type { Sdk } from './sdk.server';
+ * import type { SfContract } from 'storefront-middleware/types';
  *
- * export const [AlokaiProvider, useSdk] = createAlokaiContext<Sdk>();
+ * export const {
+ *  AlokaiProvider,
+ *  useSdk,
+ *  useSfCartState,
+ *  useSfCurrenciesState,
+ *  useSfCurrencyState,
+ *  useSfCustomerState,
+ * } = createAlokaiContext<Sdk, SfContract>();
  * ```
+ * This is also a place where you can import hooks for handling the state management.
+ * You can read more about the state management in the documentation https://docs.alokai.com/sdk/getting-started/state-management.
  * Then use the `AlokaiProvider` in the root component of your application.
  * For Pages Router it would be the `pages/_app.tsx` file,
  * and for the App Router it would be the `app/layout.tsx` file.
  * Finally, you can use the `useSdk` in any client component of your application.
- * @returns [AlokaiProvider, useSdk] - The SDK provider and the `useSdk` hook.
+ * @returns AlokaiProvider - The Alokai Context Provider.
+ * @returns useSdk - The SDK provider and the `useSdk` hook.
+ * @returns useSfCartState - Hook that return Cart state with `SfCart` type.
+ * @returns useSfCurrenciesState - Hook that return Currencies state with `SfCurrency` type.
+ * @returns useSfCurrencyState - Hook that return Currency state with `SfCurrency[]` type.
+ * @returns useSfCustomerState - Hook that return Customer state with `SfCustomer` type.
  */
 declare function createAlokaiContext<TSdk extends SDKApi<any>, TSfContract extends SfContract>(): CreateSdkContextReturn<TSdk, TSfContract>;
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@vue-storefront/next",
   "description": "Alokai dedicated features for Next.js",
   "license": "MIT",
-  "version": "4.3.0",
+  "version": "4.3.1",
   "exports": {
     ".": {
       "import": "./dist/index.mjs",
@@ -22,7 +22,8 @@
     "build": "tsup",
     "lint": "biome ci .",
     "format": "prettier --write .",
-    "test:unit": "vitest run"
+    "test:unit": "vitest run",
+    "version": "cp CHANGELOG.md ../../docs/content/storefront/6.change-log/next.md"
   },
   "dependencies": {
     "zustand": "^4.5.4",
@@ -35,7 +36,7 @@
     "react-dom": "18.3.0",
     "start-server-and-test": "^2.0.3",
     "tsup": "8.3.0",
-    "vitest": "2.0.3",
+    "vitest": "2.1.5",
     "react": "18.3.1",
     "next": "14.2.5"
   },