@masks/client

The BFF and browser-PKCE halves of @masks/client, generated from its TypeScript by ./dev reference. CI fails when this page and the source disagree.

Classes

AccessDenied

Defined in: types.ts:99

Extends

• MasksError

Constructors

Constructor

new AccessDenied(
   code,
   description?,
   status?
): AccessDenied;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

AccessDenied

Inherited from

MasksError.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
code	readonly	string	MasksError.code	types.ts:83
description?	readonly	string	MasksError.description	types.ts:84
status?	readonly	number	MasksError.status	types.ts:85

---

ConsentRequired

Defined in: types.ts:98

Extends

• MasksError

Constructors

Constructor

new ConsentRequired(
   code,
   description?,
   status?
): ConsentRequired;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

ConsentRequired

Inherited from

MasksError.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
code	readonly	string	MasksError.code	types.ts:83
description?	readonly	string	MasksError.description	types.ts:84
status?	readonly	number	MasksError.status	types.ts:85

---

InvalidGrant

Defined in: types.ts:100

Extends

• MasksError

Constructors

Constructor

new InvalidGrant(
   code,
   description?,
   status?
): InvalidGrant;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

InvalidGrant

Inherited from

MasksError.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
code	readonly	string	MasksError.code	types.ts:83
description?	readonly	string	MasksError.description	types.ts:84
status?	readonly	number	MasksError.status	types.ts:85

---

InvalidIssuer

Defined in: types.ts:102

Extends

• MasksError

Constructors

Constructor

new InvalidIssuer(
   code,
   description?,
   status?
): InvalidIssuer;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

InvalidIssuer

Inherited from

MasksError.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
code	readonly	string	MasksError.code	types.ts:83
description?	readonly	string	MasksError.description	types.ts:84
status?	readonly	number	MasksError.status	types.ts:85

---

InvalidToken

Defined in: types.ts:101

Extends

• MasksError

Constructors

Constructor

new InvalidToken(
   code,
   description?,
   status?
): InvalidToken;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

InvalidToken

Inherited from

MasksError.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
code	readonly	string	MasksError.code	types.ts:83
description?	readonly	string	MasksError.description	types.ts:84
status?	readonly	number	MasksError.status	types.ts:85

---

LoginRequired

Defined in: types.ts:97

Extends

• MasksError

Constructors

Constructor

new LoginRequired(
   code,
   description?,
   status?
): LoginRequired;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

LoginRequired

Inherited from

MasksError.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
code	readonly	string	MasksError.code	types.ts:83
description?	readonly	string	MasksError.description	types.ts:84
status?	readonly	number	MasksError.status	types.ts:85

---

MasksError

Defined in: types.ts:82

Extends

• Error

Extended by

• AccessDenied
• ConsentRequired
• InvalidGrant
• InvalidIssuer
• InvalidToken
• LoginRequired

Constructors

Constructor

new MasksError(
   code,
   description?,
   status?
): MasksError;

Defined in: types.ts:87

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

MasksError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Defined in
code	readonly	string	types.ts:83
description?	readonly	string	types.ts:84
status?	readonly	number	types.ts:85

Interfaces

Account

Defined in: types.ts:22

Properties

Property	Type	Defined in
account_url?	string	types.ts:36
avatars?	Avatars	types.ts:30
email?	string	types.ts:27
email_verified?	boolean	types.ts:28
expires_at?	number	types.ts:35
name?	string	types.ts:25
nickname?	string	types.ts:26
organization?	Organization	types.ts:32
organizations?	Organization[]	types.ts:33
picture?	string	types.ts:29
scopes	string[]	types.ts:34
signed_in	boolean	types.ts:23
subject?	string	types.ts:24
tenant?	Tenant	types.ts:31

---

ActorInfo

Defined in: actor.ts:3

Properties

Property	Type	Defined in
details	string[]	actor.ts:5
manager	boolean	actor.ts:7
name	string	actor.ts:4
organization	Organization | null	actor.ts:8
organizations	Organization[]	actor.ts:9
others	Organization[]	actor.ts:10
owner	boolean	actor.ts:12
role	string | null	actor.ts:11
unconfirmed	boolean	actor.ts:6

---

AuthorizeOptions

Defined in: browser.ts:43

Properties

Property	Type	Defined in
organization?	string	browser.ts:46
prompt?	string	browser.ts:45
returnTo?	string	browser.ts:44

---

Avatars

Defined in: types.ts:9

Properties

Property	Type	Defined in
identicon	string	types.ts:11
initials	string	types.ts:12
photo	string | null	types.ts:10

---

BrowserClient

Defined in: browser.ts:49

Methods

accessToken()

accessToken(): string | null;

Defined in: browser.ts:75

Returns

string | null

authorization()

authorization(): string | null;

Defined in: browser.ts:77

Returns

string | null

authorize()

authorize(options?): Promise<void>;

Defined in: browser.ts:52

Parameters

Parameter	Type
options?	AuthorizeOptions

Returns

Promise<void>

authorizeUrl()

authorizeUrl(options?): Promise<string>;

Defined in: browser.ts:53

Parameters

