@adobe/spacecat-shared-rum-api-client 1.3.6 → 1.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.4.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.3.6...@adobe/spacecat-shared-rum-api-client-v1.4.0) (2024-01-24)
+
+
+### Features
+
+* add create404Url method to RUMAPIClient ([9282a2d](https://github.com/adobe/spacecat-shared/commit/9282a2d97cf5f42868dcee16a40cbf26109a37fc))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.3.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.3.5...@adobe/spacecat-shared-rum-api-client-v1.3.6) (2024-01-24)
 
 

package/package.json

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

package/src/index.d.ts

@@ -74,6 +74,14 @@ export default class RUMAPIClient {
    */
   get404Sources(params?: RUMAPIOptions): Promise<Array<object>>;
 
+  /**
+   * Method to return the url composed of params that the 404 sources API is called with.
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   *  for the 404 sources API call.
+   * @returns A string returning to the 404 sources url including query parameters.
+   */
+  create404URL(params?: RUMAPIOptions): string;
+
   /**
    * Asynchronous method to return an array with the domain for a specific url
    *  or an array of all domain urls

package/src/index.js

@@ -106,6 +106,15 @@ export default class RUMAPIClient {
     this.domainkey = domainkey;
   }
 
+  create404URL(params = {}) {
+    return createUrl(
+      APIS.RUM_SOURCES,
+      {
+        domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, checkpoint: 404, ...params,
+      },
+    );
+  }
+
   async getRUMDashboard(params = {}) {
     return sendRequest(createUrl(
       APIS.RUM_DASHBOARD,
@@ -114,11 +123,8 @@ export default class RUMAPIClient {
   }
 
   async get404Sources(params = {}) {
-    return sendRequest(createUrl(
-      APIS.RUM_SOURCES,
-      {
-        domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, checkpoint: 404, ...params,
-      },
+    return sendRequest(this.create404URL(
+      params,
     ));
   }