data sync

.github/workflows/run-tests.yml

@@ -16,6 +16,9 @@ env:
   PAM_SECRET_KEY: ${{ secrets.SDK_PAM_SEC_KEY }}
   SUBSCRIBE_KEY: ${{ secrets.SDK_SUB_KEY }}
   PUBLISH_KEY: ${{ secrets.SDK_PUB_KEY }}
+  DS_SUBSCRIBE_KEY: ${{ secrets.SDK_DS_SUB_KEY }}
+  DS_PUBLISH_KEY: ${{ secrets.SDK_DS_PUB_KEY }}
+  DS_SECRET_KEY: ${{ secrets.SDK_DS_SEC_KEY }}
 
 jobs:
   tests:

.pubnub.yml

@@ -1415,6 +1415,41 @@ features:
     - FILES-DOWNLOAD-FILE
   time:
     - TIME-TIME
+  data-sync:
+    - DATASYNC-USER-CREATE
+    - DATASYNC-USER-GET
+    - DATASYNC-USER-GET-ALL
+    - DATASYNC-USER-UPDATE
+    - DATASYNC-USER-PATCH
+    - DATASYNC-USER-DELETE
+    - DATASYNC-CHANNEL-CREATE
+    - DATASYNC-CHANNEL-GET
+    - DATASYNC-CHANNEL-GET-ALL
+    - DATASYNC-CHANNEL-UPDATE
+    - DATASYNC-CHANNEL-PATCH
+    - DATASYNC-CHANNEL-DELETE
+    - DATASYNC-MEMBERSHIP-CREATE
+    - DATASYNC-MEMBERSHIP-GET
+    - DATASYNC-MEMBERSHIP-GET-ALL
+    - DATASYNC-MEMBERSHIP-UPDATE
+    - DATASYNC-MEMBERSHIP-PATCH
+    - DATASYNC-MEMBERSHIP-DELETE
+    - DATASYNC-ENTITY-CREATE
+    - DATASYNC-ENTITY-GET
+    - DATASYNC-ENTITY-GET-ALL
+    - DATASYNC-ENTITY-UPDATE
+    - DATASYNC-ENTITY-PATCH
+    - DATASYNC-ENTITY-DELETE
+    - DATASYNC-RELATIONSHIP-CREATE
+    - DATASYNC-RELATIONSHIP-GET
+    - DATASYNC-RELATIONSHIP-GET-ALL
+    - DATASYNC-RELATIONSHIP-UPDATE
+    - DATASYNC-RELATIONSHIP-PATCH
+    - DATASYNC-RELATIONSHIP-DELETE
+    - DATASYNC-FILTERING
+    - DATASYNC-SORTING
+    - DATASYNC-EVENTS-LISTENER
+    - DATASYNC-ACCESS-MANAGER
   others:
     - TELEMETRY
     - CREATE-PUSH-PAYLOAD

dist/web/pubnub.worker.js

@@ -1861,6 +1861,10 @@
          * Request will be sent using `PATCH` method.
          */
         TransportMethod["PATCH"] = "PATCH";
+        /**
+         * Request will be sent using `PUT` method.
+         */
+        TransportMethod["PUT"] = "PUT";
         /**
          * Request will be sent using `DELETE` method.
          */

lib/core/components/event-dispatcher.js

