Michael Telatynski
39 lines
867 B
TypeScript
39 lines
867 B
TypeScript
/*
|
|
Copyright 2025 New Vector Ltd.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { type Watchable } from "./watchable.ts";
|
|
|
|
/**
|
|
* The profile of the user currently logged in.
|
|
* @public
|
|
*/
|
|
export interface Profile {
|
|
/**
|
|
* Indicates whether the user is a guest user.
|
|
*/
|
|
isGuest?: boolean;
|
|
/**
|
|
* The user ID of the logged-in user, if undefined then no user is logged in.
|
|
*/
|
|
userId?: string;
|
|
/**
|
|
* The display name of the logged-in user.
|
|
*/
|
|
displayName?: string;
|
|
}
|
|
|
|
/**
|
|
* API extensions for modules to access the profile of the logged-in user.
|
|
* @public
|
|
*/
|
|
export interface ProfileApiExtension {
|
|
/**
|
|
* The profile of the user currently logged in.
|
|
*/
|
|
readonly profile: Watchable<Profile>;
|
|
}
|