feat(message-type): add custom message type support

Add custom message type support for the following APIs: publish, signal, share file, subscribe and history.
pubnub · Nov 14, 2024 · 1e5bcc1 · 1e5bcc1
1 parent 66520c2
commit 1e5bcc1
Show file tree

Hide file tree

Showing 21 changed files with 352 additions and 75 deletions.
diff --git a/dist/web/pubnub.js b/dist/web/pubnub.js
@@ -6230,6 +6230,8 @@
 	        };
 	        if (envelope.u)
 	            event.userMetadata = envelope.u;
+	        if (envelope.cmt)
+	            event.customMessageType = envelope.cmt;
 	        if (decryptionError)
 	            event.error = decryptionError;
 	        return event;
@@ -6245,6 +6247,8 @@
 	        };
 	        if (envelope.u)
 	            event.userMetadata = envelope.u;
+	        if (envelope.cmt)
+	            event.customMessageType = envelope.cmt;
 	        return event;
 	    }
 	    messageActionFromEnvelope(envelope) {
@@ -6296,6 +6300,8 @@
 	                };
 	            }
 	        }
+	        if (envelope.cmt)
+	            event.customMessageType = envelope.cmt;
 	        if (errorMessage)
 	            event.error = errorMessage;
 	        return event;
@@ -8303,8 +8309,10 @@
 	        return `/publish/${keySet.publishKey}/${keySet.subscribeKey}/0/${encodeString(channel)}/0${!this.parameters.sendByPost ? `/${encodeString(stringifiedPayload)}` : ''}`;
 	    }
 	    get queryParameters() {
-	        const { meta, replicate, storeInHistory, ttl } = this.parameters;
+	        const { customMessageType, meta, replicate, storeInHistory, ttl } = this.parameters;
 	        const query = {};
+	        if (customMessageType)
+	            query.custom_message_type = customMessageType;
 	        if (storeInHistory !== undefined)
 	            query.store = storeInHistory ? '1' : '0';
 	        if (ttl !== undefined)
@@ -8380,6 +8388,13 @@
 	        const stringifiedPayload = JSON.stringify(message);
 	        return `/signal/${publishKey}/${subscribeKey}/0/${encodeString(channel)}/0/${encodeString(stringifiedPayload)}`;
 	    }
