PubNub SDK v8.2.10 release.

pubnub · Oct 31, 2024 · 260c949 · 260c949
1 parent afdcb93
commit 260c949
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 32 deletions.
diff --git a/.pubnub.yml b/.pubnub.yml
@@ -1,5 +1,18 @@
 ---
 changelog:
+  - date: 2024-10-31
+    version: v8.2.10
+    changes:
+      - type: bug
+        text: "Fix `Actions` type definition."
+      - type: improvement
+        text: "Remove indexed signature for publish."
+      - type: improvement
+        text: "Add serializable objects to `Payload` type."
+      - type: improvement
+        text: "Aggregate generated types definitions."
+      - type: improvement
+        text: "Fix definition of type which represents message actions received from history and list of users which added action of specific type and value to the message.      Closes #407           Remove redundant indexed signature from publish message parameters type definition.      Closes #413           Extend `Payload` type definition with objects which can be serialized by `JSON.stringify` using `toJSON()` methods.      Closes #412           Aggregate multiple types definitions into single type definition type with proper type names and namespaces.      Closes #405 #409 #410           Add the Subscribe Event Engine and Event Listener types to the bundled types definition file.      Closes #377."
   - date: 2024-10-25
     version: v8.2.9
     changes:
@@ -1041,7 +1054,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '8.2.9'
+version: '8.2.10'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1057,7 +1070,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.2.9.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.2.10.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1728,7 +1741,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v8.2.9/pubnub.8.2.9.js
+            location: https://github.com/pubnub/javascript/releases/download/v8.2.10/pubnub.8.2.10.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+## v8.2.10
+October 31 2024
+
+#### Fixed
+- Fix `Actions` type definition.
+
+#### Modified
+- Remove indexed signature for publish.
+- Add serializable objects to `Payload` type.
+- Aggregate generated types definitions.
+- Fix definition of type which represents message actions received from history and list of users which added action of specific type and value to the message.      Closes #407           Remove redundant indexed signature from publish message parameters type definition.      Closes #413           Extend `Payload` type definition with objects which can be serialized by `JSON.stringify` using `toJSON()` methods.      Closes #412           Aggregate multiple types definitions into single type definition type with proper type names and namespaces.      Closes #405 #409 #410           Add the Subscribe Event Engine and Event Listener types to the bundled types definition file.      Closes #377.
+
 ## v8.2.9
 October 25 2024
 

diff --git a/README.md b/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.9.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.9.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.10.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.10.min.js
 
 2. Configure your keys:
 

diff --git a/dist/web/pubnub.js b/dist/web/pubnub.js
@@ -435,7 +435,7 @@
 	OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 	PERFORMANCE OF THIS SOFTWARE.
 	***************************************************************************** */
