@atom8n/node-cli 0.17.0

package/dist/template/templates/declarative/github-issues/template/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,
+];

package/dist/template/templates/declarative/github-issues/template/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}}',
+		},
+	],
+};

package/dist/template/templates/declarative/github-issues/template/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);
+}

package/dist/template/templates/declarative/github-issues/template/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;
+}

package/dist/template/templates/declarative/github-issues/template/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "{{nodePackageName}}",
+  "version": "0.1.0",
+  "description": "",
+  "license": "MIT",
+  "homepage": "",
+  "keywords": [
+    "n8n-community-node-package"
+  ],
+  "author": {
+    "name": "{{user.name}}",
+    "email": "{{user.email}}"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/<...>/n8n-nodes-<...>.git"
+  },
+  "scripts": {
+    "build": "n8n-node build",
+    "build:watch": "tsc --watch",
+    "dev": "n8n-node dev",
+    "lint": "n8n-node lint",
+    "lint:fix": "n8n-node lint --fix",
+    "release": "n8n-node release",
+    "prepublishOnly": "n8n-node prerelease"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "strict": true,
+    "credentials": [
+      "dist/credentials/GithubIssuesApi.credentials.js",
+      "dist/credentials/GithubIssuesOAuth2Api.credentials.js"
+    ],
+    "nodes": [
+      "dist/nodes/GithubIssues/GithubIssues.node.js"
+    ]
+  },
+  "devDependencies": {
+    "@atom8n/node-cli": "*",
+    "eslint": "9.32.0",
+    "prettier": "3.6.2",
+    "release-it": "^19.0.4",
+    "typescript": "5.9.2"
+  },
+  "peerDependencies": {
+    "@atom8n/n8n-workflow": "*"
+  }
+}

package/dist/template/templates/declarative/github-issues/template/tsconfig.json

@@ -0,0 +1,25 @@
+{
+	"compilerOptions": {
+		"strict": true,
+		"module": "commonjs",
+		"moduleResolution": "node",
+		"target": "es2019",
+		"lib": ["es2019", "es2020", "es2022.error"],
+		"removeComments": true,
+		"useUnknownInCatchVariables": false,
+		"forceConsistentCasingInFileNames": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noUnusedLocals": true,
+		"strictNullChecks": true,
+		"preserveConstEnums": true,
+		"esModuleInterop": true,
+		"resolveJsonModule": true,
+		"incremental": true,
+		"declaration": true,
+		"sourceMap": true,
+		"skipLibCheck": true,
+		"outDir": "./dist/"
+	},
+	"include": ["credentials/**/*", "nodes/**/*", "nodes/**/*.json", "package.json"]
+}

package/dist/template/templates/declarative/github-issues/template.d.ts

@@ -0,0 +1 @@
+export declare const githubIssuesTemplate: import("../../../core").TemplateWithRun<object>;

package/dist/template/templates/declarative/github-issues/template.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.githubIssuesTemplate = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const core_1 = require("../../../core");
+exports.githubIssuesTemplate = (0, core_1.createTemplate)({
+    name: 'GitHub Issues API',
+    description: 'Demo node with multiple operations and credentials',
+    path: node_path_1.default.join(__dirname, 'template'),
+});
+//# sourceMappingURL=template.js.map

package/dist/template/templates/declarative/github-issues/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../../../../../src/template/templates/declarative/github-issues/template.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAE7B,wCAA+C;AAElC,QAAA,oBAAoB,GAAG,IAAA,qBAAc,EAAC;IAClD,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE,oDAAoD;IACjE,IAAI,EAAE,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;CACtC,CAAC,CAAC"}

package/dist/template/templates/declarative/github-issues/template.ts

@@ -0,0 +1,9 @@
+import path from 'node:path';
+
+import { createTemplate } from '../../../core';
+
+export const githubIssuesTemplate = createTemplate({
+	name: 'GitHub Issues API',
+	description: 'Demo node with multiple operations and credentials',
+	path: path.join(__dirname, 'template'),
+});

package/dist/template/templates/index.d.ts

@@ -0,0 +1,15 @@
+export declare const templates: {
+    readonly declarative: {
+        readonly githubIssues: import("../core").TemplateWithRun<object>;
+        readonly custom: import("../core").TemplateWithRun<import("./declarative/custom/types").CustomTemplateConfig>;
+    };
+    readonly programmatic: {
+        readonly example: import("../core").TemplateWithRun<object>;
+    };
+};
+export type TemplateMap = typeof templates;
+export type TemplateType = keyof TemplateMap;
+export type TemplateName<T extends TemplateType> = keyof TemplateMap[T];
+export declare function getTemplate<T extends TemplateType, N extends TemplateName<T>>(type: T, name: N): TemplateMap[T][N];
+export declare function isTemplateType(val: unknown): val is TemplateType;
+export declare function isTemplateName<T extends TemplateType>(type: T, name: unknown): name is TemplateName<T>;

