@matrix-widget-toolkit/api 5.0.0 → 5.0.2

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

@@ -50,6 +50,7 @@ export type StateEventCreateContent = {
     room_version?: string;
     creator?: string;
     additional_creators?: string[];
+    type?: string;
 };
 export declare const createEventSchema: Joi.ObjectSchema<StateEvent<StateEventCreateContent>>;
 /**

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

@@ -5,8 +5,8 @@ export type { PowerLevelsActions, PowerLevelsStateEvent, StateEventCreateContent
 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 { ROOM_VERSION_12_CREATOR, UserPowerLevelType } from './powerLevel';
+export { ROOM_VERSION_12_CREATOR, STATE_EVENT_POWER_LEVELS, calculateUserPowerLevel, compareUserPowerLevelToNormalPowerLevel, hasActionPower, hasRoomEventPower, hasStateEventPower, isValidPowerLevelStateEvent, } from './powerLevel';
+export type { 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

@@ -7,6 +7,13 @@ export { isValidPowerLevelStateEvent, STATE_EVENT_POWER_LEVELS, } from './events
  */
 export declare const ROOM_VERSION_12_CREATOR = "ROOM_VERSION_12_CREATOR";
 export type UserPowerLevelType = number | typeof ROOM_VERSION_12_CREATOR;
+/**
+ * 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 declare function compareUserPowerLevelToNormalPowerLevel(userPowerLevel: UserPowerLevelType, normalPowerLevel: number): boolean;
 /**
  * Check if a user has the power to send a specific room event.
  *

package/build/cjs/index.cjs

@@ -224,6 +224,8 @@ var createEventSchema = Joi__default.default.object(__assign$2(__assign$2({}, ev
         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(),
+        // Optional room type
+        type: Joi__default.default.string().optional(),
     })
         .unknown()
         .required() })).unknown();
@@ -413,6 +415,12 @@ function compareOriginServerTS(a, b) {
  * This is a workaround to allow the room creator to always have the highest power level.
  */
 var ROOM_VERSION_12_CREATOR = 'ROOM_VERSION_12_CREATOR';
