@wireapp/protocol-messaging 1.55.0 → 1.57.0

package/README.md

@@ -49,7 +49,7 @@ Message sent to recall previously sent message, can be only sent by original aut
 
 ### MessageEdit
 If the content of a previously sent message should be edited, a generic message of type `MessageEdit` has to be sent.
-It should reference the new content (for now only type `Text` can be edited) as well as the nonce of the message it is replacing. If an edit message is received which is referencing a non existent nonce it should be discarded.
+It should reference the new content (for now only type `Text` and `Multipart` can be edited) as well as the nonce of the message it is replacing. If an edit message is received which is referencing a non existent nonce it should be discarded.
 
 ### Confirmation
 If the reception of a previously sent message should be confirmed, a generic message of type `Confirmation` has to be sent. It should reference the message to be confirmed. Currently the confirmation comes in two flavours: `Read` and `Delivered`.

package/package.json

@@ -23,10 +23,8 @@
   },
   "scripts": {
     "dist": "node web/compile.js",
-    "postversion": "git push origin master --tags && npm publish",
-    "preversion": "git checkout master && git pull && yarn && yarn dist && yarn test",
     "test": "tsc --noEmit"
   },
-  "version": "1.55.0",
+  "version": "1.57.0",
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/proto/messages.proto

@@ -34,7 +34,6 @@ message GenericMessage {
     ClientAction clientAction = 9;
     Calling calling = 10;
     Asset asset = 11;
-    Multipart multipart = 27;
     MessageHide hidden = 12;
     Location location = 13;
     MessageDelete deleted = 14;
@@ -51,6 +50,12 @@ message GenericMessage {
     // UnknownStrategy unknownStrategy = 25; -- Defined outside the oneof
     // Next field should be 26 ↓
     InCallHandRaise inCallHandRaise = 26;
+    Multipart multipart = 27;
+    HistoryClientAvailable historyClientAvailable = 28;
+    HistoryClientRequest historyClientRequest = 29;
+    HistoryClientResponse historyClientResponse = 30;
+    Poll poll = 31;
+    PollVote pollVote = 32;
   }
   optional UnknownStrategy unknownStrategy = 25 [default = IGNORE];
 
@@ -100,6 +105,29 @@ message ButtonActionConfirmation {
   optional string button_id = 2; // if not present, no button is accepted
 }
 
+// A native poll. The GenericMessage id is the poll id. Votes are never anonymous:
+// every client sees the sender of each encrypted PollVote.
+message Poll {
+  required string question = 1;
+  repeated PollOption options = 2;
+  optional bool allow_multiple_answers = 3 [default = false];
+  // Standard flags for all message types
+  optional bool expects_read_confirmation = 4 [default = false];
+  optional LegalHoldStatus legal_hold_status = 5 [default = UNKNOWN];
+}
+
+message PollOption {
+  required string id = 1;
+  required string text = 2;
+}
+
+// The sender's complete current selection for a poll. It replaces any earlier vote from the
+// same user. An empty selection retracts the vote.
+message PollVote {
+  required string reference_message_id = 1;
+  repeated string selected_option_ids = 2;
+}
+
 message Availability {
   enum Type {
     NONE = 0;
@@ -180,6 +208,9 @@ message Mention {
   }
   // only optional to maintain backwards compatibility.
   optional QualifiedUserId qualified_user_id = 4;
+  // Explicit group-wide mention. Send without user_id or qualified_user_id.
+  // Older clients ignore this field and continue to display the literal text.
+  optional bool everyone = 5;
 }
 
 message LastRead {
@@ -198,6 +229,7 @@ message Cleared {
   required int64 cleared_timestamp = 2;
   // only optional to maintain backwards compatibility
   optional QualifiedConversationId qualified_conversation_id = 3;
+  optional bool needToRemoveLocally = 4 [default = false];
 }
 
 message MessageHide {
@@ -218,6 +250,8 @@ message MessageEdit {
   oneof content {
     Text text = 2;
     Composite composite = 3;
+    Multipart multipart = 4;
+    // Reply can also be edited, but the edit will only affect the Text part
   }
 }
 
@@ -421,6 +455,25 @@ message TrackingIdentifier {
   required string identifier = 1;
 }
 
+message HistoryClient {
+  required string client_id = 1;
+  required string created_at = 2;
+  required bytes secret = 3;
+}
+
+// Sent in a conversation after new history client has been added
+message HistoryClientAvailable {
+  required HistoryClient client = 1;
+}
+
+// Sent in a conversation after you've been added to conversation with history sharing enabled
+message HistoryClientRequest {}
+
+// Sent in a subconversation in response to a HistoryClientRequest
+message HistoryClientResponse {
+  repeated HistoryClient clients = 1;
+}
+
 // Enums have to come last because of an unresolved issue with jsdoc
 // https://github.com/jsdoc/jsdoc/pull/1686
 

package/web/messages.d.ts

@@ -11,7 +11,6 @@ export interface IGenericMessage {
     clientAction?: (ClientAction|null);
     calling?: (ICalling|null);
     asset?: (IAsset|null);
-    multipart?: (IMultipart|null);
     hidden?: (IMessageHide|null);
     location?: (ILocation|null);
     deleted?: (IMessageDelete|null);
@@ -26,6 +25,12 @@ export interface IGenericMessage {
     dataTransfer?: (IDataTransfer|null);
     inCallEmoji?: (IInCallEmoji|null);
     inCallHandRaise?: (IInCallHandRaise|null);
+    multipart?: (IMultipart|null);
+    historyClientAvailable?: (IHistoryClientAvailable|null);
+    historyClientRequest?: (IHistoryClientRequest|null);
+    historyClientResponse?: (IHistoryClientResponse|null);
+    poll?: (IPoll|null);
+    pollVote?: (IPollVote|null);
     unknownStrategy?: (GenericMessage.UnknownStrategy|null);
 }
 
@@ -41,7 +46,6 @@ export class GenericMessage implements IGenericMessage {
     public clientAction?: (ClientAction|null);
     public calling?: (ICalling|null);
     public asset?: (IAsset|null);
-    public multipart?: (IMultipart|null);
     public hidden?: (IMessageHide|null);
     public location?: (ILocation|null);
     public deleted?: (IMessageDelete|null);
@@ -56,8 +60,14 @@ export class GenericMessage implements IGenericMessage {
     public dataTransfer?: (IDataTransfer|null);
     public inCallEmoji?: (IInCallEmoji|null);
     public inCallHandRaise?: (IInCallHandRaise|null);
+    public multipart?: (IMultipart|null);
+    public historyClientAvailable?: (IHistoryClientAvailable|null);
+    public historyClientRequest?: (IHistoryClientRequest|null);
+    public historyClientResponse?: (IHistoryClientResponse|null);
+    public poll?: (IPoll|null);
+    public pollVote?: (IPollVote|null);
     public unknownStrategy: GenericMessage.UnknownStrategy;
-    public content?: ("text"|"image"|"knock"|"lastRead"|"cleared"|"external"|"clientAction"|"calling"|"asset"|"multipart"|"hidden"|"location"|"deleted"|"edited"|"confirmation"|"reaction"|"ephemeral"|"availability"|"composite"|"buttonAction"|"buttonActionConfirmation"|"dataTransfer"|"inCallEmoji"|"inCallHandRaise");
+    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"|"multipart"|"historyClientAvailable"|"historyClientRequest"|"historyClientResponse"|"poll"|"pollVote");
     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;
@@ -232,6 +242,75 @@ export class ButtonActionConfirmation implements IButtonActionConfirmation {
     public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
+export interface IPoll {
+    question: string;
+    options?: (IPollOption[]|null);
+    allowMultipleAnswers?: (boolean|null);
+    expectsReadConfirmation?: (boolean|null);
+    legalHoldStatus?: (LegalHoldStatus|null);
+}
+
+export class Poll implements IPoll {
+    constructor(properties?: IPoll);
+    public question: string;
+    public options: IPollOption[];
+    public allowMultipleAnswers: boolean;
+    public expectsReadConfirmation: boolean;
+    public legalHoldStatus: LegalHoldStatus;
+    public static create(properties?: IPoll): Poll;
+    public static encode(message: IPoll, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IPoll, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): Poll;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): Poll;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): Poll;
+    public static toObject(message: Poll, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
+export interface IPollOption {
+    id: string;
+    text: string;
+}
+
+export class PollOption implements IPollOption {
+    constructor(properties?: IPollOption);
+    public id: string;
+    public text: string;
+    public static create(properties?: IPollOption): PollOption;
+    public static encode(message: IPollOption, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IPollOption, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): PollOption;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): PollOption;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): PollOption;
+    public static toObject(message: PollOption, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
+export interface IPollVote {
+    referenceMessageId: string;
+    selectedOptionIds?: (string[]|null);
+}
+
+export class PollVote implements IPollVote {
+    constructor(properties?: IPollVote);
+    public referenceMessageId: string;
+    public selectedOptionIds: string[];
+    public static create(properties?: IPollVote): PollVote;
+    public static encode(message: IPollVote, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IPollVote, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): PollVote;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): PollVote;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): PollVote;
+    public static toObject(message: PollVote, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
 export interface IAvailability {
     type: Availability.Type;
 }
@@ -429,6 +508,7 @@ export interface IMention {
     length: number;
     userId?: (string|null);
     qualifiedUserId?: (IQualifiedUserId|null);
+    everyone?: (boolean|null);
 }
 
 export class Mention implements IMention {
@@ -437,6 +517,7 @@ export class Mention implements IMention {
     public length: number;
     public userId?: (string|null);
     public qualifiedUserId?: (IQualifiedUserId|null);
+    public everyone: boolean;
     public mentionType?: "userId";
     public static create(properties?: IMention): Mention;
     public static encode(message: IMention, writer?: $protobuf.Writer): $protobuf.Writer;
@@ -477,6 +558,7 @@ export interface ICleared {
     conversationId: string;
     clearedTimestamp: (number|Long);
     qualifiedConversationId?: (IQualifiedConversationId|null);
+    needToRemoveLocally?: (boolean|null);
 }
 
 export class Cleared implements ICleared {
@@ -484,6 +566,7 @@ export class Cleared implements ICleared {
     public conversationId: string;
     public clearedTimestamp: (number|Long);
     public qualifiedConversationId?: (IQualifiedConversationId|null);
+    public needToRemoveLocally: boolean;
     public static create(properties?: ICleared): Cleared;
     public static encode(message: ICleared, writer?: $protobuf.Writer): $protobuf.Writer;
     public static encodeDelimited(message: ICleared, writer?: $protobuf.Writer): $protobuf.Writer;
@@ -542,6 +625,7 @@ export interface IMessageEdit {
     replacingMessageId: string;
     text?: (IText|null);
     composite?: (IComposite|null);
+    multipart?: (IMultipart|null);
 }
 
 export class MessageEdit implements IMessageEdit {
@@ -549,7 +633,8 @@ export class MessageEdit implements IMessageEdit {
     public replacingMessageId: string;
     public text?: (IText|null);
     public composite?: (IComposite|null);
-    public content?: ("text"|"composite");
+    public multipart?: (IMultipart|null);
+    public content?: ("text"|"composite"|"multipart");
     public static create(properties?: IMessageEdit): MessageEdit;
     public static encode(message: IMessageEdit, writer?: $protobuf.Writer): $protobuf.Writer;
     public static encodeDelimited(message: IMessageEdit, writer?: $protobuf.Writer): $protobuf.Writer;
@@ -1166,6 +1251,84 @@ export class TrackingIdentifier implements ITrackingIdentifier {
     public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
+export interface IHistoryClient {
+    clientId: string;
+    createdAt: string;
+    secret: Uint8Array;
+}
+
+export class HistoryClient implements IHistoryClient {
+    constructor(properties?: IHistoryClient);
+    public clientId: string;
+    public createdAt: string;
+    public secret: Uint8Array;
+    public static create(properties?: IHistoryClient): HistoryClient;
+    public static encode(message: IHistoryClient, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IHistoryClient, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): HistoryClient;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): HistoryClient;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): HistoryClient;
+    public static toObject(message: HistoryClient, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
+export interface IHistoryClientAvailable {
+    client: IHistoryClient;
+}
+
+export class HistoryClientAvailable implements IHistoryClientAvailable {
+    constructor(properties?: IHistoryClientAvailable);
+    public client: IHistoryClient;
+    public static create(properties?: IHistoryClientAvailable): HistoryClientAvailable;
+    public static encode(message: IHistoryClientAvailable, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IHistoryClientAvailable, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): HistoryClientAvailable;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): HistoryClientAvailable;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): HistoryClientAvailable;
+    public static toObject(message: HistoryClientAvailable, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
+export interface IHistoryClientRequest {
+}
+
+export class HistoryClientRequest implements IHistoryClientRequest {
+    constructor(properties?: IHistoryClientRequest);
+    public static create(properties?: IHistoryClientRequest): HistoryClientRequest;
+    public static encode(message: IHistoryClientRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IHistoryClientRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): HistoryClientRequest;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): HistoryClientRequest;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): HistoryClientRequest;
+    public static toObject(message: HistoryClientRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
+export interface IHistoryClientResponse {
+    clients?: (IHistoryClient[]|null);
+}
+
+export class HistoryClientResponse implements IHistoryClientResponse {
+    constructor(properties?: IHistoryClientResponse);
+    public clients: IHistoryClient[];
+    public static create(properties?: IHistoryClientResponse): HistoryClientResponse;
+    public static encode(message: IHistoryClientResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IHistoryClientResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): HistoryClientResponse;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): HistoryClientResponse;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): HistoryClientResponse;
+    public static toObject(message: HistoryClientResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+    public static getTypeUrl(typeUrlPrefix?: string): string;
+}
+
 export enum ClientAction {
     RESET_SESSION = 0
 }