package/dist/template/templates/index.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templates = void 0;
+exports.getTemplate = getTemplate;
+exports.isTemplateType = isTemplateType;
+exports.isTemplateName = isTemplateName;
+const template_1 = require("./declarative/custom/template");
+const template_2 = require("./declarative/github-issues/template");
+const template_3 = require("./programmatic/example/template");
+exports.templates = {
+    declarative: {
+        githubIssues: template_2.githubIssuesTemplate,
+        custom: template_1.customTemplate,
+    },
+    programmatic: {
+        example: template_3.exampleTemplate,
+    },
+};
+function getTemplate(type, name) {
+    return exports.templates[type][name];
+}
+function isTemplateType(val) {
+    return typeof val === 'string' && val in exports.templates;
+}
+function isTemplateName(type, name) {
+    return typeof name === 'string' && name in exports.templates[type];
+}
+//# sourceMappingURL=index.js.map

package/dist/template/templates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/template/templates/index.ts"],"names":[],"mappings":";;;AAkBA,kCAKC;AAED,wCAEC;AAED,wCAKC;AAlCD,4DAA+D;AAC/D,mEAA4E;AAC5E,8DAAkE;AAErD,QAAA,SAAS,GAAG;IACxB,WAAW,EAAE;QACZ,YAAY,EAAE,+BAAoB;QAClC,MAAM,EAAE,yBAAc;KACtB;IACD,YAAY,EAAE;QACb,OAAO,EAAE,0BAAe;KACxB;CACQ,CAAC;AAMX,SAAgB,WAAW,CAC1B,IAAO,EACP,IAAO;IAEP,OAAO,iBAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,SAAgB,cAAc,CAAC,GAAY;IAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,IAAI,iBAAS,CAAC;AACpD,CAAC;AAED,SAAgB,cAAc,CAC7B,IAAO,EACP,IAAa;IAEb,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,iBAAS,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC"}

package/dist/template/templates/index.ts

@@ -0,0 +1,35 @@
+import { customTemplate } from './declarative/custom/template';
+import { githubIssuesTemplate } from './declarative/github-issues/template';
+import { exampleTemplate } from './programmatic/example/template';
+
+export const templates = {
+	declarative: {
+		githubIssues: githubIssuesTemplate,
+		custom: customTemplate,
+	},
+	programmatic: {
+		example: exampleTemplate,
+	},
+} as const;
+
+export type TemplateMap = typeof templates;
+export type TemplateType = keyof TemplateMap;
+export type TemplateName<T extends TemplateType> = keyof TemplateMap[T];
+
+export function getTemplate<T extends TemplateType, N extends TemplateName<T>>(
+	type: T,
+	name: N,
+): TemplateMap[T][N] {
+	return templates[type][name];
+}
+
+export function isTemplateType(val: unknown): val is TemplateType {
+	return typeof val === 'string' && val in templates;
+}
+
+export function isTemplateName<T extends TemplateType>(
+	type: T,
+	name: unknown,
+): name is TemplateName<T> {
+	return typeof name === 'string' && name in templates[type];
+}

package/dist/template/templates/programmatic/example/template/README.md

