@scayle/storefront-nuxt 8.9.0 → 8.9.2

package/CHANGELOG.md

@@ -1,5 +1,156 @@
 # @scayle/storefront-nuxt
 
+## 8.9.2
+
+### Patch Changes
+
+- Deprecate `key`, `packages`, `shippingDates`, `isEmpty`, `countWithoutSoldOutItems`, `removeItem`, `contains`, `findItem`, `products`, `generateBasketKey` and `mergeBaskets` from `useBasket`.
+
+  Required updates:
+
+  - `key`:
+
+    ```TypeScript
+    const { key } = useBasket()
+
+    // will become
+
+    const { data } = useBasket()
+    const key = computed(() => data.value.key)
+    ```
+
+  - `packages`:
+
+    ```TypeScript
+    const { packages } = useBasket()
+
+    // will become
+
+    const { data } = useBasket()
+    const packages = computed(() => data.value.packages)
+    ```
+
+  - `shippingDates`:
+
+    ```TypeScript
+    const { shippingDates } = useBasket()
+
+    // will become
+    import { getShippingDates } from '@scayle/storefront-nuxt'
+    const { data } = useBasket()
+    const shippingDates = computed(() => shippingDates(data.value.packages))
+    ```
+
+  - `isEmpty`:
+
+    ```TypeScript
+    const { isEmpty } = useBasket()
+
+    // will become
+
+    const { count } = useBasket()
+    const isEmpty = computed(() => count.value === 0)
+    ```
+
+  - `countWithoutSoldOutItems`:
+
+    ```TypeScript
+    const { countWithoutSoldOutItems } = useBasket()
+
+    // will become
+
+    import { countAvailableBasketItems } from '#storefront-basket'
+    const { items } = useBasket()
+    const isEmpty = computed(() => countAvailableBasketItems(items.value ?? []))
+    ```
+
+  - `products`:
+
+    ```TypeScript
+    const { products } = useBasket()
+
+    // will become
+
+    import { findItem } from '#storefront-basket'
+    const { items } = useBasket()
+    const products = computed(() => items.value?.map((item) => item.product))
+    ```
+
+  - `removeItem`:
+
+    ```TypeScript
+    const { removeItem, items } = useBasket()
+    removeItem({ variantId: items.value[0].variant.id })
+
+    // will become
+
+    const { removeItemByKey, items } = useBasket()
+    removeItemByKey(items.value[0].key)
+    ```
+
+  - `contains`:
+
+    ```TypeScript
+    const { contains } = useBasket()
+    const isInBasket = contains({ variantId: 1 })
+
+    // will become
+
+    import { contains } from '#storefront-basket'
+    const { items } = useBasket()
+    const isInBasket = contains({ variantId: 1 }, items.value ?? [])
+    ```
+
+  - `findItem`:
+
+    ```TypeScript
+    const { findItem } = useBasket()
+    const basketItem = findItem({ variantId: 1 })
+
+    // will become
+
+    import { findItem } from '#storefront-basket'
+    const { items } = useBasket()
+    const basketItem = findItem({ variantId: 1 }, items.value ?? [])
+    ```
+
+  - `generateBasketKey`:
+
+    ```TypeScript
+    const { generateBasketKey } = useBasket()
+
+    // will become
+
+    import { generateBasketKey } from '@scayle/storefront-core/dist/utils/keys'
+    ```
+
+  - `generateBasketKey`:
+
+    ```TypeScript
+    const { mergeBaskets } = useBasket()
+    mergeBaskets('oldKey', 'newKey')
+    // will become
+
+    const mergeBasket = useRpcCall('mergeBaskets')
+    mergeBaskets('oldKey', 'newKey')
+    ```
+
+- Improve bootstrap performance by avoiding object merge and reflection
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@8.7.0
+
+## 8.9.1
+
+### Patch Changes
+
+- Updated dependency `@vueuse/core@12.5.0` to `@vueuse/core@12.6.1`
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@8.6.1
+
 ## 8.9.0
 
 ### Minor Changes

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.9.0",
+  "version": "8.9.2",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -45,7 +45,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.9.0";
+const PACKAGE_VERSION = "8.9.2";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

package/dist/runtime/composables/storefront/useBasket.d.ts

@@ -1,3 +1,4 @@
+import { generateBasketKey } from '@scayle/storefront-core/dist/utils/keys';
 import type { AddOrUpdateItemType, RpcMethodParameters, RpcMethodReturnType, BasketItem, Product, BasketTotalPrice } from '@scayle/storefront-core';
 import { ExistingItemHandling } from '@scayle/storefront-core';
 import { type NormalizedRpcResponse, type UseRpcReturn } from '../core/useRpc.js';
@@ -15,34 +16,46 @@ type UseBasketBaseReturn = Omit<Awaited<UseRpcReturn<'getBasket'>>, 'data'> & {
         existingItemHandling?: ExistingItemHandling;
     }) => Promise<void>;
     addItems: (items: AddOrUpdateItemType[], existingItemHandling?: typeof ExistingItemHandling.ADD_QUANTITY_TO_EXISTING) => Promise<void>;
