n8n-nodes-innotes 1.0.0

package/README.md

@@ -0,0 +1,305 @@
+# InNotes N8N Node
+
+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.
+
+## 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 username/password credentials
+
+## 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
+   ```
+
+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:
+
+```bash
+# Install dependencies
+yarn install
+
+# Run linting
+yarn lint
+
+# Run tests
+yarn test
+
+# Watch mode for development
+yarn dev
+
+# Build for production
+yarn build
+```
+
+## 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:
+   - **Username**: Your InNotes account email
+   - **Password**: Your InNotes account password
+   - **Base URL**: Your InNotes instance URL (e.g., `https://app.innotes.com`)
+
+### 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
+
+#### Search Contacts
+- **Resource**: Contact
+- **Operation**: Search
+- **Parameters**:
+  - Query: Search term (name, email, company)
+  - Filters: Additional filtering options
+
+### Managing Notes
+
+#### 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
+
+#### Get Notes for Contact
+- **Resource**: Note
+- **Operation**: Get All
+- **Parameters**:
+  - Contact ID: Filter notes by contact
+  - Date Range: Filter by creation date
+
+### Managing Jobs
+
+#### Track Job Application
+- **Resource**: Job
+- **Operation**: Create
+- **Required Fields**:
+  - Title: Job title
+  - Company: Company name
+- **Optional Fields**:
+  - Status, URL, Description, Salary Range, etc.
+
+#### Update Job Status
+- **Resource**: Job
+- **Operation**: Update
+- **Fields**:
+  - Job ID: ID of the job to update
+  - Status: New status (applied, interviewing, offer, etc.)
+
+### Managing Tags and Statuses
+
+#### Create Custom Tags
+- **Resource**: Tag
+- **Operation**: Create
+- **Fields**:
+  - Name: Tag name
+  - Color: Tag color (hex code)
+
+#### Update Contact Status
+- **Resource**: Status
+- **Operation**: Create/Update
+- **Fields**:
+  - Contact ID: Associated contact
+  - Status: Status value
+  - Type: Status type
+
+## Workflow Integration Examples
+
+### 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 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
+
+### 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
+
+## API Reference
+
+### Resources
+
+| 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
+
+```bash
+# Run all tests
+yarn test
+
+# Run tests in watch mode
+yarn test:watch
+
+# Run tests with coverage
+yarn test:coverage
+```
+
+## 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
+
+## 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

package/dist/credentials/InNotesApi.credentials.js

