init

Author: ayshptk

.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+/lib
+/coverage

.eslintrc

@@ -0,0 +1,17 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "no-console": 1,
+    "semi-style": ["error", "last"],
+    "semi": [2, "always"]
+  }
+}

.github/workflows/build.yaml

@@ -0,0 +1,34 @@
+name: NPM Publish
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Begin...
+        uses: actions/checkout@v2
+
+      - name: Use Node 14
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+
+      - name: Install dependencies
+        run: npm install && npm install node-fetch @types/node-fetch -g
+        env:
+          CI: true
+
+      - name: Automated Version Bump
+        uses: "phips28/gh-action-bump-version@master"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+
+      - name: Build
+        run: npm run build
+        env:
+          CI: true
+
+      - name: Publish
+        run: echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc && npm publish --access public
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.TOKEN }}

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+/coverage
+src/__tests__/local.test.ts
+package-lock.json

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ayush Pathak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,38 @@
+# @ayshptk/msngr
+
+a tiny utility to post to user-provided webhooks without worrying about platforms built for [@raiddotfarm](https://github.com/raiddotfarm)
+
+platforms supported:
+
+- [x] slack
+- [x] discord
+
+won't be adding new platforms myself because of current commitments but feel free to create PR **with a working test** to get it merged :)
+
+
+### 1. install:
+
+```
+npm install @ayshptk/msngr
+```
+
+or
+
+```
+yarn install @ayshptk/msngr
+```
+
+### 2. use
+
+```ts
+// import
+import { send } from "@ayshptk/msngr";
+
+// declaring webhook
+const webhook = "https://discord.com/api/webhooks/987654321/abcdefghijklmnopqrstuvwxyz";
+
+// send
+await send(webhook, "Hello World!");
+```
+
+

jestconfig.json

@@ -0,0 +1,9 @@
+{
+  "transform": {
+    "^.+\\.(t|j)sx?$": "ts-jest"
+  },
+  "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
+  "collectCoverageFrom": ["src/**/*.{ts,tsx}"],
+  "collectCoverage":true
+}

lib/index.d.ts

@@ -0,0 +1,12 @@
+export interface payload {
+    message: string;
+}
+export declare type request = string | payload;
+export interface response {
+    success: boolean;
+    response?: unknown;
+    reason?: string;
+}
+declare const send: (webhook: string, request: request) => Promise<response>;
+declare const ping: (webhook: string) => Promise<response>;
+export { send, ping };

lib/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ping = exports.send = void 0;
+const node_fetch_1 = require("node-fetch");
+const send = (webhook, request) => __awaiter(void 0, void 0, void 0, function* () {
+    let finalPayload;
+    if (typeof request === "string") {
+        request = { message: request };
+    }
+    if (webhook.startsWith("https://hooks.slack.com/services/")) {
+        finalPayload = {
+            text: request.message,
+        };
+    }
+    else if (webhook.startsWith("https://discord.com/api/webhooks")) {
+        finalPayload = {
+            content: request.message,
+        };
+    }
+    else {
+        return {
+            success: false,
+            reason: "Invalid webhook",
+        };
+    }
+    return (0, node_fetch_1.default)(webhook, {
+        method: "POST",
+        body: JSON.stringify(finalPayload),
+        headers: {
+            "Content-Type": "application/json",
+        },
+    })
+        .then((res) => __awaiter(void 0, void 0, void 0, function* () {
+        if (res.ok) {
+            return {
+                success: true,
+                response: yield res.text(),
+            };
+        }
+        else {
+            throw new Error(res.statusText);
+        }
+    }))
+        .catch((err) => {
+        return {
+            success: false,
+            reason: err.message,
+        };
+    });
+});
+exports.send = send;
+const ping = (webhook) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield send(webhook, { message: "Webhook pinged successfully!" });
+});
+exports.ping = ping;

