betterstackmanager 0.2.0 → 0.2.1

package/docs/classes/MonitorGroup.md

@@ -0,0 +1,75 @@
+# Monitor Groups
+
+Class: `client.monitorGroups`
+
+Methods: `create`, `edit`, `get`, `listMonitors`, `remove`.
+
+## `create`
+
+`create(monitorGroup)`
+
+Create a new monitor group.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `monitorGroup.team_name` | String | true | The team name that will own this group. |
+| `monitorGroup.paused` | Boolean | false | Pause monitoring for all monitors in this group. |
+| `monitorGroup.name` | String | false | The name of this group. |
+| `monitorGroup.sort_index` | Number | false | How to sort this group. |
+
+## `edit`
+
+`edit(id, monitorGroup)`
+
+Edit an existing monitor group.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `id` | Number | true | The monitor group ID. |
+| `monitorGroup.team_name` | String | true | The team name that will own this group. |
+| `monitorGroup.paused` | Boolean | false | Pause monitoring for all monitors in this group. |
+| `monitorGroup.name` | String | false | The name of this group. |
+| `monitorGroup.sort_index` | Number | false | How to sort this group. |
+
+## `get`
+
+`get(monitorGroupId)`
+
+Get a single monitor group.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `monitorGroupId` | Number | true | Specify the ID of the monitor group. |
+
+This can return:
+- If successful: HTTP 200 and the Monitor Group object containing the data.
+
+## `listMonitors`
+
+`listMonitors(monitorGroupId)`
+
+Show monitors that belong to a group.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `monitorGroupId` | Number | true | Specify the ID of the monitor group. |
+| `perPage` | Number | false | Amount of monitors per page. Default value is 50. |
+| `page` | Number | false | Results page number. Default value is 1. |
+
+> This method supports **pagination**!
+
+This can return:
+- If successful: HTTP 200 and a list of Monitors.
+
+## `remove`
+
+`remove(monitorGroupId)`
+
+Delete an existing monitor group.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `monitorGroupId` | Number | true | Specify the ID of the monitor group. |
+
+This can return:
+- If successful: HTTP 204 and an empty body.

package/examples/{acknowledgeIncident.js → incidents/acknowledge.js}

@@ -1,5 +1,5 @@
 const BSM = require('betterstackmanager');
-const config = require('./config.json');
+const config = require('../config.json');
 
 const client = new BSM.Client(config.token);
 

package/examples/{createIncident.js → incidents/create.js}

@@ -1,5 +1,5 @@
 const BSM = require('betterstackmanager');
-const config = require('./config.json');
+const config = require('../config.json');
 
 const client = new BSM.Client(config.token);
 

package/examples/{createIncidentComment.js → incidents/createIncidentComment.js}

@@ -1,5 +1,5 @@
 const BSM = require('betterstackmanager');
-const config = require('./config.json');
+const config = require('../config.json');
 
 const client = new BSM.Client(config.token);
 

package/examples/{getSingleIncident.js → incidents/getSingleIncident.js}

@@ -1,5 +1,5 @@
 const BSM = require('betterstackmanager');
-const config = require('./config.json');
+const config = require('../config.json');
 
 const client = new BSM.Client(config.token);
 

package/examples/{resolveIncident.js → incidents/resolve.js}

@@ -1,5 +1,5 @@
 const BSM = require('betterstackmanager');
-const config = require('./config.json');
+const config = require('../config.json');
 
 const client = new BSM.Client(config.token);
 

package/examples/readme.md

@@ -10,25 +10,9 @@ You'll need to have, at least,
 - your **global API** key,
 - a mail address.
 
-## Following examples
+## Examples
 
-All examples show how to get your BSM client up and running.
-
-## acknowledgeIncident.js
-
-This short example acknowledges an incident with the given ID.
-
-## createIncident.js
-
-This short example creates an incident with the given name, summary and explanation.
-
-## createIncidentComment.js
-
-This example appends a new comment to an existing incident.
-
-## resolveIncident.js
-
-This example resolves an existing incident with the given ID.
+You'll find examples in the subfolders. They're grouped by the topic they cover.
 
 ## Links
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterstackmanager",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Interact with Better Stack in Node.JS",
   "license": "GPL-3.0-only",
   "author": "Cyanic76",
@@ -12,6 +12,6 @@
     "lib": "src"
   },
   "dependencies": {
-    "axios": "^1.13.2"
+    "axios": "^1.13.4"
   }
 }

package/src/client/index.js

@@ -1,8 +1,9 @@
 const axios = require('axios');
 