+    removeItemByKey: (itemKey: string) => Promise<void>;
+    updateItem: (basketItemKey: string, update: BasketItemUpdateData) => Promise<void>;
+    clear: () => Promise<void>;
+    items: ComputedRef<BasketItem[] | undefined>;
+    cost: ComputedRef<BasketTotalPrice | undefined>;
+    count: ComputedRef<number | undefined>;
+    /** @deprecated In a future release `mergeBaskets` will be removed. Consider using `useRpcCall('mergeBaskets')` instead.*/
     mergeBaskets: (args: {
         fromBasketKey: string;
         toBasketKey: string;
     }) => RpcMethodReturnType<'mergeBaskets'>;
+    /** @deprecated In a future release `findItem` will be removed. Consider using `findItem` from `@scayle/storefront-basket` */
     findItem: (item: {
         variantId: number;
     } | {
         productId: number;
     }) => BasketItem | undefined;
+    /** @deprecated In a future release `contains` will be removed. Consider using `contains` from `@scayle/storefront-basket` */
     contains: (item: {
         variantId: number;
     } | {
         productId: number;
     }) => boolean;
+    /** @deprecated In a future release `removeItem` will be removed. Consider using {@link UseBasketBaseReturn.removeItemByKey | removeItemByKey } instead*/
     removeItem: (item: {
         variantId: number;
     }) => Promise<void>;
-    removeItemByKey: (itemKey: string) => Promise<void>;
-    updateItem: (basketItemKey: string, update: BasketItemUpdateData) => Promise<void>;
-    clear: () => Promise<void>;
+    /** @deprecated In a future release `generateBasketKey` will be removed. Consider using {@link generateBasketKey} instead.*/
+    generateBasketKey: typeof generateBasketKey;
+    /** @deprecated  In a future release `key` will be removed. Consider using {@link UseBasketBaseReturn.items | `items`} instead. */
     products: ComputedRef<Product[]>;
-    count: ComputedRef<number | undefined>;
+    /** @deprecated In a future removeItem `countWithoutSoldOutItems` will be removed. Consider using `countAvailableBasketItems` from `@scayle/storefront-basket` */
     countWithoutSoldOutItems: ComputedRef<number | undefined>;
-    items: ComputedRef<BasketItem[] | undefined>;
-    cost: ComputedRef<BasketTotalPrice | undefined>;
+    /** @deprecated In a future release `key` will be removed. Consider using `data.value.key` instead. */
     key: ComputedRef<BasketKey | undefined>;
+    /** @deprecated  In a future release `key` will be removed. Consider checking {@link UseBasketBaseReturn.count | count} instead. */
     isEmpty: ComputedRef<boolean>;
+    /** @deprecated In a future release `packages` will be removed. Consider using `data.value.packages` instead. */
     packages: ComputedRef<BasketPackageInformation[] | undefined>;
+    /** @deprecated In a future release `shippingDates` will be removed. Consider using {@link getShippingDates} instead. */
     shippingDates: ComputedRef<(string | null)[] | undefined>;
 };
 export declare function useBasket({ params, }?: UseBasketOptions, key?: string): UseBasketBaseReturn & Promise<UseBasketBaseReturn>;

package/dist/runtime/composables/storefront/useBasket.js

@@ -207,26 +207,26 @@ export function useBasket({
   return extendPromise(asyncData, {
     data,
     items,
+    count,
     cost,
-    key: basketKey,
-    packages,
-    shippingDates,
-    isEmpty,
     refresh,
-    count,
-    countWithoutSoldOutItems,
+    error,
+    status,
     addItem,
     addItems,
-    removeItem,
     removeItemByKey,
     updateItem,
     clear,
+    key: basketKey,
+    packages,
+    shippingDates,
+    isEmpty,
+    countWithoutSoldOutItems,
+    removeItem,
     contains,
     products,
     findItem,
     generateBasketKey,
-    mergeBaskets,
-    error,
-    status
+    mergeBaskets
   });
 }

package/dist/runtime/context.js

@@ -28,58 +28,8 @@ async function getBasketKey(appKeys, session, $log, $shopConfig) {
     log: $log
   }) : session?.id;
 }
