@scayle/storefront-core 7.31.0 → 7.32.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-core
 
+## 7.32.0
+
+### Minor Changes
+
+- Use new password change API when oauth is enabled
+
 ## 7.31.0
 
 ### Minor Changes

package/dist/api/oauth.cjs

@@ -4,6 +4,7 @@ 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");
@@ -25,10 +26,21 @@ function emptyOAuthResponseHandler(response) {
     throw new _fetch.FetchError(response);
   }
 }
+function getOAuthClient(context) {
+  const clientId = context.oauth?.clientId;
+  const clientSecret = context.oauth?.clientSecret;
+  const apiHost = context.oauth?.apiHost;
+  return new OAuthClient({
+    clientId,
+    clientSecret,
+    apiHost
+  }, context.log);
+}
 class OAuthClient {
   headers;
   baseURL;
-  constructor(options) {
+  logger;
+  constructor(options, logger) {
     const {
       clientId,
       clientSecret,
@@ -38,6 +50,7 @@ class OAuthClient {
       throw new MissingCredentialsError();
     }
     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}`,
@@ -50,6 +63,7 @@ class OAuthClient {
    * @param payload
    */
   async register(payload) {
+    this.logger?.debug("Registering user");
     return await fetch(`${this.baseURL}/auth/register`, {
       method: "POST",
       headers: this.headers,
@@ -61,6 +75,7 @@ class OAuthClient {
    * @param payload
    */
   async login(payload) {
+    this.logger?.debug("Logging in");
     return await fetch(`${this.baseURL}/auth/login`, {
       method: "POST",
       headers: this.headers,
@@ -72,6 +87,7 @@ class OAuthClient {
    * @param payload
    */
   async guestLogin(payload) {
+    this.logger?.debug("Logging in as guest");
     return await fetch(`${this.baseURL}/auth/login/guest`, {
       method: "POST",
       headers: this.headers,
@@ -83,6 +99,7 @@ class OAuthClient {
    * @param payload
    */
   async sendPasswordResetEmail(payload) {
+    this.logger?.debug("Sending password reset email");
     await fetch(`${this.baseURL}/auth/password/send-reset-email`, {
       method: "POST",
       headers: this.headers,
@@ -94,17 +111,35 @@ class OAuthClient {
    * @param payload
    */
   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 a user's password
+   * @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,
@@ -116,6 +151,7 @@ class OAuthClient {
    * @param accessToken
    */
   async validateToken(accessToken) {
+    this.logger?.debug("Validating access token");
     await fetch(`${this.baseURL}/oauth/token/validate`, {
       headers: {
         ...this.headers,
@@ -128,6 +164,7 @@ class OAuthClient {
    * @param accessToken
    */
   async revokeToken(accessToken) {
+    this.logger?.debug("Revoking access token");
     const decodedAccessToken = (0, _jose.decodeJwt)(accessToken);
     await fetch(`${this.baseURL}/oauth/tokens/${decodedAccessToken.jti}`, {
       method: "DELETE",

package/dist/api/oauth.d.ts

@@ -1,17 +1,21 @@
-import type { GuestRequest, LoginRequest, Oauth, RefreshTokenRequest, RegisterRequest, SendResetPasswordEmailRequest, UpdatePasswordByHashRequest } from '../types/api/auth';
+import type { GuestRequest, LoginRequest, Oauth, RefreshTokenRequest, RegisterRequest, SendResetPasswordEmailRequest, UpdatePasswordByHashRequest, UpdatePasswordRequest } from '../types/api/auth';
+import type { RpcContext } from '../types/api/context';
+import type { Log } from '../utils/log';
 export interface OAuthOptions {
     clientId: string;
     clientSecret: string;
     apiHost: string;
 }
+export declare function getOAuthClient(context: RpcContext): OAuthClient;
 /**
- * A client for interacting with the Checkout OAuth API
+ * A client for interacting with the Checkout Authentication API
  * Docs for all the routes: https://gitlab.com/aboutyou/checkout/schemas/checkout-auth-api/-/blob/main/build/openapi.yaml
  */
 export declare class OAuthClient {
     headers: HeadersInit;
     baseURL: string;
-    constructor(options: OAuthOptions);
+    logger?: Log;
+    constructor(options: OAuthOptions, logger?: Log);
     /**
      * Register a user and retrieve a token set
      * @param payload
@@ -39,6 +43,12 @@ export declare class OAuthClient {
      * @param payload
      */
     updatePasswordByHash(payload: UpdatePasswordByHashRequest): Promise<Oauth>;
+    /**
+     * Update a user's password
+     * @param payload
+     * @param accessToken
+     */
+    updatePassword(payload: UpdatePasswordRequest, accessToken: string): Promise<void>;
     /**
      * Generate a new access token via a refresh token
      * @param payload

package/dist/api/oauth.mjs

@@ -19,15 +19,23 @@ function emptyOAuthResponseHandler(response) {
     throw new FetchError(response);
   }
 }
+export function getOAuthClient(context) {
+  const clientId = context.oauth?.clientId;
+  const clientSecret = context.oauth?.clientSecret;
+  const apiHost = context.oauth?.apiHost;
+  return new OAuthClient({ clientId, clientSecret, apiHost }, context.log);
+}
 export class OAuthClient {
   headers;
   baseURL;
-  constructor(options) {
+  logger;
+  constructor(options, logger) {
     const { clientId, clientSecret, apiHost } = options;
     if (!clientId || !clientSecret) {
       throw new MissingCredentialsError();
     }
     this.baseURL = `${apiHost}/v1`;
+    this.logger = logger ? logger.space("auth-client") : void 0;
     const basicAuthHash = encodeBase64(`${clientId}:${clientSecret}`);
     this.headers = {
       Authorization: `Basic ${basicAuthHash}`,
@@ -40,6 +48,7 @@ export class OAuthClient {
    * @param payload
    */
   async register(payload) {
+    this.logger?.debug("Registering user");
     return await fetch(`${this.baseURL}/auth/register`, {
       method: "POST",
       headers: this.headers,
@@ -51,6 +60,7 @@ export class OAuthClient {
    * @param payload
    */
   async login(payload) {
+    this.logger?.debug("Logging in");
     return await fetch(`${this.baseURL}/auth/login`, {
       method: "POST",
       headers: this.headers,
@@ -62,6 +72,7 @@ export class OAuthClient {
    * @param payload
    */
   async guestLogin(payload) {
+    this.logger?.debug("Logging in as guest");
     return await fetch(`${this.baseURL}/auth/login/guest`, {
       method: "POST",
       headers: this.headers,
@@ -73,6 +84,7 @@ export class OAuthClient {
    * @param payload
    */
   async sendPasswordResetEmail(payload) {
+    this.logger?.debug("Sending password reset email");
     await fetch(`${this.baseURL}/auth/password/send-reset-email`, {
       method: "POST",
       headers: this.headers,
@@ -84,17 +96,35 @@ export class OAuthClient {
    * @param payload
    */
   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 a user's password
+   * @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,
@@ -106,6 +136,7 @@ export class OAuthClient {
    * @param accessToken
    */
   async validateToken(accessToken) {
+    this.logger?.debug("Validating access token");
     await fetch(`${this.baseURL}/oauth/token/validate`, {
       headers: {
         ...this.headers,
@@ -118,6 +149,7 @@ export class OAuthClient {
    * @param accessToken
    */
   async revokeToken(accessToken) {
+    this.logger?.debug("Revoking access token");
     const decodedAccessToken = decodeJwt(accessToken);
     await fetch(`${this.baseURL}/oauth/tokens/${decodedAccessToken.jti}`, {
       method: "DELETE",

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

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.updateShopUser = exports.updatePassword = void 0;
 var _customer = require("../../../api/customer.cjs");
+var _oauth = require("../../../api/oauth.cjs");
 var _fetch = require("../../../utils/fetch.cjs");
 var _httpStatus = require("../../../constants/httpStatus.cjs");
 const updateShopUser = exports.updateShopUser = async function updateShopUser2(payload, context) {
@@ -62,14 +63,25 @@ const updatePassword = exports.updatePassword = async function updatePassword2({
   newPassword
 }, context) {
   const shopUser = context.user;
-  const client = new _customer.CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const oauthEnabled = context.oauth.apiHost && context.oauth.clientId && context.oauth.clientSecret;
   try {
-    const user = client.updatePassword(context.shopId, {
+    if (oauthEnabled) {
+      const client2 = (0, _oauth.getOAuthClient)(context);
+      await client2.updatePassword({
+        password: oldPassword,
+        new_password: newPassword
+      }, context.accessToken);
+      return {
+        user: shopUser
+      };
+    }
+    const client = new _customer.CustomerAPIClient({
+      accessToken: context.accessToken,
+      refreshToken: context.refreshToken,
+      accessHeader: context.checkout.accessHeader,
+      baseUrl: context.checkout.url
+    });
+    const user = await client.updatePassword(context.shopId, {
       password: oldPassword,
       newPassword
     });

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

@@ -1,4 +1,5 @@
 import { CustomerAPIClient } from "../../../api/customer.mjs";
+import { getOAuthClient } from "../../../api/oauth.mjs";
 import { FetchError } from "../../../utils/fetch.mjs";
 import { HttpStatusCode } from "../../../constants/httpStatus.mjs";
 export const updateShopUser = async function updateShopUser2(payload, context) {
@@ -50,14 +51,26 @@ export const updateShopUser = async function updateShopUser2(payload, context) {
 };
 export const updatePassword = async function updatePassword2({ oldPassword, newPassword }, context) {
   const shopUser = context.user;
-  const client = new CustomerAPIClient({
-    accessToken: context.accessToken,
-    refreshToken: context.refreshToken,
-    accessHeader: context.checkout.accessHeader,
-    baseUrl: context.checkout.url
-  });
+  const oauthEnabled = context.oauth.apiHost && context.oauth.clientId && context.oauth.clientSecret;
   try {
-    const user = client.updatePassword(context.shopId, {
+    if (oauthEnabled) {
+      const client2 = getOAuthClient(context);
+      await client2.updatePassword(
+        {
+          password: oldPassword,
+          new_password: newPassword
+        },
+        context.accessToken
+      );
+      return { user: shopUser };
+    }
+    const client = new CustomerAPIClient({
+      accessToken: context.accessToken,
+      refreshToken: context.refreshToken,
+      accessHeader: context.checkout.accessHeader,
+      baseUrl: context.checkout.url
+    });
+    const user = await client.updatePassword(context.shopId, {
       password: oldPassword,
       newPassword
     });

package/dist/rpc/methods/session.cjs

@@ -16,16 +16,6 @@ const convertErrorForRpcCall = (error, httpStatuses) => {
   }
 };
 exports.convertErrorForRpcCall = convertErrorForRpcCall;
-function getOAuthClient(context) {
-  const clientId = context.oauth?.clientId ?? process.env.OAUTH_CLIENT_ID;
-  const clientSecret = context.oauth?.clientSecret ?? process.env.OAUTH_CLIENT_SECRET;
-  const apiHost = context.oauth?.apiHost ?? process.env.OAUTH_API_HOST;
-  return new _oauth.OAuthClient({
-    clientId,
-    clientSecret,
-    apiHost
-  });
-}
 const saveUserOnSession = async (accessToken, context) => {
   const user = await (0, _user2.fetchUser)({
     accessToken,
@@ -47,7 +37,7 @@ async function postLogin(context, tokens) {
 }
 const oauthLogin = async (login, context) => {
   const shopId = context.shopId;
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   if (!login.email || !login.password) {
     throw new Error("Login or password are missing, seems like validation has failed");
   }
@@ -67,7 +57,7 @@ const oauthLogin = async (login, context) => {
 exports.oauthLogin = oauthLogin;
 const oauthRegister = async (register, context) => {
   const shopId = context.shopId;
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   try {
     const tokens = await client.register({
       ...register,
@@ -84,7 +74,7 @@ const oauthRegister = async (register, context) => {
 exports.oauthRegister = oauthRegister;
 const oauthGuestLogin = async (guest, context) => {
   const shopId = context.shopId;
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   try {
     const tokens = client.guestLogin({
       ...guest,
@@ -101,7 +91,7 @@ const oauthGuestLogin = async (guest, context) => {
 exports.oauthGuestLogin = oauthGuestLogin;
 const refreshAccessToken = async context => {
   const refreshToken = context.refreshToken;
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   if (!refreshToken) {
     throw new Error("No app refresh token provided");
   }
@@ -130,7 +120,7 @@ const oauthRevokeToken = async context => {
   if (!accessToken) {
     throw new Error("No app oauth authentication credentials");
   }
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   await context.destroySession();
   try {
     await client.revokeToken(accessToken);
@@ -152,7 +142,7 @@ const oauthForgetPassword = async ({
   email
 }, context) => {
   const shopId = context.shopId;
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   try {
     const resetUrl = new URL(context.auth.resetPasswordUrl);
     if (!resetUrl.searchParams.has("hash")) {
@@ -181,7 +171,7 @@ const oauthForgetPassword = async ({
 exports.oauthForgetPassword = oauthForgetPassword;
 const updatePasswordByHash = async (passwordHash, context) => {
   const shopId = context.shopId;
-  const client = getOAuthClient(context);
+  const client = (0, _oauth.getOAuthClient)(context);
   try {
     const tokens = await client.updatePasswordByHash({
       ...passwordHash,

package/dist/rpc/methods/session.mjs

@@ -3,18 +3,12 @@ import { DEFAULT_WITH_LISTING, HttpStatusCode } from "../../constants/index.mjs"
 import { FetchError } from "../../utils/fetch.mjs";
 import { mergeBaskets, mergeWishlists } from "../../utils/user.mjs";
 import { fetchUser } from "../../rpc/methods/user.mjs";
-import { OAuthClient } from "../../api/oauth.mjs";
+import { getOAuthClient } from "../../api/oauth.mjs";
 export const convertErrorForRpcCall = (error, httpStatuses) => {
   if (error instanceof FetchError && httpStatuses.includes(error.response.status)) {
     return error;
   }
 };
-function getOAuthClient(context) {
-  const clientId = context.oauth?.clientId ?? process.env.OAUTH_CLIENT_ID;
-  const clientSecret = context.oauth?.clientSecret ?? process.env.OAUTH_CLIENT_SECRET;
-  const apiHost = context.oauth?.apiHost ?? process.env.OAUTH_API_HOST;
-  return new OAuthClient({ clientId, clientSecret, apiHost });
-}
 const saveUserOnSession = async (accessToken, context) => {
   const user = await fetchUser({ accessToken, callback: "" }, context);
   context.updateUser(user);

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

@@ -55,6 +55,10 @@ export interface UpdatePasswordByHashRequest {
     hash: string;
     shop_id: number;
 }
+export interface UpdatePasswordRequest {
+    password: string;
+    new_password: string;
+}
 export interface RefreshTokenRequest {
     grant_type: 'refresh_token';
     refresh_token: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.31.0",
+  "version": "7.32.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -70,10 +70,10 @@
     "@scayle/prettier-config-storefront": "2.0.2",
     "@types/crypto-js": "4.2.1",
     "@types/jest": "29.5.11",
-    "@types/node": "20.10.4",
+    "@types/node": "20.10.5",
     "@types/webpack-env": "1.18.4",
     "unbuild": "2.0.0",
-    "eslint": "8.55.0",
+    "eslint": "8.56.0",
     "eslint-formatter-gitlab": "5.1.0",
     "jest": "29.7.0",
     "jest-junit": "16.0.0",