-	/* global Reflect, Promise, SuppressedError, Symbol */
+	/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 	function __rest(s, e) {
@@ -3311,7 +3311,7 @@
 	 */
 	const encodeNames = (names, defaultString) => {
 	    const encodedNames = names.map((name) => encodeString(name));
-	    return encodedNames.length ? encodedNames.join(',') : defaultString !== null && defaultString !== void 0 ? defaultString : '';
+	    return encodedNames.length ? encodedNames.join(',') : (defaultString !== null && defaultString !== void 0 ? defaultString : '');
 	};
 	/**
 	 * @internal
@@ -3948,7 +3948,7 @@
 	            return base.PubNubFile;
 	        },
 	        get version() {
-	            return '8.2.9';
+	            return '8.2.10';
 	        },
 	        getVersion() {
 	            return this.version;
@@ -7034,7 +7034,7 @@
 	                }
 	            }
 	        })));
-	        this.on(leave.type, asyncHandler((payload_2, _2, _b) => __awaiter(this, [payload_2, _2, _b], void 0, function* (payload, _, { leave, config }) {
+	        this.on(leave.type, asyncHandler((payload_1, _1, _a) => __awaiter(this, [payload_1, _1, _a], void 0, function* (payload, _, { leave, config }) {
 	            if (!config.suppressLeaveEvents) {
 	                try {
 	                    leave({
@@ -7045,13 +7045,13 @@
 	                catch (e) { }
 	            }
 	        })));
-	        this.on(wait.type, asyncHandler((_3, abortSignal_1, _c) => __awaiter(this, [_3, abortSignal_1, _c], void 0, function* (_, abortSignal, { heartbeatDelay }) {
+	        this.on(wait.type, asyncHandler((_1, abortSignal_1, _a) => __awaiter(this, [_1, abortSignal_1, _a], void 0, function* (_, abortSignal, { heartbeatDelay }) {
 	            abortSignal.throwIfAborted();
 	            yield heartbeatDelay();
 	            abortSignal.throwIfAborted();
 	            return engine.transition(timesUp());
 	        })));
-	        this.on(delayedHeartbeat.type, asyncHandler((payload_3, abortSignal_2, _d) => __awaiter(this, [payload_3, abortSignal_2, _d], void 0, function* (payload, abortSignal, { heartbeat, retryDelay, presenceState, config }) {
+	        this.on(delayedHeartbeat.type, asyncHandler((payload_1, abortSignal_1, _a) => __awaiter(this, [payload_1, abortSignal_1, _a], void 0, function* (payload, abortSignal, { heartbeat, retryDelay, presenceState, config }) {
 	            if (config.retryConfiguration && config.retryConfiguration.shouldRetry(payload.reason, payload.attempts)) {
 	                abortSignal.throwIfAborted();
 	                yield retryDelay(config.retryConfiguration.getDelay(payload.attempts, payload.reason));
@@ -7072,9 +7072,9 @@
 	                return engine.transition(heartbeatGiveup());
 	            }
 	        })));
-	        this.on(emitStatus$1.type, asyncHandler((payload_4, _4, _e) => __awaiter(this, [payload_4, _4, _e], void 0, function* (payload, _, { emitStatus, config }) {
-	            var _f;
-	            if (config.announceFailedHeartbeats && ((_f = payload === null || payload === void 0 ? void 0 : payload.status) === null || _f === void 0 ? void 0 : _f.error) === true) {
+	        this.on(emitStatus$1.type, asyncHandler((payload_1, _1, _a) => __awaiter(this, [payload_1, _1, _a], void 0, function* (payload, _, { emitStatus, config }) {
+	            var _b;
+	            if (config.announceFailedHeartbeats && ((_b = payload === null || payload === void 0 ? void 0 : payload.status) === null || _b === void 0 ? void 0 : _b.error) === true) {
 	                emitStatus(payload.status);
 	            }
 	            else if (config.announceSuccessfulHeartbeats && payload.statusCode === 200) {
@@ -7639,7 +7639,7 @@
 	                }
 	            }
 	        })));
-	        this.on(receiveMessages.type, asyncHandler((payload_2, abortSignal_2, _b) => __awaiter(this, [payload_2, abortSignal_2, _b], void 0, function* (payload, abortSignal, { receiveMessages, config }) {
+	        this.on(receiveMessages.type, asyncHandler((payload_1, abortSignal_1, _a) => __awaiter(this, [payload_1, abortSignal_1, _a], void 0, function* (payload, abortSignal, { receiveMessages, config }) {
 	            abortSignal.throwIfAborted();
 	            try {
 	                const result = yield receiveMessages({
@@ -7661,15 +7661,15 @@
 	                }
 	            }
 	        })));
-	        this.on(emitMessages.type, asyncHandler((payload_3, _1, _c) => __awaiter(this, [payload_3, _1, _c], void 0, function* (payload, _, { emitMessages }) {
+	        this.on(emitMessages.type, asyncHandler((payload_1, _1, _a) => __awaiter(this, [payload_1, _1, _a], void 0, function* (payload, _, { emitMessages }) {
 	            if (payload.length > 0) {
 	                emitMessages(payload);
 	            }
 	        })));
-	        this.on(emitStatus.type, asyncHandler((payload_4, _2, _d) => __awaiter(this, [payload_4, _2, _d], void 0, function* (payload, _, { emitStatus }) {
+	        this.on(emitStatus.type, asyncHandler((payload_1, _1, _a) => __awaiter(this, [payload_1, _1, _a], void 0, function* (payload, _, { emitStatus }) {
 	            emitStatus(payload);
 	        })));
-	        this.on(receiveReconnect.type, asyncHandler((payload_5, abortSignal_3, _e) => __awaiter(this, [payload_5, abortSignal_3, _e], void 0, function* (payload, abortSignal, { receiveMessages, delay, config }) {
+	        this.on(receiveReconnect.type, asyncHandler((payload_1, abortSignal_1, _a) => __awaiter(this, [payload_1, abortSignal_1, _a], void 0, function* (payload, abortSignal, { receiveMessages, delay, config }) {
 	            if (config.retryConfiguration && config.retryConfiguration.shouldRetry(payload.reason, payload.attempts)) {
 	                abortSignal.throwIfAborted();
 	                yield delay(config.retryConfiguration.getDelay(payload.attempts, payload.reason));
@@ -7699,7 +7699,7 @@
 	                    : 'Unable to complete subscribe messages receive.')));
 	            }
 	        })));
-	        this.on(handshakeReconnect.type, asyncHandler((payload_6, abortSignal_4, _f) => __awaiter(this, [payload_6, abortSignal_4, _f], void 0, function* (payload, abortSignal, { handshake, delay, presenceState, config }) {
+	        this.on(handshakeReconnect.type, asyncHandler((payload_1, abortSignal_1, _a) => __awaiter(this, [payload_1, abortSignal_1, _a], void 0, function* (payload, abortSignal, { handshake, delay, presenceState, config }) {
 	            if (config.retryConfiguration && config.retryConfiguration.shouldRetry(payload.reason, payload.attempts)) {
 	                abortSignal.throwIfAborted();
 	                yield delay(config.retryConfiguration.getDelay(payload.attempts, payload.reason));
@@ -7756,7 +7756,7 @@
 	        groups: event.payload.groups,
 	        cursor: {
 	            timetoken: event.payload.cursor.timetoken,
-	            region: event.payload.cursor.region ? event.payload.cursor.region : (_b = (_a = context === null || context === void 0 ? void 0 : context.cursor) === null || _a === void 0 ? void 0 : _a.region) !== null && _b !== void 0 ? _b : 0,
+	            region: event.payload.cursor.region ? event.payload.cursor.region : ((_b = (_a = context === null || context === void 0 ? void 0 : context.cursor) === null || _a === void 0 ? void 0 : _a.region) !== null && _b !== void 0 ? _b : 0),
 	        },
 	    });
 	});
@@ -12384,7 +12384,6 @@
 	                    uuids: (_c = (_b = spaceParameters.users) === null || _b === void 0 ? void 0 : _b.map((user) => {
 	                        if (typeof user === 'string')
 	                            return user;
-	                        user.userId;
 	                        return { id: user.userId, custom: user.custom };
 	                    })) !== null && _c !== void 0 ? _c : spaceParameters.uuids,
 	                    limit: 0,

diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/dist/web/pubnub.worker.js b/dist/web/pubnub.worker.js
@@ -17,7 +17,7 @@
     OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
     PERFORMANCE OF THIS SOFTWARE.
     ***************************************************************************** */
-    /* global Reflect, Promise, SuppressedError, Symbol */
+    /* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
     function __awaiter(thisArg, _arguments, P, generator) {

diff --git a/lib/core/components/configuration.js b/lib/core/components/configuration.js
@@ -112,7 +112,7 @@ const makeConfiguration = (base, setupCryptoModule) => {
             return base.PubNubFile;
         },
         get version() {
-            return '8.2.9';
+            return '8.2.10';
         },
         getVersion() {
             return this.version;

diff --git a/lib/core/components/token_manager.js b/lib/core/components/token_manager.js
@@ -110,8 +110,6 @@ class TokenManager {
      * @param permissions - Bit-encoded resource permissions.
      *
      * @returns Human-readable resource permissions.
-     *
-     * @internal
      */
     extractPermissions(permissions) {
         const permissionsResult = {

diff --git a/lib/core/pubnub-objects.js b/lib/core/pubnub-objects.js
@@ -537,7 +537,6 @@ class PubNubObjects {
                     uuids: (_c = (_b = spaceParameters.users) === null || _b === void 0 ? void 0 : _b.map((user) => {
                         if (typeof user === 'string')
                             return user;
-                        user.userId;
                         return { id: user.userId, custom: user.custom };
                     })) !== null && _c !== void 0 ? _c : spaceParameters.uuids,
                     limit: 0,

diff --git a/lib/core/utils.js b/lib/core/utils.js
@@ -34,7 +34,7 @@ exports.encodeString = encodeString;
  */
 const encodeNames = (names, defaultString) => {
     const encodedNames = names.map((name) => (0, exports.encodeString)(name));
-    return encodedNames.length ? encodedNames.join(',') : defaultString !== null && defaultString !== void 0 ? defaultString : '';
+    return encodedNames.length ? encodedNames.join(',') : (defaultString !== null && defaultString !== void 0 ? defaultString : '');
 };
 exports.encodeNames = encodeNames;
 /**

diff --git a/lib/event-engine/states/handshake_failed.js b/lib/event-engine/states/handshake_failed.js
@@ -36,7 +36,7 @@ exports.HandshakeFailedState.on(events_1.restore.type, (context, event) => {
         groups: event.payload.groups,
         cursor: {
             timetoken: event.payload.cursor.timetoken,
-            region: event.payload.cursor.region ? event.payload.cursor.region : (_b = (_a = context === null || context === void 0 ? void 0 : context.cursor) === null || _a === void 0 ? void 0 : _a.region) !== null && _b !== void 0 ? _b : 0,
+            region: event.payload.cursor.region ? event.payload.cursor.region : ((_b = (_a = context === null || context === void 0 ? void 0 : context.cursor) === null || _a === void 0 ? void 0 : _a.region) !== null && _b !== void 0 ? _b : 0),
         },
     });
 });

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pubnub",
-  "version": "8.2.9",
+  "version": "8.2.10",
   "author": "PubNub <[email protected]>",
   "description": "Publish & Subscribe Real-time Messaging with PubNub",
   "scripts": {

diff --git a/src/core/components/configuration.ts b/src/core/components/configuration.ts
@@ -171,7 +171,7 @@ export const makeConfiguration = (
       return base.PubNubFile;
     },
     get version(): string {
-      return '8.2.9';
+      return '8.2.10';
     },
     getVersion(): string {
       return this.version;