@scayle/storefront-nuxt
Version:
Nuxt integration for the SCAYLE Commerce Engine and Storefront API
1,660 lines (1,064 loc) • 96.9 kB
Markdown
# @scayle/storefront-nuxt
## 8.61.2
### Patch Changes
- Improved build-time loading of custom RPC modules when generating the
`#virtual/rpcHttpMethods` manifest so Nuxt string aliases (for example `#shared`) resolve the same way
as in app code during HTTP verb inference.
- Resolved aliases from `@nuxt/kit` `resolvePath` (including virtual templates)
are passed to Jiti together with an app-root parent URL so imports inside `rpcMethods` match dev
behavior.
- If a module still cannot be resolved or imported, those methods continue to default to `POST` with a
logged warning.
- Added dependency `jiti@^2.6.1`
**Dependencies**
**@scayle/storefront-core v8.61.2**
- No changes in this release.
## 8.61.1
### Patch Changes
- Updated to `@scayle/unstorage-compression-driver@1.5.0`.
New optional params option on `CompressionDriverOptions` (and matching third arg on compress/decompress) is forwarded verbatim to the underlying `zlib` call. Brotli encoding now defaults to `BROTLI_PARAM_QUALITY: 6` when no params are supplied, resulting in same compression ratio as the prior implicit quality `11` default at ~300x the encode speed, removing up to several hundred ms of CPU per cold cache write on payloads in the hundreds of KB. Decompression of pre-existing entries is unaffected.
**Dependencies**
**@scayle/storefront-core v8.61.1**
- No changes in this release.
## 8.61.0
### Minor Changes
- **[RPC]** Added HTTP method support so read-only RPCs can use `GET` and unlock CDN and browser caching for public data — no changes needed for existing handlers.
Pass `{ method }` as the second argument to `defineRpcHandler`. Omit it to keep the default `POST`.
```ts
// Safe reads — eligible for CDN / browser caching
export const getNavigation = defineRpcHandler(handler, { method: 'GET' })
// Mutations
export const updateBasketItem = defineRpcHandler(handler, { method: 'PUT' })
export const deleteWishlistItem = defineRpcHandler(handler, {
method: 'DELETE',
})
```
RPCs returning user-specific data (basket, wishlist, tokens) should stay on `POST` to prevent unintended caching.
### Patch Changes
- Updated dependency `@scayle/unstorage-compression-driver@workspace:*` to `@scayle/unstorage-compression-driver@catalog:`
**Dependencies**
**@scayle/storefront-core v8.61.0**
- Minor
- **[RPC]** `defineRpcHandler` now accepts an optional `method` option (`'GET' | 'POST' | 'PUT' | 'DELETE'`) to declare the HTTP method for the handler. Defaults to `'POST'`, so existing handlers behave exactly as before. Updated built-in RPC methods to use `GET` for safe, cacheable reads and `PUT`/`POST`/`DELETE` for mutations, enabling CDN and browser caching for public data fetches.
User- and session-specific RPCs (`getBasket`, `getUser`, `fetchUser`, `getWishlist`, `getAccessToken`, `getCheckoutToken`, `getOrderById`, `getCheckoutDataByCbd`, `getShopUserAddress`) intentionally stay on `POST` so their responses are never eligible for CDN or browser caching.
```ts
import { defineRpcHandler, type RpcContext } from '@scayle/storefront-core'
// Safe, public read — eligible for CDN/browser caching
export const getNavigation = defineRpcHandler(
async (context: RpcContext) => {
/* ... */
},
{ method: 'GET' },
)
// User-specific / Mutation — uses POST to prevent cache leakage
export const getBasket = defineRpcHandler(
async (context: RpcContext) => {
/* ... */
},
// method defaults to 'POST'
)
```
- Patch
- Updated dependency `@scayle/storefront-api@workspace:*` to `@scayle/storefront-api@catalog:`
- Updated dependency `@scayle/unstorage-scayle-kv-driver@workspace:*` to `@scayle/unstorage-scayle-kv-driver@catalog:`
## 8.60.1
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.60.1**
- No changes in this release.
## 8.60.0
### Minor Changes
- All packages now require Node.js 22 or later, in line with the current Node.js LTS release schedule. See the [Node.js release schedule](https://nodejs.org/en/about/previous-releases#release-schedule) for details.
If your project is still running an older Node.js version, now is a good time to upgrade to Node.js 22 at minimum, or ideally Node.js 24, for the latest security patches and stability improvements.
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.60.0**
- Minor
- All packages now require Node.js 22 or later, in line with the current Node.js LTS release schedule. See the [Node.js release schedule](https://nodejs.org/en/about/previous-releases#release-schedule) for details.
If your project is still running an older Node.js version, now is a good time to upgrade to Node.js 22 at minimum, or ideally Node.js 24, for the latest security patches and stability improvements.
## 8.59.7
### Patch Changes
- Updated dependency `@vercel/nft@1.3.1` to `@vercel/nft@1.4.0`
**Dependencies**
- Updated dependency to @scayle/h3-session@0.6.3
- Updated dependency to @scayle/unstorage-compression-driver@1.3.0
**@scayle/storefront-core v8.59.7**
- Patch
- Updated dependency `slugify@^1.6.6` to `slugify@^1.6.8`
## 8.59.6
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.3.0
**@scayle/storefront-core v8.59.6**
- No changes in this release.
## 8.59.5
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.3.0
**@scayle/storefront-core v8.59.5**
- No changes in this release.
## 8.59.4
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.59.4**
- Patch
- Fixed error handling in `oauthRegister` and other OAuth-related RPC methods to properly propagate HTTP status codes like 409 Conflict instead of converting them to 500 Internal Server Error.
The `convertErrorForRpcCall` function now correctly handles `OAuthRequestError` instances that wrap `FetchError` objects. Previously, when OAuth API errors occurred (such as attempting to register with an existing email), the error handling only checked for direct `FetchError` instances, causing wrapped errors to fall through to a generic 500 error response. Now the function extracts the underlying `FetchError` from `OAuthRequestError` instances, ensuring that the correct HTTP status codes are returned to the frontend.
## 8.59.3
### Patch Changes
- Updated dependency `@vercel/nft@1.2.0` to `@vercel/nft@1.3.0`
**Dependencies**
**@scayle/storefront-core v8.59.3**
- No changes in this release.
## 8.59.2
### Patch Changes
- Updated dependency `@vercel/nft@1.2.0` to `@vercel/nft@1.3.0`
**Dependencies**
**@scayle/storefront-core v8.59.2**
- Patch
- Deprecated the `slugify` and `getProductPath` functions in `productHelpers.ts` due to compatibility issues with Nuxt 4.
To maintain compatibility with Nuxt 4, these functions have been deprecated. Developers should migrate to using `useRouteHelpers().slugify()` instead. Additionally, the `slugify` package must be added as a direct dependency in your Storefront Application.
**Migration:**
```ts
import baseSlugify from 'slugify'
const slugify = (url: string | undefined): string => {
return baseSlugify(url ?? '', {
lower: true,
remove: /[*+~.()'"!:@/#?]/g,
})
}
const localePath = useLocalePath()
const getProductDetailRoute = (
id: number,
name?: string,
locale?: Locale,
): string => {
return localePath(
{
name: 'p-productName-id',
params: {
productName: slugify(name),
id: `${id}`,
},
},
locale,
)
}
```
## 8.59.1
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/h3-session@0.6.3
- Updated dependency to @scayle/unstorage-compression-driver@1.2.5
**@scayle/storefront-core v8.59.1**
- Patch
- Fixed import compatibility issue with the `slugify` package in `productHelpers.ts` to support both ESM and CommonJS module formats.
The import was changed from a default import to a namespace import with a fallback, ensuring the `baseSlugify` function works correctly across different module systems and build configurations.
## 8.59.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.5
**@scayle/storefront-core v8.59.0**
- Minor
- Added type exports for similar products functionality by re-exporting `SimilarProductsEndpointParameters` and `SimilarProductsEndpointResponseData` from `@scayle/storefront-api`. These types enable type-safe usage of similar products endpoints throughout the storefront core.
## 8.58.0
### Minor Changes
- Introduced support for Nuxt 4 while maintaining full backward compatibility with Nuxt 3.
This enables consumers to migrate to Nuxt 4 ahead of the Nuxt 3 end of support on 31 Jan 2026.
- **Version Requirements:**
- Nuxt 3: `v3.13.0+`
- Nuxt 4: `v4.2.0+`
**NOTE:** Please be aware that the SCAYLE Storefront Application itself does not yet support Nuxt 4. These package updates are a prerequisite. We recommend remaining on Nuxt 3 for your Storefront implementation until further notice.
See the [Nuxt 4 Migration Guide](https://nuxt.com/docs/4.x/getting-started/upgrade) for general upgrade details.
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.58.0**
- No changes in this release.
## 8.57.3
### Patch Changes
- Updated dependency `@vercel/nft@1.1.1` to `@vercel/nft@1.2.0`
**Dependencies**
**@scayle/storefront-core v8.57.3**
- No changes in this release.
## 8.57.2
### Patch Changes
- Updated dependency `@opentelemetry/api@^1.9.0` to `@opentelemetry/api@catalog:`
- Updated dependency `@scayle/h3-session@0.6.2` to `@scayle/h3-session@workspace:*`
- Updated dependency `consola@^3.2.3` to `consola@catalog:`
- Updated dependency `defu@^6.1.4` to `defu@catalog:`
- Updated dependency `hookable@^5.5.3` to `hookable@catalog:`
- Updated dependency `jose@^6.0.8` to `jose@catalog:`
- Updated dependency `knitwork@^1.1.0` to `knitwork@catalog:`
- Updated dependency `schema-dts@1.1.5` to `schema-dts@catalog:`
- Updated dependency `ufo@^1.5.4` to `ufo@catalog:`
- Updated dependency `uncrypto@^0.1.3` to `uncrypto@catalog:`
- Updated dependency `utility-types@^3.11.0` to `utility-types@catalog:`
- This is an internal change only. The packages now use the PNPM catalog feature to ensure dependencies use the identical version across packages.
**Dependencies**
- Updated dependency to @scayle/h3-session@0.6.3
- Updated dependency to @scayle/unstorage-compression-driver@1.2.5
**@scayle/storefront-core v8.57.2**
- Patch
- Updated dependency `hookable@^5.5.3` to `hookable@catalog:`
- Updated dependency `jose@^6.0.8` to `jose@catalog:`
- Updated dependency `ufo@^1.5.3` to `ufo@catalog:`
- Updated dependency `uncrypto@^0.1.3` to `uncrypto@catalog:`
- Updated dependency `utility-types@^3.11.0` to `utility-types@catalog:`
- This is an internal change only. The packages now use the PNPM catalog feature to ensure dependencies use the identical version across packages.
## 8.57.1
### Patch Changes
- Updated dependency `@vueuse/core@13.9.0` to `@vueuse/core@catalog:`
**Dependencies**
**@scayle/storefront-core v8.57.1**
- No changes in this release.
## 8.57.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.4
**@scayle/storefront-core v8.57.0**
- Minor
- **\[Navigation\]** Exported Navigation V2 API types to provide TypeScript support for the new navigation endpoints.
The following types are now available from `@scayle/storefront-core`:
- `GetNavigationV2Parameters` - Parameters for fetching navigation trees via the V2 API
- `NavigationV2AllEndpointResponseData` - Response type for fetching all navigation trees
- `NavigationV2ByReferenceEndpointResponseData` - Response type for fetching a navigation tree by reference key
These types enable full TypeScript support when working with the Navigation V2 API, which uses reference keys instead of numeric IDs for more flexible navigation management.
## 8.56.0
### Minor Changes
- **\[Session\]** Added support for storing and managing custom data in sessions through the RPC context.
The `RpcContext` now exposes a `sessionCustomData` property to read custom session data and an `updateSessionCustomData` method to update it.
The `sessionCustomData` property may be `undefined` when no session exists or when no custom data has been set.
The `SessionCustomData` interface can be augmented with TypeScript module augmentation to provide type safety for custom session properties.
- **Type Augmentation Example:**
```ts
// types/session.ts
import '@scayle/storefront-nuxt'
declare module '@scayle/storefront-nuxt' {
interface SessionCustomData {
yourCustomDataKey?: string
}
}
```
- **Setting Custom Session Data Example:**
```ts
// server/plugins/session-plugin.ts
import { hasSession } from '@scayle/storefront-nuxt'
import { defineNitroPlugin } from '#imports'
export default defineNitroPlugin((nitroApp) => {
nitroApp.hooks.hook('storefront:afterLogin', async (_data, context) => {
// Check if we actually have a RpcContext with proper session data
if (!hasSession(context)) {
return
}
// Should you have set custom session data already in another hook,
// it might be necessary to get existing data first.
const sessionCustomData = context.sessionCustomData
// The update functions overrides the customData object on a session.
// Should you have set custom session data already in another hooks,
// you need to pass it in addition to your new custom session data.
context.updateSessionCustomData({
...sessionCustomData,
yourCustomDataKey: 'Your Session CustomData Value',
})
// Before accessing your session custom data, you might want to use an
// explicit early return conditional.
if (!sessionCustomData) {
return
}
// Your custom session data can also be accessedd directly via
// nullish coalescing depending on your needs.
console.log(context.sessionCustomData?.yourCustomDataKey)
})
})
```
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.4
**@scayle/storefront-core v8.56.0**
- Minor
- Added support for custom session data in the RPC context type definitions.
The `ContextWithSession` interface now includes a `sessionCustomData` property (which may be `undefined`) to read custom session data and an `updateSessionCustomData` method to update it.
The `ContextWithoutSession` interface has been updated accordingly to maintain type consistency.
The `SessionCustomData` interface can be augmented using TypeScript module augmentation to provide type safety for custom session properties.
## 8.55.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.4
**@scayle/storefront-core v8.55.0**
- Minor
- Updated the type of the `removeItemFromBasket` RPC to accurately reflect that error responses can be returned if removing an item from the basket fails (these error responses were already being returned before; only the type was updated). Additionally, the `clearBasket` RPC now removes items sequentially to avoid conflicts between basket updates and returns an error response if any items in the basket could not be removed.
## 8.54.0
### Patch Changes
- Updated dependency `@vercel/nft@1.0.0` to `@vercel/nft@1.1.1`
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.4
**@scayle/storefront-core v8.54.0**
- Minor
- The `getCheckoutToken` RPC was updated to refresh the access token only when it was about to expire within 30 minutes. This change reduced unnecessary access token generation and minimized the risk of using outdated or revoked tokens.
## 8.53.3
### Patch Changes
- Enhanced data fetching composables to support reactive keys, aligning with [Nuxt 3.17 data fetching improvements](https://nuxt.com/blog/v3-17#data-fetching-improvements).
You can now pass a `ref`, `computed`, or getter function as the `key` parameter to `useRpc` and derived composables (like `useProducts`, `useBrand` etc.). When the reactive key changes, the data will automatically re-fetch.
- **Before:** Keys were static strings.
- **After:** Keys can be reactive, enabling dynamic caching and automatic updates.
```ts
// Before
const { data } = await useRpc('getProduct', 'my-static-product-key', {
productId: 123,
})
// After
const productId = ref(123)
// The key is now reactive. If `productId` changes, the key updates
// to 'product-456' (for example) and triggers a new fetch.
const { data } = await useRpc(
'getProduct',
() => `product-${productId.value}`,
{ productId },
)
```
- Deprecated the `CheckoutEvent` type, which will be removed in the next major version.
This type has been moved to the Storefront Application to better align with application-specific tracking requirements.
If you are currently importing `CheckoutEvent` from `@scayle/storefront-nuxt`, you should migrate to using the type definition from the Storefront Application or define it locally in your codebase.
The type definition remains unchanged, so you can copy it directly:
```ts
import type { ShopUser } from '@scayle/storefront-nuxt'
export interface CheckoutEvent {
/** Action. */
action?: 'authenticated'
/** Type. */
type?: 'tracking'
/** User. */
user: ShopUser
/**
* The OAuth 2.0 access token for the authenticated user.
* This token can be used to access protected resources on behalf of the user.
*
* @see https://www.rfc-editor.org/rfc/rfc6749
*/
accessToken: string
/**
* Details about a specific event within the checkout process.
* This field is optional and is only used when tracking specific actions
* like `add_to_cart` or `remove_from_cart`.
*
* @see https://scayle.dev/en/core-documentation/storefront/checkout-guide/tracking
*/
event?: {
/** Event name. */
event: 'login' | 'add_to_cart' | 'remove_from_cart'
/** Event status. */
status: 'successful' | 'error'
}
}
```
- Updated the `StorefrontRuntimeConfig` type to ensure configured `shops` correctly incorporates all extended properties from `AdditionalShopConfig`.
```ts
declare module '@scayle/storefront-nuxt' {
// Extend the shop config
export interface AdditionalShopConfig {
extendedProp: string
}
}
// `extendedProp` is now properly typed
useRuntimeConfig().storefront.shops?.[shopId]?.extendedProp
```
**Dependencies**
**@scayle/storefront-core v8.53.3**
- No changes in this release.
## 8.53.2
### Patch Changes
- Introduced the `rpcDefaultLazy` configuration flag to streamline data fetching. When enabled via the `NUXT_PUBLIC_STOREFRONT_RPC_DEFAULT_LAZY` environment variable or by setting `rpcDefaultLazy` in your `nuxt.config.ts`, `useRpc` and derived composables like `useProducts` or `useBasket` will behave lazily by default. This eliminates the need to repeatedly pass `{ lazy: true }` in your component logic.
**Examples:**
```ts
// Before (or when `rpcDefaultLazy: false`)
// You had to explicitly opt-in to lazy behavior
const { data } = useRpc('someMethod', { some: 'param' }, { lazy: true })
// After (when `rpcDefaultLazy: true`)
// Lazy behavior is now the default
const { data } = useRpc('someMethod', { some: 'param' })
```
**Dependencies**
**@scayle/storefront-core v8.53.2**
- No changes in this release.
## 8.53.1
### Patch Changes
- Updated dependency `@vercel/nft@0.30.3` to `@vercel/nft@1.0.0`
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.4
**@scayle/storefront-core v8.53.1**
- Patch
- Updated `fetchAllFiltersForCategory`, `getFilters`, `getProductsCount`, and `getProductsByCategory` RPC methods to support `includeSoldOut`, `includeSellableForFree`, and `orFiltersOperator` parameters. These parameters are now correctly passed to the Storefront API client, ensuring consistent filtering behavior.
## 8.53.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.53.0**
- Minor
- Added support for promotions on order items by introducing the `OrderItemPromotion` interface and extending the `OrderItem` type with an optional `promotions` field.
This enables developers to access promotion information (`id`, `name`, and `version`) directly from order items, improving visibility into which promotions were applied to each item in an order.
Additionally, the `appliedReductions` array within the order item price now includes an optional `id` field, allowing for better tracking and identification of specific discount reductions.
For further details, see the [Order API](https://scayle.dev/en/api-guides/storefront-api/resources/orders).
## 8.52.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.3
**@scayle/storefront-core v8.52.0**
- Minor
- Extended the `OrderItem` type to support `'promotion'` as a valid category in `appliedReductions`, enabling proper type checking for promotion-based discounts in order items.
## 8.51.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.51.0**
- Minor
- Added an email hash (`emailHash`) property to the user object returned by the `fetchUser` RPC method.
The `emailHash` property is automatically included in all user objects returned by the RPCs.
The email hash is calculated server-side using SHA256 and is automatically included when a user has an email address.
This can be used e.g., for compliant user tracking and analytics without exposing sensitive email information.
## 8.50.0
### Minor Changes
- Introduced validation for domain configuration when `shopSelector: 'domain'` is enabled. This ensures that any domain-related misconfigurations are detected early during development. The validation requires the use of `@nuxtjs/i18n` and includes the following checks:
- Ensures every shop has a domain property configured
- Verifies that domains configured in the shop config are also present in the `@nuxtjs/i18n` configuration
- Checks that all domains in the i18n configuration are unique (no duplicates)
This validation can be disabled by setting the environment variable `SFC_PLUGIN_DOMAIN_CONFIG_VALIDATION_ENABLED` to `false` when building the application.
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.3
**@scayle/storefront-core v8.50.0**
- No changes in this release.
## 8.49.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.2
**@scayle/storefront-core v8.49.0**
- Minor
- Exported the `sha256` utility function as part of the public API.
This function provides a convenient way to calculate SHA256 hashes of strings using the Web Crypto API, returning hexadecimal strings.
Developers can now use this utility directly instead of implementing their own hashing logic or importing external cryptographic libraries.
Example:
```ts
import { sha256 } from '@scayle/storefront-core'
const hash = await sha256('hello')
console.log(hash) // '2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824'
```
## 8.48.1
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.2
**@scayle/storefront-core v8.48.1**
- Patch
- Export `SmartSortingKey` constant containing all predefined smart sorting keys for intelligent product sorting. Smart sorting keys provide advanced sorting algorithms that consider multiple factors like discounts, inventory levels, sales performance, and recency to optimize product listings.
Available keys:
- `SmartSortingKey.SALES_PUSH` - Promotes items with highest discounts and oldest inventory
- `SmartSortingKey.NEW_ARRIVALS` - Prioritizes recently added products with good availability
- `SmartSortingKey.BALANCED_OFFERINGS` - Balances recency, availability, discounts, and sales data
- `SmartSortingKey.INVENTORY_OPTIMIZATION` - Optimizes inventory turnover for high stock products
- `SmartSortingKey.LUXURY_PROMOTION` - Highlights high-value luxury items with discounts
- `SmartSortingKey.STOCK_COVERAGE` - Ensures broad variant availability across products
- `SmartSortingKey.TOPSELLER` - Prioritizes products with strong sales performance
- `SmartSortingKey.REVENUE_MAX` - Maximizes revenue by prioritizing high revenue products
- `SmartSortingKey.RECENTLY_POPULAR` - Favors products with high recent sales performance
These keys can be used with the `sortingKey` parameter in product queries and are intended to be used with descending sort order to return most relevant results first.
For further information on smart product sorting and how to use smart sorting keys, visit: https://scayle.dev/en/core-documentation/the-basics/products/product-sorting
## 8.48.0
### Minor Changes
- Upgraded to `nuxt@3.20`.
For more details check the [official Nuxt v3.20 release notes](https://github.com/nuxt/nuxt/releases/tag/v3.20.0).
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.48.0**
- No changes in this release.
## 8.47.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.2
- Updated dependency to @scayle/h3-session@0.6.2
**@scayle/storefront-core v8.47.0**
- Minor
- Enhanced basket RPC methods to support order custom data functionality.
All basket RPC methods now integrate with the `getOrderCustomData` RPC method to fetch and include order custom data in SAPI requests.
This enables developers to attach order-specific custom metadata, business rules, or additional context to orders throughout the basket lifecycle.
The existing `orderCustomData` parameter is deprecated and will be removed in the next major version.
For now, both parameters are supported and merged together, where attributes from the parameter take precedence.
On default, this RPC returns an empty object but can be overridden by the developer to return a custom object.
Example `getOrderCustomData` RPC:
```typescript
export const getOrderCustomData: RpcHandler<Record<string, unknown>> =
defineRpcHandler<Record<string, unknown>>(async (context: RpcContext) => {
return {
customer: {
groups: context.user?.groups,
},
}
})
```
For further information, please refer to the [Overriding Core RPC Methods](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/rpc-methods?sourceText=RPC%2520Methods#overriding-core-rpc-methods).
- Updated all basket RPC methods to pass the customer access token to the SAPI client, enabling the `X-Customer-Token` header for promotion validation.
The customer access token is now automatically included in basket requests when available.
If the token has expired, it will be omitted from the request to prevent validation errors.
## 8.46.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.1
**@scayle/storefront-core v8.46.0**
- Minor
- Added `getAttributeValuesByGroupId` function to the `attributeHelpers` helper for retrieving attribute values by their numeric attribute group ID.
This function allows you to retrieve attribute values filtered by a specific attribute group ID, providing a more targeted approach when working with grouped product attributes.
The existing `getAttributeValues` function has been renamed to `getAttributeValuesByName` to better differentiate between the two lookup methods.
### Usage Examples
Both functions return an array of values for consistency, making them safe to use in iterations. For single-select attributes, the value is wrapped in an array. For multi-select attributes, the array is returned directly.
#### Looking up by name (existing, now renamed):
```typescript
import { getAttributeValuesByName } from '@scayle/storefront-core'
// Single-select attribute
const sizes = getAttributeValuesByName(product.attributes, 'size')
// Returns: [{ id: 1, label: 'M', value: 'medium' }]
// Multi-select attribute
const colors = getAttributeValuesByName(product.attributes, 'color')
// Returns: [{ id: 1, label: 'Red' }, { id: 2, label: 'Blue' }]
// Non-existent attribute
const missing = getAttributeValuesByName(product.attributes, 'doesNotExist')
// Returns: []
```
#### Looking up by group ID (new):
```typescript
import { getAttributeValuesByGroupId } from '@scayle/storefront-core'
// Look up attribute by its numeric ID from the SCAYLE API
const promotionValues = getAttributeValuesByGroupId(product.attributes, 42)
// Returns: [{ id: 123, label: 'Summer Sale', value: 'summer-2024' }]
// Non-existent attribute group
const missing = getAttributeValuesByGroupId(product.attributes, 9999)
// Returns: []
```
### When to Use Each Function
- **`getAttributeValuesByName`**: Use when you know the attribute name key (e.g., 'color', 'size'). This is the most common use case in application code.
- **`getAttributeValuesByGroupId`**: Use when you have the numeric attribute group ID from the SCAYLE API, such as when processing API configurations, handling dynamic attribute mappings, or working with attribute group references.
## 8.45.1
### Patch Changes
- Updated dependency `@vercel/nft@0.30.2` to `@vercel/nft@0.30.3`
- Updated SCAYLE Resource Center references
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.1
**@scayle/storefront-core v8.45.1**
- Patch
- Updated SCAYLE Resource Center references
## 8.45.0
### Minor Changes
- The API routes structure was updated for multi-shop environments. The `apiBasePath` option was removed from per-shop configuration but remains configurable at the module level.
NOTE: Update your `nuxt.config.ts` to ensure `routeRules` for `/api/**` uses the manually set `apiBasePath` value to prevent caching issues with session-related RPC's and potentially failing requests!
**Before (per-shop apiBasePath):**
```typescript
// This configuration is no longer supported
runtimeConfig: {
storefront: {
shops: {
1001: {
shopId: 1001,
path: 'de',
apiBasePath: '/custom-api', // ❌ No longer supported
// ... other shop config
},
1002: {
shopId: 1002,
path: 'en',
apiBasePath: '/different-api', // ❌ No longer supported
// ... other shop config
}
}
}
}
```
**After (module-level apiBasePath):**
```typescript
// nuxt.config.ts
export default defineNuxtConfig({
storefront: {
apiBasePath: '/custom-api', // ✅ Configure globally for all shops
},
runtimeConfig: {
storefront: {
shops: {
1001: {
shopId: 1001,
path: 'de',
// ✅ apiBasePath removed from shop config
// ... other shop config
},
1002: {
shopId: 1002,
path: 'en',
// ✅ apiBasePath removed from shop config
// ... other shop config
},
},
},
},
})
```
Additionally, the types for the Storefront module options and Storefront runtime configuration have been cleaned up to properly reflect which settings can be set at runtime and which cannot. This clarifies the distinction between configuration that is static (set at build/module level) and configuration that is dynamic (set at runtime), improving type safety and developer experience.
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.45.0**
- No changes in this release.
## 8.44.2
### Patch Changes
- Updated dependency `@vercel/nft@0.30.1` to `@vercel/nft@0.30.2`
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.1
**@scayle/storefront-core v8.44.2**
- No changes in this release.
## 8.44.1
### Patch Changes
- Use latest `nuxt@3.19.2` for build. Compatibility with previous version has not changed and is specified via package `peerDependencies` and Nuxt `compatibility` flag.
**Dependencies**
**@scayle/storefront-core v8.44.1**
- No changes in this release.
## 8.44.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.1
**@scayle/storefront-core v8.44.0**
- Minor
- Export `unwrap`, `generateBasketKey`, `generateWishlistKey` and `UnstorageCache`.
## 8.43.4
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.43.4**
- No changes in this release.
## 8.43.3
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.0
**@scayle/storefront-core v8.43.3**
- No changes in this release.
## 8.43.2
### Patch Changes
- Updated dependency `@vueuse/core@13.8.0` to `@vueuse/core@13.9.0`
**Dependencies**
**@scayle/storefront-core v8.43.2**
- No changes in this release.
## 8.43.1
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.43.1**
- No changes in this release.
## 8.43.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.2.0
**@scayle/storefront-core v8.43.0**
- Minor
- Added an export of the new promotion type `ComboDealEffect`
This type is also included in the `PromotionEffectType` type and can be used to check if the promotion is of type `ComboDealEffect`.
Example:
```ts
const isComboDealType = (
promotion?: Promotion | null,
): promotion is Promotion<ComboDealEffect> => {
return promotion?.effect?.type === PromotionEffectType.COMBO_DEAL
}
```
## 8.42.2
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.42.2**
- No changes in this release.
## 8.42.1
### Patch Changes
- Updated dependency `@vueuse/core@13.7.0` to `@vueuse/core@13.8.0`
**Dependencies**
**@scayle/storefront-core v8.42.1**
- Patch
- Increased the default cache timeout to 1000ms to reduce cases of prematurely skipping the cache.
## 8.42.0
### Minor Changes
- Added `promotions` field to `BasketItem` type to support multiple promotions per basket item.
The `promotions` field is an array of `BasketItemPromotion` objects.
With the introduction of the new `promotions` array field, the `promotion` field is now deprecated.
Before:
```json
"promotion": {
"id": "123",
"name": "Promotion 1",
"isActive": true,
}
```
After:
```json
"promotions": [{
"id": "123",
"name": "Promotion 1",
"isActive": true,
}]
```
For more details, see the [Storefront API documentation](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/get-a-basket).
- Updated the parameters of the RPC functions `updateBasketItemRpc` and `updateBasketItem` with the new `promotions` attribute.
This attribute is used to support multiple promotions on basket items.
Before:
```ts
const updateBasketItemRpc = useRpcCall('updateBasketItem')
const addItemToBasketRpc = useRpcCall('addItemToBasket')
updateBasketItemRpc({
// ...
promotionId: 'promotionId',
promotionCode: 'promotionCode',
})
addItemToBasketRpc({
// ...
promotionId: 'promotionId',
promotionCode: 'promotionCode',
})
// Or with useBasket composable
const { addItem } = useBasket()
addItem({
// ...
promotionId: 'promotionId',
})
```
After:
```ts
const updateBasketItemRpc = useRpcCall('updateBasketItem')
const addItemToBasketRpc = useRpcCall('addItemToBasket')
updateBasketItemRpc({
// ...
promotions: [
{ id: 'promotionId', code: 'promotionCode' },
{
id: 'promotionId2',
},
],
})
addItemToBasketRpc({
// ...
promotions: [
{ id: 'promotionId', code: 'promotionCode' },
{
id: 'promotionId2',
},
],
})
// Or for useBasket with composable
const { addItem } = useBasket()
addItem({
// ...
promotions: [
{ id: 'promotionId', code: 'promotionCode' },
{
id: 'promotionId2',
},
],
})
```
For more details, see the [Add a variant](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/add-a-variant) and [Update an item](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/update-an-item) guides.
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.42.0**
- Minor
- Added `promotions` field to `BasketItem` type to support multiple promotions per basket item.
The `promotions` field is an array of `BasketItemPromotion` objects.
With the introduction of the new `promotions` array field, the `promotion` field is now deprecated.
Before:
```json
"promotion": {
"id": "123",
"name": "Promotion 1",
"isActive": true,
}
```
After:
```json
"promotions": [{
"id": "123",
"name": "Promotion 1",
"isActive": true,
}]
```
For more details, see the [Storefront API documentation](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/get-a-basket).
## 8.41.4
### Patch Changes
- Updated dependency `@vercel/nft@0.30.0` to `@vercel/nft@0.30.1`
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.1.0
**@scayle/storefront-core v8.41.4**
- No changes in this release.
## 8.41.3
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.2
**@scayle/storefront-core v8.41.3**
- Patch
- Fixed the case where a `postLogin` function was inadvertently registered as an RPC method.
## 8.41.2
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.41.2**
- No changes in this release.
## 8.41.1
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.41.1**
- Patch
- Improved logging around cache errors to provide more details.
## 8.41.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.41.0**
- Minor
- Introduce a new `updatePromotions` RPC method to wrap the Storefront API "Bulk update promotions" endpoint.
This allows to update all promotions applied to basket's items in a single API call.
For more details, see the [Storefront API documentation](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/bulk-update-promotions).
## 8.40.0
### Minor Changes
- Deprecated `relativeReductions` in `useProductPrice` in favor of `appliedReductions`.
Previously, `relativeReductions` did not return absolute reductions in the correct format.
The new `appliedReductions` property returns all reductions as raw values, leaving formatting responsibilities to the component.
Before:
```html
<template>
<span v-for="({ value, category }, index) in relativeReductions">
-{{ value }}%
</span>
</template>
<script setup lang="ts">
const { relativeReductions } = useProductPrice(price)
</script>
```
After:
```html
<template>
<span v-for="({ amount, category, type }, index) in appliedReductions">
-{{ type === 'relative' ? `${formatPercentage(amount.relative)}` :
`${formatCurrency(amount.absoluteWithTax)}` }}
</span>
</template>
<script setup lang="ts">
const { appliedReductions } = useProductPrice(price)
</script>
```
### Patch Changes
- Updated dependency `@vueuse/core@13.6.0` to `@vueuse/core@13.7.0`
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.1
**@scayle/storefront-core v8.40.0**
- No changes in this release.
## 8.39.1
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.1
**@scayle/storefront-core v8.39.1**
- Patch
- Added `'token'` and `'code'` to the list of default `blacklistedKeys`. This will more proactively redact server logs to prevent leaked data.
## 8.39.0
### Minor Changes
- [OTEL] When recording span exceptions, also include the `error.cause` if it exists.
### Patch Changes
- Updated dependency `@vercel/nft@0.29.4` to `@vercel/nft@0.30.0`
**Dependencies**
**@scayle/storefront-core v8.39.0**
- Patch
- Use a custom error type for OAuth API errors to improve troubleshooting OAuth errors.
## 8.38.4
### Patch Changes
- Updated dependency `@vueuse/core@13.5.0` to `@vueuse/core@13.6.0`
**Dependencies**
**@scayle/storefront-core v8.38.4**
- No changes in this release.
## 8.38.3
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.38.3**
- Patch
- Refactored internals of `getOrderDataByCbd`. This change has no noticable impact.
## 8.38.2
### Patch Changes
- Fixed a compatibility issue with the Nuxt 4 directory structure where the `rpcDir` was not resolved correctly.
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.1
**@scayle/storefront-core v8.38.2**
- No changes in this release.
## 8.38.1
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.1
**@scayle/storefront-core v8.38.1**
- Patch
- Resolved an issue where `Pagination` was not exported correctly as a `type`.
## 8.38.0
### Minor Changes
- Refined the `ContextWithoutSession` type to accurately represent actual data: `wishlistKey`, `basketKey`, and `sessionId` are now typed as `string` instead of `undefined`, since even logged-out users have these values set.
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.38.0**
- Minor
- Refined the `ContextWithoutSession` type to accurately represent actual data: `wishlistKey`, `basketKey`, and `sessionId` are now typed as `string` instead of `undefined`, since even logged-out users have these values set.
- Made `getCheckoutToken` callable by logged-in and not logged-in users. When called by a not logged-in user, the RPC returns only the `checkoutJWT`. For logged-in users, it continues to return both the `checkoutJWT` and a refreshed `accessToken` as before.
## 8.37.0
### Minor Changes
- Created the composable `useCampaign` which uses the RPC `getCampaign` to fetch the first active campaign
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.37.0**
- Minor
- The `where` parameter for the `getProductsByCategory` and `getProductsCount` RPCs was extended to include the previously missing options `sellableAt`, `hasCampaignReduction`, and `containsSearch`.
- Patch
- Added missing export of the RPC `getCampaign`
## 8.36.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.36.0**
- Minor
- Created a new RPC method `getCampaign` to retrieve the first active campaign.
More details can be found in the official SCAYLE Resource Center under [API Guides / Storefront API / Campaigns / List Campaigns](https://scayle.dev/en/api-guides/storefront-api/resources/campaigns/list-campaigns).
## 8.35.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.35.0**
- Minor
- Removed optional key `fbook` from `ShopUser` interface
- Renamed incorrectly formatted function `getBackurlFromBreadcrumbs` to `getBackURLFromBreadcrumbs`
- Patch
- Renamed interface incorrectly named `IdenfitierFilterItemWithValues` to `IdentifierFilterItemWithValues`
## 8.34.1
### Patch Changes
- Updated dependency `zod@^3.23.8` to `zod@^4.0.0`
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.0
**@scayle/storefront-core v8.34.1**
- No changes in this release.
## 8.34.0
### Patch Changes
**Dependencies**
- Updated dependency to @scayle/unstorage-compression-driver@1.0.0
**@scayle/storefront-core v8.34.0**
- Minor
- Added export of `Pagination` type.
- **Breaking:** Improved type safety of the `mergeBaskets` RPC method. The method now returns the correct type `Promise<BasketResponse<Product, Variant> | AddManyItemsBasketResponse<Product, Variant> | undefined>` instead of `any`.
## 8.33.2
### Patch Changes
- Updated dependency `@scayle/storefront-core@8.32.0` to `@scayle/storefront-core@workspace:*`
- Updated dependency `@scayle/unstorage-compression-driver@^1.0.0` to `@scayle/unstorage-compression-driver@workspace:*`
- Updated dependency `@vueuse/core@13.4.0` to `@vueuse/core@13.5.0`
**Dependencies**
**@scayle/storefront-core v8.33.2**
- Patch
- Updated dependency `@scayle/storefront-api@18.9.0` to `@scayle/storefront-api@workspace:*`
- Updated dependency `@scayle/unstorage-scayle-kv-driver@1.0.2` to `@scayle/unstorage-scayle-kv-driver@workspace:*`
## 8.33.1
### Patch Changes
- Updated dependency `@scayle/storefront-core@8.32.0` to `@scayle/storefront-core@workspace:*`
- Updated dependency `@scayle/unstorage-compression-driver@^1.0.0` to `@scayle/unstorage-compression-driver@workspace:*`
- Updated dependency `@vueuse/core@13.4.0` to `@vueuse/core@13.5.0`
**Dependencies**
**@scayle/storefront-core v8.33.1**
- Patch
- Updated dependency `@scayle/storefront-api@18.9.0` to `@scayle/storefront-api@workspace:*`
- Updated dependency `@scayle/unstorage-scayle-kv-driver@1.0.2` to `@scayle/unstorage-scayle-kv-driver@workspace:*`
## 8.33.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.33.0**
- Minor
- Added test factories for order and all related types.
It is now possible to build orders with factory functions for testing purposes.
This will reduce the amount of boilerplate code needed to create test data.
## 8.32.1
### Patch Changes
- Updated dependency `@scayle/storefront-core@8.31.0` to `@scayle/storefront-core@8.32.0`
**Dependencies**
**@scayle/storefront-core v8.32.1**
- No changes in this release.
## 8.32.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.32.0**
- Minor
- Added `minReduction` and `maxReduction` filter parameters to the `FetchProductsCountParams.where` type and updated the `getProductsCount` RPC method to accept and handle these new reduction-based filtering conditions.
- Patch
- Fixed the `getFilters` RPC method to properly apply `minReduction` and `maxReduction` filter parameters when fetching product counts.
## 8.31.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.31.0**
- Minor
- Added `minReduction` and `maxReduction` filter parameters to `FetchProductsByCategoryParams.where` and `FetchFiltersParams.where` types, and updated the `getProductsByCategory` and `getFilters` RPC methods to accept and handle these new reduction-based filtering conditions.
```ts
const { data } = useRpc('getFilters', 'getFiltersKey', () => ({
where: {
minReduction: 10,
maxReduction: 20,
},
}))
const { data } = useRpc(
'getProductsByCategory',
'getProductsByCategoryKey',
() => ({
where: {
minReduction: 10,
maxReduction: 20,
},
}),
)
```
## 8.30.3
### Patch Changes
- Updated dependency `@vueuse/core@13.3.0` to `@vueuse/core@13.4.0`
**Dependencies**
**@scayle/storefront-core v8.30.3**
- No changes in this release.
## 8.30.2
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.30.2**
- Patch
- Fixed an incorrect internal import for category related RPC methods. This should resolve potential type issues.
## 8.30.1
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.30.1**
- No changes in this release.
## 8.30.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.30.0**
- Minor
- Added `defineRpcHandler` utility function that enhances RPC handlers with type-safe metadata for improved registration and invocation of RPC handlers. While defining RPC handlers without this utility remains supported, its usage is recommended and may become mandatory in a future major release.
Existing RPC handlers can be easily migrated to use `defineRpcHandler` by passing the existing handler to `defineRpcHandler`.
```ts
export const existingHandlerWithoutParams = async (_context: RpcContext) => {
return 'existing handler'
}
export const existingHandlerWithParams = async (
{ name }: { name: string },
_context: RpcContext,
) => {
return name
}
// will become
export const existingHandlerWithoutParams = defineRpcHandler(
async (_context: RpcContext) => {
return 'existing handler'
},
)
export const existingHandlerWithParams = defineRpcHandler(
async ({ name }: { name: string }, _context: RpcContext) => {
return name
},
)
```
- Patch
- Removed unused `Awaited` and `PromiseReturnType` types.
## 8.29.0
### Patch Changes
**Dependencies**
**@scayle/storefront-core v8.29.0**
- Minor
- Added an `includeProductSorting` boolean parameter to all category RPC method endpoints (`getRootCategories`, `getCategoryByPath`, `getCategoriesByPath`, `getCategoryById`, `getCategoryTree`).
This flag allows consumers to retrieve product sorting data, including the `smartSortingKey` and `customSortingKey` properties.
Developers can leverage this data to seamlessly apply smart sorting keys on the product listing page by passing those parameters when fetching products.
- Added an optional `hideEmptyCategories` parameter to `getCategoryTree`. When enabled, the product count for each category is retrieved, and categories (including their children) without any products are removed. Enabling this option may increase response times, especially for large category trees.
```ts
import { rpcMethods } from '@scayle/storefront-core'
rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext)
```
or
```ts
import { useCategoryTree } from '#storefront/composables