@matrix-widget-toolkit/api 4.2.0 → 5.0.0

package/build/cjs/api/extras/events.d.cts

@@ -1,5 +1,13 @@
 import Joi from 'joi';
 import { RoomEvent, StateEvent, ToDeviceMessageEvent } from '../types';
+/**
+ * The type of the power levels state event.
+ */
+export declare const STATE_EVENT_POWER_LEVELS = "m.room.power_levels";
+/**
+ * The types of type of the create event.
+ */
+export declare const STATE_EVENT_CREATE = "m.room.create";
 /**
  * Check if the given event is a {@link StateEvent}.
  *
@@ -38,3 +46,46 @@ export declare function isValidToDeviceMessageEvent(event: unknown): event is To
 export declare const roomEventSchema: Joi.ObjectSchema<RoomEvent>;
 export declare const stateEventSchema: Joi.ObjectSchema<StateEvent>;
 export declare const toDeviceMessageSchema: Joi.ObjectSchema<ToDeviceMessageEvent>;
+export type StateEventCreateContent = {
+    room_version?: string;
+    creator?: string;
+    additional_creators?: string[];
+};
+export declare const createEventSchema: Joi.ObjectSchema<StateEvent<StateEventCreateContent>>;
+/**
+ * Validates that `event` is has a valid structure for a
+ * {@link StateEventCreateContent}.
+ * @param event - The event to validate.
+ * @returns True, if the event is valid.
+ */
+export declare function isValidCreateEventSchema(event: StateEvent<unknown> | undefined): event is StateEvent<StateEventCreateContent>;
+/**
+ * The types of actions.
+ */
+export type PowerLevelsActions = 'invite' | 'kick' | 'ban' | 'redact';
+/**
+ * The content of an `m.room.power_levels` event.
+ */
+export type PowerLevelsStateEvent = {
+    events?: {
+        [key: string]: number;
+    };
+    state_default?: number;
+    events_default?: number;
+    users?: {
+        [key: string]: number;
+    };
+    users_default?: number;
+    ban?: number;
+    invite?: number;
+    kick?: number;
+    redact?: number;
+};
+export declare const powerLevelsEventSchema: Joi.ObjectSchema<StateEvent<PowerLevelsStateEvent>>;
+/**
+ * Validates that `event` is has a valid structure for a
+ * {@link PowerLevelsStateEvent}.
+ * @param event - The event to validate.
+ * @returns True, if the event is valid.
+ */
+export declare function isValidPowerLevelStateEvent(event: StateEvent<unknown>): event is StateEvent<PowerLevelsStateEvent>;

package/build/cjs/api/extras/index.d.cts

@@ -1,11 +1,12 @@
 export { generateRoomTimelineCapabilities } from './capabilities';
 export { getRoomMemberDisplayName } from './displayName';
-export { isRoomEvent, isStateEvent, isValidRoomEvent, isValidStateEvent as isValidStateEVent, isValidToDeviceMessageEvent, } from './events';
+export { STATE_EVENT_CREATE, isRoomEvent, isStateEvent, isValidCreateEventSchema, isValidRoomEvent, isValidStateEvent as isValidStateEVent, isValidToDeviceMessageEvent, } from './events';
+export type { PowerLevelsActions, PowerLevelsStateEvent, StateEventCreateContent, } from './events';
 export { WIDGET_CAPABILITY_NAVIGATE, navigateToRoom } from './navigateTo';
 export type { NavigateToRoomOptions } from './navigateTo';
 export { compareOriginServerTS } from './originServerTs';
 export { STATE_EVENT_POWER_LEVELS, calculateUserPowerLevel, hasActionPower, hasRoomEventPower, hasStateEventPower, isValidPowerLevelStateEvent, } from './powerLevel';
-export type { PowerLevelsActions, PowerLevelsStateEvent } from './powerLevel';
+export type { ROOM_VERSION_12_CREATOR, UserPowerLevelType } from './powerLevel';
 export { ROOM_EVENT_REDACTION, isValidRedactionEvent, observeRedactionEvents, redactEvent, } from './redactions';
 export type { Redaction, RedactionRoomEvent } from './redactions';
 export { getContent, getOriginalEventId, isValidEventWithRelatesTo, } from './relatesTo';

