@brightdata/n8n-nodes-brightdata 1.0.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.
Files changed (32) hide show
  1. package/LICENSE.md +19 -0
  2. package/README.md +215 -0
  3. package/dist/__tests__/BrightData.node.test.d.ts +1 -0
  4. package/dist/__tests__/BrightData.node.test.js +21 -0
  5. package/dist/__tests__/BrightData.node.test.js.map +1 -0
  6. package/dist/credentials/BrightDataApi.credentials.d.ts +8 -0
  7. package/dist/credentials/BrightDataApi.credentials.js +31 -0
  8. package/dist/credentials/BrightDataApi.credentials.js.map +1 -0
  9. package/dist/nodes/BrightData/BrightData.node.d.ts +13 -0
  10. package/dist/nodes/BrightData/BrightData.node.js +703 -0
  11. package/dist/nodes/BrightData/BrightData.node.js.map +1 -0
  12. package/dist/nodes/BrightData/BrightData.node.json +18 -0
  13. package/dist/nodes/BrightData/GenericFunctions.d.ts +3 -0
  14. package/dist/nodes/BrightData/GenericFunctions.js +44 -0
  15. package/dist/nodes/BrightData/GenericFunctions.js.map +1 -0
  16. package/dist/nodes/BrightData/MarketplaceDatasetDescription.d.ts +3 -0
  17. package/dist/nodes/BrightData/MarketplaceDatasetDescription.js +1575 -0
  18. package/dist/nodes/BrightData/MarketplaceDatasetDescription.js.map +1 -0
  19. package/dist/nodes/BrightData/SearchFunctions.d.ts +4 -0
  20. package/dist/nodes/BrightData/SearchFunctions.js +36 -0
  21. package/dist/nodes/BrightData/SearchFunctions.js.map +1 -0
  22. package/dist/nodes/BrightData/WebScrapperDescription.d.ts +3 -0
  23. package/dist/nodes/BrightData/WebScrapperDescription.js +1452 -0
  24. package/dist/nodes/BrightData/WebScrapperDescription.js.map +1 -0
  25. package/dist/nodes/BrightData/WebUnlockerDescription.d.ts +3 -0
  26. package/dist/nodes/BrightData/WebUnlockerDescription.js +200 -0
  27. package/dist/nodes/BrightData/WebUnlockerDescription.js.map +1 -0
  28. package/dist/nodes/BrightData/brightdatasquared.svg +17 -0
  29. package/dist/package.json +64 -0
  30. package/dist/tsconfig.tsbuildinfo +1 -0
  31. package/index.js +0 -0
  32. package/package.json +64 -0
