n8n-nodes-innotes 2.0.11 → 2.0.12

package/README.md

@@ -1,311 +1,100 @@
-# InNotes N8N Node
+# n8n-nodes-innotes
 
-An N8N custom node that enables seamless integration with the InNotes LinkedIn CRM application. This node allows you to automate workflows involving contacts, notes, jobs, statuses, tags, and user management within the InNotes platform.
+An n8n community node for the [InNotes](https://innotes.me) LinkedIn CRM API:
+contacts, notes, jobs, statuses, tags, the current user, and the job-automation
+callback.
 
-> **Note**
-> The LinkedIn scraper microservice node now lives in `../n8n_linkedin_scraper_node` so it can be published as an independent community package.
-
-## Features
-
-- **Complete CRUD Operations**: Create, read, update, and delete operations for all InNotes resources
-- **LinkedIn CRM Integration**: Specifically designed for LinkedIn-based contact management
-- **Comprehensive Resource Support**:
-  - Contacts (LinkedIn profiles, emails, phone numbers)
-  - Notes (conversation logs, meeting notes, follow-ups)
-  - Jobs (job applications, opportunities, tracking)
-  - Statuses (contact status management)
-  - Tags (categorization and organization)
-  - Users (user account management)
-- **Advanced Filtering**: Search and filter capabilities for efficient data retrieval
-- **Pagination Support**: Handle large datasets with built-in pagination
-- **Error Handling**: Robust error handling with meaningful error messages
-- **Authentication**: Secure API authentication using a Bearer token
+The LinkedIn scraper node is a separate package,
+[`n8n-nodes-linkedin-scraper`](https://github.com/mrc527/InNotes/tree/main/n8n_linkedin_scraper_node).
 
 ## Installation
 
-### Prerequisites
-
-- N8N instance (self-hosted or cloud)
-- Node.js 18+ and yarn package manager
-- Access to InNotes API credentials
-
-### Building the Node
-
-1. Clone or download this node package to your local machine
-2. Install dependencies:
-   ```bash
-   yarn install
-   ```
-
-3. Build the node:
-   ```bash
-   yarn build
-   ```
+In n8n: **Settings → Community Nodes → Install** → `n8n-nodes-innotes`.
 
-4. Link the node to your N8N installation:
-   ```bash
-   # For local N8N development
-   yarn link
-   cd /path/to/your/n8n
-   yarn link n8n-nodes-innotes
-   
-   # Or copy the dist folder to your N8N custom nodes directory
-   cp -r dist/* ~/.n8n/custom/
-   ```
-
-### Development
-
-For development and testing:
+Manual build from source (Node >= 18.10, yarn 1):
 
 ```bash
-# Install dependencies
 yarn install
-
-# Run linting
-yarn lint
-
-# Run tests
-yarn test
-
-# Watch mode for development
-yarn dev
-
-# Build for production
 yarn build
+cp -r dist/* ~/.n8n/custom/   # then restart n8n
 ```
 
-## Configuration
-
-### API Credentials
-
-Before using the InNotes node, you need to configure your API credentials:
-
-1. In N8N, go to **Credentials** → **Create New**
-2. Search for **InNotes API** and select it
-3. Fill in the required fields:
-   - **Bearer Token**: Generate one in your InNotes dashboard, under settings
-   - **Base URL**: Your InNotes instance URL (e.g., `https://app.innotes.com`)
-
-   > Versions before 2.0.0 also offered "Username/Password (Legacy)". That
-   > scheme has been removed from InNotes; regenerate the credential with a
-   > Bearer token.
-
-### Node Setup
-
-1. Add the **InNotes** node to your workflow
-2. Select your configured credentials
-3. Choose the **Resource** (Contact, Note, Job, Status, Tag, User)
-4. Select the desired **Operation** (Get, Create, Update, Delete, etc.)
-5. Configure the specific parameters for your operation
-
-## Usage Examples
-
-### Managing Contacts
-
-#### Get All Contacts
-- **Resource**: Contact
-- **Operation**: Get All
-- **Parameters**:
-  - Limit: Number of contacts to retrieve (default: 50)
-  - Return All: Whether to return all contacts or paginate
-
-#### Create New Contact
-- **Resource**: Contact
-- **Operation**: Create
-- **Required Fields**:
-  - Name: Contact's full name
-  - LinkedIn URL: LinkedIn profile URL
-- **Optional Fields**:
-  - Email, Phone, Company, Position, etc.
-
-#### Update Contact
-- **Resource**: Contact
-- **Operation**: Update
-- **Required Fields**:
-  - Contact ID: ID of the contact to update
-- **Update Fields**: Any contact fields you want to modify
+## Credentials
 
-#### Search Contacts
-- **Resource**: Contact
-- **Operation**: Search
-- **Parameters**:
-  - Query: Search term (name, email, company)
-  - Filters: Additional filtering options
+Create an **InNotes API** credential:
 
-### Managing Notes
+| Field | Notes |
+|---|---|
+| Base URL | Your InNotes instance. Default `https://innotes.me` |
+| Bearer Token | Generate in the InNotes dashboard settings |
+| Callback Secret | Required — the node refuses to run **Automation → Report Job Created** without a value. InNotes fills it in when it provisions your automation; setting the credential up by hand, any non-empty value works, because the callback authenticates with the Bearer token above |
+| Allowed Domains | `*` for all |
 
-#### Create Note
-- **Resource**: Note
-- **Operation**: Create
-- **Required Fields**:
-  - Contact ID: ID of the associated contact
-  - Content: Note content (supports rich text)
-- **Optional Fields**:
-  - Type: Note type (meeting, call, email, etc.)
-  - Tags: Associated tags
+The credential is tested against `GET /api/user`.
 
-#### Get Notes for Contact
-- **Resource**: Note
-- **Operation**: Get All
-- **Parameters**:
-  - Contact ID: Filter notes by contact
-  - Date Range: Filter by creation date
+Username/password auth was removed in 2.0.0. Regenerate any older credential
+with a Bearer token.
 
-### Managing Jobs
+## Resources and operations
 
-#### Track Job Application
-- **Resource**: Job
-- **Operation**: Create
-- **Required Fields**:
-  - Title: Job title
-  - Company: Company name
-- **Optional Fields**:
-  - Status, URL, Description, Salary Range, etc.
+| Resource | Operations |
+|---|---|
+| Automation | Get Config, Report Job Created |
+| Contact | Create, Get, Get Many, Update, Delete |
+| Note | Create, Get (both broken — see below) |
+| Job | Create, Get, Get All, Search, Update, Delete, Exists, Batch Exists |
+| Status | Get All, Create |
+| Tag | Get All |
+| User | Get, Get CV |
 
-#### Update Job Status
-- **Resource**: Job
-- **Operation**: Update
-- **Fields**:
-  - Job ID: ID of the job to update
-  - Status: New status (applied, interviewing, offer, etc.)
+Required fields: Contact create needs **Name** and **LinkedIn Key**; Job create
+needs **Job Name** and **Company Name**.
 
-### Managing Tags and Statuses
+**The Note resource is broken.** Its required fields are **External ID** and
+**Note Text**, but the executor reads `content`/`contactId` on create and
+`noteId` on get — declared nowhere — so a UI-filled node throws on the missing
+parameter, and *Get* would call `/api/note/{noteId}` rather than look up by
+external ID.
 
-#### Create Custom Tags
-- **Resource**: Tag
-- **Operation**: Create
-- **Fields**:
-  - Name: Tag name
-  - Color: Tag color (hex code)
+Job **Search** takes a search method: `general`, `ext_id`, `title`, `company`,
+`location`, `description`. **Batch Exists** takes a comma-separated list of
+external IDs and posts them to `/api/job/batch-exists` in chunks of 200.
 
-#### Update Contact Status
-- **Resource**: Status
-- **Operation**: Create/Update
-- **Fields**:
-  - Contact ID: Associated contact
-  - Status: Status value
-  - Type: Status type
+### Pagination
 
-## Workflow Integration Examples
+Contact *Get Many* takes **Return All** or a **Limit** (default 24). The limit
+is capped at 200 because `GET /api/contacts` clamps `pageSize` there — without
+the cap a request for 500 returns 200 rows with a 200 status and nothing to say
+it was truncated.
 
-### Automated LinkedIn Outreach
-1. **Trigger**: Webhook or schedule
-2. **InNotes Node**: Get contacts with specific tags
-3. **Filter**: Process only contacts without recent notes
-4. **InNotes Node**: Create follow-up notes
-5. **Email/LinkedIn Node**: Send personalized messages
+Job *Get All* offers neither: it exposes only Search Term and External ID, while
+the executor reads an undeclared `returnAll`/`limit`, so every call requests
+`pageSize=24, page=1` and cannot be changed.
 
-### Job Application Tracking
-1. **Trigger**: New job posting (webhook/RSS)
-2. **InNotes Node**: Create new job entry
-3. **InNotes Node**: Link to relevant contacts
-4. **InNotes Node**: Create application tracking note
-5. **Calendar Node**: Schedule follow-up reminders
+### Options
 
-### Contact Enrichment
-1. **Trigger**: New contact created
-2. **External API**: Enrich contact data (company info, etc.)
-3. **InNotes Node**: Update contact with enriched data
-4. **InNotes Node**: Create initial contact note
-5. **InNotes Node**: Apply relevant tags
+A node-level **Options** collection with **Batch Size** (default 10, max 100)
+and **Timeout Between Batches** in ms (default 1000), to stay under rate limits.
 
-## API Reference
+## Errors
 
-### Resources
+Failures raise `NodeApiError` with the operation and the request parameters.
+Contact creation reports only the **count** of `contact_details` entries, never
+the values — n8n persists execution data, and those are a third party's phone
+numbers and email addresses.
 
-| Resource | Operations | Description |
-|----------|------------|-------------|
-| Contact | Get All, Get, Create, Update, Delete, Search | LinkedIn contact management |
-| Note | Get All, Get, Create, Update, Delete | Conversation and meeting notes |
-| Job | Get All, Get, Create, Update, Delete | Job application tracking |
-| Status | Get All, Get, Create, Update, Delete | Contact status management |
-| Tag | Get All, Get, Create, Update, Delete | Categorization and organization |
-| User | Get, Update | User account management |
-
-### Common Parameters
-
-- **Limit**: Maximum number of items to return (pagination)
-- **Return All**: Override limit and return all items
-- **Sort By**: Field to sort results by
-- **Sort Order**: Ascending or descending sort
-- **Filters**: Resource-specific filtering options
-
-### Error Handling
-
-The node provides comprehensive error handling:
-
-- **Authentication Errors**: Invalid credentials or expired sessions
-- **Validation Errors**: Missing required fields or invalid data
-- **API Errors**: Server errors or rate limiting
-- **Network Errors**: Connection issues or timeouts
-
-All errors include detailed messages to help with troubleshooting.
-
-## Contributing
-
-### Development Setup
-
-1. Fork the repository
-2. Install dependencies: `yarn install`
-3. Make your changes
-4. Run tests: `yarn test`
-5. Run linting: `yarn lint`
-6. Build: `yarn build`
-7. Submit a pull request
-
-### Code Style
-
-- Follow TypeScript best practices
-- Use ESLint configuration provided
-- Add JSDoc comments for public methods
-- Include unit tests for new features
-- Follow existing naming conventions
-
-### Testing
+## Development
 
 ```bash
-# Run all tests
-yarn test
-
-# Run tests in watch mode
-yarn test:watch
-
-# Run tests with coverage
-yarn test:coverage
+yarn install
+yarn lint     # eslint (flat config, eslint.config.mjs)
+yarn test     # jest
+yarn build    # gulp: tsc -> dist/, plus icons, credentials, package.json
+yarn dev      # build + watch
 ```
 
-## Support
-
-### Documentation
-- [InNotes API Documentation](https://docs.innotes.com)
-- [N8N Documentation](https://docs.n8n.io)
-
-### Issues
-If you encounter any issues or have feature requests, please:
-1. Check existing issues in the repository
-2. Create a new issue with detailed description
-3. Include error messages and steps to reproduce
-
-### Community
-- Join the N8N Community Discord
-- Check the InNotes user community
+Publishing is automated — see `CI_SETUP.md`. Do not `npm publish` by hand.
 
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
-
-## Changelog
-
-### Version 1.0.0
-- Initial release
-- Support for all InNotes resources (Contact, Note, Job, Status, Tag, User)
-- Complete CRUD operations
-- Search and filtering capabilities
-- Pagination support
-- Comprehensive error handling
-- Full TypeScript support
-
----
-
-**Author**: marco  
-**Last Updated**: 2025-06-01
+MIT.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-innotes",
-  "version": "2.0.11",
+  "version": "2.0.12",
   "description": "N8N node for InNotes CRM API integration",
   "keywords": [
     "n8n-community-node-package",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-innotes",
-  "version": "2.0.11",
+  "version": "2.0.12",
   "description": "N8N node for InNotes CRM API integration",
   "keywords": [
     "n8n-community-node-package",