-async function sessionProperties(context) {
-  const { $shopConfig, $storefront, $log, session } = context;
-  const appKeys = $shopConfig.appKeys ?? $storefront.appKeys;
-  if (session) {
-    return {
-      wishlistKey: await getWishlistKey(appKeys, session, $log, $shopConfig),
-      basketKey: await getBasketKey(appKeys, session, $log, $shopConfig),
-      sessionId: session.id,
-      get user() {
-        return session.data?.user ?? void 0;
-      },
-      get accessToken() {
-        return session.data?.accessToken ?? void 0;
-      },
-      get refreshToken() {
-        return session.data?.refreshToken ?? void 0;
-      },
-      destroySession: async () => {
-        await session.destroy();
-      },
-      createUserBoundSession: async () => {
-        $log.debug("creating user bound session");
-        const data = session.data;
-        await session.regenerate();
-        session.data = data;
-        await session.save();
-      },
-      updateUser: async (user) => {
-        session.data.user = user;
-        await session.save();
-      },
-      updateTokens: async (tokens) => {
-        Object.assign(session.data, tokens);
-        await session.save();
-      }
-    };
-  }
-  return {
-    wishlistKey: void 0,
-    basketKey: void 0,
-    sessionId: void 0,
-    user: void 0,
-    accessToken: void 0,
-    refreshToken: void 0,
-    destroySession: void 0,
-    createUserBoundSession: void 0,
-    updateUser: void 0,
-    updateTokens: void 0
-  };
-}
 export const buildContext = async (context) => {
-  const { $cache, $shopConfig, $storefront, $log, config, event } = context;
+  const { $cache, $shopConfig, $storefront, $log, config, event, session } = context;
   const sapiConfig = $shopConfig.sapi ?? $storefront.sapi;
   const appKeys = $shopConfig.appKeys ?? $storefront.appKeys;
   const idpConfig = $shopConfig.idp ?? $storefront.idp;
@@ -100,7 +50,7 @@ export const buildContext = async (context) => {
     $storefront.cache?.enabled
   );
   const { hooks } = useNitroApp();
-  const baseContext = {
+  const rpcContext = {
     cached,
     sapiClient,
     auth: {
@@ -110,11 +60,11 @@ export const buildContext = async (context) => {
       url: $shopConfig.checkout.host,
       secret: $shopConfig.checkout.secret,
       token: $shopConfig.checkout.token,
-      user: $shopConfig.checkout.user,
+      user: String($shopConfig.checkout.user),
       cbdExpiration: $shopConfig.checkout.cbdExpiration
     },
     oauth: {
-      clientId: $storefront.oauth.clientId,
+      clientId: String($storefront.oauth.clientId),
       clientSecret: $storefront.oauth.clientSecret,
       apiHost: $storefront.oauth.apiHost
     },
@@ -146,17 +96,47 @@ export const buildContext = async (context) => {
       $log
     ),
     runtimeConfiguration: config,
-    ip: getRequestIP(event, { xForwardedFor: true }),
-    headers: createAndPurifyHeaders(getRequestHeaders(event)),
+    get ip() {
+      return getRequestIP(event, { xForwardedFor: true });
+    },
+    get headers() {
+      return createAndPurifyHeaders(getRequestHeaders(event));
+    },
     internalAccessHeader: $storefront.internalAccessHeader,
     callHook: hooks.callHook,
     callHookParallel: hooks.callHookParallel,
-    callHookWith: hooks.callHookWith
+    callHookWith: hooks.callHookWith,
+    wishlistKey: session ? await getWishlistKey(appKeys, session, $log, $shopConfig) : void 0,
+    basketKey: session ? await getBasketKey(appKeys, session, $log, $shopConfig) : void 0,
+    sessionId: session?.id,
+    get user() {
+      return session?.data?.user ?? void 0;
+    },
+    get accessToken() {
+      return session?.data?.accessToken ?? void 0;
+    },
+    get refreshToken() {
+      return session?.data?.refreshToken ?? void 0;
+    },
+    destroySession: session ? async () => {
+      await session.destroy();
+    } : void 0,
+    createUserBoundSession: session ? async () => {
+      $log.debug("creating user bound session");
+      const data = session.data;
+      await session.regenerate();
+      session.data = data;
+      await session.save();
+    } : void 0,
+    updateUser: session ? async (user) => {
+      session.data.user = user;
+      await session.save();
+    } : void 0,
+    updateTokens: session ? async (tokens) => {
+      Object.assign(session.data, tokens);
+      await session.save();
+    } : void 0
   };
-  const rpcContext = Object.defineProperties({}, {
-    ...Object.getOwnPropertyDescriptors(baseContext),
-    ...Object.getOwnPropertyDescriptors(await sessionProperties(context))
-  });
   await hooks?.callHook("storefront:context:created", rpcContext);
   return rpcContext;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.9.0",
+  "version": "8.9.2",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -72,9 +72,9 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.0",
-    "@scayle/storefront-core": "8.6.0",
+    "@scayle/storefront-core": "8.7.0",
     "@scayle/unstorage-compression-driver": "^0.2.3",
-    "@vueuse/core": "12.5.0",
+    "@vueuse/core": "12.6.1",
     "consola": "^3.2.3",
     "core-js": "^3.37.1",
     "defu": "^6.1.4",
@@ -97,7 +97,7 @@
     "@nuxt/test-utils": "3.15.4",
     "@scayle/eslint-config-storefront": "4.4.1",
     "@scayle/eslint-plugin-vue-composable": "0.2.1",
-    "@types/node": "22.13.2",
+    "@types/node": "22.13.4",
     "dprint": "0.49.0",
     "eslint": "9.20.1",
     "eslint-formatter-gitlab": "5.1.0",