Add missing return types on functions

Author: AndrewFerr

src/ClientWidgetApi.ts

@@ -213,12 +213,12 @@ export class ClientWidgetApi extends EventEmitter {
         return this.allowedEvents.some(e => e.matchesAsRoomAccountData(EventDirection.Receive, eventType));
     }
 
-    public stop() {
+    public stop(): void {
         this.isStopped = true;
         this.transport.stop();
     }
 
-    private beginCapabilities() {
+    private beginCapabilities(): void {
         // widget has loaded - tell all the listeners that
         this.emit("preparing");
 
@@ -239,7 +239,7 @@ export class ClientWidgetApi extends EventEmitter {
         });
     }
 
-    private notifyCapabilities(requested: Capability[]) {
+    private notifyCapabilities(requested: Capability[]): void {
         this.transport.send(WidgetApiToWidgetAction.NotifyCapabilities, <INotifyCapabilitiesActionRequestData>{
             requested: requested,
             approved: Array.from(this.allowedCapabilities),
@@ -250,7 +250,7 @@ export class ClientWidgetApi extends EventEmitter {
         });
     }
 
-    private onIframeLoad(ev: Event) {
+    private onIframeLoad(ev: Event): void {
         if (this.widget.waitForIframeLoad) {
             // If the widget is set to waitForIframeLoad the capabilities immediatly get setup after load.
             // The client does not wait for the ContentLoaded action.
@@ -268,7 +268,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private handleContentLoadedAction(action: IContentLoadedActionRequest) {
+    private handleContentLoadedAction(action: IContentLoadedActionRequest): void {
         if (this.contentLoadedWaitTimer !== undefined) {
             clearTimeout(this.contentLoadedWaitTimer);
             this.contentLoadedWaitTimer = undefined;
@@ -291,13 +291,13 @@ export class ClientWidgetApi extends EventEmitter {
         this.contentLoadedActionSent = true;
     }
 
-    private replyVersions(request: ISupportedVersionsActionRequest) {
+    private replyVersions(request: ISupportedVersionsActionRequest): void {
         this.transport.reply<ISupportedVersionsActionResponseData>(request, {
             supported_versions: CurrentApiVersions,
         });
     }
 
-    private handleCapabilitiesRenegotiate(request: IRenegotiateCapabilitiesActionRequest) {
+    private handleCapabilitiesRenegotiate(request: IRenegotiateCapabilitiesActionRequest): void {
         // acknowledge first
         this.transport.reply<IWidgetApiAcknowledgeResponseData>(request, {});
 
@@ -318,7 +318,7 @@ export class ClientWidgetApi extends EventEmitter {
         });
     }
 
-    private handleNavigate(request: INavigateActionRequest) {
+    private handleNavigate(request: INavigateActionRequest): void {
         if (!this.hasCapability(MatrixCapabilities.MSC2931Navigate)) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: {message: "Missing capability"},
@@ -331,7 +331,7 @@ export class ClientWidgetApi extends EventEmitter {
             });
         }
 
-        const onErr = (e: unknown) => {
+        const onErr = (e: unknown): void => {
             console.error("[ClientWidgetApi] Failed to handle navigation: ", e);
             this.handleDriverError(e, request, "Error handling navigation");
         };
@@ -345,10 +345,10 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private handleOIDC(request: IGetOpenIDActionRequest) {
+    private handleOIDC(request: IGetOpenIDActionRequest): void {
         let phase = 1; // 1 = initial request, 2 = after user manual confirmation
 
-        const replyState = (state: OpenIDRequestState, credential?: IOpenIDCredentials) => {
+        const replyState = (state: OpenIDRequestState, credential?: IOpenIDCredentials): void | Promise<IWidgetApiAcknowledgeResponseData> => {
             credential = credential || {};
             if (phase > 1) {
                 return this.transport.send<IOpenIDCredentialsActionRequestData>(
@@ -367,7 +367,7 @@ export class ClientWidgetApi extends EventEmitter {
             }
         };
 
-        const replyError = (msg: string) => {
+        const replyError = (msg: string): void | Promise<IWidgetApiAcknowledgeResponseData> => {
             console.error("[ClientWidgetApi] Failed to handle OIDC: ", msg);
             if (phase > 1) {
                 // We don't have a way to indicate that a random error happened in this flow, so
@@ -405,7 +405,7 @@ export class ClientWidgetApi extends EventEmitter {
 
         this.driver.askOpenID(observer);
     }
-    private handleReadRoomAccountData(request: IReadRoomAccountDataFromWidgetActionRequest) {
+    private handleReadRoomAccountData(request: IReadRoomAccountDataFromWidgetActionRequest): void | Promise<void> {
         let events: Promise<IRoomAccountData[]> = Promise.resolve([]);
         events = this.driver.readRoomAccountData(request.data.type);
 
@@ -420,7 +420,7 @@ export class ClientWidgetApi extends EventEmitter {
         });
     }
 
-    private handleReadEvents(request: IReadEventFromWidgetActionRequest) {
+    private handleReadEvents(request: IReadEventFromWidgetActionRequest): void | Promise<void> {
         if (!request.data.type) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: {message: "Invalid request - missing event type"},
@@ -471,7 +471,7 @@ export class ClientWidgetApi extends EventEmitter {
         return events.then(evs => this.transport.reply<IReadEventFromWidgetResponseData>(request, {events: evs}));
     }
 
-    private handleSendEvent(request: ISendEventFromWidgetActionRequest) {
+    private handleSendEvent(request: ISendEventFromWidgetActionRequest): void {
         if (!request.data.type) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: {message: "Invalid request - missing event type"},
@@ -559,7 +559,7 @@ export class ClientWidgetApi extends EventEmitter {
         });
     }
 
-    private handleUpdateDelayedEvent(request: IUpdateDelayedEventFromWidgetActionRequest) {
+    private handleUpdateDelayedEvent(request: IUpdateDelayedEventFromWidgetActionRequest): void {
         if (!request.data.delay_id) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: {message: "Invalid request - missing delay_id"},
@@ -618,7 +618,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private async pollTurnServers(turnServers: AsyncGenerator<ITurnServer>, initialServer: ITurnServer) {
+    private async pollTurnServers(turnServers: AsyncGenerator<ITurnServer>, initialServer: ITurnServer): Promise<void> {
         try {
             await this.transport.send<IUpdateTurnServersRequestData>(
                 WidgetApiToWidgetAction.UpdateTurnServers,
@@ -683,7 +683,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private async handleReadRelations(request: IReadRelationsFromWidgetActionRequest) {
+    private async handleReadRelations(request: IReadRelationsFromWidgetActionRequest): Promise<void> {
         if (!request.data.event_id) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: { message: "Invalid request - missing event ID" },
@@ -732,7 +732,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private async handleUserDirectorySearch(request: IUserDirectorySearchFromWidgetActionRequest) {
+    private async handleUserDirectorySearch(request: IUserDirectorySearchFromWidgetActionRequest): Promise<void> {
         if (!this.hasCapability(MatrixCapabilities.MSC3973UserDirectorySearch)) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: { message: "Missing capability" },
@@ -773,7 +773,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private async handleGetMediaConfig(request: IGetMediaConfigActionFromWidgetActionRequest) {
+    private async handleGetMediaConfig(request: IGetMediaConfigActionFromWidgetActionRequest): Promise<void> {
         if (!this.hasCapability(MatrixCapabilities.MSC4039UploadFile)) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: { message: "Missing capability" },
@@ -793,7 +793,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private async handleUploadFile(request: IUploadFileActionFromWidgetActionRequest) {
+    private async handleUploadFile(request: IUploadFileActionFromWidgetActionRequest): Promise<void> {
         if (!this.hasCapability(MatrixCapabilities.MSC4039UploadFile)) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: { message: "Missing capability" },
@@ -833,7 +833,7 @@ export class ClientWidgetApi extends EventEmitter {
         }
     }
 
-    private handleDriverError(e: unknown, request: IWidgetApiRequest, message: string) {
+    private handleDriverError(e: unknown, request: IWidgetApiRequest, message: string): void {
         const data = this.driver.processError(e);
         this.transport.reply<IWidgetApiErrorResponseData>(request, {
             error: {
@@ -843,7 +843,7 @@ export class ClientWidgetApi extends EventEmitter {
         });
     }
 
-    private handleMessage(ev: CustomEvent<IWidgetApiRequest>) {
+    private handleMessage(ev: CustomEvent<IWidgetApiRequest>): void | Promise<void> {
         if (this.isStopped) return;
         const actionEv = new CustomEvent(`action:${ev.detail.action}`, {
             detail: ev.detail,

src/WidgetApi.ts

@@ -178,7 +178,7 @@ export class WidgetApi extends EventEmitter {
      * @throws Throws if the capabilities negotiation has already started and the
      * widget is unable to request additional capabilities.
      */
-    public requestCapability(capability: Capability) {
+    public requestCapability(capability: Capability): void {
         if (this.capabilitiesFinished && !this.supportsMSC2974Renegotiate) {
             throw new Error("Capabilities have already been negotiated");
         }
@@ -192,7 +192,7 @@ export class WidgetApi extends EventEmitter {
      * @param {Capability[]} capabilities The capabilities to request.
      * @throws Throws if the capabilities negotiation has already started.
      */
-    public requestCapabilities(capabilities: Capability[]) {
+    public requestCapabilities(capabilities: Capability[]): void {
         capabilities.forEach(cap => this.requestCapability(cap));
     }
 
@@ -202,7 +202,7 @@ export class WidgetApi extends EventEmitter {
      * @param {string | Symbols.AnyRoom} roomId The room ID, or `Symbols.AnyRoom` to
      * denote all known rooms.
      */
-    public requestCapabilityForRoomTimeline(roomId: string | Symbols.AnyRoom) {
+    public requestCapabilityForRoomTimeline(roomId: string | Symbols.AnyRoom): void {
         this.requestCapability(`org.matrix.msc2762.timeline:${roomId}`);
     }
 
@@ -214,7 +214,7 @@ export class WidgetApi extends EventEmitter {
      * @param {string} stateKey If specified, the specific state key to request.
      * Otherwise all state keys will be requested.
      */
-    public requestCapabilityToSendState(eventType: string, stateKey?: string) {
+    public requestCapabilityToSendState(eventType: string, stateKey?: string): void {
         this.requestCapability(WidgetEventCapability.forStateEvent(EventDirection.Send, eventType, stateKey).raw);
     }
 
@@ -226,7 +226,7 @@ export class WidgetApi extends EventEmitter {
      * @param {string} stateKey If specified, the specific state key to request.
      * Otherwise all state keys will be requested.
      */
-    public requestCapabilityToReceiveState(eventType: string, stateKey?: string) {
+    public requestCapabilityToReceiveState(eventType: string, stateKey?: string): void {
         this.requestCapability(WidgetEventCapability.forStateEvent(EventDirection.Receive, eventType, stateKey).raw);
     }
 
@@ -236,7 +236,7 @@ export class WidgetApi extends EventEmitter {
      * not already happened.
      * @param {string} eventType The room event type to ask for.
      */
-    public requestCapabilityToSendToDevice(eventType: string) {
+    public requestCapabilityToSendToDevice(eventType: string): void {
         this.requestCapability(WidgetEventCapability.forToDeviceEvent(EventDirection.Send, eventType).raw);
     }
 
@@ -246,7 +246,7 @@ export class WidgetApi extends EventEmitter {
      * not already happened.
      * @param {string} eventType The room event type to ask for.
      */
-    public requestCapabilityToReceiveToDevice(eventType: string) {
+    public requestCapabilityToReceiveToDevice(eventType: string): void {
         this.requestCapability(WidgetEventCapability.forToDeviceEvent(EventDirection.Receive, eventType).raw);
     }
 
@@ -255,7 +255,7 @@ export class WidgetApi extends EventEmitter {
      * allowed, but will be asked for if the negotiation has not already happened.
      * @param {string} eventType The room event type to ask for.
      */
-    public requestCapabilityToSendEvent(eventType: string) {
+    public requestCapabilityToSendEvent(eventType: string): void {
         this.requestCapability(WidgetEventCapability.forRoomEvent(EventDirection.Send, eventType).raw);
     }
 
@@ -264,7 +264,7 @@ export class WidgetApi extends EventEmitter {
      * allowed, but will be asked for if the negotiation has not already happened.
      * @param {string} eventType The room event type to ask for.
      */
-    public requestCapabilityToReceiveEvent(eventType: string) {
+    public requestCapabilityToReceiveEvent(eventType: string): void {
         this.requestCapability(WidgetEventCapability.forRoomEvent(EventDirection.Receive, eventType).raw);
     }
 
@@ -275,7 +275,7 @@ export class WidgetApi extends EventEmitter {
      * @param {string} msgtype If specified, the specific msgtype to request.
      * Otherwise all message types will be requested.
      */
-    public requestCapabilityToSendMessage(msgtype?: string) {
+    public requestCapabilityToSendMessage(msgtype?: string): void {
         this.requestCapability(WidgetEventCapability.forRoomMessageEvent(EventDirection.Send, msgtype).raw);
     }
 
@@ -286,7 +286,7 @@ export class WidgetApi extends EventEmitter {
      * @param {string} msgtype If specified, the specific msgtype to request.
      * Otherwise all message types will be requested.
      */
-    public requestCapabilityToReceiveMessage(msgtype?: string) {
+    public requestCapabilityToReceiveMessage(msgtype?: string): void {
         this.requestCapability(WidgetEventCapability.forRoomMessageEvent(EventDirection.Receive, msgtype).raw);
     }
 
@@ -295,7 +295,7 @@ export class WidgetApi extends EventEmitter {
      * allowed, but will be asked for if the negotiation has not already happened.
      * @param {string} eventType The state event type to ask for.
      */
-    public requestCapabilityToReceiveRoomAccountData(eventType: string) {
+    public requestCapabilityToReceiveRoomAccountData(eventType: string): void {
         this.requestCapability(WidgetEventCapability.forRoomAccountData(EventDirection.Receive, eventType).raw);
     }
 
@@ -318,7 +318,7 @@ export class WidgetApi extends EventEmitter {
                 } else if (rdata.state === OpenIDRequestState.Blocked) {
                     reject(new Error("User declined to verify their identity"));
                 } else if (rdata.state === OpenIDRequestState.PendingUserConfirmation) {
-                    const handlerFn = (ev: CustomEvent<IOpenIDCredentialsActionRequest>) => {
+                    const handlerFn = (ev: CustomEvent<IOpenIDCredentialsActionRequest>): void => {
                         ev.preventDefault();
                         const request = ev.detail;
                         if (request.data.original_request_id !== response.requestId) return;
@@ -663,7 +663,7 @@ export class WidgetApi extends EventEmitter {
     public async* getTurnServers(): AsyncGenerator<ITurnServer> {
         let setTurnServer: (server: ITurnServer) => void;
 
-        const onUpdateTurnServers = async (ev: CustomEvent<IUpdateTurnServersRequest>) => {
+        const onUpdateTurnServers = async (ev: CustomEvent<IUpdateTurnServersRequest>): Promise<void> => {
             ev.preventDefault();
             setTurnServer(ev.detail.data);
             await this.transport.reply<IWidgetApiAcknowledgeResponseData>(ev.detail, {});
@@ -793,7 +793,7 @@ export class WidgetApi extends EventEmitter {
      * Starts the communication channel. This should be done early to ensure
      * that messages are not missed. Communication can only be stopped by the client.
      */
-    public start() {
+    public start(): void {
         this.transport.start();
         this.getClientVersions().then(v => {
             if (v.includes(UnstableApiVersion.MSC2974)) {
@@ -802,7 +802,7 @@ export class WidgetApi extends EventEmitter {
         });
     }
 
-    private handleMessage(ev: CustomEvent<IWidgetApiRequest>) {
+    private handleMessage(ev: CustomEvent<IWidgetApiRequest>): void | Promise<void> {
         const actionEv = new CustomEvent(`action:${ev.detail.action}`, {
             detail: ev.detail,
             cancelable: true,
@@ -828,7 +828,7 @@ export class WidgetApi extends EventEmitter {
         }
     }
 
-    private replyVersions(request: ISupportedVersionsActionRequest) {
+    private replyVersions(request: ISupportedVersionsActionRequest): void {
         this.transport.reply<ISupportedVersionsActionResponseData>(request, {
             supported_versions: CurrentApiVersions,
         });
@@ -850,7 +850,7 @@ export class WidgetApi extends EventEmitter {
         });
     }
 
-    private handleCapabilities(request: ICapabilitiesActionRequest) {
+    private handleCapabilities(request: ICapabilitiesActionRequest): void | Promise<void> {
         if (this.capabilitiesFinished) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
                 error: {

src/driver/WidgetDriver.ts

@@ -289,7 +289,7 @@ export abstract class WidgetDriver {
      * met properly. By default, the widget driver will block all OIDC requests.
      * @param {SimpleObservable<IOpenIDUpdate>} observer The observable to feed updates into.
      */
-    public askOpenID(observer: SimpleObservable<IOpenIDUpdate>) {
+    public askOpenID(observer: SimpleObservable<IOpenIDUpdate>): void {
         observer.update({state: OpenIDRequestState.Blocked});
     }
 

src/models/validation/utils.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-export function assertPresent<O extends Record<any, any>>(obj: O, key: keyof O) {
+export function assertPresent<O extends Record<any, any>>(obj: O, key: keyof O): void {
     if (!obj[key]) {
         throw new Error(`${String(key)} is required`);
     }