@adobe/spacecat-shared-rum-api-client 1.6.11 → 1.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.7.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.12...@adobe/spacecat-shared-rum-api-client-v1.7.0) (2024-04-16)
+
+
+### Features
+
+* API call for getting conversion data. ([#208](https://github.com/adobe/spacecat-shared/issues/208)) ([8df8327](https://github.com/adobe/spacecat-shared/commit/8df832793df3806c20be000bff10b93810aff02c))
+
+# [@adobe/spacecat-shared-rum-api-client-v1.6.12](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.11...@adobe/spacecat-shared-rum-api-client-v1.6.12) (2024-04-12)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-universal to v4.5.1 ([#207](https://github.com/adobe/spacecat-shared/issues/207)) ([985cdba](https://github.com/adobe/spacecat-shared/commit/985cdbaf6c2c354d73f91e94d38244b6eda055ab))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.6.11](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.10...@adobe/spacecat-shared-rum-api-client-v1.6.11) (2024-04-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "1.6.11",
+  "version": "1.7.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",
@@ -32,7 +32,7 @@
   "dependencies": {
     "@adobe/fetch": "4.1.2",
     "@adobe/helix-shared-wrap": "2.0.1",
-    "@adobe/helix-universal": "4.5.0",
+    "@adobe/helix-universal": "4.5.1",
     "@adobe/spacecat-shared-utils": "1.4.0",
     "aws4": "1.12.0"
   },

package/src/index.d.ts

@@ -96,6 +96,38 @@ 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.
+   * @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.
+   */
+  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;
+
   /**
    * Asynchronous method to return the 404 sources API call response data.
    * @param {RUMAPIOptions} params - An object representing the parameters to be included

package/src/index.js

@@ -23,6 +23,8 @@ const APIS = {
   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',
   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 = {
@@ -42,6 +44,11 @@ export const NOT_FOUND_DEFAULT_PARAMS = {
   checkpoint: 404,
 };
 
+export const CONVERSION_DEFAULT_PARAMS = {
+  ...RUM_DEFAULT_PARAMS,
+  checkpoint: 'convert',
+};
+
 export const create404URL = (params = {}) => createUrl(
   APIS.RUM_SOURCES,
   {
@@ -63,6 +70,20 @@ 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,
+  {
+    ...CONVERSION_DEFAULT_PARAMS, ...params,
+  },
+);
+
 export async function sendRequest(url, opts) {
   let respJson;
   try {
@@ -184,4 +205,12 @@ 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 }));
+  }
 }