@manta-eu/auth

Reference for @manta-eu/auth as it is on main, generated from its TypeScript sources.

The last release is 0.8.1. An export added on main since then arrives with the next release.

pnpm add @manta-eu/auth

Entry points

Type Aliases

ClientOptions

ClientOptions = object

Properties

clientId?

optional clientId?: string

keycloakRealm

keycloakRealm: string

keycloakUrl

keycloakUrl: string

CliTokenOptions

CliTokenOptions = ClientOptions & LoginOptions & object

Type Declaration

scope?

optional scope?: string

CliTokenSettings

CliTokenSettings = object

Properties

fetchImpl?

optional fetchImpl?: FetchLike

interactive?

optional interactive?: boolean

label

label: string

secret?

optional secret?: string

store?

optional store?: CredentialStore

CredentialStore

CredentialStore = object

Properties

read

read: (client) => Promise<StoredLogin | undefined>

Parameters

client

PublicClient

Returns

Promise<StoredLogin | undefined>

remove

remove: (client) => Promise<void>

Parameters

client

PublicClient

Returns

Promise<void>

write

write: (client, login) => Promise<void>

Parameters

client

PublicClient

StoredLogin

Returns

Promise<void>

DeviceLogin

DeviceLogin = object

Properties

codeVerifier

codeVerifier: string

deviceCode

deviceCode: string

expiresInMs

expiresInMs: number

intervalMs

intervalMs: number

userCode

userCode: string

verificationUri

verificationUri: string

DeviceTokens

DeviceTokens = object

Properties

accessToken

accessToken: string

refreshToken?

optional refreshToken?: string

LoginOptions

LoginOptions = object

Properties

useDeviceCode?

optional useDeviceCode?: boolean

PkcePair

PkcePair = object

Properties

challenge

challenge: string

verifier

verifier: string

RunSecurity

RunSecurity = (args, stdin?) => Promise<SecurityResult>

Parameters

args

string[]

stdin?

string

Returns

Promise<SecurityResult>

SecurityResult

SecurityResult = object

Properties

code

code: number

stdout

stdout: string

Sleep

Sleep = (ms) => Promise<void>

Parameters

ms

number

Returns

Promise<void>

StoredLogin

StoredLogin = object

Properties

refreshToken

refreshToken: string

savedAt?

optional savedAt?: number

username?

optional username?: string

Variables

ciClientId

const ciClientId: "manta-codegen" = "manta-codegen"

clientIdHelp

const clientIdHelp: "Keycloak client id (default: <realm>-cli, or manta-codegen with MANTA_CLIENT_SECRET)"

loginScope

const loginScope: "openid offline_access" = "openid offline_access"

Functions

browserLogin()

browserLogin(client, __namedParameters): Promise<DeviceTokens>

Parameters

client

PublicClient

__namedParameters

fetchImpl?

FetchLike = fetch

openUrl

(url) => void

pkce?

PkcePair = ...

scope?

string = loginScope

state?

string = ...

timeoutMs?

number = defaultTimeoutMs

Returns

Promise<DeviceTokens>

cliClientId()

cliClientId(realm): string

Parameters

realm

string

Returns

string

cliTokenSource()

cliTokenSource(options, __namedParameters): RenewableTokenSource

Parameters

defaultCredentialStore()

defaultCredentialStore(__namedParameters?): CredentialStore

Parameters

__namedParameters?

platform?

string = process.platform

warn?

(message) => void = console.error

Returns

CredentialStore

fileCredentialStore()

fileCredentialStore(path?): CredentialStore

Parameters

path?

string = ...

Returns

CredentialStore

interactiveLogin()

interactiveLogin(client, __namedParameters): Promise<DeviceTokens>

Parameters

client

PublicClient

__namedParameters

fetchImpl?

FetchLike = fetch

label

string

useDeviceCode?

boolean = false

Returns

Promise<DeviceTokens>

keychainCredentialStore()

keychainCredentialStore(run?): CredentialStore

Parameters

run?

RunSecurity = runSecurity

Returns

CredentialStore

keychainWithFileFallback()

keychainWithFileFallback(keychain, file, __namedParameters?): CredentialStore

Parameters

keychain

CredentialStore

file

CredentialStore

__namedParameters?

clock?

() => number = Date.now

warn?

(reason) => void = ...

Returns

CredentialStore

logIn(client, __namedParameters): Promise<void>

Parameters

client

PublicClient

__namedParameters

fetchImpl?

FetchLike = fetch

label

string

store

CredentialStore

useDeviceCode?

boolean

Returns

Promise<void>

loginStatus()

loginStatus(client, __namedParameters): Promise<{ line: string; loggedIn: boolean; }>

Parameters

client

PublicClient

__namedParameters

store

CredentialStore

Returns

Promise<{ line: string; loggedIn: boolean; }>

logOut()

logOut(client, __namedParameters): Promise<void>

Parameters

client

PublicClient

