hydrogen-web/src/matrix/registration/Registration.ts

/*
Copyright 2021 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

    http://www.apache.org/licenses/LICENSE-2.0

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.
*/

import type {HomeServerApi} from "../net/HomeServerApi";
import {registrationStageFromType} from "./registrationStageFromType";
import type {BaseRegistrationStage} from "./stages/BaseRegistrationStage";

export type RegistrationParameters = {
    username: string | null;
    password: string;
    initialDeviceDisplayName: string;
    inhibitLogin: boolean;
}

// todo: type this later
export type RegistrationResponse = {
    [key: string]: any;
}

export class Registration {
    private _hsApi: HomeServerApi;
    private _data: RegistrationParameters;
    private _firstStage: BaseRegistrationStage;

    constructor(hsApi: HomeServerApi, data: RegistrationParameters) {
        this._hsApi = hsApi;
        this._data = data;
    }

    async start(): Promise<BaseRegistrationStage> {
        const response = await this._hsApi.register(
            this._username,
            this._password,
            this._initialDeviceDisplayName,
            undefined,
            this._inhibitLogin).response();
        this.parseStagesFromResponse(response);
        return this._firstStage;
    }

    parseStagesFromResponse(response: RegistrationResponse) {
        const { session, params } = response;
        const flow = response.flows.pop();
        let lastStage: BaseRegistrationStage;
        for (const stage of flow.stages) {
            const stageClass = registrationStageFromType(stage);
            if (!stageClass) {
                throw new Error("Unknown stage");
            }
            const registrationStage = new stageClass(this._hsApi, this._data, session, params?.[stage]);
            if (!this._firstStage) {
                this._firstStage = registrationStage;
                lastStage = registrationStage;
            } else {
                lastStage!.setNextStage(registrationStage);
                lastStage = registrationStage;
            }
        }
    }

    private get _username() { return this._data.username; }
    private get _password() { return this._data.password; }
    private get _initialDeviceDisplayName() { return this._data.initialDeviceDisplayName; }
    private get _inhibitLogin() { return this._data.inhibitLogin; }
}