@adobe/spacecat-shared-rum-api-client 1.6.7 → 1.6.9

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.6.9](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.8...@adobe/spacecat-shared-rum-api-client-v1.6.9) (2024-03-20)
+
+
+### Bug Fixes
+
+* don t expose rum domain key ([3930026](https://github.com/adobe/spacecat-shared/commit/39300265e14f2598cc0963f7ea74a6c8d964d446))
+
+# [@adobe/spacecat-shared-rum-api-client-v1.6.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.7...@adobe/spacecat-shared-rum-api-client-v1.6.8) (2024-03-19)
+
+
+### Bug Fixes
+
+* expose createRUMURL function ([#188](https://github.com/adobe/spacecat-shared/issues/188)) ([3b8b0c6](https://github.com/adobe/spacecat-shared/commit/3b8b0c6b0cc1b58cbe71951551ee48f991716c24))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.6.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.6...@adobe/spacecat-shared-rum-api-client-v1.6.7) (2024-03-09)
 
 

package/package.json

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

package/src/index.d.ts

@@ -104,6 +104,14 @@ export default class RUMAPIClient {
    */
   get404Sources(params?: RUMAPIOptions): Promise<Array<object>>;
 
+  /**
+   * Method to return the url composed of params that the RUM Dashboard API is called with.
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   *  for the RUM Dashboard API call.
+   * @returns A string returning to the RUM Dashboard url including query parameters.
+   */
+  createRUMURL(params?: RUMAPIOptions): string;
+
   /**
    * 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

package/src/index.js

@@ -42,6 +42,27 @@ export const NOT_FOUND_DEFAULT_PARAMS = {
   checkpoint: 404,
 };
 
+export const create404URL = (params = {}) => createUrl(
+  APIS.RUM_SOURCES,
+  {
+    ...NOT_FOUND_DEFAULT_PARAMS, ...params,
+  },
+);
+
+export const createRUMURL = (params = {}) => createUrl(
+  APIS.RUM_DASHBOARD,
+  {
+    ...RUM_DEFAULT_PARAMS, ...params,
+  },
+);
+
+export const createExperimentationURL = (params = {}) => createUrl(
+  APIS.RUM_EXPERIMENTS,
+  {
+    ...RUM_DEFAULT_PARAMS, ...params,
+  },
+);
+
 export async function sendRequest(url, opts) {
   let respJson;
   try {
@@ -123,43 +144,16 @@ export default class RUMAPIClient {
     this.domainkey = domainkey;
   }
 
-  create404URL(params = {}) {
-    return createUrl(
-      APIS.RUM_SOURCES,
-      {
-        domainkey: this.domainkey, ...NOT_FOUND_DEFAULT_PARAMS, ...params,
-      },
-    );
-  }
-
-  createRUMURL(params = {}) {
-    return createUrl(
-      APIS.RUM_DASHBOARD,
-      {
-        domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, ...params,
-      },
-    );
-  }
-
   async getRUMDashboard(params = {}) {
-    return sendRequest(this.createRUMURL(params));
-  }
-
-  createExperimentationURL(params = {}) {
-    return createUrl(
-      APIS.RUM_EXPERIMENTS,
-      {
-        domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, ...params,
-      },
-    );
+    return sendRequest(createRUMURL({ ...params, domainkey: this.domainkey }));
   }
 
   async getExperimentationData(params = {}) {
-    return sendRequest(this.createExperimentationURL(params));
+    return sendRequest(createExperimentationURL({ ...params, domainkey: this.domainkey }));
   }
 
   async get404Sources(params = {}) {
-    return sendRequest(this.create404URL(params));
+    return sendRequest(create404URL({ ...params, domainkey: this.domainkey }));
   }
 
   async getDomainList(params = {}) {