Parameter	Type
options?	AuthorizeOptions

Returns

Promise<string>

avatars()

avatars(): Avatars | null;

Defined in: browser.ts:65

Returns

Avatars | null

avatarUrl()

avatarUrl(subject, options?): Promise<string>;

Defined in: browser.ts:66

Parameters

Parameter	Type
subject	string
options?	{ size?: number; style?: AvatarStyle; }
options.size?	number
options.style?	AvatarStyle

Returns

Promise<string>

callback()

callback(url?): Promise<{
  identity: Claims | null;
  returnTo: string;
  tokens: Tokens;
}>;

Defined in: browser.ts:55

Parameters

Parameter	Type
url?	string

Returns

Promise<{ identity: Claims | null; returnTo: string; tokens: Tokens; }>

discover()

discover(): Promise<Discovery>;

Defined in: browser.ts:51

Returns

Promise<Discovery>

expired()

expired(leeway?): boolean;

Defined in: browser.ts:78

Parameters

Parameter	Type
leeway?	number

Returns

boolean

fetch()

fetch(url, init?): Promise<Response>;

Defined in: browser.ts:73

Parameters

Parameter	Type
url	string
init?	RequestInit

Returns

Promise<Response>

freshAccessToken()

freshAccessToken(leeway?): Promise<string | null>;

Defined in: browser.ts:72

Parameters

Parameter	Type
leeway?	number

Returns

Promise<string | null>

identity()

identity(): Claims | null;

Defined in: browser.ts:58

Returns

Claims | null

logout()

logout(options?): Promise<void>;

Defined in: browser.ts:79

Parameters

Parameter	Type
options?	LogoutOptions

Returns

Promise<void>

organization()

organization(): Organization | null;

Defined in: browser.ts:59

Returns

Organization | null

organizations()

organizations(): Organization[];

Defined in: browser.ts:60

Returns

Organization[]

pending()

pending(): boolean;

Defined in: browser.ts:54

Returns

boolean

photo()

photo(subject?): Promise<Blob | null>;

Defined in: browser.ts:70

Parameters

Parameter	Type
subject?	string

Returns

Promise<Blob | null>

proof()

proof(method, url): Promise<string | null>;

Defined in: browser.ts:74

Parameters

Parameter	Type
method	string
url	string

Returns

Promise<string | null>

ready()

ready(): Promise<Claims | null>;

Defined in: browser.ts:50

Returns

Promise<Claims | null>

refresh()

refresh(): Promise<Tokens>;

Defined in: browser.ts:71

Returns

Promise<Tokens>

switchOrganization()

switchOrganization(key, options?): Promise<void>;

Defined in: browser.ts:61

Parameters

Parameter	Type
key	string
options?	Omit<AuthorizeOptions, "organization">

Returns

Promise<void>

tokens()

tokens(): Tokens | null;

Defined in: browser.ts:76

Returns

Tokens | null

---

BrowserOptions

Defined in: browser.ts:18

Properties

Property	Type	Defined in
clientId?	string	browser.ts:20
dpop?	boolean	browser.ts:27
fetch?	(input, init?) => Promise<Response>	browser.ts:25
issuer	string	browser.ts:19
organization?	string	browser.ts:24
redirectUri?	string	browser.ts:21
resource?	string | string[]	browser.ts:23
scope?	string | string[]	browser.ts:22
storage?	Storage	browser.ts:26

---

Claims

Defined in: types.ts:51

Indexable

[claim: string]: unknown

Properties

Property	Type	Defined in
org?	Organization	types.ts:52
orgs?	Organization[]	types.ts:53

---

ClientMetadataOptions

Defined in: metadata.ts:9

Properties

Property	Type	Defined in
dpop?	boolean	metadata.ts:16
logoUri?	string	metadata.ts:15
name	string	metadata.ts:11
origin	string	metadata.ts:10
postLogoutRedirectUris?	string[]	metadata.ts:13
redirectUris?	string[]	metadata.ts:12
scope?	string | string[]	metadata.ts:14

---

Discovery

Defined in: types.ts:67

Indexable

[claim: string]: unknown

Properties

Property	Type	Defined in
authorization_endpoint	string	types.ts:69
avatar_endpoint?	string	types.ts:72
avatar_sizes_supported?	number[]	types.ts:74
avatar_styles_supported?	AvatarStyle[]	types.ts:73
end_session_endpoint?	string	types.ts:77
issuer	string	types.ts:68
jwks_uri?	string	types.ts:75
revocation_endpoint?	string	types.ts:76
tenant?	Tenant	types.ts:78
token_endpoint	string	types.ts:70
userinfo_endpoint?	string	types.ts:71

---

Jwk

Defined in: jwt.ts:11

Extends

• JsonWebKey

Properties

Property	Type	Defined in
kid?	string	jwt.ts:12

---

LoginOptions

Defined in: session.ts:15

Properties

Property	Type	Defined in
organization?	string	session.ts:17
returnTo?	string	session.ts:16

---

LogoutOptions

Defined in: browser.ts:38

Properties

Property	Type	Defined in
everywhere?	boolean	browser.ts:39
postLogoutRedirectUri?	string	browser.ts:40

