@adobe/spacecat-shared-rum-api-client 1.7.2 → 1.8.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.8.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.8.0...@adobe/spacecat-shared-rum-api-client-v1.8.1) (2024-04-24)
+
+
+### Bug Fixes
+
+* use 404 new endpoint ([23ec007](https://github.com/adobe/spacecat-shared/commit/23ec0073540eabf3d460f4705ba4dd40f27f46a0))
+
+# [@adobe/spacecat-shared-rum-api-client-v1.8.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.7.2...@adobe/spacecat-shared-rum-api-client-v1.8.0) (2024-04-19)
+
+
+### Features
+
+* calculate conversion for customer domains ([#214](https://github.com/adobe/spacecat-shared/issues/214)) ([0ce20fc](https://github.com/adobe/spacecat-shared/commit/0ce20fce05ac96273d23248c990b7e7eed93be1e))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.7.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.7.1...@adobe/spacecat-shared-rum-api-client-v1.7.2) (2024-04-17)
 
 

package/package.json

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

package/src/index.d.ts

@@ -97,36 +97,12 @@ export default class RUMAPIClient {
   createExperimentationURL(params?: RUMAPIOptions): string;
 
   /**
-  * Asynchronous method to return the conversion API call response data.
-  * @param {RUMAPIOptions} params - An object representing the parameters to be included
-  *  for the conversion data API call.
-  * @returns A Promise resolving to the conversion response data.
-  */
-  getConversionData(params?: RUMAPIOptions): Promise<Array<object>>;
-
-  /**
-  * Method to return the url composed of params that the conversion API is called with.
-  * @param {RUMAPIOptions} params - An object representing the parameters to be included
-  *  for the conversion API call.
-  * @returns A string returning the conversion url including query parameters.
-  */
-  createConversionURL(params?: RUMAPIOptions): string;
-
-  /**
-   * Asynchronous method to return the conversion API call response data.
+   * Method to return the url composed of params that the rum-sources API is called with.
    * @param {RUMAPIOptions} params - An object representing the parameters to be included
-   *  for the conversion data API call.
-   * @returns A Promise resolving to the conversion response data.
+   *  for the rum-sources API call.
+   * @returns A string returning the rum-sources url including query parameters.
    */
-  getRUMFormsDashboard(params?: RUMAPIOptions): Promise<Array<object>>;
-
-  /**
-  * Method to return the url composed of params that the conversion API is called with.
-  * @param {RUMAPIOptions} params - An object representing the parameters to be included
-  *  for the conversion API call.
-  * @returns A string returning the conversion url including query parameters.
-  */
-  createRUMFormsURL(params?: RUMAPIOptions): string;
+  createConversionURL(params?: RUMAPIOptions): string;
 
   /**
    * Asynchronous method to return the 404 sources API call response data.
@@ -161,4 +137,12 @@ export default class RUMAPIClient {
    *  or an array of all domain urls .
    */
   getDomainList(params?: RUMAPIOptions): Promise<Array<string>>;
+
+  /**
+  * Asynchronous method to return the rum-sources API call response data.
+  * @param {RUMAPIOptions} params - An object representing the parameters to be included
+  *  for the rum-sources data API call.
+  * @returns A Promise resolving to the conversion response data.
+  */
+  getConversionData(params?: RUMAPIOptions): Promise<Array<string>>;
 }

package/src/index.js

@@ -21,10 +21,9 @@ const APIS = {
   NOT_FOUND_DASHBOARD_UI: 'https://data.aem.live/404-reports',
   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_404: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-404',
   RUM_SOURCES: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-sources',
   RUM_EXPERIMENTS: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-experiments',
-  RUM_SOURCES_TARGETS: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-sources-targets',
-  RUM_FROMS_DASHBOARD: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-forms-dashboard',
 };
 
 const DOMAIN_LIST_DEFAULT_PARAMS = {
@@ -39,20 +38,16 @@ export const RUM_DEFAULT_PARAMS = {
   limit: 101,
 };
 
-export const NOT_FOUND_DEFAULT_PARAMS = {
-  ...RUM_DEFAULT_PARAMS,
-  checkpoint: 404,
-};
-
 export const CONVERSION_DEFAULT_PARAMS = {
   ...RUM_DEFAULT_PARAMS,
   checkpoint: 'convert',
+  aggregate: false,
 };
 
 export const create404URL = (params = {}) => createUrl(
-  APIS.RUM_SOURCES,
+  APIS.RUM_404,
   {
-    ...NOT_FOUND_DEFAULT_PARAMS, ...params,
+    ...RUM_DEFAULT_PARAMS, ...params,
   },
 );
 
@@ -71,14 +66,7 @@ export const createExperimentationURL = (params = {}) => createUrl(
 );
 
 export const createConversionURL = (params = {}) => createUrl(
-  APIS.RUM_SOURCES_TARGETS,
-  {
-    ...CONVERSION_DEFAULT_PARAMS, ...params,
-  },
-);
-
-export const createRUMFormsURL = (params = {}) => createUrl(
-  APIS.RUM_FROMS_DASHBOARD,
+  APIS.RUM_SOURCES,
   {
     ...CONVERSION_DEFAULT_PARAMS, ...params,
   },
@@ -173,6 +161,10 @@ export default class RUMAPIClient {
     return sendRequest(createExperimentationURL({ ...params, domainkey: this.domainkey }));
   }
 
+  async getConversionData(params = {}) {
+    return sendRequest(createConversionURL({ ...params, domainkey: this.domainkey }));
+  }
+
   async get404Sources(params = {}) {
     return sendRequest(create404URL({ ...params, domainkey: this.domainkey }));
   }
@@ -205,12 +197,4 @@ export default class RUMAPIClient {
       params,
     );
   }
-
-  async getConversionData(params = {}) {
-    return sendRequest(createConversionURL({ ...params, domainkey: this.domainkey }));
-  }
-
-  async getRUMFormsDashboard(params = {}) {
-    return sendRequest(createRUMFormsURL({ ...params, domainkey: this.domainkey }));
-  }
 }