package/build/cjs/api/extras/powerLevel.d.cts

@@ -1,55 +1,32 @@
 import { StateEvent } from '../types';
+import type { PowerLevelsActions, PowerLevelsStateEvent, StateEventCreateContent } from './events';
+export { isValidPowerLevelStateEvent, STATE_EVENT_POWER_LEVELS, } from './events';
 /**
- * The name of the power levels state event.
+ * Room version 12 requires us to have something larger than Max integer for room creators.
+ * This is a workaround to allow the room creator to always have the highest power level.
  */
-export declare const STATE_EVENT_POWER_LEVELS = "m.room.power_levels";
-/**
- * The types of actions.
- */
-export type PowerLevelsActions = 'invite' | 'kick' | 'ban' | 'redact';
-/**
- * The content of an `m.room.power_levels` event.
- */
-export type PowerLevelsStateEvent = {
-    events?: {
-        [key: string]: number;
-    };
-    state_default?: number;
-    events_default?: number;
-    users?: {
-        [key: string]: number;
-    };
-    users_default?: number;
-    ban?: number;
-    invite?: number;
-    kick?: number;
-    redact?: number;
-};
-/**
- * Validates that `event` is has a valid structure for a
- * {@link PowerLevelsStateEvent}.
- * @param event - The event to validate.
- * @returns True, if the event is valid.
- */
-export declare function isValidPowerLevelStateEvent(event: StateEvent<unknown>): event is StateEvent<PowerLevelsStateEvent>;
+export declare const ROOM_VERSION_12_CREATOR = "ROOM_VERSION_12_CREATOR";
+export type UserPowerLevelType = number | typeof ROOM_VERSION_12_CREATOR;
 /**
  * Check if a user has the power to send a specific room event.
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event for the room
  * @param userId - the id of the user
  * @param eventType - the type of room event
  * @returns if true, the user has the power
  */
-export declare function hasRoomEventPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, userId: string | undefined, eventType: string): boolean;
+export declare function hasRoomEventPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, createRoomStateEvent: StateEvent<StateEventCreateContent> | undefined, userId: string | undefined, eventType: string): boolean;
 /**
  * Check if a user has the power to send a specific state event.
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event for the room
  * @param userId - the id of the user
  * @param eventType - the type of state event
  * @returns if true, the user has the power
  */
-export declare function hasStateEventPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, userId: string | undefined, eventType: string): boolean;
+export declare function hasStateEventPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, createRoomStateEvent: StateEvent<StateEventCreateContent> | undefined, userId: string | undefined, eventType: string): boolean;
 /**
  * Check if a user has the power to perform a specific action.
  *
@@ -60,19 +37,25 @@ export declare function hasStateEventPower(powerLevelStateEvent: PowerLevelsStat
  *   * redact: Redact a message from another user
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event for the room
  * @param userId - the id of the user
  * @param action - the action
  * @returns if true, the user has the power
  */
-export declare function hasActionPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, userId: string | undefined, action: PowerLevelsActions): boolean;
+export declare function hasActionPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, createRoomStateEvent: StateEvent<StateEventCreateContent> | undefined, userId: string | undefined, action: PowerLevelsActions): boolean;
 /**
  * Calculate the power level of the user based on a `m.room.power_levels` event.
  *
+ * Note that we return the @see UserPowerLevelType type instead of a number as Room Version 12
+ * gives a Room creator (and additionalCreators) always the highest power level regardless
+ * of the highest next Powerlevel number.
+ *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event.
+ * @param createRoomStateEvent - the `m.room.create` event for the room.
  * @param userId - the ID of the user.
  * @returns the power level of the user.
  */
-export declare function calculateUserPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent, userId?: string): number;
+export declare function calculateUserPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent | undefined, createRoomStateEvent: StateEvent<StateEventCreateContent> | undefined, userId: string): UserPowerLevelType;
 /**
  * Calculate the power level that a user needs send a specific room event.
  *
@@ -80,15 +63,16 @@ export declare function calculateUserPowerLevel(powerLevelStateEvent: PowerLevel
  * @param eventType - the type of room event
  * @returns the power level that is needed
  */
