-
Notifications
You must be signed in to change notification settings - Fork 3
/
component.json
591 lines (591 loc) · 17.2 KB
/
component.json
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
{
"title": "SFTP",
"description": "Provides file access and transfer using SSH File Transfer Protocol",
"version": "1.7.4",
"credentials": {
"fields": {
"host": {
"viewClass": "TextFieldView",
"label": "Host",
"required": true,
"placeholder": "Name of the host"
},
"port": {
"viewClass": "TextFieldView",
"label": "Port",
"placeholder": "Port of the host",
"note": "If no port is provided, 22 will be used"
},
"username": {
"viewClass": "TextFieldView",
"label": "User Name",
"required": true,
"placeholder": "Paste your SFTP user name"
},
"password": {
"viewClass": "PasswordFieldView",
"label": "Password",
"required": false,
"placeholder": "Paste your SFTP password",
"note": "For using username and password based authentication, leave `Private Key` field empty"
},
"privateKey": {
"viewClass": "TextAreaView",
"label": "Private Key",
"required": false,
"placeholder": "Paste your SFTP Private Key",
"note": "For using Private Key based authentication, leave Password field empty"
},
"passphrase": {
"viewClass": "PasswordFieldView",
"label": "Passphrase",
"required": false,
"placeholder": "Paste your passphrase",
"note": "If private key is protected by a passphrase, put it here"
}
}
},
"envVars": {
"MAX_FILE_SIZE": {
"required": false,
"description": "Max file size to upload from SFTP"
}
},
"actions": {
"upload": {
"main": "./lib/actions/upload.js",
"title": "Upload Files From Attachments Header",
"help": {
"description": "Upload all files from the attachments header to a defined SFTP directory",
"link": "/components/sftp/actions#upload-files-from-attachments-header"
},
"fields": {
"directory": {
"viewClass": "TextFieldView",
"label": "Directory Name",
"required": true,
"placeholder": "/foo/bar",
"note": "Directory will be created if not exists, attachments with the same name would be overwritten"
}
},
"metadata": {
"in": {
"type": "object",
"properties": {
"filename": {
"title": "File Name",
"type": "string",
"required": false
}
}
},
"out": {
"type": "object",
"properties": {
"result": {
"title": "Result",
"type": "object",
"required": true,
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachment": {
"title": "Attachment Name",
"type": "string",
"required": true
},
"uploadedOn": {
"title": "Uploaded on",
"type": "string",
"required": true
},
"fileName": {
"title": "File Name",
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
},
"upsertFile": {
"main": "./lib/actions/upsertFile.js",
"title": "Upload File From URL",
"help": {
"description": "Given a filename and a URL to an attachment stored in the platform, transfers the contents of the attachment to the SFTP server. The component returns a summary of the written file",
"link": "/components/sftp/actions#upload-file-from-url"
},
"fields": {
"updateBehavior": {
"label": "Behavior When File Already Exists",
"viewClass": "SelectView",
"required": true,
"prompt": "Select a Behavior",
"model": {
"error": "Throw an Error",
"overwrite": "Overwrite the File",
"append": "Append the File Contents"
}
}
},
"metadata": {
"in": {
"type": "object",
"required": true,
"properties": {
"filename": {
"title": "File Name and Path",
"type": "string",
"required": true
},
"attachmentUrl": {
"title": "Attachment URL",
"type": "string",
"required": true
},
"encoding": {
"title": "Encoding (defaults to null)",
"type": "string",
"required": false
},
"fileMod": {
"title": "File Mode (i.e. read/write permissions) (defaults to 0o666 (rwx))",
"type": "string",
"required": false
}
}
},
"out": {
"type": "object",
"properties": {
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"required": true
},
"name": {
"title": "File Name",
"type": "string",
"required": true
},
"size": {
"title": "File Size",
"type": "number",
"required": true
},
"modifyTime": {
"title": "modifyTime",
"type": "string",
"required": true
},
"accessTime": {
"title": "accessTime",
"type": "string",
"required": true
},
"directory": {
"title": "directory",
"type": "string",
"required": true
},
"path": {
"title": "path",
"type": "string",
"required": true
}
}
}
}
}
},
"moveFile": {
"main": "./lib/actions/moveFile.js",
"title": "Move File",
"help": {
"description": "Moves file on SFTP already exists in one location on an sftp server to be moved to another location on the same SFTP server",
"link": "/components/sftp/actions#move-file"
},
"metadata": {
"in": {
"type": "object",
"required": true,
"properties": {
"filename": {
"title": "Current file Name and Path",
"type": "string",
"required": true
},
"newFilename": {
"title": "New file Name and Path",
"type": "string",
"required": true
}
}
},
"out": {
"type": "object",
"required": true,
"properties": {
"filename": {
"title": "Current file Name and Path",
"type": "string",
"required": true
},
"newFilename": {
"title": "New file Name and Path",
"type": "string",
"required": true
}
}
}
}
},
"delete": {
"main": "./lib/actions/delete.js",
"title": "Delete File",
"description": "Delete file by name in provided path",
"help": {
"description": "Delete file by name in provided path",
"link": "/components/sftp/actions#delete-file"
},
"metadata": {
"in": {
"type": "object",
"properties": {
"path": {
"title": "Full Path",
"type": "string",
"required": true
}
}
},
"out": {
"type": "object",
"properties": {
"id": {
"title": "Full Path",
"type": "string",
"required": true
}
}
}
}
},
"lookupObject": {
"main": "./lib/actions/lookupObject.js",
"title": "Download File by name",
"help": {
"description": "Lookup file by name in a defined SFTP directory",
"link": "/components/sftp/actions#download-file-by-name"
},
"fields": {
"allowEmptyResult": {
"viewClass": "SelectView",
"label": "Allow Empty Result",
"model": {
"Yes": "Yes",
"No": "No"
},
"prompt": "Allow empty result if object not found? Default: No."
},
"allowCriteriaToBeOmitted": {
"viewClass": "SelectView",
"label": "Allow File name to be Omitted",
"model": {
"Yes": "Yes",
"No": "No"
},
"prompt": "Allow File name to be omitted? Default: No."
},
"emitFileContent": {
"viewClass": "CheckBoxView",
"label": "Emit file content (Base64)",
"help": {
"description": "Emit file content (Base64) instead of putting it to the storage"
}
}
},
"metadata": {
"in": {
"type": "object",
"properties": {
"path": {
"title": "Path and File Name",
"type": "string"
}
}
},
"out": {
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"required": true
},
"name": {
"title": "File Name",
"type": "string",
"required": true
},
"size": {
"title": "File Size",
"type": "number",
"required": true
},
"modifyTime": {
"title": "modifyTime",
"type": "string",
"required": true
},
"accessTime": {
"title": "accessTime",
"type": "string",
"required": true
},
"directory": {
"title": "directory",
"type": "string",
"required": true
},
"path": {
"title": "path",
"type": "string",
"required": true
},
"attachment_url": {
"title": "URL in the internal storage",
"type": "string",
"required": true
},
"base64StringFromStream": {
"title": "File content in Base64",
"type": "string",
"required": false
}
}
}
}
},
"lookupObjects": {
"main": "./lib/actions/lookupObjects.js",
"title": "Download Files",
"help": {
"description": "Load list of files to attachments",
"link": "/components/sftp/actions#download-files"
},
"fields": {
"emitBehaviour": {
"viewClass": "SelectView",
"label": "Behavior",
"required": true,
"order": 50,
"model": {
"emitIndividually": "Emit Individually",
"fetchAll": "Fetch All"
},
"prompt": "Choose a Behavior type"
},
"numSearchTerms": {
"viewClass": "TextFieldView",
"label": "Number of search terms",
"required": false,
"order": 40,
"placeholder": "0",
"note": "Enter an integer number from interval: [0-99] or leave empty. Defaults to [0]"
},
"uploadFilesToAttachments": {
"viewClass": "SelectView",
"label": "Upload files to attachment",
"model": {
"Yes": "Yes",
"No": "No"
},
"order": 30,
"prompt": "Include attachments to the output message? Default: Yes."
},
"fileUploadRetry": {
"viewClass": "TextFieldView",
"label": "File Upload Retry",
"required": false,
"order": 25,
"placeholder": "5",
"help": {
"description": "How many times to retry file upload as attachment (Default: 5)"
}
},
"retryTimeout": {
"viewClass": "TextFieldView",
"label": "Retry Timeout",
"required": false,
"order": 20,
"placeholder": "10000",
"help": {
"description": "How long to wait between retry attempts in milliseconds (Default: 10000)"
}
},
"fileUploadTimeout": {
"viewClass": "TextFieldView",
"label": "File Upload Timeout",
"required": false,
"order": 15,
"placeholder": "10000",
"help": {
"description": "If file upload process will be longer than specified number of milliseconds and will not processing any data (receiving or uploading), timeout will be thrown (process will be retried if \"File Upload Retry\" set) (Default: 10000)"
}
},
"emitFileContent": {
"viewClass": "CheckBoxView",
"label": "Emit file content (Base64)",
"help": {
"description": "Emit file content (Base64)"
},
"order": 10
}
},
"dynamicMetadata": true
}
},
"triggers": {
"read": {
"main": "./lib/triggers/read.js",
"title": "Read Files",
"type": "polling",
"deprecated": true,
"help": {
"description": "Will continuously poll remote SFTP location for files that match given pattern. Found files will be transferred as attachments to the next component",
"link": "/components/sftp/triggers#read-files"
},
"fields": {
"directory": {
"viewClass": "TextFieldView",
"label": "Directory Name",
"required": true,
"placeholder": "Directory"
},
"pattern": {
"viewClass": "TextFieldView",
"label": "Pattern to Match Files",
"required": false,
"placeholder": "Pattern"
}
},
"metadata": {
"out": {
"type": "object",
"properties": {
"path": {
"title": "Full Path",
"type": "string",
"required": true
},
"size": {
"title": "File Size",
"type": "number",
"required": true
}
}
}
}
},
"pollingTrigger": {
"main": "./lib/triggers/polling.js",
"title": "Poll Files",
"type": "polling",
"help": {
"description": "Triggers to get all new and updated files since last polling",
"link": "/components/sftp/triggers#poll-files"
},
"fields": {
"directory": {
"viewClass": "TextFieldView",
"label": "Directory Name",
"required": true,
"placeholder": "Directory"
},
"pattern": {
"viewClass": "TextFieldView",
"label": "Pattern to Match Files",
"required": false,
"placeholder": "Pattern"
},
"emitBehaviour": {
"label": "Emit Behaviour",
"viewClass": "SelectView",
"required": false,
"prompt": "Default Emit Individually",
"model": {
"emitIndividually": "Emit Individually",
"fetchAll": "Fetch All"
}
},
"startTime": {
"label": "Start Time",
"viewClass": "TextFieldView",
"required": false,
"note": "Default: minimum time",
"placeholder": "Format ISO 8601: 2019-11-21T04:08:01Z"
},
"endTime": {
"label": "End Time",
"viewClass": "TextFieldView",
"required": false,
"note": "Default: maximum time",
"placeholder": "Format ISO 8601: 2019-11-21T04:08:01Z"
}
},
"metadata": {
"out": {
"type": "object",
"properties": {
"filename": {
"title": "File Name",
"type": "string",
"required": true
},
"size": {
"title": "File Size",
"type": "number",
"required": true
},
"type": {
"title": "File Type",
"type": "string",
"required": true
},
"modifyTime": {
"title": "Last Modification Time",
"type": "number",
"required": true
},
"accessTime": {
"title": "Last Access Time",
"type": "number",
"required": true
},
"directory": {
"title": "Directory",
"type": "string",
"required": true
},
"path": {
"title": "Full Path",
"type": "string",
"required": true
}
}
}
}
}
}
}