Passport

@quik/passport

---

@quik/passport / Passport

Variable: Passport

const Passport: object

Defined in: passport/src/index.ts:14

Type Declaration

Decorators

Decorators: object

Collection of decorators that apply the registered strategies to endpoints.

Decorators.Basic

Basic: <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return> = BasicStrategy.Decorator

Type Parameters

This

This

Args

Args extends any[]

Return

Return

Parameters

target

MethodDecoratorType<This, Args, Return>

context

ClassMethodDecoratorContext<This, MethodDecoratorType<This, Args, Return>>

Returns

MethodDecoratorType<This, Args, Return>

Decorators.Bearer

Bearer: <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return> = BearerStrategy.Decorator

Type Parameters

This

This

Args

Args extends any[]

Return

Return

Parameters

target

MethodDecoratorType<This, Args, Return>

context

ClassMethodDecoratorContext<This, MethodDecoratorType<This, Args, Return>>

Returns

MethodDecoratorType<This, Args, Return>

Decorators.Passkey

Passkey: <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return> = PasskeyStrategy.Decorator

Type Parameters

This

This

Args

Args extends any[]

Return

Return

Parameters

target

MethodDecoratorType<This, Args, Return>

context

ClassMethodDecoratorContext<This, MethodDecoratorType<This, Args, Return>>

Returns

MethodDecoratorType<This, Args, Return>

Passkey

Passkey: object

Public passkey API exposed by @quik/passport.

Passkey.cleanupChallenges

cleanupChallenges: (now?) => number = cleanupPasskeyChallenges

Removes expired or consumed challenges from the active store.

Parameters

now?

number

Optional reference timestamp.

Returns

number

Passkey.clearProviders

clearProviders: () => void = clearPasskeyProviders

Clears all registered passkey providers.

Returns

void

Passkey.createAuthenticationOptions

createAuthenticationOptions: (input) => Promise<QPasskeyAuthenticationOptions>

Creates WebAuthn authentication options and persists the corresponding challenge.

Parameters

input?

QPasskeyAuthenticationInput = {}

Authentication request input.

Returns

Promise<QPasskeyAuthenticationOptions>

Passkey.createRegistrationOptions

createRegistrationOptions: (input) => Promise<QPasskeyRegistrationOptions>

Creates WebAuthn registration options and persists the corresponding challenge.

Parameters

input

QPasskeyRegistrationInput

Registration request input.

Returns

Promise<QPasskeyRegistrationOptions>

Passkey.getChallengeStore

getChallengeStore: () => IQPasskeyChallengeStore = getPasskeyChallengeStore

Returns the active passkey challenge store.

Returns

IQPasskeyChallengeStore

Passkey.getCredentialStore

getCredentialStore: () => IQPasskeyCredentialStore = getPasskeyCredentialStore

Returns the active passkey credential store.

Returns

IQPasskeyCredentialStore

Passkey.getProvider

getProvider: (name) => IQPasskeyProvider = getPasskeyProvider

Returns a registered passkey provider.

Parameters

name?

string = defaultProviderName

Provider name.

Returns

IQPasskeyProvider

Throws

QTranslatableError When provider is not registered.

Passkey.InMemoryPasskeyChallengeStore

InMemoryPasskeyChallengeStore: typeof InMemoryPasskeyChallengeStore

Passkey.InMemoryPasskeyCredentialStore

InMemoryPasskeyCredentialStore: typeof InMemoryPasskeyCredentialStore

Passkey.setChallengeStore

setChallengeStore: (store) => void = setPasskeyChallengeStore

Replaces the active passkey challenge store.

Parameters

store

IQPasskeyChallengeStore

Store implementation.

Returns

void

Passkey.setCredentialStore

setCredentialStore: (store) => void = setPasskeyCredentialStore

Replaces the active passkey credential store.

Parameters

store

IQPasskeyCredentialStore

Store implementation.

Returns

void

Passkey.setProvider

setProvider: (provider, name) => void = setPasskeyProvider

Registers a passkey provider by name.

Parameters

provider

IQPasskeyProvider

Provider implementation.

name?

string = defaultProviderName

Provider name.

Returns

void

Passkey.verifyAuthentication

verifyAuthentication: (challengeId, response, request?) => Promise<IQUser>

Verifies an authentication response through the configured provider.

Parameters

challengeId

string

Persisted challenge id.

response

Record<string, unknown>

Raw client response payload.

request?

Request

Optional HTTP request context.

Returns

Promise<IQUser>

Passkey.verifyRegistration

verifyRegistration: (challengeId, response, request?) => Promise<boolean>

Verifies a registration response through the configured provider.

Parameters

challengeId

string

Persisted challenge id.

response

Record<string, unknown>

Raw client response payload.

request?

Request

Optional HTTP request context.

Returns

Promise<boolean>

passport

passport: PassportStatic

Providers

Providers: object

Providers.all

all: () => Record<string, OAuthProviderDefinition> = getOAuthProviders

Return all known OAuth providers.

Returns

Record<string, OAuthProviderDefinition>

Providers.Decorators

Decorators: object = OAuthProviderDecorators

Providers.Decorators.Callback

Callback: (providerName, options?) => <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Decorator that handles the callback from an OAuth provider.

Parameters

providerName

string

Provider identifier.

options?

AuthenticateOptions

Additional authentication options.

Returns

<This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Providers.Decorators.Redirect

Redirect: (providerName, options?) => <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Decorator that redirects a request to the selected OAuth provider.

Parameters

providerName

string

Provider identifier.

options?

AuthenticateOptions

Additional authentication options.

Returns

<This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Providers.get

get: (name) => OAuthProviderDefinition = getOAuthProvider

Returns one OAuth provider by name.

Parameters

name

string

Provider name.

Returns

OAuthProviderDefinition

Providers.register

register: (provider) => void = registerOAuthProvider

Register an OAuth provider definition.

Parameters

provider

OAuthProviderDefinition

Provider registration details.

Returns

void

Providers.registerAll

registerAll: () => void = registerOAuthProviders

Registers all OAuth providers in the passport runtime.

Returns

void

Providers.registerBatch

registerBatch: (providers) => void = registerOAuthProviderBatch

Register multiple OAuth providers in one call.

Parameters

providers

OAuthProviderDefinition[]

Provider list.

Returns

void

Scalar

Scalar: object

Scalar.createPasskeyConfiguration

createPasskeyConfiguration: () => Partial<ApiReferenceConfiguration> = createPasskeyScalarConfiguration

Builds the Scalar configuration extension used by the passkey docs helper.

Returns

Partial<ApiReferenceConfiguration>

Strategies

Strategies: object

Strategies.all

all: () => Record<string, StrategyRegistrar> = listStrategies

Returns all strategies currently configured for registration.

Returns

Record<string, StrategyRegistrar>

Strategies.register

register: (name, registrar) => void = registerStrategy

Register a strategy so it is available during module bootstrap.

Parameters

name

string

Strategy identifier.

registrar

StrategyRegistrar

Callback used to register the strategy with passport.

Returns

void

Strategies.registerBatch

registerBatch: (strategies) => void = registerStrategyBatch

Register multiple strategies in one call.

Parameters

strategies

Record<string, StrategyRegistrar>

Strategies keyed by identifier.

Returns

void