package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@ayshptk/msngr",
+  "version": "0.0.10",
+  "description": "",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint . --ext .ts",
+    "test": "jest --config jestconfig.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ayshptk/msngr"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "keywords": [
+    "webhooks"
+  ],
+  "author": "Ayush Pathak",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ayshptk/msngr/issues"
+  },
+  "homepage": "https://github.com/ayshptk/msngr#readme",
+  "devDependencies": {
+    "@types/jest": "^27.4.0",
+    "@types/node": "^16.11.6",
+    "@types/node-fetch": "^3.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.3.0",
+    "@typescript-eslint/parser": "^5.3.0",
+    "eslint": "^8.2.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.1",
+    "jest": "^27.3.1",
+    "ts-jest": "^27.0.7",
+    "typescript": "^4.4.4"
+  },
+  "dependencies": {
+    "node-fetch": "2.6.7"
+  }
+}

src/__tests__/send.test.ts

@@ -0,0 +1,51 @@
+import { send } from "../index";
+
+describe.skip("success", () => {
+  test("discord", async () => {
+    expect(
+      // feel free to use your own discord webhook :)
+      (
+        await send("https://discord.com/api/webhooks/../..", {
+          message: "Hello, world!",
+        })
+      ).success
+    ).toBe(true);
+  });
+
+  test.skip("slack", async () => {
+    expect(
+      // feel free to use your own slack webhook :)
+      (
+        await send("https://hooks.slack.com/services/../..", {
+          message: "Hello, world!",
+        })
+      ).success
+    ).toBe(true);
+  });
+});
+describe("errors", () => {
+  test("invalid webhooks", async () => {
+    expect(
+      (
+        await send(
+          "https://badwebhook.com", // feel free to use your own slack webhook :)
+          {
+            message: "Hello, world!",
+          }
+        )
+      ).reason
+    ).toBe("Invalid webhook");
+  });
+  test("expired webhooks", async () => {
+    expect(
+      (
+        await send(
+          "https://hooks.slack.com/services/T032WAH0TGU/B032WAKGF28/8F0LznNK6JRzpKR7R5srLXZ", // feel free to use your own slack webhook :)
+          {
+            message: "Hello, world!",
+          }
+        )
+      ).reason
+    ).toBe("Forbidden");
+  });
+});

src/index.ts

@@ -0,0 +1,62 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import fetch from "node-fetch";
+export interface payload {
+  message: string;
+}
+export type request = string | payload;
+export interface response {
+  success: boolean;
+  response?: unknown;
+  // returns the reason if success is false
+  reason?: string;
+}
+
+const send = async (webhook: string, request: request): Promise<response> => {
+  let finalPayload;
+  if (typeof request === "string") {
+    request = { message: request };
+  }
+  if (webhook.startsWith("https://hooks.slack.com/services/")) {
+    finalPayload = {
+      text: request.message,
+    };
+  } else if (webhook.startsWith("https://discord.com/api/webhooks")) {
+    finalPayload = {
+      content: request.message,
+    };
+  } else {
+    return {
+      success: false,
+      reason: "Invalid webhook",
+    };
+  }
+  return fetch(webhook, {
+    method: "POST",
+    body: JSON.stringify(finalPayload),
+    headers: {
+      "Content-Type": "application/json",
+    },
+  })
+    .then(async (res: any) => {
+      if (res.ok) {
+        return {
+          success: true,
+          response: await res.text(),
+        };
+      } else {
+        throw new Error(res.statusText);
+      }
+    })
+    .catch((err : any) => {
+      return {
+        success: false,
+        reason: err.message,
+      };
+    });
+};
+
+const ping = async (webhook: string): Promise<response> => {
+  return await send(webhook, { message: "Webhook pinged successfully!" });
+};
+export { send, ping };

tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "outDir": "./lib",
+        "module": "commonjs",
+        "target": "es6",
+        "declaration": true,
+        "strict": true
+    },
+    "include": ["src"],
+    "exclude": ["node_modules", "**/__tests__/*"]
+}

tsconfig.spec.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "types": ["jest", "node"]
+  }
+}