From 56d0c5656a08a077ce34dec0fdf11867f5360775 Mon Sep 17 00:00:00 2001 From: Half-Shot Date: Tue, 17 Jun 2025 13:30:47 +0100 Subject: [PATCH] API update\ --- .../element-web-module-api.api.md | 35 ++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/packages/element-web-module-api/element-web-module-api.api.md b/packages/element-web-module-api/element-web-module-api.api.md index 754a4d2eec..3a8474d949 100644 --- a/packages/element-web-module-api/element-web-module-api.api.md +++ b/packages/element-web-module-api/element-web-module-api.api.md @@ -4,8 +4,10 @@ ```ts +import { EventStatus } from 'matrix-js-sdk'; +import { IEventRelation } from 'matrix-js-sdk'; import { JSX } from 'react'; -import { MatrixEvent } from 'matrix-js-sdk/lib/matrix'; +import { Membership } from 'matrix-js-sdk'; import { ModuleApi } from '@matrix-org/react-sdk-module-api'; import { Root } from 'react-dom/client'; import { RuntimeModule } from '@matrix-org/react-sdk-module-api'; @@ -62,6 +64,7 @@ export interface ConfigApi { // @public export interface CustomComponentsApi { + // Warning: (ae-incompatible-release-tags) The symbol "registerMessageRenderer" is marked as @public, but its signature references "MatrixEvent" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "registerMessageRenderer" is marked as @public, but its signature references "CustomMessageRenderFunction" which is marked as @alpha // Warning: (ae-incompatible-release-tags) The symbol "registerMessageRenderer" is marked as @public, but its signature references "CustomMessageRenderHints" which is marked as @alpha registerMessageRenderer(eventTypeOrFilter: string | ((mxEvent: MatrixEvent) => boolean), renderer: CustomMessageRenderFunction, hints?: CustomMessageRenderHints): void; @@ -134,6 +137,36 @@ export interface LifecycleCustomisations { onLoggedOutAndStorageCleared?(): void; } +// @beta +export interface MatrixEvent { + // (undocumented) + age?: number; + // (undocumented) + content: Record; + // (undocumented) + eventId: string; + // (undocumented) + membership?: Membership; + // (undocumented) + originServerTs: number; + // (undocumented) + redacts?: string; + // (undocumented) + relation?: IEventRelation | null; + // (undocumented) + roomId?: string; + // (undocumented) + sender: string; + // (undocumented) + stateKey?: string; + // (undocumented) + status: EventStatus; + // (undocumented) + type: string; + // (undocumented) + unsigned: Record; +} + // @alpha @deprecated (undocumented) export interface Media { // (undocumented)