@wireapp/protocol-messaging 1.49.0 → 1.50.0

package/package.json

@@ -27,5 +27,5 @@
     "preversion": "git checkout master && git pull && yarn && yarn dist && yarn test",
     "test": "tsc --noEmit"
   },
-  "version": "1.49.0"
+  "version": "1.50.0"
 }

package/proto/messages.proto

@@ -47,6 +47,16 @@ message GenericMessage {
     ButtonActionConfirmation buttonActionConfirmation = 22;
     DataTransfer dataTransfer = 23; // client-side synchronization across devices of the same user
     InCallEmoji inCallEmoji = 24;
+    // UnknownStrategy unknownStrategy = 25; -- Defined outside the oneof
+    // Next field should be 26 ↓
+  }
+  optional UnknownStrategy unknownStrategy = 25 [default = IGNORE];
+
+  // See internal RFC: "2024-07-18 RFC Improve future-proofing for new OTR message types"
+  enum UnknownStrategy {
+    IGNORE = 0;                 // Ignore the message completely. Trash. Bye
+    DISCARD_AND_WARN = 1;       // Warn the user, but discard the message, as it won't be helpful in the future.
+    WARN_USER_ALLOW_RETRY = 2;  // Warn the user. Client has freedom to store it and retry in the future.
   }
 }
 

package/web/messages.d.ts

