@sbc-connect/nuxt-auth 0.4.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @sbc-connect/nuxt-auth
 
+## 0.6.0
+
+### Minor Changes
+
+- [#127](https://github.com/bcgov/connect-nuxt/pull/127) [`63409ea`](https://github.com/bcgov/connect-nuxt/commit/63409eab3ef9072fe8e05662b44f61bb8be6cff4) Thanks [@cameron-eyds](https://github.com/cameron-eyds)! - Improved name lookup validations
+
+- [#125](https://github.com/bcgov/connect-nuxt/pull/125) [`fda1d48`](https://github.com/bcgov/connect-nuxt/commit/fda1d48ed55838aeece70aa04a82440153a3db24) Thanks [@cameron-eyds](https://github.com/cameron-eyds)! - Includes contact POST and minor redirect refactors
+
+### Patch Changes
+
+- Updated dependencies [[`8cc8cc0`](https://github.com/bcgov/connect-nuxt/commit/8cc8cc09aad741dc841a864998129c6ac5a6af2f)]:
+  - @sbc-connect/nuxt-base@0.6.1
+  - @sbc-connect/nuxt-forms@0.4.1
+
+## 0.5.0
+
+### Minor Changes
+
+- [#123](https://github.com/bcgov/connect-nuxt/pull/123) [`3c33132`](https://github.com/bcgov/connect-nuxt/commit/3c331327a27cfbd0613c268abf97842288d10f8c) Thanks [@cameron-eyds](https://github.com/cameron-eyds)! - Auth Redirect Enhancements
+
 ## 0.4.1
 
 ### Patch Changes

package/app/components/Connect/Account/Create/index.vue

@@ -24,9 +24,16 @@ const formErrors = computed<{
   }
 })
 
-async function validate() {
-  return formRef.value?.validate({ silent: true })
+async function validate(fieldName?: keyof AccountProfileSchema) {
+  return formRef.value?.validate({ name: fieldName, silent: true })
 }
+
+watch(() => statusCode.value, async () => {
+  if (statusCode.value !== undefined) {
+    await nextTick()
+    await validate('accountName')
+  }
+})
 </script>
 
 <template>

package/app/composables/useAuthApi.ts

@@ -1,5 +1,3 @@
-import type { ConnectCreateAccount } from '#auth/app/interfaces/connect-account'
-
 export const useAuthApi = () => {
   const { $authApi } = useNuxtApp()
   const queryCache = useQueryCache()
@@ -34,7 +32,10 @@ export const useAuthApi = () => {
    */
   const useCreateAccount = defineMutation(() => {
     const { mutateAsync, ...mutation } = useMutation({
-      mutation: (vars: { payload: ConnectCreateAccount, successCb?: () => Promise<unknown> }) => {
+      mutation: (vars: {
+        payload: ConnectCreateAccount
+        successCb?: (createRes: ConnectAuthProfile) => Promise<unknown>
+      }) => {
         return $authApi<ConnectAuthProfile>('/orgs', {
           method: 'POST',
           body: vars.payload
@@ -48,7 +49,7 @@ export const useAuthApi = () => {
       onSuccess: async (_, _vars) => {
         await queryCache.invalidateQueries({ key: ['auth-user-profile'], exact: true })
         if (_vars.successCb) {
-          await _vars.successCb()
+          await _vars.successCb(_)
         }
       }
     })
@@ -63,17 +64,18 @@ export const useAuthApi = () => {
    * Updates a users contact by PUTing the given payload to `/users/contacts`.
    * @returns Object containing mutation state and `updateUserContact` function.
    */
-  const useUpdateUserContact = defineMutation(() => {
+  const useUpdateOrCreateUserContact = defineMutation(() => {
     const { mutateAsync, ...mutation } = useMutation({
       mutation: (vars: {
         email: string
         phone: string
         phoneExtension: string | undefined
+        method?: 'POST' | 'PUT'
         successCb?: () => Promise<unknown>
         errorCb?: (error: unknown) => Promise<unknown>
       }) => {
         return $authApi<ConnectAuthProfile>('/users/contacts', {
-          method: 'PUT',
+          method: vars.method || 'PUT',
           body: {
             email: vars.email,
             phone: vars.phone,
@@ -100,7 +102,7 @@ export const useAuthApi = () => {
 
     return {
       ...mutation,
-      updateUserContact: mutateAsync
+      updateOrCreateUserContact: mutateAsync
     }
   })
 
@@ -148,7 +150,7 @@ export const useAuthApi = () => {
     getTermsOfUse,
     useCreateAccount,
     usePatchTermsOfUse,
-    useUpdateUserContact,
+    useUpdateOrCreateUserContact,
     verifyAccountName
   }
 }

package/app/composables/useConnectAccountFlowRedirect.ts

@@ -1,32 +1,48 @@
 import type { RouteLocationNormalizedGeneric } from '#vue-router'
 
 export const useConnectAccountFlowRedirect = () => {
-  function finalRedirect(route: RouteLocationNormalizedGeneric) {
+  function finalRedirect(route: RouteLocationNormalizedGeneric, manageAccount = false) {
+    const { authUser } = useConnectAuth()
+    const { currentAccount, userAccounts } = useConnectAccountStore()
     const localePath = useLocalePath()
     const ac = useAppConfig().connect.login
     const externalRedirectUrl = route.query.return as string | undefined
     const internalRedirectUrl = ac.redirect
-
     const query = { ...route.query }
 
-    if (query.return) {
-      delete query.return
+    const bypassAccounts = userAccounts.length === 1 && !query.populate
+    const isNonStaffAccount = ![AccountType.STAFF, AccountType.SBC_STAFF].includes(currentAccount.accountType)
+    const createOrSelectAccount = manageAccount && isNonStaffAccount && !bypassAccounts
+
+    if (createOrSelectAccount) {
+      const isBcscUserWithNoAccounts = (!userAccounts.length || userAccounts.length === 0)
+        && authUser.value.loginSource === ConnectLoginSource.BCSC
+      const redirectPath = isBcscUserWithNoAccounts ? '/auth/account/create' : '/auth/account/select'
+
+      return navigateTo({ path: localePath(redirectPath), query })
     }
 
     if (externalRedirectUrl) {
+      const cleanQuery = { ...query }
+      delete cleanQuery.return
+
       return navigateTo(
         {
-          path: appendUrlParam(externalRedirectUrl, 'accountid', useConnectAccountStore().currentAccount.id),
-          query
+          path: appendUrlParam(
+            externalRedirectUrl,
+            'accountid',
+            currentAccount.id
+          ),
+          query: cleanQuery
         },
         { external: true }
       )
-    } else {
-      return navigateTo({
-        path: localePath(internalRedirectUrl),
-        query
-      })
     }
+
+    return navigateTo({
+      path: localePath(internalRedirectUrl),
+      query
+    })
   }
 
   return {

package/app/middleware/04.idp-enforcement.global.ts

@@ -33,7 +33,7 @@ export default defineNuxtRouteMiddleware(async (to) => {
   if (idpEnforcement && authUser.value?.loginSource) {
     // User's IDP is not allowed, log them out and redirect to login page
     if (!allowedIdps?.includes(authUser.value?.loginSource.toLowerCase() as unknown as ConnectIdpHint)) {
-      showInvalidIdpModal()
+      await showInvalidIdpModal()
     }
   }
 })

package/app/middleware/connect-auth.ts

@@ -5,27 +5,33 @@ export default defineNuxtRouteMiddleware(async (to) => {
   const authApi = useAuthApi()
   const { finalRedirect } = useConnectAccountFlowRedirect()
 
-  if (!isAuthenticated.value && !rtc.playwright) {
-    return navigateTo({
-      path: localePath('/auth/login'),
-      query: {
-        // include preset when present
-        ...(to.query.preset ? { preset: String(to.query.preset) } : {}),
-        return: `${rtc.baseUrl}${to.fullPath.slice(1)}`
+  const isLoginPage = to.meta.connectLogin === true
+  const isTosPage = to.meta.connectTosPage === true
+
+  if (!isAuthenticated.value && !isLoginPage && !rtc.playwright) {
+    const defaultReturn = `${rtc.baseUrl}${to.fullPath.slice(1)}`
+    const returnUrl = (to.query.return && String(to.query.return)) || defaultReturn
+
+    return navigateTo(
+      {
+        path: localePath('/auth/login'),
+        query: {
+          ...to.query,
+          return: returnUrl
+        }
       }
-    })
+    )
   }
 
   if (isAuthenticated.value) {
     const { data, refresh } = await authApi.getAuthUserProfile()
     await refresh()
     const hasAccepted = data.value?.userTerms.isTermsOfUseAccepted
-    const isTosPage = to.meta.connectTosPage === true
     if (!hasAccepted && !isTosPage) {
       const query = { ...to.query }
       return navigateTo({ path: localePath('/auth/terms-of-use'), query })
-    } else if (hasAccepted && isTosPage) {
-      return finalRedirect(to)
+    } else if (hasAccepted && (isTosPage || isLoginPage)) {
+      return finalRedirect(to, true)
     }
   }
 

package/app/pages/auth/login.vue

@@ -12,7 +12,8 @@ useHead({
 definePageMeta({
   layout: 'connect-auth',
   hideBreadcrumbs: true,
-  middleware: 'connect-login-page'
+  middleware: 'connect-auth',
+  connectLogin: true
 })
 
 const isSessionExpired = sessionStorage.getItem(ConnectAuthStorageKey.CONNECT_SESSION_EXPIRED)

package/app/pages/auth/terms-of-use.vue

@@ -70,7 +70,7 @@ const disableButtons = computed<boolean>(() => {
       @submit="patchTermsOfUse({
         accepted: true,
         version: data!.versionId,
-        successCb: async () => await finalRedirect(useRoute()),
+        successCb: async () => await finalRedirect(useRoute(), true),
       })"
     />
   </UContainer>

package/app/stores/connect-account.ts

@@ -1,12 +1,11 @@
 import { getAccountCreateSchema } from '#auth/app/utils/schemas/account'
 import type { AccountProfileSchema } from '#auth/app/utils/schemas/account'
-import type { ConnectCreateAccount } from '#auth/app/interfaces/connect-account'
 
 export const useConnectAccountStore = defineStore('connect-auth-account-store', () => {
   const { $authApi } = useNuxtApp()
   const rtc = useRuntimeConfig().public
   const { authUser } = useConnectAuth()
-  const { useCreateAccount, useUpdateUserContact, getAuthUserProfile } = useAuthApi()
+  const { useCreateAccount, useUpdateOrCreateUserContact, getAuthUserProfile } = useAuthApi()
   const { finalRedirect } = useConnectAccountFlowRedirect()
 
   // selected user account
@@ -22,7 +21,7 @@ export const useConnectAccountStore = defineStore('connect-auth-account-store',
   // Create account
   const isLoading = ref<boolean>(false)
   const { createAccount } = useCreateAccount()
-  const { updateUserContact } = useUpdateUserContact()
+  const { updateOrCreateUserContact } = useUpdateOrCreateUserContact()
   const createAccountProfileSchema = getAccountCreateSchema()
   const accountFormState = reactive<AccountProfileSchema>(createAccountProfileSchema.parse({}))
   /**
@@ -88,13 +87,23 @@ export const useConnectAccountStore = defineStore('connect-auth-account-store',
       await createAccount({
         payload,
         // Update User Contact Info on create account success
-        successCb: async () => await updateUserContact({
-          email: accountFormState.emailAddress,
-          phone: accountFormState.phone.phoneNumber,
-          phoneExtension: accountFormState.phone.ext,
-          successCb: async () => await finalRedirect(useRoute()),
-          errorCb: async () => await finalRedirect(useRoute())
-        })
+        successCb: async (createResponse: ConnectAuthProfile) => {
+          // Refresh and switch to new account prior to redirect
+          if (createResponse?.id) {
+            await setAccountInfo()
+            switchCurrentAccount(createResponse.id)
+          }
+
+          // Update or create user contact and then redirect regardless of success or failure
+          await updateOrCreateUserContact({
+            email: accountFormState.emailAddress,
+            phone: accountFormState.phone.phoneNumber,
+            phoneExtension: accountFormState.phone.ext,
+            method: userAccounts.value.length === 1 ? 'POST' : 'PUT', // if only 1 account exists then contact is new
+            successCb: async () => await finalRedirect(useRoute()),
+            errorCb: async () => await finalRedirect(useRoute())
+          })
+        }
       })
     } catch (error) {
       // Error handled in useAuthApi

package/app/utils/schemas/account.ts

@@ -6,7 +6,7 @@ export function getAccountNameSchema(status?: number | undefined) {
 
   return z.string().min(1, t('connect.validation.requiredAccountName'))
     .superRefine((val, ctx) => {
-      // Only run if we have a value and a statusCode
+      // Validate account name uniqueness based on API response status code
       if (val && status !== undefined) {
         if (status === 200) {
           ctx.addIssue({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sbc-connect/nuxt-auth",
   "type": "module",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "repository": "github:bcgov/connect-nuxt",
   "license": "BSD-3-Clause",
   "main": "./nuxt.config.ts",
@@ -22,8 +22,8 @@
     "keycloak-js": "26.2.2",
     "pinia": "3.0.4",
     "pinia-plugin-persistedstate": "4.7.1",
-    "@sbc-connect/nuxt-base": "0.6.0",
-    "@sbc-connect/nuxt-forms": "0.4.0"
+    "@sbc-connect/nuxt-base": "0.6.1",
+    "@sbc-connect/nuxt-forms": "0.4.1"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",

package/testMocks/auth/index.ts

@@ -1 +1,2 @@
+export * from './profile'
 export * from './settings'

package/testMocks/auth/profile/index.ts

@@ -0,0 +1,9 @@
+import fs from 'fs'
+import { createResolver } from 'nuxt/kit'
+
+const { resolve } = createResolver(import.meta.url)
+
+export const getUserProfileMock = () => {
+  const json: ConnectAuthProfile = JSON.parse(fs.readFileSync(resolve('./json/PUBLIC_USER.json'), 'utf8'))
+  return json
+}

package/testMocks/auth/profile/json/PUBLIC_USER.json

@@ -0,0 +1,29 @@
+{
+  "contacts": [
+    {
+      "email": "v9x3z!q__mock@fuzzmail.zzz",
+      "phone": "(902) 555-xyzz",
+      "phoneExtension": "7q1"
+    }
+  ],
+  "created": "2024-03-19T04:92:17+00:00",
+  "firstname": "Nxlqrp3##",
+  "id": 88422,
+  "idpUserid": "ZZ91XQWPMR7T4!$CBA9900PLMNXXQTT",
+  "keycloakGuid": "xxxxxxxx-bb77-49c1-f01a-xxxxxxxxx",
+  "lastname": "T'W&&two--",
+  "loginSource": "BCSC",
+  "loginTime": "2026-01-23T28:77:59+00:00",
+  "modified": "2026-01-23T28:77:59+00:00",
+  "modifiedBy": "Nxlqrp3## T'W&&two--",
+  "type": "PUBLIC_USER",
+  "userStatus": 1,
+  "userTerms": {
+    "isTermsOfUseAccepted": true,
+    "termsOfUseAcceptedVersion": "999x"
+  },
+  "username": "bcsc/zz91xqwpmr7t4!$cba9900plmnxxqtt",
+  "verified": true,
+  "version": 9999
+}
+

package/testMocks/mock-helpers.ts

@@ -1,11 +1,14 @@
 import type { Page } from '@playwright/test'
 import { AccountType } from '#auth/app/enums/account-type'
-import { getUserSettingsMock } from '#auth/testMocks/auth'
+import { getUserProfileMock, getUserSettingsMock } from '#auth/testMocks/auth'
 
 export const mockApiCallsForSetAccount = async (
   page: Page,
   accountType: AccountType = AccountType.PREMIUM
 ) => {
+  page.route('**/users/@me', async (route) => {
+    await route.fulfill({ json: getUserProfileMock() })
+  })
   page.route('**/users/**/settings', async (route) => {
     await route.fulfill({ json: getUserSettingsMock(accountType) })
   })

package/app/middleware/connect-login-page.ts

@@ -1,26 +0,0 @@
-export default defineNuxtRouteMiddleware((to) => {
-  const { isAuthenticated, authUser } = useConnectAuth()
-  const accountStore = useConnectAccountStore()
-  const localePath = useLocalePath()
-  const { finalRedirect } = useConnectAccountFlowRedirect()
-
-  const numAccounts = accountStore.userAccounts.length
-
-  if (isAuthenticated.value) {
-    if (numAccounts === 1) {
-      return finalRedirect(to)
-    }
-
-    if (numAccounts === 0 && authUser.value.loginSource === ConnectLoginSource.BCSC) {
-      return navigateTo({
-        path: localePath('/auth/account/create'),
-        query: to.query
-      })
-    }
-
-    return navigateTo({
-      path: localePath('/auth/account/select'),
-      query: to.query
-    })
-  }
-})