@scayle/storefront-core 7.22.1

package/CHANGELOG.md

@@ -0,0 +1,480 @@
+# @scayle/storefront-core
+
+## 7.22.1
+
+### Patch Changes
+
+- Add license file
+
+## 7.22.0
+
+### Minor Changes
+
+- Upgrade package `@aboutyou/backbone`to `v15.14.1`
+
+## 7.21.0
+
+### Minor Changes
+
+- - Add `promotion` RPC methods and types
+- - Add promotion data within the basket payloads
+
+### Patch Changes
+
+- Fix product URL generation, remove additional special characters that can break routing
+
+## 7.20.0
+
+### Minor Changes
+
+- Upgrade backbone to the `v15.12.1`
+
+## 7.19.1
+
+### Patch Changes
+
+- The `auth` config is optional
+
+## 7.19.0
+
+### Minor Changes
+
+- Support setting default `with` params in the module options
+
+## 7.18.0
+
+### Minor Changes
+
+- Expose error codes from BAPI for the basket rpc methods
+
+## 7.17.0
+
+### Minor Changes
+
+- Limit perPage for getBrands and getProductsByCategory to 100
+
+## 7.16.0
+
+### Minor Changes
+
+- Support expiring CBD tokens
+
+## 7.15.1
+
+### Patch Changes
+
+- Remove unnecessary dependencies
+
+## 7.15.0
+
+### Minor Changes
+
+- Support importing all dist/ files directly
+
+## 7.14.3
+
+### Patch Changes
+
+- Import fix
+
+## 7.14.2
+
+### Patch Changes
+
+- Make redis an optional dependency
+
+## 7.14.1
+
+### Patch Changes
+
+- Remove unused body-parser dependency
+
+## 7.14.0
+
+### Minor Changes
+
+- Read OAuth settings from the RpcContext
+
+## 7.13.0
+
+### Minor Changes
+
+- Save user to session during login/register process. This will fix wrong wishlist/basket keys, in the RpcContext, after the login/registering.
+- Safe user to session during login process. This will fix wrong wishlist/basket keys , in the RpcContext, after the login.
+
+## 7.12.2
+
+### Patch Changes
+
+- Replace crypto with uncrypto
+
+## 7.12.1
+
+### Patch Changes
+
+- Export BapiClient and Redirect from BAPI
+
+## 7.12.0
+
+### Minor Changes
+
+- `to` prop of `BreadcrumbItem` returned from `getBreadcrumbsFromPath` now start with `/`
+
+## 7.11.0
+
+### Minor Changes
+
+- Move `deserializeFilters` and `serializeFilters` to `@scayle/storefront-core`
+
+## 7.10.2
+
+### Patch Changes
+
+- encodeBase64 and decodeBase64 should be able to be run in browser environments
+
+## 7.10.1
+
+### Patch Changes
+
+- Get accessToken from getUserRequest on client side.
+  Merge basket and wishlist after login/register to logged in user.
+
+## 7.10.0
+
+### Minor Changes
+
+- Add the possibility to use Token based authentication.
+
+## 7.9.0
+
+### Minor Changes
+
+- Add unstorage cache provider
+
+### Patch Changes
+
+- Fix crypto-js imports needed for basked/wishlist key generation.
+
+## 7.8.0
+
+### Minor Changes
+
+- provide exports of package as ESM and CJS format
+- Migrate helpers to core package
+
+### Patch Changes
+
+- Add `initBapi` function to initialize a BapiClient
+
+## 7.7.1
+
+### Patch Changes
+
+- orFiltersOperator should be optional in FetchProductsByCategoryParams and FetchProductsCountParams
+
+## 7.7.0
+
+### Minor Changes
+
+- Update @aboutyou/backbone package and add support for `onFiltersOperator` BAPI parameter
+
+## 7.6.1
+
+### Patch Changes
+
+- Move keys utils to core package
+
+## 7.6.0
+
+### Minor Changes
+
+- Set the domain property in the rpc context
+
+## 7.5.0
+
+### Minor Changes
+
+- `refresh()` of `useUser()` and `useUserFacet()` will now clear the session and user state if the checkout returns `HTTP 403 Forbidden`.
+- **Breaking** `destroySession` is now async.
+
+## 7.4.0
+
+### Minor Changes
+
+- Add option `includeSellableForFree` to `useFacet` and `useProducts` to include free products.
+
+## 7.3.1
+
+### Patch Changes
+
+- Move RpcMethodsStorefront type to the nuxt2 package so it's accessible to shops
+
+## 7.3.0
+
+### Minor Changes
+
+- Add rpcMethods `getBrand` and `getBrands` & corresponding composables, to make bapi-sdk brand endpoints available.
+
+## 7.2.1
+
+### Patch Changes
+
+- Added ability to add basket groups by accepting `itemGroup` in the payload for the rpc method `addItemsToBasket`
+
+## 7.2.0
+
+### Minor Changes
+
+- - Replaced `enums` with the companion object pattern approach.
+- - Replaced `HttpStatusMessage` number values with the actual message
+- - Exposed `HashAlgorithm` constant with its type and move it to the core
+  - **Breaking:** If you are importing `HashAlgorithm` from `@scayle/storefront-nuxt2` change to importing it from `@scayle/storefront-core`
+
+## 7.1.0
+
+### Minor Changes
+
+- Fix `fetchAllFiltersForCategory` caching issue by returning the cached value.
+- Fix `fetchAllFiltersForCategory` caching issue by returning the cached value.
+
+## 7.0.0
+
+### Major Changes
+
+- **Changes to basket and wishlist functions**
+  - Going forward, the only way to specify `with` and `pricePromotionKey` for the basket is by passing them to `useBasketWithParams()`.
+    They can no longer be overridden when calling `basket.addItem()`, `basket.removeItem()` or `basket.fetch()`.
+  - The only way to specify `pricePromotionKey` for the wishlist is by to passing them to `useWishlistWithParams()`.
+    They can no longer be overridden when calling `wishlist.addItem()`, `wishlist.removeItem()`, `wishlist.toggleItem()` or `wishlist.fetch()`.
+- **Removed deprecated functions and values**
+  - **Removal**: `user.fetch()`
+    - user is fetched automatically. If you want to refresh the user, use `user.refresh()`
+  - **Removal**: `user.forceRefreshUser()`
+    - instead use `user.refresh()`
+  - **Removal**: `useUser()`
+    - instead use `useUserWithParams()`
+  - **Removal**: `useBasket()`
+    - instead use `useBasketWithParams()`
+  - **Removal**: `useWishlist()`
+    - instead use `useWishlistWithParams()`
+  - **Removal**: `ShopUser.emailHash`
+    - instead hash the email address on shop side
+  - **Removal**: `wishlist.contains()`
+    - instead use `wishlist.findItem()`
+  - **Removal**: `applyFilter()`
+    - instead use `applyFilters()`
+  - **Removal**: `Log.attachToNuxtContext()`
+    - instead use `inject('log', log)` in your plugin
+  - **Removal**: `Log.attachToWindow()`
+    - instead use `Log.default = log`
+  - **Removal**: `sortingValues`
+    - instead use `getSortingValues()`
+- **Changed NPM package names**
+
+  - **Breaking**: Change package scope and name of `@aboutyou/scayle-sfc-nuxt` to `@scayle/storefront-nuxt2`
+  - **Breaking**: Change package scope and name of `@aboutyou/sfc-nuxt3` to `@scayle/storefront-nuxt`
+  - **Breaking**: Change package scope and name of `@aboutyou/scayle-sfc-lib` to `@scayle/storefront-core`
+  - **Breaking**: Change package scope and name of `@aboutyou/eslint-config-sfc` to `@scayle/eslint-config-storefront`
+  - **Breaking**: Change package scope and name of `@aboutyou/prettier-config-sfc` to `@scayle/prettier-config-storefront`
+
+  _NOTE: Due to the changes of the NPM package scope from `@aboutyou` to `@scayle`,
+  it is required to change the consuming projects local `.npmrc` file as follows:_
+
+  - Before:
+
+  ```
+  @aboutyou:registry=https://gitlab.com/api/v4/packages/npm/
+  ```
+
+  - After:
+
+  ```
+  @aboutyou:registry=https://gitlab.com/api/v4/projects/29746107/packages/npm/
+  @scayle:registry=https://gitlab.com/api/v4/projects/29746107/packages/npm/
+  ```
+
+- **Removal**: `isEmpty`, `isEqual`, `pluck` and `copyTo` object helpers are removed.
+  _NOTE: We recommend to use native utilities or `radash` within your project!_
+- **Removal**: Remove the deprecated pino-based logger.
+  _NOTE: For more information, please check out the "Logging"-section in `README.md`._
+- Changes to hash utils:
+  - `hmac`, `verifyToken`, `buildSignature` functions are now async
+  - hash functions are no longer exported from `utils/index`. They must be imported from `utils/hash`
+  - `sha256` function added
+- **Breaking**: Minimum `node` version raised to `18.15.0`
+- `sha256` is used for default cache keys instead of `md5`
+- **Breaking**: Remove the BasicAuth module
+- Support sha256 for basket and wishlist keys
+
+  The `appKeys.isHashed` config option has been renamed to `appKeys.hashAlgorithm`. Instead of a boolean, there are now three options.
+
+  - `'sha256'` Use the `sha256` function for hashing basket and wishlist keys
+  - `'md5'` Use the `md5` function for hashing basket and wishlist keys (Equivalent to `isHashed: true` in v6)
+  - `null` Do not hash basket and wishlist keys (Equivalent to `isHashed: false` in v6)
+
+- **Redis optimizations**
+  Reduce memory usage by replacing `with parameters` from fetching all attributes and fetching minimum attributes required to run the demo shop.
+  _NOTE: As this is a **breaking change**, in order to upgrade you will need to pass the `with parameters` required by the shop to function correctly!_
+
+### Minor Changes
+
+- Support optionally dropping MD5 and the crypto-js dependency
+  When `process.env.SFC_OMIT_MD5` is `true`, the md5 function will be replaced with an empty stub. If you do not use the MD5 hash at all this can be used to reduce bundle sizes.
+
+  In `nuxt.config.js` add
+
+  ```js
+  env: {
+    SFC_OMIT_MD5: true
+  }
+  ```
+
+  or if you want to control it from a `.env`
+
+  ```js
+  env: {
+    SFC_OMIT_MD5: process.env.SFC_OMIT_MD5
+  }
+  ```
+
+- **Improvement**: Overall code enhancement within `storefront-core` package in favor of reducing the cognitive complexity and increasing maintainability
+  - Introduce `autobind` helper
+  - Refactor `cached` file
+
+### Patch Changes
+
+- **Bugfix**: Resolve incompatibility with Webpack 4-based build processes
+
+## 7.0.0-alpha.3
+
+### Major Changes
+
+- Changes to hash utils:
+  - `hmac`, `verifyToken`, `buildSignature` functions are now async
+  - hash functions are no longer exported from `utils/index`. They must be imported from `utils/hash`
+  - `sha256` function added
+- `sha256` is used for default cache keys instead of `md5`
+- Support sha256 for basket and wishlist keys
+
+  The `appKeys.isHashed` config option has been renamed to `appKeys.hashAlgorithm`. Instead of a boolean, there are now three options.
+
+  - `'sha256'` Use the `sha256` function for hashing basket and wishlist keys
+  - `'md5'` Use the `md5` function for hashing basket and wishlist keys (Equivalent to `isHashed: true` in v6)
+  - `null` Do not hash basket and wishlist keys (Equivalent to `isHashed: false` in v6)
+
+### Minor Changes
+
+- Support optionally dropping MD5 and the crypto-js dependency
+  When `process.env.SFC_OMIT_MD5` is `true`, the md5 function will be replaced with an empty stub. If you do not use the MD5 hash at all this can be used to reduce bundle sizes.
+
+  In `nuxt.config.js` add
+
+  ```js
+  env: {
+    SFC_OMIT_MD5: true
+  }
+  ```
+
+  or if you want to control it from a `.env`
+
+  ```js
+  env: {
+    SFC_OMIT_MD5: process.env.SFC_OMIT_MD5
+  }
+  ```
+
+## 7.0.0-alpha.2
+
+### Patch Changes
+
+- **Bugfix**: Resolve incompatibility with Webpack 4-based build processes
+
+## 7.0.0-alpha.1
+
+### Major Changes
+
+- **Redis optimizations**
+  Reduce memory usage by replacing `with parameters` from fetching all attributes and fetching minimum attributes required to run the demo shop.
+  _NOTE: As this is a **breaking change**, in order to upgrade you will need to pass the `with parameters` required by the shop to function correctly!_
+
+### Minor Changes
+
+- **Improvement**: Overall code enhancement within `storefront-core` package in favor of reducing the cognitive complexity and increasing maintainability
+  - Introduce `autobind` helper
+  - Refactor `cached` file
+
+## 7.0.0-alpha.0
+
+### Major Changes
+
+- **Changes to basket and wishlist functions**
+
+  Going forward, the only way to specify `with` and `pricePromotionKey` for the basket is pass them to `useBasketWithParams()`.
+  They can no longer be overridden when calling `basket.addItem()`, `basket.removeItem()` and `basket.fetch()`.
+
+  The only way to specify `pricePromotionKey` for the wishlist is to pass them to `useWishlistWithParams()`.
+  They can no longer be overridden when calling `wishlist.addItem()`, `wishlist.removeItem()`, `wishlist.toggleItem()` and `wishlist.fetch()`.
+
+- **Removed deprecated functions and values**
+
+  - `user.fetch()` User is fetched automatically. If you want to refresh the user, use `user.refresh()`
+  - `user.forceRefreshUser()` Use `user.refresh()` instead.
+  - `useUser()` Use `useUserWithParams()` instead.
+  - `useBasket()` Use `useBasketWithParams()` instead.
+  - `useWishlist()` Use `useWishlistWithParams()` instead.
+  - `ShopUser.emailHash` Hash the email on shop side instead.
+  - `wishlist.contains()` Use `wishlist.findItem()` instead.
+  - `applyFilter()` Use `applyFilters()` instead.
+  - `Log.attachToNuxtContext()` Use `inject('log', log)` in your plugin instead.
+  - `Log.attachToWindow()` Use `Log.default = log` instead.
+  - `sortingValues` Use `getSortingValues()` instead.
+
+- **Changed NPM package names**
+
+  - **Breaking**: Change package scope and name of `@aboutyou/scayle-sfc-nuxt` to `@scayle/storefront-nuxt2`
+  - **Breaking**: Change package scope and name of `@aboutyou/sfc-nuxt3` to `@scayle/storefront-nuxt`
+  - **Breaking**: Change package scope and name of `@aboutyou/scayle-sfc-lib` to `@scayle/storefront-core``
+  - **Breaking**: Change package scope and name of `@aboutyou/eslint-config-sfc` to `@scayle/eslint-config-storefront`
+  - **Breaking**: Change package scope and name of `@aboutyou/prettier-config-sfc` to `@scayle/prettier-config-storefront`
+
+  Due to the changes of the NPM package scope from `@aboutyou` to `@scayle`,
+  it is required to change the consuming projects local `.npmrc` file as follows:
+
+  - Before: `@aboutyou:registry=https://gitlab.com/api/v4/packages/npm/`
+  - After: `@scayle:registry=https://gitlab.com/api/v4/packages/npm/`
+
+- `isEmpty`, `isEqual`, `pluck` and `copyTo` object helpers are removed. (Recommendation: It would be good to use native utils or `radash` within the project locally)
+- Remove the deprecated pino-based logger. For more information, please check out the "Logging"-section in README.md.
+- Minimum node version is 18.15.0
+- Remove the basic auth module
+
+## 6.8.0
+
+### Minor Changes
+
+- Adds ability to ignore shop locale if passed to the breadcrumb helper. The shop needs to provide its locale using `$currentShop.locale`
+
+## 6.7.1
+
+### Patch Changes
+
+- **Bugfix**: move `CACHE_TIMEOUT` to dedicated file for reexport, instead of `cache/providers/redis.ts`, to avoid buildtime errors in nuxt2 package.
+
+## 6.7.0
+
+### Minor Changes
+
+- **Deps**: updated `@aboutyou/backbone` to `v15.3.0`
+
+## 6.6.16
+
+### Patch Changes
+
+- _Cache_: reduce redis cache timeout from 5000ms to 500ms
+
+## 6.6.15
+
+### Patch Changes
+
+- _Cache_: introduce shared redis `CACHE_TIMEOUT` constant across shared packages
+- _Cache_: Increase redis `get` timeout from `300ms` to `5000ms` to account for longer taking redis responses

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 SCAYLE GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# Storefront Core
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+
+This is a shared package for framework-independent components of the Storefront Core.
+
+## Installation
+
+```bash
+# Using pnpm
+pnpm add @scayle/storefront-core
+
+# Using yarn
+yarn add @scayle/storefront-core
+
+# Using npm
+npm install @scayle/storefront-core
+```
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@scayle/storefront-core/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@scayle/storefront-core
+[npm-downloads-src]: https://img.shields.io/npm/dm/@scayle/storefront-core.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@scayle/storefront-core
+[license-src]: https://img.shields.io/npm/l/@scayle/storefront-core.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@scayle/storefront-core

