David BakerandGitHub
707d5a4353
* Add user status to DM rooms in the room list * Screenshot * Tests for fetchUserStatus
66 lines
2.3 KiB
TypeScript
66 lines
2.3 KiB
TypeScript
/**
|
|
Copyright 2026 Element Creations Ltd.
|
|
|
|
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 { useEffect, useState } from "react";
|
|
import { ClientEvent } from "matrix-js-sdk/src/matrix";
|
|
import { logger as rootLogger } from "matrix-js-sdk/src/logger";
|
|
import { type UserStatus } from "@element-hq/web-shared-components";
|
|
|
|
import { useMatrixClientContext } from "../contexts/MatrixClientContext";
|
|
import { useTypedEventEmitter } from "./useEventEmitter";
|
|
import { useFeatureEnabled } from "./useSettings";
|
|
import { fetchUserStatus, validateUserStatus } from "../utils/userStatus";
|
|
|
|
const logger = rootLogger.getChild("useUserStatus");
|
|
|
|
/**
|
|
* Hook to get the MSC4426 user status for a given user ID. Returns undefined if the feature is disabled,
|
|
* the user does not have a status, or if there was an error fetching the status.
|
|
*
|
|
* @param userId The ID of the user whose status is being fetched.
|
|
* @returns The user's status, or undefined if not available.
|
|
*/
|
|
export function useUserStatus(userId: string | undefined): UserStatus | undefined {
|
|
const isEnabled = useFeatureEnabled("feature_user_status");
|
|
const matrixClient = useMatrixClientContext();
|
|
const [userStatus, setUserStatus] = useState<UserStatus | undefined>();
|
|
|
|
useTypedEventEmitter(matrixClient, ClientEvent.UserProfileUpdate, (syncedUserId, syncProfile) => {
|
|
if (syncedUserId !== userId) {
|
|
return;
|
|
}
|
|
|
|
setUserStatus(validateUserStatus(syncProfile["org.matrix.msc4426.status"]));
|
|
});
|
|
useEffect(() => {
|
|
(async () => {
|
|
if (!isEnabled) {
|
|
return;
|
|
}
|
|
if (!userId) {
|
|
setUserStatus(undefined);
|
|
return;
|
|
}
|
|
if ((await matrixClient.doesServerSupportExtendedProfiles()) === false) {
|
|
setUserStatus(undefined);
|
|
return;
|
|
}
|
|
try {
|
|
const result = await fetchUserStatus(matrixClient, userId);
|
|
setUserStatus(result);
|
|
} catch (ex) {
|
|
logger.warn(`Failed to get userStatus for ${userId}`, ex);
|
|
}
|
|
})();
|
|
}, [isEnabled, userId, matrixClient]);
|
|
if (!isEnabled) {
|
|
return;
|
|
}
|
|
|
|
return userStatus;
|
|
}
|