Update API

components/blocks/cards/ForgotPasswordCard/ForgotPasswordCard.test.ts

@@ -46,7 +46,7 @@ describe('<ForgotPasswordCard />', () => {
       beforeEach(() => {
         vi.mock('lib/api/Account', () => ({
           Account: function Account() {
-            this.recoverCreate = mockSuccessAccountRecoverCreate
+            this.sendRecoveryEmail = mockSuccessAccountRecoverCreate
           },
         }))
       })

components/blocks/cards/LogInCard/LogInCard.test.ts

@@ -4,10 +4,10 @@ import LogInCard from './LogInCard.vue'
 import * as apiComposables from 'composables/api'
 
 const token = 'jwt-token'
-const mockSuccessAccountLoginCreate = vi.fn(() =>
+const mockSuccessAccountLogin = vi.fn(() =>
   Promise.resolve({ data: { token }, ok: true }),
 )
-const mockSuccessUsersMeList = vi.fn(() =>
+const mockSuccessMe = vi.fn(() =>
   Promise.resolve({
     data: { id: 1, username: 'admin' },
     ok: true,
@@ -22,12 +22,12 @@ describe('<LogInCard />', () => {
   beforeEach(() => {
     vi.mock('lib/api/Account', () => ({
       Account: function Account() {
-        this.loginCreate = mockSuccessAccountLoginCreate
+        this.login = mockSuccessAccountLogin
       },
     }))
     vi.mock('lib/api/Users', () => ({
       Users: function Users() {
-        this.usersMeList = mockSuccessUsersMeList
+        this.me = mockSuccessMe
       },
     }))
   })
@@ -115,7 +115,7 @@ describe('<LogInCard />', () => {
       await getByTestId(wrapper, 'login-button').trigger('click')
 
       expect(useLoginUserSpy).toBeCalledTimes(1)
-      expect(mockSuccessAccountLoginCreate).toBeCalledTimes(1)
+      expect(mockSuccessAccountLogin).toBeCalledTimes(1)
     })
   })
 

composables/api/index.ts

@@ -1,7 +1,7 @@
 export { default as useChangePassword } from './useChangePassword'
 export { default as useConfirmAccount } from './useConfirmAccount'
-export { default as useGetLeaderboardDetail } from './useGetLeaderboardDetail'
-export { default as useGetUserDetail } from './useGetUserDetail'
+export { default as useGetLeaderboardBySlug } from './useGetLeaderboardBySlug'
+export { default as useGetUser } from './useGetUser'
 export { default as useLoginUser } from './useLoginUser'
 export { default as useLogoutUser } from './useLogoutUser'
 export { default as useRecoverAccount } from './useRecoverAccount'

composables/api/useChangePassword/index.ts

@@ -19,7 +19,7 @@ export async function useChangePassword(
 
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
   return await useApi<void>(
-    async () => await account.recoverCreate2(token, requestData),
+    async () => await account.changePassword(token, requestData),
     {
       onError,
       onOkay,

composables/api/useChangePassword/useChangePassword.test.ts

@@ -1,6 +1,6 @@
 import useChangePassword from '.'
 
-const mockSuccessRecoverCreate2 = vi.fn(() => Promise.resolve({ ok: true }))
+const mockSuccessChangePassword = vi.fn(() => Promise.resolve({ ok: true }))
 
 describe('useChangePassword', () => {
   describe('when everything is successful', () => {
@@ -10,14 +10,14 @@ describe('useChangePassword', () => {
     it('changes the password for the user', async () => {
       vi.mock('lib/api/Account', () => ({
         Account: function Account() {
-          this.recoverCreate2 = mockSuccessRecoverCreate2
+          this.changePassword = mockSuccessChangePassword
         },
       }))
 
       await useChangePassword(token, requestData)
 
-      expect(mockSuccessRecoverCreate2).toBeCalledTimes(1)
-      expect(mockSuccessRecoverCreate2).toBeCalledWith(token, requestData)
+      expect(mockSuccessChangePassword).toBeCalledTimes(1)
+      expect(mockSuccessChangePassword).toBeCalledWith(token, requestData)
     })
   })
 })

composables/api/useConfirmAccount/index.ts

@@ -18,7 +18,7 @@ export async function useConfirmAccount(
 
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
   return await useApi<void>(
-    async () => await account.confirmUpdate(confirmationToken),
+    async () => await account.confirmAccount(confirmationToken),
     { onError, onOkay },
   )
 }

composables/api/useConfirmAccount/useConfirmAccount.test.ts

@@ -4,14 +4,14 @@ const mockSuccessAccountConfirmation = vi.fn(() =>
   Promise.resolve({ ok: true }),
 )
 
-describe('useConfirmUser', () => {
+describe('useConfirmAccount', () => {
   describe('when everything is successful', () => {
     const confirmationCode = '123'
 
     it('creates a PUT request to confirm the account', async () => {
       vi.mock('lib/api/Account', () => ({
         Account: function Account() {
-          this.confirmUpdate = mockSuccessAccountConfirmation
+          this.confirmAccount = mockSuccessAccountConfirmation
         },
       }))
 

composables/api/useGetLeaderboardDetail/index.ts → composables/api/useGetLeaderboardBySlug/index.ts

@@ -8,7 +8,7 @@ import { Leaderboards } from 'lib/api/Leaderboards'
 import type { LeaderboardViewModel } from 'lib/api/data-contracts'
 import { useRuntimeConfig } from '#imports'
 
-export async function useGetLeaderboardDetail(
+export default async function useGetLeaderboardBySlug(
   leaderboardSlug: string,
   opts: optionalParameters<LeaderboardViewModel> = {},
 ): Promise<ApiResponse<LeaderboardViewModel>> {
@@ -17,22 +17,24 @@ export async function useGetLeaderboardDetail(
     categories: [],
     id: -1,
     name: '',
-    rules: '',
     slug: '',
+    info: null,
+    createdAt: '',
+    updatedAt: null,
+    deletedAt: null,
   })
 
   const leaderboardClient = new Leaderboards({
     baseUrl: useRuntimeConfig().public.backendBaseUrl,
   })
 
   return await useApi<LeaderboardViewModel>(
-    async () => await leaderboardClient.leaderboardsDetail2(leaderboardSlug),
+    async () =>
+      await leaderboardClient.getLeaderboardBySlug({ slug: leaderboardSlug }),
     {
       onError,
       onOkay,
       responseData,
     },
   )
 }
-
-export default useGetLeaderboardDetail

composables/api/useGetLeaderboardBySlug/useGetLeaderboardBySlug.test.ts

@@ -0,0 +1,24 @@
+import useGetLeaderboardBySlug from '.'
+
+const mockSuccessGetLeaderboardBySlug = vi.fn(() =>
+  Promise.resolve({ ok: true }),
+)
+
+describe('useGetLeaderboardBySlug', () => {
+  describe('when everything is successful', () => {
+    const slug = 'pieces'
+
+    it('creates a GET request to fetch the leaderboard details', async () => {
+      vi.mock('lib/api/Leaderboards', () => ({
+        Leaderboards: function Leaderboards() {
+          this.getLeaderboardBySlug = mockSuccessGetLeaderboardBySlug
+        },
+      }))
+
+      await useGetLeaderboardBySlug(slug)
+
+      expect(mockSuccessGetLeaderboardBySlug).toBeCalledTimes(1)
+      expect(mockSuccessGetLeaderboardBySlug).toBeCalledWith({ slug })
+    })
+  })
+})

composables/api/useGetUserDetail/index.ts → composables/api/useGetUser/index.ts

@@ -7,7 +7,7 @@ import {
 import { Users } from 'lib/api/Users'
 import type { UserViewModel } from 'lib/api/data-contracts'
 
-export async function useGetUserDetail(
+export default async function useGetUser(
   userId: string,
   opts: optionalParameters<UserViewModel> = {},
 ): Promise<ApiResponse<UserViewModel>> {
@@ -18,12 +18,10 @@ export async function useGetUserDetail(
   })
 
   return await useApi<UserViewModel>(
-    async () => await userClient.usersDetail(userId),
+    async () => await userClient.getUser(userId),
     {
       onError,
       onOkay,
     },
   )
 }
-
-export default useGetUserDetail

composables/api/useGetUser/useGetUser.test.ts

@@ -0,0 +1,22 @@
+import useGetUser from '.'
+
+const mockSuccessGetUser = vi.fn(() => Promise.resolve({ ok: true }))
+
+describe('useGetUser', () => {
+  describe('when everything is successful', () => {
+    const userId = 'cd79f511-a952-48d5-a1c9-262449bc2e34'
+
+    it('creates a GET request to fetch the user details', async () => {
+      vi.mock('lib/api/Users', () => ({
+        Users: function Users() {
+          this.getUser = mockSuccessGetUser
+        },
+      }))
+
+      await useGetUser(userId)
+
+      expect(mockSuccessGetUser).toBeCalledTimes(1)
+      expect(mockSuccessGetUser).toBeCalledWith(userId)
+    })
+  })
+})

composables/api/useLoginUser/index.ts

@@ -19,7 +19,7 @@ export default async function useLoginUser(
   })
 
   return await useApi<LoginResponse>(
-    async () => await account.loginCreate(requestData),
+    async () => await account.login(requestData),
     {
       onError,
       onOkay: async (d: LoginResponse) => {

composables/api/useLoginUser/useLoginUser.test.ts

@@ -2,15 +2,16 @@ import { useSessionToken } from '#imports'
 import useLoginUser from '.'
 
 // const mockFailureUsersLoginCreate = vi.fn(() => Promise.resolve({ ok: false }))
-const mockSuccessAccountLoginCreate = vi.fn(() =>
+const mockSuccessAccountLogin = vi.fn(() =>
   Promise.resolve({ data: { token: 'token' }, ok: true }),
 )
-const mockSuccessUsersMeList = vi.fn(() =>
+const mockSuccessMe = vi.fn(() =>
   Promise.resolve({
     data: {
       id: '05864eb1-540a-4b32-ad57-17871f2519f3',
       role: 'Confirmed',
       username: 'foo',
+      createdAt: '1984-01-01T00:00:00Z',
     },
     ok: true,
   }),
@@ -31,19 +32,19 @@ describe('useLoginUser', () => {
     it('creates a login session and returns the user information', async () => {
       vi.mock('lib/api/Users', () => ({
         Users: function Users() {
-          this.usersMeList = mockSuccessUsersMeList
+          this.me = mockSuccessMe
         },
       }))
       vi.mock('lib/api/Account', () => ({
         Account: function Account() {
-          this.loginCreate = mockSuccessAccountLoginCreate
+          this.login = mockSuccessAccountLogin
         },
       }))
 
       await useLoginUser({ email, password }, { onOkay: onOkaySpy })
 
-      expect(mockSuccessAccountLoginCreate).toBeCalledTimes(1)
-      expect(mockSuccessAccountLoginCreate).toBeCalledWith({ email, password })
+      expect(mockSuccessAccountLogin).toBeCalledTimes(1)
+      expect(mockSuccessAccountLogin).toBeCalledWith({ email, password })
 
       expect(onOkaySpy).toBeCalledTimes(1)
       expect(useSessionToken().value).toBeTruthy()

composables/api/useLogoutUser/useLogoutUser.test.ts

@@ -7,6 +7,7 @@ const user: UserViewModel = {
   id: '575888bd-9702-41a9-9b75-fc87d785c22a',
   role: 'Confirmed',
   username: 'test',
+  createdAt: '1984-01-01T00:00:00Z',
 }
 
 afterEach(() => {
@@ -17,7 +18,7 @@ afterEach(() => {
 
 describe('useLogoutUser', () => {
   beforeEach(() => {
-    fetchMock.mockIf(/.*\/api\/[Uu]sers\/me/, () => JSON.stringify(user))
+    fetchMock.mockIf(/.*\/[Uu]ser\/me/, () => JSON.stringify(user))
     useSessionToken().value = token
   })
 

composables/api/useRecoverAccount/index.ts

@@ -18,7 +18,7 @@ export async function useRecoverAccount(
 
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
   return await useApi<void>(
-    async () => await account.recoverCreate(requestData),
+    async () => await account.sendRecoveryEmail(requestData),
     {
       onError,
       onOkay,

composables/api/useRecoverAccount/useRecoverAccount.test.ts

@@ -1,6 +1,6 @@
 import useRecoverAccount from '.'
 
-const mockSuccessRecoverCreate = vi.fn(() => Promise.resolve({ ok: true }))
+const mockSuccessRecover = vi.fn(() => Promise.resolve({ ok: true }))
 
 describe('useRecoverAccount', () => {
   describe('when everything is successful', () => {
@@ -9,14 +9,14 @@ describe('useRecoverAccount', () => {
     it('kicks off the account recovery process', async () => {
       vi.mock('lib/api/Account', () => ({
         Account: function Account() {
-          this.recoverCreate = mockSuccessRecoverCreate
+          this.sendRecoveryEmail = mockSuccessRecover
         },
       }))
 
       await useRecoverAccount(requestData)
 
-      expect(mockSuccessRecoverCreate).toBeCalledTimes(1)
-      expect(mockSuccessRecoverCreate).toBeCalledWith(requestData)
+      expect(mockSuccessRecover).toBeCalledTimes(1)
+      expect(mockSuccessRecover).toBeCalledWith(requestData)
     })
   })
 })

composables/api/useRegisterUser/index.ts

@@ -18,7 +18,7 @@ export async function useRegisterUser(
   })
 
   return await useApi<UserViewModel>(
-    async () => await accountClient.registerCreate(requestData),
+    async () => await accountClient.register(requestData),
     {
       onError,
       onOkay,