From 49ade61ef6e2b8fa686dbc4510098975f1df984a Mon Sep 17 00:00:00 2001
From: RMidhunSuresh <hi@midhun.dev>
Date: Wed, 2 Feb 2022 12:45:49 +0530
Subject: [PATCH] Fill in ts types + change names

---
 src/matrix/registration/Registration.ts           |  6 +++---
 .../registration/registrationStageFromType.ts     |  4 ++--
 .../registration/stages/BaseRegistrationStage.ts  | 15 +++++++++------
 3 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/src/matrix/registration/Registration.ts b/src/matrix/registration/Registration.ts
index 59a6bd95..dd19fae4 100644
--- a/src/matrix/registration/Registration.ts
+++ b/src/matrix/registration/Registration.ts
@@ -18,7 +18,7 @@ import type {HomeServerApi} from "../net/HomeServerApi";
 import {registrationStageFromType} from "./registrationStageFromType";
 import type {BaseRegistrationStage} from "./stages/BaseRegistrationStage";
 
-export type RegistrationParameters = {
+export type RegistrationDetails = {
     username: string | null;
     password: string;
     initialDeviceDisplayName: string;
@@ -32,9 +32,9 @@ export type RegistrationResponse = {
 
 export class Registration {
     private _hsApi: HomeServerApi;
-    private _data: RegistrationParameters;
+    private _data: RegistrationDetails;
 
-    constructor(hsApi: HomeServerApi, data: RegistrationParameters) {
+    constructor(hsApi: HomeServerApi, data: RegistrationDetails) {
         this._hsApi = hsApi;
         this._data = data;
     }
diff --git a/src/matrix/registration/registrationStageFromType.ts b/src/matrix/registration/registrationStageFromType.ts
index 44913f94..31330bc9 100644
--- a/src/matrix/registration/registrationStageFromType.ts
+++ b/src/matrix/registration/registrationStageFromType.ts
@@ -16,11 +16,11 @@ limitations under the License.
 
 import type {BaseRegistrationStage} from "./stages/BaseRegistrationStage";
 import type {HomeServerApi} from "../net/HomeServerApi";
-import type {RegistrationParameters} from "./Registration";
+import type {RegistrationDetails} from "./Registration";
 import {DummyAuth} from "./stages/DummyAuth";
 import {TermsAuth} from "./stages/TermsAuth";
 
-type DerivedFromBaseRegistration = { new(hsApi: HomeServerApi, registrationData: RegistrationParameters, session: string, params?: Record<string, any>): BaseRegistrationStage } & typeof BaseRegistrationStage | undefined;
+type DerivedFromBaseRegistration = { new(hsApi: HomeServerApi, registrationData: RegistrationDetails, session: string, params?: Record<string, any>): BaseRegistrationStage } & typeof BaseRegistrationStage | undefined;
 
 export function registrationStageFromType(type: string): DerivedFromBaseRegistration {
     switch (type) {
diff --git a/src/matrix/registration/stages/BaseRegistrationStage.ts b/src/matrix/registration/stages/BaseRegistrationStage.ts
index df23c429..57c0fa0e 100644
--- a/src/matrix/registration/stages/BaseRegistrationStage.ts
+++ b/src/matrix/registration/stages/BaseRegistrationStage.ts
@@ -14,25 +14,28 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-type Auth = {
+type AuthenticationData = {
+    type: string;
+    session: string;
     [key: string]: any;
 }
 
-type Params = {
+// contains data needed to complete this stage, eg: link to privacy policy
+type RegistrationParams = {
     [key: string]: any;   
 }
 
 import type {HomeServerApi} from "../../net/HomeServerApi";
-import type {RegistrationParameters, RegistrationResponse} from "../Registration";
+import type {RegistrationDetails, RegistrationResponse} from "../Registration";
 
 export abstract class BaseRegistrationStage {
     protected _hsApi: HomeServerApi;
-    protected _registrationData: RegistrationParameters;
+    protected _registrationData: RegistrationDetails;
     protected _session: string;
     protected _nextStage: BaseRegistrationStage;
     protected _params?: Record<string, any>
 
-    constructor(hsApi: HomeServerApi, registrationData: RegistrationParameters, session: string, params?: Params) {
+    constructor(hsApi: HomeServerApi, registrationData: RegistrationDetails, session: string, params?: RegistrationParams) {
         this._hsApi = hsApi;
         this._registrationData = registrationData;
         this._session = session;
@@ -49,7 +52,7 @@ export abstract class BaseRegistrationStage {
      * - the next stage if this stage was completed successfully
      * - user-id (string) if registration is completed
      */
-    abstract complete(auth?: Auth): Promise<BaseRegistrationStage | string>;
+    abstract complete(auth?: AuthenticationData): Promise<BaseRegistrationStage | string>;
 
     setNextStage(stage: BaseRegistrationStage) {
         this._nextStage = stage;