@@ -98,6 +98,15 @@ class EventDispatcher {
     set onFile(listener) {
         this.updateTypeOrObjectListener({ add: !!listener, listener, type: 'file' });
     }
+    /**
+     * Set a new DataSync event handler.
+     *
+     * @param listener - Listener function, which will be called each time when a new
+     * DataSync event is received from the real-time network.
+     */
+    set onDataSync(listener) {
+        this.updateTypeOrObjectListener({ add: !!listener, listener, type: 'dataSync' });
+    }
     /**
      * Dispatch received a real-time update.
      *
@@ -140,6 +149,8 @@ class EventDispatcher {
             this.announce('messageAction', event.data);
         else if (event.type === subscribe_1.PubNubEventType.Files)
             this.announce('file', event.data);
+        else if (event.type === subscribe_1.PubNubEventType.DataSync)
+            this.announce('dataSync', event.data);
     }
     /**
      * Dispatch received connection status change.

lib/core/components/request.js

@@ -116,7 +116,9 @@ class AbstractRequest {
         if (headers)
             request.headers = headers;
         // Attach body (if required).
-        if (request.method === transport_request_1.TransportMethod.POST || request.method === transport_request_1.TransportMethod.PATCH) {
+        if (request.method === transport_request_1.TransportMethod.POST ||
+            request.method === transport_request_1.TransportMethod.PATCH ||
+            request.method === transport_request_1.TransportMethod.PUT) {
             const [body, formData] = [this.body, this.formData];
             if (formData)
                 request.formData = formData;

lib/core/components/retry-policy.js

@@ -5,6 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RetryPolicy = exports.Endpoint = void 0;
 const categories_1 = __importDefault(require("../constants/categories"));
+/**
+ * HTTP status codes which represent definitive client-side outcomes and shouldn't be retried.
+ *
+ * @internal
+ */
+const NON_RETRIABLE_STATUS_CODES = [404, 409];
 // --------------------------------------------------------
 // ------------------------ Types -------------------------
 // --------------------------------------------------------
@@ -122,7 +128,7 @@ var Endpoint;
 class RetryPolicy {
     static None() {
         return {
-            shouldRetry(_request, _response, _errorCategory, _attempt) {
+            shouldRetry(_request, _response, _errorCategory, _attempt, _statusCode) {
                 return false;
             },
             getDelay(_attempt, _response) {
@@ -139,8 +145,8 @@ class RetryPolicy {
             delay: configuration.delay,
             maximumRetry: configuration.maximumRetry,
             excluded: (_a = configuration.excluded) !== null && _a !== void 0 ? _a : [],
-            shouldRetry(request, response, error, attempt) {
-                return isRetriableRequest(request, response, error, attempt !== null && attempt !== void 0 ? attempt : 0, this.maximumRetry, this.excluded);
+            shouldRetry(request, response, error, attempt, statusCode) {
+                return isRetriableRequest(request, response, error, attempt !== null && attempt !== void 0 ? attempt : 0, this.maximumRetry, this.excluded, statusCode);
             },
             getDelay(_, response) {
                 let delay = -1;
@@ -163,8 +169,8 @@ class RetryPolicy {
             maximumDelay: configuration.maximumDelay,
             maximumRetry: configuration.maximumRetry,
             excluded: (_a = configuration.excluded) !== null && _a !== void 0 ? _a : [],
-            shouldRetry(request, response, error, attempt) {
-                return isRetriableRequest(request, response, error, attempt !== null && attempt !== void 0 ? attempt : 0, this.maximumRetry, this.excluded);
+            shouldRetry(request, response, error, attempt, statusCode) {
+                return isRetriableRequest(request, response, error, attempt !== null && attempt !== void 0 ? attempt : 0, this.maximumRetry, this.excluded, statusCode);
             },
             getDelay(attempt, response) {
                 let delay = -1;
@@ -191,12 +197,15 @@ exports.RetryPolicy = RetryPolicy;
  * @param retryAttempt - Current retry attempt.
  * @param maximumRetry - Maximum retry attempts count according to the retry policy.
  * @param excluded - List of endpoints for which retry policy won't be applied.
+ * @param statusCode - Response HTTP status code (available when request failed with an error and hence there is no
+ * `res`).
  *
  * @return `true` if request can be retried.
  *
  * @internal
  */
-const isRetriableRequest = (req, res, errorCategory, retryAttempt, maximumRetry, excluded) => {
+const isRetriableRequest = (req, res, errorCategory, retryAttempt, maximumRetry, excluded, statusCode) => {
+    var _a;
     if (errorCategory) {
         if (errorCategory === categories_1.default.PNCancelledCategory ||
             errorCategory === categories_1.default.PNBadRequestCategory ||
@@ -207,6 +216,10 @@ const isRetriableRequest = (req, res, errorCategory, retryAttempt, maximumRetry,
         return false;
     else if (retryAttempt > maximumRetry)
         return false;
+    // Status code is reported separately from the `res` when the request failed with an error.
+    const status = (_a = res === null || res === void 0 ? void 0 : res.status) !== null && _a !== void 0 ? _a : statusCode;
+    if (status !== undefined && NON_RETRIABLE_STATUS_CODES.includes(status))
+        return false;
     return res ? res.status === 429 || res.status >= 500 : true;
 };
 /**

lib/core/components/token_manager.js

@@ -47,12 +47,15 @@ class TokenManager {
      * @returns Information about resources and permissions which has been granted for them.
      */
     parseToken(tokenString) {
+        var _a, _b;
         const parsed = this.cbor.decodeToken(tokenString);
         if (parsed !== undefined) {
             const uuidResourcePermissions = parsed.res.uuid ? Object.keys(parsed.res.uuid) : [];
+            const userResourcePermissions = parsed.res.usr ? Object.keys(parsed.res.usr) : [];
             const channelResourcePermissions = Object.keys(parsed.res.chan);
             const groupResourcePermissions = Object.keys(parsed.res.grp);
             const uuidPatternPermissions = parsed.pat.uuid ? Object.keys(parsed.pat.uuid) : [];
+            const userPatternPermissions = parsed.pat.usr ? Object.keys(parsed.pat.usr) : [];
             const channelPatternPermissions = Object.keys(parsed.pat.chan);
             const groupPatternPermissions = Object.keys(parsed.pat.grp);
             const result = {
@@ -63,14 +66,19 @@ class TokenManager {
                 signature: parsed.sig,
             };
             const uuidResources = uuidResourcePermissions.length > 0;
+            const userResources = userResourcePermissions.length > 0;
             const channelResources = channelResourcePermissions.length > 0;
             const groupResources = groupResourcePermissions.length > 0;
-            if (uuidResources || channelResources || groupResources) {
+            if (uuidResources || userResources || channelResources || groupResources) {
                 result.resources = {};
                 if (uuidResources) {
                     const uuids = (result.resources.uuids = {});
                     uuidResourcePermissions.forEach((id) => (uuids[id] = this.extractPermissions(parsed.res.uuid[id])));
                 }
+                if (userResources) {
+                    const users = (result.resources.users = {});
+                    userResourcePermissions.forEach((id) => (users[id] = this.extractCrudPermissions(parsed.res.usr[id])));
+                }
                 if (channelResources) {
                     const channels = (result.resources.channels = {});
                     channelResourcePermissions.forEach((id) => (channels[id] = this.extractPermissions(parsed.res.chan[id])));
@@ -80,15 +88,23 @@ class TokenManager {
                     groupResourcePermissions.forEach((id) => (groups[id] = this.extractPermissions(parsed.res.grp[id])));
                 }
             }
+            const resourceDataSync = this.extractDataSyncScopes(parsed.res);
+            if (resourceDataSync)
+                ((_a = result.resources) !== null && _a !== void 0 ? _a : (result.resources = {})).dataSync = resourceDataSync;
             const uuidPatterns = uuidPatternPermissions.length > 0;
+            const userPatterns = userPatternPermissions.length > 0;
             const channelPatterns = channelPatternPermissions.length > 0;
             const groupPatterns = groupPatternPermissions.length > 0;
-            if (uuidPatterns || channelPatterns || groupPatterns) {
+            if (uuidPatterns || userPatterns || channelPatterns || groupPatterns) {
                 result.patterns = {};
                 if (uuidPatterns) {
                     const uuids = (result.patterns.uuids = {});
                     uuidPatternPermissions.forEach((id) => (uuids[id] = this.extractPermissions(parsed.pat.uuid[id])));
                 }
+                if (userPatterns) {
+                    const users = (result.patterns.users = {});
+                    userPatternPermissions.forEach((id) => (users[id] = this.extractCrudPermissions(parsed.pat.usr[id])));
+                }
                 if (channelPatterns) {
                     const channels = (result.patterns.channels = {});
                     channelPatternPermissions.forEach((id) => (channels[id] = this.extractPermissions(parsed.pat.chan[id])));
@@ -98,6 +114,9 @@ class TokenManager {
                     groupPatternPermissions.forEach((id) => (groups[id] = this.extractPermissions(parsed.pat.grp[id])));
                 }
             }
+            const patternDataSync = this.extractDataSyncScopes(parsed.pat);
+            if (patternDataSync)
+                ((_b = result.patterns) !== null && _b !== void 0 ? _b : (result.patterns = {})).dataSync = patternDataSync;
             if (parsed.meta && Object.keys(parsed.meta).length > 0)
                 result.meta = parsed.meta;
             return result;
@@ -137,5 +156,53 @@ class TokenManager {
             permissionsResult.read = true;
         return permissionsResult;
     }
+    /**
+     * Extract DataSync permission scopes from a token permissions section.
+     *
+     * The `datasync:*` wire keys are only present for tokens which granted DataSync permissions, so a
+     * result is returned only when at least one scope carries permissions.
+     *
+     * @param section - Raw `res` or `pat` permissions section decoded from the token.
+     *
+     * @returns Human-readable DataSync permission scopes, or `undefined` when none are granted.
+     */
+    extractDataSyncScopes(section) {
+        const dataSyncScopes = [
+            ['entities', 'datasync:entities'],
+            ['relationships', 'datasync:relationships'],
+            ['memberships', 'datasync:memberships'],
+        ];
+        let result;
+        dataSyncScopes.forEach(([scope, wireKey]) => {
+            const permissions = section[wireKey];
+            if (!permissions)
+                return;
+            const ids = Object.keys(permissions);
+            if (ids.length === 0)
+                return;
+            const scopeResult = ((result !== null && result !== void 0 ? result : (result = {}))[scope] = {});
+            ids.forEach((id) => (scopeResult[id] = this.extractCrudPermissions(permissions[id])));
+        });
+        return result;
+    }
+    /**
+     * Extract CRUD-only access permission information.
+     *
+     * Shared by the `usr` wire key (which backs the `users` grant scope) and the `datasync:*` wire
+     * keys — both carry the same CRUD bit layout and none of the `read` / `write` / `manage` / `join`
+     * bits decoded by {@link extractPermissions}.
+     *
+     * @param permissions - Bit-encoded resource permissions.
+     *
+     * @returns Human-readable CRUD resource permissions.
+     */
+    extractCrudPermissions(permissions) {
+        return {
+            create: (permissions & 16) === 16,
+            get: (permissions & 32) === 32,
+            update: (permissions & 64) === 64,
+            delete: (permissions & 8) === 8,
+        };
+    }
 }
 exports.TokenManager = TokenManager;