@n8n/workflow-sdk 0.8.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/build.tsbuildinfo +1 -1
- package/dist/codegen/code-generator.js +8 -8
- package/dist/codegen/code-generator.js.map +1 -1
- package/dist/codegen/subnode-generator.d.ts +4 -0
- package/dist/codegen/subnode-generator.js +23 -2
- package/dist/codegen/subnode-generator.js.map +1 -1
- package/dist/generate-types/generate-types.d.ts +1 -0
- package/dist/generate-types/generate-types.js +27 -1
- package/dist/generate-types/generate-types.js.map +1 -1
- package/dist/generate-types/generate-zod-schemas.js +1 -1
- package/dist/generate-types/generate-zod-schemas.js.map +1 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.js +6 -2
- package/dist/index.js.map +1 -1
- package/dist/prompts/best-practices/guides/chatbot.d.ts +7 -0
- package/dist/prompts/best-practices/guides/chatbot.js +120 -0
- package/dist/prompts/best-practices/guides/chatbot.js.map +1 -0
- package/dist/prompts/best-practices/guides/content-generation.d.ts +7 -0
- package/dist/prompts/best-practices/guides/content-generation.js +117 -0
- package/dist/prompts/best-practices/guides/content-generation.js.map +1 -0
- package/dist/prompts/best-practices/guides/data-analysis.d.ts +7 -0
- package/dist/prompts/best-practices/guides/data-analysis.js +369 -0
- package/dist/prompts/best-practices/guides/data-analysis.js.map +1 -0
- package/dist/prompts/best-practices/guides/data-extraction.d.ts +7 -0
- package/dist/prompts/best-practices/guides/data-extraction.js +124 -0
- package/dist/prompts/best-practices/guides/data-extraction.js.map +1 -0
- package/dist/prompts/best-practices/guides/data-persistence.d.ts +7 -0
- package/dist/prompts/best-practices/guides/data-persistence.js +199 -0
- package/dist/prompts/best-practices/guides/data-persistence.js.map +1 -0
- package/dist/prompts/best-practices/guides/data-transformation.d.ts +7 -0
- package/dist/prompts/best-practices/guides/data-transformation.js +148 -0
- package/dist/prompts/best-practices/guides/data-transformation.js.map +1 -0
- package/dist/prompts/best-practices/guides/document-processing.d.ts +7 -0
- package/dist/prompts/best-practices/guides/document-processing.js +334 -0
- package/dist/prompts/best-practices/guides/document-processing.js.map +1 -0
- package/dist/prompts/best-practices/guides/enrichment.d.ts +7 -0
- package/dist/prompts/best-practices/guides/enrichment.js +273 -0
- package/dist/prompts/best-practices/guides/enrichment.js.map +1 -0
- package/dist/prompts/best-practices/guides/form-input.d.ts +7 -0
- package/dist/prompts/best-practices/guides/form-input.js +175 -0
- package/dist/prompts/best-practices/guides/form-input.js.map +1 -0
- package/dist/prompts/best-practices/guides/human-in-the-loop.d.ts +7 -0
- package/dist/prompts/best-practices/guides/human-in-the-loop.js +270 -0
- package/dist/prompts/best-practices/guides/human-in-the-loop.js.map +1 -0
- package/dist/prompts/best-practices/guides/knowledge-base.d.ts +7 -0
- package/dist/prompts/best-practices/guides/knowledge-base.js +270 -0
- package/dist/prompts/best-practices/guides/knowledge-base.js.map +1 -0
- package/dist/prompts/best-practices/guides/monitoring.d.ts +7 -0
- package/dist/prompts/best-practices/guides/monitoring.js +173 -0
- package/dist/prompts/best-practices/guides/monitoring.js.map +1 -0
- package/dist/prompts/best-practices/guides/notification.d.ts +7 -0
- package/dist/prompts/best-practices/guides/notification.js +137 -0
- package/dist/prompts/best-practices/guides/notification.js.map +1 -0
- package/dist/prompts/best-practices/guides/scheduling.d.ts +7 -0
- package/dist/prompts/best-practices/guides/scheduling.js +154 -0
- package/dist/prompts/best-practices/guides/scheduling.js.map +1 -0
- package/dist/prompts/best-practices/guides/scraping-and-research.d.ts +7 -0
- package/dist/prompts/best-practices/guides/scraping-and-research.js +160 -0
- package/dist/prompts/best-practices/guides/scraping-and-research.js.map +1 -0
- package/dist/prompts/best-practices/guides/triage.d.ts +7 -0
- package/dist/prompts/best-practices/guides/triage.js +151 -0
- package/dist/prompts/best-practices/guides/triage.js.map +1 -0
- package/dist/prompts/best-practices/index.d.ts +20 -0
- package/dist/prompts/best-practices/index.js +69 -0
- package/dist/prompts/best-practices/index.js.map +1 -0
- package/dist/prompts/best-practices/types.d.ts +25 -0
- package/dist/prompts/best-practices/types.js +40 -0
- package/dist/prompts/best-practices/types.js.map +1 -0
- package/dist/prompts/index.d.ts +3 -0
- package/dist/prompts/index.js +25 -0
- package/dist/prompts/index.js.map +1 -0
- package/dist/prompts/node-guidance/index.d.ts +3 -0
- package/dist/prompts/node-guidance/index.js +20 -0
- package/dist/prompts/node-guidance/index.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/audio-generation.d.ts +2 -0
- package/dist/prompts/node-guidance/node-recommendations/audio-generation.js +18 -0
- package/dist/prompts/node-guidance/node-recommendations/audio-generation.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/format-recommendation.d.ts +2 -0
- package/dist/prompts/node-guidance/node-recommendations/format-recommendation.js +27 -0
- package/dist/prompts/node-guidance/node-recommendations/format-recommendation.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/image-generation.d.ts +2 -0
- package/dist/prompts/node-guidance/node-recommendations/image-generation.js +18 -0
- package/dist/prompts/node-guidance/node-recommendations/image-generation.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/index.d.ts +6 -0
- package/dist/prompts/node-guidance/node-recommendations/index.js +17 -0
- package/dist/prompts/node-guidance/node-recommendations/index.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/text-manipulation.d.ts +2 -0
- package/dist/prompts/node-guidance/node-recommendations/text-manipulation.js +27 -0
- package/dist/prompts/node-guidance/node-recommendations/text-manipulation.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/types.d.ts +26 -0
- package/dist/prompts/node-guidance/node-recommendations/types.js +16 -0
- package/dist/prompts/node-guidance/node-recommendations/types.js.map +1 -0
- package/dist/prompts/node-guidance/node-recommendations/video-generation.d.ts +2 -0
- package/dist/prompts/node-guidance/node-recommendations/video-generation.js +15 -0
- package/dist/prompts/node-guidance/node-recommendations/video-generation.js.map +1 -0
- package/dist/prompts/node-guidance/node-tips/index.d.ts +3 -0
- package/dist/prompts/node-guidance/node-tips/index.js +8 -0
- package/dist/prompts/node-guidance/node-tips/index.js.map +1 -0
- package/dist/prompts/node-guidance/node-tips/structured-output-parser.d.ts +2 -0
- package/dist/prompts/node-guidance/node-tips/structured-output-parser.js +35 -0
- package/dist/prompts/node-guidance/node-tips/structured-output-parser.js.map +1 -0
- package/dist/prompts/node-guidance/node-tips/types.d.ts +7 -0
- package/dist/prompts/node-guidance/node-tips/types.js +3 -0
- package/dist/prompts/node-guidance/node-tips/types.js.map +1 -0
- package/dist/prompts/node-guidance/node-tips/webhook.d.ts +2 -0
- package/dist/prompts/node-guidance/node-tips/webhook.js +38 -0
- package/dist/prompts/node-guidance/node-tips/webhook.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/embedding-nodes.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/embedding-nodes.js +70 -0
- package/dist/prompts/node-guidance/parameter-guides/embedding-nodes.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/gmail.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/gmail.js +53 -0
- package/dist/prompts/node-guidance/parameter-guides/gmail.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/http-request.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/http-request.js +139 -0
- package/dist/prompts/node-guidance/parameter-guides/http-request.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/if-node.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/if-node.js +159 -0
- package/dist/prompts/node-guidance/parameter-guides/if-node.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/index.d.ts +12 -0
- package/dist/prompts/node-guidance/parameter-guides/index.js +26 -0
- package/dist/prompts/node-guidance/parameter-guides/index.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/predecessor-output.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/predecessor-output.js +25 -0
- package/dist/prompts/node-guidance/parameter-guides/predecessor-output.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/resource-locator.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/resource-locator.js +40 -0
- package/dist/prompts/node-guidance/parameter-guides/resource-locator.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/set-node.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/set-node.js +94 -0
- package/dist/prompts/node-guidance/parameter-guides/set-node.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/switch-node.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/switch-node.js +75 -0
- package/dist/prompts/node-guidance/parameter-guides/switch-node.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/system-message.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/system-message.js +96 -0
- package/dist/prompts/node-guidance/parameter-guides/system-message.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/text-fields.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/text-fields.js +31 -0
- package/dist/prompts/node-guidance/parameter-guides/text-fields.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/tool-nodes.d.ts +2 -0
- package/dist/prompts/node-guidance/parameter-guides/tool-nodes.js +76 -0
- package/dist/prompts/node-guidance/parameter-guides/tool-nodes.js.map +1 -0
- package/dist/prompts/node-guidance/parameter-guides/types.d.ts +18 -0
- package/dist/prompts/node-guidance/parameter-guides/types.js +3 -0
- package/dist/prompts/node-guidance/parameter-guides/types.js.map +1 -0
- package/dist/prompts/node-selection/ai-nodes.d.ts +2 -0
- package/dist/prompts/node-selection/ai-nodes.js +35 -0
- package/dist/prompts/node-selection/ai-nodes.js.map +1 -0
- package/dist/prompts/node-selection/connection-parameters.d.ts +1 -0
- package/dist/prompts/node-selection/connection-parameters.js +13 -0
- package/dist/prompts/node-selection/connection-parameters.js.map +1 -0
- package/dist/prompts/node-selection/index.d.ts +5 -0
- package/dist/prompts/node-selection/index.js +16 -0
- package/dist/prompts/node-selection/index.js.map +1 -0
- package/dist/prompts/node-selection/native-preference.d.ts +1 -0
- package/dist/prompts/node-selection/native-preference.js +18 -0
- package/dist/prompts/node-selection/native-preference.js.map +1 -0
- package/dist/prompts/node-selection/trigger-selection.d.ts +1 -0
- package/dist/prompts/node-selection/trigger-selection.js +23 -0
- package/dist/prompts/node-selection/trigger-selection.js.map +1 -0
- package/dist/prompts/node-selection/use-case-patterns.d.ts +2 -0
- package/dist/prompts/node-selection/use-case-patterns.js +58 -0
- package/dist/prompts/node-selection/use-case-patterns.js.map +1 -0
- package/dist/prompts/sdk-reference/additional-functions.d.ts +1 -0
- package/dist/prompts/sdk-reference/additional-functions.js +20 -0
- package/dist/prompts/sdk-reference/additional-functions.js.map +1 -0
- package/dist/prompts/sdk-reference/expressions.d.ts +1 -0
- package/dist/prompts/sdk-reference/expressions.js +34 -0
- package/dist/prompts/sdk-reference/expressions.js.map +1 -0
- package/dist/prompts/sdk-reference/index.d.ts +5 -0
- package/dist/prompts/sdk-reference/index.js +14 -0
- package/dist/prompts/sdk-reference/index.js.map +1 -0
- package/dist/prompts/sdk-reference/workflow-patterns-detailed.d.ts +1 -0
- package/dist/prompts/sdk-reference/workflow-patterns-detailed.js +398 -0
- package/dist/prompts/sdk-reference/workflow-patterns-detailed.js.map +1 -0
- package/dist/prompts/sdk-reference/workflow-patterns.d.ts +2 -0
- package/dist/prompts/sdk-reference/workflow-patterns.js +479 -0
- package/dist/prompts/sdk-reference/workflow-patterns.js.map +1 -0
- package/dist/prompts/sdk-reference/workflow-rules.d.ts +1 -0
- package/dist/prompts/sdk-reference/workflow-rules.js +23 -0
- package/dist/prompts/sdk-reference/workflow-rules.js.map +1 -0
- package/dist/types/base.d.ts +8 -2
- package/dist/types/base.js.map +1 -1
- package/dist/workflow-builder/constants.d.ts +13 -0
- package/dist/workflow-builder/constants.js +17 -1
- package/dist/workflow-builder/constants.js.map +1 -1
- package/dist/workflow-builder/layout-utils.d.ts +7 -1
- package/dist/workflow-builder/layout-utils.js +452 -0
- package/dist/workflow-builder/layout-utils.js.map +1 -1
- package/dist/workflow-builder/node-builders/node-builder.d.ts +1 -1
- package/dist/workflow-builder/node-builders/node-builder.js +7 -3
- package/dist/workflow-builder/node-builders/node-builder.js.map +1 -1
- package/dist/workflow-builder/plugins/defaults.js +1 -0
- package/dist/workflow-builder/plugins/defaults.js.map +1 -1
- package/dist/workflow-builder/plugins/serializers/json-serializer.js +12 -1
- package/dist/workflow-builder/plugins/serializers/json-serializer.js.map +1 -1
- package/dist/workflow-builder/plugins/types.d.ts +1 -0
- package/dist/workflow-builder/plugins/validators/expression-prefix-validator.js +3 -0
- package/dist/workflow-builder/plugins/validators/expression-prefix-validator.js.map +1 -1
- package/dist/workflow-builder/plugins/validators/filter-node-validator.d.ts +2 -0
- package/dist/workflow-builder/plugins/validators/filter-node-validator.js +90 -0
- package/dist/workflow-builder/plugins/validators/filter-node-validator.js.map +1 -0
- package/dist/workflow-builder/plugins/validators/index.d.ts +1 -0
- package/dist/workflow-builder/plugins/validators/index.js +3 -1
- package/dist/workflow-builder/plugins/validators/index.js.map +1 -1
- package/dist/workflow-builder/workflow-import.js +1 -0
- package/dist/workflow-builder/workflow-import.js.map +1 -1
- package/dist/workflow-builder.js +2 -1
- package/dist/workflow-builder.js.map +1 -1
- package/package.json +52 -5
|
@@ -0,0 +1,479 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WORKFLOW_PATTERNS_CONCISE = exports.WORKFLOW_SDK_PATTERNS = void 0;
|
|
4
|
+
const SDK_IMPORT = "import { workflow, node, trigger, sticky, placeholder, newCredential, ifElse, switchCase, merge, splitInBatches, nextBatch, languageModel, memory, tool, outputParser, embedding, embeddings, vectorStore, retriever, documentLoader, textSplitter, fromAi, expr } from '@n8n/workflow-sdk';";
|
|
5
|
+
exports.WORKFLOW_SDK_PATTERNS = `<linear_chain>
|
|
6
|
+
\`\`\`javascript
|
|
7
|
+
${SDK_IMPORT}
|
|
8
|
+
|
|
9
|
+
// 1. Define all nodes first
|
|
10
|
+
const startTrigger = trigger({
|
|
11
|
+
type: 'n8n-nodes-base.manualTrigger',
|
|
12
|
+
version: 1,
|
|
13
|
+
config: { name: 'Start' }
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
const fetchData = node({
|
|
17
|
+
type: 'n8n-nodes-base.httpRequest',
|
|
18
|
+
version: 4.3,
|
|
19
|
+
config: { name: 'Fetch Data', parameters: { method: 'GET', url: '...' } }
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
const processData = node({
|
|
23
|
+
type: 'n8n-nodes-base.set',
|
|
24
|
+
version: 3.4,
|
|
25
|
+
config: { name: 'Process Data', parameters: {} }
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
// 2. Compose workflow
|
|
29
|
+
export default workflow('id', 'name')
|
|
30
|
+
.add(startTrigger)
|
|
31
|
+
.to(fetchData)
|
|
32
|
+
.to(processData);
|
|
33
|
+
\`\`\`
|
|
34
|
+
|
|
35
|
+
</linear_chain>
|
|
36
|
+
|
|
37
|
+
<independent_sources>
|
|
38
|
+
When nodes return more than 1 item, chaining causes item multiplication: if Source A returns N items, a chained Source B runs N times instead of once.
|
|
39
|
+
|
|
40
|
+
**When to use \`executeOnce: true\`:**
|
|
41
|
+
- A node fetches data independently but is chained after another data source (prevents N×M multiplication)
|
|
42
|
+
- A node should summarize/aggregate all upstream items in a single call (e.g., AI summary, send one notification)
|
|
43
|
+
- A node calls an API that doesn't vary per input item
|
|
44
|
+
|
|
45
|
+
Fix with \`executeOnce: true\` (simplest) or parallel branches + Merge (when combining results):
|
|
46
|
+
|
|
47
|
+
\`\`\`javascript
|
|
48
|
+
// sourceA outputs 10 items. sourceB outputs 10 items.
|
|
49
|
+
// WRONG - processResults runs 100 times
|
|
50
|
+
// startTrigger.to(sourceA.to(sourceB.to(processResults)))
|
|
51
|
+
|
|
52
|
+
// FIX 1 - executeOnce: sourceB runs once regardless of input items
|
|
53
|
+
const sourceB = node({ ..., config: { ..., executeOnce: true } });
|
|
54
|
+
startTrigger.to(sourceA.to(sourceB.to(processResults)));
|
|
55
|
+
|
|
56
|
+
// FIX 2 - parallel branches + Merge (combine by position)
|
|
57
|
+
const combineResults = merge({
|
|
58
|
+
version: 3.2,
|
|
59
|
+
config: { name: 'Combine Results', parameters: { mode: 'combine', combineBy: 'combineByPosition' } }
|
|
60
|
+
});
|
|
61
|
+
export default workflow('id', 'name')
|
|
62
|
+
.add(startTrigger)
|
|
63
|
+
.to(sourceA.to(combineResults.input(0)))
|
|
64
|
+
.add(startTrigger)
|
|
65
|
+
.to(sourceB.to(combineResults.input(1)))
|
|
66
|
+
.add(combineResults)
|
|
67
|
+
.to(processResults);
|
|
68
|
+
|
|
69
|
+
// FIX 3 - parallel branches + Merge (append)
|
|
70
|
+
const allResults = merge({
|
|
71
|
+
version: 3.2,
|
|
72
|
+
config: { name: 'All Results', parameters: { mode: 'append' } }
|
|
73
|
+
});
|
|
74
|
+
export default workflow('id', 'name')
|
|
75
|
+
.add(startTrigger)
|
|
76
|
+
.to(sourceA.to(allResults.input(0)))
|
|
77
|
+
.add(startTrigger)
|
|
78
|
+
.to(sourceB.to(allResults.input(1)))
|
|
79
|
+
.add(allResults)
|
|
80
|
+
.to(processResults);
|
|
81
|
+
\`\`\`
|
|
82
|
+
|
|
83
|
+
</independent_sources>
|
|
84
|
+
|
|
85
|
+
<zero_item_safety>
|
|
86
|
+
Nodes that fetch or filter data may return 0 items, which stops the entire downstream chain.
|
|
87
|
+
Use \`alwaysOutputData: true\` on data-fetching nodes to ensure the chain continues with an empty item \`{json: {}}\`.
|
|
88
|
+
|
|
89
|
+
\`\`\`javascript
|
|
90
|
+
// Data Table might be empty (fresh table, no matching rows)
|
|
91
|
+
const getReflections = node({
|
|
92
|
+
type: 'n8n-nodes-base.dataTable',
|
|
93
|
+
version: 1.1,
|
|
94
|
+
config: {
|
|
95
|
+
name: 'Get Reflections',
|
|
96
|
+
alwaysOutputData: true, // Chain continues even if table is empty
|
|
97
|
+
parameters: { resource: 'row', operation: 'get', returnAll: true }
|
|
98
|
+
}
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
// Downstream Code node handles the empty case
|
|
102
|
+
const processData = node({
|
|
103
|
+
type: 'n8n-nodes-base.code',
|
|
104
|
+
version: 2,
|
|
105
|
+
config: {
|
|
106
|
+
name: 'Process Data',
|
|
107
|
+
parameters: {
|
|
108
|
+
mode: 'runOnceForAllItems',
|
|
109
|
+
jsCode: \\\`
|
|
110
|
+
const items = $input.all();
|
|
111
|
+
// items will be [{json: {}}] if upstream had no data
|
|
112
|
+
const hasData = items.length > 0 && Object.keys(items[0].json).length > 0;
|
|
113
|
+
// ... handle both cases
|
|
114
|
+
\\\`.trim()
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
});
|
|
118
|
+
\`\`\`
|
|
119
|
+
|
|
120
|
+
**When to use \`alwaysOutputData: true\`:**
|
|
121
|
+
- Data Table with \`operation: 'get'\` (table may be empty or freshly created)
|
|
122
|
+
- Any lookup/search/filter node whose result feeds into downstream processing
|
|
123
|
+
- HTTP Request that may return an empty array
|
|
124
|
+
|
|
125
|
+
**When NOT to use it:**
|
|
126
|
+
- Trigger nodes (they always produce output)
|
|
127
|
+
- Code nodes (handle empty input in your code logic instead)
|
|
128
|
+
- Nodes at the end of the chain (no downstream to protect)
|
|
129
|
+
|
|
130
|
+
</zero_item_safety>
|
|
131
|
+
|
|
132
|
+
<conditional_branching>
|
|
133
|
+
|
|
134
|
+
**CRITICAL:** Each branch defines a COMPLETE processing path. Chain multiple steps INSIDE the branch using .to().
|
|
135
|
+
|
|
136
|
+
Every IF/Filter \`conditions\` parameter MUST include \`options\`, \`conditions\`, and \`combinator\`:
|
|
137
|
+
\`\`\`javascript
|
|
138
|
+
const checkValid = ifElse({
|
|
139
|
+
version: 2.2,
|
|
140
|
+
config: {
|
|
141
|
+
name: 'Check Valid',
|
|
142
|
+
parameters: {
|
|
143
|
+
conditions: {
|
|
144
|
+
options: { caseSensitive: true, leftValue: '', typeValidation: 'strict' },
|
|
145
|
+
conditions: [{ leftValue: '={{ $json.status }}', operator: { type: 'string', operation: 'equals' }, rightValue: 'active' }],
|
|
146
|
+
combinator: 'and'
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
export default workflow('id', 'name')
|
|
153
|
+
.add(startTrigger)
|
|
154
|
+
.to(checkValid
|
|
155
|
+
.onTrue(formatData.to(enrichData.to(saveToDb))) // Chain 3 nodes on true branch
|
|
156
|
+
.onFalse(logError));
|
|
157
|
+
\`\`\`
|
|
158
|
+
|
|
159
|
+
</conditional_branching>
|
|
160
|
+
|
|
161
|
+
<multi_way_routing>
|
|
162
|
+
|
|
163
|
+
Switch rules use \`rules.values\` (NOT \`rules.rules\`). Each rule needs \`outputKey\` and a complete \`conditions\` object:
|
|
164
|
+
\`\`\`javascript
|
|
165
|
+
const routeByPriority = switchCase({
|
|
166
|
+
version: 3.2,
|
|
167
|
+
config: {
|
|
168
|
+
name: 'Route by Priority',
|
|
169
|
+
parameters: {
|
|
170
|
+
rules: {
|
|
171
|
+
values: [
|
|
172
|
+
{ outputKey: 'urgent', conditions: { options: { caseSensitive: true, leftValue: '', typeValidation: 'strict' }, conditions: [{ leftValue: '={{ $json.priority }}', operator: { type: 'string', operation: 'equals' }, rightValue: 'urgent' }], combinator: 'and' } },
|
|
173
|
+
{ outputKey: 'normal', conditions: { options: { caseSensitive: true, leftValue: '', typeValidation: 'strict' }, conditions: [{ leftValue: '={{ $json.priority }}', operator: { type: 'string', operation: 'equals' }, rightValue: 'normal' }], combinator: 'and' } },
|
|
174
|
+
]
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
export default workflow('id', 'name')
|
|
181
|
+
.add(startTrigger)
|
|
182
|
+
.to(routeByPriority
|
|
183
|
+
.onCase('urgent', processUrgent.to(notifyTeam.to(escalate)))
|
|
184
|
+
.onCase('normal', processNormal)
|
|
185
|
+
.onDefault(archive));
|
|
186
|
+
\`\`\`
|
|
187
|
+
|
|
188
|
+
</multi_way_routing>
|
|
189
|
+
|
|
190
|
+
<parallel_execution>
|
|
191
|
+
\`\`\`javascript
|
|
192
|
+
// First declare the Merge node using merge()
|
|
193
|
+
const combineResults = merge({
|
|
194
|
+
version: 3.2,
|
|
195
|
+
config: { name: 'Combine Results', parameters: { mode: 'combine' } }
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
// Declare branch nodes
|
|
199
|
+
const branch1 = node({ type: 'n8n-nodes-base.httpRequest', ... });
|
|
200
|
+
const branch2 = node({ type: 'n8n-nodes-base.httpRequest', ... });
|
|
201
|
+
const processResults = node({ type: 'n8n-nodes-base.set', ... });
|
|
202
|
+
|
|
203
|
+
// Connect branches to specific merge inputs using .input(n)
|
|
204
|
+
export default workflow('id', 'name')
|
|
205
|
+
.add(trigger({ ... }))
|
|
206
|
+
.to(branch1.to(combineResults.input(0))) // Connect to input 0
|
|
207
|
+
.add(trigger({ ... }))
|
|
208
|
+
.to(branch2.to(combineResults.input(1))) // Connect to input 1
|
|
209
|
+
.add(combineResults)
|
|
210
|
+
.to(processResults); // Process merged results
|
|
211
|
+
\`\`\`
|
|
212
|
+
|
|
213
|
+
</parallel_execution>
|
|
214
|
+
|
|
215
|
+
<batch_processing>
|
|
216
|
+
\`\`\`javascript
|
|
217
|
+
const startTrigger = trigger({
|
|
218
|
+
type: 'n8n-nodes-base.manualTrigger',
|
|
219
|
+
version: 1,
|
|
220
|
+
config: { name: 'Start' }
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
const fetchRecords = node({
|
|
224
|
+
type: 'n8n-nodes-base.httpRequest',
|
|
225
|
+
version: 4.3,
|
|
226
|
+
config: { name: 'Fetch Records', parameters: { method: 'GET', url: '...' } }
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
const finalizeResults = node({
|
|
230
|
+
type: 'n8n-nodes-base.set',
|
|
231
|
+
version: 3.4,
|
|
232
|
+
config: { name: 'Finalize', parameters: {} }
|
|
233
|
+
});
|
|
234
|
+
|
|
235
|
+
const processRecord = node({
|
|
236
|
+
type: 'n8n-nodes-base.httpRequest',
|
|
237
|
+
version: 4.3,
|
|
238
|
+
config: { name: 'Process Record', parameters: { method: 'POST', url: '...' } }
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
const sibNode = splitInBatches({ version: 3, config: { name: 'Batch Process', parameters: { batchSize: 10 } } });
|
|
242
|
+
|
|
243
|
+
export default workflow('id', 'name')
|
|
244
|
+
.add(startTrigger)
|
|
245
|
+
.to(fetchRecords)
|
|
246
|
+
.to(sibNode
|
|
247
|
+
.onDone(finalizeResults)
|
|
248
|
+
.onEachBatch(processRecord.to(nextBatch(sibNode)))
|
|
249
|
+
);
|
|
250
|
+
\`\`\`
|
|
251
|
+
|
|
252
|
+
</batch_processing>
|
|
253
|
+
|
|
254
|
+
<multiple_triggers>
|
|
255
|
+
\`\`\`javascript
|
|
256
|
+
const webhookTrigger = trigger({
|
|
257
|
+
type: 'n8n-nodes-base.webhook',
|
|
258
|
+
version: 2.1,
|
|
259
|
+
config: { name: 'Webhook' }
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
const processWebhook = node({
|
|
263
|
+
type: 'n8n-nodes-base.set',
|
|
264
|
+
version: 3.4,
|
|
265
|
+
config: { name: 'Process Webhook', parameters: {} }
|
|
266
|
+
});
|
|
267
|
+
|
|
268
|
+
const scheduleTrigger = trigger({
|
|
269
|
+
type: 'n8n-nodes-base.scheduleTrigger',
|
|
270
|
+
version: 1.3,
|
|
271
|
+
config: { name: 'Daily Schedule', parameters: {} }
|
|
272
|
+
});
|
|
273
|
+
|
|
274
|
+
const processSchedule = node({
|
|
275
|
+
type: 'n8n-nodes-base.set',
|
|
276
|
+
version: 3.4,
|
|
277
|
+
config: { name: 'Process Schedule', parameters: {} }
|
|
278
|
+
});
|
|
279
|
+
|
|
280
|
+
export default workflow('id', 'name')
|
|
281
|
+
.add(webhookTrigger)
|
|
282
|
+
.to(processWebhook)
|
|
283
|
+
.add(scheduleTrigger)
|
|
284
|
+
.to(processSchedule);
|
|
285
|
+
\`\`\`
|
|
286
|
+
|
|
287
|
+
</multiple_triggers>
|
|
288
|
+
|
|
289
|
+
<fan_in>
|
|
290
|
+
\`\`\`javascript
|
|
291
|
+
// Each trigger's execution runs in COMPLETE ISOLATION.
|
|
292
|
+
// Different branches have no effect on each other.
|
|
293
|
+
// Never duplicate chains for "isolation" - it's already guaranteed.
|
|
294
|
+
|
|
295
|
+
const webhookTrigger = trigger({
|
|
296
|
+
type: 'n8n-nodes-base.webhook',
|
|
297
|
+
version: 2.1,
|
|
298
|
+
config: { name: 'Webhook Trigger' }
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
const scheduleTrigger = trigger({
|
|
302
|
+
type: 'n8n-nodes-base.scheduleTrigger',
|
|
303
|
+
version: 1.3,
|
|
304
|
+
config: { name: 'Daily Schedule' }
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
const processData = node({
|
|
308
|
+
type: 'n8n-nodes-base.set',
|
|
309
|
+
version: 3.4,
|
|
310
|
+
config: { name: 'Process Data', parameters: {} }
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
const sendNotification = node({
|
|
314
|
+
type: 'n8n-nodes-base.slack',
|
|
315
|
+
version: 2.3,
|
|
316
|
+
config: { name: 'Notify Slack', parameters: {} }
|
|
317
|
+
});
|
|
318
|
+
|
|
319
|
+
export default workflow('id', 'name')
|
|
320
|
+
.add(webhookTrigger)
|
|
321
|
+
.to(processData)
|
|
322
|
+
.to(sendNotification)
|
|
323
|
+
.add(scheduleTrigger)
|
|
324
|
+
.to(processData);
|
|
325
|
+
\`\`\`
|
|
326
|
+
|
|
327
|
+
</fan_in>
|
|
328
|
+
|
|
329
|
+
<ai_agent_basic>
|
|
330
|
+
\`\`\`javascript
|
|
331
|
+
const openAiModel = languageModel({
|
|
332
|
+
type: '@n8n/n8n-nodes-langchain.lmChatOpenAi',
|
|
333
|
+
version: 1.3,
|
|
334
|
+
config: { name: 'OpenAI Model', parameters: {} }
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
const startTrigger = trigger({
|
|
338
|
+
type: 'n8n-nodes-base.manualTrigger',
|
|
339
|
+
version: 1,
|
|
340
|
+
config: { name: 'Start' }
|
|
341
|
+
});
|
|
342
|
+
|
|
343
|
+
const aiAgent = node({
|
|
344
|
+
type: '@n8n/n8n-nodes-langchain.agent',
|
|
345
|
+
version: 3.1,
|
|
346
|
+
config: {
|
|
347
|
+
name: 'AI Assistant',
|
|
348
|
+
parameters: { promptType: 'define', text: 'You are a helpful assistant' },
|
|
349
|
+
subnodes: { model: openAiModel }
|
|
350
|
+
}
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
export default workflow('ai-assistant', 'AI Assistant')
|
|
354
|
+
.add(startTrigger)
|
|
355
|
+
.to(aiAgent);
|
|
356
|
+
\`\`\`
|
|
357
|
+
|
|
358
|
+
</ai_agent_basic>
|
|
359
|
+
|
|
360
|
+
<ai_agent_with_tools>
|
|
361
|
+
\`\`\`javascript
|
|
362
|
+
const openAiModel = languageModel({
|
|
363
|
+
type: '@n8n/n8n-nodes-langchain.lmChatOpenAi',
|
|
364
|
+
version: 1.3,
|
|
365
|
+
config: {
|
|
366
|
+
name: 'OpenAI Model',
|
|
367
|
+
parameters: {},
|
|
368
|
+
credentials: { openAiApi: newCredential('OpenAI') }
|
|
369
|
+
}
|
|
370
|
+
});
|
|
371
|
+
|
|
372
|
+
const calculatorTool = tool({
|
|
373
|
+
type: '@n8n/n8n-nodes-langchain.toolCalculator',
|
|
374
|
+
version: 1,
|
|
375
|
+
config: { name: 'Calculator', parameters: {} }
|
|
376
|
+
});
|
|
377
|
+
|
|
378
|
+
const startTrigger = trigger({
|
|
379
|
+
type: 'n8n-nodes-base.manualTrigger',
|
|
380
|
+
version: 1,
|
|
381
|
+
config: { name: 'Start' }
|
|
382
|
+
});
|
|
383
|
+
|
|
384
|
+
const aiAgent = node({
|
|
385
|
+
type: '@n8n/n8n-nodes-langchain.agent',
|
|
386
|
+
version: 3.1,
|
|
387
|
+
config: {
|
|
388
|
+
name: 'Math Agent',
|
|
389
|
+
parameters: { promptType: 'define', text: 'You can use tools to help users' },
|
|
390
|
+
subnodes: { model: openAiModel, tools: [calculatorTool] }
|
|
391
|
+
}
|
|
392
|
+
});
|
|
393
|
+
|
|
394
|
+
export default workflow('ai-calculator', 'AI Calculator')
|
|
395
|
+
.add(startTrigger)
|
|
396
|
+
.to(aiAgent);
|
|
397
|
+
\`\`\`
|
|
398
|
+
|
|
399
|
+
</ai_agent_with_tools>
|
|
400
|
+
|
|
401
|
+
<ai_agent_with_from_ai>
|
|
402
|
+
\`\`\`javascript
|
|
403
|
+
const openAiModel = languageModel({
|
|
404
|
+
type: '@n8n/n8n-nodes-langchain.lmChatOpenAi',
|
|
405
|
+
version: 1.3,
|
|
406
|
+
config: {
|
|
407
|
+
name: 'OpenAI Model',
|
|
408
|
+
parameters: {},
|
|
409
|
+
credentials: { openAiApi: newCredential('OpenAI') }
|
|
410
|
+
}
|
|
411
|
+
});
|
|
412
|
+
|
|
413
|
+
const gmailTool = tool({
|
|
414
|
+
type: 'n8n-nodes-base.gmailTool',
|
|
415
|
+
version: 1,
|
|
416
|
+
config: {
|
|
417
|
+
name: 'Gmail Tool',
|
|
418
|
+
parameters: {
|
|
419
|
+
sendTo: fromAi('recipient', 'Email address'),
|
|
420
|
+
subject: fromAi('subject', 'Email subject'),
|
|
421
|
+
message: fromAi('body', 'Email content')
|
|
422
|
+
},
|
|
423
|
+
credentials: { gmailOAuth2: newCredential('Gmail') }
|
|
424
|
+
}
|
|
425
|
+
});
|
|
426
|
+
|
|
427
|
+
const startTrigger = trigger({
|
|
428
|
+
type: 'n8n-nodes-base.manualTrigger',
|
|
429
|
+
version: 1,
|
|
430
|
+
config: { name: 'Start' }
|
|
431
|
+
});
|
|
432
|
+
|
|
433
|
+
const aiAgent = node({
|
|
434
|
+
type: '@n8n/n8n-nodes-langchain.agent',
|
|
435
|
+
version: 3.1,
|
|
436
|
+
config: {
|
|
437
|
+
name: 'Email Agent',
|
|
438
|
+
parameters: { promptType: 'define', text: 'You can send emails' },
|
|
439
|
+
subnodes: { model: openAiModel, tools: [gmailTool] }
|
|
440
|
+
}
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
export default workflow('ai-email', 'AI Email Sender')
|
|
444
|
+
.add(startTrigger)
|
|
445
|
+
.to(aiAgent);
|
|
446
|
+
\`\`\`
|
|
447
|
+
</ai_agent_with_from_ai>
|
|
448
|
+
|
|
449
|
+
<ai_agent_with_structured_output>
|
|
450
|
+
\`\`\`javascript
|
|
451
|
+
const structuredParser = outputParser({
|
|
452
|
+
type: '@n8n/n8n-nodes-langchain.outputParserStructured',
|
|
453
|
+
version: 1.3,
|
|
454
|
+
config: {
|
|
455
|
+
name: 'Structured Output Parser',
|
|
456
|
+
parameters: {
|
|
457
|
+
schemaType: 'fromJson',
|
|
458
|
+
jsonSchemaExample: '{ "sentiment": "positive", "confidence": 0.95, "summary": "brief summary" }'
|
|
459
|
+
}
|
|
460
|
+
}
|
|
461
|
+
});
|
|
462
|
+
|
|
463
|
+
const aiAgent = node({
|
|
464
|
+
type: '@n8n/n8n-nodes-langchain.agent',
|
|
465
|
+
version: 3.1,
|
|
466
|
+
config: {
|
|
467
|
+
name: 'Sentiment Analyzer',
|
|
468
|
+
parameters: { promptType: 'define', text: 'Analyze the sentiment of the input text', hasOutputParser: true },
|
|
469
|
+
subnodes: { model: openAiModel, outputParser: structuredParser }
|
|
470
|
+
}
|
|
471
|
+
});
|
|
472
|
+
|
|
473
|
+
export default workflow('ai-sentiment', 'AI Sentiment Analyzer')
|
|
474
|
+
.add(startTrigger)
|
|
475
|
+
.to(aiAgent);
|
|
476
|
+
\`\`\`
|
|
477
|
+
</ai_agent_with_structured_output>`;
|
|
478
|
+
exports.WORKFLOW_PATTERNS_CONCISE = exports.WORKFLOW_SDK_PATTERNS;
|
|
479
|
+
//# sourceMappingURL=workflow-patterns.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow-patterns.js","sourceRoot":"","sources":["../../../src/prompts/sdk-reference/workflow-patterns.ts"],"names":[],"mappings":";;;AAUA,MAAM,UAAU,GACf,8RAA8R,CAAC;AAMnR,QAAA,qBAAqB,GAAG;;EAEnC,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mCAsduB,CAAC;AAEF,oCA1drB,6BAAqB,CA0dyB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const WORKFLOW_RULES = "Follow these rules strictly when generating workflows:\n\n1. **Always use newCredential() for authentication**\n - When a node needs credentials, always use `newCredential('Name')` in the credentials config\n - NEVER use placeholder strings, fake API keys, or hardcoded auth values\n - Example: `credentials: { slackApi: newCredential('Slack Bot') }`\n - The credential type must match what the node expects\n\n2. **Handle empty outputs with `alwaysOutputData: true`**\n - Nodes that query data (Data Table get, Google Sheets lookup, HTTP Request, etc.) may return 0 items\n - When a node returns 0 items, all downstream nodes are SKIPPED \u2014 the workflow chain breaks silently\n - Set `alwaysOutputData: true` on any node whose output feeds downstream nodes and might return empty results\n - Common cases: fresh/empty Data Tables, filtered queries, conditional lookups, API searches with no matches\n - Example: `config: { ..., alwaysOutputData: true }`\n\n3. **Use `executeOnce: true` for single-execution nodes**\n - When a node receives N items but should only execute once (not N times), set `executeOnce: true`\n - Common cases: sending a summary notification, generating a report, calling an API that doesn't need per-item execution\n - Example: `config: { ..., executeOnce: true }`";
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WORKFLOW_RULES = void 0;
|
|
4
|
+
exports.WORKFLOW_RULES = `Follow these rules strictly when generating workflows:
|
|
5
|
+
|
|
6
|
+
1. **Always use newCredential() for authentication**
|
|
7
|
+
- When a node needs credentials, always use \`newCredential('Name')\` in the credentials config
|
|
8
|
+
- NEVER use placeholder strings, fake API keys, or hardcoded auth values
|
|
9
|
+
- Example: \`credentials: { slackApi: newCredential('Slack Bot') }\`
|
|
10
|
+
- The credential type must match what the node expects
|
|
11
|
+
|
|
12
|
+
2. **Handle empty outputs with \`alwaysOutputData: true\`**
|
|
13
|
+
- Nodes that query data (Data Table get, Google Sheets lookup, HTTP Request, etc.) may return 0 items
|
|
14
|
+
- When a node returns 0 items, all downstream nodes are SKIPPED — the workflow chain breaks silently
|
|
15
|
+
- Set \`alwaysOutputData: true\` on any node whose output feeds downstream nodes and might return empty results
|
|
16
|
+
- Common cases: fresh/empty Data Tables, filtered queries, conditional lookups, API searches with no matches
|
|
17
|
+
- Example: \`config: { ..., alwaysOutputData: true }\`
|
|
18
|
+
|
|
19
|
+
3. **Use \`executeOnce: true\` for single-execution nodes**
|
|
20
|
+
- When a node receives N items but should only execute once (not N times), set \`executeOnce: true\`
|
|
21
|
+
- Common cases: sending a summary notification, generating a report, calling an API that doesn't need per-item execution
|
|
22
|
+
- Example: \`config: { ..., executeOnce: true }\``;
|
|
23
|
+
//# sourceMappingURL=workflow-rules.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow-rules.js","sourceRoot":"","sources":["../../../src/prompts/sdk-reference/workflow-rules.ts"],"names":[],"mappings":";;;AAQa,QAAA,cAAc,GAAG;;;;;;;;;;;;;;;;;;qDAkBuB,CAAC"}
|
package/dist/types/base.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ export interface CredentialReference {
|
|
|
24
24
|
export interface NewCredentialValue {
|
|
25
25
|
readonly __newCredential: true;
|
|
26
26
|
readonly name: string;
|
|
27
|
+
readonly id?: string;
|
|
27
28
|
}
|
|
28
29
|
export interface PlaceholderValue {
|
|
29
30
|
readonly __placeholder: true;
|
|
@@ -69,6 +70,7 @@ export interface NodeJSON {
|
|
|
69
70
|
id?: string;
|
|
70
71
|
name: string;
|
|
71
72
|
}>;
|
|
73
|
+
webhookId?: string;
|
|
72
74
|
disabled?: boolean;
|
|
73
75
|
notes?: string;
|
|
74
76
|
notesInFlow?: boolean;
|
|
@@ -130,6 +132,7 @@ export interface NodeConfig<TParams = IDataObject> {
|
|
|
130
132
|
credentials?: Record<string, CredentialReference | NewCredentialValue>;
|
|
131
133
|
name?: string;
|
|
132
134
|
position?: [number, number];
|
|
135
|
+
webhookId?: string;
|
|
133
136
|
disabled?: boolean;
|
|
134
137
|
notes?: string;
|
|
135
138
|
notesInFlow?: boolean;
|
|
@@ -262,6 +265,9 @@ export interface SplitInBatchesBuilder<TOutput = unknown> {
|
|
|
262
265
|
export interface GeneratePinDataOptions {
|
|
263
266
|
beforeWorkflow?: WorkflowJSON;
|
|
264
267
|
}
|
|
268
|
+
export interface ToJSONOptions {
|
|
269
|
+
tidyUp?: boolean;
|
|
270
|
+
}
|
|
265
271
|
export interface WorkflowBuilder {
|
|
266
272
|
readonly id: string;
|
|
267
273
|
readonly name: string;
|
|
@@ -278,7 +284,7 @@ export interface WorkflowBuilder {
|
|
|
278
284
|
connect(source: NodeInstance<string, string, unknown>, sourceOutput: number, target: NodeInstance<string, string, unknown>, targetInput: number): WorkflowBuilder;
|
|
279
285
|
getNode(name: string): NodeInstance<string, string, unknown> | undefined;
|
|
280
286
|
validate(options?: ValidationOptions): ValidationResult;
|
|
281
|
-
toJSON(): WorkflowJSON;
|
|
287
|
+
toJSON(options?: ToJSONOptions): WorkflowJSON;
|
|
282
288
|
toFormat<T>(format: string): T;
|
|
283
289
|
toString(): string;
|
|
284
290
|
generatePinData(options?: GeneratePinDataOptions): WorkflowBuilder;
|
|
@@ -309,7 +315,7 @@ export type NodeFn = <TNode extends NodeInput>(input: TNode) => NodeInstance<TNo
|
|
|
309
315
|
export type TriggerFn = <TTrigger extends TriggerInput>(input: TTrigger) => TriggerInstance<TTrigger['type'], `${TTrigger['version']}`, unknown>;
|
|
310
316
|
export type StickyFn = (content: string, nodes?: Array<NodeInstance<string, string, unknown>>, config?: StickyNoteConfig) => NodeInstance<'n8n-nodes-base.stickyNote', 'v1', void>;
|
|
311
317
|
export type PlaceholderFn = (hint: string) => PlaceholderValue;
|
|
312
|
-
export type NewCredentialFn = (name: string) => NewCredentialValue;
|
|
318
|
+
export type NewCredentialFn = (name: string, id?: string) => NewCredentialValue;
|
|
313
319
|
export type IfElseFn = (branches: [
|
|
314
320
|
NodeInstance<string, string, unknown> | null,
|
|
315
321
|
NodeInstance<string, string, unknown> | null
|
package/dist/types/base.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":";;AAoKA,oDAqCC;AAUD,gDAQC;AAoUD,kCAWC;AAKD,wCAQC;AAnZD,SAAgB,oBAAoB,CAAC,WAAyB;IAC7D,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QACpD,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;gBAAE,SAAS;YACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAY,CAAC;gBACnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;oBAAE,SAAS;gBAEnC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;oBACxE,OAAO,CAAC,CAAC,CAAC,GAAG;wBACZ;4BACC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;4BACb,IAAI,EAAG,IAAI,CAAC,CAAC,CAAY,IAAI,MAAM;4BACnC,KAAK,EAAG,IAAI,CAAC,CAAC,CAAY,IAAI,CAAC;yBAC/B;qBACD,CAAC;gBACH,CAAC;YACF,CAAC;YACD,SAAS,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC;QAC/B,CAAC;IACF,CAAC;IAID,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QACpD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;gBAAE,SAAS;YACtC,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC5B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;oBAAE,SAAS;gBACnC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;oBACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;wBAC3E,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;oBAChB,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;AACF,CAAC;AAUD,SAAgB,kBAAkB,CAAC,QAAgB,EAAE,MAAiC;IACrF,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,UAAU,GAAG,GAAG,QAAQ,IAAI,OAAO,EAAE,CAAC;IAC1C,OAAO,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;QACV,UAAU,GAAG,GAAG,QAAQ,IAAI,OAAO,EAAE,CAAC;IACvC,CAAC;IACD,OAAO,UAAU,CAAC;AACnB,CAAC;AAoUD,SAAgB,WAAW,CAC1B,KAAc;IAKd,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,IAAI,CAAC,CAAC,UAAU,IAAI,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEzC,MAAM,YAAY,GAAI,KAAiC,CAAC,QAAQ,CAAC;IACjE,OAAO,YAAY,KAAK,IAAI,CAAC;AAC9B,CAAC;AAKD,SAAgB,cAAc,CAAC,KAAc;IAC5C,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;QACpF,OAAO,KAAK,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAI,KAAiC,CAAC,EAAE,CAAC;IACrD,OAAO,OAAO,MAAM,KAAK,UAAU,CAAC;AACrC,CAAC"}
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
export declare const GRID_SIZE = 16;
|
|
2
|
+
export declare const DEFAULT_NODE_SIZE: [number, number];
|
|
3
|
+
export declare const CONFIGURATION_NODE_RADIUS: number;
|
|
4
|
+
export declare const CONFIGURATION_NODE_SIZE: [number, number];
|
|
5
|
+
export declare const CONFIGURABLE_NODE_SIZE: [number, number];
|
|
6
|
+
export declare const NODE_MIN_INPUT_ITEMS_COUNT = 4;
|
|
7
|
+
export declare const NODE_X_SPACING: number;
|
|
8
|
+
export declare const NODE_Y_SPACING: number;
|
|
9
|
+
export declare const SUBGRAPH_SPACING: number;
|
|
10
|
+
export declare const AI_X_SPACING: number;
|
|
11
|
+
export declare const AI_Y_SPACING: number;
|
|
12
|
+
export declare const STICKY_BOTTOM_PADDING: number;
|
|
13
|
+
export declare const STICKY_NODE_TYPE = "n8n-nodes-base.stickyNote";
|
|
1
14
|
export declare const NODE_SPACING_X = 200;
|
|
2
15
|
export declare const DEFAULT_Y = 300;
|
|
3
16
|
export declare const START_X = 100;
|
|
@@ -1,6 +1,22 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.START_X = exports.DEFAULT_Y = exports.NODE_SPACING_X = void 0;
|
|
3
|
+
exports.START_X = exports.DEFAULT_Y = exports.NODE_SPACING_X = exports.STICKY_NODE_TYPE = exports.STICKY_BOTTOM_PADDING = exports.AI_Y_SPACING = exports.AI_X_SPACING = exports.SUBGRAPH_SPACING = exports.NODE_Y_SPACING = exports.NODE_X_SPACING = exports.NODE_MIN_INPUT_ITEMS_COUNT = exports.CONFIGURABLE_NODE_SIZE = exports.CONFIGURATION_NODE_SIZE = exports.CONFIGURATION_NODE_RADIUS = exports.DEFAULT_NODE_SIZE = exports.GRID_SIZE = void 0;
|
|
4
|
+
exports.GRID_SIZE = 16;
|
|
5
|
+
exports.DEFAULT_NODE_SIZE = [exports.GRID_SIZE * 6, exports.GRID_SIZE * 6];
|
|
6
|
+
exports.CONFIGURATION_NODE_RADIUS = (exports.GRID_SIZE * 5) / 2;
|
|
7
|
+
exports.CONFIGURATION_NODE_SIZE = [
|
|
8
|
+
exports.CONFIGURATION_NODE_RADIUS * 2,
|
|
9
|
+
exports.CONFIGURATION_NODE_RADIUS * 2,
|
|
10
|
+
];
|
|
11
|
+
exports.CONFIGURABLE_NODE_SIZE = [exports.GRID_SIZE * 16, exports.GRID_SIZE * 6];
|
|
12
|
+
exports.NODE_MIN_INPUT_ITEMS_COUNT = 4;
|
|
13
|
+
exports.NODE_X_SPACING = exports.GRID_SIZE * 8;
|
|
14
|
+
exports.NODE_Y_SPACING = exports.GRID_SIZE * 6;
|
|
15
|
+
exports.SUBGRAPH_SPACING = exports.GRID_SIZE * 8;
|
|
16
|
+
exports.AI_X_SPACING = exports.GRID_SIZE * 3;
|
|
17
|
+
exports.AI_Y_SPACING = exports.GRID_SIZE * 8;
|
|
18
|
+
exports.STICKY_BOTTOM_PADDING = exports.GRID_SIZE * 4;
|
|
19
|
+
exports.STICKY_NODE_TYPE = 'n8n-nodes-base.stickyNote';
|
|
4
20
|
exports.NODE_SPACING_X = 200;
|
|
5
21
|
exports.DEFAULT_Y = 300;
|
|
6
22
|
exports.START_X = 100;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/workflow-builder/constants.ts"],"names":[],"mappings":";;;AAOa,QAAA,cAAc,GAAG,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/workflow-builder/constants.ts"],"names":[],"mappings":";;;AAOa,QAAA,SAAS,GAAG,EAAE,CAAC;AAGf,QAAA,iBAAiB,GAAqB,CAAC,iBAAS,GAAG,CAAC,EAAE,iBAAS,GAAG,CAAC,CAAC,CAAC;AACrE,QAAA,yBAAyB,GAAG,CAAC,iBAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAChD,QAAA,uBAAuB,GAAqB;IACxD,iCAAyB,GAAG,CAAC;IAC7B,iCAAyB,GAAG,CAAC;CAC7B,CAAC;AACW,QAAA,sBAAsB,GAAqB,CAAC,iBAAS,GAAG,EAAE,EAAE,iBAAS,GAAG,CAAC,CAAC,CAAC;AAC3E,QAAA,0BAA0B,GAAG,CAAC,CAAC;AAG/B,QAAA,cAAc,GAAG,iBAAS,GAAG,CAAC,CAAC;AAC/B,QAAA,cAAc,GAAG,iBAAS,GAAG,CAAC,CAAC;AAC/B,QAAA,gBAAgB,GAAG,iBAAS,GAAG,CAAC,CAAC;AACjC,QAAA,YAAY,GAAG,iBAAS,GAAG,CAAC,CAAC;AAC7B,QAAA,YAAY,GAAG,iBAAS,GAAG,CAAC,CAAC;AAC7B,QAAA,qBAAqB,GAAG,iBAAS,GAAG,CAAC,CAAC;AAEtC,QAAA,gBAAgB,GAAG,2BAA2B,CAAC;AAG/C,QAAA,cAAc,GAAG,GAAG,CAAC;AACrB,QAAA,SAAS,GAAG,GAAG,CAAC;AAChB,QAAA,OAAO,GAAG,GAAG,CAAC"}
|
|
@@ -1,2 +1,8 @@
|
|
|
1
|
-
import type { GraphNode } from '../types/base';
|
|
1
|
+
import type { GraphNode, WorkflowJSON } from '../types/base';
|
|
2
2
|
export declare function calculateNodePositions(nodes: ReadonlyMap<string, GraphNode>): Map<string, [number, number]>;
|
|
3
|
+
export declare function getNodeDimensions(nodeName: string, aiParentNames: Set<string>, aiConfigNames: Set<string>, nodes: ReadonlyMap<string, GraphNode>): {
|
|
4
|
+
width: number;
|
|
5
|
+
height: number;
|
|
6
|
+
};
|
|
7
|
+
export declare function calculateNodePositionsDagre(nodes: ReadonlyMap<string, GraphNode>): Map<string, [number, number]>;
|
|
8
|
+
export declare function layoutWorkflowJSON(json: WorkflowJSON): WorkflowJSON;
|