@scayle/storefront-core 8.4.0 → 8.5.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @scayle/storefront-core
 
+## 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.
+
+  ```TypeScript
+  const { ... } = require('@scayle/storefront-core');
+
+  // will become
+
+  import { ... } from '@scayle/storefront-core';
+  ```
+
 ## 8.4.0
 
 ### Minor Changes

package/dist/rpc/methods/checkout/checkout.mjs

@@ -35,7 +35,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.4.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.5.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/search.d.ts

@@ -1,3 +1,25 @@
 import type { SearchEntity, SearchV2ResolveEndpointParameters, SearchV2SuggestionsEndpointParameters, SearchV2SuggestionsEndpointResponseData } from '../../types/sapi/search';
+/**
+ * Fetches search suggestions for a given term.
+ *
+ * @param option - The parameters for the request.
+ * @param option.term - The term to search for.
+ * @param option.with - An object describing which data the returned suggestions should contain.
+ * @param option.categoryId - The category ID to search within.
+ * @param context - The rpc context associated with the request.
+ *
+ * @returns A promise that resolves to a list of search suggestions.
+ */
 export declare const getSearchSuggestions: ({ term, with: _with, categoryId }: SearchV2SuggestionsEndpointParameters, { sapiClient, withParams }: import("../../types").RpcContext) => Promise<Response | SearchV2SuggestionsEndpointResponseData>;
+/**
+ * Resolves a search query and returns the resolved entity.
+ *
+ * @param option - The parameters for the search query.
+ * @param option.term - The search query to resolve.
+ * @param option.with - An object describing which data the returned result should contain.
+ * @param option.categoryId - The category ID for which the search should be performed.
+ * @param context - The rpc context associated with the request.
+ *
+ * @returns A promise that resolves to the resolved entity or null if no entity is found.
+ */
 export declare const resolveSearch: ({ term, with: _with, categoryId }: SearchV2ResolveEndpointParameters, { cached, sapiClient, withParams }: import("../../types").RpcContext) => Promise<SearchEntity | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.4.0",
+  "version": "8.5.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -14,36 +14,26 @@
     "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "default": "./dist/index.cjs"
+      "default": "./dist/index.mjs"
     },
     "./server": {
       "types": "./dist/server.d.ts",
-      "import": "./dist/server.mjs",
-      "require": "./dist/server.cjs",
-      "default": "./dist/server.cjs"
+      "default": "./dist/server.mjs"
     },
     "./dist/test/factories": {
       "types": "./dist/test/factories/index.d.ts",
-      "import": "./dist/test/factories/index.mjs",
-      "require": "./dist/test/factories/index.cjs",
-      "default": "./dist/test/factories/index.cjs"
+      "default": "./dist/test/factories/index.mjs"
     },
     "./test/factories": {
       "types": "./dist/test/factories/index.d.ts",
-      "import": "./dist/test/factories/index.mjs",
-      "require": "./dist/test/factories/index.cjs",
-      "default": "./dist/test/factories/index.cjs"
+      "default": "./dist/test/factories/index.mjs"
     },
     "./dist/*": {
       "types": "./dist/*.d.ts",
-      "import": "./dist/*.mjs",
-      "require": "./dist/*.cjs",
-      "default": "./dist/*.cjs"
+      "default": "./dist/*.mjs"
     }
   },
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
@@ -83,11 +73,11 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.4.1",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.13.1",
+    "@types/node": "22.13.2",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "2.1.9",
     "dprint": "0.49.0",
-    "eslint": "9.19.0",
+    "eslint": "9.20.1",
     "eslint-formatter-gitlab": "5.1.0",
     "publint": "0.2.12",
     "rimraf": "6.0.1",

package/dist/api/customer.cjs