+	    get queryParameters() {
+	        const { customMessageType } = this.parameters;
+	        const query = {};
+	        if (customMessageType)
+	            query.custom_message_type = customMessageType;
+	        return query;
+	    }
 	}
 
 	/**
@@ -9151,13 +9166,7 @@
 	                    if (payload.message_type === null)
 	                        payload.message_type = PubNubMessageType.Message;
 	                    const processedPayload = this.processPayload(channel, payload);
-	                    const item = {
-	                        channel,
-	                        timetoken: payload.timetoken,
-	                        message: processedPayload.payload,
-	                        messageType: payload.message_type,
-	                        uuid: payload.uuid,
-	                    };
+	                    const item = Object.assign(Object.assign({ channel, timetoken: payload.timetoken, message: processedPayload.payload, messageType: payload.message_type }, (payload.custom_message_type ? { customMessageType: payload.custom_message_type } : {})), { uuid: payload.uuid });
 	                    if (payload.actions) {
 	                        const itemWithActions = item;
 	                        itemWithActions.actions = payload.actions;
@@ -9183,8 +9192,10 @@
 	        return `/v3/${endpoint}/sub-key/${subscribeKey}/channel/${encodeNames(channels)}`;
 	    }
 	    get queryParameters() {
-	        const { start, end, count, includeMessageType, includeMeta, includeUUID, stringifiedTimeToken } = this.parameters;
-	        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ max: count }, (start ? { start } : {})), (end ? { end } : {})), (stringifiedTimeToken ? { string_message_token: 'true' } : {})), (includeMeta !== undefined && includeMeta ? { include_meta: 'true' } : {})), (includeUUID ? { include_uuid: 'true' } : {})), (includeMessageType ? { include_message_type: 'true' } : {}));
+	        const { start, end, count, includeCustomMessageType, includeMessageType, includeMeta, includeUUID, stringifiedTimeToken, } = this.parameters;
+	        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ max: count }, (start ? { start } : {})), (end ? { end } : {})), (stringifiedTimeToken ? { string_message_token: 'true' } : {})), (includeMeta !== undefined && includeMeta ? { include_meta: 'true' } : {})), (includeUUID ? { include_uuid: 'true' } : {})), (includeCustomMessageType !== undefined && includeCustomMessageType !== null
+	            ? { include_custom_message_type: includeCustomMessageType ? 'true' : 'false' }
+	            : {})), (includeMessageType ? { include_message_type: 'true' } : {}));
 	    }
 	    /**
 	     * Parse single channel data entry.
@@ -9461,8 +9472,8 @@
 	        return `/v1/files/publish-file/${publishKey}/${subscribeKey}/0/${encodeString(channel)}/0/${encodeString(this.prepareMessagePayload(fileMessage))}`;
 	    }
 	    get queryParameters() {
-	        const { storeInHistory, ttl, meta } = this.parameters;
-	        return Object.assign(Object.assign({ store: storeInHistory ? '1' : '0' }, (ttl ? { ttl } : {})), (meta && typeof meta === 'object' ? { meta: JSON.stringify(meta) } : {}));
+	        const { customMessageType, storeInHistory, ttl, meta } = this.parameters;
+	        return Object.assign(Object.assign(Object.assign({ store: storeInHistory ? '1' : '0' }, (customMessageType ? { custom_message_type: customMessageType } : {})), (ttl ? { ttl } : {})), (meta && typeof meta === 'object' ? { meta: JSON.stringify(meta) } : {}));
 	    }
 	    /**
 	     * Pre-process provided data.

diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/lib/core/endpoints/fetch_messages.js b/lib/core/endpoints/fetch_messages.js
@@ -135,13 +135,7 @@ class FetchMessagesRequest extends request_1.AbstractRequest {
                     if (payload.message_type === null)
                         payload.message_type = History.PubNubMessageType.Message;
                     const processedPayload = this.processPayload(channel, payload);
-                    const item = {
-                        channel,
-                        timetoken: payload.timetoken,
-                        message: processedPayload.payload,
-                        messageType: payload.message_type,
-                        uuid: payload.uuid,
-                    };
+                    const item = Object.assign(Object.assign({ channel, timetoken: payload.timetoken, message: processedPayload.payload, messageType: payload.message_type }, (payload.custom_message_type ? { customMessageType: payload.custom_message_type } : {})), { uuid: payload.uuid });
                     if (payload.actions) {
                         const itemWithActions = item;
                         itemWithActions.actions = payload.actions;
@@ -167,8 +161,10 @@ class FetchMessagesRequest extends request_1.AbstractRequest {
         return `/v3/${endpoint}/sub-key/${subscribeKey}/channel/${(0, utils_1.encodeNames)(channels)}`;
     }
     get queryParameters() {
-        const { start, end, count, includeMessageType, includeMeta, includeUUID, stringifiedTimeToken } = this.parameters;
-        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ max: count }, (start ? { start } : {})), (end ? { end } : {})), (stringifiedTimeToken ? { string_message_token: 'true' } : {})), (includeMeta !== undefined && includeMeta ? { include_meta: 'true' } : {})), (includeUUID ? { include_uuid: 'true' } : {})), (includeMessageType ? { include_message_type: 'true' } : {}));
+        const { start, end, count, includeCustomMessageType, includeMessageType, includeMeta, includeUUID, stringifiedTimeToken, } = this.parameters;
+        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ max: count }, (start ? { start } : {})), (end ? { end } : {})), (stringifiedTimeToken ? { string_message_token: 'true' } : {})), (includeMeta !== undefined && includeMeta ? { include_meta: 'true' } : {})), (includeUUID ? { include_uuid: 'true' } : {})), (includeCustomMessageType !== undefined && includeCustomMessageType !== null
+            ? { include_custom_message_type: includeCustomMessageType ? 'true' : 'false' }
+            : {})), (includeMessageType ? { include_message_type: 'true' } : {}));
     }
     /**
      * Parse single channel data entry.

diff --git a/lib/core/endpoints/file_upload/publish_file.js b/lib/core/endpoints/file_upload/publish_file.js
@@ -75,8 +75,8 @@ class PublishFileMessageRequest extends request_1.AbstractRequest {
         return `/v1/files/publish-file/${publishKey}/${subscribeKey}/0/${(0, utils_1.encodeString)(channel)}/0/${(0, utils_1.encodeString)(this.prepareMessagePayload(fileMessage))}`;
     }
     get queryParameters() {
-        const { storeInHistory, ttl, meta } = this.parameters;
-        return Object.assign(Object.assign({ store: storeInHistory ? '1' : '0' }, (ttl ? { ttl } : {})), (meta && typeof meta === 'object' ? { meta: JSON.stringify(meta) } : {}));
+        const { customMessageType, storeInHistory, ttl, meta } = this.parameters;
+        return Object.assign(Object.assign(Object.assign({ store: storeInHistory ? '1' : '0' }, (customMessageType ? { custom_message_type: customMessageType } : {})), (ttl ? { ttl } : {})), (meta && typeof meta === 'object' ? { meta: JSON.stringify(meta) } : {}));
     }
     /**
      * Pre-process provided data.

diff --git a/lib/core/endpoints/publish.js b/lib/core/endpoints/publish.js
@@ -79,8 +79,10 @@ class PublishRequest extends request_1.AbstractRequest {
         return `/publish/${keySet.publishKey}/${keySet.subscribeKey}/0/${(0, utils_1.encodeString)(channel)}/0${!this.parameters.sendByPost ? `/${(0, utils_1.encodeString)(stringifiedPayload)}` : ''}`;
     }
     get queryParameters() {
-        const { meta, replicate, storeInHistory, ttl } = this.parameters;
+        const { customMessageType, meta, replicate, storeInHistory, ttl } = this.parameters;
         const query = {};
+        if (customMessageType)
+            query.custom_message_type = customMessageType;
         if (storeInHistory !== undefined)
             query.store = storeInHistory ? '1' : '0';
         if (ttl !== undefined)

diff --git a/lib/core/endpoints/signal.js b/lib/core/endpoints/signal.js
@@ -56,5 +56,12 @@ class SignalRequest extends request_1.AbstractRequest {
         const stringifiedPayload = JSON.stringify(message);
         return `/signal/${publishKey}/${subscribeKey}/0/${(0, utils_1.encodeString)(channel)}/0/${(0, utils_1.encodeString)(stringifiedPayload)}`;
     }
+    get queryParameters() {
+        const { customMessageType } = this.parameters;
+        const query = {};
+        if (customMessageType)
+            query.custom_message_type = customMessageType;
+        return query;
+    }
 }
 exports.SignalRequest = SignalRequest;
diff --git a/lib/core/endpoints/subscribe.js b/lib/core/endpoints/subscribe.js
@@ -216,6 +216,8 @@ class BaseSubscribeRequest extends request_1.AbstractRequest {
         };
         if (envelope.u)
             event.userMetadata = envelope.u;
+        if (envelope.cmt)
+            event.customMessageType = envelope.cmt;
         if (decryptionError)
             event.error = decryptionError;
         return event;
@@ -231,6 +233,8 @@ class BaseSubscribeRequest extends request_1.AbstractRequest {
         };
         if (envelope.u)
             event.userMetadata = envelope.u;
+        if (envelope.cmt)
+            event.customMessageType = envelope.cmt;
         return event;
     }
     messageActionFromEnvelope(envelope) {
@@ -282,6 +286,8 @@ class BaseSubscribeRequest extends request_1.AbstractRequest {
                 };
             }
         }
+        if (envelope.cmt)
+            event.customMessageType = envelope.cmt;
         if (errorMessage)
             event.error = errorMessage;
         return event;

diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -4764,6 +4764,10 @@ declare namespace PubNub {
       userMetadata?: {
         [p: string]: Payload;
       };
+      /**
+       * User-provided message type.
+       */
+      customMessageType?: string;
       /**
        * Sent data.
        */
