CHANGELOG.md

@scayle/storefront-api

17.4.1

Patch Changes

• Fix a bug when including both hidden and specific category properties on the products endpoint

17.4.0

Minor Changes

• Improve filter types to represent the behavior from the API accurately.

17.3.0

Minor Changes

• Refactor Wishlist implementation
  • WishlistResponseData export is now deprecated, please use the new Wishlist import
  • Removed masterKey from AddWishlistItemParameters parameters
  • Added itemGroup support to the wishlist
  • Added separated WishlistWith type
  • Added WishlistItemCustomData to allow for extension of custom data on wishlists

17.2.0

Minor Changes

• Adds support for boolean filters in the Search V2 endpoints

  Example (shortened for readability):

  {
    "type": "category",
    "categorySuggestion": {
      "category": {
        "id": 1,
        "path": "/women/jackets",
        "name": "Jacke"
      },
      "filters": [
        {
          "type": "boolean",
          "booleanFilter": {
            "slug": "sale",
            "value": true,
            "label": "sale"
          }
        }
      ]
    }
  }

• Removes the considerItemGroupForUniqueness option from the StorefrontAPIClient.addOrUpdateItems.

  This behavior is now enabled by default that we consider the item group when checking for existing basket items.

17.1.0

Minor Changes

• Improve ShopConfiguration endpoint and typings

  We now also export a ShopCustomData and ShopCountryCustomData type that can be used to define your custom data by augmenting the TypeScript type definition of @scayle/storefront-api like follows:

  declare module '@scayle/storefront-api' {
    interface ShopCountryCustomData {
      isEnabled: boolean
    }
  }

17.0.1

Patch Changes

• Add missing BuyXGetYEffect and AutomaticDiscountEffect exports

17.0.0

Major Changes

• • Rename BapiClient to StorefrontAPIClient
  • Rename BapiAuthentication to StorefrontAPIAuth
  • Drop support for basic authentication
  • Drop support for header shop id placement We recommend sticking with basic query parameters, which are usually safer and easier to use. In the past, we have seen issues with headers and caching layers, which need to be specifically instrumented to consider the header.
  • The host parameter provided to the StorefrontAPIClient should now be the URL host (example: {{tenant-space}}.storefront.api.scayle.cloud) The old format of https://{{tenant-space}}.storefront.api.scayle.clou/v1/ is still supported
  • Removed all Bapi namings from types These include: BapiPrice, BapiProduct, BapiProductCategory and BapiCategory
  • Drop the ModeledBapiClient
  • Updated the build system The package is now bundled into a single file, disallowing import from internally compiled files. All imports must import the main module from @scayle/storefront-api. We have also increased the build target to ES2018.

16.3.0

Minor Changes

• Add orFiltersOperator support to filter values endpoint

16.2.2

Patch Changes

• Add orFiltersOperator support to filter values endpoint

16.2.1

Patch Changes

• Resolved an issue where the instanceof check for FetchError always incorrectly returned false, by upgrading the compilation target from ES5 to ES2015.

  This resulted in 404 errors on the redirects endpoint being treated as errors.

16.2.0

Minor Changes

• Add filters to CategorySearchSuggestion

16.1.2

Patch Changes

• remove inline sourcemaps

16.1.0

• Add support for Search V2 Endpoints

16.0.2

• Fixed a bug when brands.getBySlug method was returning brand by id if numeric value was given

16.0.0

• Switch from axios to fetch

15.14.3

• Add priority field to promotion response

15.14.2

• Export Promotion Condition types

15.14.1

• Export types

15.14.0

• Add promotions integration for Basket Endpoints

15.13.0

• Added new /v1/promotions endpoints

15.12.1

• Bring back the vouchers

15.12.0

• Add support for Promotion IDs in Basket Endpoints

15.11.0

• Don't include tests in NPM package

15.10.0

• Add name field to NavigationItem

15.9.0

• Add filters:not support on products and filters endpoint
• Add support for categories.countryLevelCustomData and categories.shopLevelCustomData

15.8.0

• Add categoryId support for /search/resolve

15.7.0

• Add support for orFiltersOperator on the /filters and /products endpoints
• Remove empty ?with= parameter on the /filters endpoint
• Remove type restrictions on AttributeKey

15.6.0

• Expose status codes in multi basket operations

15.4.0

• Expose status codes in basket responses

15.3.0

• Moved Github repository to new Scayle Org

15.2.0

• Allow a new filter filters[hasCampaignReduction] on the /filters and /products endpoints

15.1.0

• Adds supported request parameters to navigation endpoints

15.0.0

• Updates navigation response to reflect the new structure

14.3.0

• Adds ?includeSellableForFree parameter for filters API call

14.2.0

• Refactor Extract typings for better import handling

14.1.0

• Implements redirects.get method
• Implements redirects.match method -> method will return either a matched redirect or undefined if the redirect is matched

