Skip to content

Export additional functions so we can reuse them in widgets #982

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
Marcel-Nordeck merged 3 commits into from
Aug 11, 2025
Merged

Export additional functions so we can reuse them in widgets #982

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe0fea3
Export additional functions so we can reuse them in widgets
Marcel-Nordeck Aug 11, 2025
f168faf
Fix jsdoc
Marcel-Nordeck Aug 11, 2025
d52cbcc
Improve changeset wording
Marcel-Nordeck Aug 11, 2025
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
5 changes: 5 additions & 0 deletions .changeset/tame-trains-look.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@matrix-widget-toolkit/api': patch
---

Also expose ROOM_VERSION_12_CREATOR and compareUserPowerLevelToNormalPowerLevel on the API surface as it is used by neoboard
3 changes: 3 additions & 0 deletions packages/api/api-report.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export function calculateUserPowerLevel(powerLevelStateEvent: PowerLevelsStateEv
// @public
export function compareOriginServerTS<T>(a: RoomEvent<T>, b: RoomEvent<T>): number;

// @public
export function compareUserPowerLevelToNormalPowerLevel(userPowerLevel: UserPowerLevelType, normalPowerLevel: number): boolean;

// @public
export type EventWithRelatesTo<RelationType extends string> = RoomEvent<{
'm.relates_to': RelatesTo<RelationType>;
Expand Down
4 changes: 3 additions & 1 deletion packages/api/src/api/extras/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ export { WIDGET_CAPABILITY_NAVIGATE, navigateToRoom } from './navigateTo';
export type { NavigateToRoomOptions } from './navigateTo';
export { compareOriginServerTS } from './originServerTs';
export {
ROOM_VERSION_12_CREATOR,
STATE_EVENT_POWER_LEVELS,
calculateUserPowerLevel,
compareUserPowerLevelToNormalPowerLevel,
hasActionPower,
hasRoomEventPower,
hasStateEventPower,
isValidPowerLevelStateEvent,
} from './powerLevel';
export type { ROOM_VERSION_12_CREATOR, UserPowerLevelType } from './powerLevel';
export type { UserPowerLevelType } from './powerLevel';
export {
ROOM_EVENT_REDACTION,
isValidRedactionEvent,
Expand Down
8 changes: 7 additions & 1 deletion packages/api/src/api/extras/powerLevel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,13 @@ export const ROOM_VERSION_12_CREATOR = 'ROOM_VERSION_12_CREATOR';

export type UserPowerLevelType = number | typeof ROOM_VERSION_12_CREATOR;

function compareUserPowerLevelToNormalPowerLevel(
/**
* Compare a user's power level to a normal power level.
* @param userPowerLevel - The user's power level
* @param normalPowerLevel - The normal power level
* @returns True if the user's power level is greater than or equal to the normal power level, false otherwise
*/
export function compareUserPowerLevelToNormalPowerLevel(
userPowerLevel: UserPowerLevelType,
normalPowerLevel: number,
): boolean {
Expand Down
Loading