@@ -6086,6 +6090,13 @@ declare namespace PubNub {
        * The message may be any valid JSON type including objects, arrays, strings, and numbers.
        */
       message: Payload;
+      /**
+       * User-specified message type.
+       *
+       * **Important:** string limited by **3**-**50** case-sensitive alphanumeric characters with only
+       * `-` and `_` special characters allowed.
+       */
+      customMessageType?: string;
       /**
        * Whether published data should be available with `Storage API` later or not.
        *
@@ -6150,6 +6161,13 @@ declare namespace PubNub {
        * The message may be any valid JSON type including objects, arrays, strings, and numbers.
        */
       message: Payload;
+      /**
+       * User-specified message type.
+       *
+       * **Important:** string limited by **3**-**50** case-sensitive alphanumeric characters with only
+       * `-` and `_` special characters allowed.
+       */
+      customMessageType?: string;
     };
 
     /**
@@ -6566,6 +6584,10 @@ declare namespace PubNub {
        * PubNub-defined message type.
        */
       messageType?: PubNubMessageType.Message;
+      /**
+       * User-provided message type.
+       */
+      customMessageType?: string;
     };
 
     /**
@@ -6610,6 +6632,10 @@ declare namespace PubNub {
        * PubNub-defined message type.
        */
       messageType?: PubNubMessageType.Files;
+      /**
+       * User-provided message type.
+       */
+      customMessageType?: string;
     };
 
     /**
@@ -6652,6 +6678,12 @@ declare namespace PubNub {
        * @default `100` or `25`
        */
       count?: number;
+      /**
+       * Include messages' custom type flag.
+       *
+       * Message / signal and file messages may contain user-provided type.
+       */
+      includeCustomMessageType?: boolean;
       /**
        * Whether message type should be returned with each history message or not.
        *
@@ -7194,6 +7226,13 @@ declare namespace PubNub {
        * File annotation message.
        */
       message?: Payload;
+      /**
+       * User-specified message type.
+       *
+       * **Important:** string limited by **3**-**50** case-sensitive alphanumeric characters with only
+       * `-` and `_` special characters allowed.
+       */
+      customMessageType?: string;
       /**
        * Custom file and message encryption key.
        *

diff --git a/src/core/endpoints/fetch_messages.ts b/src/core/endpoints/fetch_messages.ts
@@ -127,6 +127,11 @@ type ServiceResponse = {
        */
       uuid?: string;
 