-const Incidents = require('../etc/Incident');
-const IncidentComments = require('../etc/IncidentComment');
-const Monitors = require('../etc/Monitor');
+const Incidents = require('../etc/Incident'),
+      IncidentComments = require('../etc/IncidentComment'),
+      Monitors = require('../etc/Monitor'),
+      MonitorGroup = require('../etc/MonitorGroup');
 
 const { handleError } = require('../errors/Error');
 
@@ -19,12 +20,14 @@ class Client {
       }
     });
 
-    // Get the right classes as found in the folder.
+    // Get the right classes as found in the /src/etc folder.
     this.incidents = new Incidents(this);
     this.incidentComments = new IncidentComments(this);
     this.monitors = new Monitors(this);
+    this.monitorGroups = new MonitorGroup(this);
   }
 
+  // Handle HTTP requests to the upstream API.
   async delete (endpoint) {
     try {
       const response = await this.client.delete(endpoint);

package/src/etc/Incident.js

@@ -2,8 +2,7 @@ const util = require('../client/utils');
 
 class Incidents {
   /**
-   * @param {string} token
-   * @param {string} baseURL
+   * @param {Client} client 
    */
   constructor(client) {
     this.client = client;
@@ -21,7 +20,7 @@ class Incidents {
     if(!incidentData.name) throw new Error("Incident creation: name is a required incident option.");
     if(!incidentData.summary) throw new Error("Incident creation: summary is a required incident option.");
     if(!incidentData.description) throw new Error("Incident creation: description is a required incident option.");
-    if(!incidentData.email || typeof(incidentData.email) != 'boolean') throw new Error("Incident creation: email is a required boolean incident option.");
+    if(incidentData.email && typeof(incidentData.email) != 'boolean') throw new Error("Incident creation: email is a required boolean incident option.");
 
     // Modify a copy of the provided object.
     const data = { ...incidentData };
@@ -43,8 +42,8 @@ class Incidents {
    */
 
   async acknowledge(incidentId) {
-    if(!incidentId) throw new Error("Incident acknowledgement: incidentId is a required incident option.");
-    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+    if(!incidentId || incidentId && isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId must be a Number.");
+    if(incidentId < 1) throw new Error("Incident acknowledgement: incidentId must be greater than 0.");
 
     try {
       return await this.client.post(`/v3/incidents/${incidentId}/acknowledge`);
@@ -60,8 +59,8 @@ class Incidents {
    */
 
   async get(incidentId) {
-    if(!incidentId) throw new Error("Incident fetching: incidentId is a required incident option.");
-    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+    if(!incidentId || incidentId && isNaN(incidentId)) throw new Error("Incident: incidentId must be a Number.");
+    if(incidentId < 1) throw new Error("Incident: incidentId must be greater than 0.");
 
     try {
       return await this.client.get(`/v3/incidents/${incidentId}`);
@@ -123,8 +122,7 @@ class Incidents {
    */
 
   async resolve(incidentId) {
-    if(!incidentId) throw new Error("Incident resolution: incidentId is a required incident option.");
-    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+    if(!incidentId || incidentId && isNaN(incidentId) || incidentId && parseInt(incidentId) < 1) throw new Error("Incident resolution: incidentId must be a positive Number.");
 
     try {
       return await this.client.post(`/v3/incidents/${incidentId}/resolve`);
@@ -143,10 +141,10 @@ class Incidents {
   async escalate(incidentId, escalationData){
 
     // Before trying anything, check some things right away.
-    if(!incidentId || !escalationData) throw new Error("Incident resolution: incidentId and escalationData are required incident options.");
-    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+    if(!escalationData) throw new Error("Incident escalation: escalationData is required.");
+    if(!incidentId || incidentId && isNaN(incidentId) || incidentId && parseInt(incidentId) < 1) throw new Error("Incident escalation: incidentId must be a positive Number.");
     const allowedTypes = ["User", "Team", "Schedule", "Policy", "Organization"];
-    if(!allowedTypes.includes(escalationData.type)) throw new Error("Incident resolution: Escalation Type is invalid.");
+    if(!allowedTypes.includes(escalationData.type)) throw new Error("Incident escalation: Escalation Type is invalid.");
 
     switch(escalationData.type){
       case 'User':
@@ -178,8 +176,7 @@ class Incidents {
    */
   async remove(incidentId){
 
-    if(!incidentId) throw new Error("Incident deletion: incidentId is a required incident option.");
-    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+    if(!incidentId || incidentId && isNaN(incidentId) || incidentId && parseInt(incidentId) < 1) throw new Error("Incident deletion: incidentId must be a positive Number.");
 
     try {
       return await this.client.delete(`/v3/incidents/${incidentId}`);

package/src/etc/IncidentComment.js

@@ -1,7 +1,6 @@
 class IncidentComments {
   /**
-   * @param {string} token
-   * @param {string} baseURL
+   * @param {Client} client 
    */
   constructor(client) {
     this.client = client;
@@ -54,8 +53,8 @@ class IncidentComments {
    */
   async getAll(incidentId) {
 
-    if(!incidentId) throw new Error("Incident comment fetch: incidentId is a required options.");
-    if(isNaN(incidentId) || incidentId < 1) throw new Error("Incident comment fetch: incidentId must be a Number greater than 0.");
+    if(!incidentId || incidentId && isNaN(incidentId)) throw new Error("Incident comment fetch: incidentId is a required option.");
+    if(incidentId < 1) throw new Error("Incident comment fetch: incidentId must be a positive Number.");
 
     try {
       return await this.client.get(`/v2/incidents/${incidentId}/comments`);
@@ -68,7 +67,7 @@ class IncidentComments {
   async remove(incidentId, incidentCommentId) {
 
     if(!incidentId || !incidentCommentId || incidentId && isNaN(incidentId) || incidentCommentId && isNaN(incidentCommentId)) throw new Error("Incident comment removal: incidentId and incidentCommentId must be Numbers.");
-    if(incidentId < 1 || incidentCommentId < 1) throw new Error("Incident comment removal: incidentId and incidentCommentId must be greater than 0.");
+    if(incidentId < 1 || incidentCommentId < 1) throw new Error("Incident comment removal: incidentId and incidentCommentId must be a positive Number.");
 
     try {
       return await this.client.delete(`/v2/incidents/${incidentId}/comments/${incidentCommentId}`);
@@ -87,9 +86,9 @@ class IncidentComments {
    */
   async update(incidentId, incidentCommentId, incidentCommentText) {
     
-    if(!incidentId || !incidentCommentId || !incidentCommentText ) throw new Error("Incident comment update: incidentId, incidentCommentId, incidentCommentText are required options.");
-    if(isNaN(incidentId) || isNaN(incidentCommentId)) throw new Error("Incident comment update: incidentId and incidentCommentId must both be Numbers.");
-    if(incidentId < 1 || incidentCommentId < 1) throw new Error("Incident comment update: incidentId and incidentCommentId must be greater than 0.");
+    if(!incidentId || !incidentCommentId || !incidentCommentText) throw new Error("Incident comment update: incidentId, incidentCommentId, incidentCommentText are required options.");
+    if(isNaN(incidentId) || isNaN(incidentCommentId)) throw new Error("Incident comment update: incidentId and incidentCommentId must be Numbers.");
+    if(incidentId < 1 || incidentCommentId < 1) throw new Error("Incident comment update: incidentId and incidentCommentId must be a positive Number.");
 
     try {
       return await this.client.patch(`/v2/incidents/${incidentId}/comments/${incidentCommentId}`, {

package/src/etc/Monitor.js

@@ -2,8 +2,7 @@ const util = require('../client/utils');
 
 class Monitor {
   /**
-   * @param {string} token
-   * @param {string} baseURL
+   * @param {Client} client 
    */
   constructor(client) {
     this.client = client;

package/src/etc/MonitorGroup.js

@@ -0,0 +1,122 @@
+class MonitorGroup {
+  /**
+   * @param {Client} client 
+   */
+  constructor(client) {
+    this.client = client;
+  };
+
+  /**
+   * Create a new monitor group.
+   * @param {Object} monitorGroup 
+   * @returns 
+   */
+  async create(monitorGroup) {
+
+    if(!monitorGroup) throw new Error("Montior Group: Must provide a Monitor Group object.");
+    if(!monitorGroup.team_name) throw new Error("Monitor Group: Team Name must be provided.");
+    if(monitorGroup.paused && typeof(monitorGroup.paused) != "Boolean") throw new Error("Monitor Group: paused must be either true or false.");
+    if(monitorGroup.sort_index && isNaN(monitorGroup.sort_index) || monitorGroup.sort_index && parseInt(monitorGroup.sort_index) < 1) throw new Error("Monitor Group: sort_index must be a positive number.");
+
+    try {
+      return await this.client.post(`/v2/monitor-groups/`, {
+        monitorGroup
+      });
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
+  /**
+   * Edit an existing monitor group.
+   * @param {Number} id
+   * @param {Object} monitorGroup 
+   * @returns 
+   */
+  async edit(id, monitorGroup) {
+
+    if(!id || !monitorGroup) throw new Error("Montior Group: Must provide an ID and a Monitor Group object.");
+    if(parseInt(id) < 1 || isNaN(id)) throw new Error("Monitor Group: The ID must be a positive Number.");
+    if(monitorGroup.paused && typeof(monitorGroup.paused) != "Boolean") throw new Error("Monitor Group: paused must be either true or false.");
+    if(monitorGroup.sort_index && isNaN(monitorGroup.sort_index) || monitorGroup.sort_index && parseInt(monitorGroup.sort_index) < 1) throw new Error("Monitor Group: sort_index must be a positive number.");
+
+    try {
+      return await this.client.patch(`/v2/monitor-groups/`, {
+        monitorGroup
+      });
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
+  /**
+   * Get an existing monitor group.
+   * @param {Number} monitorGroupId 
+   * @returns 
+   */
+  async get(monitorGroupId) {
+
+    if(!monitorGroupId || monitorGroupId && isNaN(monitorGroupId) || monitorGroupId && monitorGroupId < 1) throw new Error("Montior Group Deletion: ID must be a positive number.");
+
+    try {
+      return await this.client.get(`/v2/monitor-groups/${monitorGroupId}`);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
+  /**
+   * List monitors that belong to this group.
+   * @param {Number} monitorGroupId 
+   * @param {Number} perPage 
+   * @param {Number} page 
+   * @returns 
+   */
+  async listMonitors(monitorGroupId, perPage, page) {
+    if(!monitorGroupId || monitorGroupId && isNaN(monitorGroupId) || monitorGroupId && monitorGroupId < 1) throw new Error("Monitor Group ID must be a positive number.");
+
+    if(page && isNaN(page) || page && !isNaN(page) && page < 1) throw new Error("pageId must be a number greater than or equal to 0.");
+    if(perPage && isNaN(perPage) || perPage && perPage > 250 || perPage && perPage < 1) throw new Error("perPage must be a number between 1 and 250.");
+
+    const endpoint = `/v2/monitor-groups/${monitorGroupId}/monitors`;
+
+    // Build query from passed parameters
+    let parameters = {
+      "perPage": perPage ? perPage : 50,
+      "page": page ? page : 1
+    }
+    for (let key in parameters) {
+      let value = parameters[key];
+      if(value != null) endpoint += `${key}=${value}&`;
+    };
+
+    try {
+      return await this.client.get(endpoint);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
+  /**
+   * Delete an existing monitor group.
+   * @param {Number} monitorGroupId 
+   * @returns 
+   */
+  async remove(monitorGroupId) {
+
+    if(!monitorGroupId || monitorGroupId && isNaN(monitorGroupId) || monitorGroupId && monitorGroupId < 1) throw new Error("Montior Group Deletion: ID must be a positive number.");
+
+    try {
+      return await this.client.delete(`/v2/monitor-groups/${monitorGroupId}`);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+}
+
+module.exports = { MonitorGroup };

package/src/index.js

@@ -1,7 +1,8 @@
-const { Client } = require('./client');
-const { Incidents } = require('./etc/Incident');
-const { IncidentComments } = require('./etc/IncidentComment');
-const { Monitor } = require('./etc/Monitor');
+const { Client } = require('./client'),
+      { Incidents } = require('./etc/Incident'),
+      { IncidentComments } = require('./etc/IncidentComment'),
+      { Monitor } = require('./etc/Monitor'),
+      { MonitorGroup } = require('./etc/MonitorGroup');
 
 module.exports = {
   Client,
@@ -9,5 +10,6 @@ module.exports = {
   Incidents,
   IncidentComments,
 
-  Monitor
+  Monitor,
+  MonitorGroup
 };

package/src/readme.md

@@ -0,0 +1,21 @@
+# BSM - Better Stack Manager
+
+Manage your Better Stack incidents & more using the API with this library.
+
+You're in the **source code**.
+
+## Directories
+
+- `client/` - The main client code and other utilities.
+- `errors/` - The error handler.
+- `etc/` - Other classes as defined in the documentation.
+
+## Links
+
+- [Documentation](https://codeberg.org/Cyanic76/BSM.js/src/branch/main/docs)
+- [Source Code](https://codeberg.org/Cyanic76/BSM.js/)
+- [Discord server](https://cyanic.me/discord)
+
+Get the package on
+[Codeberg](https://codeberg.org/Cyanic76/-/packages/npm/betterstackmanager/) or on
+[NPM](https://www.npmjs.com/package/betterstackmanager).