package/dist/bapi/init.cjs

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.init = void 0;
+var _backbone = require("@aboutyou/backbone");
+const init = config => {
+  let auth;
+  if (config.authentication === "basic") {
+    auth = {
+      type: config.authentication,
+      username: config.username,
+      password: config.password
+    };
+  } else if (config.authentication === "token") {
+    auth = {
+      type: config.authentication,
+      token: config.token
+    };
+  } else {
+    throw new Error("Invalid BAPI authentication type");
+  }
+  return new _backbone.BapiClient({
+    host: config.host,
+    shopId: config.shopId,
+    auth
+  });
+};
+exports.init = init;

package/dist/bapi/init.d.ts

@@ -0,0 +1,14 @@
+import { BapiClient } from '@aboutyou/backbone';
+type BapiConfig = {
+    host: string;
+    shopId: number;
+} & ({
+    authentication: 'basic';
+    username: string;
+    password: string;
+} | {
+    authentication: 'token';
+    token: string;
+});
+export declare const init: (config: BapiConfig) => BapiClient;
+export {};

package/dist/bapi/init.mjs

@@ -0,0 +1,23 @@
+import { BapiClient } from "@aboutyou/backbone";
+export const init = (config) => {
+  let auth;
+  if (config.authentication === "basic") {
+    auth = {
+      type: config.authentication,
+      username: config.username,
+      password: config.password
+    };
+  } else if (config.authentication === "token") {
+    auth = {
+      type: config.authentication,
+      token: config.token
+    };
+  } else {
+    throw new Error("Invalid BAPI authentication type");
+  }
+  return new BapiClient({
+    host: config.host,
+    shopId: config.shopId,
+    auth
+  });
+};

