@backstage/integration 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +93 -0
- package/config.d.ts +42 -1
- package/dist/index.cjs.js +370 -82
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +364 -78
- package/dist/index.esm.js +353 -83
- package/dist/index.esm.js.map +1 -1
- package/package.json +7 -6
package/dist/index.d.ts
CHANGED
|
@@ -87,6 +87,83 @@ declare type ScmIntegrationsFactory<T extends ScmIntegration> = (options: {
|
|
|
87
87
|
config: Config;
|
|
88
88
|
}) => ScmIntegrationsGroup<T>;
|
|
89
89
|
|
|
90
|
+
/**
|
|
91
|
+
* The configuration parameters for a single AWS S3 provider.
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
declare type AwsS3IntegrationConfig = {
|
|
96
|
+
/**
|
|
97
|
+
* Host, derived from endpoint, and defaults to amazonaws.com
|
|
98
|
+
*/
|
|
99
|
+
host: string;
|
|
100
|
+
/**
|
|
101
|
+
* (Optional) AWS Endpoint.
|
|
102
|
+
* The endpoint URI to send requests to. The default endpoint is built from the configured region.
|
|
103
|
+
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
|
|
104
|
+
*
|
|
105
|
+
* Supports non-AWS providers, e.g. for LocalStack, endpoint may look like http://localhost:4566
|
|
106
|
+
*/
|
|
107
|
+
endpoint?: string;
|
|
108
|
+
/**
|
|
109
|
+
* (Optional) Whether to use path style URLs when communicating with S3.
|
|
110
|
+
* Defaults to false.
|
|
111
|
+
* This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.
|
|
112
|
+
*/
|
|
113
|
+
s3ForcePathStyle?: boolean;
|
|
114
|
+
/**
|
|
115
|
+
* (Optional) User access key id
|
|
116
|
+
*/
|
|
117
|
+
accessKeyId?: string;
|
|
118
|
+
/**
|
|
119
|
+
* (Optional) User secret access key
|
|
120
|
+
*/
|
|
121
|
+
secretAccessKey?: string;
|
|
122
|
+
/**
|
|
123
|
+
* (Optional) ARN of role to be assumed
|
|
124
|
+
*/
|
|
125
|
+
roleArn?: string;
|
|
126
|
+
/**
|
|
127
|
+
* (Optional) External ID to use when assuming role
|
|
128
|
+
*/
|
|
129
|
+
externalId?: string;
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* Reads a single Aws S3 integration config.
|
|
133
|
+
*
|
|
134
|
+
* @param config - The config object of a single integration
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
declare function readAwsS3IntegrationConfig(config: Config): AwsS3IntegrationConfig;
|
|
138
|
+
/**
|
|
139
|
+
* Reads a set of AWS S3 integration configs, and inserts some defaults for
|
|
140
|
+
* public Amazon AWS if not specified.
|
|
141
|
+
*
|
|
142
|
+
* @param configs - The config objects of the integrations
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
declare function readAwsS3IntegrationConfigs(configs: Config[]): AwsS3IntegrationConfig[];
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Integrates with AWS S3 or compatible solutions.
|
|
149
|
+
*
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
declare class AwsS3Integration implements ScmIntegration {
|
|
153
|
+
private readonly integrationConfig;
|
|
154
|
+
static factory: ScmIntegrationsFactory<AwsS3Integration>;
|
|
155
|
+
get type(): string;
|
|
156
|
+
get title(): string;
|
|
157
|
+
get config(): AwsS3IntegrationConfig;
|
|
158
|
+
constructor(integrationConfig: AwsS3IntegrationConfig);
|
|
159
|
+
resolveUrl(options: {
|
|
160
|
+
url: string;
|
|
161
|
+
base: string;
|
|
162
|
+
lineNumber?: number | undefined;
|
|
163
|
+
}): string;
|
|
164
|
+
resolveEditUrl(url: string): string;
|
|
165
|
+
}
|
|
166
|
+
|
|
90
167
|
/**
|
|
91
168
|
* The configuration parameters for a single Azure provider.
|
|
92
169
|
*
|
|
@@ -185,6 +262,7 @@ declare function getAzureRequestOptions(config: AzureIntegrationConfig, addition
|
|
|
185
262
|
* The configuration parameters for a single Bitbucket API provider.
|
|
186
263
|
*
|
|
187
264
|
* @public
|
|
265
|
+
* @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
188
266
|
*/
|
|
189
267
|
declare type BitbucketIntegrationConfig = {
|
|
190
268
|
/**
|
|
@@ -223,6 +301,7 @@ declare type BitbucketIntegrationConfig = {
|
|
|
223
301
|
*
|
|
224
302
|
* @param config - The config object of a single integration
|
|
225
303
|
* @public
|
|
304
|
+
* @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
226
305
|
*/
|
|
227
306
|
declare function readBitbucketIntegrationConfig(config: Config): BitbucketIntegrationConfig;
|
|
228
307
|
/**
|
|
@@ -231,6 +310,7 @@ declare function readBitbucketIntegrationConfig(config: Config): BitbucketIntegr
|
|
|
231
310
|
*
|
|
232
311
|
* @param configs - All of the integration config objects
|
|
233
312
|
* @public
|
|
313
|
+
* @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
234
314
|
*/
|
|
235
315
|
declare function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIntegrationConfig[];
|
|
236
316
|
|
|
@@ -238,6 +318,7 @@ declare function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIn
|
|
|
238
318
|
* A Bitbucket based integration.
|
|
239
319
|
*
|
|
240
320
|
* @public
|
|
321
|
+
* @deprecated replaced by the integrations bitbucketCloud and bitbucketServer.
|
|
241
322
|
*/
|
|
242
323
|
declare class BitbucketIntegration implements ScmIntegration {
|
|
243
324
|
private readonly integrationConfig;
|
|
@@ -260,6 +341,7 @@ declare class BitbucketIntegration implements ScmIntegration {
|
|
|
260
341
|
* @param url - A URL pointing to a path
|
|
261
342
|
* @param config - The relevant provider config
|
|
262
343
|
* @public
|
|
344
|
+
* @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
263
345
|
*/
|
|
264
346
|
declare function getBitbucketDefaultBranch(url: string, config: BitbucketIntegrationConfig): Promise<string>;
|
|
265
347
|
/**
|
|
@@ -269,6 +351,7 @@ declare function getBitbucketDefaultBranch(url: string, config: BitbucketIntegra
|
|
|
269
351
|
* @param url - A URL pointing to a path
|
|
270
352
|
* @param config - The relevant provider config
|
|
271
353
|
* @public
|
|
354
|
+
* @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
272
355
|
*/
|
|
273
356
|
declare function getBitbucketDownloadUrl(url: string, config: BitbucketIntegrationConfig): Promise<string>;
|
|
274
357
|
/**
|
|
@@ -284,6 +367,7 @@ declare function getBitbucketDownloadUrl(url: string, config: BitbucketIntegrati
|
|
|
284
367
|
* @param url - A URL pointing to a file
|
|
285
368
|
* @param config - The relevant provider config
|
|
286
369
|
* @public
|
|
370
|
+
* @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
287
371
|
*/
|
|
288
372
|
declare function getBitbucketFileFetchUrl(url: string, config: BitbucketIntegrationConfig): string;
|
|
289
373
|
/**
|
|
@@ -291,11 +375,219 @@ declare function getBitbucketFileFetchUrl(url: string, config: BitbucketIntegrat
|
|
|
291
375
|
*
|
|
292
376
|
* @param config - The relevant provider config
|
|
293
377
|
* @public
|
|
378
|
+
* @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
|
|
294
379
|
*/
|
|
295
380
|
declare function getBitbucketRequestOptions(config: BitbucketIntegrationConfig): {
|
|
296
381
|
headers: Record<string, string>;
|
|
297
382
|
};
|
|
298
383
|
|
|
384
|
+
/**
|
|
385
|
+
* The configuration parameters for a single Bitbucket Cloud API provider.
|
|
386
|
+
*
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
declare type BitbucketCloudIntegrationConfig = {
|
|
390
|
+
/**
|
|
391
|
+
* Constant. bitbucket.org
|
|
392
|
+
*/
|
|
393
|
+
host: string;
|
|
394
|
+
/**
|
|
395
|
+
* Constant. https://api.bitbucket.org/2.0
|
|
396
|
+
*/
|
|
397
|
+
apiBaseUrl: string;
|
|
398
|
+
/**
|
|
399
|
+
* The username to use for requests to Bitbucket Cloud (bitbucket.org).
|
|
400
|
+
*/
|
|
401
|
+
username?: string;
|
|
402
|
+
/**
|
|
403
|
+
* Authentication with Bitbucket Cloud (bitbucket.org) is done using app passwords.
|
|
404
|
+
*
|
|
405
|
+
* See https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/
|
|
406
|
+
*/
|
|
407
|
+
appPassword?: string;
|
|
408
|
+
};
|
|
409
|
+
/**
|
|
410
|
+
* Reads a single Bitbucket Cloud integration config.
|
|
411
|
+
*
|
|
412
|
+
* @param config - The config object of a single integration
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
declare function readBitbucketCloudIntegrationConfig(config: Config): BitbucketCloudIntegrationConfig;
|
|
416
|
+
/**
|
|
417
|
+
* Reads a set of Bitbucket Cloud integration configs,
|
|
418
|
+
* and inserts one for public Bitbucket Cloud if none specified.
|
|
419
|
+
*
|
|
420
|
+
* @param configs - All of the integration config objects
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
declare function readBitbucketCloudIntegrationConfigs(configs: Config[]): BitbucketCloudIntegrationConfig[];
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* A Bitbucket Cloud based integration.
|
|
427
|
+
*
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
declare class BitbucketCloudIntegration implements ScmIntegration {
|
|
431
|
+
private readonly integrationConfig;
|
|
432
|
+
static factory: ScmIntegrationsFactory<BitbucketCloudIntegration>;
|
|
433
|
+
constructor(integrationConfig: BitbucketCloudIntegrationConfig);
|
|
434
|
+
get type(): string;
|
|
435
|
+
get title(): string;
|
|
436
|
+
get config(): BitbucketCloudIntegrationConfig;
|
|
437
|
+
resolveUrl(options: {
|
|
438
|
+
url: string;
|
|
439
|
+
base: string;
|
|
440
|
+
lineNumber?: number;
|
|
441
|
+
}): string;
|
|
442
|
+
resolveEditUrl(url: string): string;
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
/**
|
|
446
|
+
* Given a URL pointing to a path on a provider, returns the default branch.
|
|
447
|
+
*
|
|
448
|
+
* @param url - A URL pointing to a path
|
|
449
|
+
* @param config - The relevant provider config
|
|
450
|
+
* @public
|
|
451
|
+
*/
|
|
452
|
+
declare function getBitbucketCloudDefaultBranch(url: string, config: BitbucketCloudIntegrationConfig): Promise<string>;
|
|
453
|
+
/**
|
|
454
|
+
* Given a URL pointing to a path on a provider, returns a URL that is suitable
|
|
455
|
+
* for downloading the subtree.
|
|
456
|
+
*
|
|
457
|
+
* @param url - A URL pointing to a path
|
|
458
|
+
* @param config - The relevant provider config
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
declare function getBitbucketCloudDownloadUrl(url: string, config: BitbucketCloudIntegrationConfig): Promise<string>;
|
|
462
|
+
/**
|
|
463
|
+
* Given a URL pointing to a file on a provider, returns a URL that is suitable
|
|
464
|
+
* for fetching the contents of the data.
|
|
465
|
+
*
|
|
466
|
+
* @remarks
|
|
467
|
+
*
|
|
468
|
+
* Converts
|
|
469
|
+
* from: https://bitbucket.org/orgname/reponame/src/master/file.yaml
|
|
470
|
+
* to: https://api.bitbucket.org/2.0/repositories/orgname/reponame/src/master/file.yaml
|
|
471
|
+
*
|
|
472
|
+
* @param url - A URL pointing to a file
|
|
473
|
+
* @param config - The relevant provider config
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
declare function getBitbucketCloudFileFetchUrl(url: string, config: BitbucketCloudIntegrationConfig): string;
|
|
477
|
+
/**
|
|
478
|
+
* Gets the request options necessary to make requests to a given provider.
|
|
479
|
+
*
|
|
480
|
+
* @param config - The relevant provider config
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
declare function getBitbucketCloudRequestOptions(config: BitbucketCloudIntegrationConfig): {
|
|
484
|
+
headers: Record<string, string>;
|
|
485
|
+
};
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* The configuration parameters for a single Bitbucket Server API provider.
|
|
489
|
+
*
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
declare type BitbucketServerIntegrationConfig = {
|
|
493
|
+
/**
|
|
494
|
+
* The host of the target that this matches on, e.g. "bitbucket.company.com"
|
|
495
|
+
*/
|
|
496
|
+
host: string;
|
|
497
|
+
/**
|
|
498
|
+
* The base URL of the API of this provider, e.g. "https://<host>/rest/api/1.0",
|
|
499
|
+
* with no trailing slash.
|
|
500
|
+
*
|
|
501
|
+
* The API will always be preferred if both its base URL and a token are
|
|
502
|
+
* present.
|
|
503
|
+
*/
|
|
504
|
+
apiBaseUrl: string;
|
|
505
|
+
/**
|
|
506
|
+
* The authorization token to use for requests to a Bitbucket Server provider.
|
|
507
|
+
*
|
|
508
|
+
* See https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html
|
|
509
|
+
*
|
|
510
|
+
* If no token is specified, anonymous access is used.
|
|
511
|
+
*/
|
|
512
|
+
token?: string;
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* Reads a single Bitbucket Server integration config.
|
|
516
|
+
*
|
|
517
|
+
* @param config - The config object of a single integration
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
declare function readBitbucketServerIntegrationConfig(config: Config): BitbucketServerIntegrationConfig;
|
|
521
|
+
/**
|
|
522
|
+
* Reads a set of Bitbucket Server integration configs.
|
|
523
|
+
*
|
|
524
|
+
* @param configs - All of the integration config objects
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
declare function readBitbucketServerIntegrationConfigs(configs: Config[]): BitbucketServerIntegrationConfig[];
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* A Bitbucket Server based integration.
|
|
531
|
+
*
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
declare class BitbucketServerIntegration implements ScmIntegration {
|
|
535
|
+
private readonly integrationConfig;
|
|
536
|
+
static factory: ScmIntegrationsFactory<BitbucketServerIntegration>;
|
|
537
|
+
constructor(integrationConfig: BitbucketServerIntegrationConfig);
|
|
538
|
+
get type(): string;
|
|
539
|
+
get title(): string;
|
|
540
|
+
get config(): BitbucketServerIntegrationConfig;
|
|
541
|
+
resolveUrl(options: {
|
|
542
|
+
url: string;
|
|
543
|
+
base: string;
|
|
544
|
+
lineNumber?: number;
|
|
545
|
+
}): string;
|
|
546
|
+
resolveEditUrl(url: string): string;
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
/**
|
|
550
|
+
* Given a URL pointing to a path on a provider, returns the default branch.
|
|
551
|
+
*
|
|
552
|
+
* @param url - A URL pointing to a path
|
|
553
|
+
* @param config - The relevant provider config
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
declare function getBitbucketServerDefaultBranch(url: string, config: BitbucketServerIntegrationConfig): Promise<string>;
|
|
557
|
+
/**
|
|
558
|
+
* Given a URL pointing to a path on a provider, returns a URL that is suitable
|
|
559
|
+
* for downloading the subtree.
|
|
560
|
+
*
|
|
561
|
+
* @param url - A URL pointing to a path
|
|
562
|
+
* @param config - The relevant provider config
|
|
563
|
+
* @public
|
|
564
|
+
*/
|
|
565
|
+
declare function getBitbucketServerDownloadUrl(url: string, config: BitbucketServerIntegrationConfig): Promise<string>;
|
|
566
|
+
/**
|
|
567
|
+
* Given a URL pointing to a file on a provider, returns a URL that is suitable
|
|
568
|
+
* for fetching the contents of the data.
|
|
569
|
+
*
|
|
570
|
+
* @remarks
|
|
571
|
+
*
|
|
572
|
+
* Converts
|
|
573
|
+
* from: https://bitbucket.company.com/projectname/reponame/src/main/file.yaml
|
|
574
|
+
* to: https://bitbucket.company.com/rest/api/1.0/project/projectname/reponame/raw/file.yaml?at=main
|
|
575
|
+
*
|
|
576
|
+
* @param url - A URL pointing to a file
|
|
577
|
+
* @param config - The relevant provider config
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
declare function getBitbucketServerFileFetchUrl(url: string, config: BitbucketServerIntegrationConfig): string;
|
|
581
|
+
/**
|
|
582
|
+
* Gets the request options necessary to make requests to a given provider.
|
|
583
|
+
*
|
|
584
|
+
* @param config - The relevant provider config
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
declare function getBitbucketServerRequestOptions(config: BitbucketServerIntegrationConfig): {
|
|
588
|
+
headers: Record<string, string>;
|
|
589
|
+
};
|
|
590
|
+
|
|
299
591
|
/**
|
|
300
592
|
* The configuration parameters for a single Gerrit API provider.
|
|
301
593
|
*
|
|
@@ -314,6 +606,11 @@ declare type GerritIntegrationConfig = {
|
|
|
314
606
|
* in a browser.
|
|
315
607
|
*/
|
|
316
608
|
baseUrl?: string;
|
|
609
|
+
/**
|
|
610
|
+
* The optional base url to use for cloning a repository. If not set the
|
|
611
|
+
* baseUrl will be used.
|
|
612
|
+
*/
|
|
613
|
+
cloneUrl?: string;
|
|
317
614
|
/**
|
|
318
615
|
* Optional base url for Gitiles. This is needed for creating a valid
|
|
319
616
|
* user-friendly url that can be used for browsing the content of the
|
|
@@ -367,13 +664,64 @@ declare class GerritIntegration implements ScmIntegration {
|
|
|
367
664
|
resolveEditUrl(url: string): string;
|
|
368
665
|
}
|
|
369
666
|
|
|
667
|
+
/**
|
|
668
|
+
* Parse a Gitiles URL and return branch, file path and project.
|
|
669
|
+
*
|
|
670
|
+
* @remarks
|
|
671
|
+
*
|
|
672
|
+
* Gerrit only handles code reviews so it does not have a native way to browse
|
|
673
|
+
* or showing the content of gits. Image if Github only had the "pull requests"
|
|
674
|
+
* tab.
|
|
675
|
+
*
|
|
676
|
+
* Any source code browsing is instead handled by optional services outside
|
|
677
|
+
* Gerrit. The url format chosen for the Gerrit url reader is the one used by
|
|
678
|
+
* the Gitiles project. Gerrit will work perfectly with Backstage without
|
|
679
|
+
* having Gitiles installed but there are some places in the Backstage GUI
|
|
680
|
+
* with links to the url used by the url reader. These will not work unless
|
|
681
|
+
* the urls point to an actual Gitiles installation.
|
|
682
|
+
*
|
|
683
|
+
* Gitiles url:
|
|
684
|
+
* https://g.com/optional_path/\{project\}/+/refs/heads/\{branch\}/\{filePath\}
|
|
685
|
+
*
|
|
686
|
+
*
|
|
687
|
+
* @param url - An URL pointing to a file stored in git.
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
declare function parseGerritGitilesUrl(config: GerritIntegrationConfig, url: string): {
|
|
691
|
+
branch: string;
|
|
692
|
+
filePath: string;
|
|
693
|
+
project: string;
|
|
694
|
+
};
|
|
695
|
+
/**
|
|
696
|
+
* Return the url to get branch info from the Gerrit API.
|
|
697
|
+
*
|
|
698
|
+
* @param config - A Gerrit provider config.
|
|
699
|
+
* @param url - An url pointing to a file in git.
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
declare function getGerritBranchApiUrl(config: GerritIntegrationConfig, url: string): string;
|
|
703
|
+
/**
|
|
704
|
+
* Return the url to clone the repo that is referenced by the url.
|
|
705
|
+
*
|
|
706
|
+
* @param url - An url pointing to a file in git.
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
declare function getGerritCloneRepoUrl(config: GerritIntegrationConfig, url: string): string;
|
|
370
710
|
/**
|
|
371
711
|
* Return the url to fetch the contents of a file using the Gerrit API.
|
|
372
712
|
*
|
|
713
|
+
* @param config - A Gerrit provider config.
|
|
373
714
|
* @param url - An url pointing to a file in git.
|
|
374
715
|
* @public
|
|
375
716
|
*/
|
|
376
717
|
declare function getGerritFileContentsApiUrl(config: GerritIntegrationConfig, url: string): string;
|
|
718
|
+
/**
|
|
719
|
+
* Return the url to query available projects using the Gerrit API.
|
|
720
|
+
*
|
|
721
|
+
* @param config - A Gerrit provider config.
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
declare function getGerritProjectsApiUrl(config: GerritIntegrationConfig): string;
|
|
377
725
|
/**
|
|
378
726
|
* Return request headers for a Gerrit provider.
|
|
379
727
|
*
|
|
@@ -553,83 +901,6 @@ declare function getGitHubRequestOptions(config: GitHubIntegrationConfig, creden
|
|
|
553
901
|
headers: Record<string, string>;
|
|
554
902
|
};
|
|
555
903
|
|
|
556
|
-
/**
|
|
557
|
-
* The configuration parameters for a single AWS S3 provider.
|
|
558
|
-
*
|
|
559
|
-
* @public
|
|
560
|
-
*/
|
|
561
|
-
declare type AwsS3IntegrationConfig = {
|
|
562
|
-
/**
|
|
563
|
-
* Host, derived from endpoint, and defaults to amazonaws.com
|
|
564
|
-
*/
|
|
565
|
-
host: string;
|
|
566
|
-
/**
|
|
567
|
-
* (Optional) AWS Endpoint.
|
|
568
|
-
* The endpoint URI to send requests to. The default endpoint is built from the configured region.
|
|
569
|
-
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
|
|
570
|
-
*
|
|
571
|
-
* Supports non-AWS providers, e.g. for LocalStack, endpoint may look like http://localhost:4566
|
|
572
|
-
*/
|
|
573
|
-
endpoint?: string;
|
|
574
|
-
/**
|
|
575
|
-
* (Optional) Whether to use path style URLs when communicating with S3.
|
|
576
|
-
* Defaults to false.
|
|
577
|
-
* This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.
|
|
578
|
-
*/
|
|
579
|
-
s3ForcePathStyle?: boolean;
|
|
580
|
-
/**
|
|
581
|
-
* (Optional) User access key id
|
|
582
|
-
*/
|
|
583
|
-
accessKeyId?: string;
|
|
584
|
-
/**
|
|
585
|
-
* (Optional) User secret access key
|
|
586
|
-
*/
|
|
587
|
-
secretAccessKey?: string;
|
|
588
|
-
/**
|
|
589
|
-
* (Optional) ARN of role to be assumed
|
|
590
|
-
*/
|
|
591
|
-
roleArn?: string;
|
|
592
|
-
/**
|
|
593
|
-
* (Optional) External ID to use when assuming role
|
|
594
|
-
*/
|
|
595
|
-
externalId?: string;
|
|
596
|
-
};
|
|
597
|
-
/**
|
|
598
|
-
* Reads a single Aws S3 integration config.
|
|
599
|
-
*
|
|
600
|
-
* @param config - The config object of a single integration
|
|
601
|
-
* @public
|
|
602
|
-
*/
|
|
603
|
-
declare function readAwsS3IntegrationConfig(config: Config): AwsS3IntegrationConfig;
|
|
604
|
-
/**
|
|
605
|
-
* Reads a set of AWS S3 integration configs, and inserts some defaults for
|
|
606
|
-
* public Amazon AWS if not specified.
|
|
607
|
-
*
|
|
608
|
-
* @param configs - The config objects of the integrations
|
|
609
|
-
* @public
|
|
610
|
-
*/
|
|
611
|
-
declare function readAwsS3IntegrationConfigs(configs: Config[]): AwsS3IntegrationConfig[];
|
|
612
|
-
|
|
613
|
-
/**
|
|
614
|
-
* Integrates with AWS S3 or compatible solutions.
|
|
615
|
-
*
|
|
616
|
-
* @public
|
|
617
|
-
*/
|
|
618
|
-
declare class AwsS3Integration implements ScmIntegration {
|
|
619
|
-
private readonly integrationConfig;
|
|
620
|
-
static factory: ScmIntegrationsFactory<AwsS3Integration>;
|
|
621
|
-
get type(): string;
|
|
622
|
-
get title(): string;
|
|
623
|
-
get config(): AwsS3IntegrationConfig;
|
|
624
|
-
constructor(integrationConfig: AwsS3IntegrationConfig);
|
|
625
|
-
resolveUrl(options: {
|
|
626
|
-
url: string;
|
|
627
|
-
base: string;
|
|
628
|
-
lineNumber?: number | undefined;
|
|
629
|
-
}): string;
|
|
630
|
-
resolveEditUrl(url: string): string;
|
|
631
|
-
}
|
|
632
|
-
|
|
633
904
|
/**
|
|
634
905
|
* A GitHub based integration.
|
|
635
906
|
*
|
|
@@ -741,7 +1012,12 @@ declare function replaceGitLabUrlType(url: string, type: 'blob' | 'tree' | 'edit
|
|
|
741
1012
|
interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
|
|
742
1013
|
awsS3: ScmIntegrationsGroup<AwsS3Integration>;
|
|
743
1014
|
azure: ScmIntegrationsGroup<AzureIntegration>;
|
|
1015
|
+
/**
|
|
1016
|
+
* @deprecated in favor of `bitbucketCloud` and `bitbucketServer`
|
|
1017
|
+
*/
|
|
744
1018
|
bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
|
|
1019
|
+
bitbucketCloud: ScmIntegrationsGroup<BitbucketCloudIntegration>;
|
|
1020
|
+
bitbucketServer: ScmIntegrationsGroup<BitbucketServerIntegration>;
|
|
745
1021
|
gerrit: ScmIntegrationsGroup<GerritIntegration>;
|
|
746
1022
|
github: ScmIntegrationsGroup<GitHubIntegration>;
|
|
747
1023
|
gitlab: ScmIntegrationsGroup<GitLabIntegration>;
|
|
@@ -946,7 +1222,12 @@ declare function defaultScmResolveUrl(options: {
|
|
|
946
1222
|
interface IntegrationsByType {
|
|
947
1223
|
awsS3: ScmIntegrationsGroup<AwsS3Integration>;
|
|
948
1224
|
azure: ScmIntegrationsGroup<AzureIntegration>;
|
|
1225
|
+
/**
|
|
1226
|
+
* @deprecated in favor of `bitbucketCloud` and `bitbucketServer`
|
|
1227
|
+
*/
|
|
949
1228
|
bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
|
|
1229
|
+
bitbucketCloud: ScmIntegrationsGroup<BitbucketCloudIntegration>;
|
|
1230
|
+
bitbucketServer: ScmIntegrationsGroup<BitbucketServerIntegration>;
|
|
950
1231
|
gerrit: ScmIntegrationsGroup<GerritIntegration>;
|
|
951
1232
|
github: ScmIntegrationsGroup<GitHubIntegration>;
|
|
952
1233
|
gitlab: ScmIntegrationsGroup<GitLabIntegration>;
|
|
@@ -962,7 +1243,12 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
|
|
|
962
1243
|
constructor(integrationsByType: IntegrationsByType);
|
|
963
1244
|
get awsS3(): ScmIntegrationsGroup<AwsS3Integration>;
|
|
964
1245
|
get azure(): ScmIntegrationsGroup<AzureIntegration>;
|
|
1246
|
+
/**
|
|
1247
|
+
* @deprecated in favor of `bitbucketCloud()` and `bitbucketServer()`
|
|
1248
|
+
*/
|
|
965
1249
|
get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
|
|
1250
|
+
get bitbucketCloud(): ScmIntegrationsGroup<BitbucketCloudIntegration>;
|
|
1251
|
+
get bitbucketServer(): ScmIntegrationsGroup<BitbucketServerIntegration>;
|
|
966
1252
|
get gerrit(): ScmIntegrationsGroup<GerritIntegration>;
|
|
967
1253
|
get github(): ScmIntegrationsGroup<GitHubIntegration>;
|
|
968
1254
|
get gitlab(): ScmIntegrationsGroup<GitLabIntegration>;
|
|
@@ -977,4 +1263,4 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
|
|
|
977
1263
|
resolveEditUrl(url: string): string;
|
|
978
1264
|
}
|
|
979
1265
|
|
|
980
|
-
export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, DefaultGithubCredentialsProvider, GerritIntegration, GerritIntegrationConfig, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGerritFileContentsApiUrl, getGerritRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, parseGerritJsonResponse, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType, replaceGitLabUrlType };
|
|
1266
|
+
export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketCloudIntegration, BitbucketCloudIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, BitbucketServerIntegration, BitbucketServerIntegrationConfig, DefaultGithubCredentialsProvider, GerritIntegration, GerritIntegrationConfig, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketCloudDefaultBranch, getBitbucketCloudDownloadUrl, getBitbucketCloudFileFetchUrl, getBitbucketCloudRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getBitbucketServerDefaultBranch, getBitbucketServerDownloadUrl, getBitbucketServerFileFetchUrl, getBitbucketServerRequestOptions, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, parseGerritGitilesUrl, parseGerritJsonResponse, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType, replaceGitLabUrlType };
|