7eb969bbc2
* Apply lint rule @typescript-eslint/no-empty-object-type To avoid the footgun that is https://www.totaltypescript.com/the-empty-object-type-in-typescript Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
111 lines
3.9 KiB
TypeScript
111 lines
3.9 KiB
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2024 The Matrix.org Foundation C.I.C.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import type { IWidget } from "matrix-widget-api";
|
|
import type { BLURHASH_FIELD } from "../utils/image-media";
|
|
import type { JitsiCallMemberEventType, JitsiCallMemberContent } from "../call-types";
|
|
import type { ILayoutStateEvent, WIDGET_LAYOUT_EVENT_TYPE } from "../stores/widgets/types";
|
|
import type { EncryptedFile } from "matrix-js-sdk/src/types";
|
|
import type { EmptyObject } from "matrix-js-sdk/src/matrix";
|
|
import type { DeviceClientInformation } from "../utils/device/types.ts";
|
|
import type { UserWidget } from "../utils/WidgetUtils-types.ts";
|
|
|
|
// Extend Matrix JS SDK types via Typescript declaration merging to support unspecced event fields and types
|
|
declare module "matrix-js-sdk/src/types" {
|
|
export interface FileInfo {
|
|
/**
|
|
* @see https://github.com/matrix-org/matrix-spec-proposals/pull/2448
|
|
*/
|
|
[BLURHASH_FIELD]?: string;
|
|
}
|
|
|
|
export interface ImageInfo {
|
|
/**
|
|
* @see https://github.com/matrix-org/matrix-spec-proposals/pull/4230
|
|
*/
|
|
"org.matrix.msc4230.is_animated"?: boolean;
|
|
}
|
|
|
|
export interface StateEvents {
|
|
// Jitsi-backed video room state events
|
|
[JitsiCallMemberEventType]: JitsiCallMemberContent;
|
|
|
|
// Unstable widgets state events
|
|
"im.vector.modular.widgets": IWidget | EmptyObject;
|
|
[WIDGET_LAYOUT_EVENT_TYPE]: ILayoutStateEvent;
|
|
|
|
// Element custom state events
|
|
"im.vector.web.settings": Record<string, any>;
|
|
"org.matrix.room.preview_urls": { disable: boolean };
|
|
|
|
// XXX unspecced usages of `m.room.*` events
|
|
"m.room.plumbing": {
|
|
status: string;
|
|
};
|
|
"m.room.bot.options": unknown;
|
|
}
|
|
|
|
export interface TimelineEvents {
|
|
"io.element.performance_metric": {
|
|
"io.element.performance_metrics": {
|
|
forEventId: string;
|
|
responseTs: number;
|
|
kind: "send_time";
|
|
};
|
|
};
|
|
}
|
|
|
|
export interface AccountDataEvents {
|
|
// Analytics account data event
|
|
"im.vector.analytics": {
|
|
id: string;
|
|
pseudonymousAnalyticsOptIn?: boolean;
|
|
};
|
|
// Device client information account data event
|
|
[key: `io.element.matrix_client_information.${string}`]: DeviceClientInformation;
|
|
// Element settings account data events
|
|
"im.vector.setting.breadcrumbs": { recent_rooms: string[] };
|
|
"io.element.recent_emoji": { recent_emoji: string[] };
|
|
"im.vector.setting.integration_provisioning": { enabled: boolean };
|
|
"im.vector.riot.breadcrumb_rooms": { recent_rooms: string[] };
|
|
"im.vector.web.settings": Record<string, any>;
|
|
|
|
// URL preview account data event
|
|
"org.matrix.preview_urls": { disable: boolean };
|
|
|
|
// This is not yet in the Matrix spec yet is being used as if it was
|
|
"m.widgets": {
|
|
[widgetId: string]: UserWidget;
|
|
};
|
|
|
|
// This is not in the Matrix spec yet seems to use an `m.` prefix
|
|
"m.accepted_terms": {
|
|
accepted: string[];
|
|
};
|
|
}
|
|
|
|
export interface AudioContent {
|
|
// MSC1767 + Ideals of MSC2516 as MSC3245
|
|
// https://github.com/matrix-org/matrix-doc/pull/3245
|
|
"org.matrix.msc1767.text"?: string;
|
|
"org.matrix.msc1767.file"?: {
|
|
url?: string;
|
|
file?: EncryptedFile;
|
|
name: string;
|
|
mimetype: string;
|
|
size: number;
|
|
};
|
|
"org.matrix.msc1767.audio"?: {
|
|
duration: number;
|
|
// https://github.com/matrix-org/matrix-doc/pull/3246
|
|
waveform?: number[];
|
|
};
|
|
"org.matrix.msc3245.voice"?: EmptyObject;
|
|
}
|
|
}
|