-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Expand file tree
/
Copy pathgenerate-block-docs.ts
More file actions
1437 lines (1217 loc) · 50.2 KB
/
generate-block-docs.ts
File metadata and controls
1437 lines (1217 loc) · 50.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env ts-node
import fs from 'fs'
import path from 'path'
import { fileURLToPath } from 'url'
import { glob } from 'glob'
console.log('Starting documentation generator...')
// Define directory paths
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
const rootDir = path.resolve(__dirname, '..')
// Paths configuration
const BLOCKS_PATH = path.join(rootDir, 'apps/sim/blocks/blocks')
const DOCS_OUTPUT_PATH = path.join(rootDir, 'apps/docs/content/docs/tools')
const ICONS_PATH = path.join(rootDir, 'apps/sim/components/icons.tsx')
// Make sure the output directory exists
if (!fs.existsSync(DOCS_OUTPUT_PATH)) {
fs.mkdirSync(DOCS_OUTPUT_PATH, { recursive: true })
}
interface InputConfig {
type: string
required: boolean
}
// Basic interface for BlockConfig to avoid import issues
interface BlockConfig {
type: string
name: string
description: string
longDescription?: string
category: string
bgColor?: string
icon?: any
subBlocks?: Array<{
id: string
title?: string
placeholder?: string
type?: string
layout?: string
options?: Array<{ label: string; id: string }>
[key: string]: any
}>
inputs?: Record<string, any>
outputs?: Record<string, any>
tools?: {
access?: string[]
config?: any
}
[key: string]: any
}
// Function to extract SVG icons from icons.tsx file
function extractIcons(): Record<string, string> {
try {
const iconsContent = fs.readFileSync(ICONS_PATH, 'utf-8')
const icons: Record<string, string> = {}
// Match both function declaration and arrow function export patterns
const functionDeclarationRegex =
/export\s+function\s+(\w+Icon)\s*\([^)]*\)\s*{[\s\S]*?return\s*\(\s*<svg[\s\S]*?<\/svg>\s*\)/g
const arrowFunctionRegex =
/export\s+const\s+(\w+Icon)\s*=\s*\([^)]*\)\s*=>\s*(\(?\s*<svg[\s\S]*?<\/svg>\s*\)?)/g
// Extract function declaration style icons
const functionMatches = Array.from(iconsContent.matchAll(functionDeclarationRegex))
for (const match of functionMatches) {
const iconName = match[1]
const svgMatch = match[0].match(/<svg[\s\S]*?<\/svg>/)
if (iconName && svgMatch) {
// Clean the SVG to remove {...props} and standardize size
let svgContent = svgMatch[0]
svgContent = svgContent.replace(/{\.\.\.props}/g, '')
svgContent = svgContent.replace(/{\.\.\.(props|rest)}/g, '')
// Remove any existing width/height attributes to let CSS handle sizing
svgContent = svgContent.replace(/width=["'][^"']*["']/g, '')
svgContent = svgContent.replace(/height=["'][^"']*["']/g, '')
// Add className for styling
svgContent = svgContent.replace(/<svg/, '<svg className="block-icon"')
icons[iconName] = svgContent
}
}
// Extract arrow function style icons
const arrowMatches = Array.from(iconsContent.matchAll(arrowFunctionRegex))
for (const match of arrowMatches) {
const iconName = match[1]
const svgContent = match[2]
const svgMatch = svgContent.match(/<svg[\s\S]*?<\/svg>/)
if (iconName && svgMatch) {
// Clean the SVG to remove {...props} and standardize size
let cleanedSvg = svgMatch[0]
cleanedSvg = cleanedSvg.replace(/{\.\.\.props}/g, '')
cleanedSvg = cleanedSvg.replace(/{\.\.\.(props|rest)}/g, '')
// Remove any existing width/height attributes to let CSS handle sizing
cleanedSvg = cleanedSvg.replace(/width=["'][^"']*["']/g, '')
cleanedSvg = cleanedSvg.replace(/height=["'][^"']*["']/g, '')
// Add className for styling
cleanedSvg = cleanedSvg.replace(/<svg/, '<svg className="block-icon"')
icons[iconName] = cleanedSvg
}
}
return icons
} catch (error) {
console.error('Error extracting icons:', error)
return {}
}
}
// Function to extract block configuration from file content
function extractBlockConfig(fileContent: string): BlockConfig | null {
try {
// Match the block name and type from imports and export statement
const _typeMatch = fileContent.match(/type\s+(\w+)Response\s*=/)
const exportMatch = fileContent.match(/export\s+const\s+(\w+)Block\s*:/)
if (!exportMatch) {
console.warn('No block export found in file')
return null
}
const blockName = exportMatch[1]
const blockType = findBlockType(fileContent, blockName)
// Extract individual properties with more robust regex
const name = extractStringProperty(fileContent, 'name') || `${blockName} Block`
const description = extractStringProperty(fileContent, 'description') || ''
const longDescription = extractStringProperty(fileContent, 'longDescription') || ''
const category = extractStringProperty(fileContent, 'category') || 'misc'
const bgColor = extractStringProperty(fileContent, 'bgColor') || '#F5F5F5'
const iconName = extractIconName(fileContent) || ''
// Extract subBlocks array
const subBlocks = extractSubBlocks(fileContent)
// Extract inputs object
const inputs = extractInputs(fileContent)
// Extract outputs object with better handling
const outputs = extractOutputs(fileContent)
// Extract tools access array
const toolsAccess = extractToolsAccess(fileContent)
return {
type: blockType || blockName.toLowerCase(),
name,
description,
longDescription,
category,
bgColor,
iconName,
subBlocks,
inputs,
outputs,
tools: {
access: toolsAccess,
},
}
} catch (error) {
console.error('Error extracting block configuration:', error)
return null
}
}
// Helper function to find the block type
function findBlockType(content: string, blockName: string): string {
// Try to find the type within the main block export
// Look for the pattern: export const [BlockName]Block: BlockConfig = { ... type: 'value' ... }
const blockExportRegex = new RegExp(
`export\\s+const\\s+${blockName}Block\\s*:[^{]*{[\\s\\S]*?type\\s*:\\s*['"]([^'"]+)['"][\\s\\S]*?}`,
'i'
)
const blockExportMatch = content.match(blockExportRegex)
if (blockExportMatch) return blockExportMatch[1]
// Fallback: try to find type within a block config object that comes after the export
const exportMatch = content.match(new RegExp(`export\\s+const\\s+${blockName}Block\\s*:`))
if (exportMatch) {
// Find the content after the export statement
const afterExport = content.substring(exportMatch.index! + exportMatch[0].length)
// Look for the first opening brace and then find type within that block
const blockStartMatch = afterExport.match(/{/)
if (blockStartMatch) {
const blockStart = blockStartMatch.index!
// Find the matching closing brace by counting braces
let braceCount = 1
let blockEnd = blockStart + 1
while (blockEnd < afterExport.length && braceCount > 0) {
if (afterExport[blockEnd] === '{') braceCount++
else if (afterExport[blockEnd] === '}') braceCount--
blockEnd++
}
// Extract the block content and look for type
const blockContent = afterExport.substring(blockStart, blockEnd)
const typeMatch = blockContent.match(/type\s*:\s*['"]([^'"]+)['"]/)
if (typeMatch) return typeMatch[1]
}
}
// Convert CamelCase to snake_case as fallback
return blockName
.replace(/([A-Z])/g, '_$1')
.toLowerCase()
.replace(/^_/, '')
}
// Helper to extract a string property from content
function extractStringProperty(content: string, propName: string): string | null {
const simpleMatch = content.match(new RegExp(`${propName}\\s*:\\s*['"]([^'"]+)['"]`, 'm'))
if (simpleMatch) return simpleMatch[1]
// Try to match multi-line string with template literals
const templateMatch = content.match(new RegExp(`${propName}\\s*:\\s*\`([^\`]+)\``, 's'))
if (templateMatch) {
let templateContent = templateMatch[1]
// Handle template literals with expressions by replacing them with reasonable defaults
// This is a simple approach - we'll replace common variable references with sensible defaults
templateContent = templateContent.replace(
/\$\{[^}]*shouldEnableURLInput[^}]*\?[^:]*:[^}]*\}/g,
'Upload files directly. '
)
templateContent = templateContent.replace(/\$\{[^}]*shouldEnableURLInput[^}]*\}/g, 'false')
// Remove any remaining template expressions that we can't safely evaluate
templateContent = templateContent.replace(/\$\{[^}]+\}/g, '')
// Clean up any extra whitespace
templateContent = templateContent.replace(/\s+/g, ' ').trim()
return templateContent
}
return null
}
// Helper to extract icon name from content
function extractIconName(content: string): string | null {
const iconMatch = content.match(/icon\s*:\s*(\w+Icon)/)
return iconMatch ? iconMatch[1] : null
}
// Helper to extract subBlocks array
function extractSubBlocks(content: string): any[] {
const subBlocksMatch = content.match(/subBlocks\s*:\s*\[([\s\S]*?)\s*\],/)
if (!subBlocksMatch) return []
const subBlocksContent = subBlocksMatch[1]
const blocks: any[] = []
// Find all block objects
const blockMatches = subBlocksContent.match(/{\s*id\s*:[^}]*}/g)
if (!blockMatches) return []
blockMatches.forEach((blockText) => {
const id = extractStringProperty(blockText, 'id')
const title = extractStringProperty(blockText, 'title')
const placeholder = extractStringProperty(blockText, 'placeholder')
const type = extractStringProperty(blockText, 'type')
const layout = extractStringProperty(blockText, 'layout')
// Extract options array if present
const optionsMatch = blockText.match(/options\s*:\s*\[([\s\S]*?)\]/)
let options: Array<{ label: string | null; id: string | null }> = []
if (optionsMatch) {
const optionsText = optionsMatch[1]
const optionMatches = optionsText.match(/{\s*label\s*:[^}]*}/g)
if (optionMatches) {
options = optionMatches.map((optText) => {
const label = extractStringProperty(optText, 'label')
const optId = extractStringProperty(optText, 'id')
return { label, id: optId }
})
}
}
blocks.push({
id,
title,
placeholder,
type,
layout,
options: options.length > 0 ? options : undefined,
})
})
return blocks
}
// Function to extract inputs object
function extractInputs(content: string): Record<string, any> {
const inputsMatch = content.match(/inputs\s*:\s*{([\s\S]*?)},/)
if (!inputsMatch) return {}
const inputsContent = inputsMatch[1]
const inputs: Record<string, any> = {}
// Find all input property definitions
const propMatches = inputsContent.match(/(\w+)\s*:\s*{[\s\S]*?}/g)
if (!propMatches) {
// Try an alternative approach for the whole inputs section
const inputLines = inputsContent.split('\n')
inputLines.forEach((line) => {
const propMatch = line.match(/\s*(\w+)\s*:\s*{/)
if (propMatch) {
const propName = propMatch[1]
const typeMatch = line.match(/type\s*:\s*['"]([^'"]+)['"]/)
const requiredMatch = line.match(/required\s*:\s*(true|false)/)
inputs[propName] = {
type: typeMatch ? typeMatch[1] : 'string',
required: requiredMatch ? requiredMatch[1] === 'true' : false,
}
}
})
return inputs
}
propMatches.forEach((propText) => {
const propMatch = propText.match(/(\w+)\s*:/)
if (!propMatch) return
const propName = propMatch[1]
const typeMatch = propText.match(/type\s*:\s*['"]?([^'"}, ]+)['"]?/s)
const requiredMatch = propText.match(/required\s*:\s*(true|false)/s)
const _descriptionMatch = propText.match(/description\s*:\s*['"]([^'"]+)['"]/s)
inputs[propName] = {
type: typeMatch ? typeMatch[1] : 'any',
required: requiredMatch ? requiredMatch[1] === 'true' : false,
}
})
return inputs
}
// Updated function to extract outputs with a simpler and more reliable approach
function extractOutputs(content: string): Record<string, any> {
// Look for the outputs section with a more resilient regex
const outputsMatch = content.match(/outputs\s*:\s*{([^}]*)}(?:\s*,|\s*})/s)
if (outputsMatch) {
const outputsContent = outputsMatch[1].trim()
const outputs: Record<string, any> = {}
// Try to extract fields from the outputs object
const fieldMatches = outputsContent.match(/(\w+)\s*:\s*{([^}]+)}/g)
if (fieldMatches && fieldMatches.length > 0) {
fieldMatches.forEach((fieldMatch) => {
const fieldNameMatch = fieldMatch.match(/(\w+)\s*:/)
if (fieldNameMatch) {
const fieldName = fieldNameMatch[1]
// Check if there's a type with a nested structure
const typeMatch = fieldMatch.match(/type\s*:\s*{([^}]+)}/)
if (typeMatch) {
// Handle nested type object
const typeContent = typeMatch[1]
const properties: Record<string, any> = {}
// Extract property types from the type object - handle cases with comments
// const propertyMatches = typeContent.match(/(\w+)\s*:\s*['"]([^'"]+)['"]/g)
const propertyMatches = typeContent.match(
/(\w+)\s*:\s*['"]([^'"]+)['"](?:\s*,)?(?:\s*\/\/[^\n]*)?/g
)
if (propertyMatches) {
propertyMatches.forEach((propMatch) => {
// Extract the property name and type, ignoring any trailing comments
const propParts = propMatch.match(/(\w+)\s*:\s*['"]([^'"]+)['"]/)
if (propParts) {
const propName = propParts[1]
const propType = propParts[2]
// Look for an inline comment that might contain a description
const commentMatch = propMatch.match(/\/\/\s*(.+)$/)
const description = commentMatch
? commentMatch[1].trim()
: `${propName} of the ${fieldName}`
properties[propName] = {
type: propType,
description: description,
}
}
})
}
// Add the field with properties
outputs[fieldName] = {
properties,
description: `${fieldName} from the block execution`,
}
} else {
// Try to extract a simple type definition
const simpleTypeMatch = fieldMatch.match(/type\s*:\s*['"]([^'"]+)['"]/)
if (simpleTypeMatch) {
outputs[fieldName] = {
type: simpleTypeMatch[1],
description: `${fieldName} output from the block`,
}
}
}
}
})
}
// If we parsed anything, return it
if (Object.keys(outputs).length > 0) {
return outputs
}
}
// Fallback to the original method for backward compatibility
const outputsSection = content.match(/outputs\s*:\s*{([^}]*response[^}]*)}(?:\s*,|\s*})/s)
if (outputsSection) {
// Find the response type definition
const responseTypeMatch = content.match(/response\s*:\s*{\s*type\s*:\s*{([^}]*)}/s)
if (responseTypeMatch) {
const typeContent = responseTypeMatch[1]
// Extract all field: 'type' pairs regardless of comments or formatting
const fieldMatches = typeContent.match(/(\w+)\s*:\s*['"]([^'"]+)['"]/g)
if (fieldMatches && fieldMatches.length > 0) {
const typeFields: Record<string, string> = {}
// Process each field match
fieldMatches.forEach((match) => {
const fieldParts = match.match(/(\w+)\s*:\s*['"]([^'"]+)['"]/)
if (fieldParts) {
const fieldName = fieldParts[1]
const fieldType = fieldParts[2]
typeFields[fieldName] = fieldType
}
})
// If we have any fields, return them in the expected structure
if (Object.keys(typeFields).length > 0) {
const result = {
response: {
type: typeFields,
},
}
return result
}
}
}
}
return {}
}
// Helper to extract tools access array
function extractToolsAccess(content: string): string[] {
const accessMatch = content.match(/access\s*:\s*\[\s*((?:['"][^'"]+['"](?:\s*,\s*)?)+)\s*\]/)
if (!accessMatch) return []
const accessContent = accessMatch[1]
const tools: string[] = []
const toolMatches = accessContent.match(/['"]([^'"]+)['"]/g)
if (toolMatches) {
toolMatches.forEach((toolText) => {
const match = toolText.match(/['"]([^'"]+)['"]/)
if (match) {
tools.push(match[1])
}
})
}
return tools
}
// Function to extract tool information from file content
function extractToolInfo(
toolName: string,
fileContent: string,
filePath = ''
): {
description: string
params: Array<{ name: string; type: string; required: boolean; description: string }>
outputs: Record<string, any>
} | null {
try {
// Extract tool config section - Simplified regex to match any *Tool export pattern
const toolConfigRegex = /export const \w+Tool\s*[=<][^{]*{[\s\S]*?params\s*:\s*{([\s\S]*?)}/im
const toolConfigMatch = fileContent.match(toolConfigRegex)
// Extract description
const descriptionRegex = /description\s*:\s*['"]([^'"]+)['"].*/
const descriptionMatch = fileContent.match(descriptionRegex)
const description = descriptionMatch ? descriptionMatch[1] : 'No description available'
// Parse parameters
const params: Array<{ name: string; type: string; required: boolean; description: string }> = []
if (toolConfigMatch) {
const paramsContent = toolConfigMatch[1]
// More robust approach to extract parameters
// Extract each parameter block completely
const paramBlocksRegex = /(\w+)\s*:\s*{([^}]+)}/g
let paramMatch
while ((paramMatch = paramBlocksRegex.exec(paramsContent)) !== null) {
const paramName = paramMatch[1]
const paramBlock = paramMatch[2]
// Skip the accessToken parameter as it's handled automatically by the OAuth flow
// Also skip any params parameter which isn't a real input
if (paramName === 'accessToken' || paramName === 'params' || paramName === 'tools') {
continue
}
// Extract param details with more robust patterns
const typeMatch = paramBlock.match(/type\s*:\s*['"]([^'"]+)['"]/)
const requiredMatch = paramBlock.match(/required\s*:\s*(true|false)/)
// More careful extraction of description with handling for multiline descriptions
let descriptionMatch = paramBlock.match(/description\s*:\s*['"]([^'"]+)['"]/)
if (!descriptionMatch) {
// Try for template literals if the description uses backticks
descriptionMatch = paramBlock.match(/description\s*:\s*`([^`]+)`/)
}
params.push({
name: paramName,
type: typeMatch ? typeMatch[1] : 'string',
required: requiredMatch ? requiredMatch[1] === 'true' : false,
description: descriptionMatch ? descriptionMatch[1] : 'No description',
})
}
}
// If no params were found with the first method, try a more direct regex approach
if (params.length === 0) {
const paramRegex =
/(\w+)\s*:\s*{(?:[^{}]|{[^{}]*})*type\s*:\s*['"]([^'"]+)['"](?:[^{}]|{[^{}]*})*required\s*:\s*(true|false)(?:[^{}]|{[^{}]*})*description\s*:\s*['"]([^'"]+)['"](?:[^{}]|{[^{}]*})*}/g
let match
while ((match = paramRegex.exec(fileContent)) !== null) {
// Skip the accessToken parameter and any params parameter
if (match[1] === 'params' || match[1] === 'tools') continue
params.push({
name: match[1],
type: match[2],
required: match[3] === 'true',
description: match[4] || 'No description',
})
}
}
// Extract output structure from transformResponse
let outputs: Record<string, any> = {}
const outputRegex = /transformResponse[\s\S]*?return\s*{[\s\S]*?output\s*:\s*{([^}]*)/
const outputMatch = fileContent.match(outputRegex)
if (outputMatch) {
const outputContent = outputMatch[1]
// Try to parse the output structure based on the content
outputs = parseOutputStructure(toolName, outputContent, fileContent)
}
// If we couldn't extract outputs from transformResponse, try an alternative approach
if (Object.keys(outputs).length === 0) {
// Look for output in successful response in transformResponse
const successOutputRegex =
/success\s*:\s*true,\s*output\s*:\s*(\{[^}]*\}|\w+(\.\w+)+\s*\|\|\s*\{[^}]*\}|\w+(\.\w+)+\.map\s*\()/
const successOutputMatch = fileContent.match(successOutputRegex)
if (successOutputMatch) {
const outputExpression = successOutputMatch[1].trim()
// Handle case where output is something like "data.data || {}"
if (outputExpression.includes('||')) {
outputs.data = 'json'
}
// Handle array mapping like "data.issues.map(...)"
else if (outputExpression.includes('.map')) {
// Try to extract the array object being mapped
const arrayMapMatch = outputExpression.match(/(\w+(?:\.\w+)+)\.map/)
if (arrayMapMatch) {
const arrayPath = arrayMapMatch[1]
// Get the base object being mapped to an array
const arrayObject = arrayPath.split('.').pop()
if (arrayObject) {
outputs[arrayObject] = 'Array of mapped items'
}
} else {
// Fallback if we can't extract the exact array object
outputs.items = 'Array of mapped items'
}
}
// Handle direct object assignment like "output: { field1, field2 }"
else if (outputExpression.startsWith('{')) {
const fieldMatches = outputExpression.match(/(\w+)\s*:/g)
if (fieldMatches) {
fieldMatches.forEach((match) => {
const fieldName = match.trim().replace(':', '')
outputs[fieldName] = 'Dynamic output field'
})
}
}
// Check for data.X patterns like "data.data"
else if (outputExpression.includes('.')) {
const fieldName = outputExpression.split('.').pop()
if (fieldName) {
outputs[fieldName] = 'json'
}
}
}
}
// Try to extract TypeScript interface for outputs as a fallback
if (Object.keys(outputs).length === 0) {
const interfaceRegex = new RegExp(
`interface\\s+${toolName.replace(/_/g, '')}Response\\s*{[\\s\\S]*?output\\s*:\\s*{([\\s\\S]*?)}[\\s\\S]*?}`
)
const interfaceMatch = fileContent.match(interfaceRegex)
if (interfaceMatch) {
const interfaceContent = interfaceMatch[1]
outputs = parseOutputStructure(toolName, interfaceContent, fileContent)
}
}
// Look for TypeScript types in a types.ts file if available
if (Object.keys(outputs).length === 0 && filePath) {
const toolDir = path.dirname(filePath)
const typesPath = path.join(toolDir, 'types.ts')
if (fs.existsSync(typesPath)) {
const typesContent = fs.readFileSync(typesPath, 'utf-8')
const responseTypeRegex = new RegExp(
`interface\\s+${toolName.replace(/_/g, '')}Response\\s*extends\\s+\\w+\\s*{\\s*output\\s*:\\s*{([\\s\\S]*?)}\\s*}`,
'i'
)
const responseTypeMatch = typesContent.match(responseTypeRegex)
if (responseTypeMatch) {
outputs = parseOutputStructure(toolName, responseTypeMatch[1], typesContent)
}
}
}
return {
description,
params,
outputs,
}
} catch (error) {
console.error(`Error extracting info for tool ${toolName}:`, error)
return null
}
}
// Update the parseOutputStructure function to better handle nested objects
function parseOutputStructure(
toolName: string,
outputContent: string,
fileContent: string
): Record<string, any> {
const outputs: Record<string, any> = {}
// Try to extract field declarations with their types
const fieldRegex = /(\w+)\s*:([^,}]+)/g
let fieldMatch
while ((fieldMatch = fieldRegex.exec(outputContent)) !== null) {
const fieldName = fieldMatch[1].trim()
const _fieldType = fieldMatch[2].trim().replace(/["'[\]]/g, '')
// Determine a good description based on field name
let description = 'Dynamic output field'
if (fieldName === 'results' || fieldName === 'memories' || fieldName === 'searchResults') {
description = `${fieldName.charAt(0).toUpperCase() + fieldName.slice(1)} from the operation`
} else if (fieldName === 'ids') {
description = 'IDs of created or retrieved resources'
} else if (fieldName === 'answer') {
description = 'Generated answer text'
} else if (fieldName === 'citations') {
description = 'References used to generate the answer'
}
outputs[fieldName] = description
}
const shorthandRegex = /(?:^\s*|[,{]\s*)([A-Za-z_][\w]*)\s*(?=,|})/g
let shorthandMatch
while ((shorthandMatch = shorthandRegex.exec(outputContent)) !== null) {
const fieldName = shorthandMatch[1].trim()
// Ignore fields already captured or those that are part of key/value pairs
if (outputs[fieldName]) continue
// Provide the same heuristic descriptions as above
let description = 'Dynamic output field'
if (fieldName === 'results' || fieldName === 'memories' || fieldName === 'searchResults') {
description = `${fieldName.charAt(0).toUpperCase() + fieldName.slice(1)} from the operation`
} else if (fieldName === 'ids') {
description = 'IDs of created or retrieved resources'
} else if (fieldName === 'answer') {
description = 'Generated answer text'
} else if (fieldName === 'citations') {
description = 'References used to generate the answer'
}
outputs[fieldName] = description
}
// Try to identify common patterns based on tool types
if (Object.keys(outputs).length === 0) {
if (toolName.includes('_search')) {
outputs.results = 'Array of search results'
} else if (toolName.includes('_answer')) {
outputs.answer = 'Generated answer text'
outputs.citations = 'References used to generate the answer'
} else if (toolName.includes('_add')) {
outputs.ids = 'IDs of created resources'
} else if (toolName.includes('_get')) {
outputs.data = 'Retrieved data'
} else {
// Try to extract field names from the output content with a simpler regex
const simpleFieldsRegex = /(\w+)\s*:/g
let simpleFieldMatch
while ((simpleFieldMatch = simpleFieldsRegex.exec(outputContent)) !== null) {
outputs[simpleFieldMatch[1]] = 'Dynamic output field'
}
}
}
return outputs
}
// Find and extract information about a tool
async function getToolInfo(toolName: string): Promise<{
description: string
params: Array<{ name: string; type: string; required: boolean; description: string }>
outputs: Record<string, any>
} | null> {
try {
// Split the tool name into parts
const parts = toolName.split('_')
// Try to find the correct split point by checking if directories exist
let toolPrefix = ''
let toolSuffix = ''
// Start from the longest possible prefix and work backwards
for (let i = parts.length - 1; i >= 1; i--) {
const possiblePrefix = parts.slice(0, i).join('_')
const possibleSuffix = parts.slice(i).join('_')
// Check if a directory exists for this prefix
const toolDirPath = path.join(rootDir, `apps/sim/tools/${possiblePrefix}`)
if (fs.existsSync(toolDirPath) && fs.statSync(toolDirPath).isDirectory()) {
toolPrefix = possiblePrefix
toolSuffix = possibleSuffix
break
}
}
// If no directory was found, fall back to single-part prefix
if (!toolPrefix) {
toolPrefix = parts[0]
toolSuffix = parts.slice(1).join('_')
}
// Simplify the file search strategy
const possibleLocations = []
// Most common pattern: suffix.ts file in the prefix directory
possibleLocations.push(path.join(rootDir, `apps/sim/tools/${toolPrefix}/${toolSuffix}.ts`))
// Try underscore version if suffix has multiple parts
if (toolSuffix.includes('_')) {
const underscoreSuffix = toolSuffix.replace(/_/g, '_')
possibleLocations.push(
path.join(rootDir, `apps/sim/tools/${toolPrefix}/${underscoreSuffix}.ts`)
)
}
// Try camelCase version of suffix
const camelCaseSuffix = toolSuffix
.split('_')
.map((part, i) => (i === 0 ? part : part.charAt(0).toUpperCase() + part.slice(1)))
.join('')
possibleLocations.push(path.join(rootDir, `apps/sim/tools/${toolPrefix}/${camelCaseSuffix}.ts`))
// Also check the index.ts file in the tool directory
possibleLocations.push(path.join(rootDir, `apps/sim/tools/${toolPrefix}/index.ts`))
// Try to find the tool definition file
let toolFilePath = ''
let toolFileContent = ''
for (const location of possibleLocations) {
if (fs.existsSync(location)) {
toolFilePath = location
toolFileContent = fs.readFileSync(location, 'utf-8')
break
}
}
// If not found, search in tool-specific directory
if (!toolFileContent) {
const toolsDir = path.join(rootDir, 'apps/tools')
if (fs.existsSync(path.join(toolsDir, toolPrefix))) {
const dirPath = path.join(toolsDir, toolPrefix)
const files = fs.readdirSync(dirPath).filter((file) => file.endsWith('.ts'))
for (const file of files) {
const filePath = path.join(dirPath, file)
const content = fs.readFileSync(filePath, 'utf-8')
// Check if this file contains the tool id
if (content.includes(`id: '${toolName}'`) || content.includes(`id: "${toolName}"`)) {
toolFilePath = filePath
toolFileContent = content
break
}
}
}
}
if (!toolFileContent) {
console.warn(`Could not find definition for tool: ${toolName}`)
return null
}
// Extract tool information from the file
return extractToolInfo(toolName, toolFileContent, toolFilePath)
} catch (error) {
console.error(`Error getting info for tool ${toolName}:`, error)
return null
}
}
// Function to extract content between manual content markers
function extractManualContent(existingContent: string): Record<string, string> {
const manualSections: Record<string, string> = {}
// Improved regex to better handle MDX comments
const manualContentRegex =
/\{\/\*\s*MANUAL-CONTENT-START:(\w+)\s*\*\/\}([\s\S]*?)\{\/\*\s*MANUAL-CONTENT-END\s*\*\/\}/g
let match
while ((match = manualContentRegex.exec(existingContent)) !== null) {
const sectionName = match[1]
const content = match[2].trim()
manualSections[sectionName] = content
console.log(`Found manual content for section: ${sectionName}`)
}
return manualSections
}
// Function to merge generated markdown with manual content
function mergeWithManualContent(
generatedMarkdown: string,
existingContent: string | null,
manualSections: Record<string, string>
): string {
if (!existingContent || Object.keys(manualSections).length === 0) {
return generatedMarkdown
}
console.log('Merging manual content with generated markdown')
// Log what we found for debugging
console.log(`Found ${Object.keys(manualSections).length} manual sections`)
Object.keys(manualSections).forEach((section) => {
console.log(` - ${section}: ${manualSections[section].substring(0, 20)}...`)
})
// Replace placeholders in generated markdown with manual content
let mergedContent = generatedMarkdown
// Add manual content for each section we found
Object.entries(manualSections).forEach(([sectionName, content]) => {
// Define insertion points for different section types with improved patterns
const insertionPoints: Record<string, { regex: RegExp }> = {
intro: {
regex: /<BlockInfoCard[\s\S]*?<\/svg>`}\s*\/>/,
},
usage: {
regex: /## Usage Instructions/,
},
configuration: {
regex: /## Configuration/,
},
outputs: {
regex: /## Outputs/,
},
notes: {
regex: /## Notes/,
},
}
// Find the appropriate insertion point
const insertionPoint = insertionPoints[sectionName]
if (insertionPoint) {
// Use regex to find the insertion point
const match = mergedContent.match(insertionPoint.regex)
if (match && match.index !== undefined) {
// Insert after the matched content
const insertPosition = match.index + match[0].length
console.log(`Inserting ${sectionName} content after position ${insertPosition}`)
mergedContent = `${mergedContent.slice(0, insertPosition)}\n\n{/* MANUAL-CONTENT-START:${sectionName} */}\n${content}\n{/* MANUAL-CONTENT-END */}\n${mergedContent.slice(insertPosition)}`
} else {
console.log(
`Could not find insertion point for ${sectionName}, regex pattern: ${insertionPoint.regex}`
)
}
} else {
console.log(`No insertion point defined for section ${sectionName}`)
}
})
return mergedContent
}
// Function to generate documentation for a block
async function generateBlockDoc(blockPath: string, icons: Record<string, string>) {
try {
// Extract the block name from the file path
const blockFileName = path.basename(blockPath, '.ts')
if (blockFileName.endsWith('.test')) {
return // Skip test files
}
// Read the file content
const fileContent = fs.readFileSync(blockPath, 'utf-8')
// Extract block configuration from the file content
const blockConfig = extractBlockConfig(fileContent)
if (!blockConfig || !blockConfig.type) {
console.warn(`Skipping ${blockFileName} - not a valid block config`)
return
}
// Skip blocks with category 'blocks' (except memory type), and skip specific blocks
if (
(blockConfig.category === 'blocks' &&
blockConfig.type !== 'memory' &&
blockConfig.type !== 'knowledge') ||
blockConfig.type === 'evaluator' ||
blockConfig.type === 'number'
) {
return
}
// Output file path
const outputFilePath = path.join(DOCS_OUTPUT_PATH, `${blockConfig.type}.mdx`)
// IMPORTANT: Check if file already exists and read its content FIRST
let existingContent: string | null = null
if (fs.existsSync(outputFilePath)) {
existingContent = fs.readFileSync(outputFilePath, 'utf-8')
console.log(`Existing file found for ${blockConfig.type}.mdx, checking for manual content...`)
}
// Extract manual content from existing file before generating new content
const manualSections = existingContent ? extractManualContent(existingContent) : {}
// Create the markdown content - now async
const markdown = await generateMarkdownForBlock(blockConfig, icons)
// Merge with manual content if we found any
let finalContent = markdown
if (Object.keys(manualSections).length > 0) {
console.log(`Found manual content in ${blockConfig.type}.mdx, merging...`)
finalContent = mergeWithManualContent(markdown, existingContent, manualSections)
} else {
console.log(`No manual content found in ${blockConfig.type}.mdx`)
}