Introduce node deprecation (#3930)

✨ Introduce node deprecation
n8n-io · Aug 24, 2022 · 4ec7ba9 · 4ec7ba9
1 parent 5285fc1
commit 4ec7ba9
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/packages/editor-ui/src/components/NodeCreator/NodeCreator.vue b/packages/editor-ui/src/components/NodeCreator/NodeCreator.vue
@@ -27,7 +27,6 @@ import Vue from 'vue';
 import { ICategoriesWithNodes, INodeCreateElement } from '@/Interface';
 import { INodeTypeDescription } from 'n8n-workflow';
 import SlideTransition from '../transitions/SlideTransition.vue';
-import { HIDDEN_NODES  } from '@/constants';
 
 import MainPanel from './MainPanel.vue';
 import { getCategoriesWithNodes, getCategorizedList } from './helpers';
@@ -53,7 +52,7 @@ export default Vue.extend({
 			return this.$store.getters['nodeTypes/allLatestNodeTypes'];
 		},
 		visibleNodeTypes(): INodeTypeDescription[] {
-			return this.allLatestNodeTypes.filter((nodeType) => !HIDDEN_NODES.includes(nodeType.name));
+			return this.allLatestNodeTypes.filter((nodeType) => !nodeType.hidden);
 		},
 		categoriesWithNodes(): ICategoriesWithNodes {
 			return getCategoriesWithNodes(this.visibleNodeTypes, this.personalizedNodeTypes as string[]);

diff --git a/packages/editor-ui/src/constants.ts b/packages/editor-ui/src/constants.ts
@@ -140,7 +140,6 @@ export const ALL_NODE_FILTER = 'All';
 export const UNCATEGORIZED_CATEGORY = 'Miscellaneous';
 export const UNCATEGORIZED_SUBCATEGORY = 'Helpers';
 export const PERSONALIZED_CATEGORY = 'Suggested Nodes';
-export const HIDDEN_NODES = [START_NODE_TYPE];
 
 export const REQUEST_NODE_FORM_URL = 'https://n8n-community.typeform.com/to/K1fBVTZ3';
 

diff --git a/packages/nodes-base/nodes/Start/Start.node.ts b/packages/nodes-base/nodes/Start/Start.node.ts
@@ -10,6 +10,7 @@ export class Start implements INodeType {
 		version: 1,
 		description: 'Starts the workflow execution from this node',
 		maxNodes: 1,
+		hidden: true,
 		defaults: {
 			name: 'Start',
 			color: '#00e000',

diff --git a/packages/workflow/src/Interfaces.ts b/packages/workflow/src/Interfaces.ts
@@ -1095,6 +1095,12 @@ export interface INodeTypeBaseDescription {
 	subtitle?: string;
 	defaultVersion?: number;
 	codex?: CodexData;
+
+	/**
+	 * Whether the node must not be shown in the node creator panel,
+	 * due to deprecation or as a special case (e.g. Start node)
+	 */
+	hidden?: true;
 }
 
 export interface INodePropertyRouting {