new: export AuthState interface so users can augment FeathersVuexStoreState

Author: hamiltoes

src/auth-module/auth-module.state.ts

@@ -3,13 +3,15 @@ eslint
 @typescript-eslint/explicit-function-return-type: 0,
 @typescript-eslint/no-explicit-any: 0
 */
+import { AuthState } from './types'
+
 export default function setupAuthState({
   userService,
   serverAlias,
   responseEntityField = 'user',
   entityIdField = 'userId'
 }) {
-  const state = {
+  const state: AuthState = {
     accessToken: null, // The JWT
     payload: null, // The JWT payload
     entityIdField,
@@ -21,6 +23,7 @@ export default function setupAuthState({
     errorOnAuthenticate: null,
     errorOnLogout: null,
     user: null, // For a reactive user object, use the `user` getter.
+    userService: null,
     serverAlias
   }
   // If a userService string was passed, add a user attribute

src/auth-module/types.ts

@@ -2,11 +2,14 @@ export interface AuthState {
   accessToken: string
   payload: {}
   entityIdField: string
+  responseEntityField: string
 
   isAuthenticatePending: boolean
   isLogoutPending: boolean
 
   errorOnAuthenticate: Error
   errorOnLogout: Error
   user: {}
+  userService: string
+  serverAlias: string
 }

src/index.ts

@@ -34,6 +34,7 @@ import {
 import { initAuth, hydrateApi } from './utils'
 import { FeathersVuex } from './vue-plugin/vue-plugin'
 import { ServiceState } from './service-module/service-module.state'
+import { AuthState } from './auth-module/types'
 const events = ['created', 'patched', 'updated', 'removed']
 
 const defaults: FeathersVuexOptions = {
@@ -107,6 +108,7 @@ export {
   clients,
   useFind,
   useGet,
+  AuthState,
   Id,
   Model,
   ModelClone,