betterstackmanager 0.0.1 → 0.1.0

package/README.md

@@ -9,8 +9,8 @@ There is a required node version, and it is `>= 6.0.0`.
 You must clone this repository (or, at least, the `src` directory) and require the Client object.
 
 ```js
-const BSM = require('./src/client/index');
-const client = new BSM();
+const BSM = require('betterstackmanager');
+const client = new BSM.Client();
 const config = require('./config.json');
 
 client.login(config.token);
@@ -31,10 +31,11 @@ The documentation for this project is contained within the `docs` directory.
 ## Links
 
 - [Documentation](https://codeberg.org/Cyanic76/BSM.js/src/branch/main/docs)
+- [NPM](https://www.npmjs.com/package/betterstackmanager)
 - [Discord server](https://cyanic.me/next)
 
 ## Contributing & Help
 
 As always, if you're in need of help, don't hesitate to create a new issue or to [join my Discord server](https://cyanic.me/discord).
 
-This project abides by the CCoC.
+This project abides by the [CCoC](https://codeberg.org/Cyanic76/pages/src/branch/pages/CODE_OF_CONDUCT.md).

package/docs/classes/IncidentComment.md

@@ -6,6 +6,8 @@ This is the point from which all incident comments can be managed.
 
 > **Markdown is supported within comments.**
 
+Methods: `create`, `get`, `getAll`, `update`.
+
 ## create(incidentId, incidentCommentText)
 
 Add a comment to an existing incident.
@@ -33,6 +35,18 @@ This can return:
 - HTTP 200 with the comment object if it was successful.
 - HTTP 404 if the given comment or incident doesn't exist.
 
+## getAll(incidentId)
+
+Fetch all comments from an incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+
+This can return:
+- HTTP 200 with an array of incident comments if it was successful.
+- HTTP 404 if the given incident doesn't exist.
+
 ## update(incidentId, incidentCommentId, incidentCommentText)
 
 Edit an existing comment on an incident.

package/docs/classes/Incidents.md

@@ -6,6 +6,8 @@ This is the point from which all incidents can be managed.
 
 Status updates can't be managed from here.
 
+Methods: `acknowledge`, `create`, `escalate`, `get`, `remove`, `resolve`.
+
 ## `acknowledge`
 
 `acknowledge(incidentId)`
@@ -116,3 +118,26 @@ This can return:
 
 - HTTP 200 if it was successful,
 - HTTP 409 if that incident was already resolved.
+
+## `search`
+
+`search(perPage, page, from, to, monitorId, heartbeatId, resolved, acknowledged, metadata)`
+
+> Each value must be set, either as the required corresponding type, as `null` or `undefined`.
+
+> This method supports **pagination**!
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `perPage` | Number | true | Number of results to show. Maximum is 250. |
+| `page` | Number | true | Page of results to show. |
+| `from` | String | false | Specify the start date. |
+| `to` | String | false | Specify the end date. |
+| `monitorId` | Number | false | Specify the monitor ID. |
+| `heartbeatId` | Number | false | Specify the heartbeat ID. |
+| `resolved` | Boolean | false | Whether to query only resolved or unresolved incidents. |
+| `acknowledged` | Boolean | false | Whether to query only incidents that are acknowledged or not. |
+
+This can return:
+
+- HTTP 200 with a list of incidents.

package/docs/readme.md

@@ -7,4 +7,5 @@ You're in the **user-facing documentation**.
 ## Links
 
 - [Source code](https://codeberg.org/Cyanic76/BSM.js)
+- [NPM](https://www.npmjs.com/package/betterstackmanager)
 - [Discord server](https://cyanic.me/next)

package/docs/upstream/Pagination.md

@@ -0,0 +1,12 @@
+# Pagination
+
+When getting a result from an method that support pagination, you may check the following properties.
+
+| Property | Type | Description |
+|-|-|-|
+| `pagination.first` | String | URL to the first page of results. |
+| `pagination.last` | String | URL to the last page of results. |
+| `pagination.prev` | String|null | URL to the previous page of results. If you're on the first page, you'll get `null`. |
+| `pagination.next` | String|null | URL to the next page of results. If you're on the last page, you'll get `null`. |
+
+See [upstream documentation](https://betterstack.com/docs/uptime/api/pagination).

package/examples/acknowledgeIncident.js

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

package/examples/createIncident.js

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

package/examples/createIncidentComment.js

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

package/examples/getSingleIncident.js

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

package/examples/readme.md

@@ -33,4 +33,5 @@ This example resolves an existing incident with the given ID.
 ## Links
 
 - [Source code](https://codeberg.org/Cyanic76/BSM.js)
+- [NPM](https://www.npmjs.com/package/betterstackmanager)
 - [Discord server](https://cyanic.me/next)

package/examples/resolveIncident.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterstackmanager",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Interact with Better Stack in Node.JS",
   "license": "GPL-3.0-only",
   "author": "Cyanic76",

package/src/etc/Incident.js

@@ -68,6 +68,52 @@ class Incidents {
     }
   };
 
+  /**
+   * Query bulk incidents.
+   * @param {Number} perPage
+   * @param {Number} page
+   * @param {String} from 
+   * @param {String} to 
+   * @param {Number} monitorId 
+   * @param {Number} heartbeatId 
+   * @param {Boolean} resolved 
+   * @param {Boolean} acknowledged 
+   * @param {Object} metadata 
+   * @returns 
+   */
+  async search(perPage, page, from, to, monitorId, heartbeatId, resolved, acknowledged, metadata) {
+
+    // Test both timestamps against the YYYY-MM-DD format.
+    const dateRegEx = /(19[7-9]\d|20[0-3]\d)-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])/;
+    if(from != null && from != undefined && !from.match(dateRegEx) || to != null && to != undefined && !to.match(dateRegEx)) throw new Error("Incident search: Both timestamps must be formatted as YYYY-MM-DD.");
+
+    // Both following values are only boolean values.
+    if(monitorId != null && monitorId != undefined && isNaN(monitorId)) throw new Error("Incident search: Monitor ID must be a number.");
+    if(heartbeatId != null && heartbeatId != undefined && heartbeatId(monitorId)) throw new Error("Incident search: Monitor ID must be a number.");
+
+    // Both following values are only numbers.
+    if(perPage != null && perPage != undefined && isNaN(perPage) || page != null && page != null && isNaN(page)) throw new Error("Incident search: Page number and results must both be numbers.");
+    if(perPage != null && perPage != undefined && perPage < 1 || perPage != null && perPage != undefined && perPage > 250) throw new Error("Incident search: Can only get between 1 and 250 results.");
+    if(page != null && page != undefined && perPage < 1) throw new Error("Incident search: Page number must be a number.");
+
+    // Build our query with the params by only passing provided params.
+    const query = new URLSearchParams();
+    if(from != null && from != undefined) query.append('from', from);
+    if(to != null && to != undefined) query.append('to', to);
+    if(monitorId != null && monitorId != undefined) query.append('monitor_id', monitorId);
+    if(heartbeatId != null && heartbeatId != undefined) query.append('heartbeat_id', heartbeatId);
+    if(resolved == false || resolved == true) query.append('resolved', resolved);
+    if(acknowledged == false || acknowledged == true) query.append('acknowledged', acknowledged);
+    if(metadata != null && metadata != undefined) query.append('metadata', metadata);
+
+    try {
+      return await this.client.get(`/v3/incidents/?${query}`);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
   /**
    * Resolve an existing incident.
    * @param {Number} incidentId 

package/src/etc/IncidentComment.js

@@ -46,6 +46,24 @@ class IncidentComments {
 
   }
 
+  /**
+   * Get all comments on an incident.
+   * @param {Number} incidentId 
+   * @returns 
+   */
+  async getAll(incidentId) {
+
+    if(!incidentId) throw new Error("Incident comment fetch: incidentId is a required options.");
+    if(isNaN(incidentId)) throw new Error("Incident comment fetch: incidentId must be a Number.");
+
+    try {
+      return await this.client.get(`/v2/incidents/${incidentId}/comments`);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
   /**
    * Edit an existing incident comment.
    * @param {Number} incidentId