n8n-nodes-ntfy-next 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+© 2025 Iván Ovejero
+
+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.

package/README.md

@@ -0,0 +1,14 @@
+# n8n-nodes-ntfy
+
+[n8n community package](https://docs.n8n.io/integrations/community-nodes/installation/gui-install/) to push messages via [ntfy.sh](https://ntfy.sh/)
+
+- Set headers via fields or JSON
+- Support for self-hosted ntfy instances
+- Credentials for basic + bearer + query auth
+
+<img src="docs/ndv.png" width="400">
+
+## Docs
+
+- [`development.md`](docs/development.md)
+- [`self-hosting.md`](docs/self-hosting.md)

package/dist/Ntfy.node.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ntfy = void 0;
+class Ntfy {
+    constructor() {
+        this.description = {
+            displayName: "ntfy",
+            name: "ntfy",
+            icon: { light: "file:ntfy.light.svg", dark: "file:ntfy.dark.svg" },
+            group: ["transform"],
+            version: 1,
+            subtitle: '={{ $parameter["topic"] }}',
+            description: "Push messages via ntfy.sh",
+            defaults: {
+                name: "ntfy",
+            },
+            inputs: ["main" /* NodeConnectionType.Main */],
+            outputs: ["main" /* NodeConnectionType.Main */],
+            requestDefaults: {
+                baseURL: '={{ $credentials.baseUrl.replace(new RegExp("/$"), "") }}',
+            },
+            credentials: [
+                {
+                    name: "ntfyApi",
+                    required: true,
+                },
+            ],
+            properties: [
+                {
+                    displayName: "Topic",
+                    name: "topic",
+                    type: "string",
+                    description: 'Topic to <a href="https://docs.ntfy.sh/publish/#publishing">push</a> a message to',
+                    required: true,
+                    default: "",
+                    placeholder: "e.g. mytopic",
+                    routing: {
+                        request: {
+                            method: "POST",
+                            url: "=/{{ $parameter.topic }}",
+                        },
+                    },
+                },
+                {
+                    displayName: "Message",
+                    name: "message",
+                    type: "string",
+                    description: "Message to publish to a topic",
+                    required: true,
+                    default: "",
+                    placeholder: "e.g. Hello world!",
+                    routing: {
+                        send: { preSend: [populateMessage] },
+                    },
+                },
+                {
+                    displayName: "Send Additional Headers",
+                    name: "sendAdditionalHeaders",
+                    type: "boolean",
+                    default: false,
+                    noDataExpression: true,
+                    description: 'Whether to send <a href="https://docs.ntfy.sh/publish/#list-of-all-parameters">additional headers</a> with the request',
+                },
+                {
+                    displayName: "Specify Headers Using...",
+                    name: "specifyHeadersUsing",
+                    type: "options",
+                    noDataExpression: true,
+                    displayOptions: {
+                        show: {
+                            sendAdditionalHeaders: [true],
+                        },
+                    },
+                    options: [
+                        {
+                            name: "Fields",
+                            value: "keypair",
+                        },
+                        {
+                            name: "JSON",
+                            value: "json",
+                        },
+                    ],
+                    default: "keypair",
+                },
+                {
+                    displayName: "Header Fields",
+                    name: "headerFields",
+                    type: "fixedCollection",
+                    displayOptions: {
+                        show: {
+                            sendAdditionalHeaders: [true],
+                            specifyHeadersUsing: ["keypair"],
+                        },
+                    },
+                    typeOptions: {
+                        multipleValues: true,
+                    },
+                    placeholder: "Add Header Field",
+                    routing: {
+                        send: { preSend: [populateHeaderFields] },
+                    },
+                    default: {
+                        parameters: [
+                            {
+                                name: "",
+                                value: "",
+                            },
+                        ],
+                    },
+                    options: [
+                        {
+                            name: "parameters",
+                            displayName: "Parameter",
+                            values: [
+                                {
+                                    displayName: "Name",
+                                    name: "name",
+                                    type: "string",
+                                    default: "",
+                                    placeholder: "e.g. X-Title",
+                                },
+                                {
+                                    displayName: "Value",
+                                    name: "value",
+                                    type: "string",
+                                    default: "",
+                                    placeholder: "e.g. This is a title",
+                                },
+                            ],
+                        },
+                    ],
+                },
+                {
+                    displayName: "JSON Headers",
+                    name: "jsonHeaders",
+                    type: "json",
+                    displayOptions: {
+                        show: {
+                            sendAdditionalHeaders: [true],
+                            specifyHeadersUsing: ["json"],
+                        },
+                    },
+                    routing: {
+                        send: { preSend: [populateJsonHeaders] },
+                    },
+                    default: '{ "X-Title": "This is a title" }',
+                },
+            ],
+        };
+    }
+}
+exports.Ntfy = Ntfy;
+async function populateMessage(opts) {
+    opts.body = this.getNodeParameter("message");
+    return opts;
+}
+async function populateHeaderFields(opts) {
+    var _a;
+    (_a = opts.headers) !== null && _a !== void 0 ? _a : (opts.headers = {});
+    const { parameters } = this.getNodeParameter("headerFields");
+    for (const p of parameters) {
+        opts.headers[p.name] = p.value;
+    }
+    return opts;
+}
+async function populateJsonHeaders(opts) {
+    opts.headers = JSON.parse(this.getNodeParameter("jsonHeaders"));
+    return opts;
+}

package/dist/NtfyApi.credentials.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NtfyApi = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+class NtfyApi {
+    constructor() {
+        this.name = "ntfyApi";
+        this.displayName = "ntfy API";
+        this.icon = { light: "file:ntfy.light.svg", dark: "file:ntfy.dark.svg" };
+        this.properties = [
+            {
+                displayName: "Base URL",
+                name: "baseUrl",
+                type: "string",
+                default: "https://ntfy.sh",
+                description: "Base URL of the ntfy instance",
+                required: true,
+            },
+            {
+                displayName: "Auth Type",
+                name: "authType",
+                type: "options",
+                description: '<a href="https://docs.ntfy.sh/publish/#authentication">Auth type</a> to use',
+                required: true,
+                options: [
+                    {
+                        name: "No Auth",
+                        value: "noAuth",
+                    },
+                    {
+                        name: "Basic Auth",
+                        value: "basicAuth",
+                    },
+                    {
+                        name: "Bearer Auth",
+                        value: "bearerAuth",
+                    },
+                    {
+                        name: "Query Auth",
+                        value: "queryAuth",
+                    },
+                ],
+                default: "noAuth",
+            },
+            {
+                displayName: "Username",
+                name: "username",
+                type: "string",
+                description: '<a href="https://docs.ntfy.sh/publish/#username-password">Username</a> for basic auth',
+                default: "",
+                required: true,
+                displayOptions: {
+                    show: {
+                        authType: ["basicAuth"],
+                    },
+                },
+            },
+            {
+                displayName: "Password",
+                name: "password",
+                type: "string",
+                description: '<a href="https://docs.ntfy.sh/publish/#username-password">Password</a> for basic auth',
+                typeOptions: {
+                    password: true,
+                },
+                default: "",
+                placeholder: "e.g. mypassword123",
+                required: true,
+                displayOptions: {
+                    show: {
+                        authType: ["basicAuth"],
+                    },
+                },
+            },
+            {
+                displayName: "Bearer Token",
+                name: "bearerToken",
+                required: true,
+                description: '<a href="https://docs.ntfy.sh/publish/#access-tokens">Bearer token</a> for bearer auth',
+                type: "string",
+                typeOptions: { password: true },
+                default: "",
+                placeholder: "e.g. tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2",
+                displayOptions: {
+                    show: {
+                        authType: ["bearerAuth"],
+                    },
+                },
+            },
+            {
+                displayName: "Query Parameter",
+                name: "queryParameter",
+                type: "string",
+                required: true,
+                description: '<a href="https://docs.ntfy.sh/publish/#query-param">Query parameter</a> for auth',
+                default: "",
+                displayOptions: {
+                    show: {
+                        authType: ["queryAuth"],
+                    },
+                },
+            },
+        ];
+        this.test = {
+            request: {
+                baseURL: '={{ $credentials.baseUrl }}',
+                url: '/v1/health',
+            },
+        };
+    }
+    async authenticate(credentials, opts) {
+        const c = credentials;
+        if (c.authType === "noAuth")
+            return opts;
+        if (c.authType === "basicAuth") {
+            opts.auth = { username: c.username, password: c.password };
+            return opts;
+        }
+        if (c.authType === "bearerAuth") {
+            opts.headers = {
+                Authorization: `Bearer ${c.bearerToken}`,
+            };
+            return opts;
+        }
+        if (c.authType === "queryAuth") {
+            opts.url = `${opts.url}?auth=${c.queryParameter}`;
+            return opts;
+        }
+        throw new n8n_workflow_1.ApplicationError("Invalid credentials type");
+    }
+}
+exports.NtfyApi = NtfyApi;

package/dist/ntfy.dark.svg

@@ -0,0 +1,7 @@
+<svg width="800" height="800" viewBox="0 0 50.8 50.8" xmlns="http://www.w3.org/2000/svg">
+  <g style="stroke:#fff;stroke-opacity:1">
+    <path d="M44.98 39.952V10.848H7.407v27.814l-1.587 4.2 8.393-2.91Z" style="fill:none;fill-opacity:1;stroke:#fff;stroke-width:3.175;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:3;stroke-dasharray:none;stroke-opacity:1;paint-order:markers fill stroke"/>
+    <path d="M27.781 31.485h8.202" style="fill:none;fill-opacity:1;stroke:#fff;stroke-width:3.175;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:3;stroke-dasharray:none;stroke-opacity:1;paint-order:markers stroke fill"/>
+    <path d="m65.979 100.011 9.511 5.492-9.511 5.491" style="display:inline;fill:none;fill-opacity:1;stroke:#fff;stroke-width:3.175;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:3;stroke-dasharray:none;stroke-opacity:1;paint-order:markers stroke fill" transform="translate(-51.81 -80.758)"/>
+  </g>
+</svg>

package/dist/ntfy.light.svg

@@ -0,0 +1,7 @@
+<svg width="800" height="800" viewBox="0 0 50.8 50.8" xmlns="http://www.w3.org/2000/svg">
+  <g style="stroke:#000;stroke-opacity:1">
+    <path d="M44.98 39.952V10.848H7.407v27.814l-1.587 4.2 8.393-2.91Z" style="fill:none;fill-opacity:1;stroke:#000;stroke-width:3.175;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:3;stroke-dasharray:none;stroke-opacity:1;paint-order:markers fill stroke"/>
+    <path d="M27.781 31.485h8.202" style="fill:none;fill-opacity:1;stroke:#000;stroke-width:3.175;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:3;stroke-dasharray:none;stroke-opacity:1;paint-order:markers stroke fill"/>
+    <path d="m65.979 100.011 9.511 5.492-9.511 5.491" style="display:inline;fill:none;fill-opacity:1;stroke:#000;stroke-width:3.175;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:3;stroke-dasharray:none;stroke-opacity:1;paint-order:markers stroke fill" transform="translate(-51.81 -80.758)"/>
+  </g>
+</svg>

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "n8n-nodes-ntfy-next",
+  "version": "1.0.0",
+  "description": "n8n community package to push messages via ntfy.sh",
+  "keywords": [
+    "n8n-community-node-package",
+    "ntfy"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Iván Ovejero"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ivov/n8n-nodes-ntfy.git"
+  },
+  "engines": {
+    "node": ">=20.15",
+    "pnpm": ">=9.15"
+  },
+  "packageManager": "pnpm@9.15.1",
+  "main": "index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && cp src/*.svg dist/"
+  },
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": [
+      "dist/NtfyApi.credentials.js"
+    ],
+    "nodes": [
+      "dist/Ntfy.node.js"
+    ]
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  }
+}