feat: reset password feature

api/composables.api.md

@@ -12,6 +12,7 @@ import { Customer } from '@shopware-pwa/commons/interfaces/models/checkout/custo
 import { CustomerAddress } from '@shopware-pwa/commons/interfaces/models/checkout/customer/CustomerAddress';
 import { CustomerAddressParam } from '@shopware-pwa/shopware-6-client';
 import { CustomerRegistrationParams } from '@shopware-pwa/commons/interfaces/request/CustomerRegistrationParams';
+import { CustomerResetPasswordParam } from '@shopware-pwa/shopware-6-client';
 import { CustomerUpdateEmailParam } from '@shopware-pwa/shopware-6-client';
 import { CustomerUpdatePasswordParam } from '@shopware-pwa/shopware-6-client';
 import { CustomerUpdateProfileParam } from '@shopware-pwa/shopware-6-client';
@@ -300,6 +301,8 @@ export interface UseUser {
     // (undocumented)
     register: ({}: CustomerRegistrationParams) => Promise<boolean>;
     // (undocumented)
+    resetPassword: (resetPasswordData: CustomerResetPasswordParam) => Promise<boolean>;
+    // (undocumented)
     salutation: Ref<Salutation | null>;
     // (undocumented)
     updateEmail: (updateEmailData: CustomerUpdateEmailParam) => Promise<boolean>;

api/shopware-6-client.api.md

@@ -90,6 +90,14 @@ export interface CustomerRegisterResponse {
     data: string;
 }
 
+// @alpha (undocumented)
+export interface CustomerResetPasswordParam {
+    // (undocumented)
+    email: string;
+    // (undocumented)
+    storefrontUrl?: string;
+}
+
 // @alpha (undocumented)
 export interface CustomerUpdateEmailParam {
     // (undocumented)
@@ -251,6 +259,9 @@ export function register(params: CustomerRegistrationParams): Promise<CustomerRe
 // @alpha
 export function removeCartItem(itemId: string): Promise<Cart>;
 
+// @alpha
+export function resetPassword(params: CustomerResetPasswordParam): Promise<void>;
+
 // @alpha
 export function setCurrentBillingAddress(billingAddressId: string): Promise<ContextTokenResponse>;
 

packages/composables/__tests__/useProductListing.spec.ts

@@ -212,7 +212,7 @@ describe("Composables - useProductListing", () => {
 
     it("should not change pagination state to privided one once a useProductListing argument is passed hasn't any required fields", async () => {
       const { pagination } = useProductListing({
-        page: undefined
+        page: undefined,
       } as any);
 
       expect(pagination.value).toStrictEqual({

packages/composables/__tests__/useUser.spec.ts

@@ -497,6 +497,31 @@ describe("Composables - useUser", () => {
       );
     });
   });
+  describe("resetPassword", () => {
+    it("should invoke resetPassword api-client method and return true on success", async () => {
+      mockedApiClient.resetPassword.mockImplementationOnce(async () =>
+        Promise.resolve(undefined)
+      );
+      const { resetPassword } = useUser();
+      const response = await resetPassword({
+        email: "qweqwe@qwe.com",
+      });
+      expect(mockedApiClient.resetPassword).toBeCalledTimes(1);
+      expect(response).toBeTruthy();
+    });
+    it("should return false and set the error.value on api-client on resetPassword rejection", async () => {
+      mockedApiClient.resetPassword.mockImplementationOnce(async () =>
+        Promise.reject("Email does not fit to any in Sales Channel")
+      );
+      const { resetPassword, error } = useUser();
+      const response = await resetPassword({
+        email: "qweqwe@qwe.com",
+      });
+      expect(mockedApiClient.resetPassword).toBeCalledTimes(1);
+      expect(response).toBeFalsy();
+      expect(error.value).toEqual("Email does not fit to any in Sales Channel");
+    });
+  });
   describe("updateEmail", () => {
     it("should invoke updateEmail api-client method and return true on success", async () => {
       mockedApiClient.updateEmail.mockImplementationOnce(async () =>

packages/composables/src/hooks/useUser.ts

@@ -4,6 +4,7 @@ import {
   logout as apiLogout,
   register as apiRegister,
   updatePassword as apiUpdatePassword,
+  resetPassword as apiResetPassword,
   updateEmail as apiUpdateEmail,
   getCustomer,
   getCustomerOrders,
@@ -20,6 +21,7 @@ import {
   CustomerUpdateProfileParam,
   CustomerUpdatePasswordParam,
   CustomerUpdateEmailParam,
+  CustomerResetPasswordParam,
 } from "@shopware-pwa/shopware-6-client";
 import { Customer } from "@shopware-pwa/commons/interfaces/models/checkout/customer/Customer";
 import { getStore } from "@shopware-pwa/composables";
@@ -69,6 +71,9 @@ export interface UseUser {
   updatePassword: (
     updatePasswordData: CustomerUpdatePasswordParam
   ) => Promise<boolean>;
+  resetPassword: (
+    resetPasswordData: CustomerResetPasswordParam
+  ) => Promise<boolean>;
   markAddressAsDefault: ({
     addressId,
     type,
@@ -264,6 +269,18 @@ export const useUser = (): UseUser => {
     return true;
   };
 
+  const resetPassword = async (
+    resetPasswordData: CustomerResetPasswordParam
+  ): Promise<boolean> => {
+    try {
+      await apiResetPassword(resetPasswordData);
+    } catch (e) {
+      error.value = e;
+      return false;
+    }
+    return true;
+  };
+
   const updateEmail = async (
     updateEmailData: CustomerUpdateEmailParam
   ): Promise<boolean> => {
@@ -296,6 +313,7 @@ export const useUser = (): UseUser => {
     updateEmail,
     updatePersonalInfo,
     updatePassword,
+    resetPassword,
     addAddress,
     deleteAddress,
     loadSalutation,

packages/default-theme/components/SwResetPassword.vue

@@ -3,10 +3,10 @@
     <div class="form sw-reset-password__form">
       <!-- <h2 class="sw-reset-password__header">Reset password</h2> -->
       <SfAlert
-        v-if="error"
+        v-if="userError"
         class="sw-reset-password__alert"
         type="danger"
-        :message="error"
+        :message="userError.message"
       />
       <SfInput
         v-model="email"
@@ -31,6 +31,7 @@
 import { SfInput, SfButton, SfAlert } from '@storefront-ui/vue'
 import { validationMixin } from 'vuelidate'
 import { required, email } from 'vuelidate/lib/validators'
+import {useUser} from '@shopware-pwa/composables';
 
 export default {
   name: 'SwResetPassword',
@@ -42,16 +43,32 @@ export default {
       error: ''
     }
   },
+  setup() {
+    const { resetPassword, error: userError } = useUser()
+    return {
+      resetPassword: resetPassword,
+      userError,
+    }
+  },
   validations: {
     email: {
       required,
       email
     }
   },
   methods: {
-    invokeResetPassword() {
+    async invokeResetPassword() {
       this.$v.$touch()
-      this.error = 'Reset password is not implemented yet'
+
+      if (this.$v.$invalid) {
+        return;
+      }
+      const resetSent = await this.resetPassword({
+        email: this.email
+      })
+      if (resetSent) {
+        this.$emit('success');
+      }
     }
   }
 }

packages/shopware-6-client/__tests__/services/CustomerService/resetPassword.spec.ts

@@ -0,0 +1,63 @@
+import { getCustomerResetPasswordEndpoint } from "../../../src/endpoints";
+import { apiService } from "../../../src/apiService";
+import { internet, random } from "faker";
+import { resetPassword, update, config } from "@shopware-pwa/shopware-6-client";
+
+const DEFAULT_ENDPOINT = "https://shopware-2.vuestorefront.io";
+const email = internet.email("John", "Doe");
+const credentials = {
+  email: email,
+  storefrontUrl: config.endpoint ?? DEFAULT_ENDPOINT,
+};
+
+jest.mock("../../../src/apiService");
+const mockedAxios = apiService as jest.Mocked<typeof apiService>;
+
+describe("CustomerService - resetPassword", () => {
+  let contextToken: string;
+  beforeEach(() => {
+    jest.resetAllMocks();
+    contextToken = random.uuid();
+    update({ contextToken });
+  });
+  afterEach(() => {
+    expect(config.contextToken).toEqual(contextToken);
+  });
+
+  it("rejects the promise if the email do not mach any in Sales Channel", async () => {
+    mockedAxios.post.mockRejectedValueOnce(
+      new Error("400 - invalid email address")
+    );
+    expect(
+      resetPassword({
+        email: credentials.email,
+        storefrontUrl: credentials.storefrontUrl ?? "",
+      })
+    ).rejects.toThrow("400 - invalid email");
+    expect(mockedAxios.post).toBeCalledTimes(1);
+    expect(mockedAxios.post).toBeCalledWith(
+      getCustomerResetPasswordEndpoint(),
+      {
+        email: credentials.email,
+        storefrontUrl: credentials.storefrontUrl,
+      }
+    );
+  });
+
+  it("returns no data if successfully updated", async () => {
+    mockedAxios.post.mockResolvedValueOnce(null);
+    const result = await resetPassword({
+      email: credentials.email,
+      storefrontUrl: credentials.storefrontUrl ?? "",
+    });
+    expect(result).toBeFalsy();
+    expect(mockedAxios.post).toBeCalledTimes(1);
+    expect(mockedAxios.post).toBeCalledWith(
+      getCustomerResetPasswordEndpoint(),
+      {
+        email: credentials.email,
+        storefrontUrl: credentials.storefrontUrl ?? "",
+      }
+    );
+  });
+});

packages/shopware-6-client/src/endpoints.ts

@@ -70,6 +70,9 @@ export const getCustomerUpdateEmailEndpoint = () =>
 export const getCustomerUpdatePasswordEndpoint = () =>
   `/store-api/v1/account/change-password`;
 
+export const getCustomerResetPasswordEndpoint = () =>
+  `/store-api/v1/account/recovery-password`;
+
 // checkout
 
 export const getCheckoutCartEndpoint = () =>

packages/shopware-6-client/src/services/customerService.ts

@@ -5,6 +5,7 @@ import {
   getCustomerRegisterEndpoint,
   getCustomerDetailsUpdateEndpoint,
   getCustomerUpdatePasswordEndpoint,
+  getCustomerResetPasswordEndpoint,
   getCustomerDefaultBillingAddressEndpoint,
   getCustomerDefaultShippingAddressEndpoint,
   getCustomerLogoutEndpoint,
@@ -14,6 +15,7 @@ import {
 } from "../endpoints";
 import { Customer } from "@shopware-pwa/commons/interfaces/models/checkout/customer/Customer";
 import { apiService } from "../apiService";
+import { config } from "../settings";
 import { CustomerAddress } from "@shopware-pwa/commons/interfaces/models/checkout/customer/CustomerAddress";
 import { CustomerRegistrationParams } from "@shopware-pwa/commons/interfaces/request/CustomerRegistrationParams";
 import { ContextTokenResponse } from "@shopware-pwa/commons/interfaces/response/SessionContext";
@@ -238,6 +240,30 @@ export async function updatePassword(
   await apiService.post(getCustomerUpdatePasswordEndpoint(), params);
 }
 
+/**
+ * @alpha
+ */
+export interface CustomerResetPasswordParam {
+  email: string;
+  storefrontUrl?: string;
+}
+
+/**
+ * Reset a customer's password
+ *
+ * @throws ClientApiError
+ * @alpha
+ */
+export async function resetPassword(
+  params: CustomerResetPasswordParam
+): Promise<void> {
+  if (!params.storefrontUrl) {
+    params.storefrontUrl = config.endpoint;
+  }
+
+  await apiService.post(getCustomerResetPasswordEndpoint(), params);
+}
+
 /**
  * @alpha
  */