Programmatic-style node tutorial outdated

[Noiirod]

Hello,
its me again, i have a problem with the programmatic-style node tutorial, 2 on 3 imports are outdated.

import {
	IExecuteFunctions,
} from 'n8n-core';

import {
	OptionsWithUri,
} from 'request';

I found that the first one is changed by n8n-workflow, but what about the second ? and how i should change the code in the exemple to match the right import :

// Make HTTP request according to https://sendgrid.com/docs/api-reference/
			const options: OptionsWithUri = {
				headers: {
					'Accept': 'application/json',
				},
				method: 'PUT',
				body: {
					contacts: [
						data,
					],
				},
				uri: `https://api.sendgrid.com/v3/marketing/contacts`,
				json: true,
			};
			responseData = await this.helpers.requestWithAuthentication.call(this, 'friendGridApi', options);
			returnData.push(responseData);
		}

Thanks by advance !

[netroy]

can you please link to the tutorial you are using? we can then try to get it updated 🙏🏽

[Noiirod]

Sure ! there it is : https://docs.n8n.io/integrations/creating-nodes/build/programmatic-style-node/

[Joffcom]

I have created DOC-961 as the internal ticket to update the guides.

[Noiirod]

Thank you !

[mathisgauthey]

Hello, its me again, i have a problem with the programmatic-style node tutorial, 2 on 3 imports are outdated.

import {
	IExecuteFunctions,
} from 'n8n-core';

import {
	OptionsWithUri,
} from 'request';

I found that the first one is changed by n8n-workflow, but what about the second ? and how i should change the code in the exemple to match the right import :

// Make HTTP request according to https://sendgrid.com/docs/api-reference/
			const options: OptionsWithUri = {
				headers: {
					'Accept': 'application/json',
				},
				method: 'PUT',
				body: {
					contacts: [
						data,
					],
				},
				uri: `https://api.sendgrid.com/v3/marketing/contacts`,
				json: true,
			};
			responseData = await this.helpers.requestWithAuthentication.call(this, 'friendGridApi', options);
			returnData.push(responseData);
		}

Thanks by advance !

Hey there pal, I think you might have found it by now, but here is the complete FriendGrid.node.ts which has the few corrections required by the n8n docs.

import {
    IDataObject,
    INodeExecutionData,
    INodeType,
    INodeTypeDescription,
    IExecuteFunctions,
    IHttpRequestOptions
} from 'n8n-workflow';

export class FriendGrid implements INodeType {
    description: INodeTypeDescription = {
        // Basic node details will go here
        displayName: 'FriendGrid',
        name: 'friendGrid',
        icon: 'file:friendGrid.svg',
        group: ['transform'],
        version: 1,
        description: 'Consume SendGrid API',
        defaults: {
            name: 'FriendGrid',
        },
        inputs: ['main'],
        outputs: ['main'],
        credentials: [
            {
                name: 'friendGridApi',
                required: true,
            },
        ],
        properties: [
            // Resources and operations will go here
            {
                displayName: 'Resource',
                name: 'resource',
                type: 'options',
                options: [
                    {
                        name: 'Contact',
                        value: 'contact',
                    },
                ],
                default: 'contact',
                noDataExpression: true,
                required: true,
                description: 'Create a new contact',
            },
            {
                displayName: 'Operation',
                name: 'operation',
                type: 'options',
                displayOptions: {
                    show: {
                        resource: [
                            'contact',
                        ],
                    },
                },
                options: [
                    {
                        name: 'Create',
                        value: 'create',
                        description: 'Create a contact',
                        action: 'Create a contact',
                    },
                ],
                default: 'create',
                noDataExpression: true,
            },
            {
                displayName: 'Email',
                name: 'email',
                type: 'string',
                required: true,
                displayOptions: {
                    show: {
                        operation: [
                            'create',
                        ],
                        resource: [
                            'contact',
                        ],
                    },
                },
                default: '',
                placeholder: 'name@email.com',
                description: 'Primary email for the contact',
            },
            {
                displayName: 'Additional Fields',
                name: 'additionalFields',
                type: 'collection',
                placeholder: 'Add Field',
                default: {},
                displayOptions: {
                    show: {
                        resource: [
                            'contact',
                        ],
                        operation: [
                            'create',
                        ],
                    },
                },
                options: [
                    {
                        displayName: 'First Name',
                        name: 'firstName',
                        type: 'string',
                        default: '',
                    },
                    {
                        displayName: 'Last Name',
                        name: 'lastName',
                        type: 'string',
                        default: '',
                    },
                ],
            },
        ],
    };

