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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.4.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.4.0...@adobe/spacecat-shared-rum-api-client-v1.4.1) (2024-01-26)
+
+
+### Bug Fixes
+
+* add missing type declaration for SLACK_TARGETS ([#113](https://github.com/adobe/spacecat-shared/issues/113)) ([1658513](https://github.com/adobe/spacecat-shared/commit/1658513bc29b618f35ce31dfff88d26110525c7f))
+
+# [@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/README.md

@@ -12,6 +12,18 @@ npm install @adobe/spacecat-shared-rum-api-client
 
 ## Usage
 
+### Configuring Tokens
+
+To configure tokens for your application, follow these steps:
+
+1. Visit the main page of your Slack app at [https://api.slack.com/apps](https://api.slack.com/apps).
+
+2. Navigate to the "OAuth & Permissions" page and locate the "Scope" section. Here, you can add scopes to your Slack app based on the specific methods you intend to use from the Slack API. For example, if your app requires file upload functionality, ensure you add the `files:read` and `files:write` scopes.
+
+3. Locate your Slack bot token under the "Bot User OAuth Token" section on the same page. You will need to provide this token to the `SlackClient` in your application.
+
+4. For information on the scopes needed for each Slack API method, refer to the [documentation](https://api.slack.com/methods). The required scopes for each API method are listed in the "Bot tokens" row. As an example, to use the `postMessage` API method, the required scope is `chat:write`, as documented in [https://api.slack.com/methods/chat.postMessage](https://api.slack.com/methods/chat.postMessage).
+
 ### Creating and instance from Helix UniversalContext
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "1.3.6",
+  "version": "1.4.1",
   "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,
     ));
   }