@@ -1,164 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CustomerAPIClient = void 0;
-var _fetch = require("../utils/fetch.cjs");
-var _httpStatus = require("../constants/httpStatus.cjs");
-var _oauth = require("./oauth.cjs");
-class CustomerAPIClient {
-  baseURL;
-  context;
-  additionalHeaders;
-  constructor(context) {
-    this.baseURL = context.checkout.url;
-    this.context = context;
-    this.additionalHeaders = context.internalAccessHeader ? {
-      "x-internal-access": context.internalAccessHeader
-    } : {};
-  }
-  get headers() {
-    return {
-      Authorization: `Bearer ${this.context.accessToken}`,
-      Accept: "application/json",
-      "Content-Type": "application/json",
-      ...this.additionalHeaders
-    };
-  }
-  async sendRequest(request, retry = true) {
-    const response = await request();
-    if (response.ok) {
-      return await response.json();
-    }
-    if ((response.status === _httpStatus.HttpStatusCode.UNAUTHORIZED && response.headers.get("WWW-Authenticate")?.includes("invalid_token") || response.status === _httpStatus.HttpStatusCode.FORBIDDEN) && this.context.accessToken && this.context.refreshToken) {
-      if (retry) {
-        const client = (0, _oauth.getOAuthClient)(this.context);
-        try {
-          const tokens = await client.refreshToken({
-            grant_type: "refresh_token",
-            refresh_token: this.context.refreshToken
-          });
-          this.context.updateTokens({
-            accessToken: tokens?.access_token,
-            refreshToken: tokens?.refresh_token
-          });
-        } catch (e) {
-          if (e instanceof _fetch.FetchError && e.response.status === _httpStatus.HttpStatusCode.UNAUTHORIZED) {
-            this.context.log.debug("Failed to refresh Checkout Token due to invalid refresh token. Deleting session");
-            await this.context.destroySession();
-          } else {
-            this.context.log.debug("Failed to refresh Checkout Token for unknown reason.");
-          }
-          throw new _fetch.FetchError(response);
-        }
-        return await this.sendRequest(request, false);
-      } else {
-        this.context.log.debug("Invalid Checkout Token. Deleting session");
-        await this.context.destroySession();
-      }
-    }
-    throw new _fetch.FetchError(response);
-  }
-  /**
-   * Get the addresses for the current customer.
-   *
-   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/address/list-addresses
-   */
-  async getAddresses(shopId) {
-    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/addresses`, {
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      }
-    }));
-  }
-  /**
-   * Returns customer data and latest orders.
-   * When not logged in, it will return `undefined`.
-   *
-   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/get-customer
-   */
-  async getMe(shopId, accessToken) {
-    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/me`, {
-      headers: {
-        ...this.headers,
-        ...(accessToken ? {
-          Authorization: `Bearer ${accessToken}`
-        } : {}),
-        "X-Shop-Id": shopId.toString()
-      }
-    }));
-  }
-  /**
-   * Retrieve a customer's order.
-   *
-   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/order/get-order
-   */
-  async getOrder(shopId, orderId) {
-    return this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/order/${orderId}`, {
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      }
-    }));
-  }
-  /**
-   * Update contact details of a customer.
-   *
-   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-contact-details
-   */
-  async updateContactInfo(shopId, {
-    email,
-    phone
-  }) {
-    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/contact`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      },
-      body: JSON.stringify({
-        email,
-        phone
-      })
-    }));
-  }
-  /**
-   * Update customer personal data.
-   *
-   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-personal-data
-   */
-  async updatePersonalInfo(shopId, payload) {
-    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/personal`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      },
-      body: JSON.stringify(payload)
-    }));
-  }
-  /**
-   * Update customer password.
-   *
-   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-password
-   */
-  async updatePassword(shopId, {
-    password,
-    newPassword
-  }) {
-    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/password`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      },
-      body: JSON.stringify({
-        password,
-        newPassword
-      })
-    }));
-  }
-}
-exports.CustomerAPIClient = CustomerAPIClient;

package/dist/api/oauth.cjs

