@wireapp/protocol-messaging 1.49.0 → 1.51.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.51.0"
 }

package/proto/messages.proto

@@ -47,6 +47,17 @@ 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 ↓
+    InCallHandRaise inCallHandRaise = 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.
   }
 }
 
@@ -336,6 +347,10 @@ message InCallEmoji {
   map<string, int32> emojis = 1;
 }
 
+message InCallHandRaise {
+  required bool is_hand_up = 1; // true if the hand is raised, false if lowered
+}
+
 message Calling {
   required string content = 1;
   optional QualifiedConversationId qualified_conversation_id = 2;

package/web/messages.d.ts

@@ -24,6 +24,8 @@ export interface IGenericMessage {
     buttonActionConfirmation?: (IButtonActionConfirmation|null);
     dataTransfer?: (IDataTransfer|null);
     inCallEmoji?: (IInCallEmoji|null);
+    inCallHandRaise?: (IInCallHandRaise|null);
+    unknownStrategy?: (GenericMessage.UnknownStrategy|null);
 }
 
 export class GenericMessage implements IGenericMessage {
@@ -51,7 +53,9 @@ export class GenericMessage implements IGenericMessage {
     public buttonActionConfirmation?: (IButtonActionConfirmation|null);
     public dataTransfer?: (IDataTransfer|null);
     public inCallEmoji?: (IInCallEmoji|null);
-    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 inCallHandRaise?: (IInCallHandRaise|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"|"inCallHandRaise");
     public static create(properties?: IGenericMessage): GenericMessage;
     public static encode(message: IGenericMessage, writer?: $protobuf.Writer): $protobuf.Writer;
     public static encodeDelimited(message: IGenericMessage, writer?: $protobuf.Writer): $protobuf.Writer;
@@ -64,6 +68,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;
@@ -926,6 +939,25 @@ export class InCallEmoji implements IInCallEmoji {
     public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
+export interface IInCallHandRaise {
+    isHandUp: boolean;
+}
+
+export class InCallHandRaise implements IInCallHandRaise {
+    constructor(properties?: IInCallHandRaise);
+    public isHandUp: boolean;
+    public static create(properties?: IInCallHandRaise): InCallHandRaise;
+    public static encode(message: IInCallHandRaise, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IInCallHandRaise, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): InCallHandRaise;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): InCallHandRaise;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): InCallHandRaise;
+    public static toObject(message: InCallHandRaise, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
 export interface ICalling {
     content: string;
     qualifiedConversationId?: (IQualifiedConversationId|null);

package/web/messages.js

@@ -38,6 +38,8 @@ $root.GenericMessage = (function() {
      * @property {IButtonActionConfirmation|null} [buttonActionConfirmation] GenericMessage buttonActionConfirmation
      * @property {IDataTransfer|null} [dataTransfer] GenericMessage dataTransfer
      * @property {IInCallEmoji|null} [inCallEmoji] GenericMessage inCallEmoji
+     * @property {IInCallHandRaise|null} [inCallHandRaise] GenericMessage inCallHandRaise
+     * @property {GenericMessage.UnknownStrategy|null} [unknownStrategy] GenericMessage unknownStrategy
      */
 
     /**
@@ -239,17 +241,33 @@ $root.GenericMessage = (function() {
      */
     GenericMessage.prototype.inCallEmoji = null;
 
+    /**
+     * GenericMessage inCallHandRaise.
+     * @member {IInCallHandRaise|null|undefined} inCallHandRaise
+     * @memberof GenericMessage
+     * @instance
+     */
+    GenericMessage.prototype.inCallHandRaise = 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;
 
     /**
      * GenericMessage content.
-     * @member {"text"|"image"|"knock"|"lastRead"|"cleared"|"external"|"clientAction"|"calling"|"asset"|"hidden"|"location"|"deleted"|"edited"|"confirmation"|"reaction"|"ephemeral"|"availability"|"composite"|"buttonAction"|"buttonActionConfirmation"|"dataTransfer"|"inCallEmoji"|undefined} content
+     * @member {"text"|"image"|"knock"|"lastRead"|"cleared"|"external"|"clientAction"|"calling"|"asset"|"hidden"|"location"|"deleted"|"edited"|"confirmation"|"reaction"|"ephemeral"|"availability"|"composite"|"buttonAction"|"buttonActionConfirmation"|"dataTransfer"|"inCallEmoji"|"inCallHandRaise"|undefined} content
      * @memberof GenericMessage
      * @instance
      */
     Object.defineProperty(GenericMessage.prototype, "content", {
-        get: $util.oneOfGetter($oneOfFields = ["text", "image", "knock", "lastRead", "cleared", "external", "clientAction", "calling", "asset", "hidden", "location", "deleted", "edited", "confirmation", "reaction", "ephemeral", "availability", "composite", "buttonAction", "buttonActionConfirmation", "dataTransfer", "inCallEmoji"]),
+        get: $util.oneOfGetter($oneOfFields = ["text", "image", "knock", "lastRead", "cleared", "external", "clientAction", "calling", "asset", "hidden", "location", "deleted", "edited", "confirmation", "reaction", "ephemeral", "availability", "composite", "buttonAction", "buttonActionConfirmation", "dataTransfer", "inCallEmoji", "inCallHandRaise"]),
         set: $util.oneOfSetter($oneOfFields)
     });
 
@@ -322,6 +340,10 @@ $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);
+        if (message.inCallHandRaise != null && Object.hasOwnProperty.call(message, "inCallHandRaise"))
+            $root.InCallHandRaise.encode(message.inCallHandRaise, writer.uint32(/* id 26, wireType 2 =*/210).fork()).ldelim();
         return writer;
     };
 
@@ -448,6 +470,14 @@ $root.GenericMessage = (function() {
                     message.inCallEmoji = $root.InCallEmoji.decode(reader, reader.uint32());
                     break;
                 }
+            case 26: {
+                    message.inCallHandRaise = $root.InCallHandRaise.decode(reader, reader.uint32());
+                    break;
+                }
+            case 25: {
+                    message.unknownStrategy = reader.int32();
+                    break;
+                }
             default:
                 reader.skipType(tag & 7);
                 break;
@@ -707,6 +737,25 @@ $root.GenericMessage = (function() {
                     return "inCallEmoji." + error;
             }
         }
+        if (message.inCallHandRaise != null && message.hasOwnProperty("inCallHandRaise")) {
+            if (properties.content === 1)
+                return "content: multiple values";
+            properties.content = 1;
+            {
+                var error = $root.InCallHandRaise.verify(message.inCallHandRaise);
+                if (error)
+                    return "inCallHandRaise." + 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 +890,31 @@ $root.GenericMessage = (function() {
                 throw TypeError(".GenericMessage.inCallEmoji: object expected");
             message.inCallEmoji = $root.InCallEmoji.fromObject(object.inCallEmoji);
         }
+        if (object.inCallHandRaise != null) {
+            if (typeof object.inCallHandRaise !== "object")
+                throw TypeError(".GenericMessage.inCallHandRaise: object expected");
+            message.inCallHandRaise = $root.InCallHandRaise.fromObject(object.inCallHandRaise);
+        }
+        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 +931,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 +1047,13 @@ $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;
+        if (message.inCallHandRaise != null && message.hasOwnProperty("inCallHandRaise")) {
+            object.inCallHandRaise = $root.InCallHandRaise.toObject(message.inCallHandRaise, options);
+            if (options.oneofs)
+                object.content = "inCallHandRaise";
+        }
         return object;
     };
 
@@ -1000,6 +1083,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;
 })();
 
@@ -10947,6 +11046,209 @@ $root.InCallEmoji = (function() {
     return InCallEmoji;
 })();
 
+$root.InCallHandRaise = (function() {
+
+    /**
+     * Properties of an InCallHandRaise.
+     * @exports IInCallHandRaise
+     * @interface IInCallHandRaise
+     * @property {boolean} isHandUp InCallHandRaise isHandUp
+     */
+
+    /**
+     * Constructs a new InCallHandRaise.
+     * @exports InCallHandRaise
+     * @classdesc Represents an InCallHandRaise.
+     * @implements IInCallHandRaise
+     * @constructor
+     * @param {IInCallHandRaise=} [properties] Properties to set
+     */
+    function InCallHandRaise(properties) {
+        if (properties)
+            for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                if (properties[keys[i]] != null)
+                    this[keys[i]] = properties[keys[i]];
+    }
+
+    /**
+     * InCallHandRaise isHandUp.
+     * @member {boolean} isHandUp
+     * @memberof InCallHandRaise
+     * @instance
+     */
+    InCallHandRaise.prototype.isHandUp = false;
+
+    /**
+     * Creates a new InCallHandRaise instance using the specified properties.
+     * @function create
+     * @memberof InCallHandRaise
+     * @static
+     * @param {IInCallHandRaise=} [properties] Properties to set
+     * @returns {InCallHandRaise} InCallHandRaise instance
+     */
+    InCallHandRaise.create = function create(properties) {
+        return new InCallHandRaise(properties);
+    };
+
+    /**
+     * Encodes the specified InCallHandRaise message. Does not implicitly {@link InCallHandRaise.verify|verify} messages.
+     * @function encode
+     * @memberof InCallHandRaise
+     * @static
+     * @param {IInCallHandRaise} message InCallHandRaise message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    InCallHandRaise.encode = function encode(message, writer) {
+        if (!writer)
+            writer = $Writer.create();
+        writer.uint32(/* id 1, wireType 0 =*/8).bool(message.isHandUp);
+        return writer;
+    };
+
+    /**
+     * Encodes the specified InCallHandRaise message, length delimited. Does not implicitly {@link InCallHandRaise.verify|verify} messages.
+     * @function encodeDelimited
+     * @memberof InCallHandRaise
+     * @static
+     * @param {IInCallHandRaise} message InCallHandRaise message or plain object to encode
+     * @param {$protobuf.Writer} [writer] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    InCallHandRaise.encodeDelimited = function encodeDelimited(message, writer) {
+        return this.encode(message, writer).ldelim();
+    };
+
+    /**
+     * Decodes an InCallHandRaise message from the specified reader or buffer.
+     * @function decode
+     * @memberof InCallHandRaise
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @param {number} [length] Message length if known beforehand
+     * @returns {InCallHandRaise} InCallHandRaise
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    InCallHandRaise.decode = function decode(reader, length) {
+        if (!(reader instanceof $Reader))
+            reader = $Reader.create(reader);
+        var end = length === undefined ? reader.len : reader.pos + length, message = new $root.InCallHandRaise();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+            case 1: {
+                    message.isHandUp = reader.bool();
+                    break;
+                }
+            default:
+                reader.skipType(tag & 7);
+                break;
+            }
+        }
+        if (!message.hasOwnProperty("isHandUp"))
+            throw $util.ProtocolError("missing required 'isHandUp'", { instance: message });
+        return message;
+    };
+
+    /**
+     * Decodes an InCallHandRaise message from the specified reader or buffer, length delimited.
+     * @function decodeDelimited
+     * @memberof InCallHandRaise
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+     * @returns {InCallHandRaise} InCallHandRaise
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    InCallHandRaise.decodeDelimited = function decodeDelimited(reader) {
+        if (!(reader instanceof $Reader))
+            reader = new $Reader(reader);
+        return this.decode(reader, reader.uint32());
+    };
+
+    /**
+     * Verifies an InCallHandRaise message.
+     * @function verify
+     * @memberof InCallHandRaise
+     * @static
+     * @param {Object.<string,*>} message Plain object to verify
+     * @returns {string|null} `null` if valid, otherwise the reason why it is not
+     */
+    InCallHandRaise.verify = function verify(message) {
+        if (typeof message !== "object" || message === null)
+            return "object expected";
+        if (typeof message.isHandUp !== "boolean")
+            return "isHandUp: boolean expected";
+        return null;
+    };
+
+    /**
+     * Creates an InCallHandRaise message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof InCallHandRaise
+     * @static
+     * @param {Object.<string,*>} object Plain object
+     * @returns {InCallHandRaise} InCallHandRaise
+     */
+    InCallHandRaise.fromObject = function fromObject(object) {
+        if (object instanceof $root.InCallHandRaise)
+            return object;
+        var message = new $root.InCallHandRaise();
+        if (object.isHandUp != null)
+            message.isHandUp = Boolean(object.isHandUp);
+        return message;
+    };
+
+    /**
+     * Creates a plain object from an InCallHandRaise message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof InCallHandRaise
+     * @static
+     * @param {InCallHandRaise} message InCallHandRaise
+     * @param {$protobuf.IConversionOptions} [options] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    InCallHandRaise.toObject = function toObject(message, options) {
+        if (!options)
+            options = {};
+        var object = {};
+        if (options.defaults)
+            object.isHandUp = false;
+        if (message.isHandUp != null && message.hasOwnProperty("isHandUp"))
+            object.isHandUp = message.isHandUp;
+        return object;
+    };
+
+    /**
+     * Converts this InCallHandRaise to JSON.
+     * @function toJSON
+     * @memberof InCallHandRaise
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    InCallHandRaise.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    /**
+     * Gets the default type url for InCallHandRaise
+     * @function getTypeUrl
+     * @memberof InCallHandRaise
+     * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+     * @returns {string} The default type url
+     */
+    InCallHandRaise.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/InCallHandRaise";
+    };
+
+    return InCallHandRaise;
+})();
+
 $root.Calling = (function() {
 
     /**