first commit

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

@@ -0,0 +1,54 @@
+import type {
+	IExecuteFunctions,
+	ILoadOptionsFunctions,
+	IDataObject,
+	JsonObject,
+	IHttpRequestMethods,
+	IRequestOptions,
+} from 'n8n-workflow';
+import { NodeApiError, NodeOperationError } from 'n8n-workflow';
+
+export async function yourlsApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: IHttpRequestMethods,
+
+	body: any = {},
+	qs: IDataObject = {},
+): Promise<any> {
+	const credentials = await this.getCredentials('yourlsApi');
+
+	qs.signature = credentials.signature as string;
+	qs.format = 'json';
+
+	const options: IRequestOptions = {
+		method,
+		body,
+		qs,
+		uri: `${credentials.url}/yourls-api.php`,
+		json: true,
+	};
+	try {
+		const response = await this.helpers.request.call(this, options);
+
+		if (response.status === 'fail') {
+			throw new NodeOperationError(
+				this.getNode(),
+				`Yourls error response [400]: ${response.message}`,
+			);
+		}
+
+		if (typeof response === 'string' && response.includes('<b>Fatal error</b>')) {
+			throw new NodeOperationError(
+				this.getNode(),
+				"Yourls responded with a 'Fatal error', check description for more details",
+				{
+					description: `Server response:\n${response}`,
+				},
+			);
+		}
+
+		return response;
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error as JsonObject);
+	}
+}

packages/nodes-base/nodes/Yourls/UrlDescription.ts

@@ -0,0 +1,119 @@
+import type { INodeProperties } from 'n8n-workflow';
+
+export const urlOperations: INodeProperties[] = [
+	{
+		displayName: 'Operation',
+		name: 'operation',
+		type: 'options',
+		noDataExpression: true,
+		displayOptions: {
+			show: {
+				resource: ['url'],
+			},
+		},
+		options: [
+			{
+				name: 'Expand',
+				value: 'expand',
+				description: 'Expand a URL',
+				action: 'Expand a URL',
+			},
+			{
+				name: 'Shorten',
+				value: 'shorten',
+				description: 'Shorten a URL',
+				action: 'Shorten a URL',
+			},
+			{
+				name: 'Stats',
+				value: 'stats',
+				description: 'Get stats about one short URL',
+				action: 'Get stats for a URL',
+			},
+		],
+		default: 'shorten',
+	},
+];
+
+export const urlFields: INodeProperties[] = [
+	/* -------------------------------------------------------------------------- */
+	/*                                url:shorten                                 */
+	/* -------------------------------------------------------------------------- */
+	{
+		displayName: 'URL',
+		name: 'url',
+		type: 'string',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['url'],
+				operation: ['shorten'],
+			},
+		},
+		default: '',
+		description: 'The URL to shorten',
+	},
+	{
+		displayName: 'Additional Fields',
+		name: 'additionalFields',
+		type: 'collection',
+		placeholder: 'Add Field',
+		default: {},
+		displayOptions: {
+			show: {
+				resource: ['url'],
+				operation: ['shorten'],
+			},
+		},
+		options: [
+			{
+				displayName: 'Keyword',
+				name: 'keyword',
+				type: 'string',
+				default: '',
+			},
+			{
+				displayName: 'Title',
+				name: 'title',
+				type: 'string',
+				default: '',
+				description: 'Title for custom short URLs',
+			},
+		],
+	},
+	/* -------------------------------------------------------------------------- */
+	/*                                url:expand                                  */
+	/* -------------------------------------------------------------------------- */
+	{
+		displayName: 'Short URL',
+		name: 'shortUrl',
+		type: 'string',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['url'],
+				operation: ['expand'],
+			},
+		},
+		default: '',
+		description: 'The short URL to expand',
+	},
+
+	/* -------------------------------------------------------------------------- */
+	/*                                url:stats                                   */
+	/* -------------------------------------------------------------------------- */
+	{
+		displayName: 'Short URL',
+		name: 'shortUrl',
+		type: 'string',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['url'],
+				operation: ['stats'],
+			},
+		},
+		default: '',
+		description: 'The short URL for which to get stats',
+	},
+];

packages/nodes-base/nodes/Yourls/Yourls.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "n8n-nodes-base.yourls",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Utility"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/credentials/yourls/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.yourls/"
+			}
+		]
+	}
+}

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

@@ -0,0 +1,104 @@
+import {
+	type IExecuteFunctions,
+	type IDataObject,
+	type INodeExecutionData,
+	type INodeType,
+	type INodeTypeDescription,
+	NodeConnectionTypes,
+} from 'n8n-workflow';
+
+import { yourlsApiRequest } from './GenericFunctions';
+import { urlFields, urlOperations } from './UrlDescription';
+
+export class Yourls implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Yourls',
+		name: 'yourls',
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
+		icon: 'file:yourls.png',
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume Yourls API',
+		defaults: {
+			name: 'Yourls',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'yourlsApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'URL',
+						value: 'url',
+					},
+				],
+				default: 'url',
+			},
+			...urlOperations,
+			...urlFields,
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const returnData: IDataObject[] = [];
+		const length = items.length;
+		const qs: IDataObject = {};
+		let responseData;
+		const resource = this.getNodeParameter('resource', 0);
+		const operation = this.getNodeParameter('operation', 0);
+		for (let i = 0; i < length; i++) {
+			try {
+				if (resource === 'url') {
+					if (operation === 'shorten') {
+						const url = this.getNodeParameter('url', i) as string;
+						const additionalFields = this.getNodeParameter('additionalFields', i);
+						qs.url = url;
+						qs.action = 'shorturl';
+						Object.assign(qs, additionalFields);
+						responseData = await yourlsApiRequest.call(this, 'GET', {}, qs);
+					}
+
+					if (operation === 'expand') {
+						const shortUrl = this.getNodeParameter('shortUrl', i) as string;
+						qs.shorturl = shortUrl;
+						qs.action = 'expand';
+						responseData = await yourlsApiRequest.call(this, 'GET', {}, qs);
+					}
+
+					if (operation === 'stats') {
+						const shortUrl = this.getNodeParameter('shortUrl', i) as string;
+						qs.shorturl = shortUrl;
+						qs.action = 'url-stats';
+						responseData = await yourlsApiRequest.call(this, 'GET', {}, qs);
+						responseData = responseData.link;
+					}
+				}
+				if (Array.isArray(responseData)) {
+					returnData.push.apply(returnData, responseData as IDataObject[]);
+				} else {
+					returnData.push(responseData as IDataObject);
+				}
+			} catch (error) {
+				if (this.continueOnFail()) {
+					returnData.push({ error: error.message });
+					continue;
+				}
+				throw error;
+			}
+		}
+		return [this.helpers.returnJsonArray(returnData)];
+	}
+}