+      /**
+       * User-provided message type.
+       */
+      custom_message_type?: string;
+
       /**
        * PubNub-defined message type.
        */
@@ -232,6 +237,7 @@ export class FetchMessagesRequest extends AbstractRequest<History.FetchMessagesR
           timetoken: payload.timetoken,
           message: processedPayload.payload,
           messageType: payload.message_type,
+          ...(payload.custom_message_type ? { customMessageType: payload.custom_message_type } : {}),
           uuid: payload.uuid,
         };
 
@@ -269,7 +275,16 @@ export class FetchMessagesRequest extends AbstractRequest<History.FetchMessagesR
   }
 
   protected get queryParameters(): Query {
-    const { start, end, count, includeMessageType, includeMeta, includeUUID, stringifiedTimeToken } = this.parameters;
+    const {
+      start,
+      end,
+      count,
+      includeCustomMessageType,
+      includeMessageType,
+      includeMeta,
+      includeUUID,
+      stringifiedTimeToken,
+    } = this.parameters;
 
     return {
       max: count!,
@@ -278,6 +293,9 @@ export class FetchMessagesRequest extends AbstractRequest<History.FetchMessagesR
       ...(stringifiedTimeToken! ? { string_message_token: 'true' } : {}),
       ...(includeMeta !== undefined && includeMeta ? { include_meta: 'true' } : {}),
       ...(includeUUID! ? { include_uuid: 'true' } : {}),
+      ...(includeCustomMessageType !== undefined && includeCustomMessageType !== null
+        ? { include_custom_message_type: includeCustomMessageType ? 'true' : 'false' }
+        : {}),
       ...(includeMessageType! ? { include_message_type: 'true' } : {}),
     };
   }

diff --git a/src/core/endpoints/file_upload/publish_file.ts b/src/core/endpoints/file_upload/publish_file.ts
@@ -111,9 +111,10 @@ export class PublishFileMessageRequest extends AbstractRequest<FileSharing.Publi
   }
 
   protected get queryParameters(): Query {
-    const { storeInHistory, ttl, meta } = this.parameters;
+    const { customMessageType, storeInHistory, ttl, meta } = this.parameters;
     return {
       store: storeInHistory! ? '1' : '0',
+      ...(customMessageType ? { custom_message_type: customMessageType } : {}),
       ...(ttl ? { ttl } : {}),
       ...(meta && typeof meta === 'object' ? { meta: JSON.stringify(meta) } : {}),
     };

diff --git a/src/core/endpoints/publish.ts b/src/core/endpoints/publish.ts
@@ -44,6 +44,14 @@ export type PublishParameters = {
    */
   message: Payload;
 
+  /**
+   * User-specified message type.
+   *
+   * **Important:** string limited by **3**-**50** case-sensitive alphanumeric characters with only
+   * `-` and `_` special characters allowed.
+   */
+  customMessageType?: string;
+
   /**
    * Whether published data should be available with `Storage API` later or not.
    *
@@ -176,9 +184,10 @@ export class PublishRequest extends AbstractRequest<PublishResponse> {
   }
 
   protected get queryParameters(): Query {
-    const { meta, replicate, storeInHistory, ttl } = this.parameters;
+    const { customMessageType, meta, replicate, storeInHistory, ttl } = this.parameters;
     const query: Query = {};
 
+    if (customMessageType) query.custom_message_type = customMessageType;
     if (storeInHistory !== undefined) query.store = storeInHistory ? '1' : '0';
     if (ttl !== undefined) query.ttl = ttl;
     if (replicate !== undefined && !replicate) query.norep = 'true';

diff --git a/src/core/endpoints/signal.ts b/src/core/endpoints/signal.ts
@@ -29,6 +29,14 @@ export type SignalParameters = {
    * The message may be any valid JSON type including objects, arrays, strings, and numbers.
    */
   message: Payload;
+
+  /**
+   * User-specified message type.
+   *
+   * **Important:** string limited by **3**-**50** case-sensitive alphanumeric characters with only
+   * `-` and `_` special characters allowed.
+   */
+  customMessageType?: string;
 };
 
 /**
@@ -105,4 +113,13 @@ export class SignalRequest extends AbstractRequest<SignalResponse> {
 
     return `/signal/${publishKey}/${subscribeKey}/0/${encodeString(channel)}/0/${encodeString(stringifiedPayload)}`;
   }
+
+  protected get queryParameters(): Query {
+    const { customMessageType } = this.parameters;
+    const query: Query = {};
+
+    if (customMessageType) query.custom_message_type = customMessageType;
+
+    return query;
+  }
 }