@@ -0,0 +1,108 @@
+"use strict";
+/**
+ * Author: Marco Visin
+ * Date: 2025-06-02
+ * Updated to support Bearer token authentication
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InNotesApi = void 0;
+class InNotesApi {
+    constructor() {
+        this.name = 'inNotesApi';
+        this.displayName = 'InNotes API';
+        this.documentationUrl = 'https://innotes.me';
+        this.icon = 'file:Logo_128.png';
+        this.properties = [
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: 'https://innotes.me',
+                description: 'The base URL of your InNotes instance',
+                required: true,
+            },
+            {
+                displayName: 'Authentication Method',
+                name: 'authMethod',
+                type: 'options',
+                options: [
+                    {
+                        name: 'Bearer Token',
+                        value: 'token',
+                    },
+                    {
+                        name: 'Username/Password (Legacy)',
+                        value: 'credentials',
+                    },
+                ],
+                default: 'token',
+                description: 'Choose your authentication method. Bearer token is recommended.',
+            },
+            {
+                displayName: 'Bearer Token',
+                name: 'token',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                description: 'Your InNotes API Bearer token. Generate one in your dashboard settings.',
+                required: true,
+                displayOptions: {
+                    show: {
+                        authMethod: ['token'],
+                    },
+                },
+            },
+            {
+                displayName: 'Username',
+                name: 'username',
+                type: 'string',
+                default: '',
+                description: 'Your InNotes username',
+                required: true,
+                displayOptions: {
+                    show: {
+                        authMethod: ['credentials'],
+                    },
+                },
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                description: 'Your InNotes password',
+                required: true,
+                displayOptions: {
+                    show: {
+                        authMethod: ['credentials'],
+                    },
+                },
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'Authorization': '={{$credentials.authMethod === "token" ? "Bearer " + $credentials.token : undefined}}',
+                    'username': '={{$credentials.authMethod === "credentials" ? $credentials.username : undefined}}',
+                    'password': '={{$credentials.authMethod === "credentials" ? $credentials.password : undefined}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl}}',
+                url: '/api/user',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.InNotesApi = InNotesApi;
+
+//# sourceMappingURL=InNotesApi.credentials.js.map

package/dist/credentials/InNotesApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../credentials/InNotesApi.credentials.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAUH,MAAa,UAAU;IAAvB;QACC,SAAI,GAAG,YAAY,CAAC;QACpB,gBAAW,GAAG,aAAa,CAAC;QAC5B,qBAAgB,GAAG,oBAAoB,CAAC;QACxC,SAAI,GAAS,mBAAmB,CAAC;QACjC,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,oBAAoB;gBAC7B,WAAW,EAAE,uCAAuC;gBACpD,QAAQ,EAAE,IAAI;aACd;YACD;gBACC,WAAW,EAAE,uBAAuB;gBACpC,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE;oBACR;wBACC,IAAI,EAAE,cAAc;wBACpB,KAAK,EAAE,OAAO;qBACd;oBACD;wBACC,IAAI,EAAE,4BAA4B;wBAClC,KAAK,EAAE,aAAa;qBACpB;iBACD;gBACD,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE,iEAAiE;aAC9E;YACD;gBACC,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,yEAAyE;gBACtF,QAAQ,EAAE,IAAI;gBACd,cAAc,EAAE;oBACf,IAAI,EAAE;wBACL,UAAU,EAAE,CAAC,OAAO,CAAC;qBACrB;iBACD;aACD;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,uBAAuB;gBACpC,QAAQ,EAAE,IAAI;gBACd,cAAc,EAAE;oBACf,IAAI,EAAE;wBACL,UAAU,EAAE,CAAC,aAAa,CAAC;qBAC3B;iBACD;aACD;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,uBAAuB;gBACpC,QAAQ,EAAE,IAAI;gBACd,cAAc,EAAE;oBACf,IAAI,EAAE;wBACL,UAAU,EAAE,CAAC,aAAa,CAAC;qBAC3B;iBACD;aACD;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,eAAe,EAAE,uFAAuF;oBACxG,UAAU,EAAE,oFAAoF;oBAChG,UAAU,EAAE,oFAAoF;iBAChG;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AAhGD,gCAgGC","file":"InNotesApi.credentials.js","sourcesContent":["/**\n * Author: Marco Visin\n * Date: 2025-06-02\n * Updated to support Bearer token authentication\n */\n\nimport {\n\tIAuthenticateGeneric,\n\tICredentialTestRequest,\n\tICredentialType,\n\tINodeProperties,\n\tIcon,\n} from 'n8n-workflow';\n\nexport class InNotesApi implements ICredentialType {\n\tname = 'inNotesApi';\n\tdisplayName = 'InNotes API';\n\tdocumentationUrl = 'https://innotes.me';\n\ticon: Icon = 'file:Logo_128.png';\n\tproperties: INodeProperties[] = [\n\t\t{\n\t\t\tdisplayName: 'Base URL',\n\t\t\tname: 'baseUrl',\n\t\t\ttype: 'string',\n\t\t\tdefault: 'https://innotes.me',\n\t\t\tdescription: 'The base URL of your InNotes instance',\n\t\t\trequired: true,\n\t\t},\n\t\t{\n\t\t\tdisplayName: 'Authentication Method',\n\t\t\tname: 'authMethod',\n\t\t\ttype: 'options',\n\t\t\toptions: [\n\t\t\t\t{\n\t\t\t\t\tname: 'Bearer Token',\n\t\t\t\t\tvalue: 'token',\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tname: 'Username/Password (Legacy)',\n\t\t\t\t\tvalue: 'credentials',\n\t\t\t\t},\n\t\t\t],\n\t\t\tdefault: 'token',\n\t\t\tdescription: 'Choose your authentication method. Bearer token is recommended.',\n\t\t},\n\t\t{\n\t\t\tdisplayName: 'Bearer Token',\n\t\t\tname: 'token',\n\t\t\ttype: 'string',\n\t\t\ttypeOptions: {\n\t\t\t\tpassword: true,\n\t\t\t},\n\t\t\tdefault: '',\n\t\t\tdescription: 'Your InNotes API Bearer token. Generate one in your dashboard settings.',\n\t\t\trequired: true,\n\t\t\tdisplayOptions: {\n\t\t\t\tshow: {\n\t\t\t\t\tauthMethod: ['token'],\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdisplayName: 'Username',\n\t\t\tname: 'username',\n\t\t\ttype: 'string',\n\t\t\tdefault: '',\n\t\t\tdescription: 'Your InNotes username',\n\t\t\trequired: true,\n\t\t\tdisplayOptions: {\n\t\t\t\tshow: {\n\t\t\t\t\tauthMethod: ['credentials'],\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdisplayName: 'Password',\n\t\t\tname: 'password',\n\t\t\ttype: 'string',\n\t\t\ttypeOptions: {\n\t\t\t\tpassword: true,\n\t\t\t},\n\t\t\tdefault: '',\n\t\t\tdescription: 'Your InNotes password',\n\t\t\trequired: true,\n\t\t\tdisplayOptions: {\n\t\t\t\tshow: {\n\t\t\t\t\tauthMethod: ['credentials'],\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t];\n\n\tauthenticate: IAuthenticateGeneric = {\n\t\ttype: 'generic',\n\t\tproperties: {\n\t\t\theaders: {\n\t\t\t\t'Authorization': '={{$credentials.authMethod === \"token\" ? \"Bearer \" + $credentials.token : undefined}}',\n\t\t\t\t'username': '={{$credentials.authMethod === \"credentials\" ? $credentials.username : undefined}}',\n\t\t\t\t'password': '={{$credentials.authMethod === \"credentials\" ? $credentials.password : undefined}}',\n\t\t\t},\n\t\t},\n\t};\n\n\ttest: ICredentialTestRequest = {\n\t\trequest: {\n\t\t\tbaseURL: '={{$credentials.baseUrl}}',\n\t\t\turl: '/api/user',\n\t\t\tmethod: 'GET',\n\t\t},\n\t};\n}\n"]}

package/dist/credentials/InNotesApi.credentials.ts

@@ -0,0 +1,111 @@
+/**
+ * Author: Marco Visin
+ * Date: 2025-06-02
+ * Updated to support Bearer token authentication
+ */
+
+import {
+	IAuthenticateGeneric,
+	ICredentialTestRequest,
+	ICredentialType,
+	INodeProperties,
+	Icon,
+} from 'n8n-workflow';
+
+export class InNotesApi implements ICredentialType {
+	name = 'inNotesApi';
+	displayName = 'InNotes API';
+	documentationUrl = 'https://innotes.me';
+	icon: Icon = 'file:Logo_128.png';
+	properties: INodeProperties[] = [
+		{
+			displayName: 'Base URL',
+			name: 'baseUrl',
+			type: 'string',
+			default: 'https://innotes.me',
+			description: 'The base URL of your InNotes instance',
+			required: true,
+		},
+		{
+			displayName: 'Authentication Method',
+			name: 'authMethod',
+			type: 'options',
+			options: [
+				{
+					name: 'Bearer Token',
+					value: 'token',
+				},
+				{
+					name: 'Username/Password (Legacy)',
+					value: 'credentials',
+				},
+			],
+			default: 'token',
+			description: 'Choose your authentication method. Bearer token is recommended.',
+		},
+		{
+			displayName: 'Bearer Token',
+			name: 'token',
+			type: 'string',
+			typeOptions: {
+				password: true,
+			},
+			default: '',
+			description: 'Your InNotes API Bearer token. Generate one in your dashboard settings.',
+			required: true,
+			displayOptions: {
+				show: {
+					authMethod: ['token'],
+				},
+			},
+		},
+		{
+			displayName: 'Username',
+			name: 'username',
+			type: 'string',
+			default: '',
+			description: 'Your InNotes username',
+			required: true,
+			displayOptions: {
+				show: {
+					authMethod: ['credentials'],
+				},
+			},
+		},
+		{
+			displayName: 'Password',
+			name: 'password',
+			type: 'string',
+			typeOptions: {
+				password: true,
+			},
+			default: '',
+			description: 'Your InNotes password',
+			required: true,
+			displayOptions: {
+				show: {
+					authMethod: ['credentials'],
+				},
+			},
+		},
+	];
+
+	authenticate: IAuthenticateGeneric = {
+		type: 'generic',
+		properties: {
+			headers: {
+				'Authorization': '={{$credentials.authMethod === "token" ? "Bearer " + $credentials.token : undefined}}',
+				'username': '={{$credentials.authMethod === "credentials" ? $credentials.username : undefined}}',
+				'password': '={{$credentials.authMethod === "credentials" ? $credentials.password : undefined}}',
+			},
+		},
+	};
+
+	test: ICredentialTestRequest = {
+		request: {
+			baseURL: '={{$credentials.baseUrl}}',
+			url: '/api/user',
+			method: 'GET',
+		},
+	};
+}