@nimble-way/nimble-js 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.
Files changed (48) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/client.d.mts +4 -1
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +4 -1
  5. package/client.d.ts.map +1 -1
  6. package/client.js +4 -1
  7. package/client.js.map +1 -1
  8. package/client.mjs +4 -1
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/batches.d.mts +140 -0
  12. package/resources/batches.d.mts.map +1 -0
  13. package/resources/batches.d.ts +140 -0
  14. package/resources/batches.d.ts.map +1 -0
  15. package/resources/batches.js +33 -0
  16. package/resources/batches.js.map +1 -0
  17. package/resources/batches.mjs +29 -0
  18. package/resources/batches.mjs.map +1 -0
  19. package/resources/crawl.d.mts +1 -1
  20. package/resources/crawl.d.mts.map +1 -1
  21. package/resources/crawl.d.ts +1 -1
  22. package/resources/crawl.d.ts.map +1 -1
  23. package/resources/index.d.mts +1 -0
  24. package/resources/index.d.mts.map +1 -1
  25. package/resources/index.d.ts +1 -0
  26. package/resources/index.d.ts.map +1 -1
  27. package/resources/index.js +3 -1
  28. package/resources/index.js.map +1 -1
  29. package/resources/index.mjs +1 -0
  30. package/resources/index.mjs.map +1 -1
  31. package/resources/top-level.d.mts +201 -22
  32. package/resources/top-level.d.mts.map +1 -1
  33. package/resources/top-level.d.ts +201 -22
  34. package/resources/top-level.d.ts.map +1 -1
  35. package/src/client.ts +10 -1
  36. package/src/resources/batches.ts +185 -0
  37. package/src/resources/crawl.ts +1 -1
  38. package/src/resources/index.ts +1 -0
  39. package/src/resources/top-level.ts +1130 -31
  40. package/src/version.ts +1 -1
  41. package/version.d.mts +1 -1
  42. package/version.d.mts.map +1 -1
  43. package/version.d.ts +1 -1
  44. package/version.d.ts.map +1 -1
  45. package/version.js +1 -1
  46. package/version.js.map +1 -1
  47. package/version.mjs +1 -1
  48. package/version.mjs.map +1 -1
@@ -986,7 +986,7 @@ export interface ExtractParams {
986
986
  /**
987
987
  * List of acceptable response formats in order of preference
988
988
  */
989
- formats?: Array<'html' | 'markdown' | 'screenshot'>;
989
+ formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
990
990
 
991
991
  /**
992
992
  * Custom HTTP headers to include in the request
@@ -2067,7 +2067,7 @@ export interface ExtractAsyncParams {
2067
2067
  /**
2068
2068
  * List of acceptable response formats in order of preference
2069
2069
  */
2070
- formats?: Array<'html' | 'markdown' | 'screenshot'>;
2070
+ formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
2071
2071
 
2072
2072
  /**
2073
2073
  * Custom HTTP headers to include in the request
@@ -2846,29 +2846,24 @@ export namespace ExtractAsyncParams {
2846
2846
 
2847
2847
  export interface ExtractBatchParams {
2848
2848
  /**
2849
- * Array of extraction requests. Each object represents one extraction with its own
2850
- * parameters.
2849
+ * Array of extraction requests. Each object can include extraction parameters and
2850
+ * async/storage settings.
2851
2851
  */
2852
- params: Array<ExtractBatchParams.Param>;
2852
+ inputs: Array<ExtractBatchParams.Input>;
2853
2853
 
2854
2854
  /**
2855
- * Shared parameters applied to the entire batch, such as storage and callback
2856
- * configuration.
2855
+ * Shared parameters applied to the entire batch. Can include extraction parameters
2856
+ * and async/storage settings.
2857
2857
  */
2858
- shared_params?: ExtractBatchParams.SharedParams;
2858
+ shared_inputs?: ExtractBatchParams.SharedInputs;
2859
2859
  }
2860
2860
 
