docs: snippet for pubnub apis. (#458)

* docs snippets for publish-subscribe, presence, message-persistence, app-context, mobile-push, access-manager, channel-groups.

* fix: lint issue.

* removed deprecation from deleteMessages()

* code snippets for documentation. A separate file for impot and initialisation.

* configuration code snippets

* script to compile check the code snippets

* fix: snippet compilation for lowest node version and build generated before snippet compilation happens

* added missing iterativelyUpdateExistingMetadata

* example with promises syntax demo

* missing SubscriptionSet subscribe() basic usage example

* added missing subscriptionSet example code snippets

* added getFilterExpresssionBasicusage

* revert changes of providing return type for addSubscriptionSet() method on subscriptionSet entity

* added getting started code snippets

* added missing generic listener syntax example

* fix snippets indentation, GrantToken type fix by removing objects syntax support,
Error handling refactor in code snippets

* additional information about send file code snippet in node.js

* * address Codacy quality checks suggestions.
* Indentation as per other code base

* Codacy suggestions

* lint: codacy suggestion

* removed deprected warning from deleteMessages API

* added snippet for connect, disconnect and delete proxy

* code snippets: formating setToken strings

* fix dummy token length related format issue.

* code snippet: error handling, additional comments

* details about exception in getting started example.

* PubNub SDK v9.6.2 release.

---------

Co-authored-by: Mohit Tejani <[email protected]>
Co-authored-by: PubNub Release Bot <[email protected]>

Author: 3 people

.github/workflows/run-tests.yml

@@ -50,6 +50,9 @@ jobs:
         run: |
           npm install
           npm run ${{ matrix.env }}
+      - name: Test docs snippets syntax
+        if: matrix.node == '18.18.0' && matrix.env == 'ci:node'
+        run: npm run test:snippets
       - name: Cancel workflow runs for commit on error
         if: failure()
         uses: ./.github/.release/actions/actions/utils/fast-jobs-failure

.pubnub.yml

@@ -1,5 +1,12 @@
 ---
 changelog:
+  - date: 2025-06-30
+    version: v9.6.2
+    changes:
+      - type: improvement
+        text: "Removed deprecation warning from deleteMessages method."
+      - type: improvement
+        text: "Added code snippets for docs."
   - date: 2025-06-18
     version: v9.6.1
     changes:
@@ -1256,7 +1263,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '9.6.1'
+version: '9.6.2'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1272,7 +1279,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.6.1.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.6.2.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1943,7 +1950,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v9.6.1/pubnub.9.6.1.js
+            location: https://github.com/pubnub/javascript/releases/download/v9.6.2/pubnub.9.6.2.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v9.6.2
+June 30 2025
+
+#### Modified
+- Removed deprecation warning from deleteMessages method.
+- Added code snippets for docs.
+
 ## v9.6.1
 June 18 2025
 

README.md

@@ -27,8 +27,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.9.6.1.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.6.1.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.6.2.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.6.2.min.js
 
 2. Configure your keys:
 

dist/web/pubnub.js

@@ -4957,7 +4957,7 @@
 	            return base.PubNubFile;
 	        },
 	        get version() {
-	            return '9.6.1';
+	            return '9.6.2';
 	        },
 	        getVersion() {
 	            return this.version;
@@ -16170,7 +16170,6 @@
 	     *
 	     * @returns Asynchronous delete messages response or `void` in case if `callback` provided.
 	     *
-	     * @deprecated
 	     */
 	    deleteMessages(parameters, callback) {
 	        return __awaiter(this, void 0, void 0, function* () {

dist/web/pubnub.min.js

@@ -0,0 +1,132 @@
+import PubNub, { PubNubError } from '../lib/types';
+
+const pubnub = new PubNub({
+  publishKey: 'demo',
+  subscribeKey: 'demo',
+  userId: 'myUniqueUserId',
+});
+
+// snippet.grantTokenVariousResources
+try {
+  const token = await pubnub.grantToken({
+    ttl: 15,
+    authorized_uuid: 'my-authorized-uuid',
+    resources: {
+      channels: {
+        'channel-a': {
+          read: true,
+        },
+        'channel-b': {
+          read: true,
+          write: true,
+        },
+        'channel-c': {
+          read: true,
+          write: true,
+        },
+        'channel-d': {
+          read: true,
+          write: true,
+        },
+      },
+      groups: {
+        'channel-group-b': {
+          read: true,
+        },
+      },
+      uuids: {
+        'uuid-c': {
+          get: true,
+        },
+        'uuid-d': {
+          get: true,
+          update: true,
+        },
+      },
+    },
+  });
+} catch (error) {
+  console.error(
+    `Grant token error: ${error}.${
+      (error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''
+    }`,
+  );
+}
+// snippet.end
+
+// snippet.grantTokenUsingRegEx
+try {
+  const token = await pubnub.grantToken({
+    ttl: 15,
+    authorized_uuid: 'my-authorized-uuid',
+    patterns: {
+      channels: {
+        '^channel-[A-Za-z0-9]$': {
+          read: true,
+        },
+      },
+    },
+  });
+} catch (error) {
+  console.error(
+    `Grant token error: ${error}.${
+      (error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''
+    }`,
+  );
+}
+// snippet.end
+
+// snippet.grantTokenRegExAndResources
+try {
+  const token = await pubnub.grantToken({
+    ttl: 15,
+    authorized_uuid: 'my-authorized-uuid',
+    resources: {
+      channels: {
+        'channel-a': {
+          read: true,
+        },
+        'channel-b': {
+          read: true,
+          write: true,
+        },
+        'channel-c': {
+          read: true,
+          write: true,
+        },
+        'channel-d': {
+          read: true,
+          write: true,
+        },
+      },
+      groups: {
+        'channel-group-b': {
+          read: true,
+        },
+      },
+      uuids: {
+        'uuid-c': {
+          get: true,
+        },
+        'uuid-d': {
+          get: true,
+          update: true,
+        },
+      },
+    },
+    patterns: {
+      channels: {
+        '^channel-[A-Za-z0-9]$': {
+          read: true,
+        },
+      },
+    },
+  });
+} catch (error) {
+  console.error(
+    `Grant token error: ${error}.${
+      (error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''
+    }`,
+  );
+}
+// snippet.end

docs-snippets/access-manager.ts

@@ -0,0 +1,59 @@
+import PubNub, { PubNubError } from '../lib/types';
+
+const pubnub = new PubNub({
+  publishKey: 'demo',
+  subscribeKey: 'demo',
+  userId: 'myUniqueUserId',
+});
+
+// snippet.iterativelyUpdateExistingMetadata
+const channel = 'team.red';
+const name = 'Red Team';
+const description = 'The channel for Red team.';
+const customField = { visible: 'team' };
+
+// Function to set and then update channel metadata
+try {
+  const response = await pubnub.objects.setChannelMetadata({
+    channel: channel,
+    data: {
+      name: name,
+      description: description,
+      custom: customField,
+    },
+  });
+  console.log('The channel has been created with name and description.\n');
+
+  // Fetch current object with custom fields
+  const currentObjectResponse = await pubnub.objects.getChannelMetadata({
+    channel: channel,
+    include: {
+      customFields: true,
+    },
+  });
+  const currentObject = currentObjectResponse.data;
+
+  // Initialize the custom field object
+  const custom = currentObject.custom || {};
+
+  // Add or update the field
+  custom['edit'] = 'admin';
+
+  // Writing the updated object back to the server
+  const setResponse = await pubnub.objects.setChannelMetadata({
+    channel: channel,
+    data: {
+      name: currentObject.name || '',
+      description: currentObject.description || '',
+      custom: custom,
+    },
+  });
+  console.log('Object has been updated', setResponse);
+} catch (error) {
+  console.error(
+    `Set channel metadata error: ${error}.${
+      (error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''
+    }`,
+  );
+}
+// snippet.end

docs-snippets/app-context.ts

@@ -0,0 +1,52 @@
+import PubNub, { PubNubError } from '../../lib/types';
+
+const pubnub = new PubNub({
+  publishKey: 'demo',
+  subscribeKey: 'demo',
+  userId: 'myUniqueUserId',
+});
+
+// snippet.accessManagerBasicUsage
+// Function to use grantToken method
+try {
+  const token = await pubnub.grantToken({
+    ttl: 15,
+    authorized_uuid: 'my-authorized-uuid',
+    resources: {
+      channels: {
+        'my-channel': {
+          read: true,
+          write: true,
+        },
+      },
+    },
+  });
+  console.log('Granted Token:', token);
+} catch (error) {
+  console.error(
+    `Grant token error: ${error}.${
+      (error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''
+    }`,
+  );
+}
+// snippet.end
+
+// snippet.revokeTokenBasicUsage
+try {
+  const response = await pubnub.revokeToken('p0AkFl043rhDdHRsple3KgQ3NwY6BDcENnctokenVzcqBDczaWdYIGOAeTyWGJI');
+} catch (error) {
+  console.error(
+    `Revoke token error: ${error}.${
+      (error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''
+    }`,
+  );
+}
+// snippet.end
+
+// snippet.parseTokenBasicUsage
+pubnub.parseToken('use-token-string-generated-by-grantToken()');
+// snippet.end
+
+// snippet.setTokenBasicUsage
+pubnub.setToken('use-token-string-generated-by-grantToken()');
+// snippet.end