@@ -1,238 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.OAuthClient = void 0;
-exports.getOAuthClient = getOAuthClient;
-var _jose = require("jose");
-var _fetch = require("../utils/fetch.cjs");
-var _hash = require("../utils/hash.cjs");
-class MissingCredentialsError extends Error {
-  constructor() {
-    super("[OAuth API] No credentials configured");
-    this.name = "MissingCredentialsError";
-  }
-}
-async function oauthResponseHandler(response) {
-  const data = await response.json();
-  if (!response.ok) {
-    throw new _fetch.FetchError(response, data);
-  }
-  return data;
-}
-function emptyOAuthResponseHandler(response) {
-  if (!response.ok) {
-    throw new _fetch.FetchError(response);
-  }
-}
-function getOAuthClient(context) {
-  if (!context.oauth) {
-    throw new Error("OAuth configuration is missing");
-  }
-  const clientId = context.oauth.clientId;
-  const clientSecret = context.oauth.clientSecret;
-  const apiHost = context.oauth.apiHost;
-  const accessHeader = context.internalAccessHeader;
-  return new OAuthClient({
-    clientId,
-    clientSecret,
-    apiHost,
-    additionalHeaders: accessHeader ? {
-      "x-internal-access": accessHeader
-    } : {}
-  }, context.log);
-}
-class OAuthClient {
-  headers;
-  baseURL;
-  logger;
-  clientId;
-  constructor(options, logger) {
-    const {
-      clientId,
-      clientSecret,
-      apiHost,
-      additionalHeaders
-    } = options;
-    if (!clientId || !clientSecret) {
-      throw new MissingCredentialsError();
-    }
-    this.clientId = clientId;
-    this.baseURL = `${apiHost}/v1`;
-    this.logger = logger ? logger.space("auth-client") : void 0;
-    const basicAuthHash = (0, _hash.encodeBase64)(`${clientId}:${clientSecret}`);
-    this.headers = {
-      Authorization: `Basic ${basicAuthHash}`,
-      Accept: "application/json",
-      "Content-Type": "application/json",
-      ...additionalHeaders
-    };
-  }
-  /**
-   * Register a new User and receive an access token.
-   *
-   * @param payload
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
-   */
-  async register(payload) {
-    this.logger?.debug("Registering user");
-    return await fetch(`${this.baseURL}/auth/register`, {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify(payload)
-    }).then(oauthResponseHandler);
-  }
-  /**
-   * Login a User and receive an access token.
-   *
-   * @param payload
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
-   */
-  async login(payload) {
-    this.logger?.debug("Logging in");
-    return await fetch(`${this.baseURL}/auth/login`, {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify(payload)
-    }).then(oauthResponseHandler);
-  }
-  /**
-   * Login a User as a guest and receive an access token.
-   *
-   * @param payload
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
-   */
-  async guestLogin(payload) {
-    this.logger?.debug("Logging in as guest");
-    return await fetch(`${this.baseURL}/auth/login/guest`, {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify(payload)
-    }).then(oauthResponseHandler);
-  }
-  /**
-   * Send a reset password email to a User.
-   *
-   * @param payload
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
-   */
-  async sendPasswordResetEmail(payload) {
-    this.logger?.debug("Sending password reset email");
-    await fetch(`${this.baseURL}/auth/password/send-reset-email`, {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify(payload)
-    }).then(emptyOAuthResponseHandler);
-  }
-  /**
-   * Update password by using hash.
-   * All older tokens of the User are also invalidated.
-   *
-   * @param payload
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
-   */
-  async updatePasswordByHash(payload) {
-    this.logger?.debug("Updating password by hash");
-    return await fetch(`${this.baseURL}/auth/password/update-by-hash`, {
-      method: "PUT",
-      headers: this.headers,
-      body: JSON.stringify(payload)
-    }).then(oauthResponseHandler);
-  }
-  /**
-   * Update password via plain string.
-   *
-   * @param payload
-   * @param accessToken
-   */
-  async updatePassword(payload, accessToken) {
-    this.logger?.debug("Updating password");
-    return await fetch(`${this.baseURL}/auth/password`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        Authorization: `Bearer ${accessToken}`
-      },
-      body: JSON.stringify(payload)
-    }).then(emptyOAuthResponseHandler);
-  }
-  /**
-   * Generate a new access token via a refresh token.
-   *
-   * @param payload
-   */
-  async refreshToken(payload) {
-    this.logger?.debug("Refreshing access token");
-    return await fetch(`${this.baseURL}/oauth/token`, {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify(payload)
-    }).then(oauthResponseHandler);
-  }
-  /**
-   * Validate a token.
-   *
-   * @param accessToken
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/validate-present-token
-   */
-  async validateToken(accessToken) {
-    this.logger?.debug("Validating access token");
-    await fetch(`${this.baseURL}/oauth/token/validate`, {
-      headers: {
-        ...this.headers,
-        Authorization: `Bearer ${accessToken}`
-      }
-    }).then(emptyOAuthResponseHandler);
-  }
-  /**
-   * Revoke an Access Token and all related Refresh Tokens.
-   *
-   * Uses a valid Bearer Access Token in the Authorization header and will
-   * revoke the token with the given ID (_which could be a different token_).
-   * If a external identity provider was used for the target token,
-   * the corresponding IDP-AccessToken and IDP-RefreshToken will be revoked as well.
-   * In case the identity provider does not support revoking tokens over api calls
-   * (_because a frontend redirect is required_) this step will be skipped and the IDP-Tokens
-   * will remain valid until they expire or are revoked from IDP side.
-   *
-   * @param shopId
-   * @param accessToken
-   *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/delete-access-token-with-id
-   */
-  async revokeToken(shopId, accessToken) {
-    this.logger?.debug("Revoking access token");
-    const decodedAccessToken = (0, _jose.decodeJwt)(accessToken);
-    await fetch(`${this.baseURL}/oauth/tokens/${decodedAccessToken.jti}`, {
-      method: "DELETE",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": `${shopId}`,
-        Authorization: `Bearer ${accessToken}`
-      }
-    }).then(emptyOAuthResponseHandler);
-  }
-  /**
-   * Generate a new token based on authorization code.
-   *
-   * @param code
-   */
-  async generateToken(code) {
-    return await fetch(`${this.baseURL}/oauth/token`, {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify({
-        grant_type: "authorization_code",
-        code
-      })
-    }).then(oauthResponseHandler);
-  }
-}
-exports.OAuthClient = OAuthClient;

