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

* Export additional functions so we can reuse them in widgets

Signed-off-by: MTRNord <[email protected]>

* Fix jsdoc

Signed-off-by: MTRNord <[email protected]>

* Improve changeset wording

Co-authored-by: Milton Moura <[email protected]>
Signed-off-by: Marcel-Nordeck <[email protected]>

---------

Signed-off-by: MTRNord <[email protected]>
Signed-off-by: Marcel-Nordeck <[email protected]>
Co-authored-by: Milton Moura <[email protected]>

Author: Marcel-Nordeck

.changeset/tame-trains-look.md

@@ -0,0 +1,5 @@
+---
+'@matrix-widget-toolkit/api': patch
+---
+
+Expose `ROOM_VERSION_12_CREATOR` and `compareUserPowerLevelToNormalPowerLevel` on the API surface

packages/api/api-report.api.md

@@ -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>;

packages/api/src/api/extras/index.ts

@@ -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,

packages/api/src/api/extras/powerLevel.ts

@@ -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 {