14.0.0

• extraFilters on NavigationItemCategory are now correctly typed as number[] instead of boolean

13.18.0

• Add support for itemGroup on basket endpoints

13.17.0

• Add includeSoldOut on filters endpoint

13.16.0

• Allows querying products with reductionRange

13.13.0

• Fix Basket Item Status
• Add includeItemsWithoutProductData option for basket endpoints

13.12.0

• Add 409 and 413 wishlist response status codes

13.11.1

• Returns merchantId information on product variant level

13.11.0

• Allows querying products with searchCategoryIds

13.10.3

• Allows querying products and variants with lowestPriorPrice

13.10.2

• Allows querying products based on minimum and max reduction
• Allows querying products with baseCategories

13.9.0

• Expose /campaigns API as BapiClient.campaigns.get
• Expose /campaigns/{campaignId} API as BapiClient.campaigns.getById
• Expose /navigation/trees API as BapiClient.navigation.getAll
• Expose /navigation/trees/{navigationTreeId} API as BapiClient.navigation.getById

13.8.0

• Allow arbitrary campaign keys

13.7.1

• Ignore displayData on BapiClient.addOrUpdateItems when strategy ExistingItemHandling.AddQuantityToExisting is used
  • Reason: The underlying API does not support updating display data of existing items, only the custom data

13.7.0

• Support parameters containsSearch and disableFuzziness for product searches

13.6.0

• BapiClient.basket.updateItem (and its usage through BapiClient.basket.addOrUpdateItems) now supports updating the customData as well as the pricePromotionKey
  • Beware that setting either of these entirely replaces any previous customData the item may have had

13.5.0

• Expose /search/resolve API as BapiClient.search.resolve

13.4.0

• Add getByReferenceKey, which uses a faster implementation than getByReferenceKeys when requesting products for a single reference key

13.3.0

• Expose attributeGroupType for AttributesFilterItemWithValues on /filters endpoint

13.2.0

• Include campaignKey in /filters request

13.1.0

• Now supports CloudVault's token based authentication.

13.0.0

• Throw error if category's getByPath argument is invalid, resulting in the server returning the full list of categories

12.0.1

• Add category properties to root categories request

12.0.0

• Breaking Change: For categories included with products on /products, properties will not be included by default anymore. Responses are now small by default. Use with: { categories: { properties: 'all' } } to get the previous behavior, or better yet specify the exact properties you need using with: { categories: { properties: { withName: ['foo', 'bar'] } } }

11.0.0

• Breaking Change: For category requests, properties are not included by default anymore. Responses are now small by default. Use with: { properties: 'all' } to get the previous behavior, or better yet specify the exact properties you need using with: { properties: { withName: ['foo', 'bar'] } }

10.3.0

• Add shop-configuration endpoint

10.2.0

• Expose the score property on the Typeahead suggestions

10.1.1

• Fix incorrectly named "attribute by key" response type

10.1.0

• Add support for the "attribute by key" /attributes/${key} API endpoint

10.0.0

• Update BapiClient.addOrUpdateItems to return more detailled errors if any occured during the operations
• Make AddToBasketFailureKind enum string-based, so it's suitable for logging
• Expose skipAvailabilityCheck on "add to wishlist" operation

9.1.0

• Expose referenceKey on BAPI
• Expose products.byReferenceKeys on BapiClient

9.0.0

• Move axios back to a normal dependency, but with a wide range of versions supported, so consumers define which exact version should be used easily
• Export BasketItemPrice and BasketTotalPrice (28)
  • Thanks to @sqonde for contributing this fix
• Expose /typeahead API endpoint methods

8.0.1

• depth is now exposed on the category response type
• skipAvailabilityCheck can now be specified for basket requests

8.0.0

• The axios library is now a peer dependency, so you can specify the version to be used in the consumer's package.json.

7.0.0

• BapiClient: Change the default shopID placement to be query, which avoids CORS OPTIONS requests for GET requests.

6.0.0

• Align the parameters across BapiClient.categories.* methods

  • The depth parameter is now send to BAPI in all cases, even though it's not needed for every case (e.g. requesting categories by IDs wouldn't include children, unless those where specified using the with parameter). This is done to have a consistent behavior across the SDK methods, and not be reliant on per endpoint behavior in BAPI.
  • The legacy behavior of not returning the whole category tree by default when requesting the root categories (BapiClient.categories.getRoots) is kept. Pass an explicit children parameter (e.g. 1000) to request the whole tree.
  • BapiClient.categories.getByIds and createCategoriesByIdsEndpointRequest used to take a depth parameter which mapped directly to the BAPI HTTP API depth parameter. This has now been removed in favor of with.children, which specifies the additional levels of children that should be loaded. Set with.children to "previous depth" - 1 when upgrading to this version.

• Adds support for the /filters/:groupName/values endpoint