-export declare function calculateRoomEventPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent, eventType: string): number;
+export declare function calculateRoomEventPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent | undefined, eventType: string): number;
 /**
  * Calculate the power level that a user needs send a specific state event.
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event
  * @param eventType - the type of state event
  * @returns the power level that is needed
  */
-export declare function calculateStateEventPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent, eventType: string): number;
+export declare function calculateStateEventPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent | undefined, createRoomStateEvent: StateEvent<StateEventCreateContent> | undefined, eventType: string): number;
 /**
  * Calculate the power level that a user needs to perform an action.
  *
@@ -102,4 +86,4 @@ export declare function calculateStateEventPowerLevel(powerLevelStateEvent: Powe
  * @param action - the action
  * @returns the power level that is needed
  */
-export declare function calculateActionPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent, action: PowerLevelsActions): number;
+export declare function calculateActionPowerLevel(powerLevelStateEvent: PowerLevelsStateEvent | undefined, action: PowerLevelsActions): number;

package/build/cjs/index.cjs

@@ -124,6 +124,14 @@ var __assign$2 = (undefined && undefined.__assign) || function () {
     };
     return __assign$2.apply(this, arguments);
 };
+/**
+ * The type of the power levels state event.
+ */
+var STATE_EVENT_POWER_LEVELS = 'm.room.power_levels';
+/**
+ * The types of type of the create event.
+ */
+var STATE_EVENT_CREATE = 'm.room.create';
 /**
  * Check if the given event is a {@link StateEvent}.
  *
@@ -151,7 +159,12 @@ function isRoomEvent(event) {
 // Allow any here, so that the validation works for every event
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function isValidRoomEvent(event) {
-    return roomEventSchema.validate(event).error === undefined;
+    var result = roomEventSchema.validate(event);
+    if (result.error) {
+        console.warn('Invalid room event:', result.error.details, { event: event });
+        return false;
+    }
+    return true;
 }
 /**
  * Check if the given value is a valid {@link StateEvent}.
@@ -162,7 +175,12 @@ function isValidRoomEvent(event) {
 // Allow any here, so that the validation works for every event
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function isValidStateEvent(event) {
-    return stateEventSchema.validate(event).error === undefined;
+    var result = stateEventSchema.validate(event);
+    if (result.error) {
+        console.warn('Invalid state event:', result.error.details, { event: event });
+        return false;
+    }
+    return true;
 }
 /**
  * Check if the given value is a valid {@link ToDeviceMessageEvent}.
@@ -171,19 +189,26 @@ function isValidStateEvent(event) {
  * @returns true if value is a valid to device message, else false.
  */
 function isValidToDeviceMessageEvent(event) {
-    return toDeviceMessageSchema.validate(event).error === undefined;
+    var result = toDeviceMessageSchema.validate(event);
+    if (result.error) {
+        console.warn('Invalid to device message event:', result.error.details, {
+            event: event,
+        });
+        return false;
+    }
+    return true;
 }
