@brokenrubik/n8n-nodes-ns 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+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,235 @@
+# n8n-node-netsuite
+
+A comprehensive n8n node for NetSuite integration, providing full access to NetSuite's SuiteTalk REST API with OAuth 2.0 M2M authentication.
+
+## Features
+
+### 🔐 **Secure Authentication**
+
+- OAuth 2.0 Machine-to-Machine (M2M) authentication
+- JWT token-based authentication with PS256 algorithm
+- Automatic token caching and refresh
+- Certificate-based security
+
+### 📊 **Complete CRUD Operations**
+
+- **List Records**: Retrieve multiple records with pagination support
+- **Get Record**: Fetch individual records by ID
+- **Insert Record**: Create new records
+- **Update Record**: Modify existing records
+- **Remove Record**: Delete records
+
+### 🔍 **Advanced Query Capabilities**
+
+- **SuiteQL Support**: Execute SQL-like queries against NetSuite data
+- **Raw API Requests**: Direct access to any NetSuite REST endpoint
+- **Pagination Handling**: Automatic handling of large result sets
+- **Query Parameters**: Support for filters, limits, and offsets
+
+### 🛠️ **Developer-Friendly Features**
+
+- **Modular Architecture**: Clean, maintainable code structure
+- **Comprehensive Error Handling**: NetSuite-specific error parsing and reporting
+- **TypeScript Support**: Full type safety and IntelliSense
+- **Extensive Documentation**: Detailed comments and examples
+
+## Prerequisites
+
+### System Requirements
+
+- Node.js 20+ and npm
+- n8n installed globally: `npm install n8n -g`
+
+### NetSuite Requirements
+
+- NetSuite account with REST API access
+- OAuth 2.0 Application configured in NetSuite
+- Certificate and private key for M2M authentication
+- Appropriate permissions for the operations you want to perform
+
+## Installation
+
+### For Development
+
+```bash
+# Clone the repository
+git clone https://github.com/BrokenRubik/n8n-netsuite-node
+cd n8n-netsuite-node
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Link for local development
+npm link
+
+# Restart n8n to load the new node: https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/
+```
+
+## Setup Instructions
+
+### Step 1: Create NetSuite Integration Record
+
+1. **Navigate to Integration Setup**:
+   - Log into your NetSuite account
+   - Go to **Setup → Integration → Manage Integrations → New**
+
+2. **Configure Integration**:
+   - Enter a **Name** for your integration (e.g., "n8n NetSuite Integration")
+   - Set **State** to "Enabled"
+   - Under **Client Credentials (M2M)**, check **"Client Credentials (Machine To Machine) Grant"**
+   - Leave all other checkboxes unchecked
+   - Click **Save**
+
+3. **Copy Integration Client ID**:
+   - ⚠️ **Important**: After saving, immediately copy the **Integration Client ID**
+   - This ID will disappear if you close the tab or navigate away
+   - Store it securely as you'll need it for the n8n credentials
+
+### Step 2: Generate Certificate and Private Key
+
+1. **Create Certificate Pair**:
+   - Open a terminal/command prompt
+   - Generate a private key and certificate using OpenSSL:
+
+   ```bash
+   openssl req -x509 -newkey rsa:3072 -keyout n8n_key.pem -out n8n_cert.pem -days 365 -nodes\n
+   ```
+
+2. **Alternative: Using NetSuite's Guide**:
+   - Follow NetSuite's official certificate generation guide: [Creating Certificates for OAuth 2.0](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_162686838198.html)
+
+### Step 3: Upload Certificate to NetSuite
+
+1. **Navigate to Certificate Setup**:
+   - Go to **Setup → Integration → Manage Authentication → OAuth 2.0 Client Credentials (M2M) Setup**
+
+2. **Upload Certificate**:
+   - Click **"New"** to create a new certificate entry
+   - Enter a **Name** for the certificate (e.g., "n8n Integration Certificate")
+   - Upload the **certificate file** (`n8n_cert.pem`) - not the private key
+   - Click **Save**
+
+3. **Copy Certificate ID**:
+   - After saving, copy the generated **Certificate ID**
+   - You'll need this for the n8n credentials
+
+### Step 4: Set Up n8n Credentials
+
+1. **Open n8n**:
+   - Navigate to **Credentials** in n8n
+   - Click **"Add Credential"**
+   - Select **"NetSuite API"**
+
+2. **Enter Credential Information**:
+   - **Account ID**: Your NetSuite account ID (e.g., "1234567" or "1234567_SB1" for sandbox)
+   - **Integration Client ID**: The ID copied from Step 1
+   - **Certificate ID (M2M)**: The ID copied from Step 3
+   - **PEM Content**: Copy and paste the entire content of your private key file (`n8n_key.pem`)
+
+3. **PEM Content Format**:
+
+   ```
+   -----BEGIN PRIVATE KEY-----
+   MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQC...
+   ... (your private key content) ...
+   -----END PRIVATE KEY-----
+   ```
+
+### Step 5: Test the Connection
+
+1. **Create a Test Workflow**:
+   - Create a new workflow in n8n
+   - Add a **NetSuite** node
+   - Configure it to list a simple record type (e.g., Customer)
+   - Execute the workflow to verify the connection
+
+## Usage Examples
+
+### List Sales Orders
+
+```javascript
+// Operation: List Records
+// Record Type: Sales Order
+// Query: status:pendingFulfillment
+// Limit: 100
+```
+
+### Create Customer Record
+
+```javascript
+// Operation: Insert Record
+// Record Type: Customer
+// Input data:
+{
+  "companyName": "Acme Corp",
+  "email": "contact@acme.com",
+  "phone": "+1-555-0123"
+}
+```
+
+### Execute SuiteQL Query
+
+```javascript
+// Operation: Execute SuiteQL
+// Query: SELECT id, companyName FROM customer WHERE dateCreated >= '2024-01-01'
+// Limit: 1000
+```
+
+### Raw API Request
+
+```javascript
+// Operation: Raw Request
+// Method: GET
+// Path: /services/rest/record/v1/customer/123
+// Full Response: true
+```
+
+## Architecture
+
+### Modular Design
+
+- **Main Node**: Orchestrates operations and handles authentication
+- **Service Layer**: Manages API communication and token handling
+- **Operation Modules**: Individual handlers for each operation type
+- **Type System**: Comprehensive TypeScript definitions
+- **Utilities**: Shared helper functions and response handlers
+
+### Error Handling
+
+- Follows NetSuite's official error format documentation
+- Provides detailed error messages with context
+- Supports graceful degradation with "Continue on Fail"
+- Includes error codes, paths, and actionable guidance
+
+## Development
+
+### Project Structure
+
+```
+├── nodes/NetSuite/
+│   ├── types/           # TypeScript type definitions
+│   ├── utils/           # Utility functions
+│   ├── operations/      # Operation implementations
+│   ├── NetSuite.node.ts # Main node class
+│   └── NetSuite.service.ts # API service layer
+├── credentials/         # Authentication configuration
+└── dist/               # Built output
+```
+
+### Adding New Operations
+
+1. Create operation file in `operations/` directory
+2. Export function from `operations/index.ts`
+3. Add case to switch statement in `NetSuite.node.ts`
+4. Add UI configuration to `NetSuite.node.options.ts`
+
+## Troubleshooting
+
+### Debug Information
+
+- Enable debug logging with `DEBUG=n8n-nodes-netsuite`
+- Check n8n logs for detailed error messages
+- Verify NetSuite audit trail for failed requests

