@matrix-widget-toolkit/api 1.0.2 → 3.0.0

package/build/cjs/index.js

@@ -606,8 +606,8 @@ function isValidEventWithRelatesTo(event) {
  * The name of the room member state event.
  */
 var STATE_EVENT_ROOM_MEMBER = 'm.room.member';
-function isStringOrUndefined(value) {
-    return value === undefined || typeof value === 'string';
+function isStringUndefinedOrNull(value) {
+    return value === undefined || value === null || typeof value === 'string';
 }
 /**
  * Validates that `event` is has a valid structure for a
@@ -624,10 +624,12 @@ function isValidRoomMemberStateEvent(event) {
     if (typeof content.membership !== 'string') {
         return false;
     }
-    if (!isStringOrUndefined(content.displayname)) {
+    if (!isStringUndefinedOrNull(content.displayname)) {
         return false;
     }
-    if (!isStringOrUndefined(content.avatar_url)) {
+    // the avatar_url shouldn't be null, but some implementations
+    // set it as a valid value
+    if (!isStringUndefinedOrNull(content.avatar_url)) {
         return false;
     }
     return true;
@@ -1441,14 +1443,13 @@ var WidgetApiImpl = /** @class */ (function () {
     /** {@inheritDoc WidgetApi.readEventRelations} */
     WidgetApiImpl.prototype.readEventRelations = function (eventId, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, original_event, chunk, next_batch;
+            var _a, chunk, next_batch;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this.matrixWidgetApi.readEventRelations(eventId, options === null || options === void 0 ? void 0 : options.roomId, options === null || options === void 0 ? void 0 : options.relationType, options === null || options === void 0 ? void 0 : options.eventType, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.from)];
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.readEventRelations(eventId, options === null || options === void 0 ? void 0 : options.roomId, options === null || options === void 0 ? void 0 : options.relationType, options === null || options === void 0 ? void 0 : options.eventType, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.from, undefined, options === null || options === void 0 ? void 0 : options.direction)];
                     case 1:
-                        _a = _b.sent(), original_event = _a.original_event, chunk = _a.chunk, next_batch = _a.next_batch;
+                        _a = _b.sent(), chunk = _a.chunk, next_batch = _a.next_batch;
                         return [2 /*return*/, {
-                                originalEvent: original_event,
                                 chunk: chunk,
                                 nextToken: next_batch !== null && next_batch !== void 0 ? next_batch : undefined,
                             }];

package/build/esm/index.js

@@ -604,8 +604,8 @@ function isValidEventWithRelatesTo(event) {
  * The name of the room member state event.
  */
 var STATE_EVENT_ROOM_MEMBER = 'm.room.member';
-function isStringOrUndefined(value) {
-    return value === undefined || typeof value === 'string';
+function isStringUndefinedOrNull(value) {
+    return value === undefined || value === null || typeof value === 'string';
 }
 /**
  * Validates that `event` is has a valid structure for a
@@ -622,10 +622,12 @@ function isValidRoomMemberStateEvent(event) {
     if (typeof content.membership !== 'string') {
         return false;
     }
-    if (!isStringOrUndefined(content.displayname)) {
+    if (!isStringUndefinedOrNull(content.displayname)) {
         return false;
     }
-    if (!isStringOrUndefined(content.avatar_url)) {
+    // the avatar_url shouldn't be null, but some implementations
+    // set it as a valid value
+    if (!isStringUndefinedOrNull(content.avatar_url)) {
         return false;
     }
     return true;
@@ -1439,14 +1441,13 @@ var WidgetApiImpl = /** @class */ (function () {
     /** {@inheritDoc WidgetApi.readEventRelations} */
     WidgetApiImpl.prototype.readEventRelations = function (eventId, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, original_event, chunk, next_batch;
+            var _a, chunk, next_batch;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this.matrixWidgetApi.readEventRelations(eventId, options === null || options === void 0 ? void 0 : options.roomId, options === null || options === void 0 ? void 0 : options.relationType, options === null || options === void 0 ? void 0 : options.eventType, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.from)];
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.readEventRelations(eventId, options === null || options === void 0 ? void 0 : options.roomId, options === null || options === void 0 ? void 0 : options.relationType, options === null || options === void 0 ? void 0 : options.eventType, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.from, undefined, options === null || options === void 0 ? void 0 : options.direction)];
                     case 1:
-                        _a = _b.sent(), original_event = _a.original_event, chunk = _a.chunk, next_batch = _a.next_batch;
+                        _a = _b.sent(), chunk = _a.chunk, next_batch = _a.next_batch;
                         return [2 /*return*/, {
-                                originalEvent: original_event,
                                 chunk: chunk,
                                 nextToken: next_batch !== null && next_batch !== void 0 ? next_batch : undefined,
                             }];

package/build/index.d.ts

@@ -370,11 +370,11 @@ export declare type RoomMemberStateEventContent = {
     /**
      * The display name for this user, if any.
      */
-    displayname?: string;
+    displayname?: string | null;
     /**
      * The avatar URL for this user, if any.
      */
-    avatar_url?: string;
+    avatar_url?: string | null;
 };
 
 /**
@@ -571,15 +571,14 @@ export declare type WidgetApi = {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
     /**
-     * Receive an event with a given `eventId` and all events that relate to it by
-     * means of MSC2674. Both `originalEvent` and `chunk` can include state events
-     * or room events.
+     * Receive all events that relate to a given `eventId` by means of MSC2674.
+     * `chunk` can include state events or room events.
      *
      * @remarks You can only receive events where the capability to receive it was
-     *          approved. If `originalEvent` is not approved, an exception is thrown.
-     *          If an event in `chunk` is not approve, it is silently skipped. Note
-     *          that the call might return less than `limit` events due to various
-     *          reasons, including missing capabilities or encrypted events.
+     *          approved. If an event in `chunk` is not approved, it is silently
+     *          skipped. Note that the call might return less than `limit` events
+     *          due to various reasons, including missing capabilities or encrypted
+     *          events.
      *
      * @param eventId - The id of the event to receive
      * @param options - Options for receiving the related events.
@@ -590,6 +589,8 @@ export declare type WidgetApi = {
      *                  no further page exists.
      *                  Use `relationType` to only return events with that `rel_type`.
      *                  Use `eventType` to only return events with that `type`.
+     *                  Use `direction` to change time-order of the chunks
+     *                  (default: 'b').
      *
      * @throws if the capability to receive the type of event is missing.
      */
@@ -599,8 +600,8 @@ export declare type WidgetApi = {
         from?: string;
         relationType?: string;
         eventType?: string;
+        direction?: 'f' | 'b';
     }): Promise<{
-        originalEvent?: RoomEvent | StateEvent;
         chunk: Array<RoomEvent | StateEvent>;
         nextToken?: string;
     }>;
@@ -791,8 +792,8 @@ export declare class WidgetApiImpl implements WidgetApi {
         from?: string;
         relationType?: string;
         eventType?: string;
+        direction?: 'f' | 'b';
     }): Promise<{
-        originalEvent?: RoomEvent | StateEvent;
         chunk: Array<RoomEvent | StateEvent>;
         nextToken?: string;
     }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "1.0.2",
+  "version": "3.0.0",
   "description": "A simplified layer on top of matrix-widget-api to use build widgets.",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",
@@ -10,7 +10,7 @@
   "devDependencies": {
     "@craco/craco": "^6.4.5",
     "@types/jest": "^27.5.2",
-    "@types/node": "^16.18.4",
+    "@types/node": "^16.18.11",
     "@types/qs": "^6.9.7",
     "typescript": "^4.8.4"
   },
@@ -29,7 +29,7 @@
   "dependencies": {
     "matrix-widget-api": "^1.1.1",
     "qs": "^6.11.0",
-    "rxjs": "^7.5.7"
+    "rxjs": "^7.8.0"
   },
   "repository": {
     "type": "git",