Skip to content

Update linter dependencies #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jan 3, 2025
Merged

Update linter dependencies #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cfee98d
Replace babel-eslint with @babel/eslint-parser
AndrewFerr Nov 5, 2024
7622247
Migrate to eslint-plugin-matrix-org
AndrewFerr Nov 5, 2024
ee46d9c
Run lint:fix
AndrewFerr Nov 5, 2024
64a49f3
Add missing return types on functions
AndrewFerr Nov 12, 2024
0058c04
Allow empty interface types
AndrewFerr Nov 12, 2024
291d8a7
Avoid unnecessary any
AndrewFerr Nov 12, 2024
3b2a0cd
Allow any on exported types
AndrewFerr Nov 12, 2024
0e3b2fc
Allow unknown object to string
AndrewFerr Nov 12, 2024
428c03a
Lint test files
AndrewFerr Nov 12, 2024
f11206f
Increase test coverage
AndrewFerr Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
module.exports = {
extends: ["matrix-org"],
plugins: [
"babel",
"matrix-org",
],
extends: [
"plugin:matrix-org/babel",
],
parserOptions: {
project: ["./tsconfig-dev.json"],
},
env: {
browser: true,
},
Expand All @@ -29,12 +34,17 @@ module.exports = {
},
overrides: [{
"files": ["src/**/*.ts", "test/**/*.ts"],
"extends": ["matrix-org/ts"],
"extends": ["plugin:matrix-org/typescript"],
"rules": {
// TypeScript has its own version of this
"babel/no-invalid-this": "off",

"quotes": "off",
},
}, {
"files": ["src/interfaces/**/*.ts"],
"rules": {
"@typescript-eslint/no-empty-object-type": "off",
},
}],
};
14 changes: 11 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,26 @@
"@action-validator/core": "^0.5.3",
"@babel/cli": "^7.11.6",
"@babel/core": "^7.11.6",
"@babel/eslint-parser": "^7.25.9",
"@babel/eslint-plugin": "^7.25.9",
"@babel/plugin-proposal-class-properties": "^7.10.4",
"@babel/preset-env": "^7.11.5",
"@babel/preset-typescript": "^7.10.4",
"@casualbot/jest-sonar-reporter": "^2.2.7",
"@stylistic/eslint-plugin": "^2.10.1",
"@testing-library/dom": "^8.0.0",
"@types/jest": "^29.5.12",
"@types/node": "^18.16.0",
"babel-eslint": "^10.1.0",
"@typescript-eslint/eslint-plugin": "^8.0.0",
"@typescript-eslint/parser": "^8.0.0",
"browserify": "^17.0.0",
"eslint": "^7.8.1",
"eslint-config-matrix-org": "^0.1.2",
"eslint": "^8.0.0",
"eslint-config-google": "^0.14.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-babel": "^5.3.1",
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-matrix-org": "^2.0.0",
"eslint-plugin-unicorn": "^56.0.0",
"jest": "^29.5.0",
"jest-environment-jsdom": "^29.5.0",
"rimraf": "^3.0.2",
Expand Down
62 changes: 32 additions & 30 deletions src/ClientWidgetApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/

import { EventEmitter } from "events";

import { ITransport } from "./transport/ITransport";
import { Widget } from "./models/Widget";
import { PostmessageTransport } from "./transport/PostmessageTransport";
Expand Down Expand Up @@ -212,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");

Expand All @@ -238,18 +239,18 @@ 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),
}).catch(e => {
console.warn("non-fatal error notifying widget of approved capabilities:", e);
}).then(() => {
this.emit("capabilitiesNotified")
this.emit("capabilitiesNotified");
});
}

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.
Expand All @@ -267,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;
Expand All @@ -290,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, {});

Expand All @@ -317,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"},
Expand All @@ -330,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");
};
Expand All @@ -344,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>(
Expand All @@ -366,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
Expand Down Expand Up @@ -404,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);

Expand All @@ -415,11 +416,11 @@ export class ClientWidgetApi extends EventEmitter {
}

return events.then((evs) => {
this.transport.reply<IReadRoomAccountDataFromWidgetResponseData>(request, {events: evs})
this.transport.reply<IReadRoomAccountDataFromWidgetResponseData>(request, {events: evs});
});
}

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"},
Expand All @@ -433,9 +434,10 @@ export class ClientWidgetApi extends EventEmitter {

let askRoomIds: string[] | null = null; // null denotes current room only
if (request.data.room_ids) {
askRoomIds = request.data.room_ids as string[];
if (!Array.isArray(askRoomIds)) {
askRoomIds = [askRoomIds as any as string];
if (Array.isArray(request.data.room_ids)) {
askRoomIds = request.data.room_ids;
} else {
askRoomIds = [request.data.room_ids];
}
for (const roomId of askRoomIds) {
if (!this.canUseRoomTimeline(roomId)) {
Expand Down Expand Up @@ -470,7 +472,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"},
Expand Down Expand Up @@ -558,7 +560,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"},
Expand Down Expand Up @@ -617,7 +619,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,
Expand Down Expand Up @@ -682,7 +684,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" },
Expand Down Expand Up @@ -731,7 +733,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" },
Expand Down Expand Up @@ -772,15 +774,15 @@ 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" },
});
}

try {
const result = await this.driver.getMediaConfig()
const result = await this.driver.getMediaConfig();

return this.transport.reply<IGetMediaConfigActionFromWidgetResponseData>(
request,
Expand All @@ -792,7 +794,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" },
Expand Down Expand Up @@ -832,7 +834,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: {
Expand All @@ -842,7 +844,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,
Expand Down Expand Up @@ -874,7 +876,7 @@ export class ClientWidgetApi extends EventEmitter {
case WidgetApiFromWidgetAction.MSC3869ReadRelations:
return this.handleReadRelations(<IReadRelationsFromWidgetActionRequest>ev.detail);
case WidgetApiFromWidgetAction.MSC3973UserDirectorySearch:
return this.handleUserDirectorySearch(<IUserDirectorySearchFromWidgetActionRequest>ev.detail)
return this.handleUserDirectorySearch(<IUserDirectorySearchFromWidgetActionRequest>ev.detail);
case WidgetApiFromWidgetAction.BeeperReadRoomAccountData:
return this.handleReadRoomAccountData(<IReadRoomAccountDataFromWidgetActionRequest>ev.detail);
case WidgetApiFromWidgetAction.MSC4039GetMediaConfigAction:
Expand Down
Loading