@@ -0,0 +1,1452 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.webScrapperFields = exports.webScrapperOperations = void 0;
4
+ exports.webScrapperOperations = [
5
+ {
6
+ displayName: 'Operation',
7
+ name: 'operation',
8
+ type: 'options',
9
+ noDataExpression: true,
10
+ displayOptions: {
11
+ show: {
12
+ resource: ['webScrapper'],
13
+ },
14
+ },
15
+ options: [
16
+ {
17
+ name: "Deliver Snapshot",
18
+ value: 'deliverSnapshot',
19
+ action: 'Deliver the snapshot content to the specified storage',
20
+ routing: {
21
+ request: {
22
+ method: 'POST',
23
+ url: '/datasets/v3/deliver/{{$parameter["snapshot_id"]}}',
24
+ },
25
+ },
26
+ },
27
+ {
28
+ name: "Download Snapshot",
29
+ value: 'downloadSnapshot',
30
+ action: 'Download the snapshot content',
31
+ routing: {
32
+ request: {
33
+ method: 'POST',
34
+ url: '/datasets/v3/snapshot/{{$parameter["snapshot_id"]}}',
35
+ },
36
+ },
37
+ },
38
+ {
39
+ name: 'Get Snapshots',
40
+ value: 'getSnapshots',
41
+ action: 'Get filtered snapshots',
42
+ routing: {
43
+ request: {
44
+ method: 'GET',
45
+ url: '/datasets/v3/snapshots',
46
+ qs: {
47
+ dataset_id: '={{$parameter["dataset_id"]}}'
48
+ },
49
+ },
50
+ },
51
+ },
52
+ {
53
+ name: 'Monitor Progress Snapshot',
54
+ value: 'monitorProgressSnapshot',
55
+ action: 'Monitor the progress of a snapshot',
56
+ routing: {
57
+ request: {
58
+ method: 'GET',
59
+ url: '/datasets/v3/progress/{{$parameter["snapshot_id"]}}',
60
+ },
61
+ },
62
+ },
63
+ {
64
+ name: 'Scrape By URL',
65
+ value: 'scrapeByUrl',
66
+ action: 'Scrape data synchronously by URL',
67
+ routing: {
68
+ request: {
69
+ method: 'POST',
70
+ url: '/datasets/v3/scrape',
71
+ qs: {
72
+ dataset_id: '={{$parameter["dataset_id"]}}'
73
+ },
74
+ },
75
+ },
76
+ },
77
+ {
78
+ name: 'Trigger Collection By URL',
79
+ value: 'triggerCollectionByUrl',
80
+ action: 'Trigger a collection and generate a snapshot by URL',
81
+ routing: {
82
+ request: {
83
+ method: 'POST',
84
+ url: '/datasets/v3/trigger',
85
+ qs: {
86
+ dataset_id: '={{$parameter["dataset_id"]}}',
87
+ },
88
+ },
89
+ },
90
+ },
91
+ ],
92
+ default: 'scrapeByUrl',
93
+ },
94
+ ];
95
+ const webScrapperParameters = [
96
+ {
97
+ displayName: 'Dataset',
98
+ name: 'dataset_id',
99
+ type: 'resourceLocator',
100
+ default: {
101
+ mode: 'list',
102
+ },
103
+ modes: [
104
+ {
105
+ displayName: 'From List',
106
+ name: 'list',
107
+ type: 'list',
108
+ placeholder: 'Select a DataSet ...',
109
+ typeOptions: {
110
+ searchListMethod: 'getDataSets',
111
+ searchable: true,
112
+ },
113
+ },
114
+ ],
115
+ required: true,
116
+ description: 'Select the DataSet',
117
+ displayOptions: {
118
+ show: {
119
+ resource: ['webScrapper'],
120
+ operation: [
121
+ 'getSnapshots',
122
+ 'scrapeByUrl',
123
+ 'triggerCollectionByUrl',
124
+ ],
125
+ },
126
+ },
127
+ },
128
+ {
129
+ displayName: 'Status',
130
+ name: 'status',
131
+ type: 'options',
132
+ default: 'ready',
133
+ displayOptions: {
134
+ show: {
135
+ resource: ['webScrapper'],
136
+ operation: ['getSnapshots'],
137
+ },
138
+ },
139
+ options: [
140
+ {
141
+ name: 'Building',
142
+ value: 'building',
143
+ },
144
+ {
145
+ name: 'Canceled',
146
+ value: 'canceled',
147
+ },
148
+ {
149
+ name: 'Collecting',
150
+ value: 'collecting',
151
+ },
152
+ {
153
+ name: 'Delivering',
154
+ value: 'delivering',
155
+ },
156
+ {
157
+ name: 'Digesting',
158
+ value: 'digesting',
159
+ },
160
+ {
161
+ name: 'Failed',
162
+ value: 'failed',
163
+ },
164
+ {
165
+ name: 'Pending Developer Review',
166
+ value: 'pending_developer_review',
167
+ },
168
+ {
169
+ name: 'Pending Discovery Input',
170
+ value: 'pending_discovery_input',
171
+ },
172
+ {
173
+ name: 'Pending Owner Review',
174
+ value: 'pending_owner_review',
175
+ },
176
+ {
177
+ name: 'Pending PDP Input',
178
+ value: 'pending_pdp_input',
179
+ },
180
+ {
181
+ name: 'Queued For Developer Review',
182
+ value: 'queued_for_developer_review',
183
+ },
184
+ {
185
+ name: 'Ready',
186
+ value: 'ready',
187
+ },
188
+ {
189
+ name: 'Rolling Back',
190
+ value: 'rolling_back',
191
+ },
192
+ {
193
+ name: 'Scheduled',
194
+ value: 'scheduled',
195
+ },
196
+ {
197
+ name: 'Validating',
198
+ value: 'validating',
199
+ },
200
+ ],
201
+ description: 'The status of the snapshot to filter the snapshots',
202
+ },
203
+ {
204
+ displayName: 'Batch Size',
205
+ name: 'batch_size',
206
+ type: 'number',
207
+ default: 1000,
208
+ displayOptions: {
209
+ show: {
210
+ resource: ['webScrapper'],
211
+ operation: ['downloadSnapshot'],
212
+ },
213
+ },
214
+ description: 'The number of records to download in each batch',
215
+ },
216
+ {
217
+ displayName: 'Part',
218
+ name: 'part',
219
+ type: 'number',
220
+ default: 1,
221
+ displayOptions: {
222
+ show: {
223
+ resource: ['webScrapper'],
224
+ operation: ['downloadSnapshot'],
225
+ },
226
+ },
227
+ description: 'The part number of the snapshot to download',
228
+ },
229
+ {
230
+ displayName: 'Skip',
231
+ name: 'skip',
232
+ type: 'number',
233
+ default: 0,
234
+ description: 'Number of snapshots to skip',
235
+ displayOptions: {
236
+ show: {
237
+ resource: ['webScrapper'],
238
+ operation: ['getSnapshots'],
239
+ },
240
+ },
241
+ routing: {
242
+ request: {
243
+ qs: {
244
+ skip: '={{$value}}',
245
+ },
246
+ },
247
+ },
248
+ },
249
+ {
250
+ displayName: 'Limit',
251
+ name: 'limit',
252
+ type: 'number',
253
+ typeOptions: {
254
+ minValue: 1,
255
+ },
256
+ default: 50,
257
+ description: 'Max number of results to return',
258
+ displayOptions: {
259
+ show: {
260
+ resource: ['webScrapper'],
261
+ operation: ['getSnapshots'],
262
+ },
263
+ },
264
+ routing: {
265
+ request: {
266
+ qs: {
267
+ limit: '={{$value}}',
268
+ },
269
+ },
270
+ },
271
+ },
272
+ {
273
+ displayName: 'From Date',
274
+ name: 'from_date',
275
+ type: 'dateTime',
276
+ default: '',
277
+ description: 'Start date to filter snapshots (ISO 8601 format)',
278
+ displayOptions: {
279
+ show: {
280
+ resource: ['webScrapper'],
281
+ operation: ['getSnapshots'],
282
+ },
283
+ },
284
+ routing: {
285
+ request: {
286
+ qs: {
287
+ from_date: '={{$value}}',
288
+ },
289
+ },
290
+ },
291
+ required: true,
292
+ },
293
+ {
294
+ displayName: 'To Date',
295
+ name: 'to_date',
296
+ type: 'dateTime',
297
+ default: '',
298
+ description: 'End date to filter snapshots (ISO 8601 format)',
299
+ displayOptions: {
300
+ show: {
301
+ resource: ['webScrapper'],
302
+ operation: ['getSnapshots'],
303
+ },
304
+ },
305
+ routing: {
306
+ request: {
307
+ qs: {
308
+ to_date: '={{$value}}',
309
+ },
310
+ },
311
+ },
312
+ required: true,
313
+ },
314
+ {
315
+ displayName: 'Snapshot ID',
316
+ name: 'snapshot_id',
317
+ type: 'string',
318
+ default: '',
319
+ displayOptions: {
320
+ show: {
321
+ resource: ['webScrapper'],
322
+ operation: [
323
+ 'monitorProgressSnapshot',
324
+ 'deliverSnapshot',
325
+ 'downloadSnapshot',
326
+ ],
327
+ },
328
+ },
329
+ required: true,
330
+ description: 'The ID of the snapshot to operate on',
331
+ },
332
+ {
333
+ displayName: 'URLs',
334
+ name: 'urls',
335
+ type: 'json',
336
+ default: '[{"url":"https://www.linkedin.com/in/bulentakar"}]',
337
+ description: 'The URLs to trigger the snapshot',
338
+ required: true,
339
+ displayOptions: {
340
+ show: {
341
+ resource: ['webScrapper'],
342
+ operation: ['triggerCollectionByUrl', 'scrapeByUrl'],
343
+ },
344
+ },
345
+ routing: {
346
+ send: {
347
+ type: 'body',
348
+ },
349
+ },
350
+ },
351
+ {
352
+ displayName: 'Include Errors',
353
+ name: 'include_errors',
354
+ type: 'boolean',
355
+ default: false,
356
+ displayOptions: {
357
+ show: {
358
+ resource: ['webScrapper'],
359
+ operation: [
360
+ 'scrapeByUrl',
361
+ ],
362
+ },
363
+ },
364
+ required: true,
365
+ description: 'Whether to include errors in the response',
366
+ },
367
+ {
368
+ displayName: 'Format',
369
+ name: 'format',
370
+ type: 'options',
371
+ options: [
372
+ {
373
+ name: 'JSON',
374
+ value: 'json',
375
+ },
376
+ {
377
+ name: 'CSV',
378
+ value: 'csv',
379
+ },
380
+ ],
381
+ default: 'json',
382
+ displayOptions: {
383
+ show: {
384
+ resource: ['webScrapper'],
385
+ operation: [
386
+ 'scrapeByUrl',
387
+ 'downloadSnapshot',
388
+ ],
389
+ },
390
+ },
391
+ description: 'The format of the data to be returned',
392
+ },
393
+ {
394
+ displayName: 'Endpoint',
395
+ name: 'endpoint',
396
+ type: 'string',
397
+ default: 'https://brightdata-test.free.beeceptor.com',
398
+ description: 'The endpoint to send the data obtained from the snapshot',
399
+ displayOptions: {
400
+ show: {
401
+ resource: ['webScrapper'],
402
+ operation: ['triggerCollectionByUrl'],
403
+ },
404
+ },
405
+ routing: {
406
+ send: {
407
+ type: 'query',
408
+ property: 'endpoint',
409
+ },
410
+ },
411
+ },
412
+ {
413
+ displayName: 'Notify',
414
+ name: 'notify',
415
+ type: 'string',
416
+ default: 'https://brightdata-test.free.beeceptor.com',
417
+ description: 'The URL to notify when the collection is finished',
418
+ displayOptions: {
419
+ show: {
420
+ resource: ['webScrapper'],
421
+ operation: ['triggerCollectionByUrl'],
422
+ },
423
+ },
424
+ routing: {
425
+ send: {
426
+ type: 'query',
427
+ property: 'notify',
428
+ },
429
+ },
430
+ },
431
+ {
432
+ displayName: 'Notify',
433
+ name: 'notify',
434
+ type: 'string',
435
+ default: '',
436
+ description: 'URL where a notification will be sent once the delivery is finished',
437
+ displayOptions: {
438
+ show: {
439
+ resource: ['webScrapper'],
440
+ operation: ['deliverSnapshot'],
441
+ },
442
+ },
443
+ routing: {
444
+ send: {
445
+ type: 'query',
446
+ property: 'notify',
447
+ },
448
+ },
449
+ },
450
+ {
451
+ displayName: 'Deliver Type',
452
+ name: 'deliver_type',
453
+ type: 'options',
454
+ options: [
455
+ {
456
+ name: 'Aliyun Object Storage Service',
457
+ value: 'ali_oss',
458
+ },
459
+ {
460
+ name: 'Amazon S3',
461
+ value: 's3',
462
+ },
463
+ {
464
+ name: 'Google Cloud PubSub',
465
+ value: 'gcs_pubsub',
466
+ },
467
+ {
468
+ name: 'Google Cloud Storage',
469
+ value: 'gcs',
470
+ },
471
+ {
472
+ name: 'Microsoft Azure',
473
+ value: 'azure',
474
+ },
475
+ {
476
+ name: 'SFTP',
477
+ value: 'sftp',
478
+ },
479
+ {
480
+ name: 'Snowflake',
481
+ value: 'snowflake',
482
+ },
483
+ {
484
+ name: 'Webhook',
485
+ value: 'webhook',
486
+ },
487
+ ],
488
+ default: 's3',
489
+ displayOptions: {
490
+ show: {
491
+ resource: ['webScrapper'],
492
+ operation: ['deliverSnapshot'],
493
+ },
494
+ },
495
+ routing: {
496
+ request: {
497
+ body: {
498
+ deliver: {
499
+ type: '={{$parameter["deliver_type"]}}',
500
+ },
501
+ },
502
+ },
503
+ },
504
+ },
505
+ {
506
+ displayName: 'Webhook Endpoint',
507
+ name: 'endpoint',
508
+ type: 'string',
509
+ default: '',
510
+ description: 'Webhook URL to deliver the snapshot',
511
+ displayOptions: {
512
+ show: {
513
+ resource: ['webScrapper'],
514
+ operation: ['deliverSnapshot'],
515
+ deliver_type: ['webhook'],
516
+ },
517
+ },
518
+ routing: {
519
+ request: {
520
+ body: {
521
+ deliver: {
522
+ endpoint: '={{$parameter["endpoint"]}}',
523
+ },
524
+ },
525
+ },
526
+ },
527
+ },
528
+ {
529
+ displayName: 'Filename Template',
530
+ name: 'filename_template',
531
+ type: 'string',
532
+ default: '',
533
+ description: 'Template for the filename, including placeholders',
534
+ displayOptions: {
535
+ show: {
536
+ resource: ['webScrapper'],
537
+ operation: ['deliverSnapshot'],
538
+ deliver_type: [
539
+ 'webhook',
540
+ 'ali_oss',
541
+ 'gcs_pubsub',
542
+ 'gcs',
543
+ 's3',
544
+ 'azure',
545
+ 'sftp',
546
+ 'snowflake',
547
+ ],
548
+ },
549
+ },
550
+ routing: {
551
+ request: {
552
+ body: {
553
+ deliver: {
554
+ filename: {
555
+ template: '={{$parameter["filename_template"]}}',
556
+ },
557
+ },
558
+ },
559
+ },
560
+ },
561
+ required: true,
562
+ },
563
+ {
564
+ displayName: 'File Extension',
565
+ name: 'filename_extension',
566
+ type: 'options',
567
+ options: [
568
+ {
569
+ name: 'JSON',
570
+ value: 'json',
571
+ },
572
+ {
573
+ name: 'JSONL',
574
+ value: 'jsonl',
575
+ },
576
+ {
577
+ name: 'CSV',
578
+ value: 'csv',
579
+ },
580
+ ],
581
+ default: 'json',
582
+ description: 'Extension for the delivered file (JSON, JSONL, CSV)',
583
+ displayOptions: {
584
+ show: {
585
+ resource: ['webScrapper'],
586
+ operation: ['deliverSnapshot'],
587
+ deliver_type: [
588
+ 'webhook',
589
+ 'ali_oss',
590
+ 'gcs_pubsub',
591
+ 'gcs',
592
+ 's3',
593
+ 'azure',
594
+ 'sftp',
595
+ 'snowflake',
596
+ ],
597
+ },
598
+ },
599
+ routing: {
600
+ request: {
601
+ body: {
602
+ deliver: {
603
+ type: 'webhook',
604
+ filename: {
605
+ extension: '={{$parameter["filename_extension"]}}',
606
+ },
607
+ },
608
+ },
609
+ },
610
+ },
611
+ required: true,
612
+ },
613
+ {
614
+ displayName: 'Topic ID',
615
+ name: 'topic_id',
616
+ type: 'string',
617
+ default: '',
618
+ description: 'Google PubSub topic ID',
619
+ displayOptions: {
620
+ show: {
621
+ resource: ['webScrapper'],
622
+ operation: ['deliverSnapshot'],
623
+ deliver_type: ['gcs_pubsub'],
624
+ },
625
+ },
626
+ routing: {
627
+ request: {
628
+ body: {
629
+ deliver: {
630
+ topic_id: '={{$parameter["topic_id"]}}',
631
+ },
632
+ },
633
+ },
634
+ },
635
+ required: true,
636
+ },
637
+ {
638
+ displayName: 'Client Email',
639
+ name: 'client_email',
640
+ type: 'string',
641
+ default: '',
642
+ displayOptions: {
643
+ show: {
644
+ resource: ['webScrapper'],
645
+ operation: ['deliverSnapshot'],
646
+ deliver_type: ['gcs_pubsub', 'gcs'],
647
+ },
648
+ },
649
+ routing: {
650
+ request: {
651
+ body: {
652
+ deliver: {
653
+ credentials: {
654
+ client_email: '={{$parameter["client_email"]}}',
655
+ },
656
+ },
657
+ },
658
+ },
659
+ },
660
+ required: true,
661
+ },
662
+ {
663
+ displayName: 'Private Key',
664
+ name: 'private_key',
665
+ type: 'string',
666
+ typeOptions: {
667
+ password: true,
668
+ },
669
+ default: '',
670
+ displayOptions: {
671
+ show: {
672
+ resource: ['webScrapper'],
673
+ operation: ['deliverSnapshot'],
674
+ deliver_type: ['gcs_pubsub', 'gcs'],
675
+ },
676
+ },
677
+ routing: {
678
+ request: {
679
+ body: {
680
+ deliver: {
681
+ credentials: {
682
+ private_key: '={{$parameter["private_key"]}}',
683
+ },
684
+ },
685
+ },
686
+ },
687
+ },
688
+ required: true,
689
+ },
690
+ {
691
+ displayName: 'Attributes',
692
+ name: 'attributes',
693
+ type: 'json',
694
+ default: '',
695
+ description: 'Attributes to include in the PubSub message',
696
+ displayOptions: {
697
+ show: {
698
+ resource: ['webScrapper'],
699
+ operation: ['deliverSnapshot'],
700
+ deliver_type: ['gcs_pubsub'],
701
+ },
702
+ },
703
+ routing: {
704
+ request: {
705
+ body: {
706
+ deliver: {
707
+ attributes: '={{$parameter["attributes"]}}',
708
+ },
709
+ },
710
+ },
711
+ },
712
+ },
713
+ {
714
+ displayName: 'Container',
715
+ name: 'container',
716
+ type: 'string',
717
+ default: '',
718
+ description: 'Name of the Azure container',
719
+ displayOptions: {
720
+ show: {
721
+ resource: ['webScrapper'],
722
+ operation: ['deliverSnapshot'],
723
+ deliver_type: ['azure'],
724
+ },
725
+ },
726
+ routing: {
727
+ request: {
728
+ body: {
729
+ deliver: {
730
+ container: '={{$parameter["container"]}}',
731
+ },
732
+ },
733
+ },
734
+ },
735
+ required: true,
736
+ },
737
+ {
738
+ displayName: 'Bucket',
739
+ name: 'bucket',
740
+ type: 'string',
741
+ default: '',
742
+ description: 'Name of the bucket',
743
+ displayOptions: {
744
+ show: {
745
+ resource: ['webScrapper'],
746
+ operation: ['deliverSnapshot'],
747
+ deliver_type: ['s3', 'ali_oss', 'gcs'],
748
+ },
749
+ },
750
+ routing: {
751
+ request: {
752
+ body: {
753
+ deliver: {
754
+ bucket: '={{$parameter["bucket"]}}',
755
+ },
756
+ },
757
+ },
758
+ },
759
+ required: true,
760
+ },
761
+ {
762
+ displayName: 'AWS Access Key',
763
+ name: 'aws-access-key',
764
+ type: 'string',
765
+ default: '',
766
+ displayOptions: {
767
+ show: {
768
+ resource: ['webScrapper'],
769
+ operation: ['deliverSnapshot'],
770
+ deliver_type: ['s3'],
771
+ },
772
+ },
773
+ description: 'AWS Access Key ID',
774
+ routing: {
775
+ request: {
776
+ body: {
777
+ deliver: {
778
+ credentials: {
779
+ 'aws-access-key': '={{$parameter["aws-access-key"]}}',
780
+ },
781
+ },
782
+ },
783
+ },
784
+ },
785
+ required: true,
786
+ },
787
+ {
788
+ displayName: 'AWS Secret Key',
789
+ name: 'aws-secret-key',
790
+ type: 'string',
791
+ typeOptions: {
792
+ password: true,
793
+ },
794
+ default: '',
795
+ displayOptions: {
796
+ show: {
797
+ resource: ['webScrapper'],
798
+ operation: ['deliverSnapshot'],
799
+ deliver_type: ['s3'],
800
+ },
801
+ },
802
+ description: 'AWS Secret Access Key',
803
+ routing: {
804
+ request: {
805
+ body: {
806
+ deliver: {
807
+ credentials: {
808
+ 'aws-secret-key': '={{$parameter["aws-secret-key"]}}',
809
+ },
810
+ },
811
+ },
812
+ },
813
+ },
814
+ required: true,
815
+ },
816
+ {
817
+ displayName: 'Access Key',
818
+ name: 'aws-access-key',
819
+ type: 'string',
820
+ default: '',
821
+ displayOptions: {
822
+ show: {
823
+ resource: ['webScrapper'],
824
+ operation: ['deliverSnapshot'],
825
+ deliver_type: ['ali_oss'],
826
+ },
827
+ },
828
+ routing: {
829
+ request: {
830
+ body: {
831
+ deliver: {
832
+ credentials: {
833
+ 'access-key': '={{$parameter["access-key"]}}',
834
+ },
835
+ },
836
+ },
837
+ },
838
+ },
839
+ required: true,
840
+ },
841
+ {
842
+ displayName: 'Secret Key',
843
+ name: 'secret-key',
844
+ type: 'string',
845
+ typeOptions: {
846
+ password: true,
847
+ },
848
+ default: '',
849
+ displayOptions: {
850
+ show: {
851
+ resource: ['webScrapper'],
852
+ operation: ['deliverSnapshot'],
853
+ deliver_type: ['ali_oss'],
854
+ },
855
+ },
856
+ routing: {
857
+ request: {
858
+ body: {
859
+ deliver: {
860
+ credentials: {
861
+ 'secret-key': '={{$parameter["secret-key"]}}',
862
+ },
863
+ },
864
+ },
865
+ },
866
+ },
867
+ required: true,
868
+ },
869
+ {
870
+ displayName: 'Account',
871
+ name: 'account',
872
+ type: 'string',
873
+ default: '',
874
+ description: 'Azure storage account',
875
+ displayOptions: {
876
+ show: {
877
+ resource: ['webScrapper'],
878
+ operation: ['deliverSnapshot'],
879
+ deliver_type: ['azure'],
880
+ },
881
+ },
882
+ routing: {
883
+ request: {
884
+ body: {
885
+ deliver: {
886
+ credentials: {
887
+ account: '={{$parameter["account"]}}',
888
+ },
889
+ },
890
+ },
891
+ },
892
+ },
893
+ required: true,
894
+ },
895
+ {
896
+ displayName: 'Key',
897
+ name: 'key',
898
+ type: 'string',
899
+ typeOptions: {
900
+ password: true,
901
+ },
902
+ default: '',
903
+ description: 'Azure storage key',
904
+ displayOptions: {
905
+ show: {
906
+ resource: ['webScrapper'],
907
+ operation: ['deliverSnapshot'],
908
+ deliver_type: ['azure'],
909
+ },
910
+ },
911
+ routing: {
912
+ request: {
913
+ body: {
914
+ deliver: {
915
+ credentials: {
916
+ key: '={{$parameter["key"]}}',
917
+ },
918
+ },
919
+ },
920
+ },
921
+ },
922
+ required: true,
923
+ },
924
+ {
925
+ displayName: 'SAS Token',
926
+ name: 'sas_token',
927
+ type: 'string',
928
+ typeOptions: {
929
+ password: true,
930
+ },
931
+ default: '',
932
+ description: 'Azure SAS token for access',
933
+ displayOptions: {
934
+ show: {
935
+ resource: ['webScrapper'],
936
+ operation: ['deliverSnapshot'],
937
+ deliver_type: ['azure'],
938
+ },
939
+ },
940
+ routing: {
941
+ request: {
942
+ body: {
943
+ deliver: {
944
+ credentials: {
945
+ sas_token: '={{$parameter["sas_token"]}}',
946
+ },
947
+ },
948
+ },
949
+ },
950
+ },
951
+ required: true,
952
+ },
953
+ {
954
+ displayName: 'Role ARN',
955
+ name: 'role_arn',
956
+ type: 'string',
957
+ default: '',
958
+ displayOptions: {
959
+ show: {
960
+ resource: ['webScrapper'],
961
+ operation: ['deliverSnapshot'],
962
+ deliver_type: ['s3'],
963
+ },
964
+ },
965
+ routing: {
966
+ request: {
967
+ body: {
968
+ deliver: {
969
+ credentials: {
970
+ role_arn: '={{$parameter["role_arn"]}}',
971
+ },
972
+ },
973
+ },
974
+ },
975
+ },
976
+ },
977
+ {
978
+ displayName: 'External ID',
979
+ name: 'external_id',
980
+ type: 'string',
981
+ default: '',
982
+ displayOptions: {
983
+ show: {
984
+ resource: ['webScrapper'],
985
+ operation: ['deliverSnapshot'],
986
+ deliver_type: ['s3'],
987
+ },
988
+ },
989
+ routing: {
990
+ request: {
991
+ body: {
992
+ deliver: {
993
+ credentials: {
994
+ external_id: '={{$parameter["external_id"]}}',
995
+ },
996
+ },
997
+ },
998
+ },
999
+ },
1000
+ },
1001
+ {
1002
+ displayName: 'Directory',
1003
+ name: 'directory',
1004
+ type: 'string',
1005
+ default: '',
1006
+ description: 'Target path',
1007
+ displayOptions: {
1008
+ show: {
1009
+ resource: ['webScrapper'],
1010
+ operation: ['deliverSnapshot'],
1011
+ deliver_type: ['s3', 'ali_oss', 'gcs', 'azure', 'sftp', 'snowflake'],
1012
+ },
1013
+ },
1014
+ routing: {
1015
+ request: {
1016
+ body: {
1017
+ deliver: {
1018
+ directory: '={{$parameter["directory"]}}',
1019
+ },
1020
+ },
1021
+ },
1022
+ },
1023
+ },
1024
+ {
1025
+ displayName: 'Region',
1026
+ name: 'region',
1027
+ type: 'string',
1028
+ default: '',
1029
+ description: 'AWS Region',
1030
+ displayOptions: {
1031
+ show: {
1032
+ resource: ['webScrapper'],
1033
+ operation: ['deliverSnapshot'],
1034
+ deliver_type: ['s3', 'ali_oss'],
1035
+ },
1036
+ },
1037
+ routing: {
1038
+ request: {
1039
+ body: {
1040
+ deliver: {
1041
+ region: '={{$parameter["region"]}}',
1042
+ },
1043
+ },
1044
+ },
1045
+ },
1046
+ },
1047
+ {
1048
+ displayName: 'Host',
1049
+ name: 'host',
1050
+ type: 'string',
1051
+ default: '',
1052
+ description: 'SFTP server host',
1053
+ displayOptions: {
1054
+ show: {
1055
+ resource: ['webScrapper'],
1056
+ operation: ['deliverSnapshot'],
1057
+ deliver_type: ['sftp'],
1058
+ },
1059
+ },
1060
+ routing: {
1061
+ request: {
1062
+ body: {
1063
+ deliver: {
1064
+ host: '={{$parameter["host"]}}',
1065
+ },
1066
+ },
1067
+ },
1068
+ },
1069
+ required: true,
1070
+ },
1071
+ {
1072
+ displayName: 'Port',
1073
+ name: 'port',
1074
+ type: 'number',
1075
+ default: 22,
1076
+ description: 'SFTP server port',
1077
+ displayOptions: {
1078
+ show: {
1079
+ resource: ['webScrapper'],
1080
+ operation: ['deliverSnapshot'],
1081
+ deliver_type: ['sftp'],
1082
+ },
1083
+ },
1084
+ routing: {
1085
+ request: {
1086
+ body: {
1087
+ deliver: {
1088
+ port: '={{$parameter["port"]}}',
1089
+ },
1090
+ },
1091
+ },
1092
+ },
1093
+ },
1094
+ {
1095
+ displayName: 'Path',
1096
+ name: 'path',
1097
+ type: 'string',
1098
+ default: '',
1099
+ description: 'Remote path on the SFTP server to store the file',
1100
+ displayOptions: {
1101
+ show: {
1102
+ resource: ['webScrapper'],
1103
+ operation: ['deliverSnapshot'],
1104
+ deliver_type: ['sftp'],
1105
+ },
1106
+ },
1107
+ routing: {
1108
+ request: {
1109
+ body: {
1110
+ deliver: {
1111
+ path: '={{$parameter["path"]}}',
1112
+ },
1113
+ },
1114
+ },
1115
+ },
1116
+ },
1117
+ {
1118
+ displayName: 'Username',
1119
+ name: 'username',
1120
+ type: 'string',
1121
+ default: '',
1122
+ description: 'SFTP username',
1123
+ displayOptions: {
1124
+ show: {
1125
+ resource: ['webScrapper'],
1126
+ operation: ['deliverSnapshot'],
1127
+ deliver_type: ['sftp'],
1128
+ },
1129
+ },
1130
+ routing: {
1131
+ request: {
1132
+ body: {
1133
+ deliver: {
1134
+ credentials: {
1135
+ username: '={{$parameter["username"]}}',
1136
+ },
1137
+ },
1138
+ },
1139
+ },
1140
+ },
1141
+ required: true,
1142
+ },
1143
+ {
1144
+ displayName: 'Password',
1145
+ name: 'password',
1146
+ type: 'string',
1147
+ typeOptions: {
1148
+ password: true,
1149
+ },
1150
+ default: '',
1151
+ description: 'SFTP password',
1152
+ displayOptions: {
1153
+ show: {
1154
+ resource: ['webScrapper'],
1155
+ operation: ['deliverSnapshot'],
1156
+ deliver_type: ['sftp'],
1157
+ },
1158
+ },
1159
+ routing: {
1160
+ request: {
1161
+ body: {
1162
+ deliver: {
1163
+ credentials: {
1164
+ password: '={{$parameter["password"]}}',
1165
+ },
1166
+ },
1167
+ },
1168
+ },
1169
+ },
1170
+ required: true,
1171
+ },
1172
+ {
1173
+ displayName: 'SSH Key',
1174
+ name: 'ssh_key',
1175
+ type: 'string',
1176
+ typeOptions: {
1177
+ password: true,
1178
+ },
1179
+ default: '',
1180
+ description: 'SSH key for SFTP authentication',
1181
+ displayOptions: {
1182
+ show: {
1183
+ resource: ['webScrapper'],
1184
+ operation: ['deliverSnapshot'],
1185
+ deliver_type: ['sftp'],
1186
+ },
1187
+ },
1188
+ routing: {
1189
+ request: {
1190
+ body: {
1191
+ deliver: {
1192
+ credentials: {
1193
+ ssh_key: '={{$parameter["ssh_key"]}}',
1194
+ },
1195
+ },
1196
+ },
1197
+ },
1198
+ },
1199
+ required: true,
1200
+ },
1201
+ {
1202
+ displayName: 'Passphrase',
1203
+ name: 'passphrase',
1204
+ type: 'string',
1205
+ typeOptions: {
1206
+ password: true,
1207
+ },
1208
+ default: '',
1209
+ description: 'Passphrase for the SSH key, if any',
1210
+ displayOptions: {
1211
+ show: {
1212
+ resource: ['webScrapper'],
1213
+ operation: ['deliverSnapshot'],
1214
+ deliver_type: ['sftp'],
1215
+ },
1216
+ },
1217
+ routing: {
1218
+ request: {
1219
+ body: {
1220
+ deliver: {
1221
+ credentials: {
1222
+ passphrase: '={{$parameter["passphrase"]}}',
1223
+ },
1224
+ },
1225
+ },
1226
+ },
1227
+ },
1228
+ },
1229
+ {
1230
+ displayName: 'Database',
1231
+ name: 'database',
1232
+ type: 'string',
1233
+ default: '',
1234
+ displayOptions: {
1235
+ show: {
1236
+ resource: ['webScrapper'],
1237
+ operation: ['deliverSnapshot'],
1238
+ deliver_type: ['snowflake'],
1239
+ },
1240
+ },
1241
+ routing: {
1242
+ request: {
1243
+ body: {
1244
+ deliver: {
1245
+ database: '={{$parameter["database"]}}',
1246
+ },
1247
+ },
1248
+ },
1249
+ },
1250
+ required: true,
1251
+ description: 'Snowflake database name',
1252
+ },
1253
+ {
1254
+ displayName: 'Schema',
1255
+ name: 'schema',
1256
+ type: 'string',
1257
+ default: '',
1258
+ displayOptions: {
1259
+ show: {
1260
+ resource: ['webScrapper'],
1261
+ operation: ['deliverSnapshot'],
1262
+ deliver_type: ['snowflake'],
1263
+ },
1264
+ },
1265
+ routing: {
1266
+ request: {
1267
+ body: {
1268
+ deliver: {
1269
+ schema: '={{$parameter["schema"]}}',
1270
+ },
1271
+ },
1272
+ },
1273
+ },
1274
+ required: true,
1275
+ description: 'Snowflake schema name',
1276
+ },
1277
+ {
1278
+ displayName: 'Stage',
1279
+ name: 'stage',
1280
+ type: 'string',
1281
+ default: '',
1282
+ displayOptions: {
1283
+ show: {
1284
+ resource: ['webScrapper'],
1285
+ operation: ['deliverSnapshot'],
1286
+ deliver_type: ['snowflake'],
1287
+ },
1288
+ },
1289
+ routing: {
1290
+ request: {
1291
+ body: {
1292
+ deliver: {
1293
+ stage: '={{$parameter["stage"]}}',
1294
+ },
1295
+ },
1296
+ },
1297
+ },
1298
+ required: true,
1299
+ description: 'Snowflake stage name',
1300
+ },
1301
+ {
1302
+ displayName: 'Role',
1303
+ name: 'role',
1304
+ type: 'string',
1305
+ default: '',
1306
+ displayOptions: {
1307
+ show: {
1308
+ resource: ['webScrapper'],
1309
+ operation: ['deliverSnapshot'],
1310
+ deliver_type: ['snowflake'],
1311
+ },
1312
+ },
1313
+ routing: {
1314
+ request: {
1315
+ body: {
1316
+ deliver: {
1317
+ role: '={{$parameter["role"]}}',
1318
+ },
1319
+ },
1320
+ },
1321
+ },
1322
+ required: true,
1323
+ description: 'Snowflake role',
1324
+ },
1325
+ {
1326
+ displayName: 'Warehouse',
1327
+ name: 'warehouse',
1328
+ type: 'string',
1329
+ default: '',
1330
+ displayOptions: {
1331
+ show: {
1332
+ resource: ['webScrapper'],
1333
+ operation: ['deliverSnapshot'],
1334
+ deliver_type: ['snowflake'],
1335
+ },
1336
+ },
1337
+ routing: {
1338
+ request: {
1339
+ body: {
1340
+ deliver: {
1341
+ warehouse: '={{$parameter["warehouse"]}}',
1342
+ },
1343
+ },
1344
+ },
1345
+ },
1346
+ required: true,
1347
+ description: 'Snowflake warehouse',
1348
+ },
1349
+ {
1350
+ displayName: 'Account',
1351
+ name: 'credentials.account',
1352
+ type: 'string',
1353
+ default: '',
1354
+ displayOptions: {
1355
+ show: {
1356
+ resource: ['webScrapper'],
1357
+ operation: ['deliverSnapshot'],
1358
+ deliver_type: ['snowflake'],
1359
+ },
1360
+ },
1361
+ routing: {
1362
+ request: {
1363
+ body: {
1364
+ deliver: {
1365
+ credentials: {
1366
+ account: '={{$parameter["credentials.account"]}}',
1367
+ },
1368
+ },
1369
+ },
1370
+ },
1371
+ },
1372
+ required: true,
1373
+ description: 'Snowflake account',
1374
+ },
1375
+ {
1376
+ displayName: 'User',
1377
+ name: 'credentials.user',
1378
+ type: 'string',
1379
+ default: '',
1380
+ displayOptions: {
1381
+ show: {
1382
+ resource: ['webScrapper'],
1383
+ operation: ['deliverSnapshot'],
1384
+ deliver_type: ['snowflake'],
1385
+ },
1386
+ },
1387
+ routing: {
1388
+ request: {
1389
+ body: {
1390
+ deliver: {
1391
+ credentials: {
1392
+ user: '={{$parameter["credentials.user"]}}',
1393
+ },
1394
+ },
1395
+ },
1396
+ },
1397
+ },
1398
+ required: true,
1399
+ description: 'Snowflake user',
1400
+ },
1401
+ {
1402
+ displayName: 'Password',
1403
+ name: 'credentials.password',
1404
+ type: 'string',
1405
+ typeOptions: {
1406
+ password: true,
1407
+ },
1408
+ default: '',
1409
+ displayOptions: {
1410
+ show: {
1411
+ resource: ['webScrapper'],
1412
+ operation: ['deliverSnapshot'],
1413
+ deliver_type: ['snowflake'],
1414
+ },
1415
+ },
1416
+ routing: {
1417
+ request: {
1418
+ body: {
1419
+ deliver: {
1420
+ credentials: {
1421
+ password: '={{$parameter["credentials.password"]}}',
1422
+ },
1423
+ },
1424
+ },
1425
+ },
1426
+ },
1427
+ required: true,
1428
+ description: 'Snowflake password',
1429
+ },
1430
+ {
1431
+ displayName: 'Compress',
1432
+ name: 'compress',
1433
+ type: 'boolean',
1434
+ default: false,
1435
+ description: 'Whether compress the response in gzip format',
1436
+ displayOptions: {
1437
+ show: {
1438
+ resource: ['webScrapper'],
1439
+ operation: ['deliverSnapshot', 'downloadSnapshot'],
1440
+ },
1441
+ },
1442
+ routing: {
1443
+ request: {
1444
+ body: {
1445
+ compress: '={{$parameter["compress"]}}',
1446
+ },
1447
+ },
1448
+ },
1449
+ },
1450
+ ];
1451
+ exports.webScrapperFields = [...webScrapperParameters];
1452
+ //# sourceMappingURL=WebScrapperDescription.js.map