Fix sort options serialization (#379)

fix(app-context): fix `sort` options serialization

Fix issue because of which single string sort option wasn't serialized properly.

.pubnub.yml

@@ -1,5 +1,10 @@
 ---
 changelog:
+  - date: 2024-06-06
+    version: v8.2.3
+    changes:
+      - type: bug
+        text: "Fix issue because of which single string sort option wasn't serialized properly."
   - date: 2024-06-05
     version: v8.2.2
     changes:
@@ -998,7 +1003,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '8.2.2'
+version: '8.2.3'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1014,7 +1019,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.2.2.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.2.3.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1685,7 +1690,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v8.2.2/pubnub.8.2.2.js
+            location: https://github.com/pubnub/javascript/releases/download/v8.2.3/pubnub.8.2.3.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v8.2.3
+June 06 2024
+
+#### Fixed
+- Fix issue because of which single string sort option wasn't serialized properly.
+
 ## v8.2.2
 June 05 2024
 

README.md

@@ -28,8 +28,8 @@ Watch [Getting Started with PubNub JS SDK](https://app.dashcam.io/replay/64ee0d2
      npm install pubnub
      ```
    * or download one of our builds from our CDN: 
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.2.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.2.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.3.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.3.min.js
 
 2. Configure your keys:
 

dist/web/pubnub.js

@@ -3813,7 +3813,7 @@
 	            return base.PubNubFile;
 	        },
 	        get version() {
-	            return '8.2.2';
+	            return '8.2.3';
 	        },
 	        getVersion() {
 	            return this.version;
@@ -9781,7 +9781,11 @@
 	    }
 	    get queryParameters() {
 	        const { include, page, filter, sort, limit } = this.parameters;
-	        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+	        let sorting = '';
+	        if (typeof sort === 'string')
+	            sorting = sort;
+	        else
+	            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 	        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ include: ['status', 'type', ...(include.customFields ? ['custom'] : [])].join(','), count: `${include.totalCount}` }, (filter ? { filter } : {})), ((page === null || page === void 0 ? void 0 : page.next) ? { start: page.next } : {})), ((page === null || page === void 0 ? void 0 : page.prev) ? { end: page.prev } : {})), (limit ? { limit } : {})), (sorting.length ? { sort: sorting } : {}));
 	    }
 	}
@@ -9913,7 +9917,11 @@
 	    }
 	    get queryParameters() {
 	        const { include, page, filter, sort, limit } = this.parameters;
-	        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+	        let sorting = '';
+	        if (typeof sort === 'string')
+	            sorting = sort;
+	        else
+	            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 	        const includeFlags = [];
 	        if (include.statusField)
 	            includeFlags.push('status');
@@ -10008,7 +10016,11 @@
 	    }
 	    get queryParameters() {
 	        const { include, page, filter, sort, limit } = this.parameters;
-	        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+	        let sorting = '';
+	        if (typeof sort === 'string')
+	            sorting = sort;
+	        else
+	            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 	        const includeFlags = ['channel.status', 'channel.type', 'status'];
 	        if (include.customFields)
 	            includeFlags.push('custom');
@@ -10084,7 +10096,11 @@
 	    }
 	    get queryParameters() {
 	        const { include, page, filter, sort, limit } = this.parameters;
-	        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+	        let sorting = '';
+	        if (typeof sort === 'string')
+	            sorting = sort;
+	        else
+	            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 	        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ include: ['status', 'type', ...(include.customFields ? ['custom'] : [])].join(',') }, (include.totalCount !== undefined ? { count: `${include.totalCount}` } : {})), (filter ? { filter } : {})), ((page === null || page === void 0 ? void 0 : page.next) ? { start: page.next } : {})), ((page === null || page === void 0 ? void 0 : page.prev) ? { end: page.prev } : {})), (limit ? { limit } : {})), (sorting.length ? { sort: sorting } : {}));
 	    }
 	}
@@ -10333,7 +10349,11 @@
 	    }
 	    get queryParameters() {
 	        const { include, page, filter, sort, limit } = this.parameters;
-	        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+	        let sorting = '';
+	        if (typeof sort === 'string')
+	            sorting = sort;
+	        else
+	            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 	        const includeFlags = [];
 	        if (include.statusField)
 	            includeFlags.push('status');
@@ -10425,7 +10445,11 @@
 	    }
 	    get queryParameters() {
 	        const { include, page, filter, sort, limit } = this.parameters;
-	        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+	        let sorting = '';
+	        if (typeof sort === 'string')
+	            sorting = sort;
+	        else
+	            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 	        const includeFlags = ['uuid.status', 'uuid.type', 'type'];
 	        if (include.customFields)
 	            includeFlags.push('custom');

lib/core/components/configuration.js

@@ -110,7 +110,7 @@ const makeConfiguration = (base, setupCryptoModule) => {
             return base.PubNubFile;
         },
         get version() {
-            return '8.2.2';
+            return '8.2.3';
         },
         getVersion() {
             return this.version;

lib/core/endpoints/objects/channel/get_all.js

@@ -73,7 +73,11 @@ class GetAllChannelsMetadataRequest extends request_1.AbstractRequest {
     }
     get queryParameters() {
         const { include, page, filter, sort, limit } = this.parameters;
-        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+        let sorting = '';
+        if (typeof sort === 'string')
+            sorting = sort;
+        else
+            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
         return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ include: ['status', 'type', ...(include.customFields ? ['custom'] : [])].join(','), count: `${include.totalCount}` }, (filter ? { filter } : {})), ((page === null || page === void 0 ? void 0 : page.next) ? { start: page.next } : {})), ((page === null || page === void 0 ? void 0 : page.prev) ? { end: page.prev } : {})), (limit ? { limit } : {})), (sorting.length ? { sort: sorting } : {}));
     }
 }

lib/core/endpoints/objects/member/get.js

@@ -104,7 +104,11 @@ class GetChannelMembersRequest extends request_1.AbstractRequest {
     }
     get queryParameters() {
         const { include, page, filter, sort, limit } = this.parameters;
-        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+        let sorting = '';
+        if (typeof sort === 'string')
+            sorting = sort;
+        else
+            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
         const includeFlags = [];
         if (include.statusField)
             includeFlags.push('status');

lib/core/endpoints/objects/member/set.js

@@ -93,7 +93,11 @@ class SetChannelMembersRequest extends request_1.AbstractRequest {
     }
     get queryParameters() {
         const { include, page, filter, sort, limit } = this.parameters;
-        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+        let sorting = '';
+        if (typeof sort === 'string')
+            sorting = sort;
+        else
+            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
         const includeFlags = ['uuid.status', 'uuid.type', 'type'];
         if (include.customFields)
             includeFlags.push('custom');

lib/core/endpoints/objects/membership/get.js

@@ -107,7 +107,11 @@ class GetUUIDMembershipsRequest extends request_1.AbstractRequest {
     }
     get queryParameters() {
         const { include, page, filter, sort, limit } = this.parameters;
-        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+        let sorting = '';
+        if (typeof sort === 'string')
+            sorting = sort;
+        else
+            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
         const includeFlags = [];
         if (include.statusField)
             includeFlags.push('status');

lib/core/endpoints/objects/membership/set.js

@@ -96,7 +96,11 @@ class SetUUIDMembershipsRequest extends request_1.AbstractRequest {
     }
     get queryParameters() {
         const { include, page, filter, sort, limit } = this.parameters;
-        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+        let sorting = '';
+        if (typeof sort === 'string')
+            sorting = sort;
+        else
+            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
         const includeFlags = ['channel.status', 'channel.type', 'status'];
         if (include.customFields)
             includeFlags.push('custom');

lib/core/endpoints/objects/uuid/get_all.js

@@ -68,7 +68,11 @@ class GetAllUUIDMetadataRequest extends request_1.AbstractRequest {
     }
     get queryParameters() {
         const { include, page, filter, sort, limit } = this.parameters;
-        const sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => order !== null ? `${option}:${order}` : option);
+        let sorting = '';
+        if (typeof sort === 'string')
+            sorting = sort;
+        else
+            sorting = Object.entries(sort !== null && sort !== void 0 ? sort : {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
         return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ include: ['status', 'type', ...(include.customFields ? ['custom'] : [])].join(',') }, (include.totalCount !== undefined ? { count: `${include.totalCount}` } : {})), (filter ? { filter } : {})), ((page === null || page === void 0 ? void 0 : page.next) ? { start: page.next } : {})), ((page === null || page === void 0 ? void 0 : page.prev) ? { end: page.prev } : {})), (limit ? { limit } : {})), (sorting.length ? { sort: sorting } : {}));
     }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pubnub",
-  "version": "8.2.2",
+  "version": "8.2.3",
   "author": "PubNub <[email protected]>",
   "description": "Publish & Subscribe Real-time Messaging with PubNub",
   "scripts": {

src/core/components/configuration.ts

@@ -169,7 +169,7 @@ export const makeConfiguration = (
       return base.PubNubFile;
     },
     get version(): string {
-      return '8.2.2';
+      return '8.2.3';
     },
     getVersion(): string {
       return this.version;

src/core/endpoints/objects/channel/get_all.ts

@@ -90,9 +90,10 @@ export class GetAllChannelsMetadataRequest<
 
   protected get queryParameters(): Query {
     const { include, page, filter, sort, limit } = this.parameters;
-    const sorting = Object.entries(sort ?? {}).map(([option, order]) =>
-      order !== null ? `${option}:${order}` : option,
-    );
+    let sorting: string | string[] = '';
+    if (typeof sort === 'string') sorting = sort;
+    else
+      sorting = Object.entries(sort ?? {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 
     return {
       include: ['status', 'type', ...(include!.customFields ? ['custom'] : [])].join(','),

src/core/endpoints/objects/member/get.ts

@@ -130,9 +130,10 @@ export class GetChannelMembersRequest<
 
   protected get queryParameters(): Query {
     const { include, page, filter, sort, limit } = this.parameters;
-    const sorting = Object.entries(sort ?? {}).map(([option, order]) =>
-      order !== null ? `${option}:${order}` : option,
-    );
+    let sorting: string | string[] = '';
+    if (typeof sort === 'string') sorting = sort;
+    else
+      sorting = Object.entries(sort ?? {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
     const includeFlags: string[] = [];
 
     if (include!.statusField) includeFlags.push('status');

src/core/endpoints/objects/member/set.ts

@@ -121,9 +121,10 @@ export class SetChannelMembersRequest<
 
   protected get queryParameters(): Query {
     const { include, page, filter, sort, limit } = this.parameters;
-    const sorting = Object.entries(sort ?? {}).map(([option, order]) =>
-      order !== null ? `${option}:${order}` : option,
-    );
+    let sorting: string | string[] = '';
+    if (typeof sort === 'string') sorting = sort;
+    else
+      sorting = Object.entries(sort ?? {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
     const includeFlags: string[] = ['uuid.status', 'uuid.type', 'type'];
 
     if (include!.customFields) includeFlags.push('custom');

src/core/endpoints/objects/membership/get.ts

@@ -133,9 +133,10 @@ export class GetUUIDMembershipsRequest<
 
   protected get queryParameters(): Query {
     const { include, page, filter, sort, limit } = this.parameters;
-    const sorting = Object.entries(sort ?? {}).map(([option, order]) =>
-      order !== null ? `${option}:${order}` : option,
-    );
+    let sorting: string | string[] = '';
+    if (typeof sort === 'string') sorting = sort;
+    else
+      sorting = Object.entries(sort ?? {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
     const includeFlags: string[] = [];
 
     if (include!.statusField) includeFlags.push('status');

src/core/endpoints/objects/membership/set.ts

@@ -124,9 +124,10 @@ export class SetUUIDMembershipsRequest<
 
   protected get queryParameters(): Query {
     const { include, page, filter, sort, limit } = this.parameters;
-    const sorting = Object.entries(sort ?? {}).map(([option, order]) =>
-      order !== null ? `${option}:${order}` : option,
-    );
+    let sorting: string | string[] = '';
+    if (typeof sort === 'string') sorting = sort;
+    else
+      sorting = Object.entries(sort ?? {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
     const includeFlags: string[] = ['channel.status', 'channel.type', 'status'];
 
     if (include!.customFields) includeFlags.push('custom');

src/core/endpoints/objects/uuid/get_all.ts

@@ -84,9 +84,10 @@ export class GetAllUUIDMetadataRequest<
 
   protected get queryParameters(): Query {
     const { include, page, filter, sort, limit } = this.parameters;
-    const sorting = Object.entries(sort ?? {}).map(([option, order]) =>
-      order !== null ? `${option}:${order}` : option,
-    );
+    let sorting: string | string[] = '';
+    if (typeof sort === 'string') sorting = sort;
+    else
+      sorting = Object.entries(sort ?? {}).map(([option, order]) => (order !== null ? `${option}:${order}` : option));
 
     return {
       include: ['status', 'type', ...(include!.customFields ? ['custom'] : [])].join(','),