+/**
+ * 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
+ */
 function compareUserPowerLevelToNormalPowerLevel(userPowerLevel, normalPowerLevel) {
     if (userPowerLevel === ROOM_VERSION_12_CREATOR) {
         // Room version 12 creator has the highest power level.
@@ -2017,6 +2025,7 @@ var WidgetApiImpl = /** @class */ (function () {
 }());
 
 exports.ROOM_EVENT_REDACTION = ROOM_EVENT_REDACTION;
+exports.ROOM_VERSION_12_CREATOR = ROOM_VERSION_12_CREATOR;
 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;
@@ -2024,6 +2033,7 @@ exports.WIDGET_CAPABILITY_NAVIGATE = WIDGET_CAPABILITY_NAVIGATE;
 exports.WidgetApiImpl = WidgetApiImpl;
 exports.calculateUserPowerLevel = calculateUserPowerLevel;
 exports.compareOriginServerTS = compareOriginServerTS;
+exports.compareUserPowerLevelToNormalPowerLevel = compareUserPowerLevelToNormalPowerLevel;
 exports.extractRawWidgetParameters = extractRawWidgetParameters;
 exports.extractWidgetApiParameters = extractWidgetApiParameters;
 exports.extractWidgetParameters = extractWidgetParameters;

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

@@ -50,6 +50,7 @@ export type StateEventCreateContent = {
     room_version?: string;
     creator?: string;
     additional_creators?: string[];
+    type?: string;
 };
 export declare const createEventSchema: Joi.ObjectSchema<StateEvent<StateEventCreateContent>>;
 /**

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

@@ -5,8 +5,8 @@ export type { PowerLevelsActions, PowerLevelsStateEvent, StateEventCreateContent
 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 { ROOM_VERSION_12_CREATOR, UserPowerLevelType } from './powerLevel';
+export { ROOM_VERSION_12_CREATOR, STATE_EVENT_POWER_LEVELS, calculateUserPowerLevel, compareUserPowerLevelToNormalPowerLevel, hasActionPower, hasRoomEventPower, hasStateEventPower, isValidPowerLevelStateEvent, } from './powerLevel';
+export type { 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/esm/api/extras/powerLevel.d.ts

@@ -7,6 +7,13 @@ export { isValidPowerLevelStateEvent, STATE_EVENT_POWER_LEVELS, } from './events
  */
 export declare const ROOM_VERSION_12_CREATOR = "ROOM_VERSION_12_CREATOR";
 export type UserPowerLevelType = number | typeof ROOM_VERSION_12_CREATOR;
+/**
+ * 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 declare function compareUserPowerLevelToNormalPowerLevel(userPowerLevel: UserPowerLevelType, normalPowerLevel: number): boolean;
 /**
  * Check if a user has the power to send a specific room event.
  *

package/build/esm/index.js

@@ -218,6 +218,8 @@ var createEventSchema = Joi.object(__assign$2(__assign$2({}, eventSchemaBasicPro
         creator: Joi.string().optional(),
         // Room version 12 introduces the additional_creators field.
         additional_creators: Joi.array().items(Joi.string()).optional(),
+        // Optional room type
+        type: Joi.string().optional(),
     })
         .unknown()
         .required() })).unknown();
@@ -407,6 +409,12 @@ function compareOriginServerTS(a, b) {
  * This is a workaround to allow the room creator to always have the highest power level.
  */
 var ROOM_VERSION_12_CREATOR = 'ROOM_VERSION_12_CREATOR';
+/**
+ * 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
+ */
 function compareUserPowerLevelToNormalPowerLevel(userPowerLevel, normalPowerLevel) {
     if (userPowerLevel === ROOM_VERSION_12_CREATOR) {
         // Room version 12 creator has the highest power level.
@@ -2010,4 +2018,4 @@ var WidgetApiImpl = /** @class */ (function () {
     return WidgetApiImpl;
 }());
 
-export { ROOM_EVENT_REDACTION, STATE_EVENT_CREATE, STATE_EVENT_POWER_LEVELS, STATE_EVENT_ROOM_MEMBER, WIDGET_CAPABILITY_NAVIGATE, WidgetApiImpl, WidgetParameter, calculateUserPowerLevel, compareOriginServerTS, extractRawWidgetParameters, extractWidgetApiParameters, extractWidgetParameters, generateRoomTimelineCapabilities, generateWidgetRegistrationUrl, getContent, getOriginalEventId, getRoomMemberDisplayName, hasActionPower, hasRoomEventPower, hasStateEventPower, hasWidgetParameters, isRoomEvent, isStateEvent, isValidCreateEventSchema, isValidEventWithRelatesTo, isValidPowerLevelStateEvent, isValidRedactionEvent, isValidRoomEvent, isValidRoomMemberStateEvent, isValidStateEvent as isValidStateEVent, isValidToDeviceMessageEvent, makeEventFromSendStateEventResult, navigateToRoom, observeRedactionEvents, parseWidgetId, redactEvent, repairWidgetRegistration, sendStateEventWithEventResult };
+export { ROOM_EVENT_REDACTION, ROOM_VERSION_12_CREATOR, STATE_EVENT_CREATE, STATE_EVENT_POWER_LEVELS, STATE_EVENT_ROOM_MEMBER, WIDGET_CAPABILITY_NAVIGATE, WidgetApiImpl, WidgetParameter, calculateUserPowerLevel, compareOriginServerTS, compareUserPowerLevelToNormalPowerLevel, extractRawWidgetParameters, extractWidgetApiParameters, extractWidgetParameters, generateRoomTimelineCapabilities, generateWidgetRegistrationUrl, getContent, getOriginalEventId, getRoomMemberDisplayName, hasActionPower, hasRoomEventPower, hasStateEventPower, hasWidgetParameters, isRoomEvent, isStateEvent, isValidCreateEventSchema, isValidEventWithRelatesTo, isValidPowerLevelStateEvent, isValidRedactionEvent, isValidRoomEvent, isValidRoomMemberStateEvent, isValidStateEvent as isValidStateEVent, isValidToDeviceMessageEvent, makeEventFromSendStateEventResult, navigateToRoom, observeRedactionEvents, parseWidgetId, redactEvent, repairWidgetRegistration, sendStateEventWithEventResult };

package/build/index.d.ts

@@ -47,6 +47,14 @@ export declare function calculateUserPowerLevel(powerLevelStateEvent: PowerLevel
  */
 export declare function compareOriginServerTS<T>(a: RoomEvent<T>, b: RoomEvent<T>): number;
 
+/**
+ * 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 declare function compareUserPowerLevelToNormalPowerLevel(userPowerLevel: UserPowerLevelType, normalPowerLevel: number): boolean;
+
 /**
  * Content of a room event that relates to another event.
  */
@@ -469,6 +477,7 @@ export declare type StateEventCreateContent = {
     room_version?: string;
     creator?: string;
     additional_creators?: string[];
+    type?: string;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "A simplified layer on top of matrix-widget-api to use build widgets.",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",