5.0.0

• Remove support for /masters endpoisrc/endpoints/typeahead/typeahead.tsnt

4.1.1

• Add minProductId to ProductsSearchEndpointParameters

4.1.0

• Add variants.getByIds to BapiClient

4.0.1

• Fix types for the BapiProductCategory and BapiCategory

4.0.0

• Removal of the following product helpers: findBrand, attributeLabel, variantAttributeLabel, variantAttributeId, attributeNames and labelFromAttributeGroup
• Addition of the following helpers: getAttributeValues

These helpers have been removed because they were not very useful by themselves. With the new optional chaining operator, most of these operations can be performed inline in the code.

For more information, see: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#optional-chaining

3.0.1

Fix ObjectMap type usage, such that it's included in the final output package.

3.0.0

Breaking changes:

• Remove tax from BapiPrice for the BasketItemPrice since BAPI won't supply that anymore soon.

2.8.0

Add includeHidden parameter to categories by IDs request (corresponds to BAPI's showHidden URL query parameter).

2.7.0

The tax field on the basket total costs is not exposed anymore, as it will shortly be removed from the API responses.

The Axios adapter is now configurable.

2.5.2

Expose including on /filters endpoint

2.5.1

Expose id on appropriate FilterItemWithValues

2.5.0

Expose id for attributes.

2.4.0

Support overwriting the Checkout shop ID on basket GETs with checkoutShopId parameter.

2.3.0

Add addOrUpdateItems method to BapiClient that handles adding or updating of many items, including merging quantities of new items with existing ones.

2.2.0

Add pricePromotionKey to every wishlist request.

2.1.2

Add ability to provide pricePromotionKey when adding items to wishlist.

2.1.0

Expose deliveryForecast on variant stock.

Expose availableQuantity and deliveryForecast on basket item.

Attribute group type property now correctly typed as nullable to match API schema.

Reference price size property now correctly typed as nullable to match API schema.

2.0.0

createProductsByIdsEndpointRequest throws when an empty array is provided for the productIds parameter.

BapiClient.products.getByIds returns an empty array when an empty array is provided for the productIds parameter, not making any network request.

pricePromotionKey can now be set for product listing request and products by IDs queries.

Add includeHidden parameter to product's categories include to request hidden categories on the product.

Support childShopId in addWishlistItemEndpointRequest.

1.5.0

Set accept-encoding: gzip, deflate in NodeJS context

1.4.0

Expose campaignKey in wishlist API calls.

1.3.0

Rename includeSoldOutProducts parameter to includeSoldOut.

1.2.1

Allow passing custom headers to execute.

1.2.0

Add search mappings endpoint.

1.1.1

Allow specifying includeSellableForFree parameter on /product endpoints Allow specifying parameters.includeSoldOutProducts parameter on /products search endpoint

1.1.0

Allow specifying with parameter for /filters requests

1.0.0

Expose displayData on Basket response

Improve displayData type, only allowing expected keys

Use CentAmount type for range filters, as their is only 1 for prices ( …

0.31.0

Expose displayData property in "create basket item" requests

0.30.0

Fix brands include for search suggestions

0.29.0

Set sortingKey parameter correctly (as sortingKey) for product queries

Expose currencyCode on price

0.28.0

Add search suggestions endpoint.

0.27.0

Add ability to set HTTP basic auth credentials.

0.26.0

Expose customData property on stocks. Remove it from variants.

Refine type for BooleanFilterValue, which can contain 0, 1, or 2 values.

0.25.0

Expose appliedPricePromotionKey on variant

0.24.0

Expose categoryProperties on product and allow it to be included in requests.

0.23.0

Enable sortingKey for product search queries

Expose customData property on variants

export AddToBasketFailureKind enum

0.22.0

Support campaignKey for basket requests

0.21.0

Expose optional priceRange property on product entities.

0.20.0

The key property is now exposed on basket responses.

A childShopId parameter can now be passed to "add to basket" calls, which will be forward as appId in the payload of the checkout call.

The shop ID can now be set via the header or via an URL query parameter. Since it the URL parameter doesn't infere with CORS it's now mandatory in the SDK (and also in upcoming versions of the BAPI itself). The execute function by default will place the shop ID in the URL, while the BapiClient will place the shop ID in the header to support existing BAPI installations. This might change in the future.

0.19.0

Respect advancedAttributes query for variants in basket requests

0.18.0

Fix "Add Wishlist Item" requests

0.17.1

Request non-legacy image attributes by default. No specific setting needed. Now matches the types of the response in all cases.

0.17.0

Correct types for product image attributes (non-legacy style).

0.16.0

Make the shopId optional, for cases where only a single shop ID is used and one wants to avoid CORS OPTIONS request in browser settings.

0.15.0

Send explicit depth parameter for all /categories requests. To request the whole category tree use an explicit depth exceeding the tree depth.