Abstract Class: BaseAuthPasskeyRoute<U, A, S>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:21

Extended by

• BaseAuthPasskeyRouteMongo
• BaseAuthPasskeyRouteSQL

Type Parameters

U

U extends User

A

A extends Alias

S

S extends Secret

Constructors

Constructor

new BaseAuthPasskeyRoute<U, A, S>(): BaseAuthPasskeyRoute<U, A, S>

Returns

BaseAuthPasskeyRoute<U, A, S>

Properties

aliasClass

abstract protected aliasClass: any

Defined in: src/routes/BaseAuthPasskeyRoute.ts:22

---

aliasRepo?

protected optional aliasRepo?: RepoUtils<A>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:26

---

authMiddleware?

protected optional authMiddleware?: AuthMiddleware

Defined in: src/routes/BaseAuthPasskeyRoute.ts:29

---

jwtConfig?

protected optional jwtConfig?: any

Defined in: src/routes/BaseAuthPasskeyRoute.ts:32

---

messagingUtils?

protected optional messagingUtils?: MessagingUtils

Defined in: src/routes/BaseAuthPasskeyRoute.ts:38

---

objectFactory?

protected optional objectFactory?: ObjectFactory

Defined in: src/routes/BaseAuthPasskeyRoute.ts:35

---

passkeyConfig

protected passkeyConfig: PasskeyConfig

Defined in: src/routes/BaseAuthPasskeyRoute.ts:43

---

secretClass

abstract protected secretClass: any

Defined in: src/routes/BaseAuthPasskeyRoute.ts:23

---

secretRepo?

protected optional secretRepo?: RepoUtils<S>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:40

---

userClass

abstract protected userClass: any

Defined in: src/routes/BaseAuthPasskeyRoute.ts:24

---

userRepo?

protected optional userRepo?: RepoUtils<U>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:49

---

userUtils?

protected optional userUtils?: UserUtils<U, A>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:51

Methods

authenticate()

authenticate(user): Promise<AuthResult | undefined>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:116

Authenticates the user using Passkey and returns a JSON Web Token access token to be used with future API requests.

Parameters

user

JWTUser

Returns

Promise<AuthResult | undefined>

---

getCredentialById()

protected getCredentialById(credentialId): Promise<StoredPasskeyCredential | undefined>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:124

Parameters

credentialId

string

Returns

Promise<StoredPasskeyCredential | undefined>

---

getCredentials()

protected getCredentials(id): Promise<StoredPasskeyCredential[]>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:132

Parameters

id

string

Returns

Promise<StoredPasskeyCredential[]>

---

getUser()

protected getUser(id): Promise<JWTUser | undefined>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:162

Retrieve the user associated with a given uid or alias.

Parameters

id

string

The unqique id of the user or alias to lookup.

Returns

Promise<JWTUser | undefined>

---

initialize()

protected initialize(): Promise<void>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:57

Called on server startup to initialize the route with any defaults.

Returns

Promise<void>

---

updateCredentialCounter()

protected updateCredentialCounter(credentialId, newCounter): Promise<void>

Defined in: src/routes/BaseAuthPasskeyRoute.ts:169

Parameters

credentialId

string

newCounter

number

Returns

Promise<void>