n8n-nodes-ninjapipe 0.1.0 → 0.4.0

package/INSTALL.md

@@ -0,0 +1,20 @@
+# Install
+
+## Update and publish
+
+```bash
+cd ~/Desktop/n8n-nodes-ninjapipe
+npm install
+npm version patch
+npm publish
+```
+
+This package is plain JavaScript and does not need a TypeScript build step anymore.
+
+## In n8n
+
+Install or update the community node package:
+
+```
+n8n-nodes-ninjapipe
+```

package/README.md

@@ -1,48 +1,52 @@
 # n8n-nodes-ninjapipe
 
-Community node for NinjaPipe.
-
-## Included
-
-- NinjaPipe API credentials
-- Resources:
-  - Contacts
-  - Deals
-  - Products
-  - Budgets
-  - Custom API Request
-
-## Current scope
-
-This package is built from the public NinjaPipe API documentation that clearly exposes authentication with Bearer API keys, a `/api/...` base path, contacts, deals, products, budgets, pagination, and client-portal actions. Anything beyond that should be added once the endpoint contract is verified in the docs.
-
-## Install locally
-
-```bash
-npm install
-npm run build
-npm link
-```
-
-In your n8n custom extensions folder, link or install the package and restart n8n.
-
-## Credentials
-
-- API Key
-- Base URL, default: `https://www.ninjapipe.app/api`
+Usability-first NinjaPipe package for n8n.
+
+## What is inside
+
+- `NinjaPipe` action node
+  - guided fields for Contacts, Companies, Deals, Tasks, Projects, Products, Budgets
+  - custom fields as repeatable key/value fields
+  - additional standard fields for fields not yet exposed in the UI
+  - field discovery via **Get Field List**
+  - flatten custom fields into normal output fields
+  - custom API request fallback
+- `NinjaPipe Trigger`
+  - generic polling trigger for Contacts, Companies, Deals, Tasks, Databins, or any custom path
+  - practical for lead capture and Databin-style submissions
+
+## Recommended usage
+
+### Create a contact without raw JSON
+Use `Resource = Contact` and `Operation = Create`.
+Fill the guided fields.
+Add any workspace-specific fields under **Additional Fields**.
+Add business-specific fields under **Custom Fields**.
+
+### Discover which fields exist
+Use `Operation = Get Field List`.
+This samples one or more records and returns
+- top-level field names
+- custom field keys
+- a sample record
+
+### Simple filters without JSON
+For `Get Many`, use
+- Search
+- Status Filter
+- Owner Filter
+- Query Parameters
+
+Only use `Advanced Query JSON` when the API needs something special.
+
+### Trigger on form-like submissions
+If your NinjaPipe setup stores incoming web submissions in a Databin-style endpoint, use `NinjaPipe Trigger` with
+- `Resource = Databins`, or
+- `Path Override = /your/custom/path`
+
+Then connect the trigger to an email node or to a second NinjaPipe node for contact creation, deal creation, list assignment, or task creation.
 
 ## Notes
 
-- Pagination defaults to page 1 and limit 20.
-- NinjaPipe documentation mentions a maximum limit of 100 for paginated list endpoints.
-- Contacts support client portal enable and disable as documented.
-
-## Next expansion ideas
-
-- Companies
-- Tasks
-- Projects
-- Forms
-- Files
-- Webhook trigger node
-- Load options from live endpoints
+- This package intentionally keeps a **Custom API Request** option because NinjaPipe's product surface is broader than the publicly obvious API snippets.
+- Custom field values are supported directly. Custom field **schema creation** is not hard-coded because a public endpoint for custom field definitions was not clearly exposed in the verified API docs. Use `Additional Fields`, `Custom Fields`, and `Custom API Request` as the safe fallback.

package/credentials/NinjaPipeApi.credentials.js

@@ -0,0 +1,32 @@
+
+class NinjaPipeApi {
+	constructor() {
+		this.name = 'ninjaPipeApi';
+		this.displayName = 'NinjaPipe API';
+		this.documentationUrl = 'https://docs.ninjapipe.app/api-docs';
+		this.properties = [
+			{
+				displayName: 'Base URL',
+				name: 'baseUrl',
+				type: 'string',
+				default: 'https://www.ninjapipe.app/api',
+				placeholder: 'https://www.ninjapipe.app/api',
+				required: true,
+				description: 'Base URL of the NinjaPipe API',
+			},
+			{
+				displayName: 'API Key',
+				name: 'apiKey',
+				type: 'string',
+				typeOptions: {
+					password: true,
+				},
+				default: '',
+				required: true,
+				description: 'Workspace API key',
+			},
+		];
+	}
+}
+
+module.exports = { NinjaPipeApi };

package/examples/databin-lead-to-contact.json

@@ -0,0 +1,54 @@
+{
+  "name": "NinjaPipe Databin Lead to Email Example",
+  "nodes": [
+    {
+      "parameters": {
+        "resource": "databin",
+        "eventMode": "new",
+        "timestampField": "created_at",
+        "emitOnlyAfterStart": true
+      },
+      "id": "1",
+      "name": "NinjaPipe Trigger",
+      "type": "n8n-nodes-ninjapipe.ninjaPipeTrigger",
+      "typeVersion": 1,
+      "position": [
+        360,
+        300
+      ]
+    },
+    {
+      "parameters": {
+        "resource": "contact",
+        "operation": "create",
+        "useGuidedFields": true,
+        "contactFirstName": "={{$json.first_name || $json.name || ''}}",
+        "contactLastName": "={{$json.last_name || ''}}",
+        "contactEmail": "={{$json.email || ''}}",
+        "contactPhone": "={{$json.phone || ''}}",
+        "contactNotes": "={{$json.message || ''}}"
+      },
+      "id": "2",
+      "name": "Create Contact",
+      "type": "n8n-nodes-ninjapipe.ninjaPipe",
+      "typeVersion": 3,
+      "position": [
+        660,
+        300
+      ]
+    }
+  ],
+  "connections": {
+    "NinjaPipe Trigger": {
+      "main": [
+        [
+          {
+            "node": "Create Contact",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    }
+  }
+}

package/index.js

@@ -0,0 +1 @@
+module.exports = {};