Add nodes generated by the Node CLI, update README (#96)

nodes/GithubIssues/GithubIssues.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "n8n-nodes-github-issues",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Development", "Developer Tools"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://github.com/org/repo?tab=readme-ov-file#credentials"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://github.com/org/repo?tab=readme-ov-file"
+			}
+		]
+	}
+}

nodes/GithubIssues/GithubIssues.node.ts

@@ -0,0 +1,96 @@
+import { NodeConnectionType, type INodeType, type INodeTypeDescription } from 'n8n-workflow';
+import { issueDescription } from './resources/issue';
+import { issueCommentDescription } from './resources/issueComment';
+import { getRepositories } from './listSearch/getRepositories';
+import { getUsers } from './listSearch/getUsers';
+import { getIssues } from './listSearch/getIssues';
+
+export class GithubIssues implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'GitHub Issues',
+		name: 'githubIssues',
+		icon: { light: 'file:../../icons/github.svg', dark: 'file:../../icons/github.dark.svg' },
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume issues from the GitHub API',
+		defaults: {
+			name: 'GitHub Issues',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionType.Main],
+		outputs: [NodeConnectionType.Main],
+		credentials: [
+			{
+				name: 'githubIssuesApi',
+				required: true,
+				displayOptions: {
+					show: {
+						authentication: ['accessToken'],
+					},
+				},
+			},
+			{
+				name: 'githubIssuesOAuth2Api',
+				required: true,
+				displayOptions: {
+					show: {
+						authentication: ['oAuth2'],
+					},
+				},
+			},
+		],
+		requestDefaults: {
+			baseURL: 'https://api.github.com',
+			headers: {
+				Accept: 'application/json',
+				'Content-Type': 'application/json',
+			},
+		},
+		properties: [
+			{
+				displayName: 'Authentication',
+				name: 'authentication',
+				type: 'options',
+				options: [
+					{
+						name: 'Access Token',
+						value: 'accessToken',
+					},
+					{
+						name: 'OAuth2',
+						value: 'oAuth2',
+					},
+				],
+				default: 'accessToken',
+			},
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Issue',
+						value: 'issue',
+					},
+					{
+						name: 'Issue Comment',
+						value: 'issueComment',
+					},
+				],
+				default: 'issue',
+			},
+			...issueDescription,
+			...issueCommentDescription,
+		],
+	};
+
+	methods = {
+		listSearch: {
+			getRepositories,
+			getUsers,
+			getIssues,
+		},
+	};
+}

nodes/GithubIssues/listSearch/getIssues.ts

@@ -0,0 +1,49 @@
+import type {
+	ILoadOptionsFunctions,
+	INodeListSearchResult,
+	INodeListSearchItems,
+} from 'n8n-workflow';
+import { githubApiRequest } from '../shared/transport';
+
+type IssueSearchItem = {
+	number: number;
+	title: string;
+	html_url: string;
+};
+
+type IssueSearchResponse = {
+	items: IssueSearchItem[];
+	total_count: number;
+};
+
+export async function getIssues(
+	this: ILoadOptionsFunctions,
+	filter?: string,
+	paginationToken?: string,
+): Promise<INodeListSearchResult> {
+	const page = paginationToken ? +paginationToken : 1;
+	const per_page = 100;
+
+	let responseData: IssueSearchResponse = {
+		items: [],
+		total_count: 0,
+	};
+	const owner = this.getNodeParameter('owner', '', { extractValue: true });
+	const repository = this.getNodeParameter('repository', '', { extractValue: true });
+	const filters = [filter, `repo:${owner}/${repository}`];
+
+	responseData = await githubApiRequest.call(this, 'GET', '/search/issues', {
+		q: filters.filter(Boolean).join(' '),
+		page,
+		per_page,
+	});
+
+	const results: INodeListSearchItems[] = responseData.items.map((item: IssueSearchItem) => ({
+		name: item.title,
+		value: item.number,
+		url: item.html_url,
+	}));
+
+	const nextPaginationToken = page * per_page < responseData.total_count ? page + 1 : undefined;
+	return { results, paginationToken: nextPaginationToken };
+}