package/dist/credentials/NetSuiteApi.credentials.d.ts

@@ -0,0 +1,8 @@
+import { IAuthenticateGeneric, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class NetSuiteApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+}

package/dist/credentials/NetSuiteApi.credentials.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetSuiteApi = void 0;
+class NetSuiteApi {
+    constructor() {
+        this.name = 'netSuiteApi';
+        this.displayName = 'NetSuite API';
+        this.documentationUrl = 'https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/chapter_1540391670.html';
+        this.properties = [
+            {
+                displayName: 'Account ID',
+                name: 'accountId',
+                type: 'string',
+                default: '',
+                required: true,
+                description: 'NetSuite Account ID',
+            },
+            {
+                displayName: 'Integration Client ID',
+                name: 'integrationClientId',
+                type: 'string',
+                default: '',
+                required: true,
+                description: 'OAuth 2.0 Integration Client ID',
+            },
+            {
+                displayName: 'Certificate ID (M2M)',
+                name: 'certificateId',
+                type: 'string',
+                default: '',
+                required: true,
+                description: 'OAuth 2.0 Certificate ID for M2M authentication',
+            },
+            {
+                displayName: 'PEM Content',
+                name: 'pemContent',
+                type: 'string',
+                default: '',
+                typeOptions: {
+                    multiline: true,
+                    rows: 10,
+                },
+                required: true,
+                placeholder: '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----',
+                description: 'Paste your PEM file content here (private key, certificate, etc.)',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+            },
+        };
+    }
+}
+exports.NetSuiteApi = NetSuiteApi;
+//# sourceMappingURL=NetSuiteApi.credentials.js.map

