Static Readonly ALL_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly ERROR_Static Readonly FAIL_The auto discovery failed. The client is expected to communicate the error to the user and refuse logging in.
Static Readonly FAIL_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 PROMPTThe 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 SUCCESSThe auto discovery was successful.
Static Private Optional fetchStatic Private fetchStatic Private fetchInternal
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.
Promise which resolves to the returned state.
The URL to fetch a JSON object from.
Static findAttempts 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.
Promise which resolves to the discovered configuration, which may include error states. Rejects on unexpected failure, not when discovery fails.
The homeserver domain to perform discovery on. For example, "matrix.org".
Static fromValidates 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.
Promise which resolves to the verified configuration, which may include error states. Rejects on unexpected failure, not when verification fails.
The configuration object itself, as returned by the .well-known auto-discovery endpoint.
Static getGets 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().
Promise which resolves to the domain's client config. Can be an empty object.
Optional domain: stringThe domain to get the client config for.
Static Private sanitizeInternal
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.
The sanitized URL or a falsey value if the URL is invalid.
Optional url: null | stringThe potentially invalid URL to sanitize.
Static setGenerated using TypeDoc
Utilities for automatically discovery resources, such as homeservers for users to log in to.