@@ -0,0 +1,46 @@
+# {{nodePackageName}}
+
+This is an n8n community node. It lets you use _app/service name_ in your n8n workflows.
+
+_App/service name_ is _one or two sentences describing the service this node integrates with_.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/) workflow automation platform.
+
+[Installation](#installation)
+[Operations](#operations)
+[Credentials](#credentials)
+[Compatibility](#compatibility)
+[Usage](#usage)
+[Resources](#resources)
+[Version history](#version-history)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+_List the operations supported by your node._
+
+## Credentials
+
+_If users need to authenticate with the app/service, provide details here. You should include prerequisites (such as signing up with the service), available authentication methods, and how to set them up._
+
+## Compatibility
+
+_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._
+
+## Usage
+
+_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._
+
+_By the time users are looking for community nodes, they probably already know n8n basics. But if you expect new users, you can link to the [Try it out](https://docs.n8n.io/try-it-out/) documentation to help them get started._
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+* _Link to app/service documentation._
+
+## Version history
+
+_This is another optional section. If your node has multiple versions, include a short description of available versions and what changed, as well as any compatibility impact._

package/dist/template/templates/programmatic/example/template/nodes/Example/Example.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "{{nodePackageName}}",
+	"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"
+			}
+		]
+	}
+}

package/dist/template/templates/programmatic/example/template/nodes/Example/Example.node.ts

@@ -0,0 +1,78 @@
+import type {
+	IExecuteFunctions,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes, NodeOperationError } from 'n8n-workflow';
+
+export class Example implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Example',
+		name: 'example',
+		icon: { light: 'file:example.svg', dark: 'file:example.dark.svg' },
+		group: ['input'],
+		version: 1,
+		description: 'Basic Example Node',
+		defaults: {
+			name: 'Example',
+		},
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		usableAsTool: true,
+		properties: [
+			// Node properties which the user gets displayed and
+			// can change on the node.
+			{
+				displayName: 'My String',
+				name: 'myString',
+				type: 'string',
+				default: '',
+				placeholder: 'Placeholder value',
+				description: 'The description text',
+			},
+		],
+	};
+
+	// The function below is responsible for actually doing whatever this node
+	// is supposed to do. In this case, we're just appending the `myString` property
+	// with whatever the user has entered.
+	// You can make async calls and use `await`.
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+
+		let item: INodeExecutionData;
+		let myString: string;
+
+		// Iterates over all input items and add the key "myString" with the
+		// value the parameter "myString" resolves to.
+		// (This could be a different value for each item in case it contains an expression)
+		for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+			try {
+				myString = this.getNodeParameter('myString', itemIndex, '') as string;
+				item = items[itemIndex];
+
+				item.json.myString = myString;
+			} catch (error) {
+				// This node should never fail but we want to showcase how
+				// to handle errors.
+				if (this.continueOnFail()) {
+					items.push({ json: this.getInputData(itemIndex)[0].json, error, pairedItem: itemIndex });
+				} else {
+					// Adding `itemIndex` allows other workflows to handle this error
+					if (error.context) {
+						// If the error thrown already contains the context property,
+						// only append the itemIndex
+						error.context.itemIndex = itemIndex;
+						throw error;
+					}
+					throw new NodeOperationError(this.getNode(), error, {
+						itemIndex,
+					});
+				}
+			}
+		}
+
+		return [items];
+	}
+}

package/dist/template/templates/programmatic/example/template/nodes/Example/example.dark.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="aquamarine"
+    stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-cpu">
+    <rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
+    <rect x="9" y="9" width="6" height="6"></rect>
+    <line x1="9" y1="1" x2="9" y2="4"></line>
+    <line x1="15" y1="1" x2="15" y2="4"></line>
+    <line x1="9" y1="20" x2="9" y2="23"></line>
+    <line x1="15" y1="20" x2="15" y2="23"></line>
+    <line x1="20" y1="9" x2="23" y2="9"></line>
+    <line x1="20" y1="14" x2="23" y2="14"></line>
+    <line x1="1" y1="9" x2="4" y2="9"></line>
+    <line x1="1" y1="14" x2="4" y2="14"></line>
+</svg>

package/dist/template/templates/programmatic/example/template/nodes/Example/example.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="darkblue"
+    stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-cpu">
+    <rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
+    <rect x="9" y="9" width="6" height="6"></rect>
+    <line x1="9" y1="1" x2="9" y2="4"></line>
+    <line x1="15" y1="1" x2="15" y2="4"></line>
+    <line x1="9" y1="20" x2="9" y2="23"></line>
+    <line x1="15" y1="20" x2="15" y2="23"></line>
+    <line x1="20" y1="9" x2="23" y2="9"></line>
+    <line x1="20" y1="14" x2="23" y2="14"></line>
+    <line x1="1" y1="9" x2="4" y2="9"></line>
+    <line x1="1" y1="14" x2="4" y2="14"></line>
+</svg>

package/dist/template/templates/programmatic/example/template/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "{{nodePackageName}}",
+  "version": "0.1.0",
+  "description": "",
+  "license": "MIT",
+  "homepage": "",
+  "keywords": [
+    "n8n-community-node-package"
+  ],
+  "author": {
+    "name": "{{user.name}}",
+    "email": "{{user.email}}"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/<...>/n8n-nodes-<...>.git"
+  },
+  "scripts": {
+    "build": "n8n-node build",
+    "build:watch": "tsc --watch",
+    "dev": "n8n-node dev",
+    "lint": "n8n-node lint",
+    "lint:fix": "n8n-node lint --fix",
+    "release": "n8n-node release",
+    "prepublishOnly": "n8n-node prerelease"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "strict": true,
+    "credentials": [],
+    "nodes": [
+      "dist/nodes/Example/Example.node.js"
+    ]
+  },
+  "devDependencies": {
+    "@atom8n/node-cli": "*",
+    "eslint": "9.32.0",
+    "prettier": "3.6.2",
+    "release-it": "^19.0.4",
+    "typescript": "5.9.2"
+  },
+  "peerDependencies": {
+    "@atom8n/n8n-workflow": "*"
+  }
+}