@scayle/storefront-core 7.34.1 → 7.36.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scayle/storefront-core
 
+## 7.36.0
+
+### Minor Changes
+
+- Support `Response` returns in RPC methods
+- Handle 401 from CO and delete session
+
+## 7.35.0
+
+### Minor Changes
+
+- Change `oauthForgetPassword` payload signature to accept `email` only
+
 ## 7.34.1
 
 ### Patch Changes

package/dist/api/customer.cjs

@@ -7,17 +7,16 @@ exports.CustomerAPIClient = void 0;
 var _fetch = require("../utils/fetch.cjs");
 var _httpStatus = require("../constants/httpStatus.cjs");
 class CustomerAPIClient {
-  headers;
   baseURL;
-  constructor(options) {
-    const {
-      accessToken,
-      accessHeader,
-      baseUrl
-    } = options;
-    this.baseURL = baseUrl;
-    this.headers = {
-      Authorization: `Bearer ${accessToken}`,
+  context;
+  constructor(context) {
+    this.baseURL = context.checkout.url;
+    this.context = context;
+  }
+  get headers() {
+    const accessHeader = this.context.checkout.accessHeader;
+    return {
+      Authorization: `Bearer ${this.context.accessToken}`,
       Accept: "application/json",
       "Content-Type": "application/json",
       ...(accessHeader ? {
@@ -27,6 +26,10 @@ 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();
+      }
       throw new _fetch.FetchError(response);
     }
     return await response.json();

package/dist/api/customer.d.ts

@@ -1,19 +1,4 @@
-import type { ShopUserAddress, Order, ShopUser, Gender } from '../types';
-interface CustomerAPIOptions {
-    /**
-     * The OAuth Access Token
-     */
-    accessToken: string;
-    /**
-     * The OAuth Refresh Token
-     */
-    refreshToken: string;
-    accessHeader: string;
-    /**
-     * The Checkout Host
-     */
-    baseUrl: string;
-}
+import type { ShopUserAddress, Order, ShopUser, Gender, RpcContext } from '../types';
 interface PaginatedResponse<EntityType> {
     entities: EntityType[];
     pagination: {
@@ -50,9 +35,10 @@ interface PasswordUpdate {
  * @see https://scayle.dev/api/oauth/latest
  */
 export declare class CustomerAPIClient {
-    headers: HeadersInit;
     baseURL: string;
-    constructor(options: CustomerAPIOptions);
+    context: RpcContext;
+    constructor(context: RpcContext);
+    get headers(): HeadersInit;
     handleResponse<BodyType>(response: Response): Promise<BodyType>;
     /**
      * Get the addresses for the current customer

package/dist/api/customer.mjs

@@ -1,13 +1,16 @@
 import { FetchError } from "../utils/fetch.mjs";
 import { HttpStatusCode } from "../constants/httpStatus.mjs";
 export class CustomerAPIClient {
-  headers;
   baseURL;
-  constructor(options) {
-    const { accessToken, accessHeader, baseUrl } = options;
-    this.baseURL = baseUrl;
-    this.headers = {
-      Authorization: `Bearer ${accessToken}`,
+  context;
+  constructor(context) {
+    this.baseURL = context.checkout.url;
+    this.context = context;
+  }
+  get headers() {
+    const accessHeader = this.context.checkout.accessHeader;
+    return {
+      Authorization: `Bearer ${this.context.accessToken}`,
       Accept: "application/json",
       "Content-Type": "application/json",
       ...accessHeader ? { "X-Access-Header": accessHeader } : {}
@@ -15,6 +18,10 @@ export class CustomerAPIClient {
   }
   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();
+      }
       throw new FetchError(response);
     }
     return await response.json();

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

@@ -21,12 +21,7 @@ const getOrderById = exports.getOrderById = async function getOrderById2({
   if (!isOrderInUserOrderlist) {
     throw new Error("Order not belonging to current user");
   }
-  const client = new _customer.CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new _customer.CustomerAPIClient(context);
   try {
     return await client.getOrder(context.shopId, orderId);
   } catch (error) {

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

@@ -15,12 +15,7 @@ export const getOrderById = async function getOrderById2({ orderId }, context) {
   if (!isOrderInUserOrderlist) {
     throw new Error("Order not belonging to current user");
   }
-  const client = new CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new CustomerAPIClient(context);
   try {
     return await client.getOrder(context.shopId, orderId);
   } catch (error) {

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

@@ -28,12 +28,7 @@ const updateShopUser = exports.updateShopUser = async function updateShopUser2(p
     ...context.user,
     ...updatedUser
   };
-  const client = new _customer.CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new _customer.CustomerAPIClient(context);
   try {
     await Promise.all([client.updateContactInfo(shopId, {
       email: user.email,
@@ -75,12 +70,7 @@ const updatePassword = exports.updatePassword = async function updatePassword2({
         user: shopUser
       };
     }
-    const client = new _customer.CustomerAPIClient({
-      accessToken: context.accessToken,
-      refreshToken: context.refreshToken,
-      accessHeader: context.checkout.accessHeader,
-      baseUrl: context.checkout.url
-    });
+    const client = new _customer.CustomerAPIClient(context);
     const user = await client.updatePassword(context.shopId, {
       password: oldPassword,
       newPassword

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

@@ -22,12 +22,7 @@ export const updateShopUser = async function updateShopUser2(payload, context) {
     ...context.user,
     ...updatedUser
   };
-  const client = new CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new CustomerAPIClient(context);
   try {
     await Promise.all([
       client.updateContactInfo(shopId, {
@@ -64,12 +59,7 @@ export const updatePassword = async function updatePassword2({ oldPassword, newP
       );
       return { user: shopUser };
     }
-    const client = new CustomerAPIClient({
-      accessToken: context.accessToken,
-      refreshToken: context.refreshToken,
-      accessHeader: context.checkout.accessHeader,
-      baseUrl: context.checkout.url
-    });
+    const client = new CustomerAPIClient(context);
     const user = await client.updatePassword(context.shopId, {
       password: oldPassword,
       newPassword

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

@@ -7,11 +7,6 @@ exports.getShopUserAddresses = void 0;
 var _customer = require("../../../api/customer.cjs");
 const getShopUserAddresses = exports.getShopUserAddresses = async function getShopUserAddresses2(context) {
   const shopId = context.shopId;
-  const client = new _customer.CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new _customer.CustomerAPIClient(context);
   return (await client.getAddresses(shopId)).entities;
 };

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

@@ -1,12 +1,7 @@
 import { CustomerAPIClient } from "../../../api/customer.mjs";
 const getShopUserAddresses = async function getShopUserAddresses2(context) {
   const shopId = context.shopId;
-  const client = new CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new CustomerAPIClient(context);
   return (await client.getAddresses(shopId)).entities;
 };
 export { getShopUserAddresses };

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

@@ -1,5 +1,5 @@
 import type { Optional } from 'utility-types';
-import type { GuestRequest, LoginRequest, ParamRpcHandler, RegisterRequest, RpcHandler, SendResetPasswordEmailRequest, UpdatePasswordByHashRequest } from '../../types';
+import type { GuestRequest, LoginRequest, ParamRpcHandler, RegisterRequest, RpcHandler, UpdatePasswordByHashRequest } from '../../types';
 /**
  * Ensure error is a fetch error with one of the status codes
  */
@@ -13,7 +13,9 @@ export declare const refreshAccessToken: RpcHandler<{
 export declare const oauthRevokeToken: RpcHandler<{
     result: boolean;
 }>;
-export declare const oauthForgetPassword: RpcHandler<SendResetPasswordEmailRequest, {
+export declare const oauthForgetPassword: RpcHandler<{
+    email: string;
+}, {
     success: boolean;
 }>;
 export declare const updatePasswordByHash: ParamRpcHandler<Optional<UpdatePasswordByHashRequest, 'shop_id'>, undefined>;

package/dist/rpc/methods/user.cjs

@@ -17,12 +17,7 @@ const fetchUser = exports.fetchUser = async function fetchUser2(payload, context
   const {
     shopId
   } = context;
-  const client = new _customer.CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new _customer.CustomerAPIClient(context);
   const user = await client.getMe(shopId);
   return {
     ...user,
@@ -40,12 +35,7 @@ const refreshUser = exports.refreshUser = async function refreshUser2(context) {
     accessToken,
     shopId
   } = context;
-  const client = new _customer.CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new _customer.CustomerAPIClient(context);
   const user = await client.getMe(shopId);
   if (user?.id) {
     context.updateUser({

package/dist/rpc/methods/user.mjs

@@ -7,12 +7,7 @@ const getUser = function getUser2(context) {
 const fetchUser = async function fetchUser2(payload, context) {
   const { accessToken } = payload;
   const { shopId } = context;
-  const client = new CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new CustomerAPIClient(context);
   const user = await client.getMe(shopId);
   return {
     ...user,
@@ -25,12 +20,7 @@ const fetchUser = async function fetchUser2(payload, context) {
 };
 const refreshUser = async function refreshUser2(context) {
   const { accessToken, shopId } = context;
-  const client = new CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const client = new CustomerAPIClient(context);
   const user = await client.getMe(shopId);
   if (user?.id) {
     context.updateUser({

package/dist/rpc/methods/wishlist.cjs

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.removeItemFromWishlist = exports.getWishlist = exports.clearWishlist = exports.addItemToWishlist = void 0;
-var _errors = require("../../errors/index.cjs");
 var _constants = require("../../constants/index.cjs");
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.basket ?? _constants.MIN_WITH_PARAMS_WISHLIST;
@@ -41,7 +40,11 @@ const addItemToWishlist = exports.addItemToWishlist = async function addItemToWi
       message
     } = result.wishlist;
     context.log.error("Adding to wishlist failed", result.wishlist);
-    throw new _errors.BAPIError("BAPI ERROR", code, message, "bapiClient.wishlist.addItem");
+    return new Response(JSON.stringify({
+      message
+    }), {
+      status: code
+    });
   }
 };
 const getWishlist = exports.getWishlist = async function getWishlist2(options, context) {

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

@@ -1,10 +1,10 @@
 import type { WishlistResponseData } from '@aboutyou/backbone/endpoints/wishlist/getWishlist';
-import { RpcHandler, WishlistWithOptions } from '../../types';
-export declare const addItemToWishlist: RpcHandler<{
+import { RpcHandler, ParamRpcHandler, WishlistWithOptions } from '../../types';
+export declare const addItemToWishlist: ParamRpcHandler<{
     variantId?: number;
     productId?: number;
     with?: WishlistWithOptions;
-}, WishlistResponseData>;
+}, WishlistResponseData | Response>;
 export declare const getWishlist: RpcHandler<WishlistWithOptions | undefined, WishlistResponseData>;
 export declare const removeItemFromWishlist: RpcHandler<{
     itemKey: string;

package/dist/rpc/methods/wishlist.mjs

@@ -1,4 +1,3 @@
-import { BAPIError } from "../../errors/index.mjs";
 import { MIN_WITH_PARAMS_WISHLIST } from "../../constants/index.mjs";
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.basket ?? MIN_WITH_PARAMS_WISHLIST;
@@ -25,12 +24,7 @@ export const addItemToWishlist = async function addItemToWishlist2(options, cont
   } else {
     const { code, message } = result.wishlist;
     context.log.error("Adding to wishlist failed", result.wishlist);
-    throw new BAPIError(
-      "BAPI ERROR",
-      code,
-      message,
-      "bapiClient.wishlist.addItem"
-    );
+    return new Response(JSON.stringify({ message }), { status: code });
   }
 };
 export const getWishlist = async function getWishlist2(options, context) {

package/dist/types/api/rpc.d.ts

@@ -1,4 +1,4 @@
 import { RpcContext } from './context';
-export type ParamRpcHandler<Params extends Record<string, any>, Response> = (params: Params, context: RpcContext) => Promise<Response> | Response;
-export type NoParamRpcHandler<Response> = (context: RpcContext) => Promise<Response> | Response;
+export type ParamRpcHandler<Params extends Record<string, any>, ResponseType> = (params: Params, context: RpcContext) => Promise<ResponseType> | ResponseType;
+export type NoParamRpcHandler<ResponseType> = (context: RpcContext) => Promise<ResponseType> | ResponseType;
 export type RpcHandler<A, B = void> = B extends void ? NoParamRpcHandler<A> : ParamRpcHandler<A, B>;

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

@@ -105,6 +105,23 @@ export type NumberOfInstallmentsChosenByTheCustomerForTheOrder = number;
 export type IfTrueTheCustomerElectedToHaveADelayInPaymentCapture = boolean;
 export type TimestampOfOrderCreation = string;
 export type TimestampOfLastOrderUpdate = string;
+export interface ThisFieldHoldsDetailsAboutTheIncludedVATTax {
+    amount: TheIncludedVATAmount;
+    rate: TheIncludedVATRateInPercentAsIntegerRepresentation;
+}
+/**
+ * When an item cannot be shipped within the regular delivery timeframe, and the warehouse is already aware of this, prior to the customer placing the order (ie it is not an unintentionally delayed delivery). This is generally the case when the item is out of stock and: the warehouse is waiting for incoming returns to restock the item, the warehouse has ordered fresh stocks from the supplier/manufacturer and is waiting for these to be shipped to the warehouse.
+ */
+export interface DeliveryForecastFromWarehouse {
+    deliverable?: {
+        key?: string;
+        [k: string]: unknown;
+    };
+    subsequentDelivery?: {
+        key?: 'endOfJanuary' | 'endOfFebruary' | 'endOfMarch' | 'endOfApril' | 'endOfMay' | 'endOfJune' | 'endOfJuly' | 'endOfAugust' | 'endOfSeptember' | 'endOfOctober' | 'endOfNovember' | 'endOfDecember' | 'midOfJanuary' | 'midOfFebruary' | 'midOfMarch' | 'midOfApril' | 'midOfMay' | 'midOfJune' | 'midOfJuly' | 'midOfAugust' | 'midOfSeptember' | 'midOfOctober' | 'midOfNovember' | 'midOfDecember' | 'easter' | 'christmas' | 'available' | 'directShipping' | 'outsold';
+        [k: string]: unknown;
+    };
+}
 export interface Order {
     /**
      * This `id` can be applied as a parameter on the url to retrieve an individual order in the [Fetch Order by ID](#fetch-order-by-id) endpoint.
@@ -535,20 +552,3 @@ export interface Order {
     createdAt: TimestampOfOrderCreation;
     updatedAt: TimestampOfLastOrderUpdate;
 }
-export interface ThisFieldHoldsDetailsAboutTheIncludedVATTax {
-    amount: TheIncludedVATAmount;
-    rate: TheIncludedVATRateInPercentAsIntegerRepresentation;
-}
-/**
- * When an item cannot be shipped within the regular delivery timeframe, and the warehouse is already aware of this, prior to the customer placing the order (ie it is not an unintentionally delayed delivery). This is generally the case when the item is out of stock and: the warehouse is waiting for incoming returns to restock the item, the warehouse has ordered fresh stocks from the supplier/manufacturer and is waiting for these to be shipped to the warehouse.
- */
-export interface DeliveryForecastFromWarehouse {
-    deliverable?: {
-        key?: string;
-        [k: string]: unknown;
-    };
-    subsequentDelivery?: {
-        key?: 'endOfJanuary' | 'endOfFebruary' | 'endOfMarch' | 'endOfApril' | 'endOfMay' | 'endOfJune' | 'endOfJuly' | 'endOfAugust' | 'endOfSeptember' | 'endOfOctober' | 'endOfNovember' | 'endOfDecember' | 'midOfJanuary' | 'midOfFebruary' | 'midOfMarch' | 'midOfApril' | 'midOfMay' | 'midOfJune' | 'midOfJuly' | 'midOfAugust' | 'midOfSeptember' | 'midOfOctober' | 'midOfNovember' | 'midOfDecember' | 'easter' | 'christmas' | 'available' | 'directShipping' | 'outsold';
-        [k: string]: unknown;
-    };
-}

package/dist/utils/response.cjs

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unwrap = unwrap;
+async function unwrap(response) {
+  if (response instanceof Response) {
+    console.log("unwrapping for ", response.url);
+    return await response.json();
+  }
+  return response;
+}

package/dist/utils/response.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Unwrap a possible response into its body
+ * @param x
+ * @returns
+ */
+export declare function unwrap<T>(response: Response | T): Promise<T>;

package/dist/utils/response.mjs

@@ -0,0 +1,7 @@
+export async function unwrap(response) {
+  if (response instanceof Response) {
+    console.log("unwrapping for ", response.url);
+    return await response.json();
+  }
+  return response;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.34.1",
+  "version": "7.36.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -59,7 +59,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
-    "@aboutyou/backbone": "16.0.1",
+    "@aboutyou/backbone": "16.0.2",
     "crypto-js": "4.2.0",
     "jose": "^4.14.4",
     "radash": "^11.0.0",
@@ -72,9 +72,9 @@
     "@scayle/eslint-config-storefront": "3.2.6",
     "@scayle/prettier-config-storefront": "2.0.2",
     "@types/crypto-js": "4.2.1",
-    "@types/node": "20.10.6",
+    "@types/node": "20.10.7",
     "@types/webpack-env": "1.18.4",
-    "@vitest/coverage-v8": "1.1.1",
+    "@vitest/coverage-v8": "1.1.3",
     "eslint": "8.56.0",
     "eslint-formatter-gitlab": "5.1.0",
     "prettier": "3.0.0",
@@ -84,7 +84,7 @@
     "typescript": "5.3.3",
     "unbuild": "2.0.0",
     "unstorage": "1.10.1",
-    "vitest": "1.1.1"
+    "vitest": "1.1.3"
   },
   "optionalDependencies": {
     "redis": "4"