Merge pull request #202 from matrix-org/hs/ts-models

Typescriptify models/*

changelog.d/202.misc

@@ -0,0 +1 @@
+Typescriptify models/*

spec/unit/matrix-user.spec.js

@@ -1,4 +1,4 @@
-const MatrixUser = require("../../lib/models/users/matrix");
+const MatrixUser = require("../..").MatrixUser;
 
 describe("MatrixUser", function() {
     describe("escapeUserId", function() {

src/bridge.js

@@ -31,8 +31,8 @@ const Intent = require("./components/intent").Intent;
 const RoomBridgeStore = require("./components/room-bridge-store");
 const UserBridgeStore = require("./components/user-bridge-store");
 const EventBridgeStore = require("./components/event-bridge-store");
-const MatrixUser = require("./models/users/matrix");
-const MatrixRoom = require("./models/rooms/matrix");
+const MatrixUser = require("./models/users/matrix").MatrixUser;
+const MatrixRoom = require("./models/rooms/matrix").MatrixRoom;
 const { PrometheusMetrics } = require("./components/prometheusmetrics");
 const MembershipCache = require("./components/membership-cache");
 const RoomLinkValidator = require("./components/room-link-validator").RoomLinkValidator;

src/components/bridge-context.js

@@ -15,8 +15,8 @@ limitations under the License.
 */
 
 const Promise = require("bluebird");
-const MatrixUser = require("../models/users/matrix");
-const MatrixRoom = require("../models/rooms/matrix");
+const MatrixUser = require("../models/users/matrix").MatrixUser;
+const MatrixRoom = require("../models/rooms/matrix").MatrixRoom;
 const {wrap} = require("../errors");
 
 /**

src/components/event-bridge-store.js

@@ -14,7 +14,7 @@ limitations under the License.
 */
 
 const BridgeStore = require("./bridge-store");
-const StoredEvent = require("../models/events/event");
+const { StoredEvent } = require("../models/events/event");
 const util = require("util");
 
 /**

src/components/intent.ts

@@ -13,7 +13,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import MatrixUser from "../models/users/matrix";
+import { MatrixUser } from "../models/users/matrix";
 import JsSdk from "matrix-js-sdk";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/components/room-bridge-store.js

@@ -57,8 +57,8 @@ limitations under the License.
  */
 
 var BridgeStore = require("./bridge-store");
-var MatrixRoom = require("../models/rooms/matrix");
-var RemoteRoom = require("../models/rooms/remote");
+const MatrixRoom = require("../models/rooms/matrix").MatrixRoom;
+const RemoteRoom = require("../models/rooms/remote").RemoteRoom;
 var util = require("util");
 
 /**

src/components/room-upgrade-handler.js

@@ -14,8 +14,8 @@ limitations under the License.
 */
 
 const log = require("./logging").get("RoomUpgradeHandler");
-const MatrixRoom = require("../models/rooms/matrix");
-const MatrixUser = require("../models/users/matrix");
+const MatrixRoom = require("../models/rooms/matrix").MatrixRoom;
+const MatrixUser = require("../models/users/matrix").MatrixUser;
 
 /**
  * Handles migration of rooms when a room upgrade is performed.

src/components/user-bridge-store.js

@@ -53,8 +53,8 @@ limitations under the License.
  */
 
 var BridgeStore = require("./bridge-store");
-var MatrixUser = require("../models/users/matrix");
-var RemoteUser = require("../models/users/remote");
+const MatrixUser = require("../models/users/matrix").MatrixUser;
+const RemoteUser = require("../models/users/remote").RemoteUser;
 var util = require("util");
 
 /**

src/index.ts

@@ -36,11 +36,11 @@ module.exports.RoomBridgeStore = require("./components/room-bridge-store");
 module.exports.EventBridgeStore = require("./components/event-bridge-store");
 
 // Models
-module.exports.MatrixUser = require("./models/users/matrix");
-module.exports.RemoteUser = require("./models/users/remote");
-module.exports.MatrixRoom = require("./models/rooms/matrix");
-module.exports.RemoteRoom = require("./models/rooms/remote");
-module.exports.StoredEvent = require("./models/events/event");
+export * from "./models/rooms/matrix";
+export * from "./models/rooms/remote";
+export * from "./models/users/matrix";
+export * from "./models/users/remote";
+export * from "./models/events/event";
 
 module.exports.Bridge = require("./bridge");
 module.exports.BridgeContext = require("./components/bridge-context");

src/models/events/event.ts

@@ -0,0 +1,122 @@
+/*
+Copyright 2019 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.
+*/
+
+export class StoredEvent {
+    /**
+     * Create a store event.
+     * @param roomId The matrix room ID
+     * @param eventId The matrix event ID
+     * @param remoteRoomId The remote room ID
+     * @param remoteEventId The remote event ID
+     * @param _extras Any extra data that may be included with the event.
+     */
+    constructor(public roomId: string,
+        public eventId: string, public remoteRoomId: string,
+        public remoteEventId: string,
+        private readonly _extras: Record<string, unknown> = {}
+    ) { }
+
+    /**
+     * Get the unique ID.
+     * @return A unique ID
+     */
+    public getId() {
+        return this.eventId + this.remoteEventId;
+    };
+
+    /**
+     * Get the matrix room ID.
+     * @return The room ID
+     */
+    public getMatrixRoomId() {
+        return this.roomId;
+    };
+
+    /**
+     * Get the matrix event ID.
+     * @return The event ID
+     */
+    public getMatrixEventId() {
+        return this.eventId;
+    };
+
+    /**
+     * Get the remote room ID.
+     * @return The remote room ID
+     */
+    public getRemoteRoomId() {
+        return this.remoteRoomId;
+    };
+
+    /**
+     * Get the remote event ID.
+     * @return The remote event ID
+     */
+    public getRemoteEventId() {
+        return this.remoteEventId;
+    };
+
+    /**
+     * Get the data value for the given key.
+     * @param key An arbitrary bridge-specific key.
+     * @return Stored data for this key. May be undefined.
+     */
+    public get<T>(key: string) {
+        return this._extras[key] as T;
+    };
+
+    /**
+     * Set an arbitrary bridge-specific data value for this event. This will be serailized
+     * under an 'extras' key.
+     * @param key The key to store the data value under.
+     * @param val The data value. This value should be serializable via
+     * <code>JSON.stringify(data)</code>.
+     */
+    public set(key: string, val: unknown) {
+        this._extras[key] = val;
+    };
+
+    /**
+     * Serialize data about this event into a JSON object.
+     */
+    public serialize() {
+        return {
+            id: this.getId(),
+            matrix: {
+                roomId: this.roomId,
+                eventId: this.eventId,
+            },
+            remote: {
+                roomId: this.remoteRoomId,
+                eventId: this.remoteEventId,
+            },
+            extras: this._extras,
+        };
+    };
+
+    /**
+     * Set data about this event from a serialized data object.
+     * @param data The serialized data
+     */
+    public static deserialize(data: { matrix: { roomId: string, eventId: string}, remote: { roomId: string, eventId: string}, extras: Record<string, unknown>}) {
+        return new StoredEvent(
+            data.matrix.roomId,
+            data.matrix.eventId,
+            data.remote.roomId,
+            data.remote.eventId,
+            data.extras
+        );
+    };
+}