@scayle/storefront-core 7.54.0 → 7.56.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @scayle/storefront-core
 
+## 7.56.0
+
+### Minor Changes
+
+- Add refresh token logic to customer API client
+
+### Patch Changes
+
+- Ensure `user.storefrontAccessToken` is up to date when calling the `getUser` RPC
+
+## 7.55.0
+
+### Minor Changes
+
+- Allow disabling the `HashAlgorithm` by setting its value to `none` within a shop config.
+- Added exports for `ProductSortConfig` type and enums `APISortOption` and `APISortOrder`.
+
 ## 7.54.0
 
 ### Minor Changes

package/dist/api/README.md

@@ -0,0 +1,7 @@
+# Storefront Core API Clients
+
+## Overview
+
+This directory is the home of "mini" API clients. While some SCAYLE APIs provide a TypeScript SDK as an npm package (e.g. SAPI) others do not. When the API is simple enough, we may create a "mini" SDK within `storefront-core`. This way we can provide a TypeScript native abstraction over the API but not suffer the overhead of an additional package to maintain.
+
+The SDKs created here should generally be a single file. The goal should be to make them as self-contained as possible, but it is ok if they need to pull a type or utility function from elsewhere in `storefront-core`.

package/dist/api/customer.cjs

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 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;
@@ -24,26 +25,39 @@ class CustomerAPIClient {
       } : {})
     };
   }
-  async handleResponse(response) {
-    if (!response.ok) {
-      if (response.status === _httpStatus.HttpStatusCode.UNAUTHORIZED && this.context.accessToken) {
-        this.context.log.debug("Invalid Checkout Token. Deleting session");
-        await this.context.destroySession();
+  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);
+        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
+        });
+        return await this.sendRequest(request, false);
       }
-      throw new _fetch.FetchError(response);
+      this.context.log.debug("Invalid Checkout Token. Deleting session");
+      await this.context.destroySession();
     }
-    return await response.json();
+    throw new _fetch.FetchError(response);
   }
   /**
    * Get the addresses for the current customer
    */
   async getAddresses(shopId) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/addresses`, {
+    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/addresses`, {
       headers: {
         ...this.headers,
         "X-Shop-Id": shopId.toString()
       }
-    }).then(response => this.handleResponse(response));
+    }));
   }
   /**
    * Returns customer data and latest orders.
@@ -51,7 +65,7 @@ class CustomerAPIClient {
    * @see https://scayle.dev/api/oauth/latest/fetch-authorized-payload
    */
   async getMe(shopId, accessToken) {
-    const response = await fetch(`${this.baseURL}/api/oauth/me`, {
+    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/me`, {
       headers: {
         ...this.headers,
         ...(accessToken ? {
@@ -59,20 +73,19 @@ class CustomerAPIClient {
         } : {}),
         "X-Shop-Id": shopId.toString()
       }
-    });
-    return this.handleResponse(response);
+    }));
   }
   /**
    * Fetch a customer's order
    * @see https://scayle.dev/api/oauth/latest/fetch-order-by-id
    */
   async getOrder(shopId, orderId) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/order/${orderId}`, {
+    return this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/order/${orderId}`, {
       headers: {
         ...this.headers,
         "X-Shop-Id": shopId.toString()
       }
-    }).then(response => this.handleResponse(response));
+    }));
   }
   /**
    * Update the customer's contact details
@@ -83,7 +96,7 @@ class CustomerAPIClient {
     email,
     phone
   }) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/contact`, {
+    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/contact`, {
       method: "PUT",
       headers: {
         ...this.headers,
@@ -93,20 +106,20 @@ class CustomerAPIClient {
         email,
         phone
       })
-    }).then(response => this.handleResponse(response));
+    }));
   }
   /**
    * Update the customer's personal details
    */
   async updatePersonalInfo(shopId, payload) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/personal`, {
+    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)
-    }).then(response => this.handleResponse(response));
+    }));
   }
   /**
    * Update the customer's password
@@ -117,7 +130,7 @@ class CustomerAPIClient {
     password,
     newPassword
   }) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/password`, {
+    return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/password`, {
       method: "PUT",
       headers: {
         ...this.headers,
@@ -127,7 +140,7 @@ class CustomerAPIClient {
         password,
         newPassword
       })
-    }).then(response => this.handleResponse(response));
+    }));
   }
 }
 exports.CustomerAPIClient = CustomerAPIClient;

package/dist/api/customer.d.ts

@@ -39,7 +39,7 @@ export declare class CustomerAPIClient {
     context: RpcContext;
     constructor(context: RpcContext);
     get headers(): HeadersInit;
-    handleResponse<BodyType>(response: Response): Promise<BodyType>;
+    sendRequest<BodyType>(request: () => Promise<Response>, retry?: boolean): Promise<BodyType>;
     /**
      * Get the addresses for the current customer
      */

