1 Commits

Author SHA1 Message Date
Iván Ovejero
060a34edeb 👕 Disable casing rules 2022-07-19 16:06:35 +02:00
17 changed files with 5778 additions and 357 deletions

View File

@@ -12,9 +12,6 @@ trim_trailing_whitespace = true
indent_style = space indent_style = space
indent_size = 2 indent_size = 2
[*.md]
trim_trailing_whitespace = false
[*.yml] [*.yml]
indent_style = space indent_style = space
indent_size = 2 indent_size = 2

View File

@@ -1,6 +1,3 @@
/**
* @type {import('@types/eslint').ESLint.ConfigData}
*/
module.exports = { module.exports = {
root: true, root: true,
@@ -11,42 +8,34 @@ module.exports = {
}, },
parser: '@typescript-eslint/parser', parser: '@typescript-eslint/parser',
parserOptions: { parserOptions: {
project: ['./tsconfig.json'], project: ['./tsconfig.json'],
sourceType: 'module', sourceType: 'module',
extraFileExtensions: ['.json'], extraFileExtensions: ['.json'],
}, },
ignorePatterns: [
ignorePatterns: ['.eslintrc.js', '**/*.js', '**/node_modules/**', '**/dist/**'], '.eslintrc.js',
'**/*.js',
'**/node_modules/**',
'**/dist/**',
],
overrides: [ overrides: [
{ {
files: ['package.json'], files: ['package.json'],
plugins: ['eslint-plugin-n8n-nodes-base'], plugins: ['eslint-plugin-n8n-nodes-base'],
extends: ['plugin:n8n-nodes-base/community'], extends: ['plugin:n8n-nodes-base/community'],
rules: {
'n8n-nodes-base/community-package-json-name-still-default': 'off',
},
}, },
{ {
files: ['./credentials/**/*.ts'], files: ['./credentials/**/*.ts'],
plugins: ['eslint-plugin-n8n-nodes-base'], plugins: ['eslint-plugin-n8n-nodes-base'],
extends: ['plugin:n8n-nodes-base/credentials'], extends: ['plugin:n8n-nodes-base/credentials'],
rules: { rules: {
'n8n-nodes-base/cred-class-field-authenticate-type-assertion': 'error', 'n8n-nodes-base/cred-class-field-documentation-url-missing': 'off',
'n8n-nodes-base/cred-class-field-display-name-missing-oauth2': 'error',
'n8n-nodes-base/cred-class-field-display-name-miscased': 'error',
'n8n-nodes-base/cred-class-field-documentation-url-missing': 'error',
'n8n-nodes-base/cred-class-field-documentation-url-miscased': 'off', 'n8n-nodes-base/cred-class-field-documentation-url-miscased': 'off',
'n8n-nodes-base/cred-class-field-name-missing-oauth2': 'error',
'n8n-nodes-base/cred-class-field-name-unsuffixed': 'error', 'n8n-nodes-base/cred-filename-against-convention': 'off',
'n8n-nodes-base/cred-class-field-name-uppercase-first-char': 'error', 'n8n-nodes-base/cred-class-field-name-uppercase-first-char': 'off',
'n8n-nodes-base/cred-class-field-properties-assertion': 'error',
'n8n-nodes-base/cred-class-field-type-options-password-missing': 'error',
'n8n-nodes-base/cred-class-name-missing-oauth2-suffix': 'error',
'n8n-nodes-base/cred-class-name-unsuffixed': 'error',
'n8n-nodes-base/cred-filename-against-convention': 'error',
}, },
}, },
{ {
@@ -54,92 +43,16 @@ module.exports = {
plugins: ['eslint-plugin-n8n-nodes-base'], plugins: ['eslint-plugin-n8n-nodes-base'],
extends: ['plugin:n8n-nodes-base/nodes'], extends: ['plugin:n8n-nodes-base/nodes'],
rules: { rules: {
'n8n-nodes-base/node-class-description-credentials-name-unsuffixed': 'error', 'n8n-nodes-base/node-execute-block-missing-continue-on-fail': 'off',
'n8n-nodes-base/node-class-description-display-name-unsuffixed-trigger-node': 'error', 'n8n-nodes-base/node-resource-description-filename-against-convention': 'off',
'n8n-nodes-base/node-class-description-empty-string': 'error', 'n8n-nodes-base/node-param-fixed-collection-type-unsorted-items': 'off',
'n8n-nodes-base/node-class-description-icon-not-svg': 'error', 'n8n-nodes-base/node-execute-block-operation-missing-singular-pairing': 'off',
'n8n-nodes-base/node-class-description-inputs-wrong-regular-node': 'off', 'n8n-nodes-base/node-execute-block-operation-missing-plural-pairing': 'off',
'n8n-nodes-base/node-class-description-inputs-wrong-trigger-node': 'error',
'n8n-nodes-base/node-class-description-missing-subtitle': 'error', 'n8n-nodes-base/node-dirname-against-convention': 'off',
'n8n-nodes-base/node-class-description-non-core-color-present': 'error', 'n8n-nodes-base/node-filename-against-convention': 'off',
'n8n-nodes-base/node-class-description-name-miscased': 'error', 'n8n-nodes-base/node-param-operation-option-action-miscased': 'off',
'n8n-nodes-base/node-class-description-name-unsuffixed-trigger-node': 'error', 'n8n-nodes-base/node-param-display-name-miscased': 'off',
'n8n-nodes-base/node-class-description-outputs-wrong': 'off',
'n8n-nodes-base/node-dirname-against-convention': 'error',
'n8n-nodes-base/node-execute-block-double-assertion-for-items': 'error',
'n8n-nodes-base/node-execute-block-wrong-error-thrown': 'error',
'n8n-nodes-base/node-filename-against-convention': 'error',
'n8n-nodes-base/node-param-array-type-assertion': 'error',
'n8n-nodes-base/node-param-color-type-unused': 'error',
'n8n-nodes-base/node-param-default-missing': 'error',
'n8n-nodes-base/node-param-default-wrong-for-boolean': 'error',
'n8n-nodes-base/node-param-default-wrong-for-collection': 'error',
'n8n-nodes-base/node-param-default-wrong-for-fixed-collection': 'error',
'n8n-nodes-base/node-param-default-wrong-for-fixed-collection': 'error',
'n8n-nodes-base/node-param-default-wrong-for-multi-options': 'error',
'n8n-nodes-base/node-param-default-wrong-for-number': 'error',
'n8n-nodes-base/node-param-default-wrong-for-simplify': 'error',
'n8n-nodes-base/node-param-default-wrong-for-string': 'error',
'n8n-nodes-base/node-param-description-boolean-without-whether': 'error',
'n8n-nodes-base/node-param-description-comma-separated-hyphen': 'error',
'n8n-nodes-base/node-param-description-empty-string': 'error',
'n8n-nodes-base/node-param-description-excess-final-period': 'error',
'n8n-nodes-base/node-param-description-excess-inner-whitespace': 'error',
'n8n-nodes-base/node-param-description-identical-to-display-name': 'error',
'n8n-nodes-base/node-param-description-line-break-html-tag': 'error',
'n8n-nodes-base/node-param-description-lowercase-first-char': 'error',
'n8n-nodes-base/node-param-description-miscased-id': 'error',
'n8n-nodes-base/node-param-description-miscased-json': 'error',
'n8n-nodes-base/node-param-description-miscased-url': 'error',
'n8n-nodes-base/node-param-description-missing-final-period': 'error',
'n8n-nodes-base/node-param-description-missing-for-ignore-ssl-issues': 'error',
'n8n-nodes-base/node-param-description-missing-for-return-all': 'error',
'n8n-nodes-base/node-param-description-missing-for-simplify': 'error',
'n8n-nodes-base/node-param-description-missing-from-dynamic-multi-options': 'error',
'n8n-nodes-base/node-param-description-missing-from-dynamic-options': 'error',
'n8n-nodes-base/node-param-description-missing-from-limit': 'error',
'n8n-nodes-base/node-param-description-unencoded-angle-brackets': 'error',
'n8n-nodes-base/node-param-description-unneeded-backticks': 'error',
'n8n-nodes-base/node-param-description-untrimmed': 'error',
'n8n-nodes-base/node-param-description-url-missing-protocol': 'error',
'n8n-nodes-base/node-param-description-weak': 'error',
'n8n-nodes-base/node-param-description-wrong-for-dynamic-multi-options': 'error',
'n8n-nodes-base/node-param-description-wrong-for-dynamic-options': 'error',
'n8n-nodes-base/node-param-description-wrong-for-ignore-ssl-issues': 'error',
'n8n-nodes-base/node-param-description-wrong-for-limit': 'error',
'n8n-nodes-base/node-param-description-wrong-for-return-all': 'error',
'n8n-nodes-base/node-param-description-wrong-for-simplify': 'error',
'n8n-nodes-base/node-param-description-wrong-for-upsert': 'error',
'n8n-nodes-base/node-param-display-name-excess-inner-whitespace': 'error',
'n8n-nodes-base/node-param-display-name-miscased-id': 'error',
'n8n-nodes-base/node-param-display-name-miscased': 'error',
'n8n-nodes-base/node-param-display-name-not-first-position': 'error',
'n8n-nodes-base/node-param-display-name-untrimmed': 'error',
'n8n-nodes-base/node-param-display-name-wrong-for-dynamic-multi-options': 'error',
'n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options': 'error',
'n8n-nodes-base/node-param-display-name-wrong-for-simplify': 'error',
'n8n-nodes-base/node-param-display-name-wrong-for-update-fields': 'error',
'n8n-nodes-base/node-param-min-value-wrong-for-limit': 'error',
'n8n-nodes-base/node-param-multi-options-type-unsorted-items': 'error',
'n8n-nodes-base/node-param-name-untrimmed': 'error',
'n8n-nodes-base/node-param-operation-option-action-wrong-for-get-many': 'error',
'n8n-nodes-base/node-param-operation-option-description-wrong-for-get-many': 'error',
'n8n-nodes-base/node-param-operation-option-without-action': 'error',
'n8n-nodes-base/node-param-operation-without-no-data-expression': 'error',
'n8n-nodes-base/node-param-option-description-identical-to-name': 'error',
'n8n-nodes-base/node-param-option-name-containing-star': 'error',
'n8n-nodes-base/node-param-option-name-duplicate': 'error',
'n8n-nodes-base/node-param-option-name-wrong-for-get-many': 'error',
'n8n-nodes-base/node-param-option-name-wrong-for-upsert': 'error',
'n8n-nodes-base/node-param-option-value-duplicate': 'error',
'n8n-nodes-base/node-param-options-type-unsorted-items': 'error',
'n8n-nodes-base/node-param-placeholder-miscased-id': 'error',
'n8n-nodes-base/node-param-placeholder-missing-email': 'error',
'n8n-nodes-base/node-param-required-false': 'error',
'n8n-nodes-base/node-param-resource-with-plural-option': 'error',
'n8n-nodes-base/node-param-resource-without-no-data-expression': 'error',
'n8n-nodes-base/node-param-type-options-missing-from-limit': 'error',
'n8n-nodes-base/node-param-type-options-password-missing': 'error',
}, },
}, },
], ],

View File

@@ -1,16 +0,0 @@
/**
* @type {import('@types/eslint').ESLint.ConfigData}
*/
module.exports = {
extends: "./.eslintrc.js",
overrides: [
{
files: ['package.json'],
plugins: ['eslint-plugin-n8n-nodes-base'],
rules: {
'n8n-nodes-base/community-package-json-name-still-default': 'error',
},
},
],
};

View File

@@ -1,2 +0,0 @@
.DS_Store
*.tsbuildinfo

View File

@@ -1,76 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at jan@n8n.io. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

View File

@@ -1,4 +1,4 @@
Copyright 2022 n8n Copyright <YEAR> <COPYRIGHT HOLDER>
Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in this software and associated documentation files (the "Software"), to deal in

View File

@@ -1,47 +1,21 @@
![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
# n8n-nodes-starter # n8n-nodes-starter
This repo contains example nodes to help you get started building your own custom integrations for [n8n](https://n8n.io). It includes the node linter and other dependencies. This repo contains example nodes to help you get started building your own custom integrations for n8n.
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry). All nodes are npm packages. To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
If you would like your node to be available on n8n cloud you can also [submit your node for verification](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/).
## Prerequisites
You need the following installed on your development machine:
* [git](https://git-scm.com/downloads)
* Node.js and npm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
* Install n8n with:
```
npm install n8n -g
```
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/).
## Using this starter ## Using this starter
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/). 1. Clone the repo:
```
1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. git clone https://github.com/n8n-io/n8n-nodes-starter.git
2. Clone your new repo: ```
``` 2. Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/).
git clone https://github.com/<your organization>/<your-repo-name>.git 3. Open the project in your editor.
``` 4. Browse the examples in `/nodes`. Modify the examples, or replace them with your own nodes.
3. Run `npm i` to install dependencies. 5. Update the `package.json` to match your details.
4. Open the project in your editor. 6. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes. 7. Publish your package to npm. More information on the links below.
6. Update the `package.json` to match your details.
7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
10. Update the LICENSE file to use your details.
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
## More information
Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
## License ## License

View File

@@ -1,48 +0,0 @@
# n8n-nodes-_node-name_
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/reference/license/) workflow automation platform.
[Installation](#installation)
[Operations](#operations)
[Credentials](#credentials) <!-- delete if no auth needed -->
[Compatibility](#compatibility)
[Usage](#usage) <!-- delete if not using this section -->
[Resources](#resources)
[Version history](#version-history) <!-- delete if not using this section -->
## 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._

View File

@@ -8,9 +8,6 @@ import {
export class ExampleCredentialsApi implements ICredentialType { export class ExampleCredentialsApi implements ICredentialType {
name = 'exampleCredentialsApi'; name = 'exampleCredentialsApi';
displayName = 'Example Credentials API'; displayName = 'Example Credentials API';
documentationUrl = 'https://your-docs-url';
properties: INodeProperties[] = [ properties: INodeProperties[] = [
// The credentials to get from user and save encrypted. // The credentials to get from user and save encrypted.
// Properties can be defined exactly in the same way // Properties can be defined exactly in the same way

View File

@@ -8,16 +8,13 @@ import {
export class HttpBinApi implements ICredentialType { export class HttpBinApi implements ICredentialType {
name = 'httpbinApi'; name = 'httpbinApi';
displayName = 'HttpBin API'; displayName = 'HttpBin API';
documentationUrl = 'https://your-docs-url'; documentationUrl = '<your-docs-url>';
properties: INodeProperties[] = [ properties: INodeProperties[] = [
{ {
displayName: 'Token', displayName: 'Token',
name: 'token', name: 'token',
type: 'string', type: 'string',
default: '', default: '',
typeOptions: {
password: true,
}
}, },
{ {
displayName: 'Domain', displayName: 'Domain',
@@ -31,14 +28,14 @@ export class HttpBinApi implements ICredentialType {
// stating how this credential is injected as part of the request // stating how this credential is injected as part of the request
// An example is the Http Request node that can make generic calls // An example is the Http Request node that can make generic calls
// reusing this credential // reusing this credential
authenticate: IAuthenticateGeneric = { authenticate = {
type: 'generic', type: 'generic',
properties: { properties: {
headers: { headers: {
Authorization: '={{"Bearer " + $credentials.token}}', Authorization: '={{"Bearer " + $credentials.token}}',
}, },
}, },
}; } as IAuthenticateGeneric;
// The block below tells how this credential can be tested // The block below tells how this credential can be tested
test: ICredentialTestRequest = { test: ICredentialTestRequest = {

View File

@@ -1,10 +1,10 @@
import type { import { IExecuteFunctions } from 'n8n-core';
IExecuteFunctions, import {
INodeExecutionData, INodeExecutionData,
INodeType, INodeType,
INodeTypeDescription, INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow'; } from 'n8n-workflow';
import { NodeConnectionType, NodeOperationError } from 'n8n-workflow';
export class ExampleNode implements INodeType { export class ExampleNode implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
@@ -16,9 +16,8 @@ export class ExampleNode implements INodeType {
defaults: { defaults: {
name: 'Example Node', name: 'Example Node',
}, },
inputs: [NodeConnectionType.Main], inputs: ['main'],
outputs: [NodeConnectionType.Main], outputs: ['main'],
usableAsTool: true,
properties: [ properties: [
// Node properties which the user gets displayed and // Node properties which the user gets displayed and
// can change on the node. // can change on the node.
@@ -51,7 +50,7 @@ export class ExampleNode implements INodeType {
myString = this.getNodeParameter('myString', itemIndex, '') as string; myString = this.getNodeParameter('myString', itemIndex, '') as string;
item = items[itemIndex]; item = items[itemIndex];
item.json.myString = myString; item.json['myString'] = myString;
} catch (error) { } catch (error) {
// This node should never fail but we want to showcase how // This node should never fail but we want to showcase how
// to handle errors. // to handle errors.
@@ -72,6 +71,6 @@ export class ExampleNode implements INodeType {
} }
} }
return [items]; return this.prepareOutputData(items);
} }
} }

View File

@@ -1,21 +1,21 @@
import { INodeType, INodeTypeDescription, NodeConnectionType } from 'n8n-workflow'; import { INodeType, INodeTypeDescription } from 'n8n-workflow';
import { httpVerbFields, httpVerbOperations } from './HttpVerbDescription'; import { httpVerbFields, httpVerbOperations } from './HttpVerbDescription';
export class HttpBin implements INodeType { export class HttpBin implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'HttpBin', displayName: 'HttpBin',
name: 'httpBin', name: 'httpBin',
icon: { light: 'file:httpbin.svg', dark: 'file:httpbin.svg' }, icon: 'file:httpbin.svg',
group: ['transform'], group: ['transform'],
version: 1, version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Interact with HttpBin API', description: 'Interact with HttpBin API',
defaults: { defaults: {
name: 'HttpBin', name: 'HttpBin',
color: '#3b4151',
}, },
inputs: [NodeConnectionType.Main], inputs: ['main'],
outputs: [NodeConnectionType.Main], outputs: ['main'],
usableAsTool: true,
credentials: [ credentials: [
{ {
name: 'httpbinApi', name: 'httpbinApi',

View File

@@ -17,7 +17,6 @@ export const httpVerbOperations: INodeProperties[] = [
{ {
name: 'GET', name: 'GET',
value: 'get', value: 'get',
description: 'Perform a GET request',
action: 'Perform a GET request', action: 'Perform a GET request',
routing: { routing: {
request: { request: {
@@ -29,7 +28,6 @@ export const httpVerbOperations: INodeProperties[] = [
{ {
name: 'DELETE', name: 'DELETE',
value: 'delete', value: 'delete',
description: 'Perform a DELETE request',
action: 'Perform a DELETE request', action: 'Perform a DELETE request',
routing: { routing: {
request: { request: {
@@ -47,10 +45,10 @@ export const httpVerbOperations: INodeProperties[] = [
// We do that by adding `operation: ["get"]` to `displayOptions.show` // We do that by adding `operation: ["get"]` to `displayOptions.show`
const getOperation: INodeProperties[] = [ const getOperation: INodeProperties[] = [
{ {
displayName: 'Type of Data',
name: 'typeofData', name: 'typeofData',
default: 'queryParameter', default: 'queryParameter',
description: 'Select type of data to send [Query Parameters]', description: 'Select type of data to send [Query Parameters]',
displayName: 'Type of Data',
displayOptions: { displayOptions: {
show: { show: {
resource: ['httpVerb'], resource: ['httpVerb'],
@@ -67,10 +65,10 @@ const getOperation: INodeProperties[] = [
required: true, required: true,
}, },
{ {
displayName: 'Query Parameters',
name: 'arguments', name: 'arguments',
default: {}, default: {},
description: "The request's query parameters", description: "The request's query parameters",
displayName: 'Query Parameters',
displayOptions: { displayOptions: {
show: { show: {
resource: ['httpVerb'], resource: ['httpVerb'],
@@ -118,10 +116,10 @@ const getOperation: INodeProperties[] = [
// We do that by adding `operation: ["delete"]` to `displayOptions.show` // We do that by adding `operation: ["delete"]` to `displayOptions.show`
const deleteOperation: INodeProperties[] = [ const deleteOperation: INodeProperties[] = [
{ {
displayName: 'Type of Data',
name: 'typeofData', name: 'typeofData',
default: 'queryParameter', default: 'queryParameter',
description: 'Select type of data to send [Query Parameter Arguments, JSON-Body]', description: 'Select type of data to send [Query Parameter Arguments, JSON-Body]',
displayName: 'Type of Data',
displayOptions: { displayOptions: {
show: { show: {
resource: ['httpVerb'], resource: ['httpVerb'],
@@ -142,10 +140,10 @@ const deleteOperation: INodeProperties[] = [
type: 'options', type: 'options',
}, },
{ {
displayName: 'Query Parameters',
name: 'arguments', name: 'arguments',
default: {}, default: {},
description: "The request's query parameters", description: "The request's query parameters",
displayName: 'Query Parameters',
displayOptions: { displayOptions: {
show: { show: {
resource: ['httpVerb'], resource: ['httpVerb'],
@@ -189,10 +187,10 @@ const deleteOperation: INodeProperties[] = [
}, },
}, },
{ {
displayName: 'JSON Object',
name: 'arguments', name: 'arguments',
default: {}, default: {},
description: "The request's JSON properties", description: "The request's JSON properties",
displayName: 'JSON Object',
displayOptions: { displayOptions: {
show: { show: {
resource: ['httpVerb'], resource: ['httpVerb'],

5563
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,31 +1,28 @@
{ {
"name": "n8n-nodes-<...>", "name": "n8n-nodes-starter",
"version": "0.1.0", "version": "0.1.0",
"description": "", "description": "Example starter module for custom n8n nodes.",
"keywords": [ "keywords": [
"n8n-community-node-package" "n8n-community-node-package"
], ],
"license": "MIT", "license": "MIT",
"homepage": "", "homepage": "https://n8n.io",
"author": { "author": {
"name": "", "name": "Jan Oberhauser",
"email": "" "email": "jan@n8n.io"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/<...>/n8n-nodes-<...>.git" "url": "git+https://github.com/n8n-io/n8n-nodes-starter.git"
},
"engines": {
"node": ">=20.15"
}, },
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"build": "npx rimraf dist && tsc && gulp build:icons", "build": "tsc && gulp build:icons",
"dev": "tsc --watch", "dev": "tsc --watch",
"format": "prettier nodes credentials --write", "format": "prettier nodes credentials --write",
"lint": "eslint nodes credentials package.json", "lint": "tslint -p tsconfig.json -c tslint.json; eslint nodes credentials package.json",
"lintfix": "eslint nodes credentials package.json --fix", "lintfix": "tslint --fix -p tsconfig.json -c tslint.json; eslint nodes credentials package.json --fix",
"prepublishOnly": "npm run build && npm run lint -c .eslintrc.prepublish.js nodes credentials package.json" "prepare": "npm run build && npm run lint"
}, },
"files": [ "files": [
"dist" "dist"
@@ -33,7 +30,7 @@
"n8n": { "n8n": {
"n8nNodesApiVersion": 1, "n8nNodesApiVersion": 1,
"credentials": [ "credentials": [
"dist/credentials/ExampleCredentialsApi.credentials.js", "dist/credentials/ExampleCredentials.credentials.js",
"dist/credentials/HttpBinApi.credentials.js" "dist/credentials/HttpBinApi.credentials.js"
], ],
"nodes": [ "nodes": [
@@ -42,14 +39,15 @@
] ]
}, },
"devDependencies": { "devDependencies": {
"@typescript-eslint/parser": "~8.32.0", "@types/express": "^4.17.6",
"eslint": "^8.57.0", "@types/request-promise-native": "~1.0.15",
"eslint-plugin-n8n-nodes-base": "^1.16.3", "@typescript-eslint/parser": "^5.29.0",
"gulp": "^5.0.0", "eslint-plugin-n8n-nodes-base": "^1.5.1",
"prettier": "^3.5.3", "gulp": "^4.0.2",
"typescript": "^5.8.2" "n8n-core": "^0.125.0",
}, "n8n-workflow": "^0.107.0",
"peerDependencies": { "prettier": "^2.7.1",
"n8n-workflow": "*" "tslint": "^6.1.2",
"typescript": "~4.6.0"
} }
} }

View File

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

127
tslint.json Normal file
View File

@@ -0,0 +1,127 @@
{
"linterOptions": {
"exclude": [
"node_modules/**/*"
]
},
"defaultSeverity": "error",
"jsRules": {},
"rules": {
"array-type": [
true,
"array-simple"
],
"arrow-return-shorthand": true,
"ban": [
true,
{
"name": "Array",
"message": "tsstyle#array-constructor"
}
],
"ban-types": [
true,
[
"Object",
"Use {} instead."
],
[
"String",
"Use 'string' instead."
],
[
"Number",
"Use 'number' instead."
],
[
"Boolean",
"Use 'boolean' instead."
]
],
"class-name": true,
"curly": [
true,
"ignore-same-line"
],
"forin": true,
"jsdoc-format": true,
"label-position": true,
"indent": [
true,
"tabs",
2
],
"member-access": [
true,
"no-public"
],
"new-parens": true,
"no-angle-bracket-type-assertion": true,
"no-any": true,
"no-arg": true,
"no-conditional-assignment": true,
"no-construct": true,
"no-debugger": true,
"no-default-export": true,
"no-duplicate-variable": true,
"no-inferrable-types": true,
"ordered-imports": [
true,
{
"import-sources-order": "any",
"named-imports-order": "case-insensitive"
}
],
"no-namespace": [
true,
"allow-declarations"
],
"no-reference": true,
"no-string-throw": true,
"no-unused-expression": true,
"no-var-keyword": true,
"object-literal-shorthand": true,
"only-arrow-functions": [
true,
"allow-declarations",
"allow-named-functions"
],
"prefer-const": true,
"radix": true,
"semicolon": [
true,
"always",
"ignore-bound-class-methods"
],
"switch-default": true,
"trailing-comma": [
true,
{
"multiline": {
"objects": "always",
"arrays": "always",
"functions": "always",
"typeLiterals": "ignore"
},
"esSpecCompliant": true
}
],
"triple-equals": [
true,
"allow-null-check"
],
"use-isnan": true,
"quotes": [
"error",
"single"
],
"variable-name": [
true,
"check-format",
"ban-keywords",
"allow-leading-underscore",
"allow-trailing-underscore"
]
},
"rulesDirectory": []
}