n8n-nodes-didar-crm 0.0.6 → 0.0.8

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025
+Copyright (c) 2025 Ali Mozayyani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -1,45 +1,138 @@
 # n8n-nodes-didar-crm
 
-Community node for [n8n](https://n8n.io) to integrate with [Didar CRM](https://app.didar.me).
+Custom **n8n nodes** for integrating with **Didar CRM**.
+This package provides actions and triggers to automate workflows with your Didar CRM account.
 
-This node allows you to:
-- **Trigger workflows** from Didar CRM webhooks  
-- **Create Deals** with all required fields (Title, Owner, Pipeline, Stage, Person, Company, Status)  
-- Use **Additional Fields** like description, source, lost reason, price, currency, custom fields, etc.  
-- Select Owner, Pipeline, and Stage from dropdowns (or manually enter IDs).  
+---
+
+## ✨ Features
+
+* **Trigger**
+
+  * Receive webhook events from Didar CRM (entity changes, updates, deletions, etc.)
+
+* **Deal**
+
+  * Create a deal
+  * Update a deal (by Id)
+  * Get deal details (by Id)
+
+* **Person (Contact)**
+
+  * Create a person
+  * Update a person (by Id)
+  * Get person details (by Id)
+
+* **Common**
+
+  * Dropdown selectors for Pipelines, Pipeline Stages, Owners (Users)
+  * Manual ID input option for each dropdown field
+  * Support for additional fields like Source, Lost Reason, Visibility Type, Custom Fields, etc.
+  * Proper handling of default values (zero-guid where needed)
+  * Webhook trigger enforces POST requests
+
+---
+
+## 📦 Installation
+
+```bash
+npm install n8n-nodes-didar-crm
+```
 
-More operations (update deal, get deal, person/company operations) will be added soon.
+Then, place the module inside your n8n custom directory (usually `~/.n8n/custom/`) and restart n8n.
 
 ---
 
-## ⚙️ Installation
+## ⚡ Usage
+
+### 1. Trigger node
+
+Add the **Didar CRM Trigger** node to your workflow.
+
+* It exposes a webhook URL in n8n.
+* Only **POST** requests are accepted.
+* Returns payload structured into:
 
-In your n8n instance, go to:
+  ```json
+  {
+    "data": { ... }, 
+    "changes": [ ... ], 
+    "meta": { ... }, 
+    "raw": { ... },
+    "receivedAt": "timestamp"
+  }
+  ```
 
-`Settings > Community Nodes > Install`
+### 2. Deal operations
 
-and enter: n8n-nodes-didar-crm
+* **Create Deal** → required fields: `Title`, `OwnerId`, `PipelineId`, `PipelineStageId`, `PersonId`, `CompanyId`, `Status`
+* **Update Deal** → same as Create, plus required `Id`
+* **Get Deal** → requires `Id`
 
+### 3. Person (Contact) operations
+
+* **Create Person** → required fields: `LastName`, `OwnerId`
+* **Update Person** → same as Create, plus required `Id`
+* **Get Person** → requires `Id`
 
 ---
 
-## 🔑 Authentication
+## 🔑 Credentials
+
+A new credential type **Didar API** is provided.
+
+* You must set your **API Key** and (if required) authentication cookies.
+* Used across all operations.
 
-Currently the node uses an **API Key** (query param `?apikey=...`) for authentication.  
-You need to generate and provide your API key from your Didar CRM account.
+---
+
+## 📂 Project structure
+
+```
+n8n-nodes-didar-crm/
+│── package.json
+│── README.md
+│── LICENSE
+│── nodes/
+│    ├── DidarCrm.node.ts        # Main entry for resource & operation switch
+│    ├── DidarCrmTrigger.node.ts # Trigger node
+│    └── deal/                   # Deal operations
+│         ├── create.operation.ts
+│         ├── update.operation.ts
+│         └── get.operation.ts
+│    └── person/                 # Person operations
+│         ├── create.operation.ts
+│         ├── update.operation.ts
+│         └── get.operation.ts
+│── lib/
+     ├── http.ts                  # Request helper
+     └── loadOptions.ts           # Dropdown population (pipelines, stages, users)
+```
 
 ---
 
-## 🧪 Development
+## 🛠 Development
 
-Clone repo and build:
+1. Clone the repo
+2. Install dependencies:
 
-```bash
-npm install
-npm run build
+   ```bash
+   npm install
+   ```
+3. Build:
+
+   ```bash
+   npm run build
+   ```
+4. Link into your n8n custom directory and restart n8n:
+
+   ```bash
+   npm link
+   n8n start
+   ```
+
+---
 
-For local testing in n8n:
+## 📜 License
 
-# inside n8n custom folder
-cd ~/.n8n/custom
-npm install /path/to/n8n-nodes-didar-crm
+MIT License – see [LICENSE](./LICENSE) for details.