package/dist/api/customer.mjs

@@ -1,5 +1,6 @@
 import { FetchError } from "../utils/fetch.mjs";
 import { HttpStatusCode } from "../constants/httpStatus.mjs";
+import { getOAuthClient } from "./oauth.mjs";
 export class CustomerAPIClient {
   baseURL;
   context;
@@ -16,27 +17,42 @@ export class CustomerAPIClient {
       ...accessHeader ? { "X-Access-Header": accessHeader } : {}
     };
   }
-  async handleResponse(response) {
-    if (!response.ok) {
-      if (response.status === HttpStatusCode.UNAUTHORIZED && this.context.accessToken) {
-        this.context.log.debug("Invalid Checkout Token. Deleting session");
-        await this.context.destroySession();
+  async sendRequest(request, retry = true) {
+    const response = await request();
+    if (response.ok) {
+      return await response.json();
+    }
+    if ((response.status === HttpStatusCode.UNAUTHORIZED && response.headers.get("WWW-Authenticate")?.includes(
+      "invalid_token"
+    ) || response.status === HttpStatusCode.FORBIDDEN) && this.context.accessToken && this.context.refreshToken) {
+      if (retry) {
+        const client = getOAuthClient(this.context);
+        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
+        });
+        return await this.sendRequest(request, false);
       }
-      throw new FetchError(response);
+      this.context.log.debug("Invalid Checkout Token. Deleting session");
+      await this.context.destroySession();
     }
-    return await response.json();
+    throw new FetchError(response);
   }
   /**
    * Get the addresses for the current customer
    */
   async getAddresses(shopId) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/addresses`, {
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      }
-    }).then(
-      (response) => this.handleResponse(response)
+    return await this.sendRequest(
+      () => fetch(`${this.baseURL}/api/oauth/customer/addresses`, {
+        headers: {
+          ...this.headers,
+          "X-Shop-Id": shopId.toString()
+        }
+      })
     );
   }
   /**
@@ -45,26 +61,29 @@ export class CustomerAPIClient {
    * @see https://scayle.dev/api/oauth/latest/fetch-authorized-payload
    */
   async getMe(shopId, accessToken) {
-    const response = await fetch(`${this.baseURL}/api/oauth/me`, {
-      headers: {
-        ...this.headers,
-        ...accessToken ? { Authorization: `Bearer ${accessToken}` } : {},
-        "X-Shop-Id": shopId.toString()
-      }
-    });
-    return this.handleResponse(response);
+    return await this.sendRequest(
+      () => fetch(`${this.baseURL}/api/oauth/me`, {
+        headers: {
+          ...this.headers,
+          ...accessToken ? { Authorization: `Bearer ${accessToken}` } : {},
+          "X-Shop-Id": shopId.toString()
+        }
+      })
+    );
   }
   /**
    * Fetch a customer's order
    * @see https://scayle.dev/api/oauth/latest/fetch-order-by-id
    */
   async getOrder(shopId, orderId) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/order/${orderId}`, {
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      }
-    }).then((response) => this.handleResponse(response));
+    return this.sendRequest(
+      () => fetch(`${this.baseURL}/api/oauth/customer/order/${orderId}`, {
+        headers: {
+          ...this.headers,
+          "X-Shop-Id": shopId.toString()
+        }
+      })
+    );
   }
   /**
    * Update the customer's contact details
@@ -72,30 +91,34 @@ export class CustomerAPIClient {
    * @see https://scayle.dev/api/oauth/latest/put-customer-contact
    */
   async updateContactInfo(shopId, { email, phone }) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/contact`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      },
-      body: JSON.stringify({
-        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
+        })
       })
-    }).then((response) => this.handleResponse(response));
+    );
   }
   /**
    * Update the customer's personal details
    */
   async updatePersonalInfo(shopId, payload) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/personal`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      },
-      body: JSON.stringify(payload)
-    }).then((response) => this.handleResponse(response));
+    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 the customer's password
@@ -103,13 +126,15 @@ export class CustomerAPIClient {
    * @see https://scayle.dev/api/oauth/latest/put-customer-password
    */
   async updatePassword(shopId, { password, newPassword }) {
-    return await fetch(`${this.baseURL}/api/oauth/customer/password`, {
-      method: "PUT",
-      headers: {
-        ...this.headers,
-        "X-Shop-Id": shopId.toString()
-      },
-      body: JSON.stringify({ password, newPassword })
-    }).then((response) => this.handleResponse(response));
+    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 })
+      })
+    );
   }
 }

package/dist/constants/hash.cjs

@@ -6,5 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.HashAlgorithm = void 0;
 const HashAlgorithm = exports.HashAlgorithm = {
   MD5: "md5",
-  SHA256: "sha256"
+  SHA256: "sha256",
+  NONE: "none"
 };

package/dist/constants/hash.d.ts