    // The execute method will go here
    async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
        // Handle data coming from previous nodes
        const items = this.getInputData();
        let responseData;
        const returnData = [];
        const resource = this.getNodeParameter('resource', 0) as string;
        const operation = this.getNodeParameter('operation', 0) as string;

        // For each item, make an API call to create a contact
        for (let i = 0; i < items.length; i++) {
            if (resource === 'contact') {
                if (operation === 'create') {
                    // Get email input
                    const email = this.getNodeParameter('email', i) as string;
                    // Get additional fields input
                    const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
                    const data: IDataObject = {
                        email,
                    };

                    Object.assign(data, additionalFields);

                    // Make HTTP request according to https://sendgrid.com/docs/api-reference/
                    const options: IHttpRequestOptions = {
                        headers: {
                            'Accept': 'application/json',
                        },
                        method: 'PUT',
                        body: {
                            contacts: [
                                data,
                            ],
                        },
                        url: 'https://api.sendgrid.com/v3/marketing/contacts',
                        json: true,
                    };
                    responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'friendGridApi', options);
                    returnData.push(responseData);
                }
            }
        }
        // Map data to n8n data structure
        return [this.helpers.returnJsonArray(returnData)];
    }
}

Along with the package.json :

(I just added @types/normalize-package-data": "^2.4.4 as a dev dependency)

{
  "name": "n8n-nodes-friendgrid",
  "version": "0.1.0",
  "description": "n8n node to create contacts in SendGrid",
  "keywords": [
    "n8n-community-node-package"
  ],
  "license": "MIT",
  "homepage": "https://n8n.io",
  "author": {
    "name": "Test",
    "email": "test@example.com"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/starter/n8n-nodes-starter.git"
  },
  "engines": {
    "node": ">=18.10",
    "pnpm": ">=9.1"
  },
  "packageManager": "pnpm@9.1.4",
  "main": "index.js",
  "scripts": {
    "preinstall": "npx only-allow pnpm",
    "build": "tsc && gulp build:icons",
    "dev": "tsc --watch",
    "format": "prettier nodes credentials --write",
    "lint": "eslint nodes credentials package.json",
    "lintfix": "eslint nodes credentials package.json --fix",
    "prepublishOnly": "pnpm build && pnpm lint -c .eslintrc.prepublish.js nodes credentials package.json"
  },
  "files": [
    "dist"
  ],
  "n8n": {
    "n8nNodesApiVersion": 1,
    "credentials": [
      "dist/credentials/FriendGridApi.credentials.js"
    ],
    "nodes": [
      "dist/nodes/FriendGrid/FriendGrid.node.js"
    ]
  },
  "devDependencies": {
    "@types/normalize-package-data": "^2.4.4",
    "@typescript-eslint/parser": "^7.15.0",
    "eslint": "^8.56.0",
    "eslint-plugin-n8n-nodes-base": "^1.16.1",
    "gulp": "^4.0.2",
    "prettier": "^3.3.2",
    "typescript": "^5.5.3"
  },
  "peerDependencies": {
    "n8n-workflow": "*"
  }
}

---

Explanations of the changes

Changes in the New Version:

Imports

• Removed: import { OptionsWithUri } from 'request';
• Added: import { IHttpRequestOptions } from 'n8n-workflow';
• Modified: IExecuteFunctions was moved from 'n8n-core' to 'n8n-workflow'.

HTTP Request Handling

• Replaced:
  • OptionsWithUri (from request) → IHttpRequestOptions (from n8n-workflow).
  • uri → url in the request options.
  • requestWithAuthentication.call(this, 'friendGridApi', options) → httpRequestWithAuthentication.call(this, 'friendGridApi', options).

Benefits of the Changes

• Uses IHttpRequestOptions, which is the recommended way in newer n8n versions.
• Removes dependency on request, which is deprecated in favor of httpRequestWithAuthentication.
• Aligns with n8n's modern best practices, ensuring compatibility with future updates.

The core functionality remains unchanged; the refactoring primarily modernizes the request handling.