@adobe/spacecat-shared-rum-api-client 1.6.2 → 1.6.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.6.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.3...@adobe/spacecat-shared-rum-api-client-v1.6.4) (2024-02-27)
+
+
+### Bug Fixes
+
+* create404Backlink and createRUMBacklink documentation  ([#165](https://github.com/adobe/spacecat-shared/issues/165)) ([418ec68](https://github.com/adobe/spacecat-shared/commit/418ec68a1cabf22054688342438dcf2ea60acf38))
+
+# [@adobe/spacecat-shared-rum-api-client-v1.6.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.2...@adobe/spacecat-shared-rum-api-client-v1.6.3) (2024-02-27)
+
+
+### Bug Fixes
+
+* add backlink params ([cbf715d](https://github.com/adobe/spacecat-shared/commit/cbf715d2e04762a8e8fb40bb7daca7f6f9df193a))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.6.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.1...@adobe/spacecat-shared-rum-api-client-v1.6.2) (2024-02-21)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "1.6.2",
+  "version": "1.6.4",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -14,11 +14,23 @@ import { UniversalContext } from '@adobe/helix-universal';
 
 export interface RUMAPIOptions {
   interval?: number;
+  startdate?: string,
+  enddate?: string,
   offset?: number;
   limit?: number;
   url?: string;
 }
 
+export interface RUMDashboardOptions {
+  interval?: number;
+  startdate?: string,
+  enddate?: string,
+  offset?: number;
+  limit?: number;
+  domainkey?: string,
+  url?: string;
+}
+
 export default class RUMAPIClient {
   /**
    * Static factory method to create an instance of RUMAPIClient.
@@ -42,21 +54,23 @@ export default class RUMAPIClient {
    * Asynchronous method to create a RUM backlink.
    * @param {string} url - A string representing the URL for the backlink.
    * @param {number} expiry - An integer representing the expiry value for the backlink.
+   * @param {RUMDashboardOptions} params - An object representing the parameters to be included
    * @returns A Promise resolving to a string representing url of the created backlink.
    * @remarks This method creates a backlink to the RUM dashboard, allowing users
    *   to view their reports and monitor real user activities.
    */
-  createRUMBacklink(url: string, expiry: number): Promise<string>;
+  createRUMBacklink(url: string, expiry: number, params?: RUMDashboardOptions): Promise<string>;
 
   /**
    * Asynchronous method to create a 404 backlink.
    * @param {string} url - A string representing the URL for the backlink.
    * @param {number} expiry - An integer representing the expiry value for the backlink.
+   * @param {RUMDashboardOptions} params - An object representing the parameters to be included
    * @returns A Promise resolving to a string representing url of the created backlink.
    * @remarks This method creates a backlink to the 404 report, allowing users
    *   to view their 404 pages.
    */
-  create404Backlink(url: string, expiry: number): Promise<string>;
+  create404Backlink(url: string, expiry: number, params?: RUMDashboardOptions): Promise<string>;
 
   /**
    * Asynchronous method to return the RUM dashboard API call response data.

package/src/index.js

@@ -88,9 +88,16 @@ async function generateDomainKey(domainkey, url, expiry) {
   return data[0].key;
 }
 
-async function createBacklink(dashboardUrl, domainKey, domainUrl, expiry) {
+async function createBacklink(dashboardUrl, domainKey, domainUrl, expiry, params) {
   const scopedDomainKey = await generateDomainKey(domainKey, domainUrl, expiry);
-  return `${dashboardUrl}?interval=${expiry}&offset=0&limit=100&url=${domainUrl}&domainkey=${scopedDomainKey}`;
+  return createUrl(dashboardUrl, {
+    offset: 0,
+    limit: 100,
+    url: domainUrl,
+    domainkey: scopedDomainKey,
+    interval: expiry,
+    ...params,
+  });
 }
 
 export default class RUMAPIClient {
@@ -160,11 +167,23 @@ export default class RUMAPIClient {
     return data.map((row) => row.hostname);
   }
 
-  async createRUMBacklink(url, expiry) {
-    return createBacklink(APIS.RUM_DASHBOARD_UI, this.domainkey, url, expiry);
+  async createRUMBacklink(url, expiry, params) {
+    return createBacklink(
+      APIS.RUM_DASHBOARD_UI,
+      this.domainkey,
+      url,
+      expiry,
+      params,
+    );
   }
 
-  async create404Backlink(url, expiry) {
-    return createBacklink(APIS.NOT_FOUND_DASHBOARD_UI, this.domainkey, url, expiry);
+  async create404Backlink(url, expiry, params) {
+    return createBacklink(
+      APIS.NOT_FOUND_DASHBOARD_UI,
+      this.domainkey,
+      url,
+      expiry,
+      params,
+    );
   }
 }