@@ -24,6 +24,7 @@ export interface IGenericMessage {
     buttonActionConfirmation?: (IButtonActionConfirmation|null);
     dataTransfer?: (IDataTransfer|null);
     inCallEmoji?: (IInCallEmoji|null);
+    unknownStrategy?: (GenericMessage.UnknownStrategy|null);
 }
 
 export class GenericMessage implements IGenericMessage {
@@ -51,6 +52,7 @@ export class GenericMessage implements IGenericMessage {
     public buttonActionConfirmation?: (IButtonActionConfirmation|null);
     public dataTransfer?: (IDataTransfer|null);
     public inCallEmoji?: (IInCallEmoji|null);
+    public unknownStrategy: GenericMessage.UnknownStrategy;
     public content?: ("text"|"image"|"knock"|"lastRead"|"cleared"|"external"|"clientAction"|"calling"|"asset"|"hidden"|"location"|"deleted"|"edited"|"confirmation"|"reaction"|"ephemeral"|"availability"|"composite"|"buttonAction"|"buttonActionConfirmation"|"dataTransfer"|"inCallEmoji");
     public static create(properties?: IGenericMessage): GenericMessage;
     public static encode(message: IGenericMessage, writer?: $protobuf.Writer): $protobuf.Writer;
@@ -64,6 +66,15 @@ export class GenericMessage implements IGenericMessage {
     public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
+export namespace GenericMessage {
+
+    enum UnknownStrategy {
+        IGNORE = 0,
+        DISCARD_AND_WARN = 1,
+        WARN_USER_ALLOW_RETRY = 2
+    }
+}
+
 export interface IQualifiedUserId {
     id: string;
     domain: string;

package/web/messages.js

@@ -38,6 +38,7 @@ $root.GenericMessage = (function() {
      * @property {IButtonActionConfirmation|null} [buttonActionConfirmation] GenericMessage buttonActionConfirmation
      * @property {IDataTransfer|null} [dataTransfer] GenericMessage dataTransfer
      * @property {IInCallEmoji|null} [inCallEmoji] GenericMessage inCallEmoji
+     * @property {GenericMessage.UnknownStrategy|null} [unknownStrategy] GenericMessage unknownStrategy
      */
 
     /**
@@ -239,6 +240,14 @@ $root.GenericMessage = (function() {
      */
     GenericMessage.prototype.inCallEmoji = null;
 
+    /**
+     * GenericMessage unknownStrategy.
+     * @member {GenericMessage.UnknownStrategy} unknownStrategy
+     * @memberof GenericMessage
+     * @instance
+     */
+    GenericMessage.prototype.unknownStrategy = 0;
+
     // OneOf field names bound to virtual getters and setters
     var $oneOfFields;
 
@@ -322,6 +331,8 @@ $root.GenericMessage = (function() {
             $root.DataTransfer.encode(message.dataTransfer, writer.uint32(/* id 23, wireType 2 =*/186).fork()).ldelim();
         if (message.inCallEmoji != null && Object.hasOwnProperty.call(message, "inCallEmoji"))
             $root.InCallEmoji.encode(message.inCallEmoji, writer.uint32(/* id 24, wireType 2 =*/194).fork()).ldelim();
+        if (message.unknownStrategy != null && Object.hasOwnProperty.call(message, "unknownStrategy"))
+            writer.uint32(/* id 25, wireType 0 =*/200).int32(message.unknownStrategy);
         return writer;
     };
 
@@ -448,6 +459,10 @@ $root.GenericMessage = (function() {
                     message.inCallEmoji = $root.InCallEmoji.decode(reader, reader.uint32());
                     break;
                 }
+            case 25: {
+                    message.unknownStrategy = reader.int32();
+                    break;
+                }
             default:
                 reader.skipType(tag & 7);
                 break;
@@ -707,6 +722,15 @@ $root.GenericMessage = (function() {
                     return "inCallEmoji." + error;
             }
         }
+        if (message.unknownStrategy != null && message.hasOwnProperty("unknownStrategy"))
+            switch (message.unknownStrategy) {
+            default:
+                return "unknownStrategy: enum value expected";
+            case 0:
+            case 1:
+            case 2:
+                break;
+            }
         return null;
     };
 
@@ -841,6 +865,26 @@ $root.GenericMessage = (function() {
                 throw TypeError(".GenericMessage.inCallEmoji: object expected");
             message.inCallEmoji = $root.InCallEmoji.fromObject(object.inCallEmoji);
         }
+        switch (object.unknownStrategy) {
+        default:
+            if (typeof object.unknownStrategy === "number") {
+                message.unknownStrategy = object.unknownStrategy;
+                break;
+            }
+            break;
+        case "IGNORE":
+        case 0:
+            message.unknownStrategy = 0;
+            break;
+        case "DISCARD_AND_WARN":
+        case 1:
+            message.unknownStrategy = 1;
+            break;
+        case "WARN_USER_ALLOW_RETRY":
+        case 2:
+            message.unknownStrategy = 2;
+            break;
+        }
         return message;
     };
 
@@ -857,8 +901,10 @@ $root.GenericMessage = (function() {
         if (!options)
             options = {};
         var object = {};
-        if (options.defaults)
+        if (options.defaults) {
             object.messageId = "";
+            object.unknownStrategy = options.enums === String ? "IGNORE" : 0;
+        }
         if (message.messageId != null && message.hasOwnProperty("messageId"))
             object.messageId = message.messageId;
         if (message.text != null && message.hasOwnProperty("text")) {
@@ -971,6 +1017,8 @@ $root.GenericMessage = (function() {
             if (options.oneofs)
                 object.content = "inCallEmoji";
         }
+        if (message.unknownStrategy != null && message.hasOwnProperty("unknownStrategy"))
+            object.unknownStrategy = options.enums === String ? $root.GenericMessage.UnknownStrategy[message.unknownStrategy] === undefined ? message.unknownStrategy : $root.GenericMessage.UnknownStrategy[message.unknownStrategy] : message.unknownStrategy;
         return object;
     };
 
@@ -1000,6 +1048,22 @@ $root.GenericMessage = (function() {
         return typeUrlPrefix + "/GenericMessage";
     };
 
+    /**
+     * UnknownStrategy enum.
+     * @name GenericMessage.UnknownStrategy
+     * @enum {number}
+     * @property {number} IGNORE=0 IGNORE value
+     * @property {number} DISCARD_AND_WARN=1 DISCARD_AND_WARN value
+     * @property {number} WARN_USER_ALLOW_RETRY=2 WARN_USER_ALLOW_RETRY value
+     */
+    GenericMessage.UnknownStrategy = (function() {
+        var valuesById = {}, values = Object.create(valuesById);
+        values[valuesById[0] = "IGNORE"] = 0;
+        values[valuesById[1] = "DISCARD_AND_WARN"] = 1;
+        values[valuesById[2] = "WARN_USER_ALLOW_RETRY"] = 2;
+        return values;
+    })();
+
     return GenericMessage;
 })();