@scayle/storefront-core

Update getUniqueItemsFromOrder and getItemQuantityFromOrder to accept order Product and Variant generics to ensure correct types. Moreover, both methods are deprecated as they should be handled within Storefront project itself.

8.14.0

Minor Changes

Expose PackageDeliveryStatus type. This new type clearly defines the allowed values for a package's delivery status. This improves code clarity and helps prevent typos. It's used to replace the inline string literal types in the ListOfPackages type.
Refactor the Order and OrderItem interfaces to be generic, allowing them to accept custom Product and Variant types. This allows to strongly type the product and variant data within orders and order items, leading to better type checking and potentially fewer runtime errors. This allows for compile-time checks and autocompletion when working with product and variant properties of OrderItem and items property of Order.

8.13.0

Minor Changes

Expose OrderStatus and OrderItem interfaces from order types.
Enhance the OrderSummary component by integrating the OrderStatus type from the order Order interface. This update provides a more accurate and detailed representation of the order status for users.
Enhance order detailedStatus code type for billing, order and shipping properties and expose OrderStatusCode, BillingStatusCode and ShippingStatusCode.

Patch Changes

Added fishery@>=2.2.3 as peerDependencies.

8.12.3

Patch Changes

Fix typo introduced in 8.12.2.

8.12.2

Patch Changes

Use CentAmount in the Order type to avoid nominal type errors.

8.12.1

Patch Changes

Dependencies

Updated dependency to @scayle/unstorage-scayle-kv-driver@0.1.1

8.12.0

Minor Changes

Expose CategoryFilter from storefront-core.

8.11.3

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@18.1.0

8.11.2

Patch Changes

Updated dependency jose@^5.6.3 to jose@^6.0.8

8.11.1

Patch Changes

Added dependency @scayle/unstorage-scayle-kv-driver@0.0.1

Dependencies

Updated dependency to @scayle/unstorage-scayle-kv-driver@0.1.0

8.11.0

Minor Changes

Remove check in getOrderById RPC whether an order exists in context.user.orderSummary. The order summary defaults to including only the 50 most recent entries. This fix ensures orders beyond this limit can be accessed.

8.10.0

Minor Changes

Simplified exported Order interface by relying directly on primitive types instead of having multiple intermediate types that resolve to primitives.
The following formerly exported intermediate types have been replaces by primitive types:
- resolving to string now
  - TimestampOfOrderConfirmation
  - CharacterCurrencyCode
  - UniqueIdentifierOfTheState
  - NameOfTheState
  - UniqueIdentifierOfTheState1
  - NameOfTheState1
  - UniqueIdentifierOfTheState2
  - NameOfTheState2
  - TimestampOfOrderInvoice
  - CharacterCurrencyCode1
  - UniqueIdentifierOfTheItem
  - TimestampOfItemCreation
  - TimestampOfLastItemUpdate
  - CarrierShippingTheItem
  - LatestExpectedDeliveryDate
  - EarliestExpectedDeliveryDate
  - ShipmentKeyOfTheItem
  - TimestampOfOrderCreation
  - TimestampOfLastOrderUpdate
- resolving to number now
  - ThisFieldRepresentsTheAdditionalFeesExcludingTheTaxes
  - ThisFieldRepresentsTheAdditionalFeesIncludingTheTaxes
  - TheIncludedVATAmount
  - TheIncludedVATRateInPercentAsIntegerRepresentation
  - ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes
  - AbsoluteValueOfTheAppliedTax
  - UniqueNumericIdentifierOfTheItem
  - AvailableQuantityInTheWarehouse
  - ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1
  - AbsoluteValueOfTheAppliedTax1
  - RelativeValueOfTheAppliedTax
  - UndiscountedItemPriceExcludingTaxes
  - UndiscountedItemPriceIncludingTaxes
  - ItemPriceExcludingTaxes1
  - ItemPriceIncludingTaxes1
  - ReferenceByWhichThePackageIsIdentified
  - ItemPriceExcludingTaxes
  - ItemPriceIncludingTaxes
  - NumberOfInstallmentsChosenByTheCustomerForTheOrder
- resolving to boolean now
  - TheReturnShipmentHasBeenTriggeredByCCI
  - WhetherThePaymentMethodIsAGiftCard
  - IfTrueTheCustomerElectedToHaveADelayInPaymentCapture
- resolving to null | number now
  - PickingWarehouseId
  - WarehousePackageReference
- resolving to null | string now
  - ReturnIdentCodeOfTheItem
The interface ThisFieldHoldsDetailsAboutTheIncludedVATTax has been removed and amount: number and rate: number have been directly specified under Order.cost.appliedFees.tax.vat: {amount: number, rate: number}. Additionally we have introduce the types OrderAddressRecipientGender and OrderAddressRecipientType, as well as the interfaces OrderAddress and OrderForwardingAddress.