nodes/GithubIssues/listSearch/getRepositories.ts

@@ -0,0 +1,50 @@
+import type {
+	ILoadOptionsFunctions,
+	INodeListSearchItems,
+	INodeListSearchResult,
+} from 'n8n-workflow';
+import { githubApiRequest } from '../shared/transport';
+
+type RepositorySearchItem = {
+	name: string;
+	html_url: string;
+};
+
+type RepositorySearchResponse = {
+	items: RepositorySearchItem[];
+	total_count: number;
+};
+
+export async function getRepositories(
+	this: ILoadOptionsFunctions,
+	filter?: string,
+	paginationToken?: string,
+): Promise<INodeListSearchResult> {
+	const owner = this.getCurrentNodeParameter('owner', { extractValue: true });
+	const page = paginationToken ? +paginationToken : 1;
+	const per_page = 100;
+	const q = `${filter ?? ''} user:${owner} fork:true`;
+	let responseData: RepositorySearchResponse = {
+		items: [],
+		total_count: 0,
+	};
+
+	try {
+		responseData = await githubApiRequest.call(this, 'GET', '/search/repositories', {
+			q,
+			page,
+			per_page,
+		});
+	} catch {
+		// will fail if the owner does not have any repositories
+	}
+
+	const results: INodeListSearchItems[] = responseData.items.map((item: RepositorySearchItem) => ({
+		name: item.name,
+		value: item.name,
+		url: item.html_url,
+	}));
+
+	const nextPaginationToken = page * per_page < responseData.total_count ? page + 1 : undefined;
+	return { results, paginationToken: nextPaginationToken };
+}

nodes/GithubIssues/listSearch/getUsers.ts

@@ -0,0 +1,49 @@
+import type {
+	ILoadOptionsFunctions,
+	INodeListSearchResult,
+	INodeListSearchItems,
+} from 'n8n-workflow';
+import { githubApiRequest } from '../shared/transport';
+
+type UserSearchItem = {
+	login: string;
+	html_url: string;
+};
+
+type UserSearchResponse = {
+	items: UserSearchItem[];
+	total_count: number;
+};
+
+export async function getUsers(
+	this: ILoadOptionsFunctions,
+	filter?: string,
+	paginationToken?: string,
+): Promise<INodeListSearchResult> {
+	const page = paginationToken ? +paginationToken : 1;
+	const per_page = 100;
+
+	let responseData: UserSearchResponse = {
+		items: [],
+		total_count: 0,
+	};
+
+	try {
+		responseData = await githubApiRequest.call(this, 'GET', '/search/users', {
+			q: filter,
+			page,
+			per_page,
+		});
+	} catch {
+		// will fail if the owner does not have any users
+	}
+
+	const results: INodeListSearchItems[] = responseData.items.map((item: UserSearchItem) => ({
+		name: item.login,
+		value: item.login,
+		url: item.html_url,
+	}));
+
+	const nextPaginationToken = page * per_page < responseData.total_count ? page + 1 : undefined;
+	return { results, paginationToken: nextPaginationToken };
+}

nodes/GithubIssues/resources/issue/create.ts

