OAuth2: generic functions, credentials, UI

packages/nodes-base/credentials/ClearbitOAuth2Api.credentials.ts

@@ -0,0 +1,60 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+
+export class ClearbitOAuth2Api implements ICredentialType {
+	name = 'clearbitOAuth2Api';
+	extends = [
+		'oAuth2Api',
+	];
+	displayName = 'Clearbit OAuth2 API';
+	properties = [
+		{
+			displayName: 'Authorization URL',
+			name: 'authUrl',
+			type: 'hidden' as NodePropertyTypes,
+			default: 'https://clearbit.com/oauth/authorize',
+			required: true,
+		},
+		{
+			displayName: 'Access Token URL',
+			name: 'accessTokenUrl',
+			type: 'hidden' as NodePropertyTypes,
+			default: 'https://clearbit.com/oauth/access_token',
+			required: true,
+		},
+		{
+			displayName: 'Scope',
+			name: 'scope',
+			type: 'hidden' as NodePropertyTypes,
+			default: '',
+		},
+		{
+			displayName: 'Auth URI Query Parameters',
+			name: 'authQueryParameters',
+			type: 'hidden' as NodePropertyTypes,
+			default: '',
+		},
+		{
+			displayName: 'Authentication',
+			name: 'authentication',
+			type: 'options' as NodePropertyTypes,
+			options: [
+				{
+					name: 'Body',
+					value: 'body',
+					description: 'Send credentials in body',
+				},
+				{
+					name: 'Header',
+					value: 'header',
+					description: 'Send credentials as Basic Auth header',
+				},
+			],
+			default: 'header',
+			description: 'Resource to consume.',
+		},
+	];
+}

packages/nodes-base/nodes/Clearbit/Clearbit.node.ts

@@ -38,9 +38,44 @@ export class Clearbit implements INodeType {
 			{
 				name: 'clearbitApi',
 				required: true,
-			}
+				displayOptions: {
+					show: {
+						authentication: [
+							'accessToken',
+						],
+					},
+				},
+			},
+			{
+				name: 'clearbitOAuth2Api',
+				required: true,
+				displayOptions: {
+					show: {
+						authentication: [
+							'oAuth2',
+						],
+					},
+				},
+			},
 		],
 		properties: [
+			{
+				displayName: 'Authentication',
+				name: 'authentication',
+				type: 'options',
+				options: [
+					{
+						name: 'Access Token',
+						value: 'accessToken',
+					},
+					{
+						name: 'OAuth2',
+						value: 'oAuth2',
+					},
+				],
+				default: 'accessToken',
+				description: 'The resource to operate on.',
+			},
 			{
 				displayName: 'Resource',
 				name: 'resource',

packages/nodes-base/nodes/Clearbit/GenericFunctions.ts

@@ -8,12 +8,10 @@ import {
 import { IDataObject } from 'n8n-workflow';
 
 export async function clearbitApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, api: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
-	const credentials = this.getCredentials('clearbitApi');
-	if (credentials === undefined) {
-		throw new Error('No credentials got returned!');
-	}
+	const authenticationMethod = this.getNodeParameter('authentication', 0);
+
 	let options: OptionsWithUri = {
-		headers: { Authorization: `Bearer ${credentials.apiKey}`},
+		headers: {},
 		method,
 		qs,
 		body,
@@ -24,9 +22,21 @@ export async function clearbitApiRequest(this: IHookFunctions | IExecuteFunction
 	if (Object.keys(options.body).length === 0) {
 		delete options.body;
 	}
+
 	try {
-		return await this.helpers.request!(options);
-	} catch (error) {
+		if (authenticationMethod === 'accessToken') {
+			const credentials = this.getCredentials('clearbitApi');
+			if (credentials === undefined) {
+				throw new Error('No credentials got returned!');
+			}
+			//@ts-ignore
+			options.headers['Authorization'] = `Bearer ${credentials.apiKey}`;
+			// @ts-ignore
+			return await this.helpers.request(options);
+		} else {
+			return await this.helpers.requestOAuth2?.call(this, 'clearbitOAuth2Api', options);
+		}
+	} catch(error) {
 		if (error.statusCode === 401) {
 			// Return a clear error
 			throw new Error('The Clearbit credentials are not valid!');

packages/nodes-base/package.json

@@ -39,6 +39,7 @@
             "dist/credentials/BitlyApi.credentials.js",
             "dist/credentials/ChargebeeApi.credentials.js",
             "dist/credentials/ClearbitApi.credentials.js",
+            "dist/credentials/ClearbitOAuth2Api.credentials.js",
             "dist/credentials/ClickUpApi.credentials.js",
             "dist/credentials/ClockifyApi.credentials.js",
             "dist/credentials/CockpitApi.credentials.js",