Class AutoDiscovery

Utilities for automatically discovery resources, such as homeservers for users to log in to.

Constructors

constructor

new AutoDiscovery(): AutoDiscovery
Returns AutoDiscovery

Properties

`Static` `Readonly` ALL_ERRORS

ALL_ERRORS: AutoDiscoveryError[] = ...

`Static` `Readonly` ERROR_GENERIC_FAILURE

ERROR_GENERIC_FAILURE: GenericFailure = AutoDiscoveryError.GenericFailure

`Static` `Readonly` ERROR_HOMESERVER_TOO_OLD

ERROR_HOMESERVER_TOO_OLD: UnsupportedHomeserverSpecVersion = AutoDiscovery.ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION

Deprecated

Replaced by ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION

`Static` `Readonly` ERROR_INVALID

ERROR_INVALID: Invalid = AutoDiscoveryError.Invalid

`Static` `Readonly` ERROR_INVALID_HOMESERVER

ERROR_INVALID_HOMESERVER: InvalidHomeserver = AutoDiscoveryError.InvalidHomeserver

`Static` `Readonly` ERROR_INVALID_HS_BASE_URL

ERROR_INVALID_HS_BASE_URL: InvalidHsBaseUrl = AutoDiscoveryError.InvalidHsBaseUrl

`Static` `Readonly` ERROR_INVALID_IDENTITY_SERVER

ERROR_INVALID_IDENTITY_SERVER: InvalidIdentityServer = AutoDiscoveryError.InvalidIdentityServer

`Static` `Readonly` ERROR_INVALID_IS

ERROR_INVALID_IS: InvalidIs = AutoDiscoveryError.InvalidIs

`Static` `Readonly` ERROR_INVALID_IS_BASE_URL

ERROR_INVALID_IS_BASE_URL: InvalidIsBaseUrl = AutoDiscoveryError.InvalidIsBaseUrl

`Static` `Readonly` ERROR_INVALID_JSON

ERROR_INVALID_JSON: InvalidJson = AutoDiscoveryError.InvalidJson

`Static` `Readonly` ERROR_MISSING_WELLKNOWN

ERROR_MISSING_WELLKNOWN: MissingWellknown = AutoDiscoveryError.MissingWellknown

`Static` `Readonly` ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION

ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION: UnsupportedHomeserverSpecVersion = AutoDiscoveryError.UnsupportedHomeserverSpecVersion

`Static` `Readonly` FAIL_ERROR

FAIL_ERROR: FAIL_ERROR = AutoDiscoveryAction.FAIL_ERROR

The auto discovery failed. The client is expected to communicate the error to the user and refuse logging in.

`Static` `Readonly` FAIL_PROMPT

FAIL_PROMPT: FAIL_PROMPT = AutoDiscoveryAction.FAIL_PROMPT

The auto discovery failed, however the client may still recover from the problem. The client is recommended to that the same action it would for PROMPT while also warning the user about what went wrong. The client may also treat this the same as a FAIL_ERROR state.

`Static` `Readonly` PROMPT

PROMPT: PROMPT = AutoDiscoveryAction.PROMPT

The auto discovery didn't fail but did not find anything of interest. The client is expected to prompt the user for more information, or fail if it prefers.

`Static` `Readonly` SUCCESS

SUCCESS: SUCCESS = AutoDiscoveryAction.SUCCESS

The auto discovery was successful.

`Static` `Private` `Optional` fetchFn

fetchFn?: {
(input, init?): Promise<Response>;
(input, init?): Promise<Response>;
}

Type declaration

- (input, init?): Promise<Response>
- MDN Reference
  Parameters
  - input: RequestInfo | URL
  - Optional init: RequestInit
  Returns Promise<Response>
- (input, init?): Promise<Response>
- Parameters
  - input: string | Request | URL
  - Optional init: RequestInit
  Returns Promise<Response>

Methods

`Static` `Private` fetch

fetch(resource, options?): Promise<Response>
Parameters
- resource: string | URL
- Optional options: RequestInit
Returns Promise<Response>
- Defined in src/autodiscovery.ts:422

`Static` `Private` fetchWellKnownObject

fetchWellKnownObject<T>(url): Promise<IWellKnownConfig<Partial<T>>>
Internal
Fetches a JSON object from a given URL, as expected by all .well-known related lookups. If the server gives a 404 then the action will be IGNORE. If the server returns something that isn't JSON, the action will be FAIL_PROMPT. For any other failure the action will be FAIL_PROMPT.

The returned object will be a result of the call in object form with the following properties: raw: The JSON object returned by the server. action: One of SUCCESS, IGNORE, or FAIL_PROMPT. reason: Relatively human-readable description of what went wrong. error: The actual Error, if one exists.
Type Parameters
- T = IWellKnownConfig<IClientWellKnown>
Parameters
- url: string
  The URL to fetch a JSON object from.
Returns Promise<IWellKnownConfig<Partial<T>>>
Promise which resolves to the returned state.
- Defined in src/autodiscovery.ts:451

`Static` findClientConfig

findClientConfig(domain): Promise<ClientConfig>
Attempts to automatically discover client configuration information prior to logging in. Such information includes the homeserver URL and identity server URL the client would want. Additional details may also be discovered, and will be transparently included in the response object unaltered.
Parameters
- domain: string
  The homeserver domain to perform discovery on. For example, "matrix.org".