@@ -0,0 +1,74 @@
+import type { INodeProperties } from 'n8n-workflow';
+
+const showOnlyForIssueCreate = {
+	operation: ['create'],
+	resource: ['issue'],
+};
+
+export const issueCreateDescription: INodeProperties[] = [
+	{
+		displayName: 'Title',
+		name: 'title',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: showOnlyForIssueCreate,
+		},
+		description: 'The title of the issue',
+		routing: {
+			send: {
+				type: 'body',
+				property: 'title',
+			},
+		},
+	},
+	{
+		displayName: 'Body',
+		name: 'body',
+		type: 'string',
+		typeOptions: {
+			rows: 5,
+		},
+		default: '',
+		displayOptions: {
+			show: showOnlyForIssueCreate,
+		},
+		description: 'The body of the issue',
+		routing: {
+			send: {
+				type: 'body',
+				property: 'body',
+			},
+		},
+	},
+	{
+		displayName: 'Labels',
+		name: 'labels',
+		type: 'collection',
+		typeOptions: {
+			multipleValues: true,
+			multipleValueButtonText: 'Add Label',
+		},
+		displayOptions: {
+			show: showOnlyForIssueCreate,
+		},
+		default: { label: '' },
+		options: [
+			{
+				displayName: 'Label',
+				name: 'label',
+				type: 'string',
+				default: '',
+				description: 'Label to add to issue',
+			},
+		],
+		routing: {
+			send: {
+				type: 'body',
+				property: 'labels',
+				value: '={{$value.map((data) => data.label)}}',
+			},
+		},
+	},
+];

nodes/GithubIssues/resources/issue/get.ts

@@ -0,0 +1,14 @@
+import type { INodeProperties } from 'n8n-workflow';
+import { issueSelect } from '../../shared/descriptions';
+
+const showOnlyForIssueGet = {
+	operation: ['get'],
+	resource: ['issue'],
+};
+
+export const issueGetDescription: INodeProperties[] = [
+	{
+		...issueSelect,
+		displayOptions: { show: showOnlyForIssueGet },
+	},
+];

nodes/GithubIssues/resources/issue/getAll.ts

@@ -0,0 +1,124 @@
+import type { INodeProperties } from 'n8n-workflow';
+import { parseLinkHeader } from '../../shared/utils';
+
+const showOnlyForIssueGetMany = {
+	operation: ['getAll'],
+	resource: ['issue'],
+};
+
+export const issueGetManyDescription: INodeProperties[] = [
+	{
+		displayName: 'Limit',
+		name: 'limit',
+		type: 'number',
+		displayOptions: {
+			show: {
+				...showOnlyForIssueGetMany,
+				returnAll: [false],
+			},
+		},
+		typeOptions: {
+			minValue: 1,
+			maxValue: 100,
+		},
+		default: 50,
+		routing: {
+			send: {
+				type: 'query',
+				property: 'per_page',
+			},
+			output: {
+				maxResults: '={{$value}}',
+			},
+		},
+		description: 'Max number of results to return',
+	},
+	{
+		displayName: 'Return All',
+		name: 'returnAll',
+		type: 'boolean',
+		displayOptions: {
+			show: showOnlyForIssueGetMany,
+		},
+		default: false,
+		description: 'Whether to return all results or only up to a given limit',
+		routing: {
+			send: {
+				paginate: '={{ $value }}',
+				type: 'query',
+				property: 'per_page',
+				value: '100',
+			},
+			operations: {
+				pagination: {
+					type: 'generic',
+					properties: {
+						continue: `={{ !!(${parseLinkHeader.toString()})($response.headers?.link).next }}`,
+						request: {
+							url: `={{ (${parseLinkHeader.toString()})($response.headers?.link)?.next ?? $request.url }}`,
+						},
+					},
+				},
+			},
+		},
+	},
+	{
+		displayName: 'Filters',
+		name: 'filters',
+		type: 'collection',
+		typeOptions: {
+			multipleValueButtonText: 'Add Filter',
+		},
+		displayOptions: {
+			show: showOnlyForIssueGetMany,
+		},
+		default: {},
+		options: [
+			{
+				displayName: 'Updated Since',
+				name: 'since',
+				type: 'dateTime',
+				default: '',
+				description: 'Return only issues updated at or after this time',
+				routing: {
+					request: {
+						qs: {
+							since: '={{$value}}',
+						},
+					},
+				},
+			},
+			{
+				displayName: 'State',
+				name: 'state',
+				type: 'options',
+				options: [
+					{
+						name: 'All',
+						value: 'all',
+						description: 'Returns issues with any state',
+					},
+					{
+						name: 'Closed',
+						value: 'closed',
+						description: 'Return issues with "closed" state',
+					},
+					{
+						name: 'Open',
+						value: 'open',
+						description: 'Return issues with "open" state',
+					},
+				],
+				default: 'open',
+				description: 'The issue state to filter on',
+				routing: {
+					request: {
+						qs: {
+							state: '={{$value}}',
+						},
+					},
+				},
+			},
+		],
+	},
+];

