feat(here-now): add offset parameter for here now

Add a zero-based `offset` index parameter to be used together with `limit` for `here now`
pagination.

Author: parfeon

src/core/endpoints/presence/here_now.ts

@@ -142,8 +142,7 @@ export class HereNowRequest extends AbstractRequest<Presence.HereNowResponse, Se
     this.parameters.queryParameters ??= {};
     this.parameters.includeUUIDs ??= INCLUDE_UUID;
     this.parameters.includeState ??= INCLUDE_STATE;
-    if (this.parameters.limit) this.parameters.limit = Math.min(this.parameters.limit, MAXIMUM_COUNT);
-    else this.parameters.limit = MAXIMUM_COUNT;
+    this.parameters.limit ??= MAXIMUM_COUNT;
   }
 
   operation(): RequestOperation {
@@ -212,10 +211,11 @@ export class HereNowRequest extends AbstractRequest<Presence.HereNowResponse, Se
   }
 
   protected get queryParameters(): Query {
-    const { channelGroups, includeUUIDs, includeState, limit, queryParameters } = this.parameters;
+    const { channelGroups, includeUUIDs, includeState, limit, offset, queryParameters } = this.parameters;
 
     return {
       ...(this.operation() === RequestOperation.PNHereNowOperation ? { limit } : {}),
+      ...(this.operation() === RequestOperation.PNHereNowOperation && (offset ?? 0 > 0) ? { offset } : {}),
       ...(!includeUUIDs! ? { disable_uuids: '1' } : {}),
       ...((includeState ?? false) ? { state: '1' } : {}),
       ...(channelGroups && channelGroups.length > 0 ? { 'channel-group': channelGroups.join(',') } : {}),

src/core/types/api/presence.ts

@@ -195,12 +195,15 @@ export type HereNowParameters = {
   /**
    * Limit the number of results returned.
    *
-   * **Important:** Maximum value is `1000` users per request.
-   *
    * @default `1000`.
    */
   limit?: number;
 
+  /**
+   * Zero-based starting index for pagination.
+   */
+  offset?: number;
+
   /**
    * Additional query parameters.
    */

test/integration/endpoints/presence.test.ts

@@ -444,13 +444,13 @@ describe('presence endpoints', () => {
         .query({
           pnsdk: `PubNub-JS-Nodejs/${pubnub.getVersion()}`,
           uuid: 'myUUID',
-          limit: 1000,
+          limit: 10000,
         })
         .reply(200, '{"status": 200, "message": "OK", "occupancy": 1, "service": "Presence"}', {
           'content-type': 'text/javascript',
         });
 
-      pubnub.hereNow({ channels: ['game1'] }, (status, response) => {
+      pubnub.hereNow({ channels: ['game1'], limit: 10000, offset: 0 }, (status, response) => {
         try {
           assert.equal(status.error, false);
           assert(response !== null);
@@ -477,14 +477,15 @@ describe('presence endpoints', () => {
           pnsdk: `PubNub-JS-Nodejs/${pubnub.getVersion()}`,
           uuid: 'myUUID',
           limit: 1000,
+          offset: 1,
         })
         .reply(
           200,
           '{"status": 200, "message": "OK", "payload": {"channels": {"game1": {"uuids": ["a3ffd012-a3b9-478c-8705-64089f24d71e"], "occupancy": 1}}, "total_channels": 1, "total_occupancy": 1}, "service": "Presence"}',
           { 'content-type': 'text/javascript' },
         );
 
-      pubnub.hereNow({ channels: ['ch1', 'ch2'] }, (status, response) => {
+      pubnub.hereNow({ channels: ['ch1', 'ch2'], offset: 1 }, (status, response) => {
         try {
           assert.equal(status.error, false);
           assert(response !== null);
@@ -560,7 +561,7 @@ describe('presence endpoints', () => {
         .get('/v2/presence/sub-key/mySubscribeKey/channel/ch1,ch2')
         .query({
           pnsdk: `PubNub-JS-Nodejs/${pubnub.getVersion()}`,
-          limit: 1000,
+          limit: 10000,
           uuid: 'myUUID',
         })
         .reply(