adds a working n8n node to interact with searchapi

Author: dapeduu

.tool-versions

@@ -0,0 +1,2 @@
+nodejs 22.14.0
+pnpm 10.9.0

README.md

@@ -6,6 +6,11 @@ This repo contains example nodes to help you get started building your own custo
 
 To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
 
+## Plan 
+
+- Node type: Action
+- Style: Declarative
+
 ## Prerequisites
 
 You need the following installed on your development machine:

credentials/SearchAPI.credentials.ts

@@ -0,0 +1,32 @@
+import {
+	IAuthenticateGeneric,
+	ICredentialType,
+	INodeProperties,
+} from 'n8n-workflow';
+
+export class SearchAPI implements ICredentialType {
+	name = 'searchApi';
+	displayName = 'SearchAPI';
+	
+	// Uses the link to this tutorial as an example
+	// Replace with your own docs links when building your own nodes
+	documentationUrl = 'https://www.searchapi.io/docs/google';
+	properties: INodeProperties[] = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string',
+			default: '',
+            required: true,
+		},
+	];
+	authenticate = {
+		type: 'generic',
+        properties: {
+			qs: { api_key: '={{ $credentials.apiKey }}' },
+            headers: {
+                "X-SearchApi-Source": "N8N"
+            }
+        }
+	} as IAuthenticateGeneric;
+}

nodes/SearchAPI/SearchAPI.node.json

@@ -0,0 +1,104 @@
+import { IDataObject, INodeType, INodeTypeDescription } from 'n8n-workflow';
+
+export class SearchAPI implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'SearchAPI',
+		name: 'searchapi',
+		icon: 'file:searchApi.svg',
+		group: ['output'],
+		version: 1,
+		description: 'Search the web via SearchAPI.io (declarative)',
+		subtitle: '={{ $parameter["engine"] }}',
+		defaults: { name: 'SearchAPI', color: '#4338ca' },
+		inputs: ['main'],
+		outputs: ['main'],
+
+		credentials: [{ name: 'searchApi', required: true }],
+
+		requestDefaults: {
+			baseURL: 'https://www.searchapi.io/api/v1',
+			method: 'GET',
+			url: '/search',
+			headers: { Accept: 'application/json' },
+			qs: {
+				api_key: '={{ $credentials.apiKey }}',   // generic-auth pattern :contentReference[oaicite:3]{index=3}
+			},
+		},
+
+		properties: [
+			{
+				displayName: 'Query (q)',
+				name: 'q',
+				type: 'string',
+				default: '={{ $json.q }}',
+				required: true,
+				description: 'Search phrase to use in the engine of your choice.',
+				routing: {
+					request: {
+						qs: {
+							q: '={{ $value }}',
+						},
+					},
+				},
+			},
+			{
+				displayName: 'Engine (engine)',
+				name: 'engine',
+				type: 'string',
+				default: 'google',
+				required: true,
+				description: 'Search engine to use for the query.',
+				routing: {
+					request: {
+						qs: {
+							engine: '={{ $value }}',
+						},
+					},
+				},
+			},
+			{
+				displayName: 'Additional Parameters',
+				name: 'additionalParams',
+				type: 'fixedCollection',
+				typeOptions: { multipleValues: true },
+				default: {},
+				hint: 'You can ignore this and add "additionalParams" to the node input.',
+				description: 'Add any extra query-string keys your SearchAPI request should include.',
+				options: [
+					{
+						displayName: 'Parameter',
+						name: 'parameter',
+						values: [
+							{
+								displayName: 'Name',
+								name: 'name',
+								type: 'string',
+								default: '',
+							},
+							{
+								displayName: 'Value',
+								name: 'value',
+								type: 'string',
+								default: '',
+							},
+						],
+					},
+				],
+				/**
+				 * Build an object like { hl: 'en', gl: 'us' } out of
+				 * the collection entries and merge it into qs.
+				 */
+				routing: {
+					request: {
+						// We are doing this cast here because we need to 
+						// build an object out of the collection entries
+						// and merge it into qs, but qs expects an object.
+						qs: '={{ Object.fromEntries(($value.parameter ?? $json.additionalParams ?? []).map(p => [p.name, p.value]))  }}' as unknown as IDataObject,
+					},
+				},
+			}
+
+		],
+
+	};
+}

nodes/SearchAPI/SearchAPI.node.ts

@@ -1,5 +1,5 @@
 {
-  "name": "n8n-nodes-<...>",
+  "name": "n8n-nodes-searchapi",
   "version": "0.1.0",
   "description": "",
   "keywords": [
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/<...>/n8n-nodes-<...>.git"
+    "url": "https://github.com/SearchApi/n8n-nodes-searchapi.git"
   },
   "engines": {
     "node": ">=18.10",
@@ -37,11 +37,13 @@
     "n8nNodesApiVersion": 1,
     "credentials": [
       "dist/credentials/ExampleCredentialsApi.credentials.js",
-      "dist/credentials/HttpBinApi.credentials.js"
+      "dist/credentials/HttpBinApi.credentials.js",
+      "dist/credentials/SearchAPI.credentials.js"
     ],
     "nodes": [
       "dist/nodes/ExampleNode/ExampleNode.node.js",
-      "dist/nodes/HttpBin/HttpBin.node.js"
+      "dist/nodes/HttpBin/HttpBin.node.js",
+      "dist/nodes/SearchAPI/SearchAPI.node.js"
     ]
   },
   "devDependencies": {
@@ -50,6 +52,7 @@
     "eslint-plugin-n8n-nodes-base": "^1.16.1",
     "gulp": "^4.0.2",
     "prettier": "^3.3.2",
+    "sqlite3": "^5.1.7",
     "typescript": "^5.5.3"
   },
   "peerDependencies": {