nodes/GithubIssues/resources/issue/index.ts

@@ -0,0 +1,75 @@
+import type { INodeProperties } from 'n8n-workflow';
+import { repoNameSelect, repoOwnerSelect } from '../../shared/descriptions';
+import { issueGetManyDescription } from './getAll';
+import { issueGetDescription } from './get';
+import { issueCreateDescription } from './create';
+
+const showOnlyForIssues = {
+	resource: ['issue'],
+};
+
+export const issueDescription: INodeProperties[] = [
+	{
+		displayName: 'Operation',
+		name: 'operation',
+		type: 'options',
+		noDataExpression: true,
+		displayOptions: {
+			show: showOnlyForIssues,
+		},
+		options: [
+			{
+				name: 'Get Many',
+				value: 'getAll',
+				action: 'Get issues in a repository',
+				description: 'Get many issues in a repository',
+				routing: {
+					request: {
+						method: 'GET',
+						url: '=/repos/{{$parameter.owner}}/{{$parameter.repository}}/issues',
+					},
+				},
+			},
+			{
+				name: 'Get',
+				value: 'get',
+				action: 'Get an issue',
+				description: 'Get the data of a single issue',
+				routing: {
+					request: {
+						method: 'GET',
+						url: '=/repos/{{$parameter.owner}}/{{$parameter.repository}}/issues/{{$parameter.issue}}',
+					},
+				},
+			},
+			{
+				name: 'Create',
+				value: 'create',
+				action: 'Create a new issue',
+				description: 'Create a new issue',
+				routing: {
+					request: {
+						method: 'POST',
+						url: '=/repos/{{$parameter.owner}}/{{$parameter.repository}}/issues',
+					},
+				},
+			},
+		],
+		default: 'getAll',
+	},
+	{
+		...repoOwnerSelect,
+		displayOptions: {
+			show: showOnlyForIssues,
+		},
+	},
+	{
+		...repoNameSelect,
+		displayOptions: {
+			show: showOnlyForIssues,
+		},
+	},
+	...issueGetManyDescription,
+	...issueGetDescription,
+	...issueCreateDescription,
+];

nodes/GithubIssues/resources/issueComment/getAll.ts

@@ -0,0 +1,65 @@
+import type { INodeProperties } from 'n8n-workflow';
+import { parseLinkHeader } from '../../shared/utils';
+
+const showOnlyForIssueCommentGetMany = {
+	operation: ['getAll'],
+	resource: ['issueComment'],
+};
+
+export const issueCommentGetManyDescription: INodeProperties[] = [
+	{
+		displayName: 'Limit',
+		name: 'limit',
+		type: 'number',
+		displayOptions: {
+			show: {
+				...showOnlyForIssueCommentGetMany,
+				returnAll: [false],
+			},
+		},
+		typeOptions: {
+			minValue: 1,
+			maxValue: 100,
+		},
+		default: 50,
+		routing: {
+			send: {
+				type: 'query',
+				property: 'per_page',
+			},
+			output: {
+				maxResults: '={{$value}}',
+			},
+		},
+		description: 'Max number of results to return',
+	},
+	{
+		displayName: 'Return All',
+		name: 'returnAll',
+		type: 'boolean',
+		displayOptions: {
+			show: showOnlyForIssueCommentGetMany,
+		},
+		default: false,
+		description: 'Whether to return all results or only up to a given limit',
+		routing: {
+			send: {
+				paginate: '={{ $value }}',
+				type: 'query',
+				property: 'per_page',
+				value: '100',
+			},
+			operations: {
+				pagination: {
+					type: 'generic',
+					properties: {
+						continue: `={{ !!(${parseLinkHeader.toString()})($response.headers?.link).next }}`,
+						request: {
+							url: `={{ (${parseLinkHeader.toString()})($response.headers?.link)?.next ?? $request.url }}`,
+						},
+					},
+				},
+			},
+		},
+	},
+];