package/dist/cache/cache.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/cache/cache.d.ts

@@ -0,0 +1,8 @@
+export interface Cache {
+    set: (key: string, value: any, ttl: number, tags?: string[]) => Promise<void>;
+    get(key: string): Promise<any>;
+    has(key: string): Promise<boolean>;
+    purgeTags: (tags: string[]) => Promise<void>;
+    purgeKeys: (keys: string[]) => Promise<void>;
+    purgeAll: () => Promise<void>;
+}

package/dist/cache/cached.cjs

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Cached = void 0;
+var _radash = require("radash");
+var _autobind = require("../helpers/autobind.cjs");
+var _utils = require("../utils/index.cjs");
+var _hash = require("../utils/hash.cjs");
+var _constants = require("../constants/index.cjs");
+const CACHE_NOT_INITIALIZED_MSG = "Cache is not initialized";
+class Cached {
+  cache;
+  log;
+  prefix;
+  enabled;
+  constructor(cache, log, prefix = "", enabled = process.env.AY_CACHE_DISABLED !== "true") {
+    if (!cache) {
+      log.error(CACHE_NOT_INITIALIZED_MSG);
+      throw new Error(CACHE_NOT_INITIALIZED_MSG);
+    }
+    this.cache = cache;
+    this.log = log.space("cached.init");
+    this.prefix = prefix;
+    this.enabled = enabled;
+    (0, _autobind.autobind)(this);
+  }
+  get isCacheEnabled() {
+    return this.enabled;
+  }
+  execute(fn, options) {
+    return async (...args) => {
+      const prefix = options?.cacheKeyPrefix ?? fn.name;
+      const params = [...args, this?.prefix];
+      const cacheKey = options?.cacheKey ?? (await this.createCacheKey(params, prefix));
+      const [cacheGetError, cachedResponse] = await (0, _radash.tryit)(this.getCacheValue)(cacheKey, options);
+      if (cachedResponse) {
+        return cachedResponse;
+      }
+      if (cacheGetError) {
+        this.handleError(cacheGetError, false);
+      }
+      const [error, response] = await (0, _radash.tryit)(fn)(...args);
+      if (error) {
+        this.handleError(error);
+      }
+      if (cacheGetError) {
+        return response;
+      }
+      const [cacheSetError] = await (0, _radash.tryit)(this.setCacheValue)(cacheKey, response, options);
+      if (cacheSetError) {
+        this.handleError(cacheSetError);
+      }
+      return response;
+    };
+  }
+  async getCacheValue(cacheKey, options) {
+    if (!this.isCacheEnabled) {
+      return;
+    }
+    const data = await (0, _utils.timeout)(options?.timeout ?? _constants.CACHE_TIMEOUT, this.cache.get(cacheKey));
+    if (data !== null) {
+      return data;
+    }
+  }
+  async setCacheValue(cacheKey, value, options) {
+    if (!this.isCacheEnabled) {
+      return;
+    }
+    const ttl = options?.ttl || 60 * 60;
+    if (ttl) {
+      await (0, _utils.timeout)(_constants.CACHE_TIMEOUT, this.cache.set(cacheKey, value, ttl));
+    }
+  }
+  async createCacheKey(params, prefix = "") {
+    return [prefix, await (0, _hash.sha256)(JSON.stringify(params))].join(":");
+  }
+  handleError(error, shouldThrow = true) {
+    if (error.message === "timeout") {
+      return this.log.error("Cache timeout");
+    }
+    this.log.error(error);
+    if (shouldThrow) {
+      throw error;
+    }
+  }
+}
+exports.Cached = Cached;