Returns Promise<ClientConfig>
Promise which resolves to the discovered configuration, which may include error states. Rejects on unexpected failure, not when discovery fails.
- Defined in src/autodiscovery.ts:310

`Static` fromDiscoveryConfig

fromDiscoveryConfig(wellknown): Promise<ClientConfig>
Validates and verifies client configuration information for purposes of logging in. Such information includes the homeserver URL and identity server URL the client would want. Additional details may also be included, and will be transparently brought into the response object unaltered.
Parameters
- wellknown: IClientWellKnown
  The configuration object itself, as returned by the .well-known auto-discovery endpoint.
Returns Promise<ClientConfig>
Promise which resolves to the verified configuration, which may include error states. Rejects on unexpected failure, not when verification fails.
- Defined in src/autodiscovery.ts:138

`Static` getRawClientConfig

getRawClientConfig(domain?): Promise<IClientWellKnown>
Gets the raw discovery client configuration for the given domain name. Should only be used if there's no validation to be done on the resulting object, otherwise use findClientConfig().
Parameters
- Optional domain: string
  The domain to get the client config for.
Returns Promise<IClientWellKnown>
Promise which resolves to the domain's client config. Can be an empty object.
- Defined in src/autodiscovery.ts:377

`Static` `Private` sanitizeWellKnownUrl

sanitizeWellKnownUrl(url?): string | false
Internal
Sanitizes a given URL to ensure it is either an HTTP or HTTP URL and is suitable for the requirements laid out by .well-known auto discovery. If valid, the URL will also be stripped of any trailing slashes.
Parameters
- Optional url: null | string
  The potentially invalid URL to sanitize.
Returns string | false
The sanitized URL or a falsey value if the URL is invalid.
- Defined in src/autodiscovery.ts:395

`Static` setFetchFn

setFetchFn(fetchFn): void
Parameters
- fetchFn: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
  }
  - - (input, init?): Promise<Response>
    - MDN Reference
      
      Parameters
      input: RequestInfo | URL
      Optional init: RequestInit
      Returns Promise<Response>
    - (input, init?): Promise<Response>
    - Parameters
      input: string | Request | URL
      Optional init: RequestInit
      Returns Promise<Response>
Returns void
- Defined in src/autodiscovery.ts:431

Class AutoDiscovery

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AutoDiscovery

Properties

Static Readonly ALL_ERRORS

Static Readonly ERROR_GENERIC_FAILURE

Static Readonly ERROR_HOMESERVER_TOO_OLD

Deprecated

Static Readonly ERROR_INVALID

Static Readonly ERROR_INVALID_HOMESERVER

Static Readonly ERROR_INVALID_HS_BASE_URL

Static Readonly ERROR_INVALID_IDENTITY_SERVER

Static Readonly ERROR_INVALID_IS

Static Readonly ERROR_INVALID_IS_BASE_URL

Static Readonly ERROR_INVALID_JSON

Static Readonly ERROR_MISSING_WELLKNOWN

Static Readonly ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION

Static Readonly FAIL_ERROR

Static Readonly FAIL_PROMPT

Static Readonly PROMPT

Static Readonly SUCCESS

Static Private Optional fetchFn

Type declaration

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Methods

Static Private fetch

Parameters

Returns Promise<Response>

Static Private fetchWellKnownObject

Type Parameters

Parameters

Returns Promise<IWellKnownConfig<Partial<T>>>

Static findClientConfig

Parameters

Returns Promise<ClientConfig>

Static fromDiscoveryConfig

Parameters

Returns Promise<ClientConfig>

Static getRawClientConfig

Parameters

Returns Promise<IClientWellKnown>

Static Private sanitizeWellKnownUrl

Parameters

Returns string | false

Static setFetchFn

Parameters

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Returns void

Settings

Member Visibility

Theme

On This Page

`Static` `Readonly` ALL_ERRORS

`Static` `Readonly` ERROR_GENERIC_FAILURE

`Static` `Readonly` ERROR_HOMESERVER_TOO_OLD

`Static` `Readonly` ERROR_INVALID

`Static` `Readonly` ERROR_INVALID_HOMESERVER

`Static` `Readonly` ERROR_INVALID_HS_BASE_URL

`Static` `Readonly` ERROR_INVALID_IDENTITY_SERVER

`Static` `Readonly` ERROR_INVALID_IS

`Static` `Readonly` ERROR_INVALID_IS_BASE_URL

`Static` `Readonly` ERROR_INVALID_JSON

`Static` `Readonly` ERROR_MISSING_WELLKNOWN

`Static` `Readonly` ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION

`Static` `Readonly` FAIL_ERROR

`Static` `Readonly` FAIL_PROMPT

`Static` `Readonly` PROMPT

`Static` `Readonly` SUCCESS

`Static` `Private` `Optional` fetchFn

`Static` `Private` fetch

`Static` `Private` fetchWellKnownObject

`Static` findClientConfig

`Static` fromDiscoveryConfig

`Static` getRawClientConfig

`Static` `Private` sanitizeWellKnownUrl

`Static` setFetchFn