mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-14 08:34:07 -08:00
1d2666b37c
This PR is an example for how we can 1. improve typing and remove boilerplate code in may of our nodes 2. use nock to write effective unit tests for nodes that make external calls ## Review / Merge checklist - [x] PR title and summary are descriptive - [x] Add tests
95 lines
2.4 KiB
TypeScript
95 lines
2.4 KiB
TypeScript
import {
|
|
Node,
|
|
NodeApiError,
|
|
type IExecuteFunctions,
|
|
type INodeExecutionData,
|
|
type INodeTypeDescription,
|
|
type JsonObject,
|
|
} from 'n8n-workflow';
|
|
|
|
export const apiUrl = 'https://api.peekalink.io';
|
|
|
|
type Operation = 'preview' | 'isAvailable';
|
|
|
|
export class Peekalink extends Node {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Peekalink',
|
|
name: 'peekalink',
|
|
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
|
|
icon: 'file:peekalink.png',
|
|
group: ['output'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"]',
|
|
description: 'Consume the Peekalink API',
|
|
defaults: {
|
|
name: 'Peekalink',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'peekalinkApi',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
options: [
|
|
{
|
|
name: 'Is Available',
|
|
value: 'isAvailable',
|
|
description: 'Check whether preview for a given link is available',
|
|
action: 'Check whether the preview for a given link is available',
|
|
},
|
|
{
|
|
name: 'Preview',
|
|
value: 'preview',
|
|
description: 'Return the preview for a link',
|
|
action: 'Return the preview for a link',
|
|
},
|
|
],
|
|
default: 'preview',
|
|
},
|
|
{
|
|
displayName: 'URL',
|
|
name: 'url',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
},
|
|
],
|
|
};
|
|
|
|
async execute(context: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = context.getInputData();
|
|
const operation = context.getNodeParameter('operation', 0) as Operation;
|
|
const credentials = await context.getCredentials('peekalinkApi');
|
|
|
|
const returnData = await Promise.all(
|
|
items.map(async (_, i) => {
|
|
try {
|
|
const link = context.getNodeParameter('url', i) as string;
|
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
|
return await context.helpers.request({
|
|
method: 'POST',
|
|
uri: operation === 'preview' ? apiUrl : `${apiUrl}/is-available/`,
|
|
body: { link },
|
|
headers: { 'X-API-Key': credentials.apiKey },
|
|
json: true,
|
|
});
|
|
} catch (error) {
|
|
if (context.continueOnFail()) {
|
|
return { error: error.message };
|
|
}
|
|
throw new NodeApiError(context.getNode(), error as JsonObject);
|
|
}
|
|
}),
|
|
);
|
|
return [context.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|