8.9.0

Minor Changes

Extend RpcContext with an rpcCall property. This is a utility function that can be used within RPC methods to invoke another RPC method.

8.8.0

Minor Changes

Deprecate RpcContext.campaignKey. The getCampaignKey RPC should be used instead.

To get the default campaign key, you can call the RPC method:

// Before
async function rpcMethod(context) {
  const campaignKey = { context }
  // ...
}
// After
async function rpcMethod(context) {
  const campaignKey = await context.callRpc?.('getCampaignKey')
  // ...
}

To override the default campaign key, override the getCampaignKey RPC with your own implementation. See Overriding core RPC Methods for more.

8.7.1

Patch Changes

Introduced JSDoc comments to provide additional contextual descriptions and hints.

8.7.0

Minor Changes

[Testing] Create and expose externally userFactory

Patch Changes

The domain property on RpcContext is optional

8.6.1

Patch Changes

Remove duplicated export of PromotionEffectType. It was previously defined within @scayle/storefront-core and reexported from @scayle/storefront-api. Now only the the object literal and type from @scayle/storefront-api are exported.

8.6.0

Minor Changes

Reexport ExistingItemHandling,AddToBasketFailureKind,UpdateBasketItemFailureKind,AddToWishlistFailureKind,PromotionEffectType and FilterTypes from @scayle/storefront-api, instead of redefining them in @scayle/storefront-core
Remove package.json and server exports.
The CommonJS export format will be removed in this version. All exports are provided through ES Modules (import/export) exclusively
This change will primarily affect users who are currently using the CommonJS format of this package. To update your code, you should replace require statements with import statements and update your build tooling if necessary.
```
const { ... } = require('@scayle/storefront-core')

// will become

import { ... } from '@scayle/storefront-core'
```

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@18.0.0

8.5.0

Minor Changes

The CommonJS export format will be removed in this version. All exports are provided through ES Modules (import/export) exclusively
This change will primarily affect users who are currently using the CommonJS format of this package. To update your code, you should replace require statements with import statements and update your build tooling if necessary.
```
const { ... } = require('@scayle/storefront-core')

// will become

import { ... } from '@scayle/storefront-core'
```

8.4.0

Minor Changes

Types - Extend Gender type with n option

8.3.2

Patch Changes

Types: Explicitly type the return of resolveSearch

8.3.1

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@17.18.0

8.3.0

Minor Changes

Basket Add support to update existing basket items using the updateBasketItem RPC.

8.2.2

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@17.17.0

8.2.1

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@17.16.0

8.2.0

Minor Changes

Performance Remove the 'autobinding' of the methods on the Cached instance. Instead the execute method only is bound when constructing the RpcContext. This simplifies the code and improves the performance of the bootstrap function. This change is internal to storefront-core and the API of RpcContext is unchanged.

8.1.5

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@17.15.0

8.1.4

Patch Changes

Fixed misspelling of interface BasketItemDisplayDataItem to BasketItemDisplayDataItem

Dependencies

Updated dependency to @scayle/storefront-api@17.14.1

8.1.3

Patch Changes

Dependencies

Updated dependency to @scayle/storefront-api@17.14.0

8.1.2

Patch Changes

RPC Methods: When propagating the status code from a SAPI error, only include the statusCode and statusText. Previously the headers and body were included as well which could cause content decoding issues.

8.1.1

Patch Changes

Make the sort parameter optional for the FetchProductsByCategoryParams

8.1.0

Minor Changes

RPC Methods: Propagate SAPI response codes through RPC methods. This addresses an issue introduced in Storefront Core v8 where specific status codes were incorrectly reported as generic 500 errors. The following RPC methods are impacted:
- getBrands
- getBrandById
- getCategoryByPath
- getCategoryById
- getProductById
- getProductsByIds
- getProductsByReferenceKeys
- getPromotions
- getCurrentPromotions
- getPromotionsByIds
- getSearchSuggestions
- getShopConfiguration
- getVariantById
- getWishlist
- removeItemFromWishlist

8.0.0

Major Changes

[💥 BREAKING] The getBadgeLabel helper function has been removed, giving you more control over badge label display.

Note: This change doesn't affect projects using SCAYLE Storefront Boilerplate v1.0 or later.

For applications based on older versions or using getBadgeLabel, you can refer to the previous implementation below:

const BadgeLabel = {
  NEW: 'new',
  SOLD_OUT: 'sold_out',
  ONLINE_EXCLUSIVE: 'online_exclusive',
  SUSTAINABLE: 'sustainable',
  PREMIUM: 'premium',
  DEFAULT: '',
} as const

type BadgeLabelParamsKeys =
  | 'isNew'
  | 'isSoldOut'
  | 'isOnlineOnly'
  | 'isSustainable'
  | 'isPremium'