@@ -2,5 +2,6 @@ import type { ValuesType } from 'utility-types';
 export declare const HashAlgorithm: {
     readonly MD5: "md5";
     readonly SHA256: "sha256";
+    readonly NONE: "none";
 };
 export type HashAlgorithm = ValuesType<typeof HashAlgorithm> | null;

package/dist/constants/hash.mjs

@@ -1,4 +1,5 @@
 export const HashAlgorithm = {
   MD5: "md5",
-  SHA256: "sha256"
+  SHA256: "sha256",
+  NONE: "none"
 };

package/dist/index.cjs

@@ -4,8 +4,22 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  rpcMethods: true
+  rpcMethods: true,
+  APISortOption: true,
+  APISortOrder: true
 };
+Object.defineProperty(exports, "APISortOption", {
+  enumerable: true,
+  get: function () {
+    return _storefrontApi.APISortOption;
+  }
+});
+Object.defineProperty(exports, "APISortOrder", {
+  enumerable: true,
+  get: function () {
+    return _storefrontApi.APISortOrder;
+  }
+});
 exports.rpcMethods = void 0;
 var rpcMethods = _interopRequireWildcard(require("./rpc/methods/index.cjs"));
 exports.rpcMethods = rpcMethods;
@@ -81,5 +95,6 @@ Object.keys(_types).forEach(function (key) {
     }
   });
 });
+var _storefrontApi = require("@scayle/storefront-api");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }

package/dist/index.d.ts

@@ -17,3 +17,4 @@ export type RpcMethodName = Resolve<keyof RpcMethods>;
 export type RpcMethod<N extends RpcMethodName> = RpcMethods[N];
 export type RpcMethodParameters<N extends RpcMethodName> = Parameters<RpcMethod<N>>[0];
 export type RpcMethodReturnType<N extends RpcMethodName> = ReturnType<RpcMethod<N>>;
+export { APISortOption, APISortOrder, type ProductSortConfig, } from '@scayle/storefront-api';

package/dist/index.mjs

@@ -6,3 +6,7 @@ export * from "./constants/index.mjs";
 export * from "./cache/index.mjs";
 export * from "./helpers/index.mjs";
 export * from "./types/index.mjs";
+export {
+  APISortOption,
+  APISortOrder
+} from "@scayle/storefront-api";

package/dist/rpc/methods/checkout/checkout.cjs

@@ -24,7 +24,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.53.0"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.55.0"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

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

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

package/dist/rpc/methods/user.cjs

@@ -7,8 +7,20 @@ exports.refreshUser = exports.getUser = exports.fetchUser = void 0;
 var _types = require("../../types/index.cjs");
 var _customer = require("../../api/customer.cjs");
 const getUser = exports.getUser = function getUser2(context) {
+  const {
+    user,
+    accessToken,
+    shopId
+  } = context;
+  if (user) {
+    user.authentication = user.authentication ?? {
+      type: "idp"
+    };
+    user.authentication.storefrontAccessToken = accessToken;
+    user.loginShopId = shopId;
+  }
   return {
-    user: context.user
+    user
   };
 };
 const fetchUser = exports.fetchUser = async function fetchUser2(payload, context) {

package/dist/rpc/methods/user.mjs

@@ -1,8 +1,16 @@
 import { assertSession } from "../../types/index.mjs";
 import { CustomerAPIClient } from "../../api/customer.mjs";
 const getUser = function getUser2(context) {
+  const { user, accessToken, shopId } = context;
+  if (user) {
+    user.authentication = user.authentication ?? {
+      type: "idp"
+    };
+    user.authentication.storefrontAccessToken = accessToken;
+    user.loginShopId = shopId;
+  }
   return {
-    user: context.user
+    user
   };
 };
 const fetchUser = async function fetchUser2(payload, context) {

package/dist/types/bapi/sorting.cjs

@@ -1,5 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+"use strict";

package/dist/types/bapi/sorting.d.ts

@@ -1,6 +1,5 @@
 import type { APISortOption, APISortOrder } from '@scayle/storefront-api';
 import type { SortName, SortQuery } from '../../constants';
-export { APISortOption, APISortOrder };
 export type SortingValueKey = 'topSeller' | 'dateNewest' | 'priceDesc' | 'priceAsc' | 'reductionDesc' | 'reductionAsc';
 export interface SortValue {
     name: SortName;

package/dist/types/bapi/sorting.mjs

@@ -1 +0,0 @@
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.54.0",
+  "version": "7.56.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -71,10 +71,10 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.2.0",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "20.14.1",
+    "@types/node": "20.14.2",
     "@types/webpack-env": "1.18.5",
     "@vitest/coverage-v8": "1.6.0",
-    "dprint": "0.46.1",
+    "dprint": "0.46.2",
     "eslint": "9.4.0",
     "eslint-formatter-gitlab": "5.1.0",
     "publint": "0.2.8",