@sbc-connect/nuxt-auth 0.14.0 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @sbc-connect/nuxt-auth
 
+## 0.16.0
+
+### Minor Changes
+
+- [#183](https://github.com/bcgov/connect-nuxt/pull/183) [`7319c2e`](https://github.com/bcgov/connect-nuxt/commit/7319c2ec4da24854e67fab7446dac11e3f936b8f) Thanks [@deetz99](https://github.com/deetz99)! - Loosen typing for idps in app config, delete unused ConnectValidIdps type and getValidIdps function.
+
+## 0.15.0
+
+### Minor Changes
+
+- [#180](https://github.com/bcgov/connect-nuxt/pull/180) [`4e25088`](https://github.com/bcgov/connect-nuxt/commit/4e250886da973eda99044ff1c34383604b05d718) Thanks [@deetz99](https://github.com/deetz99)! - Force type resolutions via nuxt config prepare:types hook.
+
+### Patch Changes
+
+- Updated dependencies [[`4e25088`](https://github.com/bcgov/connect-nuxt/commit/4e250886da973eda99044ff1c34383604b05d718)]:
+  - @sbc-connect/nuxt-base@0.12.0
+  - @sbc-connect/nuxt-forms@0.7.7
+
 ## 0.14.0
 
 ### Minor Changes

package/app/app.config.ts

@@ -1,11 +1,10 @@
-import { ConnectIdpHint } from './enums/connect-idp-hint'
 import type { AppConfigInput } from 'nuxt/schema'
 
 export default defineAppConfig({
   connect: {
     login: {
       redirect: '/',
-      idps: [ConnectIdpHint.BCSC, ConnectIdpHint.BCEID, ConnectIdpHint.IDIR],
+      idps: ['bcsc', 'bceid', 'idir'],
       skipAccountRedirect: false,
       idpEnforcement: false
     },

package/app/composables/useConnectAppConfig.ts

@@ -1,5 +1,4 @@
-import { useAppConfig } from '#imports'
-
+/* eslint-disable @typescript-eslint/no-explicit-any */
 export const useConnectAppConfig = () => {
   /**
    * Merge preset overrides (from app.config.connectOverrides) into the provided baseConfig.
@@ -7,10 +6,10 @@ export const useConnectAppConfig = () => {
    */
   function mergeAppConfigOverrides(
     baseConfig: ConnectConfig,
-    presetName: ConnectPresetType
+    presetName: string
   ): ConnectConfig {
     const appConfig = useAppConfig()
-    const overrides = appConfig.connectOverrides?.[presetName] ?? null
+    const overrides = (appConfig.connectOverrides as Record<string, any>)?.[presetName] ?? null
 
     return {
       ...baseConfig,

package/app/interfaces/app-config-shapes.ts

@@ -1,6 +1,8 @@
+type IdpList = Array<'bcsc' | 'bceid' | 'idir'>
+
 export interface ConnectLoginConfig {
   redirect: string
-  idps: ConnectIdpHint[]
+  idps: IdpList
   skipAccountRedirect: boolean
   idpEnforcement: boolean
   alert?: {
@@ -9,6 +11,8 @@ export interface ConnectLoginConfig {
   }
 }
 
+export type ConnectLoginConfigInput = Partial<ConnectLoginConfig>
+
 export interface ConnectLogoutConfig {
   redirect: string
 }
@@ -33,6 +37,13 @@ export interface ConnectConfig {
   footer?: ConnectFooterConfig
 }
 
+export interface ConnectConfigInput {
+  login?: Partial<ConnectLoginConfigInput>
+  logout?: Partial<ConnectLogoutConfig>
+  header?: Partial<ConnectHeaderConfig>
+  footer?: Partial<ConnectFooterConfig>
+}
+
 export interface ConnectPresetOverrides {
   login?: Partial<ConnectLoginConfig>
   header?: Partial<ConnectHeaderConfig>

package/app/middleware/02.app-config-presets.global.ts

@@ -1,10 +1,12 @@
 export default defineNuxtRouteMiddleware((to) => {
-  const appConfig = useAppConfig()
-  const { mergeAppConfigOverrides } = useConnectAppConfig()
+  if (to.query.preset) {
+    const appConfig = useAppConfig()
+    const { mergeAppConfigOverrides } = useConnectAppConfig()
 
-  // Build and assign app.config presets
-  appConfig.connect = mergeAppConfigOverrides(
-    appConfig.connect as ConnectConfig,
-    to.query.preset as ConnectPresetType
-  )
+    // Build and assign app.config presets
+    appConfig.connect = mergeAppConfigOverrides(
+      appConfig.connect as ConnectConfig,
+      to.query.preset as string
+    )
+  }
 })

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

@@ -9,11 +9,11 @@ export default defineNuxtRouteMiddleware(async (to) => {
   // IDP Enforcement Config
   const connectConfig = appConfig.connect as ConnectConfig
   const idpEnforcement = connectConfig?.login?.idpEnforcement
-  const allowedIdps = connectConfig?.login?.idps
+  const allowedIdps = connectConfig?.login?.idps as string[]
 
   if (idpEnforcement && authUser.value?.loginSource) {
     // User's IDP is not allowed, display idp enforcement modal
-    if (!allowedIdps?.includes(authUser.value?.loginSource.toLowerCase() as unknown as ConnectIdpHint)) {
+    if (!allowedIdps?.includes(authUser.value?.loginSource.toLowerCase())) {
       // Pass redirect url to preserve any query params
       const pathWithQuery = withQuery(localePath('/auth/login'), to.query)
       const url = `${window.location.origin}${pathWithQuery}`

package/app/types/auth-app-config.d.ts

@@ -1,7 +1,7 @@
 declare module 'nuxt/schema' {
   /** What users can write in app.config.ts */
   interface AppConfigInput {
-    connect?: Partial<ConnectConfig>
+    connect?: ConnectConfigInput
     connectOverrides?: Record<string, ConnectPresetOverrides | null>
   }
 

package/app/types/auth-plugins.d.ts

@@ -0,0 +1,11 @@
+import type { $Fetch } from 'ofetch'
+import type Keycloak from 'keycloak-js'
+
+declare module '#app' {
+  interface NuxtApp {
+    $authApi: $Fetch
+    $connectAuth: Keycloak
+  }
+}
+
+export {}

package/app/types/connect-valid-idps.ts

@@ -1,5 +1,3 @@
 export type ConnectValidIdpOption = ConnectIdpHint.BCSC
   | ConnectIdpHint.BCEID
   | ConnectIdpHint.IDIR
-
-export type ConnectValidIdps = ConnectValidIdpOption[]

package/app/utils/index.ts

@@ -1,2 +1 @@
-export * from './constants'
 export * from './schemas'

package/nuxt.config.ts

@@ -96,11 +96,11 @@ export default defineNuxtConfig({
   // Can also force sharedReferences, nodeReferences - and nitro references using the 'nitro:prepare:types' hook
   hooks: {
     'prepare:types': ({ references }) => {
-      // force `#app` augmentations
       references.push(
         { path: resolve('./app/types/auth-app-config.d.ts') },
         { path: resolve('./app/types/auth-nuxt-hooks.d.ts') },
-        { path: resolve('./app/types/auth-page-meta.d.ts') }
+        { path: resolve('./app/types/auth-page-meta.d.ts') },
+        { path: resolve('./app/types/auth-plugins.d.ts') }
       )
     }
   }

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@sbc-connect/nuxt-auth",
   "type": "module",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "repository": "github:bcgov/connect-nuxt",
   "license": "BSD-3-Clause",
   "main": "./nuxt.config.ts",
   "devDependencies": {
     "@axe-core/playwright": "4.11.3",
     "dotenv": "17.4.2",
-    "nuxt": "4.4.6",
+    "nuxt": "4.4.8",
     "typescript": "6.0.3",
     "vue-tsc": "3.3.1",
     "@sbc-connect/eslint-config": "0.0.8",
-    "@sbc-connect/vitest-config": "0.2.0",
-    "@sbc-connect/playwright-config": "0.2.0"
+    "@sbc-connect/playwright-config": "0.2.0",
+    "@sbc-connect/vitest-config": "0.2.0"
   },
   "dependencies": {
     "@pinia/colada": "1.3.0",
@@ -22,8 +22,8 @@
     "keycloak-js": "26.2.4",
     "pinia": "3.0.4",
     "pinia-plugin-persistedstate": "4.7.1",
-    "@sbc-connect/nuxt-base": "0.11.0",
-    "@sbc-connect/nuxt-forms": "0.7.6"
+    "@sbc-connect/nuxt-base": "0.12.0",
+    "@sbc-connect/nuxt-forms": "0.7.7"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",

package/app/enums/connect-preset-type.ts

@@ -1,4 +0,0 @@
-export enum ConnectPresetType {
-  DEFAULT = 'default',
-  BCSC_USER = 'bcscUser'
-}

package/app/utils/constants/index.ts

@@ -1 +0,0 @@
-export * from './valid-idps'

package/app/utils/constants/valid-idps.ts

@@ -1,7 +0,0 @@
-export function getValidIdps(): ConnectValidIdps {
-  return [
-    ConnectIdpHint.BCSC,
-    ConnectIdpHint.BCEID,
-    ConnectIdpHint.IDIR
-  ]
-}