nodes/GithubIssues/resources/issueComment/index.ts

@@ -0,0 +1,47 @@
+import type { INodeProperties } from 'n8n-workflow';
+import { repoNameSelect, repoOwnerSelect } from '../../shared/descriptions';
+import { issueCommentGetManyDescription } from './getAll';
+
+const showOnlyForIssueComments = {
+	resource: ['issueComment'],
+};
+
+export const issueCommentDescription: INodeProperties[] = [
+	{
+		displayName: 'Operation',
+		name: 'operation',
+		type: 'options',
+		noDataExpression: true,
+		displayOptions: {
+			show: showOnlyForIssueComments,
+		},
+		options: [
+			{
+				name: 'Get Many',
+				value: 'getAll',
+				action: 'Get issue comments',
+				description: 'Get issue comments',
+				routing: {
+					request: {
+						method: 'GET',
+						url: '=/repos/{{$parameter.owner}}/{{$parameter.repository}}/issues/comments',
+					},
+				},
+			},
+		],
+		default: 'getAll',
+	},
+	{
+		...repoOwnerSelect,
+		displayOptions: {
+			show: showOnlyForIssueComments,
+		},
+	},
+	{
+		...repoNameSelect,
+		displayOptions: {
+			show: showOnlyForIssueComments,
+		},
+	},
+	...issueCommentGetManyDescription,
+];

nodes/GithubIssues/shared/descriptions.ts

