@signalgrid/signalgrid-push 1.0.1

package/README.md

@@ -0,0 +1,79 @@
+# Signalgrid Node.js SDK
+
+Official Node.js client for the `@signalgrid/signalgrid` package.
+
+## Install
+
+```bash
+npm install @signalgrid/signalgrid
+```
+
+## Usage
+
+```js
+import Signalgrid from '@signalgrid/signalgrid';
+
+const sg = new Signalgrid('your_client_key');
+
+const result = await sg.send({
+  channel: 'your_channel_token',
+  title: 'Server Alert',
+  body: 'High CPU usage detected on web-01',
+  type: 'warning',
+  critical: false
+});
+
+console.log(result);
+```
+
+## API
+
+### `new Signalgrid(clientKey)`
+
+Creates a Signalgrid client instance.
+
+#### Arguments
+
+- `clientKey` (`string`) - Your Signalgrid client key.
+
+### `sg.send(payload)`
+
+Sends a notification.
+
+#### Payload
+
+- `channel` (`string`) - Your channel token.
+- `title` (`string`) - Notification title.
+- `body` (`string`) - Notification body.
+- `type` (`string`, optional) - Notification type such as `info`, `success`, `warning`, or `error`.
+- `critical` (`boolean`, optional) - Critical flag. If set to true, notification will bypass DND / Focus modes.
+
+#### Returns
+
+Returns a promise that resolves with the Signalgrid API response.
+
+## Example with error handling
+
+```js
+import Signalgrid from '@signalgrid/signalgrid';
+
+async function main() {
+  try {
+    const sg = new Signalgrid('your_client_key');
+
+    const result = await sg.send({
+      channel: 'your_channel_token',
+      title: 'Server Alert',
+      body: 'High CPU usage detected on web-01',
+      type: 'warning',
+      critical: false
+    });
+
+    console.log(result);
+  } catch (error) {
+    console.error('Failed to send notification:', error);
+  }
+}
+
+main();
+```

package/index.js

@@ -0,0 +1,39 @@
+class Signalgrid {
+  constructor(clientKey) {
+    if (!clientKey) {
+      throw new Error('Signalgrid: clientKey is required.');
+    }
+    this.clientKey = clientKey;
+    this.url = 'https://api.signalgrid.co/v1/push';
+  }
+
+  async send({ channel, type = 'info', title = '', body = '', critical = false }) {
+    if (!channel) throw new Error('Signalgrid: channel is required.');
+
+    const params = new URLSearchParams();
+    params.append('client_key', this.clientKey);
+    params.append('channel', channel);
+    params.append('type', type);
+    params.append('title', title);
+    params.append('body', body);
+    params.append('critical', String(critical));
+
+    const response = await fetch(this.url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        'User-Agent': 'signalgrid-node-client/1.0.0'
+      },
+      body: params.toString()
+    });
+
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(`Signalgrid HTTP Error ${response.status}: ${errorText}`);
+    }
+
+    return await response.text();
+  }
+}
+
+export default Signalgrid;

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@signalgrid/signalgrid-push",
+  "version": "1.0.1",
+  "description": "Official Node.js client for Signalgrid push notifications",
+  "type": "module",
+  "main": "index.js",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "signalgrid",
+    "push",
+    "notifications",
+    "push notifications",
+    "alerts"
+  ],
+  "author": "Signalgrid",
+  "license": "MIT"
+}