@adobe/spacecat-shared-rum-api-client 1.1.2 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.2.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.1.2...@adobe/spacecat-shared-rum-api-client-v1.2.0) (2023-12-15)
+
+
+### Features
+
+* add support for 404 report backlink ([0d622de](https://github.com/adobe-rnd/spacecat-shared/commit/0d622de241b51f0df625679591dd5168b5b070a7))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.1.2](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.1.1...@adobe/spacecat-shared-rum-api-client-v1.1.2) (2023-12-14)
 
 

package/README.md

@@ -29,13 +29,23 @@ const domainKey = "your-domain-key";
 const rumApiClient = new RUMAPIClient(domainKey);
 ```
 
-### Creating a Backlink
+### Creating a RUM Backlink
 
 ```js
 const url = "https://example.com";
-const expiry = 7; // in days
+const expiryInDays = 7;
 
-const backlink = await rumApiClient.createBacklink(url, expiry);
+const backlink = await rumApiClient.createRUMBacklink(url, expiryInDays);
+console.log(`Backlink created: ${backlink}`)
+```
+
+### Creating a 404 Report Backlink
+
+```js
+const url = "https://example.com";
+const expiryInDays = 7;
+
+const backlink = await rumApiClient.create404Backlink(url, expiryInDays);
 console.log(`Backlink created: ${backlink}`)
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",
@@ -42,6 +42,6 @@
     "nock": "13.4.0",
     "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
-    "typescript": "5.3.2"
+    "typescript": "5.3.3"
   }
 }

package/src/index.d.ts

@@ -16,6 +16,7 @@ export interface RUMAPIOptions {
   interval: number;
   offset: number;
   limit: number;
+  url: string;
 }
 
 export default class RUMAPIClient {
@@ -38,14 +39,24 @@ export default class RUMAPIClient {
   constructor(domainkey: string);
 
   /**
-   * Asynchronous method to create a backlink.
+   * 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.
    * @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.
    */
-  createBacklink(url: string, expiry: number): Promise<string>;
+  createRUMBacklink(url: string, expiry: number): 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.
+   * @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>;
 
   /**
    * Asynchronous method to return the RUM dashboard API call response data.

package/src/index.js

@@ -18,6 +18,7 @@ import { fetch } from './utils.js';
 const APIS = {
   ROTATE_DOMAINKEYS: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rotate-domainkeys',
   RUM_DASHBOARD_UI: 'https://main--franklin-dashboard--adobe.hlx.live/views/rum-dashboard',
+  NOT_FOUND_DASHBOARD_UI: 'https://main--franklin-dashboard--adobe.hlx.live/views/404-report',
   RUM_DASHBOARD: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-dashboard',
   DOMAIN_LIST: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/dash/domain-list',
   RUM_SOURCES: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-sources',
@@ -81,6 +82,11 @@ async function generateDomainKey(domainkey, url, expiry) {
   return data[0].key;
 }
 
+async function createBacklink(dashboardUrl, domainKey, domainUrl, expiry) {
+  const scopedDomainKey = await generateDomainKey(domainKey, domainUrl, expiry);
+  return `${dashboardUrl}?interval=${expiry}&offset=0&limit=100&url=${domainUrl}&domainkey=${scopedDomainKey}`;
+}
+
 export default class RUMAPIClient {
   static createFrom(context) {
     if (context.rumApiClient) return context.rumApiClient;
@@ -125,8 +131,11 @@ export default class RUMAPIClient {
     return data.map((row) => row.hostname);
   }
 
-  async createBacklink(url, expiry) {
-    const scopedDomainKey = await generateDomainKey(this.domainkey, url, expiry);
-    return `${APIS.RUM_DASHBOARD_UI}?interval=${expiry}&offset=0&limit=100&url=${url}&domainkey=${scopedDomainKey}`;
+  async createRUMBacklink(url, expiry) {
+    return createBacklink(APIS.RUM_DASHBOARD_UI, this.domainkey, url, expiry);
+  }
+
+  async create404Backlink(url, expiry) {
+    return createBacklink(APIS.NOT_FOUND_DASHBOARD_UI, this.domainkey, url, expiry);
   }
 }