@@ -0,0 +1,151 @@
+import type { INodeProperties } from 'n8n-workflow';
+
+export const repoOwnerSelect: INodeProperties = {
+	displayName: 'Repository Owner',
+	name: 'owner',
+	type: 'resourceLocator',
+	default: { mode: 'list', value: '' },
+	required: true,
+	modes: [
+		{
+			displayName: 'Repository Owner',
+			name: 'list',
+			type: 'list',
+			placeholder: 'Select an owner...',
+			typeOptions: {
+				searchListMethod: 'getUsers',
+				searchable: true,
+				searchFilterRequired: false,
+			},
+		},
+		{
+			displayName: 'Link',
+			name: 'url',
+			type: 'string',
+			placeholder: 'e.g. https://github.com/n8n-io',
+			extractValue: {
+				type: 'regex',
+				regex: 'https:\\/\\/github.com\\/([-_0-9a-zA-Z]+)',
+			},
+			validation: [
+				{
+					type: 'regex',
+					properties: {
+						regex: 'https:\\/\\/github.com\\/([-_0-9a-zA-Z]+)(?:.*)',
+						errorMessage: 'Not a valid GitHub URL',
+					},
+				},
+			],
+		},
+		{
+			displayName: 'By Name',
+			name: 'name',
+			type: 'string',
+			placeholder: 'e.g. n8n-io',
+			validation: [
+				{
+					type: 'regex',
+					properties: {
+						regex: '[-_a-zA-Z0-9]+',
+						errorMessage: 'Not a valid GitHub Owner Name',
+					},
+				},
+			],
+			url: '=https://github.com/{{$value}}',
+		},
+	],
+};
+
+export const repoNameSelect: INodeProperties = {
+	displayName: 'Repository Name',
+	name: 'repository',
+	type: 'resourceLocator',
+	default: {
+		mode: 'list',
+		value: '',
+	},
+	required: true,
+	modes: [
+		{
+			displayName: 'Repository Name',
+			name: 'list',
+			type: 'list',
+			placeholder: 'Select an Repository...',
+			typeOptions: {
+				searchListMethod: 'getRepositories',
+				searchable: true,
+			},
+		},
+		{
+			displayName: 'Link',
+			name: 'url',
+			type: 'string',
+			placeholder: 'e.g. https://github.com/n8n-io/n8n',
+			extractValue: {
+				type: 'regex',
+				regex: 'https:\\/\\/github.com\\/(?:[-_0-9a-zA-Z]+)\\/([-_.0-9a-zA-Z]+)',
+			},
+			validation: [
+				{
+					type: 'regex',
+					properties: {
+						regex: 'https:\\/\\/github.com\\/(?:[-_0-9a-zA-Z]+)\\/([-_.0-9a-zA-Z]+)(?:.*)',
+						errorMessage: 'Not a valid GitHub Repository URL',
+					},
+				},
+			],
+		},
+		{
+			displayName: 'By Name',
+			name: 'name',
+			type: 'string',
+			placeholder: 'e.g. n8n',
+			validation: [
+				{
+					type: 'regex',
+					properties: {
+						regex: '[-_.0-9a-zA-Z]+',
+						errorMessage: 'Not a valid GitHub Repository Name',
+					},
+				},
+			],
+			url: '=https://github.com/{{$parameter["owner"]}}/{{$value}}',
+		},
+	],
+	displayOptions: {
+		hide: {
+			resource: ['user', 'organization'],
+			operation: ['getRepositories'],
+		},
+	},
+};
+
+export const issueSelect: INodeProperties = {
+	displayName: 'Issue',
+	name: 'issue',
+	type: 'resourceLocator',
+	default: {
+		mode: 'list',
+		value: '',
+	},
+	required: true,
+	modes: [
+		{
+			displayName: 'Issue',
+			name: 'list',
+			type: 'list',
+			placeholder: 'Select an Issue...',
+			typeOptions: {
+				searchListMethod: 'getIssues',
+				searchable: true,
+			},
+		},
+		{
+			displayName: 'By ID',
+			name: 'name',
+			type: 'string',
+			placeholder: 'e.g. 123',
+			url: '=https://github.com/{{$parameter.owner}}/{{$parameter.repository}}/issues/{{$value}}',
+		},
+	],
+};

nodes/GithubIssues/shared/transport.ts

@@ -0,0 +1,32 @@
+import type {
+	IHookFunctions,
+	IExecuteFunctions,
+	IExecuteSingleFunctions,
+	ILoadOptionsFunctions,
+	IHttpRequestMethods,
+	IDataObject,
+	IHttpRequestOptions,
+} from 'n8n-workflow';
+
+export async function githubApiRequest(
+	this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
+	method: IHttpRequestMethods,
+	resource: string,
+	qs: IDataObject = {},
+	body: IDataObject | undefined = undefined,
+) {
+	const authenticationMethod = this.getNodeParameter('authentication', 0);
+
+	const options: IHttpRequestOptions = {
+		method: method,
+		qs,
+		body,
+		url: `https://api.github.com${resource}`,
+		json: true,
+	};
+
+	const credentialType =
+		authenticationMethod === 'accessToken' ? 'githubIssuesApi' : 'githubIssuesOAuth2Api';
+
+	return this.helpers.httpRequestWithAuthentication.call(this, credentialType, options);
+}

nodes/GithubIssues/shared/utils.ts

@@ -0,0 +1,14 @@
+export function parseLinkHeader(header?: string): { [rel: string]: string } {
+	const links: { [rel: string]: string } = {};
+
+	for (const part of header?.split(',') ?? []) {
+		const section = part.trim();
+		const match = section.match(/^<([^>]+)>\s*;\s*rel="?([^"]+)"?/);
+		if (match) {
+			const [, url, rel] = match;
+			links[rel] = url;
+		}
+	}
+
+	return links;
+}