2861
2861
  export namespace ExtractBatchParams {
2862
- export interface Param {
2863
- /**
2864
- * Target URL to scrape
2865
- */
2866
- url: string;
2867
-
2862
+ export interface Input {
2868
2863
  /**
2869
2864
  * Browser type to emulate
2870
2865
  */
2871
- browser?: 'chrome' | 'firefox' | Param.UnionMember1;
2866
+ browser?: 'chrome' | 'firefox' | Input.UnionMember1;
2872
2867
 
2873
2868
  /**
2874
2869
  * Array of browser automation actions to execute sequentially
@@ -2889,6 +2884,11 @@ export namespace ExtractBatchParams {
2889
2884
  | Shared.WaitForNavigationAction
2890
2885
  >;
2891
2886
 
2887
+ /**
2888
+ * URL to call back when async operation completes
2889
+ */
2890
+ callback_url?: string;
2891
+
2892
2892
  /**
2893
2893
  * City for geolocation
2894
2894
  */
@@ -2902,7 +2902,7 @@ export namespace ExtractBatchParams {
2902
2902
  /**
2903
2903
  * Browser cookies as array of cookie objects
2904
2904
  */
2905
- cookies?: Array<Param.UnionMember0> | string;
2905
+ cookies?: Array<Input.UnionMember0> | string;
2906
2906
 
2907
2907
  /**
2908
2908
  * Country code for geolocation and proxy selection
@@ -3178,7 +3178,7 @@ export namespace ExtractBatchParams {
3178
3178
  /**
3179
3179
  * List of acceptable response formats in order of preference
3180
3180
  */
3181
- formats?: Array<'html' | 'markdown' | 'screenshot'>;
3181
+ formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
3182
3182
 
3183
3183
  /**
3184
3184
  * Custom HTTP headers to include in the request
@@ -3741,7 +3741,7 @@ export namespace ExtractBatchParams {
3741
3741
  /**
3742
3742
  * Filters for capturing network traffic
3743
3743
  */
3744
- network_capture?: Array<Param.NetworkCapture>;
3744
+ network_capture?: Array<Input.NetworkCapture>;
3745
3745
 
3746
3746
  /**
3747
3747
  * Operating system to emulate
@@ -3781,7 +3781,7 @@ export namespace ExtractBatchParams {
3781
3781
  */
3782
3782
  request_timeout?: number;
3783
3783
 
3784
- session?: Param.Session;
3784
+ session?: Input.Session;
3785
3785
 
3786
3786
  /**
3787
3787
  * Skills or capabilities required for the request
@@ -3849,13 +3849,38 @@ export namespace ExtractBatchParams {
3849
3849
  | 'WI'
3850
3850
  | 'WY';
3851
3851
 
3852
+ /**
3853
+ * Whether to compress stored data
3854
+ */
3855
+ storage_compress?: boolean;
3856
+
3857
+ /**
3858
+ * Custom name for the stored object
3859
+ */
3860
+ storage_object_name?: string;
3861
+
3862
+ /**
3863
+ * Type of storage to use for results
3864
+ */
3865
+ storage_type?: string;
3866
+
3867
+ /**
3868
+ * URL for storage location
3869
+ */
3870
+ storage_url?: string;
3871
+
3852
3872
  /**
3853
3873
  * User-defined tag for request identification
3854
3874
  */
3855
3875
  tag?: string;
3876
+
3877
+ /**
3878
+ * Target URL to scrape
3879
+ */
3880
+ url?: string;
3856
3881
  }
3857
3882
 
3858
- export namespace Param {
3883
+ export namespace Input {
3859
3884
  export interface UnionMember1 {
3860
3885
  name: 'chrome' | 'firefox';
3861
3886
 
@@ -3936,34 +3961,1108 @@ export namespace ExtractBatchParams {
3936
3961
  }
3937
3962
 
3938
3963
  /**
3939
- * Shared parameters applied to the entire batch, such as storage and callback
3940
- * configuration.
3964
+ * Shared parameters applied to the entire batch. Can include extraction parameters
3965
+ * and async/storage settings.
3941
3966
  */
3942
- export interface SharedParams {
3967
+ export interface SharedInputs {
3968
+ /**
3969
+ * Browser type to emulate
3970
+ */
3971
+ browser?: 'chrome' | 'firefox' | SharedInputs.UnionMember1;
3972
+
3973
+ /**
3974
+ * Array of browser automation actions to execute sequentially
3975
+ */
3976
+ browser_actions?: Array<
3977
+ | Shared.AutoScrollAction
3978
+ | Shared.ClickAction
3979
+ | Shared.EvalAction
3980
+ | Shared.FetchAction
3981
+ | Shared.FillAction
3982
+ | Shared.GetCookiesAction
3983
+ | Shared.GotoAction
3984
+ | Shared.PressAction
3985
+ | Shared.ScreenshotAction
3986
+ | Shared.ScrollAction
3987
+ | Shared.WaitAction
3988
+ | Shared.WaitForElementAction
3989
+ | Shared.WaitForNavigationAction
3990
+ >;
3991
+
3943
3992
  /**
3944
3993
  * URL to call back when async operation completes
3945
3994
  */
3946
3995
  callback_url?: string;
3947
3996
 
3948
3997
  /**
3949
- * Whether to compress stored data
3998
+ * City for geolocation
3950
3999
  */
3951
- storage_compress?: boolean;
4000
+ city?: string;
3952
4001
 
3953
4002
  /**
3954
- * Custom name for the stored object
4003
+ * Whether to automatically handle cookie consent headers
3955
4004
  */
3956
- storage_object_name?: string;
4005
+ consent_header?: boolean;
3957
4006
 
3958
4007
  /**
3959
- * Type of storage to use for results
4008
+ * Browser cookies as array of cookie objects
3960
4009
  */
3961
- storage_type?: string;
4010
+ cookies?: Array<SharedInputs.UnionMember0> | string;
3962
4011
 
3963
4012
  /**
3964
- * URL for storage location
4013
+ * Country code for geolocation and proxy selection
3965
4014
  */
3966
- storage_url?: string;
4015
+ country?:
4016
+ | 'AD'
4017
+ | 'AE'
4018
+ | 'AF'
4019
+ | 'AG'
4020
+ | 'AI'
4021
+ | 'AL'
4022
+ | 'AM'
4023
+ | 'AO'
4024
+ | 'AQ'
4025
+ | 'AR'
4026
+ | 'AS'
4027
+ | 'AT'
4028
+ | 'AU'
4029
+ | 'AW'
4030
+ | 'AX'
4031
+ | 'AZ'
4032
+ | 'BA'
4033
+ | 'BB'
4034
+ | 'BD'
4035
+ | 'BE'
4036
+ | 'BF'
4037
+ | 'BG'
4038
+ | 'BH'
4039
+ | 'BI'
4040
+ | 'BJ'
4041
+ | 'BL'
4042
+ | 'BM'
4043
+ | 'BN'
4044
+ | 'BO'
4045
+ | 'BQ'
4046
+ | 'BR'
4047
+ | 'BS'
4048
+ | 'BT'
4049
+ | 'BV'
4050
+ | 'BW'
4051
+ | 'BY'
4052
+ | 'BZ'
4053
+ | 'CA'
4054
+ | 'CC'
4055
+ | 'CD'
4056
+ | 'CF'
4057
+ | 'CG'
4058
+ | 'CH'
4059
+ | 'CI'
4060
+ | 'CK'
4061
+ | 'CL'
4062
+ | 'CM'
4063
+ | 'CN'
4064
+ | 'CO'
4065
+ | 'CR'
4066
+ | 'CU'
4067
+ | 'CV'
4068
+ | 'CW'
4069
+ | 'CX'
4070
+ | 'CY'
4071
+ | 'CZ'
4072
+ | 'DE'
4073
+ | 'DJ'
4074
+ | 'DK'
4075
+ | 'DM'
4076
+ | 'DO'
4077
+ | 'DZ'
4078
+ | 'EC'
4079
+ | 'EE'
4080
+ | 'EG'
4081
+ | 'EH'
4082
+ | 'ER'
4083
+ | 'ES'
4084
+ | 'ET'
4085
+ | 'FI'
4086
+ | 'FJ'
4087
+ | 'FK'
4088
+ | 'FM'
4089
+ | 'FO'
4090
+ | 'FR'
4091
+ | 'GA'
4092
+ | 'GB'
4093
+ | 'GD'
4094
+ | 'GE'
4095
+ | 'GF'
4096
+ | 'GG'
4097
+ | 'GH'
4098
+ | 'GI'
4099
+ | 'GL'
4100
+ | 'GM'
4101
+ | 'GN'
4102
+ | 'GP'
4103
+ | 'GQ'
4104
+ | 'GR'
4105
+ | 'GS'
4106
+ | 'GT'
4107
+ | 'GU'
4108
+ | 'GW'
4109
+ | 'GY'
4110
+ | 'HK'
4111
+ | 'HM'
4112
+ | 'HN'
4113
+ | 'HR'
4114
+ | 'HT'
4115
+ | 'HU'
4116
+ | 'ID'
4117
+ | 'IE'
4118
+ | 'IL'
4119
+ | 'IM'
4120
+ | 'IN'
4121
+ | 'IO'
4122
+ | 'IQ'
4123
+ | 'IR'
4124
+ | 'IS'
4125
+ | 'IT'
4126
+ | 'JE'
4127
+ | 'JM'
4128
+ | 'JO'
4129
+ | 'JP'
4130
+ | 'KE'
4131
+ | 'KG'
4132
+ | 'KH'
4133
+ | 'KI'
4134
+ | 'KM'
4135
+ | 'KN'
4136
+ | 'KP'
4137
+ | 'KR'
4138
+ | 'KW'
4139
+ | 'KY'
4140
+ | 'KZ'
4141
+ | 'LA'
4142
+ | 'LB'
4143
+ | 'LC'
4144
+ | 'LI'
4145
+ | 'LK'
4146
+ | 'LR'
4147
+ | 'LS'
4148
+ | 'LT'
4149
+ | 'LU'
4150
+ | 'LV'
4151
+ | 'LY'
4152
+ | 'MA'
4153
+ | 'MC'
4154
+ | 'MD'
4155
+ | 'ME'
4156
+ | 'MF'
4157
+ | 'MG'
4158
+ | 'MH'
4159
+ | 'MK'
4160
+ | 'ML'
4161
+ | 'MM'
4162
+ | 'MN'
4163
+ | 'MO'
4164
+ | 'MP'
4165
+ | 'MQ'
4166
+ | 'MR'
4167
+ | 'MS'
4168
+ | 'MT'
4169
+ | 'MU'
4170
+ | 'MV'
4171
+ | 'MW'
4172
+ | 'MX'
4173
+ | 'MY'
4174
+ | 'MZ'
4175
+ | 'NA'
4176
+ | 'NC'
4177
+ | 'NE'
4178
+ | 'NF'
4179
+ | 'NG'
4180
+ | 'NI'
4181
+ | 'NL'
4182
+ | 'NO'
4183
+ | 'NP'
4184
+ | 'NR'
4185
+ | 'NU'
4186
+ | 'NZ'
4187
+ | 'OM'
4188
+ | 'PA'
4189
+ | 'PE'
4190
+ | 'PF'
4191
+ | 'PG'
4192
+ | 'PH'
4193
+ | 'PK'
4194
+ | 'PL'
4195
+ | 'PM'
4196
+ | 'PN'
4197
+ | 'PR'
4198
+ | 'PS'
4199
+ | 'PT'
4200
+ | 'PW'
4201
+ | 'PY'
4202
+ | 'QA'
4203
+ | 'RE'
4204
+ | 'RO'
4205
+ | 'RS'
4206
+ | 'RU'
4207
+ | 'RW'
4208
+ | 'SA'
4209
+ | 'SB'
4210
+ | 'SC'
4211
+ | 'SD'
4212
+ | 'SE'
4213
+ | 'SG'
4214
+ | 'SH'
4215
+ | 'SI'
4216
+ | 'SJ'
4217
+ | 'SK'
4218
+ | 'SL'
4219
+ | 'SM'
4220
+ | 'SN'
4221
+ | 'SO'
4222
+ | 'SR'
4223
+ | 'SS'
4224
+ | 'ST'
4225
+ | 'SV'
4226
+ | 'SX'
4227
+ | 'SY'
4228
+ | 'SZ'
4229
+ | 'TC'
4230
+ | 'TD'
4231
+ | 'TF'
4232
+ | 'TG'
4233
+ | 'TH'
4234
+ | 'TJ'
4235
+ | 'TK'
4236
+ | 'TL'
4237
+ | 'TM'
4238
+ | 'TN'
4239
+ | 'TO'
4240
+ | 'TR'
4241
+ | 'TT'
4242
+ | 'TV'
4243
+ | 'TW'
4244
+ | 'TZ'
4245
+ | 'UA'
4246
+ | 'UG'
4247
+ | 'UM'
4248
+ | 'US'
4249
+ | 'UY'
4250
+ | 'UZ'
4251
+ | 'VA'
4252
+ | 'VC'
4253
+ | 'VE'
4254
+ | 'VG'
4255
+ | 'VI'
4256
+ | 'VN'
4257
+ | 'VU'
4258
+ | 'WF'
4259
+ | 'WS'
4260
+ | 'XK'
4261
+ | 'YE'
4262
+ | 'YT'
4263
+ | 'ZA'
4264
+ | 'ZM'
4265
+ | 'ZW'
4266
+ | 'ALL';
4267
+
4268
+ /**
4269
+ * Device type for browser emulation
4270
+ */
4271
+ device?: 'desktop' | 'mobile' | 'tablet';
4272
+
4273
+ /**
4274
+ * Browser driver to use
4275
+ */
4276
+ driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
4277
+
4278
+ /**
4279
+ * Expected HTTP status codes for successful requests
4280
+ */
4281
+ expected_status_codes?: Array<number>;
4282
+
4283
+ /**
4284
+ * List of acceptable response formats in order of preference
4285
+ */
4286
+ formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
4287
+
4288
+ /**
4289
+ * Custom HTTP headers to include in the request
4290
+ */
4291
+ headers?: { [key: string]: string | Array<string> | null };
4292
+
4293
+ /**
4294
+ * Whether to use HTTP/2 protocol
4295
+ */
4296
+ http2?: boolean;
4297
+
4298
+ /**
4299
+ * Whether to emulate XMLHttpRequest behavior
4300
+ */
4301
+ is_xhr?: boolean;
4302
+
4303
+ /**
4304
+ * Locale for browser language and region settings
4305
+ */
4306
+ locale?:
4307
+ | 'aa-DJ'
4308
+ | 'aa-ER'
4309
+ | 'aa-ET'
4310
+ | 'af'
4311
+ | 'af-NA'
4312
+ | 'af-ZA'
4313
+ | 'ak'
4314
+ | 'ak-GH'
4315
+ | 'am'
4316
+ | 'am-ET'
4317
+ | 'an-ES'
4318
+ | 'ar'
4319
+ | 'ar-AE'
4320
+ | 'ar-BH'
4321
+ | 'ar-DZ'
4322
+ | 'ar-EG'
4323
+ | 'ar-IN'
4324
+ | 'ar-IQ'
4325
+ | 'ar-JO'
4326
+ | 'ar-KW'
4327
+ | 'ar-LB'
4328
+ | 'ar-LY'
4329
+ | 'ar-MA'
4330
+ | 'ar-OM'
4331
+ | 'ar-QA'
4332
+ | 'ar-SA'
4333
+ | 'ar-SD'
4334
+ | 'ar-SY'
4335
+ | 'ar-TN'
4336
+ | 'ar-YE'
4337
+ | 'as'
4338
+ | 'as-IN'
4339
+ | 'asa'
4340
+ | 'asa-TZ'
4341
+ | 'ast-ES'
4342
+ | 'az'
4343
+ | 'az-AZ'
4344
+ | 'az-Cyrl'
4345
+ | 'az-Cyrl-AZ'
4346
+ | 'az-Latn'
4347
+ | 'az-Latn-AZ'
4348
+ | 'be'
4349
+ | 'be-BY'
4350
+ | 'bem'
4351
+ | 'bem-ZM'
4352
+ | 'ber-DZ'
4353
+ | 'ber-MA'
4354
+ | 'bez'
4355
+ | 'bez-TZ'
4356
+ | 'bg'
4357
+ | 'bg-BG'
4358
+ | 'bho-IN'
4359
+ | 'bm'
4360
+ | 'bm-ML'
4361
+ | 'bn'
4362
+ | 'bn-BD'
4363
+ | 'bn-IN'
4364
+ | 'bo'
4365
+ | 'bo-CN'
4366
+ | 'bo-IN'
4367
+ | 'br-FR'
4368
+ | 'brx-IN'
4369
+ | 'bs'
4370
+ | 'bs-BA'
4371
+ | 'byn-ER'
4372
+ | 'ca'
4373
+ | 'ca-AD'
4374
+ | 'ca-ES'
4375
+ | 'ca-FR'
4376
+ | 'ca-IT'
4377
+ | 'cgg'
4378
+ | 'cgg-UG'
4379
+ | 'chr'
4380
+ | 'chr-US'
4381
+ | 'crh-UA'
4382
+ | 'cs'
4383
+ | 'cs-CZ'
4384
+ | 'csb-PL'
4385
+ | 'cv-RU'
4386
+ | 'cy'
4387
+ | 'cy-GB'
4388
+ | 'da'
4389
+ | 'da-DK'
4390
+ | 'dav'
4391
+ | 'dav-KE'
4392
+ | 'de'
4393
+ | 'de-AT'
4394
+ | 'de-BE'
4395
+ | 'de-CH'
4396
+ | 'de-DE'
4397
+ | 'de-LI'
4398
+ | 'de-LU'
4399
+ | 'dv-MV'
4400
+ | 'dz-BT'
4401
+ | 'ebu'
4402
+ | 'ebu-KE'
4403
+ | 'ee'
4404
+ | 'ee-GH'
4405
+ | 'ee-TG'
4406
+ | 'el'
4407
+ | 'el-CY'
4408
+ | 'el-GR'
4409
+ | 'en'
4410
+ | 'en-AG'
4411
+ | 'en-AS'
4412
+ | 'en-AU'
4413
+ | 'en-BE'
4414
+ | 'en-BW'
4415
+ | 'en-BZ'
4416
+ | 'en-CA'
4417
+ | 'en-DK'
4418
+ | 'en-GB'
4419
+ | 'en-GU'
4420
+ | 'en-HK'
4421
+ | 'en-IE'
4422
+ | 'en-IN'
4423
+ | 'en-JM'
4424
+ | 'en-MH'
4425
+ | 'en-MP'
4426
+ | 'en-MT'
4427
+ | 'en-MU'
4428
+ | 'en-NA'
4429
+ | 'en-NG'
4430
+ | 'en-NZ'
4431
+ | 'en-PH'
4432
+ | 'en-PK'
4433
+ | 'en-SG'
4434
+ | 'en-TT'
4435
+ | 'en-UM'
4436
+ | 'en-US'
4437
+ | 'en-VI'
4438
+ | 'en-ZA'
4439
+ | 'en-ZM'
4440
+ | 'en-ZW'
4441
+ | 'eo'
4442
+ | 'es'
4443
+ | 'es-419'
4444
+ | 'es-AR'
4445
+ | 'es-BO'
4446
+ | 'es-CL'
4447
+ | 'es-CO'
4448
+ | 'es-CR'
4449
+ | 'es-CU'
4450
+ | 'es-DO'
4451
+ | 'es-EC'
4452
+ | 'es-ES'
4453
+ | 'es-GQ'
4454
+ | 'es-GT'
4455
+ | 'es-HN'
4456
+ | 'es-MX'
4457
+ | 'es-NI'
4458
+ | 'es-PA'
4459
+ | 'es-PE'
4460
+ | 'es-PR'
4461
+ | 'es-PY'
4462
+ | 'es-SV'
4463
+ | 'es-US'
4464
+ | 'es-UY'
4465
+ | 'es-VE'
4466
+ | 'et'
4467
+ | 'et-EE'
4468
+ | 'eu'
4469
+ | 'eu-ES'
4470
+ | 'fa'
4471
+ | 'fa-AF'
4472
+ | 'fa-IR'
4473
+ | 'ff'
4474
+ | 'ff-SN'
4475
+ | 'fi'
4476
+ | 'fi-FI'
4477
+ | 'fil'
4478
+ | 'fil-PH'
4479
+ | 'fo'
4480
+ | 'fo-FO'
4481
+ | 'fr'
4482
+ | 'fr-BE'
4483
+ | 'fr-BF'
4484
+ | 'fr-BI'
4485
+ | 'fr-BJ'
4486
+ | 'fr-BL'
4487
+ | 'fr-CA'
4488
+ | 'fr-CD'
4489
+ | 'fr-CF'
4490
+ | 'fr-CG'
4491
+ | 'fr-CH'
4492
+ | 'fr-CI'
4493
+ | 'fr-CM'
4494
+ | 'fr-DJ'
4495
+ | 'fr-FR'
4496
+ | 'fr-GA'
4497
+ | 'fr-GN'
4498
+ | 'fr-GP'
4499
+ | 'fr-GQ'
4500
+ | 'fr-KM'
4501
+ | 'fr-LU'
4502
+ | 'fr-MC'
4503
+ | 'fr-MF'
4504
+ | 'fr-MG'
4505
+ | 'fr-ML'
4506
+ | 'fr-MQ'
4507
+ | 'fr-NE'
4508
+ | 'fr-RE'
4509
+ | 'fr-RW'
4510
+ | 'fr-SN'
4511
+ | 'fr-TD'
4512
+ | 'fr-TG'
4513
+ | 'fur-IT'
4514
+ | 'fy-DE'
4515
+ | 'fy-NL'
4516
+ | 'ga'
4517
+ | 'ga-IE'
4518
+ | 'gd-GB'
4519
+ | 'gez-ER'
4520
+ | 'gez-ET'
4521
+ | 'gl'
4522
+ | 'gl-ES'
4523
+ | 'gsw'
4524
+ | 'gsw-CH'
4525
+ | 'gu'
4526
+ | 'gu-IN'
4527
+ | 'guz'
4528
+ | 'guz-KE'
4529
+ | 'gv'
4530
+ | 'gv-GB'
4531
+ | 'ha'
4532
+ | 'ha-Latn'
4533
+ | 'ha-Latn-GH'
4534
+ | 'ha-Latn-NE'
4535
+ | 'ha-Latn-NG'
4536
+ | 'ha-NG'
4537
+ | 'haw'
4538
+ | 'haw-US'
4539
+ | 'he'
4540
+ | 'he-IL'
4541
+ | 'hi'
4542
+ | 'hi-IN'
4543
+ | 'hne-IN'
4544
+ | 'hr'
4545
+ | 'hr-HR'
4546
+ | 'hsb-DE'
4547
+ | 'ht-HT'
4548
+ | 'hu'
4549
+ | 'hu-HU'
4550
+ | 'hy'
4551
+ | 'hy-AM'
4552
+ | 'id'
4553
+ | 'id-ID'
4554
+ | 'ig'
4555
+ | 'ig-NG'
4556
+ | 'ii'
4557
+ | 'ii-CN'
4558
+ | 'ik-CA'
4559
+ | 'is'
4560
+ | 'is-IS'
4561
+ | 'it'
4562
+ | 'it-CH'
4563
+ | 'it-IT'
4564
+ | 'iu-CA'
4565
+ | 'iw-IL'
4566
+ | 'ja'
4567
+ | 'ja-JP'
4568
+ | 'jmc'
4569
+ | 'jmc-TZ'
4570
+ | 'ka'
4571
+ | 'ka-GE'
4572
+ | 'kab'
4573
+ | 'kab-DZ'
4574
+ | 'kam'
4575
+ | 'kam-KE'
4576
+ | 'kde'
4577
+ | 'kde-TZ'
4578
+ | 'kea'
4579
+ | 'kea-CV'
4580
+ | 'khq'
4581
+ | 'khq-ML'
4582
+ | 'ki'
4583
+ | 'ki-KE'
4584
+ | 'kk'
4585
+ | 'kk-Cyrl'
4586
+ | 'kk-Cyrl-KZ'
4587
+ | 'kk-KZ'
4588
+ | 'kl'
4589
+ | 'kl-GL'
4590
+ | 'kln'
4591
+ | 'kln-KE'
4592
+ | 'km'
4593
+ | 'km-KH'
4594
+ | 'kn'
4595
+ | 'kn-IN'
4596
+ | 'ko'
4597
+ | 'ko-KR'
4598
+ | 'kok'
4599
+ | 'kok-IN'
4600
+ | 'ks-IN'
4601
+ | 'ku-TR'
4602
+ | 'kw'
4603
+ | 'kw-GB'
4604
+ | 'ky-KG'
4605
+ | 'lag'
4606
+ | 'lag-TZ'
4607
+ | 'lb-LU'
4608
+ | 'lg'
4609
+ | 'lg-UG'
4610
+ | 'li-BE'
4611
+ | 'li-NL'
4612
+ | 'lij-IT'
4613
+ | 'lo-LA'
4614
+ | 'lt'
4615
+ | 'lt-LT'
4616
+ | 'luo'
4617
+ | 'luo-KE'
4618
+ | 'luy'
4619
+ | 'luy-KE'
4620
+ | 'lv'
4621
+ | 'lv-LV'
4622
+ | 'mag-IN'
4623
+ | 'mai-IN'
4624
+ | 'mas'
4625
+ | 'mas-KE'
4626
+ | 'mas-TZ'
4627
+ | 'mer'
4628
+ | 'mer-KE'
4629
+ | 'mfe'
4630
+ | 'mfe-MU'
4631
+ | 'mg'
4632
+ | 'mg-MG'
4633
+ | 'mhr-RU'
4634
+ | 'mi-NZ'
4635
+ | 'mk'
4636
+ | 'mk-MK'
4637
+ | 'ml'
4638
+ | 'ml-IN'
4639
+ | 'mn-MN'
4640
+ | 'mr'
4641
+ | 'mr-IN'
4642
+ | 'ms'
4643
+ | 'ms-BN'
4644
+ | 'ms-MY'
4645
+ | 'mt'
4646
+ | 'mt-MT'
4647
+ | 'my'
4648
+ | 'my-MM'
4649
+ | 'nan-TW'
4650
+ | 'naq'
4651
+ | 'naq-NA'
4652
+ | 'nb'
4653
+ | 'nb-NO'
4654
+ | 'nd'
4655
+ | 'nd-ZW'
4656
+ | 'nds-DE'
4657
+ | 'nds-NL'
4658
+ | 'ne'
4659
+ | 'ne-IN'
4660
+ | 'ne-NP'
4661
+ | 'nl'
4662
+ | 'nl-AW'
4663
+ | 'nl-BE'
4664
+ | 'nl-NL'
4665
+ | 'nn'
4666
+ | 'nn-NO'
4667
+ | 'nr-ZA'
4668
+ | 'nso-ZA'
4669
+ | 'nyn'
4670
+ | 'nyn-UG'
4671
+ | 'oc-FR'
4672
+ | 'om'
4673
+ | 'om-ET'
4674
+ | 'om-KE'
4675
+ | 'or'
4676
+ | 'or-IN'
4677
+ | 'os-RU'
4678
+ | 'pa'
4679
+ | 'pa-Arab'
4680
+ | 'pa-Arab-PK'
4681
+ | 'pa-Guru'
4682
+ | 'pa-Guru-IN'
4683
+ | 'pa-IN'
4684
+ | 'pa-PK'
4685
+ | 'pap-AN'
4686
+ | 'pl'
4687
+ | 'pl-PL'
4688
+ | 'ps'
4689
+ | 'ps-AF'
4690
+ | 'pt'
4691
+ | 'pt-BR'
4692
+ | 'pt-GW'
4693
+ | 'pt-MZ'
4694
+ | 'pt-PT'
4695
+ | 'rm'
4696
+ | 'rm-CH'
4697
+ | 'ro'
4698
+ | 'ro-MD'
4699
+ | 'ro-RO'
4700
+ | 'rof'
4701
+ | 'rof-TZ'
4702
+ | 'ru'
4703
+ | 'ru-MD'
4704
+ | 'ru-RU'
4705
+ | 'ru-UA'
4706
+ | 'rw'
4707
+ | 'rw-RW'
4708
+ | 'rwk'
4709
+ | 'rwk-TZ'
4710
+ | 'sa-IN'
4711
+ | 'saq'
4712
+ | 'saq-KE'
4713
+ | 'sc-IT'
4714
+ | 'sd-IN'
4715
+ | 'se-NO'
4716
+ | 'seh'
4717
+ | 'seh-MZ'
4718
+ | 'ses'
4719
+ | 'ses-ML'
4720
+ | 'sg'
4721
+ | 'sg-CF'
4722
+ | 'shi'
4723
+ | 'shi-Latn'
4724
+ | 'shi-Latn-MA'
4725
+ | 'shi-Tfng'
4726
+ | 'shi-Tfng-MA'
4727
+ | 'shs-CA'
4728
+ | 'si'
4729
+ | 'si-LK'
4730
+ | 'sid-ET'
4731
+ | 'sk'
4732
+ | 'sk-SK'
4733
+ | 'sl'
4734
+ | 'sl-SI'
4735
+ | 'sn'
4736
+ | 'sn-ZW'
4737
+ | 'so'
4738
+ | 'so-DJ'
4739
+ | 'so-ET'
4740
+ | 'so-KE'
4741
+ | 'so-SO'
4742
+ | 'sq'
4743
+ | 'sq-AL'
4744
+ | 'sq-MK'
4745
+ | 'sr'
4746
+ | 'sr-Cyrl'
4747
+ | 'sr-Cyrl-BA'
4748
+ | 'sr-Cyrl-ME'
4749
+ | 'sr-Cyrl-RS'
4750
+ | 'sr-Latn'
4751
+ | 'sr-Latn-BA'
4752
+ | 'sr-Latn-ME'
4753
+ | 'sr-Latn-RS'
4754
+ | 'sr-ME'
4755
+ | 'sr-RS'
4756
+ | 'ss-ZA'
4757
+ | 'st-ZA'
4758
+ | 'sv'
4759
+ | 'sv-FI'
4760
+ | 'sv-SE'
4761
+ | 'sw'
4762
+ | 'sw-KE'
4763
+ | 'sw-TZ'
4764
+ | 'ta'
4765
+ | 'ta-IN'
4766
+ | 'ta-LK'
4767
+ | 'te'
4768
+ | 'te-IN'
4769
+ | 'teo'
4770
+ | 'teo-KE'
4771
+ | 'teo-UG'
4772
+ | 'tg-TJ'
4773
+ | 'th'
4774
+ | 'th-TH'
4775
+ | 'ti'
4776
+ | 'ti-ER'
4777
+ | 'ti-ET'
4778
+ | 'tig-ER'
4779
+ | 'tk-TM'
4780
+ | 'tl-PH'
4781
+ | 'tn-ZA'
4782
+ | 'to'
4783
+ | 'to-TO'
4784
+ | 'tr'
4785
+ | 'tr-CY'
4786
+ | 'tr-TR'
4787
+ | 'ts-ZA'
4788
+ | 'tt-RU'
4789
+ | 'tzm'
4790
+ | 'tzm-Latn'
4791
+ | 'tzm-Latn-MA'
4792
+ | 'ug-CN'
4793
+ | 'uk'
4794
+ | 'uk-UA'
4795
+ | 'unm-US'
4796
+ | 'ur'
4797
+ | 'ur-IN'
4798
+ | 'ur-PK'
4799
+ | 'uz'
4800
+ | 'uz-Arab'
4801
+ | 'uz-Arab-AF'
4802
+ | 'uz-Cyrl'
4803
+ | 'uz-Cyrl-UZ'
4804
+ | 'uz-Latn'
4805
+ | 'uz-Latn-UZ'
4806
+ | 'uz-UZ'
4807
+ | 've-ZA'
4808
+ | 'vi'
4809
+ | 'vi-VN'
4810
+ | 'vun'
4811
+ | 'vun-TZ'
4812
+ | 'wa-BE'
4813
+ | 'wae-CH'
4814
+ | 'wal-ET'
4815
+ | 'wo-SN'
4816
+ | 'xh-ZA'
4817
+ | 'xog'
4818
+ | 'xog-UG'
4819
+ | 'yi-US'
4820
+ | 'yo'
4821
+ | 'yo-NG'
4822
+ | 'yue-HK'
4823
+ | 'zh'
4824
+ | 'zh-CN'
4825
+ | 'zh-HK'
4826
+ | 'zh-Hans'
4827
+ | 'zh-Hans-CN'
4828
+ | 'zh-Hans-HK'
4829
+ | 'zh-Hans-MO'
4830
+ | 'zh-Hans-SG'
4831
+ | 'zh-Hant'
4832
+ | 'zh-Hant-HK'
4833
+ | 'zh-Hant-MO'
4834
+ | 'zh-Hant-TW'
4835
+ | 'zh-SG'
4836
+ | 'zh-TW'
4837
+ | 'zu'
4838
+ | 'zu-ZA'
4839
+ | 'auto';
4840
+
4841
+ /**
4842
+ * HTTP method for the request
4843
+ */
4844
+ method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
4845
+
4846
+ /**
4847
+ * Filters for capturing network traffic
4848
+ */
4849
+ network_capture?: Array<SharedInputs.NetworkCapture>;
4850
+
4851
+ /**
4852
+ * Operating system to emulate
4853
+ */
4854
+ os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
4855
+
4856
+ /**
4857
+ * Whether to parse the response content
4858
+ */
4859
+ parse?: boolean;
4860
+
4861
+ /**
4862
+ * Custom parser configuration as a key-value map
4863
+ */
4864
+ parser?: { [key: string]: unknown } | string;
4865
+
4866
+ /**
4867
+ * Referrer policy for the request
4868
+ */
4869
+ referrer_type?:
4870
+ | 'random'
4871
+ | 'no-referer'
4872
+ | 'same-origin'
4873
+ | 'google'
4874
+ | 'bing'
4875
+ | 'facebook'
4876
+ | 'twitter'
4877
+ | 'instagram';
4878
+
4879
+ /**
4880
+ * Whether to render JavaScript content using a browser
4881
+ */
4882
+ render?: boolean;
4883
+
4884
+ /**
4885
+ * Request timeout in milliseconds
4886
+ */
4887
+ request_timeout?: number;
4888
+
4889
+ session?: SharedInputs.Session;
4890
+
4891
+ /**
4892
+ * Skills or capabilities required for the request
4893
+ */
4894
+ skill?: string | Array<string>;
4895
+
4896
+ /**
4897
+ * US state for geolocation (only valid when country is US)
4898
+ */
4899
+ state?:
4900
+ | 'AL'
4901
+ | 'AK'
4902
+ | 'AS'
4903
+ | 'AZ'
4904
+ | 'AR'
4905
+ | 'CA'
4906
+ | 'CO'
4907
+ | 'CT'
4908
+ | 'DE'
4909
+ | 'DC'
4910
+ | 'FL'
4911
+ | 'GA'
4912
+ | 'GU'
4913
+ | 'HI'
4914
+ | 'ID'
4915
+ | 'IL'
4916
+ | 'IN'
4917
+ | 'IA'
4918
+ | 'KS'
4919
+ | 'KY'
4920
+ | 'LA'
4921
+ | 'ME'
4922
+ | 'MD'
4923
+ | 'MA'
4924
+ | 'MI'
4925
+ | 'MN'
4926
+ | 'MS'
4927
+ | 'MO'
4928
+ | 'MT'
4929
+ | 'NE'
4930
+ | 'NV'
4931
+ | 'NH'
4932
+ | 'NJ'
4933
+ | 'NM'
4934
+ | 'NY'
4935
+ | 'NC'
4936
+ | 'ND'
4937
+ | 'MP'
4938
+ | 'OH'
4939
+ | 'OK'
4940
+ | 'OR'
4941
+ | 'PA'
4942
+ | 'PR'
4943
+ | 'RI'
4944
+ | 'SC'
4945
+ | 'SD'
4946
+ | 'TN'
4947
+ | 'TX'
4948
+ | 'UT'
4949
+ | 'VT'
4950
+ | 'VA'
4951
+ | 'VI'
4952
+ | 'WA'
4953
+ | 'WV'
4954
+ | 'WI'
4955
+ | 'WY';
4956
+
4957
+ /**
4958
+ * Whether to compress stored data
4959
+ */
4960
+ storage_compress?: boolean;
4961
+
4962
+ /**
4963
+ * Custom name for the stored object
4964
+ */
4965
+ storage_object_name?: string;
4966
+
4967
+ /**
4968
+ * Type of storage to use for results
4969
+ */
4970
+ storage_type?: string;
4971
+
4972
+ /**
4973
+ * URL for storage location
4974
+ */
4975
+ storage_url?: string;
4976
+
4977
+ /**
4978
+ * User-defined tag for request identification
4979
+ */
4980
+ tag?: string;
4981
+
4982
+ /**
4983
+ * Target URL to scrape
4984
+ */
4985
+ url?: string;
4986
+ }
4987
+
4988
+ export namespace SharedInputs {
4989
+ export interface UnionMember1 {
4990
+ name: 'chrome' | 'firefox';
4991
+
4992
+ /**
4993
+ * Specific browser version to emulate
4994
+ */
4995
+ version?: string;
4996
+ }
4997
+
4998
+ export interface UnionMember0 {
4999
+ creation?: string | null;
5000
+
5001
+ domain?: string | null;
5002
+
5003
+ expires?: string;
5004
+
5005
+ extensions?: Array<string> | null;
5006
+
5007
+ hostOnly?: boolean | null;
5008
+
5009
+ httpOnly?: boolean | null;
5010
+
5011
+ lastAccessed?: string | null;
5012
+
5013
+ maxAge?: 'Infinity' | '-Infinity' | number | null;
5014
+
5015
+ name?: string;
5016
+
5017
+ path?: string | null;
5018
+
5019
+ pathIsDefault?: boolean | null;
5020
+
5021
+ sameSite?: 'strict' | 'lax' | 'none';
5022
+
5023
+ secure?: boolean;
5024
+
5025
+ value?: string;
5026
+
5027
+ [k: string]: unknown;
5028
+ }
5029
+
5030
+ export interface NetworkCapture {
5031
+ method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
5032
+
5033
+ /**
5034
+ * Resource type for network capture filtering
5035
+ */
5036
+ resource_type?: string | Array<string>;
5037
+
5038
+ status_code?: number | Array<number>;
5039
+
5040
+ url?: NetworkCapture.URL;
5041
+
5042
+ validation?: boolean;
5043
+
5044
+ wait_for_requests_count?: number;
5045
+
5046
+ wait_for_requests_count_timeout?: number;
5047
+ }
5048
+
5049
+ export namespace NetworkCapture {
5050
+ export interface URL {
5051
+ value: string;
5052
+
5053
+ type?: 'exact' | 'contains';
5054
+ }
5055
+ }
5056
+
5057
+ export interface Session {
5058
+ id?: string;
5059
+
5060
+ prefetch_userbrowser?: boolean;
5061
+
5062
+ retry?: boolean;
5063
+
5064
+ timeout?: number;
5065
+ }
3967
5066
  }
3968
5067
  }
3969
5068