package/dist/cache/cache.cjs

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

package/dist/cache/cached.cjs

@@ -1,90 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.MINUTE = exports.Cached = void 0;
-var _utils = require("../utils/index.cjs");
-var _hash = require("../utils/hash.cjs");
-var _constants = require("../constants/index.cjs");
-const MINUTE = exports.MINUTE = 60;
-const CACHE_NOT_INITIALIZED_MSG = "Cache is not initialized";
-class Cached {
-  cache;
-  log;
-  prefix;
-  enabled;
-  constructor(cache, log, prefix = "", enabled) {
-    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;
-  }
-  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));
-      try {
-        const cachedResponse = await this.getCacheValue(cacheKey, options);
-        if (cachedResponse !== void 0 && cachedResponse !== null) {
-          return cachedResponse;
-        }
-      } catch (e) {
-        if (e instanceof Error) {
-          this.handleError(e);
-        }
-      }
-      const response = await fn(...args);
-      if (response === void 0 || response === null) {
-        return response;
-      }
-      if (response instanceof Response && !response.ok) {
-        return response;
-      }
-      try {
-        await this.setCacheValue(cacheKey, response, options);
-      } catch (e) {
-        if (e instanceof Error) {
-          this.handleError(e);
-        }
-      }
-      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 * MINUTE;
-    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) {
-    if (error.message === "timeout") {
-      return this.log.error("Cache timeout");
-    }
-    this.log.error(error);
-  }
-}
-exports.Cached = Cached;

package/dist/cache/index.cjs

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _cache = require("./cache.cjs");
-Object.keys(_cache).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _cache[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _cache[key];
-    }
-  });
-});
-var _cached = require("./cached.cjs");
-Object.keys(_cached).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _cached[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _cached[key];
-    }
-  });
-});