Use MSC4407 as the unstable prefix for sticky event capabilities (#159)

* Use MSC4407 as the unstable prefix for sticky event capabilities

I realized that these capabilities would need their own MSC separate from the actual sticky event MSC, and Timo has kindly gone and drafted one. Changing these experimental identifiers while they're still hot off the press.

* Remove unused, unspecified widget action

Author: robintown

src/ClientWidgetApi.ts

@@ -607,9 +607,9 @@ export class ClientWidgetApi extends EventEmitter {
         }
 
         const isStickyEvent = request.data.sticky_duration_ms !== undefined;
-        if (isStickyEvent && !this.hasCapability(MatrixCapabilities.MSC4354SendStickyEvent)) {
+        if (isStickyEvent && !this.hasCapability(MatrixCapabilities.MSC4407SendStickyEvent)) {
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                error: { message: `Missing capability for ${MatrixCapabilities.MSC4354SendStickyEvent}` },
+                error: { message: `Missing capability for ${MatrixCapabilities.MSC4407SendStickyEvent}` },
             });
         }
 

src/driver/WidgetDriver.ts

@@ -110,7 +110,7 @@ export abstract class WidgetDriver {
     }
 
     /**
-     * @experimental Part of MSC4354
+     * @experimental Part of MSC4407
      * Sends a sticky event into a room. If `roomId` is falsy, the client should send the event
      * into the room the user is currently looking at. The widget API will have already
      * verified that the widget is capable of sending the event to that room.
@@ -163,7 +163,7 @@ export abstract class WidgetDriver {
     }
 
     /**
-     * @experimental Part of MSC4140, MSC4157 and MSC4354
+     * @experimental Part of MSC4140, MSC4157 and MSC4407
      * Sends a delayed sticky event into a room. If `roomId` is falsy, the client should send the event
      * into the room the user is currently looking at. The widget API will have already
      * verified that the widget is capable of sending the event to that room.

src/interfaces/Capabilities.ts

@@ -56,11 +56,11 @@ export enum MatrixCapabilities {
     /**
      * @experimental It is not recommended to rely on this existing - it can be removed without notice.
      */
-    MSC4354SendStickyEvent = "org.matrix.msc4354.send_sticky_event",
+    MSC4407SendStickyEvent = "org.matrix.msc4407.send.sticky_event",
     /**
      * @experimental It is not recommended to rely on this existing - it can be removed without notice.
      */
-    MSC4354ReceiveStickyEvent = "org.matrix.msc4354.receive_sticky_event",
+    MSC4407ReceiveStickyEvent = "org.matrix.msc4407.receive.sticky_event",
 }
 
 export type Capability = MatrixCapabilities | string;

src/interfaces/SendEventAction.ts

@@ -29,7 +29,7 @@ export interface ISendEventFromWidgetRequestData extends IWidgetApiRequestData {
     delay?: number; // eslint-disable-line camelcase
     parent_delay_id?: string; // eslint-disable-line camelcase
 
-    // MSC4354SendStickyEvent
+    // MSC4407
     sticky_duration_ms?: number;
 }
 

src/interfaces/WidgetApiAction.ts

@@ -92,11 +92,6 @@ export enum WidgetApiFromWidgetAction {
      * @experimental It is not recommended to rely on this existing - it can be removed without notice.
      */
     MSC4157UpdateDelayedEvent = "org.matrix.msc4157.update_delayed_event",
-
-    /**
-     * @experimental It is not recommended to rely on this existing - it can be removed without notice.
-     */
-    MSC4354SendStickyEvent = "org.matrix.msc4354.send_sticky_event",
 }
 
 export type WidgetApiAction = WidgetApiToWidgetAction | WidgetApiFromWidgetAction | string;

test/ClientWidgetApi-test.ts

@@ -771,7 +771,7 @@ describe("ClientWidgetApi", () => {
             await loadIframe([
                 `org.matrix.msc2762.timeline:${event.data.room_id}`,
                 `org.matrix.msc2762.send.event:${event.data.type}`,
-                MatrixCapabilities.MSC4354SendStickyEvent,
+                MatrixCapabilities.MSC4407SendStickyEvent,
             ]);
 
             emitEvent(new CustomEvent("", { detail: event }));
@@ -822,7 +822,7 @@ describe("ClientWidgetApi", () => {
                     `org.matrix.msc2762.timeline:${event.data.room_id}`,
                     `org.matrix.msc2762.send.event:${event.data.type}`,
                     MatrixCapabilities.MSC4157SendDelayedEvent,
-                    MatrixCapabilities.MSC4354SendStickyEvent,
+                    MatrixCapabilities.MSC4407SendStickyEvent,
                 ]);
 
                 emitEvent(new CustomEvent("", { detail: event }));
@@ -871,7 +871,7 @@ describe("ClientWidgetApi", () => {
             await loadIframe([
                 `org.matrix.msc2762.timeline:${event.data.room_id}`,
                 `org.matrix.msc2762.send.state_event:${event.data.type}`,
-                MatrixCapabilities.MSC4354SendStickyEvent,
+                MatrixCapabilities.MSC4407SendStickyEvent,
             ]);
 
             emitEvent(new CustomEvent("", { detail: event }));