data sync

.github/workflows/run-tests.yml

@@ -16,6 +16,10 @@ 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 }}
+  DS_ORIGIN: ${{ secrets.SDK_DS_ORIGIN }}
 
 jobs:
   tests:

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/token_manager.js

@@ -47,6 +47,7 @@ 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) : [];
@@ -80,6 +81,9 @@ 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 channelPatterns = channelPatternPermissions.length > 0;
             const groupPatterns = groupPatternPermissions.length > 0;
@@ -98,6 +102,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 +144,49 @@ 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.extractDataSyncPermissions(permissions[id])));
+        });
+        return result;
+    }
+    /**
+     * Extract DataSync resource access permission information.
+     *
+     * @param permissions - Bit-encoded resource permissions.
+     *
+     * @returns Human-readable DataSync resource permissions.
+     */
+    extractDataSyncPermissions(permissions) {
+        return {
+            create: (permissions & 16) === 16,
+            get: (permissions & 32) === 32,
+            update: (permissions & 64) === 64,
+            delete: (permissions & 8) === 8,
+        };
+    }
 }
 exports.TokenManager = TokenManager;

lib/core/constants/operations.js

@@ -145,6 +145,129 @@ var RequestOperation;
      */
     RequestOperation["PNSetMembershipsOperation"] = "PNSetMembershipsOperation";
     // --------------------------------------------------------
+    // ------------------- DataSync API ----------------------
+    // --------------------------------------------------------
+    /**
+     * Create entity REST API operation.
+     */
+    RequestOperation["PNCreateDataSyncEntityOperation"] = "PNCreateDataSyncEntityOperation";
+    /**
+     * Get entity REST API operation.
+     */
+    RequestOperation["PNGetDataSyncEntityOperation"] = "PNGetDataSyncEntityOperation";
+    /**
+     * Get all entities REST API operation.
+     */
+    RequestOperation["PNGetDataSyncEntitiesOperation"] = "PNGetDataSyncEntitiesOperation";
+    /**
+     * Set entity REST API operation (full replacement via PUT).
+     */
+    RequestOperation["PNSetDataSyncEntityOperation"] = "PNSetDataSyncEntityOperation";
+    /**
+     * Update entity REST API operation (partial update via PATCH).
+     */
+    RequestOperation["PNUpdateDataSyncEntityOperation"] = "PNUpdateDataSyncEntityOperation";
+    /**
+     * Remove entity REST API operation.
+     */
+    RequestOperation["PNRemoveDataSyncEntityOperation"] = "PNRemoveDataSyncEntityOperation";
+    /**
+     * Create relationship REST API operation.
+     */
+    RequestOperation["PNCreateDataSyncRelationshipOperation"] = "PNCreateDataSyncRelationshipOperation";
+    /**
+     * Get relationship REST API operation.
+     */
+    RequestOperation["PNGetDataSyncRelationshipOperation"] = "PNGetDataSyncRelationshipOperation";
+    /**
+     * Get all relationships REST API operation.
+     */
+    RequestOperation["PNGetDataSyncRelationshipsOperation"] = "PNGetDataSyncRelationshipsOperation";
+    /**
+     * Set relationship REST API operation (full replacement via PUT).
+     */
+    RequestOperation["PNSetDataSyncRelationshipOperation"] = "PNSetDataSyncRelationshipOperation";
+    /**
+     * Update relationship REST API operation (partial update via PATCH).
+     */
+    RequestOperation["PNUpdateDataSyncRelationshipOperation"] = "PNUpdateDataSyncRelationshipOperation";
+    /**
+     * Remove relationship REST API operation.
+     */
+    RequestOperation["PNRemoveDataSyncRelationshipOperation"] = "PNRemoveDataSyncRelationshipOperation";
+    /**
+     * Create user REST API operation.
+     */
+    RequestOperation["PNCreateDataSyncUserOperation"] = "PNCreateDataSyncUserOperation";
+    /**
+     * Get user REST API operation.
+     */
+    RequestOperation["PNGetDataSyncUserOperation"] = "PNGetDataSyncUserOperation";
+    /**
+     * Get all users REST API operation.
+     */
+    RequestOperation["PNGetDataSyncUsersOperation"] = "PNGetDataSyncUsersOperation";
+    /**
+     * Set user REST API operation (full replacement via PUT).
+     */
+    RequestOperation["PNSetDataSyncUserOperation"] = "PNSetDataSyncUserOperation";
+    /**
+     * Update user REST API operation (partial update via PATCH).
+     */
+    RequestOperation["PNUpdateDataSyncUserOperation"] = "PNUpdateDataSyncUserOperation";
+    /**
+     * Remove user REST API operation.
+     */
+    RequestOperation["PNRemoveDataSyncUserOperation"] = "PNRemoveDataSyncUserOperation";
+    /**
+     * Create channel REST API operation.
+     */
+    RequestOperation["PNCreateDataSyncChannelOperation"] = "PNCreateDataSyncChannelOperation";
+    /**
+     * Get channel REST API operation.
+     */
+    RequestOperation["PNGetDataSyncChannelOperation"] = "PNGetDataSyncChannelOperation";
+    /**
+     * Get all channels REST API operation.
+     */
+    RequestOperation["PNGetDataSyncChannelsOperation"] = "PNGetDataSyncChannelsOperation";
+    /**
+     * Set channel REST API operation (full replacement via PUT).
+     */
+    RequestOperation["PNSetDataSyncChannelOperation"] = "PNSetDataSyncChannelOperation";
+    /**
+     * Update channel REST API operation (partial update via PATCH).
+     */
+    RequestOperation["PNUpdateDataSyncChannelOperation"] = "PNUpdateDataSyncChannelOperation";
+    /**
+     * Remove channel REST API operation.
+     */
+    RequestOperation["PNRemoveDataSyncChannelOperation"] = "PNRemoveDataSyncChannelOperation";
+    /**
+     * Create membership REST API operation.
+     */
+    RequestOperation["PNCreateDataSyncMembershipOperation"] = "PNCreateDataSyncMembershipOperation";
+    /**
+     * Get membership REST API operation.
+     */
+    RequestOperation["PNGetDataSyncMembershipOperation"] = "PNGetDataSyncMembershipOperation";
+    /**
+     * Get all memberships REST API operation.
+     */
+    RequestOperation["PNGetDataSyncMembershipsOperation"] = "PNGetDataSyncMembershipsOperation";
+    /**
+     * Set membership REST API operation (full replacement via PUT).
+     */
+    RequestOperation["PNSetDataSyncMembershipOperation"] = "PNSetDataSyncMembershipOperation";
+    /**
+     * Update membership REST API operation (partial update via PATCH).
+     */
+    RequestOperation["PNUpdateDataSyncMembershipOperation"] = "PNUpdateDataSyncMembershipOperation";
+    /**
+     * Remove membership REST API operation.
+     */
+    RequestOperation["PNRemoveDataSyncMembershipOperation"] = "PNRemoveDataSyncMembershipOperation";
+    // --------------------------------------------------------
     // -------------------- File Upload API -------------------
     // --------------------------------------------------------
     /**