@adobe/spacecat-shared-rum-api-client 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.1.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.0.0...@adobe/spacecat-shared-rum-api-client-v1.1.0) (2023-12-14)
+
+
+### Features
+
+* add rum api calls to shared ([56cccd0](https://github.com/adobe-rnd/spacecat-shared/commit/56cccd0f498eaca6a4bb35a6b64d5f0dbe68a096))
+
 # @adobe/spacecat-shared-rum-api-client-v1.0.0 (2023-12-12)
 
 

package/README.md

@@ -39,6 +39,33 @@ const backlink = await rumApiClient.createBacklink(url, expiry);
 console.log(`Backlink created: ${backlink}`)
 ```
 
+### Getting RUM Dashboard Data
+
+```js
+const url = "example.com";
+
+const rumData = await rumApiClient.getRUMDashboard({ url });
+console.log(`RUM data: ${rumData}`)
+```
+
+### Getting 404 checkpoints
+
+```js
+const url = "example.com";
+
+const backlink = await rumApiClient.get404Sources({ url });
+console.log(`404 Checkpoints: ${backlink}`)
+```
+
+### Getting Edge Delivery Services Domains
+
+```js
+const url = "all";
+
+const domains = await rumApiClient.getDomainList({}, url);
+console.log(`Backlink created: ${backlink}`)
+```
+
 ## Testing
 Run the included tests with the following command:
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",
@@ -33,7 +33,7 @@
     "@adobe/fetch": "4.1.1",
     "@adobe/helix-shared-wrap": "2.0.0",
     "@adobe/helix-universal": "4.4.1",
-    "@adobe/spacecat-shared-utils": "1.3.0",
+    "@adobe/spacecat-shared-utils": "1.4.0",
     "aws4": "1.12.0"
   },
   "devDependencies": {

package/src/index.d.ts

@@ -12,6 +12,12 @@
 
 import { UniversalContext } from '@adobe/helix-universal';
 
+export interface RUMAPIOptions {
+  interval: number;
+  offset: number;
+  limit: number;
+}
+
 export declare class RUMAPIClient {
   /**
    * Static factory method to create an instance of RUMAPIClient.
@@ -40,4 +46,30 @@ export declare class RUMAPIClient {
    *   to view their reports and monitor real user activities.
    */
   createBacklink(url: string, expiry: number): Promise<string>;
+
+  /**
+   * Asynchronous method to return the RUM dashboard API call response data.
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   *  for the RUM Dashboard API call.
+   * @returns A Promise resolving to the RUM dashboard response data.
+   */
+  getRUMDashboard(params?: RUMAPIOptions): Promise<Array<object>>;
+
+  /**
+   * Asynchronous method to return the 404 sources API call response data.
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   *  for the 404 sources API call.
+   * @returns A Promise resolving to the 404 sources response data.
+   */
+  get404Sources(params?: RUMAPIOptions): Promise<Array<object>>;
+
+  /**
+   * Asynchronous method to return an array with the domain for a specific url
+   *  or an array of all domain urls
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   * for the domain list call.
+   * @returns A Promise resolving to an array of the domain for a specific url
+   *  or an array of all domain urls .
+   */
+  getDomainList(params?: RUMAPIOptions): Promise<Array<string>>;
 }

package/src/index.js

@@ -17,7 +17,22 @@ import { fetch } from './utils.js';
 
 const APIS = {
   ROTATE_DOMAINKEYS: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rotate-domainkeys',
-  RUM_DASHBOARD: 'https://main--franklin-dashboard--adobe.hlx.live/views/rum-dashboard',
+  RUM_DASHBOARD_UI: 'https://main--franklin-dashboard--adobe.hlx.live/views/rum-dashboard',
+  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',
+};
+
+const DOMAIN_LIST_DEFAULT_PARAMS = {
+  interval: 30,
+  offset: 0,
+  limit: 100000,
+};
+
+export const RUM_DEFAULT_PARAMS = {
+  interval: 7,
+  offset: 0,
+  limit: 101,
 };
 
 export async function sendRequest(url, opts) {
@@ -85,8 +100,33 @@ export default class RUMAPIClient {
     this.domainkey = domainkey;
   }
 
+  async getRUMDashboard(params = {}) {
+    return sendRequest(createUrl(
+      APIS.RUM_DASHBOARD,
+      { domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, ...params },
+    ));
+  }
+
+  async get404Sources(params = {}) {
+    return sendRequest(createUrl(
+      APIS.RUM_SOURCES,
+      {
+        domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, checkpoint: 404, ...params,
+      },
+    ));
+  }
+
+  async getDomainList(params = {}) {
+    const data = await sendRequest(createUrl(
+      APIS.DOMAIN_LIST,
+      { domainkey: this.domainkey, ...DOMAIN_LIST_DEFAULT_PARAMS, ...params },
+    ));
+
+    return data.map((row) => row.hostname);
+  }
+
   async createBacklink(url, expiry) {
     const scopedDomainKey = await generateDomainKey(this.domainkey, url, expiry);
-    return `${APIS.RUM_DASHBOARD}?interval=${expiry}&offset=0&limit=100&url=${url}&domainkey=${scopedDomainKey}`;
+    return `${APIS.RUM_DASHBOARD_UI}?interval=${expiry}&offset=0&limit=100&url=${url}&domainkey=${scopedDomainKey}`;
   }
 }