Prepare initial release (#4)

* prepare Release base of the guideline from n8n
* chore: remove unused icons and docs
* feat: add create delete and stimulus operations
* refactor: improve UX with alphabetical operations and sensible limit default
* refactor: improve code structure and fix operation descriptions
* Use list_operations instead of check_credentials
* refactor: improve error handling and UX consistency

---------

Co-authored-by: Lars Kaltefleiter <lars.kaltefleiter@itomig.de>

Author: dw-itomig

CHANGELOG.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ITOMIG GmbH
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -3,13 +3,19 @@ import type {
 	ICredentialTestRequest,
 	ICredentialType,
 	INodeProperties,
+	Icon,
 } from 'n8n-workflow';
 
 export class ITopApi implements ICredentialType {
 	name = 'iTopApi';
 
 	displayName = 'iTop API';
 
+	icon: Icon = {
+		light: 'file:../nodes/ITop/icons/itop.svg',
+		dark: 'file:../nodes/ITop/icons/itop-dark.svg',
+	};
+
 	documentationUrl = 'https://www.itophub.io/wiki/page?id=latest:advancedtopics:rest_json';
 
 	properties: INodeProperties[] = [
@@ -60,7 +66,7 @@ export class ITopApi implements ICredentialType {
 				'Content-Type': 'application/x-www-form-urlencoded',
 			},
 			body: {
-				json_data: '={{ JSON.stringify({ operation: "core/check_credentials" }) }}',
+				json_data: '={{ JSON.stringify({ operation: "list_operations" }) }}',
 				auth_user: '={{$credentials.username}}',
 				auth_pwd: '={{$credentials.password}}',
 			},
@@ -69,11 +75,19 @@ export class ITopApi implements ICredentialType {
 			{
 				type: 'responseSuccessBody',
 				properties: {
-					key: 'authorized',
-					value: true,
-					message: 'Authentication failed. Please check your username and password.',
+					key: 'code',
+					value: 1,
+					message: 'Authentication failed. Missing/wrong credentials or the user does not have enough rights to perform the requested operation.',
 				},
 			},
+			{
+				type: 'responseSuccessBody',
+				properties: {
+					key: 'code',
+					value: 100,
+					message: 'Request failed. Internal iTop Error.',
+				},
+			}
 		],
 	};
 }

credentials/GithubIssuesApi.credentials.ts

@@ -3,13 +3,19 @@ import type {
 	ICredentialTestRequest,
 	ICredentialType,
 	INodeProperties,
+	Icon,
 } from 'n8n-workflow';
 
 export class ITopTokenApi implements ICredentialType {
 	name = 'iTopTokenApi';
 
 	displayName = 'iTop Token API';
 
+	icon: Icon = {
+		light: 'file:../nodes/ITop/icons/itop.svg',
+		dark: 'file:../nodes/ITop/icons/itop-dark.svg',
+	};
+
 	documentationUrl = 'https://www.itophub.io/wiki/page?id=latest:advancedtopics:rest_json';
 
 	properties: INodeProperties[] = [
@@ -54,19 +60,27 @@ export class ITopTokenApi implements ICredentialType {
 				'Content-Type': 'application/x-www-form-urlencoded',
 			},
 			body: {
-				json_data: '={{ JSON.stringify({ operation: "core/check_credentials" }) }}',
+				json_data: '={{ JSON.stringify({ operation: "list_operations" }) }}',
 				auth_token: '={{$credentials.authToken}}',
 			},
 		},
 		rules: [
 			{
 				type: 'responseSuccessBody',
 				properties: {
-					key: 'authorized',
-					value: true,
-					message: 'Authentication failed. Please check your token.',
+					key: 'code',
+					value: 1,
+					message: 'Authentication failed. Missing/wrong credentials or the user does not have enough rights to perform the requested operation.',
 				},
 			},
+			{
+				type: 'responseSuccessBody',
+				properties: {
+					key: 'code',
+					value: 100,
+					message: 'Request failed. Internal iTop Error.',
+				},
+			}
 		],
 	};
 }