@passageidentity/passage-js/README.md

Passage Complete for Web - Build a full custom passwordless authentication experience in any modern web app with Passage by 1Password.

![passage-js](https://storage.googleapis.com/passage-docs/github-md-assets/passage-js.png)

![NPM Version](https://img.shields.io/npm/v/%40passageidentity%2Fpassage-js)
![NPM Type Definitions](https://img.shields.io/npm/types/%40passageidentity%2Fpassage-js)
![NPM License](https://img.shields.io/npm/l/%40passageidentity%2Fpassage-js)
![Static Badge](https://img.shields.io/badge/Built_by_1Password-grey?logo=1password)

## About

[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease. 

Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience.

Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution.

Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys.

### In passage-js

Passage-JS provides a convenient JavaScript interface to handling all client-side operations for user authentication and management with Passkey Complete. If you're looking for a pre-built UI that handles everything for you elegantly check out our UI library [passage-elements](https://www.npmjs.com/package/@passageidentity/passage-elements) or [passage-react](https://www.npmjs.com/package/@passageidentity/passage-react).

What's Included?

🙆 Getting and editing information about the currently authenticated user.

🤝 Managing the session of the current user.

🔒 Full passkey authentication.

✨ Magic Link and One-Time Passcodes over email or SMS.

👥 Authentication with Social providers.

🪙 Custom token management.

| Product | Compatible |
| --- | --- |
| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** | ✖️ For Passkey Flex, check out [passage-flex-js](https://www.npmjs.com/package/@passageidentity/passage-flex-js)
| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** | ✅
| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** | ✖️ For Passkey Ready, check out [Authentikit](https://www.npmjs.com/package/@passageidentity/authentikit)

<br />

## Getting Started

### Check Prerequisites

<p>
 You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
 <sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
</p>

### Install
```shell
npm i @passageidentity/passage-js
```

### Import
```js
import { Passage } from '@passageidentity/passage-js'
```

### Initialize
```js
const passage = new Passage('YOUR_PASSAGE_APP_ID');
```

### Go Passwordless

Find aditional customization options and more implementation guidance on our [Passkey JS Documentation](https://docs.passage.id/complete/passage-js) page.

## Support & Feedback

We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md). 

<br />

---

<p align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png">
      <source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
      <img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
    </picture>
</p>

<p align="center">
    <sub>Passage is a product by <a href="https://1password.com/product/passage">1Password</a>, the global leader in access management solutions with nearly 150k business customers.</sub><br />
    <sub>This project is licensed under the MIT license. See the <a href="_media/LICENSE">LICENSE</a> file for more info.</sub>
</p>

# API Reference

## Classes

### Passage

The Passage class used to perform register and login operations.
The only parameter is the app handle for the application.

#### Example

```
import Passage from '@passageidentity/passage-js';
const passage = new Passage(app_id);
```

#### Constructors

##### new Passage()

> **new Passage**(`appID`, `config`?): [`Passage`](README.md#passage)

Constructor configuring the Passage class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `appID` | `string` | the App's corresponding AppID |
| `config`? | [`PassageConfig`](README.md#passageconfig) | An optional parameter to pass in configurable properties. The tokenStore property is an object that implements ReadOnlyTokenStore or TokenStore to manage retrieval and storage of tokens. If no tokenStore is provided by default Passage will store tokens in a combination of localstorage and cookies. |

###### Returns

[`Passage`](README.md#passage)

#### Properties

##### app

> **app**: [`PassageApp`](README.md#passageapp)

PassageApp class contains functions that operate on the Passage app level.

##### currentUser

> **currentUser**: [`PassageCurrentUser`](README.md#passagecurrentuser)

The PassageCurrentUser class contains functions to get information about the currently authenticated user.

##### magicLink

> **magicLink**: [`PassageMagicLink`](README.md#passagemagiclink)

PassageMagicLink class contains functions that use magic links for authentication, identitfy verification, and handling identifier changes.

##### oneTimePasscode

> **oneTimePasscode**: [`PassageOneTimePasscode`](README.md#passageonetimepasscode)

PassageOneTimePasscode class contains functions that use one-time passcodes for authentication.

##### passkey

> **passkey**: [`PassagePasskey`](README.md#passagepasskey)

PassagePasskey class contains functions that use passkeys for authentication and utilities to help with passkey UX decisions.

##### session

> **session**: [`PassageSession`](README.md#passagesession)

The PassageSession class used to manage Passage sessions using refresh tokens.

##### social

> **social**: [`PassageSocial`](README.md#passagesocial)

PassageSocial class contains functions that use social providers for authentication.

***

### PassageApp

PassageApp class contains functions that operate on the Passage app level.

#### Extends

- `PassageBase`\<`AppsApi`\>

#### Constructors

##### new PassageApp()

> **new PassageApp**(`instanceConfig`): [`PassageApp`](README.md#passageapp)

Constructor configuring the App class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |

###### Returns

[`PassageApp`](README.md#passageapp)

###### Overrides

`PassageBase<AppsApi>.constructor`

#### Methods

##### createUser()

> **createUser**(`identifier`, `userMetadata`?): `Promise`\<`User`\>

createUser creates a user in a 'pending' state.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` | the email or phone number of the user |
| `userMetadata`? | [`Metadata`](README.md#metadata-1) | optional metadata to associate with the user |

###### Returns

`Promise`\<`User`\>

##### info()

> **info**(): `Promise`\<`App`\>

Get information about an app.

###### Returns

`Promise`\<`App`\>

a data object containing app information and the authentication policy

###### Example

```javascript
import Passage from '@passageidentity/passage-js';

const passage = new Passage(appId);

await passage.app.info()
 .then(data => {
     // look at information regarding a particular app
 }).catch(e => console.log(e));
```

##### userExists()

> **userExists**(`identifier`): `Promise`\<`User`\>

Look-up a user and return the user properties if the user exists

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` | email address / phone for user |

###### Returns

`Promise`\<`User`\>

***

### PassageCurrentUser

The PassageCurrentUser class contains functions to get information about the currently authenticated user.

#### Extends

- `PassageBaseAuthenticated`\<`CurrentuserApi`\>

#### Constructors

##### new PassageCurrentUser()

> **new PassageCurrentUser**(`instanceConfig`, `session`): [`PassageCurrentUser`](README.md#passagecurrentuser)

constructor for the CurrentUser class.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |
| `session` | [`PassageSession`](README.md#passagesession) | - |

###### Returns

[`PassageCurrentUser`](README.md#passagecurrentuser)

###### Overrides

`PassageBaseAuthenticated<CurrentuserApi>.constructor`

#### Methods

##### addPasskey()

> **addPasskey**(`options`?): `Promise`\<`Credential_2`\>

addPasskey register a new passkey for the current user.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options`? | `PasskeyCreationOptions` | Optional configuration for passkey creation |

###### Returns

`Promise`\<`Credential_2`\>

the new passkey regsitered for the current user.

##### changeEmail()

> **changeEmail**(`newEmail`, `language`?): `Promise`\<`MagicLink`\>

changeEmail initiates an email change for the authenticated user. An email change requires verification, so an email will be sent to the user which they must verify before the email change takes effect.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `newEmail` | `string` |  |
| `language`? | `string` | the language string for localizing emails, if no lanuage or an invalid language is provided the application default lanuage will be used |

###### Returns

`Promise`\<`MagicLink`\>

the magicLink response on success.

##### changePhone()

> **changePhone**(`newPhone`, `language`?): `Promise`\<`MagicLink`\>

changePhone initiates a phone number change for the authenticated user. An phone number change requires verification, so an SMS with a link will be sent to the user which they must verify before the phone number change takes effect.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `newPhone` | `string` |  |
| `language`? | `string` | the language string for localizing emails, if no lanuage or an invalid language is provided the application default lanuage will be used |

###### Returns

`Promise`\<`MagicLink`\>

the magicLink response on success.

##### deletePasskey()

> **deletePasskey**(`passkey`): `Promise`\<`boolean`\>

deletePasskey deletes an existing passkey for the current user.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `passkey` | `Credential_2` | the passkey to be deleted |

###### Returns

`Promise`\<`boolean`\>

true if the device has been deleted successfully.

##### deleteSocialConnection()

> **deleteSocialConnection**(`socialConnectionType`): `Promise`\<`boolean`\>

deleteSocialConnection deletes an existing social connection for the current user.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `socialConnectionType` | [`SocialConnection`](README.md#socialconnection) | the social connection to be deleted |

###### Returns

`Promise`\<`boolean`\>

true if the social connection has been deleted successfully.

##### editPasskey()

> **editPasskey**(`passkeyId`, `friendlyName`): `Promise`\<`Credential_2`\>

editPasskey allows the passkey's friendly name to be changed.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `passkeyId` | `string` |  |
| `friendlyName` | `string` |  |

###### Returns

`Promise`\<`Credential_2`\>

the edited device after applying the requested device attribute changes.

##### listSocialConnections()

> **listSocialConnections**(): `Promise`\<`UserSocialConnections`\>

listSocialConnections is used to list the current user's social connections.

###### Returns

`Promise`\<`UserSocialConnections`\>

the current social connections and their properties.

##### metadata()

> **metadata**(): `Promise`\<[`Metadata`](README.md#metadata-1)\>

getMetadata returns the metadata for the currently authenticated user.

###### Returns

`Promise`\<[`Metadata`](README.md#metadata-1)\>

the current Passage user's info, or undefined if the
current Passage user's authentication token could not be validated.

##### passkeys()

> **passkeys**(): `Promise`\<`Credential_2`[]\>

Get the list of the current users's passkeys.

###### Returns

`Promise`\<`Credential_2`[]\>

the array of passkeys.

##### updateMetadata()

> **updateMetadata**(`metadata`): `Promise`\<`CurrentUser`\>

updateMetadata updates the metadata for the currentuser. Note that only metadata fields set for the app can be updated.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `metadata` | [`Metadata`](README.md#metadata-1) |  |

###### Returns

`Promise`\<`CurrentUser`\>

the current user with their newly updated metadata field.

##### userInfo()

> **userInfo**(): `Promise`\<`CurrentUser`\>

userInfo returns the user information for the currently authenticated user. If the user is not authenticated, an error is thrown.

###### Returns

`Promise`\<`CurrentUser`\>

the current Passage user's info
current Passage user's authentication token could not be validated.

***

### PassageMagicLink

PassageMagicLink class contains functions that use magic links for authentication, identitfy verification, and handling identifier changes.

#### Extends

- `PassageBase`\<`MagicLinkApi`\>

#### Constructors

##### new PassageMagicLink()

> **new PassageMagicLink**(`instanceConfig`): [`PassageMagicLink`](README.md#passagemagiclink)

Constructor configuring the PassageMagicLink class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |

###### Returns

[`PassageMagicLink`](README.md#passagemagiclink)

###### Overrides

`PassageBase<MagicLinkApi>.constructor`

#### Methods

##### activate()

> **activate**(`magicLink`): `Promise`\<`AuthResult`\>

Activates a magic link. Handles login, registration, identifier verification, and identifier change magic links. 
Will throw an error if the magic link is invalid, expired, or has already been activated.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `magicLink` | `string` | The magic link to activate |

###### Returns

`Promise`\<`AuthResult`\>

##### login()

> **login**(`identifier`, `language`?): `Promise`\<`MagicLink`\>

Creates a new magic link for login. Will throw an error if the user does not exist.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` | The Passage User's identifier |
| `language`? | `string` | the language string for localizing emails, if no lanuage or an invalid language is provided the application default lanuage will be used |

###### Returns

`Promise`\<`MagicLink`\>

MagicLink JSON payload

##### register()

> **register**(`identifier`, `language`?): `Promise`\<`MagicLink`\>

Create a new magic link for registration. Will throw an error if the user has already logged into their account at least once.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` | The Passage User's identifier |
| `language`? | `string` | the language string for localizing emails, if no lanuage or an invalid language is provided the application default lanuage will be used |

###### Returns

`Promise`\<`MagicLink`\>

MagicLink JSON payload

##### status()

> **status**(`id`): `Promise`\<`AuthResult`\>

Look up a magic link by ID and check if it has been verified. This function is most commonly used to
iteratively check if a user has clicked a magic link to login. Once the link has been verified,
Passage will return authentication information via this endpoint. This enables cross-device login.
This will throw an error if the magic link is not activated.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `id` | `string` | unique ID for an magic link which is returned by functions that create a magic link |

###### Returns

`Promise`\<`AuthResult`\>

***

### PassageOneTimePasscode

PassageOneTimePasscode class contains functions that use one-time passcodes for authentication.

#### Extends

- `PassageBase`\<`OTPApi`\>

#### Constructors

##### new PassageOneTimePasscode()

> **new PassageOneTimePasscode**(`instanceConfig`): [`PassageOneTimePasscode`](README.md#passageonetimepasscode)

Constructor configuring the PassageOneTimePasscode class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |

###### Returns

[`PassageOneTimePasscode`](README.md#passageonetimepasscode)

###### Overrides

`PassageBase<OTPApi>.constructor`

#### Methods

##### activate()

> **activate**(`oneTimePasscode`, `id`): `Promise`\<`AuthResult`\>

Activates a one-time passcode. Handles login and registration one-time passcodes.
Will throw an error if the one-time passcode is invalid, expired, or has already been activated.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `oneTimePasscode` | `string` | The one-time passcode provided by the user from their email or text message. |
| `id` | `string` | The id associated with the one-time passcode. |

###### Returns

`Promise`\<`AuthResult`\>

##### login()

> **login**(`identifier`, `language`?): `Promise`\<`OneTimePasscodeResponse`\>

Create a new one-time passcode for login. Will throw an error if the user does not exist.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` | The Passage User's identifier |
| `language`? | `string` | the language string for localizing emails, if no lanuage or an invalid language is provided the application default lanuage will be used |

###### Returns

`Promise`\<`OneTimePasscodeResponse`\>

One-time passcode object

##### register()

> **register**(`identifier`, `language`?): `Promise`\<`OneTimePasscodeResponse`\>

Create a new one-time passcode for registration. Will throw an error if the user has already logged into their account at least once.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` | The Passage User's identifier |
| `language`? | `string` | the language string for localizing emails, if no lanuage or an invalid language is provided the application default lanuage will be used |

###### Returns

`Promise`\<`OneTimePasscodeResponse`\>

One-time passcode object

***

### PassagePasskey

PassagePasskey class contains functions that use passkeys for authentication and utilities to help with passkey UX decisions.

#### Constructors

##### new PassagePasskey()

> **new PassagePasskey**(`instanceConfig`, `app`): [`PassagePasskey`](README.md#passagepasskey)

Constructor configuring the Passkey class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |
| `app` | [`PassageApp`](README.md#passageapp) | - |

###### Returns

[`PassagePasskey`](README.md#passagepasskey)

#### Methods

##### checkPasskeyOrigin()

> **checkPasskeyOrigin**(): `Promise`\<`boolean`\>

Checks if an application's auth origin matches the current origin on an end user's browser.
If this function returns false, passkeys will not work properly on this domain.

###### Returns

`Promise`\<`boolean`\>

##### createCredentialAvailable()

> **createCredentialAvailable**(): `Promise`\<`ICreateCredentialFeatures`\>

Uses information about the user's current browser to determine what features are availble for creating credentials via WebAuthn.
NOTE: Do not call this from an event handler where navigator.get or navigator.create is invoked or it will break the required user gesture on iOS web browsers.

###### Returns

`Promise`\<`ICreateCredentialFeatures`\>

The set of features supported by the browser.

##### getCredentialAvailable()

> **getCredentialAvailable**(): `Promise`\<`IGetCredentialFeatures`\>

Uses information about the user's current browser to determine what features are availble for getting credentials via WebAuthn.
NOTE: Do not call this from an event handler where navigator.get or navigator.create is invoked or it will break the required user gesture on iOS web browsers.

###### Returns

`Promise`\<`IGetCredentialFeatures`\>

The set of features supported by the browser.

##### hasLocalPasskey()

> **hasLocalPasskey**(`userId`): `boolean`

Checks to see if the user has any platform passkeys.
This happens by checking to see if we have the userID and an associated passkey credential stored in localStorage via
the key psg_cred_obj.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `userId` | `string` | the Passage User's userID |

###### Returns

`boolean`

returns true if psg_cred_obj exists in localstorage, false if not

##### login()

> **login**(`identifier`?, `options`?): `Promise`\<`AuthResult`\>

Logs in an existing user with a passkey. Will throw an error if the user does not exist, has no passkeys, or if the operation is cancelled with an abort signal.
If no identifier is provided, the user will be prompted to select an identifier, formally known as WebAuthn discoverable credentials.
If implementing passkey autocomplete, formally known as WebAuthn conditional mediation, no identifier should be provided and the isConditionalMediation option should be set to true.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier`? | `string` |  |
| `options`? | [`PasskeyLoginOptions`](README.md#passkeyloginoptions) |  |

###### Returns

`Promise`\<`AuthResult`\>

The authentication token, redirect URL, and refresh token, if configured for the application.

##### register()

> **register**(`identifier`, `options`?): `Promise`\<`AuthResult`\>

Registers a new user with a passkey. Will throw an error if the user has already logged into their account at lesst once.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `identifier` | `string` |  |
| `options`? | `PasskeyCreationOptions` |  |

###### Returns

`Promise`\<`AuthResult`\>

The authentication token, redirect URL, and refresh token, if configured for the application.

***

### PassageSession

The PassageSession class used to manage Passage sessions using refresh tokens.

#### Extends

- `PassageBase`\<`TokensApi`\>

#### Constructors

##### new PassageSession()

> **new PassageSession**(`instanceConfig`): [`PassageSession`](README.md#passagesession)

Constructor configuring the PassageOneTimePasscode class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |

###### Returns

[`PassageSession`](README.md#passagesession)

###### Overrides

`PassageBase<TokensApi>.constructor`

#### Methods

##### authGuard()

> **authGuard**(): `Promise`\<`boolean`\>

authGuard checks if the current user has a JWT that is valid and potentially verifiable.
IMPORTANT: this is not verifying the JWT, it is only checking if the JWT is formatted properly.

###### Returns

`Promise`\<`boolean`\>

true if the user has a valid (but unverified) JWT, false if not.

##### getAuthToken()

> **getAuthToken**(): `Promise`\<`string`\>

getAuthToken gets the current authToken for the currently authenticated user.

###### Returns

`Promise`\<`string`\>

returns the user's authToken if it exists or fetches a new one with a refresh token if it exists

##### refresh()

> **refresh**(): `Promise`\<`AuthResult`\>

refresh gets and saves a new authToken for the currently authenticated user using their refresh token

###### Returns

`Promise`\<`AuthResult`\>

returns the user's authToken if successful

##### signOut()

> **signOut**(): `Promise`\<`boolean`\>

Sign out a user by deleting their AuthToken from local storage and revoking their refresh token.

###### Returns

`Promise`\<`boolean`\>

true if the device has been deleted successfully.

***

### PassageSocial

PassageSocial class contains functions that use social providers for authentication.

#### Extends

- `PassageBase`\<`OAuth2Api`\>

#### Constructors

##### new PassageSocial()

> **new PassageSocial**(`instanceConfig`): [`PassageSocial`](README.md#passagesocial)

Constructor configuring the PassageSocial class' attributes

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `instanceConfig` | `PassageInstanceConfig` | the config of the current Passage instance |

###### Returns

[`PassageSocial`](README.md#passagesocial)

###### Overrides

`PassageBase<OAuth2Api>.constructor`

#### Methods

##### authorize()

> **authorize**(`connection`): `Promise`\<`void`\>

Initiates authorization via a supported third-party social provider.
This must be run from a secure context (HTTPS or localhost).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `connection` | [`SocialConnection`](README.md#socialconnection) | The social connection to use for login. |

###### Returns

`Promise`\<`void`\>

##### finish()

> **finish**(`code`): `Promise`\<`AuthResult`\>

Finishes a social login by exchanging the social login provider code for Passage tokens.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `code` | `string` | The code returned from the social login provider |

###### Returns

`Promise`\<`AuthResult`\>

***

### PassageTokenStore

PassageTokenStore class provides the Passage default token storage mechanism.
The auth token is stored in localStorage and cookies.
The refresh token is stored in localStorage only.

#### Extends

- [`TokenStore`](README.md#tokenstore)

#### Constructors

##### new PassageTokenStore()

> **new PassageTokenStore**(): [`PassageTokenStore`](README.md#passagetokenstore)

###### Returns

[`PassageTokenStore`](README.md#passagetokenstore)

###### Inherited from

[`TokenStore`](README.md#tokenstore).[`constructor`](README.md#constructors-10)

#### Methods

##### clearTokens()

> **clearTokens**(): `Promise`\<`void`\>

Clears the auth token from localstorage and cookies and refresh token from localstorage

###### Returns

`Promise`\<`void`\>

###### Overrides

[`TokenStore`](README.md#tokenstore).[`clearTokens`](README.md#cleartokens-1)

##### getAuthToken()

> **getAuthToken**(): `Promise`\<`string`\>

Gets the current auth token

###### Returns

`Promise`\<`string`\>

The current auth token

###### Overrides

[`TokenStore`](README.md#tokenstore).[`getAuthToken`](README.md#getauthtoken-3)

##### getRefreshToken()

> **getRefreshToken**(): `Promise`\<`undefined` \| `string`\>

Gets the current refresh token

###### Returns

`Promise`\<`undefined` \| `string`\>

The current refresh token

###### Overrides

[`TokenStore`](README.md#tokenstore).[`getRefreshToken`](README.md#getrefreshtoken-2)

##### setTokens()

> **setTokens**(`authResult`): `Promise`\<`void`\>

Sets the auth token and refresh token, if used

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `authResult` | `AuthResult` |  |

###### Returns

`Promise`\<`void`\>

###### Overrides

[`TokenStore`](README.md#tokenstore).[`setTokens`](README.md#settokens-1)

***

### `abstract` ReadOnlyTokenStore

Base class for implementing read-only token stores. getAuthToken() is the only required function to implement.
If a Passage object is built with a read-only token store it will not handle any token storage.

#### Extended by

- [`TokenStore`](README.md#tokenstore)

#### Constructors

##### new ReadOnlyTokenStore()

> **new ReadOnlyTokenStore**(): [`ReadOnlyTokenStore`](README.md#readonlytokenstore)

###### Returns

[`ReadOnlyTokenStore`](README.md#readonlytokenstore)

#### Methods

##### getAuthToken()

> `abstract` **getAuthToken**(): `Promise`\<`string`\>

This method returns a token to be used for authenticated operations on the User class.

###### Returns

`Promise`\<`string`\>

Passage-issued JWT

##### getRefreshToken()

> **getRefreshToken**(): `Promise`\<`undefined` \| `string`\>

This method retrieves a Passage refresh token from storage for use with the Session class for refreshing Passage sessions.
If this method returns undefined then Session will not handle any refresh token logic.

###### Returns

`Promise`\<`undefined` \| `string`\>

refresh token, or undefined if not using refresh tokens.

***

### `abstract` TokenStore

Base class for implementing full read-write token stores.

#### Extends

- [`ReadOnlyTokenStore`](README.md#readonlytokenstore)

#### Extended by

- [`PassageTokenStore`](README.md#passagetokenstore)

#### Constructors

##### new TokenStore()

> **new TokenStore**(): [`TokenStore`](README.md#tokenstore)

###### Returns

[`TokenStore`](README.md#tokenstore)

###### Inherited from

[`ReadOnlyTokenStore`](README.md#readonlytokenstore).[`constructor`](README.md#constructors-9)

#### Methods

##### clearTokens()

> **clearTokens**(): `Promise`\<`void`\>

This method is responsible for clearing tokens from storage when a sign-out operation is executed on the Session class.

###### Returns

`Promise`\<`void`\>

##### getAuthToken()

> `abstract` **getAuthToken**(): `Promise`\<`string`\>

This method returns a token to be used for authenticated operations on the User class.

###### Returns

`Promise`\<`string`\>

Passage-issued JWT

###### Inherited from

[`ReadOnlyTokenStore`](README.md#readonlytokenstore).[`getAuthToken`](README.md#getauthtoken-2)

##### getRefreshToken()

> **getRefreshToken**(): `Promise`\<`undefined` \| `string`\>

This method retrieves a Passage refresh token from storage for use with the Session class for refreshing Passage sessions.
If this method returns undefined then Session will not handle any refresh token logic.

###### Returns

`Promise`\<`undefined` \| `string`\>

refresh token, or undefined if not using refresh tokens.

###### Inherited from

[`ReadOnlyTokenStore`](README.md#readonlytokenstore).[`getRefreshToken`](README.md#getrefreshtoken-1)

##### setTokens()

> `abstract` **setTokens**(`authResult`): `Promise`\<`void`\>

This method is responsible for hanlding the storage of Passage-issued JWTs and refresh tokens.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `authResult` | `AuthResult` | The authResult object returned from Passage Login, Register, Magic Link, and token refresh operations. |

###### Returns

`Promise`\<`void`\>

## Interfaces

### Metadata

#### Indexable

 \[`key`: `string`\]: `boolean` \| `string` \| `number`

***

### PassageConfig

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| `tokenStore?` | [`ReadOnlyTokenStore`](README.md#readonlytokenstore) \| [`TokenStore`](README.md#tokenstore) | A custom TokenStore implementation that handles custom management of tokens |

***

### PasskeyLoginOptions

#### Properties

| Property | Type |
| ------ | ------ |
| `abortSignal?` | `AbortSignal` |
| `isConditionalMediation?` | `boolean` |

## Enumerations

### Identifier

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
| `both` | `"both"` |
| `email` | `"email"` |
| `phone` | `"phone"` |

***

### RequiredIdentifier

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
| `Both` | `"both"` |
| `Either` | `"either"` |
| `Email` | `"email"` |
| `Phone` | `"phone"` |

***

### SocialConnection

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
| `Apple` | `"apple"` |
| `Github` | `"github"` |
| `Google` | `"google"` |

***

### UserMetadataType

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
| `BOOLEAN` | `"boolean"` |
| `DATE` | `"date"` |
| `EMAIL` | `"email"` |
| `INTEGER` | `"integer"` |
| `PHONE` | `"phone"` |
| `STRING` | `"string"` |

## Functions

### isFullTokenStore()

> **isFullTokenStore**(`store`): `store is TokenStore`

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `store` | [`ReadOnlyTokenStore`](README.md#readonlytokenstore) \| [`TokenStore`](README.md#tokenstore) |

#### Returns

`store is TokenStore`

## Type Aliases

### OneTimePasscode

> **OneTimePasscode**: `OneTimePasscodeResponse`

***

### PassageAppInfo

> **PassageAppInfo**: `App`

***

### Passkey

> **Passkey**: `Credential`

***

### PublicUserInfo

> **PublicUserInfo**: `User`

***

### UserSocialConnection

> **UserSocialConnection**: `AppleSocialConnection` \| `GithubSocialConnection` \| `GoogleSocialConnection`