Revision control
Copy as Markdown
Other Tools
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.VerifierEvent = exports.VerificationRequestEvent = exports.VerificationPhase = void 0;
exports.canAcceptVerificationRequest = canAcceptVerificationRequest;
/*
Copyright 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* An incoming, or outgoing, request to verify a user or a device via cross-signing.
*/
/** Events emitted by {@link VerificationRequest}. */
let VerificationRequestEvent = exports.VerificationRequestEvent = /*#__PURE__*/function (VerificationRequestEvent) {
VerificationRequestEvent["Change"] = "change";
return VerificationRequestEvent;
}({});
/**
* Listener type map for {@link VerificationRequestEvent}s.
*
* @internal
*/
/** The current phase of a verification request. */
let VerificationPhase = exports.VerificationPhase = /*#__PURE__*/function (VerificationPhase) {
VerificationPhase[VerificationPhase["Unsent"] = 1] = "Unsent";
VerificationPhase[VerificationPhase["Requested"] = 2] = "Requested";
VerificationPhase[VerificationPhase["Ready"] = 3] = "Ready";
VerificationPhase[VerificationPhase["Started"] = 4] = "Started";
VerificationPhase[VerificationPhase["Cancelled"] = 5] = "Cancelled";
VerificationPhase[VerificationPhase["Done"] = 6] = "Done";
return VerificationPhase;
}({});
/**
* A `Verifier` is responsible for performing the verification using a particular method, such as via QR code or SAS
* (emojis).
*
* A verifier object can be created by calling `VerificationRequest.beginVerification`; one is also created
* automatically when a `m.key.verification.start` event is received for an existing VerificationRequest.
*
* Once a verifier object is created, the verification can be started by calling the {@link Verifier#verify} method.
*/
/** Events emitted by {@link Verifier} */
let VerifierEvent = exports.VerifierEvent = /*#__PURE__*/function (VerifierEvent) {
VerifierEvent["Cancel"] = "cancel";
VerifierEvent["ShowSas"] = "show_sas";
VerifierEvent["ShowReciprocateQr"] = "show_reciprocate_qr";
return VerifierEvent;
}({});
/** Listener type map for {@link VerifierEvent}s. */
/**
* Callbacks for user actions to confirm that the other side has scanned our QR code.
*
* This is exposed as the payload of a `VerifierEvent.ShowReciprocateQr` event, or can be retrieved directly from the
* verifier as `reciprocateQREvent`.
*/
/**
* Callbacks for user actions while a SAS is displayed.
*
* This is exposed as the payload of a `VerifierEvent.ShowSas` event, or directly from the verifier as `sasEvent`.
*/
/** A generated SAS to be shown to the user, in alternative formats */
/**
* An emoji for the generated SAS. A tuple `[emoji, name]` where `emoji` is the emoji itself and `name` is the
* English name.
*/
/**
* True if the request is in a state where it can be accepted (ie, that we're in phases {@link VerificationPhase.Unsent}
* or {@link VerificationPhase.Requested}, and that we're not in the process of sending a `ready` or `cancel`).
*/
function canAcceptVerificationRequest(req) {
return req.phase < VerificationPhase.Ready && !req.accepting && !req.declining;
}