---

Organization

Defined in: types.ts:15

Properties

Property	Type	Defined in
id	string	types.ts:16
key	string	types.ts:17
name	string	types.ts:18
role	string	types.ts:19

---

Refusal

Defined in: types.ts:39

Properties

Property	Type	Defined in
error	string	types.ts:41
handshake_url?	string	types.ts:43
login_url?	string	types.ts:42
signed_in	false	types.ts:40

---

SessionClient

Defined in: session.ts:20

Methods

avatarUrl()

avatarUrl(account, options?): string | null;

Defined in: session.ts:32

Parameters

Parameter	Type
account	Account | null
options?	{ size?: number; style?: AvatarStyle; }
options.size?	number
options.style?	AvatarStyle

Returns

string | null

handshake()

handshake(): void;

Defined in: session.ts:30

Returns

void

handshakeUrl()

handshakeUrl(): string;

Defined in: session.ts:31

Returns

string

login()

login(options?): void;

Defined in: session.ts:24

Parameters

Parameter	Type
options?	LoginOptions

Returns

void

loginUrl()

loginUrl(options?): string;

Defined in: session.ts:29

Parameters

Parameter	Type
options?	LoginOptions

Returns

string

logout()

logout(options?): Promise<void>;

Defined in: session.ts:36

Parameters

Parameter	Type
options?	{ everywhere?: boolean; }
options.everywhere?	boolean

Returns

Promise<void>

require()

require(options?): Promise<Account>;

Defined in: session.ts:23

Parameters

Parameter	Type
options?	LoginOptions

Returns

Promise<Account>

session()

session(): Promise<Account | null>;

Defined in: session.ts:21

Returns

Promise<Account | null>

status()

status(): Promise<Status>;

Defined in: session.ts:22

Returns

Promise<Status>

switchOrganization()

switchOrganization(key, options?): void;

Defined in: session.ts:25

Parameters

Parameter	Type
key	string
options?	Omit<LoginOptions, "organization">

Returns

void

---

SessionOptions

Defined in: session.ts:9

Properties

Property	Type	Defined in
basePath?	string	session.ts:10
csrfToken?	() => string | null	session.ts:12
fetch?	(input, init?) => Promise<Response>	session.ts:11

---

Tenant

Defined in: types.ts:1

Properties

Property	Type	Defined in
name?	string	types.ts:4
subdomain?	string	types.ts:3
uuid?	string	types.ts:2

---

Tokens

Defined in: types.ts:57

Properties

Property	Type	Defined in
access_token	string	types.ts:58
expires_in	number	types.ts:63
id_token?	string	types.ts:59
obtained_at	number	types.ts:64
refresh_token?	string	types.ts:60
scope	string	types.ts:62
token_type	string	types.ts:61

---

VerifyOptions

Defined in: jwt.ts:15

Properties

Property	Type	Defined in
audience	string	jwt.ts:17
issuer	string	jwt.ts:16
keyFor	(kid) => Promise<Jwk>	jwt.ts:20
leeway?	number	jwt.ts:19
nonce	string	jwt.ts:18

Type Aliases

AvatarStyle

type AvatarStyle = "photo" | "identicon" | "initials";

Defined in: types.ts:7

---

Status

type Status =
  | {
  account: Account;
  state: "signed_in";
}
  | {
  loginUrl: string;
  state: "signed_out";
}
  | {
  handshakeUrl: string;
  state: "handshake_required";
};

Defined in: types.ts:46

Variables

CLIENT_PATH

const CLIENT_PATH: "/oauth/client.json" = "/oauth/client.json";

Defined in: metadata.ts:1

Functions

actorFrom()

function actorFrom(account): ActorInfo;

Defined in: actor.ts:15

Parameters

Parameter	Type
account	Account

Returns

ActorInfo

---

clientMetadata()

function clientMetadata(options): Record<string, unknown>;

Defined in: metadata.ts:19

Parameters

Parameter	Type
options	ClientMetadataOptions

Returns

Record<string, unknown>

---

createBrowserClient()

function createBrowserClient(options): BrowserClient;

Defined in: browser.ts:82

Parameters

Parameter	Type
options	BrowserOptions

Returns

BrowserClient

---

createSession()

function createSession(options?): SessionClient;

Defined in: session.ts:59

Parameters

Parameter	Type
options?	SessionOptions

Returns

SessionClient

---

holdsRole()

function holdsRole(account, ...roles): boolean;

Defined in: actor.ts:42

Parameters

Parameter	Type
account	Account
…roles	string[]

Returns

boolean

---

initials()

function initials(name): string;

Defined in: actor.ts:48

Parameters

Parameter	Type
name	string

Returns

string

---

masksError()

function masksError(
   code,
   description?,
   status?
): MasksError;

Defined in: types.ts:114

Parameters

Parameter	Type
code	string
description?	string
status?	number

Returns

MasksError

---

verifyIdToken()

function verifyIdToken(token, __namedParameters): Promise<Claims>;

Defined in: jwt.ts:51

Parameters

Parameter	Type
token	string
__namedParameters	VerifyOptions

Returns

Promise<Claims>