type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>

const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
  if (!params) {
    return BadgeLabel.DEFAULT
  }
  const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
    params

  if (isNew) {
    return BadgeLabel.NEW
  } else if (isSoldOut) {
    return BadgeLabel.SOLD_OUT
  } else if (isOnlineOnly) {
    return BadgeLabel.ONLINE_EXCLUSIVE
  } else if (isSustainable) {
    return BadgeLabel.SUSTAINABLE
  } else if (isPremium) {
    return BadgeLabel.PREMIUM
  } else {
    return BadgeLabel.DEFAULT
  }
}

[💥 BREAKING] We've standardized our configuration to use sapi (Storefront API) throughout the codebase, replacing the deprecated bapi keyword. This change improves clarity and consistency by removing the initBapi function, replacing the bapiClient property with sapiClient within the RPCContext, and updating all code references accordingly. BapiConfig is not exported anymore and has been superseded by SapiConfig.
- NOTE: These changes impact your environment variables used for deployments. Please check your infrastructure and deployment setup and adapt accordingly!
- Previous bapi Configuration in nuxt.config.ts
  export default { // ... runtimeConfig: { // ... storefront: { // ... bapi: { host: '...', token: '...', }, // ... }, // ... }, // ... }
- Legacy Environment Variables:
  NUXT_STOREFRONT_BAPI_HOST='...' NUXT_STOREFRONT_BAPI_TOKEN='...'
- Current sapi Configuration in nuxt.config.ts
  export default { // ... runtimeConfig: { // ... storefront: { // ... sapi: { host: '...', token: '...', }, // ... }, // ... }, // ... }
- New Environment Variables:
  NUXT_STOREFRONT_SAPI_HOST='...' NUXT_STOREFRONT_SAPI_TOKEN='...'
[💥 BREAKING] We've streamlined cache management by replacing the outdated AY_CACHE_DISABLED environment variable. Now, you can effortlessly control caching using either the NUXT_STOREFRONT_CACHE_ENABLED environment variable or the storefront.cache.enabled option within your nuxt.config.ts file, providing a more user-friendly experience.
[💥 BREAKING] This release removes the RedisCache provider. We now use UnstorageCache which also supports Redis as a backing store.
[💥 BREAKING] To improve security and streamline token management, we've updated how you access user accessToken. Instead of directly accessing the storefrontAccessToken field on the UserAuthentication interface, you'll now use the dedicated getAccessToken RPC. This change ensures a more secure and controlled method for handling sensitive user data within your application.
- Previous Usage of user.authentication.storefrontAccessToken:
  const { data, fetching, fetch, error, status } = useUser( 'getUser', // ... ) data.value.user.authentication.storefrontAccessToken
- Current Usage of dedicated getAccessToken RPC method:
  const { data: accessToken } = useRpc( 'getAccessToken', // ... )

[💥 BREAKING] We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.

Overriding default hashAlgorithm in nuxt.config.ts:

export default defineNuxtConfig({
  // ...
  runtimeConfig: {
    // ...
    storefront: {
      // ...
      appKeys: {
        // ...
        hashAlgorithm: HashAlgorithm.MD5, // HashAlgorithm.SHA256
      },
      // ...
    },
    // ...
  },
  // ...
})

[💥 BREAKING] The attribute loginShopId is removed from the ShopUser interface as the shop now uses session cookies.
[💥 BREAKING] We're streamlining the search experience as we transition to SCAYLE Search v2, focusing on a category-centric approach. To achieve this, we're consolidating search functionality. This means we're replacing the searchProducts RPC method with getSearchSuggestions, which provides both product suggestions (triggered by product IDs) and category suggestions (triggered by category-like terms, leading to filtered category pages).
- Previous Usage of searchProducts RPC method:
  const getSearchSuggestionsRpc = useRpcCall('searchProducts') data.value = await searchProducts({ term: String(searchQuery.value), ...params, })
- Current Usage of getSearchSuggestions RPC method:
  const getSearchSuggestionsRpc = useRpcCall('getSearchSuggestions') data.value = await getSearchSuggestionsRpc({ term: String(searchQuery.value), ...params, })
[💥 BREAKING] Improved basket updating: Adding an item to your basket with a reduced quantity will now correctly update the basket contents.
[💥 BREAKING] The methods getBasket, removeItemFromBasket, addItemsToBasket, and addItemToBasket have been updated. Instead of returning the basket object directly, the basket will now be accessible as a property within the response body. Furthermore, errors occurring duringaddItemToBasket and addItemsToBasket will from now on return HTTP 400. The error kind can be identified by checking the error property of the response.

Patch Changes

Default forceTokenRefresh to false when no payload is passed to getAccessToken