package/dist/credentials/NetSuiteApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetSuiteApi.credentials.js","sourceRoot":"","sources":["../../credentials/NetSuiteApi.credentials.ts"],"names":[],"mappings":";;;AAMA,MAAa,WAAW;IAAxB;QACC,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GAAG,cAAc,CAAC;QAC7B,qBAAgB,GACf,uFAAuF,CAAC;QAEzF,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,qBAAqB;aAClC;YACD;gBACC,WAAW,EAAE,uBAAuB;gBACpC,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,iCAAiC;aAC9C;YACD;gBACC,WAAW,EAAE,sBAAsB;gBACnC,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,iDAAiD;aAC9D;YACD;gBACC,WAAW,EAAE,aAAa;gBAC1B,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE;oBACZ,SAAS,EAAE,IAAI;oBACf,IAAI,EAAE,EAAE;iBACR;gBACD,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6DAA6D;gBAC1E,WAAW,EAAE,mEAAmE;aAChF;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,cAAc,EAAE,kBAAkB;iBAClC;aACD;SACD,CAAC;IAEH,CAAC;CAAA;AAvDD,kCAuDC"}

package/dist/nodes/NetSuite/NetSuite.node.d.ts

@@ -0,0 +1,5 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class NetSuite implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}

package/dist/nodes/NetSuite/NetSuite.node.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetSuite = void 0;
+const util_1 = require("util");
+const n8n_workflow_1 = require("n8n-workflow");
+const NetSuite_node_options_1 = require("./NetSuite.node.options");
+const operations_1 = require("./operations");
+const debug = (0, util_1.debuglog)('n8n-nodes-netsuite');
+class NetSuite {
+    constructor() {
+        this.description = NetSuite_node_options_1.nodeDescription;
+    }
+    async execute() {
+        const credentials = (await this.getCredentials('netSuiteApi'));
+        const operation = this.getNodeParameter('operation', 0);
+        const items = this.getInputData();
+        const returnData = [];
+        for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+            const item = items[itemIndex];
+            let data;
+            try {
+                debug(`Processing ${operation} for ${itemIndex + 1} of ${items.length}`);
+                const options = { item, fns: this, credentials, itemIndex };
+                switch (operation) {
+                    case 'getRecord':
+                        data = await (0, operations_1.getRecord)(options);
+                        break;
+                    case 'listRecords':
+                        data = await (0, operations_1.listRecords)(options);
+                        break;
+                    case 'removeRecord':
+                        data = await (0, operations_1.removeRecord)(options);
+                        break;
+                    case 'insertRecord':
+                        data = await (0, operations_1.insertRecord)(options);
+                        break;
+                    case 'updateRecord':
+                        data = await (0, operations_1.updateRecord)(options);
+                        break;
+                    case 'rawRequest':
+                        data = await (0, operations_1.rawRequest)(options);
+                        break;
+                    case 'runSuiteQL':
+                        data = await (0, operations_1.runSuiteQL)(options);
+                        break;
+                    default:
+                        const error = `The operation "${operation}" is not supported!`;
+                        if (this.continueOnFail() !== true) {
+                            throw new n8n_workflow_1.NodeOperationError(this.getNode(), error);
+                        }
+                        else {
+                            data = { json: { error } };
+                        }
+                        break;
+                }
+                if (Array.isArray(data)) {
+                    returnData.push(...data);
+                }
+                else {
+                    returnData.push(data);
+                }
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({
+                        json: {
+                            error: error.message,
+                        },
+                    });
+                }
+                else {
+                    throw new n8n_workflow_1.NodeApiError(this.getNode(), error, {
+                        itemIndex,
+                    });
+                }
+            }
+        }
+        return this.prepareOutputData(returnData);
+    }
+}
+exports.NetSuite = NetSuite;
+//# sourceMappingURL=NetSuite.node.js.map