-/**
- * Base properties to validate for all events.
- */
-var eventSchemaProps = {
-    type: Joi__default.default.string().required(),
+var eventSchemaBasicProps = {
     // Do roughly check against the format
     // https://spec.matrix.org/v1.13/appendices/#common-identifier-format
     sender: Joi__default.default.string().pattern(new RegExp('^@[^\\s:]*:\\S*$')).required(),
-    room_id: Joi__default.default.string().pattern(new RegExp('^![^:]*:\\S*')).required(),
-    content: Joi__default.default.object().required(),
+    // Prior versions of the code had checked for a server_name. However in room version 12+ this got dropped. There is no way for us to check this here.
+    room_id: Joi__default.default.string().pattern(new RegExp('^!')).required(),
 };
+/**
+ * Base properties to validate for all events.
+ */
+var eventSchemaProps = __assign$2({ type: Joi__default.default.string().required(), content: Joi__default.default.object().required() }, eventSchemaBasicProps);
 var roomEventSchema = Joi__default.default.object(__assign$2(__assign$2({}, eventSchemaProps), { event_id: Joi__default.default.string().pattern(new RegExp('^\\$.*')).required(), origin_server_ts: Joi__default.default.date().timestamp('javascript').required() })).unknown();
 var stateEventSchema = Joi__default.default.object(__assign$2(__assign$2({}, eventSchemaProps), { event_id: Joi__default.default.string().pattern(new RegExp('^\\$.*')), origin_server_ts: Joi__default.default.date().timestamp('javascript'), state_key: Joi__default.default.string().allow('').required() })).unknown();
 var toDeviceMessageSchema = Joi__default.default.object({
@@ -192,6 +217,71 @@ var toDeviceMessageSchema = Joi__default.default.object({
     encrypted: Joi__default.default.boolean().required(),
     content: Joi__default.default.object().required(),
 }).unknown();
+var createEventSchema = Joi__default.default.object(__assign$2(__assign$2({}, eventSchemaBasicProps), { type: Joi__default.default.string().equal(STATE_EVENT_CREATE).required(), content: Joi__default.default.object({
+        // Room version 1 does not have a room version, so we allow it to be undefined.
+        room_version: Joi__default.default.string().optional(),
+        // The user ID of the creator of the room. (only from 1-10. after that we must use the sender field)
+        creator: Joi__default.default.string().optional(),
+        // Room version 12 introduces the additional_creators field.
+        additional_creators: Joi__default.default.array().items(Joi__default.default.string()).optional(),
+    })
+        .unknown()
+        .required() })).unknown();
+/**
+ * Validates that `event` is has a valid structure for a
+ * {@link StateEventCreateContent}.
+ * @param event - The event to validate.
+ * @returns True, if the event is valid.
+ */
+function isValidCreateEventSchema(event) {
+    if (!event) {
+        return true;
+    }
+    var result = createEventSchema.validate(event);
+    if (result.error) {
+        console.warn('Invalid room create message event:', result.error.details, {
+            event: event,
+        });
+        return false;
+    }
+    return true;
+}
+var powerLevelsEventSchema = Joi__default.default.object(__assign$2(__assign$2({}, eventSchemaBasicProps), { 
+    // Strictly require to match the power levels event type
+    type: Joi__default.default.string().equal(STATE_EVENT_POWER_LEVELS).required(), content: Joi__default.default.object({
+        ban: Joi__default.default.number().optional().default(50),
+        events: Joi__default.default.object().pattern(Joi__default.default.string(), Joi__default.default.number()).optional(),
+        events_default: Joi__default.default.number().optional().default(0),
+        invite: Joi__default.default.number().optional().default(0),
+        kick: Joi__default.default.number().optional().default(50),
+        notifications: Joi__default.default.object({
+            room: Joi__default.default.number().optional().default(50),
+        })
+            .unknown()
+            .optional(),
+        redact: Joi__default.default.number().optional().default(50),
+        state_default: Joi__default.default.number().optional().default(50),
+        users: Joi__default.default.object().pattern(Joi__default.default.string(), Joi__default.default.number()).optional(),
+        users_default: Joi__default.default.number().optional().default(0),
+    })
+        .unknown()
+        .required() })).unknown();
+/**
+ * Validates that `event` is has a valid structure for a
+ * {@link PowerLevelsStateEvent}.
+ * @param event - The event to validate.
+ * @returns True, if the event is valid.
+ */
+function isValidPowerLevelStateEvent(event) {
+    var result = powerLevelsEventSchema.validate(event);
+    if (result.error) {
+        console.warn('Invalid powerlevel event:', result.error.details, {
+            event: event,
+        });
+        return false;
+    }
+    return true;
+}
 
 /*
  * Copyright 2022 Nordeck IT + Consulting GmbH
@@ -319,95 +409,57 @@ function compareOriginServerTS(a, b) {
  * limitations under the License.
  */
 /**
- * The name of the power levels state event.
+ * Room version 12 requires us to have something larger than Max integer for room creators.
+ * This is a workaround to allow the room creator to always have the highest power level.
  */
-var STATE_EVENT_POWER_LEVELS = 'm.room.power_levels';
-function isNumberOrUndefined(value) {
-    return value === undefined || typeof value === 'number';
-}
-function isStringToNumberMapOrUndefined(value) {
-    return (value === undefined ||
-        (value !== null &&
-            typeof value === 'object' &&
-            Object.entries(value).every(function (_a) {
-                var k = _a[0], v = _a[1];
-                return typeof k === 'string' && typeof v === 'number';
-            })));
-}
-/**
- * Validates that `event` is has a valid structure for a
- * {@link PowerLevelsStateEvent}.
- * @param event - The event to validate.
- * @returns True, if the event is valid.
- */
-function isValidPowerLevelStateEvent(event) {
-    if (event.type !== STATE_EVENT_POWER_LEVELS ||
-        typeof event.content !== 'object') {
-        return false;
-    }
-    var content = event.content;
-    if (!isStringToNumberMapOrUndefined(content.events)) {
-        return false;
-    }
-    if (!isNumberOrUndefined(content.state_default)) {
-        return false;
-    }
-    if (!isNumberOrUndefined(content.events_default)) {
-        return false;
-    }
-    if (!isStringToNumberMapOrUndefined(content.users)) {
-        return false;
-    }
-    if (!isNumberOrUndefined(content.users_default)) {
-        return false;
-    }
-    if (!isNumberOrUndefined(content.ban)) {
-        return false;
-    }
-    if (!isNumberOrUndefined(content.invite)) {
-        return false;
-    }
-    if (!isNumberOrUndefined(content.kick)) {
-        return false;
+var ROOM_VERSION_12_CREATOR = 'ROOM_VERSION_12_CREATOR';
+function compareUserPowerLevelToNormalPowerLevel(userPowerLevel, normalPowerLevel) {
+    if (userPowerLevel === ROOM_VERSION_12_CREATOR) {
+        // Room version 12 creator has the highest power level.
+        return true;
     }
-    if (!isNumberOrUndefined(content.redact)) {
+    if (typeof userPowerLevel !== 'number') {
+        // If the user power level is not a number, we cannot compare it to a normal power level.
         return false;
     }
-    return true;
+    // Compare the user power level to the normal power level.
+    return userPowerLevel >= normalPowerLevel;
 }
 /**
  * Check if a user has the power to send a specific room event.
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event for the room
  * @param userId - the id of the user
  * @param eventType - the type of room event
  * @returns if true, the user has the power
  */
-function hasRoomEventPower(powerLevelStateEvent, userId, eventType) {
-    if (!powerLevelStateEvent) {
-        // See https://github.com/matrix-org/matrix-spec/blob/203b9756f52adfc2a3b63d664f18cdbf9f8bf126/data/event-schemas/schema/m.room.power_levels.yaml#L36-L43
-        return true;
+function hasRoomEventPower(powerLevelStateEvent, createRoomStateEvent, userId, eventType) {
+    if (!userId) {
+        // This is invalid but required to be checked due to widget API which may not know it
+        throw new Error('Cannot check action power without a user ID. Please provide a user ID.');
     }
-    var userLevel = calculateUserPowerLevel(powerLevelStateEvent, userId);
+    var userLevel = calculateUserPowerLevel(powerLevelStateEvent, createRoomStateEvent, userId);
     var eventLevel = calculateRoomEventPowerLevel(powerLevelStateEvent, eventType);
-    return userLevel >= eventLevel;
+    return compareUserPowerLevelToNormalPowerLevel(userLevel, eventLevel);
 }
 /**
  * Check if a user has the power to send a specific state event.
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event for the room
  * @param userId - the id of the user
  * @param eventType - the type of state event
  * @returns if true, the user has the power
  */
-function hasStateEventPower(powerLevelStateEvent, userId, eventType) {
-    if (!powerLevelStateEvent) {
-        // See https://github.com/matrix-org/matrix-spec/blob/203b9756f52adfc2a3b63d664f18cdbf9f8bf126/data/event-schemas/schema/m.room.power_levels.yaml#L36-L43
-        return true;
+function hasStateEventPower(powerLevelStateEvent, createRoomStateEvent, userId, eventType) {
+    if (!userId) {
+        // This is invalid but required to be checked due to widget API which may not know it
+        throw new Error('Cannot check action power without a user ID. Please provide a user ID.');
     }
-    var userLevel = calculateUserPowerLevel(powerLevelStateEvent, userId);
-    var eventLevel = calculateStateEventPowerLevel(powerLevelStateEvent, eventType);
-    return userLevel >= eventLevel;
+    var userLevel = calculateUserPowerLevel(powerLevelStateEvent, createRoomStateEvent, userId);
+    var eventLevel = calculateStateEventPowerLevel(powerLevelStateEvent, createRoomStateEvent, eventType);
+    return compareUserPowerLevelToNormalPowerLevel(userLevel, eventLevel);
 }
 /**
  * Check if a user has the power to perform a specific action.
@@ -419,30 +471,74 @@ function hasStateEventPower(powerLevelStateEvent, userId, eventType) {
  *   * redact: Redact a message from another user
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event for the room
  * @param userId - the id of the user
  * @param action - the action
  * @returns if true, the user has the power
  */
-function hasActionPower(powerLevelStateEvent, userId, action) {
-    if (!powerLevelStateEvent) {
-        // See https://github.com/matrix-org/matrix-spec/blob/203b9756f52adfc2a3b63d664f18cdbf9f8bf126/data/event-schemas/schema/m.room.power_levels.yaml#L36-L43
-        return true;
+function hasActionPower(powerLevelStateEvent, createRoomStateEvent, userId, action) {
+    if (!userId) {
+        // This is invalid but required to be checked due to widget API which may not know it
+        throw new Error('Cannot check action power without a user ID. Please provide a user ID.');
     }
-    var userLevel = calculateUserPowerLevel(powerLevelStateEvent, userId);
+    var userLevel = calculateUserPowerLevel(powerLevelStateEvent, createRoomStateEvent, userId);
     var eventLevel = calculateActionPowerLevel(powerLevelStateEvent, action);
-    return userLevel >= eventLevel;
+    return compareUserPowerLevelToNormalPowerLevel(userLevel, eventLevel);
 }
 /**
  * Calculate the power level of the user based on a `m.room.power_levels` event.
  *
+ * Note that we return the @see UserPowerLevelType type instead of a number as Room Version 12
+ * gives a Room creator (and additionalCreators) always the highest power level regardless
+ * of the highest next Powerlevel number.
+ *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event.
+ * @param createRoomStateEvent - the `m.room.create` event for the room.
  * @param userId - the ID of the user.
  * @returns the power level of the user.
  */
-function calculateUserPowerLevel(powerLevelStateEvent, userId) {
-    var _a, _b, _c;
-    // See https://github.com/matrix-org/matrix-spec/blob/203b9756f52adfc2a3b63d664f18cdbf9f8bf126/data/event-schemas/schema/m.room.power_levels.yaml#L8-L12
-    return ((_c = (_b = (userId ? (_a = powerLevelStateEvent.users) === null || _a === void 0 ? void 0 : _a[userId] : undefined)) !== null && _b !== void 0 ? _b : powerLevelStateEvent.users_default) !== null && _c !== void 0 ? _c : 0);
+function calculateUserPowerLevel(powerLevelStateEvent, createRoomStateEvent, userId) {
+    var _a, _b, _c, _d, _e, _f;
+    // This is practically not allowed and therefor not covered by the spec. However a js consumer could still pass an undefined userId so we handle it gracefully.
+    if (!userId) {
+        // If no user ID is provided, we return the default user power level or 0 if not set.
+        return 0;
+    }
+    // If we have room version 12 we must check if the user is the creator of the room and needs to have the highest power level.
+    if (((_a = createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.content) === null || _a === void 0 ? void 0 : _a.room_version) === '12' ||
+        ((_b = createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.content) === null || _b === void 0 ? void 0 : _b.room_version) === 'org.matrix.hydra.11') {
+        // If the user is the creator of the room, we return the special ROOM_VERSION_12_CREATOR value.
+        if (createRoomStateEvent.sender === userId) {
+            return ROOM_VERSION_12_CREATOR;
+        }
+        if ((_c = createRoomStateEvent.content.additional_creators) === null || _c === void 0 ? void 0 : _c.includes(userId)) {
+            // If the user is an additional creator of the room, we return the special ROOM_VERSION_12_CREATOR value.
+            return ROOM_VERSION_12_CREATOR;
+        }
+    }
+    // If there is no power level state event, we assume the user has no power unless they are the room creator in which case they get PL 100.
+    if (!powerLevelStateEvent) {
+        if (['1', '2', '3', '4', '5', '6', '7', '8', '9', '10'].includes((_e = (_d = createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.content) === null || _d === void 0 ? void 0 : _d.room_version) !== null && _e !== void 0 ? _e : '1')) {
+            // Room version 1-10 does not have a room version, so we assume the creator has power level 100.
+            return ((_f = createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.content) === null || _f === void 0 ? void 0 : _f.creator) === userId ? 100 : 0;
+        }
+        else {
+            // For room versions 11 and above, we assume the sender has power level 100.
+            return (createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.sender) === userId ? 100 : 0;
+        }
+    }
+    if (powerLevelStateEvent.users && userId in powerLevelStateEvent.users) {
+        // If the user is explicitly listed in the users map, return their power level.
+        return powerLevelStateEvent.users[userId];
+    }
+    else if (powerLevelStateEvent.users_default !== undefined) {
+        // If the user is not explicitly listed, return the default user power level.
+        return powerLevelStateEvent.users_default;
+    }
+    else {
+        // If no users or default is set, return 0.
+        return 0;
+    }
 }
 /**
  * Calculate the power level that a user needs send a specific room event.
@@ -454,19 +550,26 @@ function calculateUserPowerLevel(powerLevelStateEvent, userId) {
 function calculateRoomEventPowerLevel(powerLevelStateEvent, eventType) {
     var _a, _b, _c;
     // See https://github.com/matrix-org/matrix-spec/blob/203b9756f52adfc2a3b63d664f18cdbf9f8bf126/data/event-schemas/schema/m.room.power_levels.yaml#L14-L19
-    return ((_c = (_b = (_a = powerLevelStateEvent.events) === null || _a === void 0 ? void 0 : _a[eventType]) !== null && _b !== void 0 ? _b : powerLevelStateEvent.events_default) !== null && _c !== void 0 ? _c : 0);
+    return ((_c = (_b = (_a = powerLevelStateEvent === null || powerLevelStateEvent === void 0 ? void 0 : powerLevelStateEvent.events) === null || _a === void 0 ? void 0 : _a[eventType]) !== null && _b !== void 0 ? _b : powerLevelStateEvent === null || powerLevelStateEvent === void 0 ? void 0 : powerLevelStateEvent.events_default) !== null && _c !== void 0 ? _c : 0);
 }
 /**
  * Calculate the power level that a user needs send a specific state event.
  *
  * @param powerLevelStateEvent - the content of the `m.room.power_levels` event
+ * @param createRoomStateEvent - the `m.room.create` event
  * @param eventType - the type of state event
  * @returns the power level that is needed
  */
-function calculateStateEventPowerLevel(powerLevelStateEvent, eventType) {
-    var _a, _b, _c;
+function calculateStateEventPowerLevel(powerLevelStateEvent, createRoomStateEvent, eventType) {
+    var _a, _b, _c, _d, _e;
+    // In room version 12 (and the beta org.matrix.hydra.11 version) we need 150 for m.room.tombstone events and it cant be changed by the user.
+    if ((((_a = createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.content) === null || _a === void 0 ? void 0 : _a.room_version) === '12' ||
+        ((_b = createRoomStateEvent === null || createRoomStateEvent === void 0 ? void 0 : createRoomStateEvent.content) === null || _b === void 0 ? void 0 : _b.room_version) === 'org.matrix.hydra.11') &&
+        eventType === 'm.room.tombstone') {
+        return 150;
+    }
     // See https://github.com/matrix-org/matrix-spec/blob/203b9756f52adfc2a3b63d664f18cdbf9f8bf126/data/event-schemas/schema/m.room.power_levels.yaml#L14-L19
-    return ((_c = (_b = (_a = powerLevelStateEvent.events) === null || _a === void 0 ? void 0 : _a[eventType]) !== null && _b !== void 0 ? _b : powerLevelStateEvent.state_default) !== null && _c !== void 0 ? _c : 50);
+    return ((_e = (_d = (_c = powerLevelStateEvent === null || powerLevelStateEvent === void 0 ? void 0 : powerLevelStateEvent.events) === null || _c === void 0 ? void 0 : _c[eventType]) !== null && _d !== void 0 ? _d : powerLevelStateEvent === null || powerLevelStateEvent === void 0 ? void 0 : powerLevelStateEvent.state_default) !== null && _e !== void 0 ? _e : 50);
 }
 /**
  * Calculate the power level that a user needs to perform an action.
@@ -1914,6 +2017,7 @@ var WidgetApiImpl = /** @class */ (function () {
 }());
 
 exports.ROOM_EVENT_REDACTION = ROOM_EVENT_REDACTION;
+exports.STATE_EVENT_CREATE = STATE_EVENT_CREATE;
 exports.STATE_EVENT_POWER_LEVELS = STATE_EVENT_POWER_LEVELS;
 exports.STATE_EVENT_ROOM_MEMBER = STATE_EVENT_ROOM_MEMBER;
 exports.WIDGET_CAPABILITY_NAVIGATE = WIDGET_CAPABILITY_NAVIGATE;
@@ -1934,6 +2038,7 @@ exports.hasStateEventPower = hasStateEventPower;
 exports.hasWidgetParameters = hasWidgetParameters;
 exports.isRoomEvent = isRoomEvent;
 exports.isStateEvent = isStateEvent;
+exports.isValidCreateEventSchema = isValidCreateEventSchema;
 exports.isValidEventWithRelatesTo = isValidEventWithRelatesTo;
 exports.isValidPowerLevelStateEvent = isValidPowerLevelStateEvent;
 exports.isValidRedactionEvent = isValidRedactionEvent;

package/build/esm/api/extras/events.d.ts

@@ -1,5 +1,13 @@
 import Joi from 'joi';
 import { RoomEvent, StateEvent, ToDeviceMessageEvent } from '../types';
+/**
+ * The type of the power levels state event.
+ */
+export declare const STATE_EVENT_POWER_LEVELS = "m.room.power_levels";
+/**
+ * The types of type of the create event.
+ */
+export declare const STATE_EVENT_CREATE = "m.room.create";
 /**
  * Check if the given event is a {@link StateEvent}.
  *
@@ -38,3 +46,46 @@ export declare function isValidToDeviceMessageEvent(event: unknown): event is To
 export declare const roomEventSchema: Joi.ObjectSchema<RoomEvent>;
 export declare const stateEventSchema: Joi.ObjectSchema<StateEvent>;
 export declare const toDeviceMessageSchema: Joi.ObjectSchema<ToDeviceMessageEvent>;
+export type StateEventCreateContent = {
+    room_version?: string;
+    creator?: string;
+    additional_creators?: string[];
+};
+export declare const createEventSchema: Joi.ObjectSchema<StateEvent<StateEventCreateContent>>;
+/**
+ * Validates that `event` is has a valid structure for a
+ * {@link StateEventCreateContent}.
+ * @param event - The event to validate.
+ * @returns True, if the event is valid.
+ */
+export declare function isValidCreateEventSchema(event: StateEvent<unknown> | undefined): event is StateEvent<StateEventCreateContent>;
+/**
+ * The types of actions.
+ */
+export type PowerLevelsActions = 'invite' | 'kick' | 'ban' | 'redact';
+/**
+ * The content of an `m.room.power_levels` event.
+ */
+export type PowerLevelsStateEvent = {
+    events?: {
+        [key: string]: number;
+    };
+    state_default?: number;
+    events_default?: number;
+    users?: {
+        [key: string]: number;
+    };
+    users_default?: number;
+    ban?: number;
+    invite?: number;
+    kick?: number;
+    redact?: number;
+};
+export declare const powerLevelsEventSchema: Joi.ObjectSchema<StateEvent<PowerLevelsStateEvent>>;
+/**
+ * Validates that `event` is has a valid structure for a
+ * {@link PowerLevelsStateEvent}.
+ * @param event - The event to validate.
+ * @returns True, if the event is valid.
+ */
+export declare function isValidPowerLevelStateEvent(event: StateEvent<unknown>): event is StateEvent<PowerLevelsStateEvent>;