__namedParameters

fetchImpl?

FetchLike = fetch

label

string

store

CredentialStore

Returns

Promise<void>

pollForDeviceTokens()

pollForDeviceTokens(client, __namedParameters, __namedParameters?): Promise<DeviceTokens>

Parameters

client

PublicClient

__namedParameters

Pick<DeviceLogin, "deviceCode" | "codeVerifier"> & object

__namedParameters?

clock?

() => number = Date.now

fetchImpl?

FetchLike = fetch

sleep?

Sleep = sleepFor

Returns

Promise<DeviceTokens>

postTo()

postTo(endpoint, init, fetchImpl?): Promise<Response>

Parameters

endpoint

string

init

RequestInit

fetchImpl?

FetchLike = fetch

Returns

Promise<Response>

publicClientFrom()

publicClientFrom(__namedParameters): PublicClient

Parameters

__namedParameters

ClientOptions

Returns

PublicClient

readJson()

readJson<T>(response, endpoint): Promise<T>

Type Parameters

T

T

Parameters

response

Response

endpoint

string

Returns

Promise<T>

refreshAccessToken()

refreshAccessToken(client, refreshToken, fetchImpl?): Promise<DeviceTokens | undefined>

Parameters

client

PublicClient

refreshToken

string

fetchImpl?

FetchLike = fetch

Returns

Promise<DeviceTokens | undefined>

registerAuthCommands()

registerAuthCommands(program, __namedParameters): void

Parameters

program

Command

__namedParameters

fetchImpl?

FetchLike = fetch

label

string

store?

CredentialStore = ...

Returns

void

revokeRefreshToken()

revokeRefreshToken(client, refreshToken, fetchImpl?): Promise<boolean>

Parameters

client

PublicClient

refreshToken

string

fetchImpl?

FetchLike = fetch

Returns

Promise<boolean>

saveLogin()

saveLogin(store, client, tokens): Promise<boolean>

Parameters

store

CredentialStore

client

PublicClient

tokens

DeviceTokens

Returns

Promise<boolean>

startDeviceLogin()

startDeviceLogin(client, fetchImpl?, pkce?, scope?): Promise<DeviceLogin>

Parameters

client

PublicClient

fetchImpl?

FetchLike = fetch

pkce?

PkcePair = ...

scope?

string

Returns

Promise<DeviceLogin>

storedLoginTokenSource()

storedLoginTokenSource(__namedParameters): RenewableTokenSource

Parameters

__namedParameters

client

PublicClient

clock?

() => number = Date.now

fetchImpl?

FetchLike = fetch

() => Promise<DeviceTokens>

store

CredentialStore

warn?

(message) => void = console.error

Returns

RenewableTokenSource

userTokenSource()

userTokenSource(client, __namedParameters): RenewableTokenSource

Parameters

client

PublicClient

__namedParameters

fetchImpl?

FetchLike = fetch

interactive?

boolean = ...

label

string

store?

CredentialStore = ...

useDeviceCode?

boolean

Returns

RenewableTokenSource

References

AnonymousCustomAppVisitor

Re-exports AnonymousCustomAppVisitor

cachedToken

Re-exports cachedToken

ClientCredentials

Re-exports ClientCredentials

customAppUserAccessToken

Re-exports customAppUserAccessToken

CustomAppUserAccessTokenOptions

Re-exports CustomAppUserAccessTokenOptions

CustomAppUserGrantBase

Re-exports CustomAppUserGrantBase

defaultDeployment

Re-exports defaultDeployment

describeError

Re-exports describeError

discoveryUrl

Re-exports discoveryUrl

endWebLogin

Re-exports endWebLogin

FetchLike

Re-exports FetchLike

finishWebLogin

Re-exports finishWebLogin

IdentifiedCustomAppUser

Re-exports IdentifiedCustomAppUser

issuerUrl

Re-exports issuerUrl

isTransientStatus

Re-exports isTransientStatus

mintWithClientCredentials

Re-exports mintWithClientCredentials

OidcClient

Re-exports OidcClient

PublicClient

Re-exports PublicClient

Realm

Re-exports Realm

refreshWebLogin

Re-exports refreshWebLogin

RefusedRequestError

Re-exports RefusedRequestError

RenewableTokenSource

Re-exports RenewableTokenSource

startWebLogin

Re-exports startWebLogin

StartWebLoginOptions

Re-exports StartWebLoginOptions

TokenSource

Re-exports TokenSource

webLoginRoutes

Re-exports webLoginRoutes

WebLoginRoutes

Re-exports WebLoginRoutes

WebLoginRoutesOptions

Re-exports WebLoginRoutesOptions

WebLoginStart

Re-exports WebLoginStart

WebLogoutOptions

Re-exports WebLogoutOptions

webLogoutUrl

Re-exports webLogoutUrl

WebSession

Re-exports WebSession

WebTokens

Re-exports WebTokens

withRenewal

Re-exports withRenewal