package/dist/nodes/NetSuite/NetSuite.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetSuite.node.js","sourceRoot":"","sources":["../../../nodes/NetSuite/NetSuite.node.ts"],"names":[],"mappings":";;;AAOA,+BAAgC;AAOhC,+CAAgE;AAChE,mEAA0D;AAE1D,6CAQsB;AAEtB,MAAM,KAAK,GAAG,IAAA,eAAQ,EAAC,oBAAoB,CAAC,CAAC;AAE7C,MAAa,QAAQ;IAArB;QACC,gBAAW,GAAyB,uCAAe,CAAC;IAgFrD,CAAC;IA3EA,KAAK,CAAC,OAAO;QAEZ,MAAM,WAAW,GAAyB,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAyB,CAAC;QAC7G,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAW,CAAC;QAClE,MAAM,KAAK,GAAyB,IAAI,CAAC,YAAY,EAAE,CAAC;QACxD,MAAM,UAAU,GAAyB,EAAE,CAAC;QAG5C,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAuB,KAAK,CAAC,SAAS,CAAC,CAAC;YAClD,IAAI,IAA+C,CAAC;YAEpD,IAAI,CAAC;gBACJ,KAAK,CAAC,cAAc,SAAS,QAAQ,SAAS,GAAG,CAAC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;gBAGzE,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;gBAG5D,QAAQ,SAAS,EAAE,CAAC;oBACnB,KAAK,WAAW;wBACf,IAAI,GAAG,MAAM,IAAA,sBAAS,EAAC,OAAO,CAAC,CAAC;wBAChC,MAAM;oBACP,KAAK,aAAa;wBACjB,IAAI,GAAG,MAAM,IAAA,wBAAW,EAAC,OAAO,CAAC,CAAC;wBAClC,MAAM;oBACP,KAAK,cAAc;wBAClB,IAAI,GAAG,MAAM,IAAA,yBAAY,EAAC,OAAO,CAAC,CAAC;wBACnC,MAAM;oBACP,KAAK,cAAc;wBAClB,IAAI,GAAG,MAAM,IAAA,yBAAY,EAAC,OAAO,CAAC,CAAC;wBACnC,MAAM;oBACP,KAAK,cAAc;wBAClB,IAAI,GAAG,MAAM,IAAA,yBAAY,EAAC,OAAO,CAAC,CAAC;wBACnC,MAAM;oBACP,KAAK,YAAY;wBAChB,IAAI,GAAG,MAAM,IAAA,uBAAU,EAAC,OAAO,CAAC,CAAC;wBACjC,MAAM;oBACP,KAAK,YAAY;wBAChB,IAAI,GAAG,MAAM,IAAA,uBAAU,EAAC,OAAO,CAAC,CAAC;wBACjC,MAAM;oBACP;wBACC,MAAM,KAAK,GAAG,kBAAkB,SAAS,qBAAqB,CAAC;wBAC/D,IAAI,IAAI,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC;4BACpC,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;wBACrD,CAAC;6BAAM,CAAC;4BACP,IAAI,GAAG,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;wBAC5B,CAAC;wBACD,MAAM;gBACR,CAAC;gBAGD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzB,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACP,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAEhB,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC3B,UAAU,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE;4BACL,KAAK,EAAE,KAAK,CAAC,OAAO;yBACpB;qBACD,CAAC,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACP,MAAM,IAAI,2BAAY,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE;wBAC7C,SAAS;qBACT,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;CACD;AAjFD,4BAiFC"}

package/dist/nodes/NetSuite/NetSuite.node.json

@@ -0,0 +1,20 @@
+{
+    "node": "n8n-nodes-base.NetSuite",
+    "nodeVersion": "1.0",
+    "codexVersion": "1.0",
+    "categories": [
+        "ERP"
+    ],
+    "resources": {
+        "credentialDocumentation": [
+            {
+                "url": ""
+            }
+        ],
+        "primaryDocumentation": [
+            {
+                "url": ""
+            }
+        ]
+    }
+}

package/dist/nodes/NetSuite/NetSuite.node.options.d.ts

@@ -0,0 +1,2 @@
+import { INodeTypeDescription } from 'n8n-workflow';
+export declare const nodeDescription: INodeTypeDescription;