@backstage/plugin-catalog-backend-module-bitbucket-server 0.1.2-next.2 → 0.1.3-next.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 +34 -0
- package/alpha/package.json +6 -0
- package/config.d.ts +10 -3
- package/dist/index.alpha.d.ts +147 -0
- package/dist/index.beta.d.ts +144 -0
- package/dist/index.cjs.js +50 -11
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +72 -56
- package/package.json +20 -15
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,39 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-bitbucket-server
|
|
2
2
|
|
|
3
|
+
## 0.1.3-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 68f7f5a857: `BitbucketServerEntityProvider`: Add option to configure schedule via `app-config.yaml` instead of in code.
|
|
8
|
+
|
|
9
|
+
Please find how to configure the schedule at the config at
|
|
10
|
+
https://backstage.io/docs/integrations/bitbucketServer/discovery
|
|
11
|
+
|
|
12
|
+
- cd48ed8370: Add `bitbucketServerEntityProviderCatalogModule` (new backend-plugin-api, alpha).
|
|
13
|
+
- Updated dependencies
|
|
14
|
+
- @backstage/backend-common@0.16.0-next.0
|
|
15
|
+
- @backstage/plugin-catalog-backend@1.5.1-next.0
|
|
16
|
+
- @backstage/integration@1.4.0-next.0
|
|
17
|
+
- @backstage/backend-tasks@0.3.7-next.0
|
|
18
|
+
- @backstage/catalog-model@1.1.3-next.0
|
|
19
|
+
- @backstage/backend-plugin-api@0.1.4-next.0
|
|
20
|
+
- @backstage/plugin-catalog-node@1.2.1-next.0
|
|
21
|
+
- @backstage/config@1.0.4-next.0
|
|
22
|
+
- @backstage/errors@1.1.3-next.0
|
|
23
|
+
|
|
24
|
+
## 0.1.2
|
|
25
|
+
|
|
26
|
+
### Patch Changes
|
|
27
|
+
|
|
28
|
+
- Updated dependencies
|
|
29
|
+
- @backstage/catalog-model@1.1.2
|
|
30
|
+
- @backstage/backend-common@0.15.2
|
|
31
|
+
- @backstage/plugin-catalog-backend@1.5.0
|
|
32
|
+
- @backstage/backend-tasks@0.3.6
|
|
33
|
+
- @backstage/config@1.0.3
|
|
34
|
+
- @backstage/errors@1.1.2
|
|
35
|
+
- @backstage/integration@1.3.2
|
|
36
|
+
|
|
3
37
|
## 0.1.2-next.2
|
|
4
38
|
|
|
5
39
|
### Patch Changes
|
package/config.d.ts
CHANGED
|
@@ -14,11 +14,10 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
|
+
import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
|
|
18
|
+
|
|
17
19
|
export interface Config {
|
|
18
20
|
catalog?: {
|
|
19
|
-
/**
|
|
20
|
-
* List of provider-specific options and attributes
|
|
21
|
-
*/
|
|
22
21
|
providers?: {
|
|
23
22
|
/**
|
|
24
23
|
* BitbucketServerEntityProvider configuration
|
|
@@ -48,6 +47,10 @@ export interface Config {
|
|
|
48
47
|
*/
|
|
49
48
|
projectKey?: RegExp;
|
|
50
49
|
};
|
|
50
|
+
/**
|
|
51
|
+
* (Optional) TaskScheduleDefinition for the refresh.
|
|
52
|
+
*/
|
|
53
|
+
schedule?: TaskScheduleDefinitionConfig;
|
|
51
54
|
}
|
|
52
55
|
| Record<
|
|
53
56
|
string,
|
|
@@ -73,6 +76,10 @@ export interface Config {
|
|
|
73
76
|
*/
|
|
74
77
|
projectKey?: RegExp;
|
|
75
78
|
};
|
|
79
|
+
/**
|
|
80
|
+
* (Optional) TaskScheduleDefinition for the refresh.
|
|
81
|
+
*/
|
|
82
|
+
schedule?: TaskScheduleDefinitionConfig;
|
|
76
83
|
}
|
|
77
84
|
>;
|
|
78
85
|
};
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A Backstage catalog backend module that helps integrate towards Bitbucket Server
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
8
|
+
import { BitbucketServerIntegrationConfig } from '@backstage/integration';
|
|
9
|
+
import { Config } from '@backstage/config';
|
|
10
|
+
import { Entity } from '@backstage/catalog-model';
|
|
11
|
+
import { EntityProvider } from '@backstage/plugin-catalog-backend';
|
|
12
|
+
import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
|
|
13
|
+
import { LocationSpec } from '@backstage/plugin-catalog-backend';
|
|
14
|
+
import { Logger } from 'winston';
|
|
15
|
+
import { PluginTaskScheduler } from '@backstage/backend-tasks';
|
|
16
|
+
import { Response as Response_2 } from 'node-fetch';
|
|
17
|
+
import { TaskRunner } from '@backstage/backend-tasks';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* A client for interacting with a Bitbucket Server instance
|
|
21
|
+
*
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export declare class BitbucketServerClient {
|
|
25
|
+
private readonly config;
|
|
26
|
+
static fromConfig(options: {
|
|
27
|
+
config: BitbucketServerIntegrationConfig;
|
|
28
|
+
}): BitbucketServerClient;
|
|
29
|
+
constructor(options: {
|
|
30
|
+
config: BitbucketServerIntegrationConfig;
|
|
31
|
+
});
|
|
32
|
+
listProjects(options: {
|
|
33
|
+
listOptions?: BitbucketServerListOptions;
|
|
34
|
+
}): Promise<BitbucketServerPagedResponse<BitbucketServerProject>>;
|
|
35
|
+
listRepositories(options: {
|
|
36
|
+
projectKey: string;
|
|
37
|
+
listOptions?: BitbucketServerListOptions;
|
|
38
|
+
}): Promise<BitbucketServerPagedResponse<BitbucketServerRepository>>;
|
|
39
|
+
getFile(options: {
|
|
40
|
+
projectKey: string;
|
|
41
|
+
repo: string;
|
|
42
|
+
path: string;
|
|
43
|
+
}): Promise<Response_2>;
|
|
44
|
+
getRepository(options: {
|
|
45
|
+
projectKey: string;
|
|
46
|
+
repo: string;
|
|
47
|
+
}): Promise<BitbucketServerRepository>;
|
|
48
|
+
resolvePath(options: {
|
|
49
|
+
projectKey: string;
|
|
50
|
+
repo: string;
|
|
51
|
+
path: string;
|
|
52
|
+
}): {
|
|
53
|
+
path: string;
|
|
54
|
+
};
|
|
55
|
+
private pagedRequest;
|
|
56
|
+
private getTypeMapped;
|
|
57
|
+
private get;
|
|
58
|
+
private request;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Discovers catalog files located in Bitbucket Server.
|
|
63
|
+
* The provider will search your Bitbucket Server instance and register catalog files matching the configured path
|
|
64
|
+
* as Location entity and via following processing steps add all contained catalog entities.
|
|
65
|
+
* This can be useful as an alternative to static locations or manually adding things to the catalog.
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class BitbucketServerEntityProvider implements EntityProvider {
|
|
70
|
+
private readonly integration;
|
|
71
|
+
private readonly config;
|
|
72
|
+
private readonly parser;
|
|
73
|
+
private readonly logger;
|
|
74
|
+
private readonly scheduleFn;
|
|
75
|
+
private connection?;
|
|
76
|
+
static fromConfig(config: Config, options: {
|
|
77
|
+
logger: Logger;
|
|
78
|
+
parser?: BitbucketServerLocationParser;
|
|
79
|
+
schedule?: TaskRunner;
|
|
80
|
+
scheduler?: PluginTaskScheduler;
|
|
81
|
+
}): BitbucketServerEntityProvider[];
|
|
82
|
+
private constructor();
|
|
83
|
+
private createScheduleFn;
|
|
84
|
+
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
|
|
85
|
+
getProviderName(): string;
|
|
86
|
+
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
|
|
87
|
+
connect(connection: EntityProviderConnection): Promise<void>;
|
|
88
|
+
refresh(logger: Logger): Promise<void>;
|
|
89
|
+
private findEntities;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* @alpha
|
|
94
|
+
*/
|
|
95
|
+
export declare const bitbucketServerEntityProviderCatalogModule: (options?: undefined) => BackendFeature;
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare type BitbucketServerListOptions = {
|
|
101
|
+
[key: string]: number | undefined;
|
|
102
|
+
limit?: number | undefined;
|
|
103
|
+
start?: number | undefined;
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* A custom callback that reacts to finding a location by yielding entities.
|
|
108
|
+
* Can be used for custom location/repository parsing logic.
|
|
109
|
+
*
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export declare type BitbucketServerLocationParser = (options: {
|
|
113
|
+
client: BitbucketServerClient;
|
|
114
|
+
location: LocationSpec;
|
|
115
|
+
logger: Logger;
|
|
116
|
+
}) => AsyncIterable<Entity>;
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
export declare type BitbucketServerPagedResponse<T> = {
|
|
122
|
+
size: number;
|
|
123
|
+
limit: number;
|
|
124
|
+
start: number;
|
|
125
|
+
isLastPage: boolean;
|
|
126
|
+
values: T[];
|
|
127
|
+
nextPageStart: number;
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
/** @public */
|
|
131
|
+
export declare type BitbucketServerProject = {
|
|
132
|
+
key: string;
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
/** @public */
|
|
136
|
+
export declare type BitbucketServerRepository = {
|
|
137
|
+
project: {
|
|
138
|
+
key: string;
|
|
139
|
+
};
|
|
140
|
+
slug: string;
|
|
141
|
+
description: string;
|
|
142
|
+
links: Record<string, {
|
|
143
|
+
href: string;
|
|
144
|
+
}[]>;
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
export { }
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A Backstage catalog backend module that helps integrate towards Bitbucket Server
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
8
|
+
import { BitbucketServerIntegrationConfig } from '@backstage/integration';
|
|
9
|
+
import { Config } from '@backstage/config';
|
|
10
|
+
import { Entity } from '@backstage/catalog-model';
|
|
11
|
+
import { EntityProvider } from '@backstage/plugin-catalog-backend';
|
|
12
|
+
import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
|
|
13
|
+
import { LocationSpec } from '@backstage/plugin-catalog-backend';
|
|
14
|
+
import { Logger } from 'winston';
|
|
15
|
+
import { PluginTaskScheduler } from '@backstage/backend-tasks';
|
|
16
|
+
import { Response as Response_2 } from 'node-fetch';
|
|
17
|
+
import { TaskRunner } from '@backstage/backend-tasks';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* A client for interacting with a Bitbucket Server instance
|
|
21
|
+
*
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export declare class BitbucketServerClient {
|
|
25
|
+
private readonly config;
|
|
26
|
+
static fromConfig(options: {
|
|
27
|
+
config: BitbucketServerIntegrationConfig;
|
|
28
|
+
}): BitbucketServerClient;
|
|
29
|
+
constructor(options: {
|
|
30
|
+
config: BitbucketServerIntegrationConfig;
|
|
31
|
+
});
|
|
32
|
+
listProjects(options: {
|
|
33
|
+
listOptions?: BitbucketServerListOptions;
|
|
34
|
+
}): Promise<BitbucketServerPagedResponse<BitbucketServerProject>>;
|
|
35
|
+
listRepositories(options: {
|
|
36
|
+
projectKey: string;
|
|
37
|
+
listOptions?: BitbucketServerListOptions;
|
|
38
|
+
}): Promise<BitbucketServerPagedResponse<BitbucketServerRepository>>;
|
|
39
|
+
getFile(options: {
|
|
40
|
+
projectKey: string;
|
|
41
|
+
repo: string;
|
|
42
|
+
path: string;
|
|
43
|
+
}): Promise<Response_2>;
|
|
44
|
+
getRepository(options: {
|
|
45
|
+
projectKey: string;
|
|
46
|
+
repo: string;
|
|
47
|
+
}): Promise<BitbucketServerRepository>;
|
|
48
|
+
resolvePath(options: {
|
|
49
|
+
projectKey: string;
|
|
50
|
+
repo: string;
|
|
51
|
+
path: string;
|
|
52
|
+
}): {
|
|
53
|
+
path: string;
|
|
54
|
+
};
|
|
55
|
+
private pagedRequest;
|
|
56
|
+
private getTypeMapped;
|
|
57
|
+
private get;
|
|
58
|
+
private request;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Discovers catalog files located in Bitbucket Server.
|
|
63
|
+
* The provider will search your Bitbucket Server instance and register catalog files matching the configured path
|
|
64
|
+
* as Location entity and via following processing steps add all contained catalog entities.
|
|
65
|
+
* This can be useful as an alternative to static locations or manually adding things to the catalog.
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class BitbucketServerEntityProvider implements EntityProvider {
|
|
70
|
+
private readonly integration;
|
|
71
|
+
private readonly config;
|
|
72
|
+
private readonly parser;
|
|
73
|
+
private readonly logger;
|
|
74
|
+
private readonly scheduleFn;
|
|
75
|
+
private connection?;
|
|
76
|
+
static fromConfig(config: Config, options: {
|
|
77
|
+
logger: Logger;
|
|
78
|
+
parser?: BitbucketServerLocationParser;
|
|
79
|
+
schedule?: TaskRunner;
|
|
80
|
+
scheduler?: PluginTaskScheduler;
|
|
81
|
+
}): BitbucketServerEntityProvider[];
|
|
82
|
+
private constructor();
|
|
83
|
+
private createScheduleFn;
|
|
84
|
+
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
|
|
85
|
+
getProviderName(): string;
|
|
86
|
+
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
|
|
87
|
+
connect(connection: EntityProviderConnection): Promise<void>;
|
|
88
|
+
refresh(logger: Logger): Promise<void>;
|
|
89
|
+
private findEntities;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/* Excluded from this release type: bitbucketServerEntityProviderCatalogModule */
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export declare type BitbucketServerListOptions = {
|
|
98
|
+
[key: string]: number | undefined;
|
|
99
|
+
limit?: number | undefined;
|
|
100
|
+
start?: number | undefined;
|
|
101
|
+
};
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* A custom callback that reacts to finding a location by yielding entities.
|
|
105
|
+
* Can be used for custom location/repository parsing logic.
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare type BitbucketServerLocationParser = (options: {
|
|
110
|
+
client: BitbucketServerClient;
|
|
111
|
+
location: LocationSpec;
|
|
112
|
+
logger: Logger;
|
|
113
|
+
}) => AsyncIterable<Entity>;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export declare type BitbucketServerPagedResponse<T> = {
|
|
119
|
+
size: number;
|
|
120
|
+
limit: number;
|
|
121
|
+
start: number;
|
|
122
|
+
isLastPage: boolean;
|
|
123
|
+
values: T[];
|
|
124
|
+
nextPageStart: number;
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
/** @public */
|
|
128
|
+
export declare type BitbucketServerProject = {
|
|
129
|
+
key: string;
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
/** @public */
|
|
133
|
+
export declare type BitbucketServerRepository = {
|
|
134
|
+
project: {
|
|
135
|
+
key: string;
|
|
136
|
+
};
|
|
137
|
+
slug: string;
|
|
138
|
+
description: string;
|
|
139
|
+
links: Record<string, {
|
|
140
|
+
href: string;
|
|
141
|
+
}[]>;
|
|
142
|
+
};
|
|
143
|
+
|
|
144
|
+
export { }
|
package/dist/index.cjs.js
CHANGED
|
@@ -4,9 +4,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var fetch = require('node-fetch');
|
|
6
6
|
var integration = require('@backstage/integration');
|
|
7
|
+
var errors = require('@backstage/errors');
|
|
7
8
|
var uuid = require('uuid');
|
|
9
|
+
var backendTasks = require('@backstage/backend-tasks');
|
|
8
10
|
var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
|
|
9
|
-
var
|
|
11
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
12
|
+
var pluginCatalogNode = require('@backstage/plugin-catalog-node');
|
|
10
13
|
|
|
11
14
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
12
15
|
|
|
@@ -115,10 +118,6 @@ async function* paginated(request, options) {
|
|
|
115
118
|
} while (!res.isLastPage);
|
|
116
119
|
}
|
|
117
120
|
|
|
118
|
-
const defaultBitbucketServerLocationParser = async function* defaultBitbucketServerLocationParser2(options) {
|
|
119
|
-
yield pluginCatalogBackend.locationSpecToLocationEntity({ location: options.location });
|
|
120
|
-
};
|
|
121
|
-
|
|
122
121
|
const DEFAULT_CATALOG_PATH = "/catalog-info.yaml";
|
|
123
122
|
const DEFAULT_PROVIDER_ID = "default";
|
|
124
123
|
function readProviderConfigs(config) {
|
|
@@ -142,6 +141,7 @@ function readProviderConfig(id, config) {
|
|
|
142
141
|
const catalogPath = (_a = config.getOptionalString("catalogPath")) != null ? _a : DEFAULT_CATALOG_PATH;
|
|
143
142
|
const projectKeyPattern = config.getOptionalString("filters.projectKey");
|
|
144
143
|
const repoSlugPattern = config.getOptionalString("filters.repoSlug");
|
|
144
|
+
const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
|
|
145
145
|
return {
|
|
146
146
|
id,
|
|
147
147
|
host,
|
|
@@ -149,14 +149,23 @@ function readProviderConfig(id, config) {
|
|
|
149
149
|
filters: {
|
|
150
150
|
projectKey: projectKeyPattern ? new RegExp(projectKeyPattern) : void 0,
|
|
151
151
|
repoSlug: repoSlugPattern ? new RegExp(repoSlugPattern) : void 0
|
|
152
|
-
}
|
|
152
|
+
},
|
|
153
|
+
schedule
|
|
153
154
|
};
|
|
154
155
|
}
|
|
155
156
|
|
|
157
|
+
const defaultBitbucketServerLocationParser = async function* defaultBitbucketServerLocationParser2(options) {
|
|
158
|
+
yield pluginCatalogBackend.locationSpecToLocationEntity({ location: options.location });
|
|
159
|
+
};
|
|
160
|
+
|
|
156
161
|
class BitbucketServerEntityProvider {
|
|
157
162
|
static fromConfig(config, options) {
|
|
158
163
|
const integrations = integration.ScmIntegrations.fromConfig(config);
|
|
164
|
+
if (!options.schedule && !options.scheduler) {
|
|
165
|
+
throw new Error("Either schedule or scheduler must be provided.");
|
|
166
|
+
}
|
|
159
167
|
return readProviderConfigs(config).map((providerConfig) => {
|
|
168
|
+
var _a;
|
|
160
169
|
const integration = integrations.bitbucketServer.byHost(
|
|
161
170
|
providerConfig.host
|
|
162
171
|
);
|
|
@@ -165,28 +174,34 @@ class BitbucketServerEntityProvider {
|
|
|
165
174
|
`No BitbucketServer integration found that matches host ${providerConfig.host}`
|
|
166
175
|
);
|
|
167
176
|
}
|
|
177
|
+
if (!options.schedule && !providerConfig.schedule) {
|
|
178
|
+
throw new Error(
|
|
179
|
+
`No schedule provided neither via code nor config for bitbucketServer-provider:${providerConfig.id}.`
|
|
180
|
+
);
|
|
181
|
+
}
|
|
182
|
+
const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
|
|
168
183
|
return new BitbucketServerEntityProvider(
|
|
169
184
|
providerConfig,
|
|
170
185
|
integration,
|
|
171
186
|
options.logger,
|
|
172
|
-
|
|
187
|
+
taskRunner,
|
|
173
188
|
options.parser
|
|
174
189
|
);
|
|
175
190
|
});
|
|
176
191
|
}
|
|
177
|
-
constructor(config, integration, logger,
|
|
192
|
+
constructor(config, integration, logger, taskRunner, parser) {
|
|
178
193
|
this.integration = integration;
|
|
179
194
|
this.config = config;
|
|
180
195
|
this.parser = parser || defaultBitbucketServerLocationParser;
|
|
181
196
|
this.logger = logger.child({
|
|
182
197
|
target: this.getProviderName()
|
|
183
198
|
});
|
|
184
|
-
this.scheduleFn = this.createScheduleFn(
|
|
199
|
+
this.scheduleFn = this.createScheduleFn(taskRunner);
|
|
185
200
|
}
|
|
186
|
-
createScheduleFn(
|
|
201
|
+
createScheduleFn(taskRunner) {
|
|
187
202
|
return async () => {
|
|
188
203
|
const taskId = `${this.getProviderName()}:refresh`;
|
|
189
|
-
return
|
|
204
|
+
return taskRunner.run({
|
|
190
205
|
id: taskId,
|
|
191
206
|
fn: async () => {
|
|
192
207
|
const logger = this.logger.child({
|
|
@@ -267,6 +282,30 @@ class BitbucketServerEntityProvider {
|
|
|
267
282
|
}
|
|
268
283
|
}
|
|
269
284
|
|
|
285
|
+
const bitbucketServerEntityProviderCatalogModule = backendPluginApi.createBackendModule({
|
|
286
|
+
pluginId: "catalog",
|
|
287
|
+
moduleId: "bitbucketServerEntityProvider",
|
|
288
|
+
register(env) {
|
|
289
|
+
env.registerInit({
|
|
290
|
+
deps: {
|
|
291
|
+
catalog: pluginCatalogNode.catalogProcessingExtensionPoint,
|
|
292
|
+
config: backendPluginApi.configServiceRef,
|
|
293
|
+
logger: backendPluginApi.loggerServiceRef,
|
|
294
|
+
scheduler: backendPluginApi.schedulerServiceRef
|
|
295
|
+
},
|
|
296
|
+
async init({ catalog, config, logger, scheduler }) {
|
|
297
|
+
const winstonLogger = backendPluginApi.loggerToWinstonLogger(logger);
|
|
298
|
+
const providers = BitbucketServerEntityProvider.fromConfig(config, {
|
|
299
|
+
logger: winstonLogger,
|
|
300
|
+
scheduler
|
|
301
|
+
});
|
|
302
|
+
catalog.addEntityProvider(providers);
|
|
303
|
+
}
|
|
304
|
+
});
|
|
305
|
+
}
|
|
306
|
+
});
|
|
307
|
+
|
|
270
308
|
exports.BitbucketServerClient = BitbucketServerClient;
|
|
271
309
|
exports.BitbucketServerEntityProvider = BitbucketServerEntityProvider;
|
|
310
|
+
exports.bitbucketServerEntityProviderCatalogModule = bitbucketServerEntityProviderCatalogModule;
|
|
272
311
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/lib/BitbucketServerClient.ts","../src/providers/BitbucketServerLocationParser.ts","../src/providers/BitbucketServerEntityProviderConfig.ts","../src/providers/BitbucketServerEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport fetch, { Request, Response } from 'node-fetch';\nimport {\n BitbucketServerIntegrationConfig,\n getBitbucketServerRequestOptions,\n} from '@backstage/integration';\nimport { BitbucketServerProject, BitbucketServerRepository } from './types';\n\n/**\n * A client for interacting with a Bitbucket Server instance\n *\n * @public\n */\nexport class BitbucketServerClient {\n private readonly config: BitbucketServerIntegrationConfig;\n\n static fromConfig(options: {\n config: BitbucketServerIntegrationConfig;\n }): BitbucketServerClient {\n return new BitbucketServerClient(options);\n }\n\n constructor(options: { config: BitbucketServerIntegrationConfig }) {\n this.config = options.config;\n }\n\n async listProjects(options: {\n listOptions?: BitbucketServerListOptions;\n }): Promise<BitbucketServerPagedResponse<BitbucketServerProject>> {\n return this.pagedRequest(\n `${this.config.apiBaseUrl}/projects`,\n options.listOptions,\n );\n }\n\n async listRepositories(options: {\n projectKey: string;\n listOptions?: BitbucketServerListOptions;\n }): Promise<BitbucketServerPagedResponse<BitbucketServerRepository>> {\n return this.pagedRequest(\n `${this.config.apiBaseUrl}/projects/${encodeURIComponent(\n options.projectKey,\n )}/repos`,\n options.listOptions,\n );\n }\n\n async getFile(options: {\n projectKey: string;\n repo: string;\n path: string;\n }): Promise<Response> {\n const base = new URL(this.config.apiBaseUrl);\n return fetch(\n `${base.protocol}//${base.host}/projects/${options.projectKey}/repos/${options.repo}/raw/${options.path}`,\n getBitbucketServerRequestOptions(this.config),\n );\n }\n\n async getRepository(options: {\n projectKey: string;\n repo: string;\n }): Promise<BitbucketServerRepository> {\n const request = `${this.config.apiBaseUrl}/projects/${options.projectKey}/repos/${options.repo}`;\n const response = await fetch(\n request,\n getBitbucketServerRequestOptions(this.config),\n );\n return response.json();\n }\n\n resolvePath(options: { projectKey: string; repo: string; path: string }): {\n path: string;\n } {\n const base = new URL(this.config.apiBaseUrl || '');\n\n return {\n path: `${base.protocol}//${base.host}/projects/${options.projectKey}/repos/${options.repo}${options.path}`,\n };\n }\n\n private async pagedRequest(\n endpoint: string,\n options?: BitbucketServerListOptions,\n ): Promise<BitbucketServerPagedResponse<any>> {\n const request = new URL(endpoint);\n for (const key in options) {\n if (options[key]) {\n request.searchParams.append(key, options[key]!.toString());\n }\n }\n return this.getTypeMapped(request);\n }\n\n private async getTypeMapped<T = any>(url: URL): Promise<T> {\n return this.get(url).then((response: Response) => {\n return response.json() as Promise<T>;\n });\n }\n\n private async get(url: URL): Promise<Response> {\n return this.request(new Request(url.toString(), { method: 'GET' }));\n }\n\n private async request(req: Request): Promise<Response> {\n return fetch(req, getBitbucketServerRequestOptions(this.config)).then(\n (response: Response) => {\n if (!response.ok) {\n throw new Error(\n `Unexpected response for ${req.method} ${req.url}. Expected 200 but got ${response.status} - ${response.statusText}`,\n );\n }\n return response;\n },\n );\n }\n}\n\n/**\n * @public\n */\nexport type BitbucketServerListOptions = {\n [key: string]: number | undefined;\n limit?: number | undefined;\n start?: number | undefined;\n};\n\n/**\n * @public\n */\nexport type BitbucketServerPagedResponse<T> = {\n size: number;\n limit: number;\n start: number;\n isLastPage: boolean;\n values: T[];\n nextPageStart: number;\n};\n\nexport async function* paginated(\n request: (\n options: BitbucketServerListOptions,\n ) => Promise<BitbucketServerPagedResponse<any>>,\n options?: BitbucketServerListOptions,\n) {\n const opts = options || { start: 0 };\n let res;\n do {\n res = await request(opts);\n opts.start = res.nextPageStart;\n for (const item of res.values) {\n yield item;\n }\n } while (!res.isLastPage);\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n LocationSpec,\n locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-backend';\nimport { Entity } from '@backstage/catalog-model';\nimport { Logger } from 'winston';\nimport { BitbucketServerClient } from '../lib';\n\n/**\n * A custom callback that reacts to finding a location by yielding entities.\n * Can be used for custom location/repository parsing logic.\n *\n * @public\n */\nexport type BitbucketServerLocationParser = (options: {\n client: BitbucketServerClient;\n location: LocationSpec;\n logger: Logger;\n}) => AsyncIterable<Entity>;\n\nexport const defaultBitbucketServerLocationParser =\n async function* defaultBitbucketServerLocationParser(options: {\n location: LocationSpec;\n }) {\n yield locationSpecToLocationEntity({ location: options.location });\n };\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\n\nconst DEFAULT_CATALOG_PATH = '/catalog-info.yaml';\nconst DEFAULT_PROVIDER_ID = 'default';\n\nexport type BitbucketServerEntityProviderConfig = {\n id: string;\n host: string;\n catalogPath: string;\n filters?: {\n projectKey?: RegExp;\n repoSlug?: RegExp;\n };\n};\n\nexport function readProviderConfigs(\n config: Config,\n): BitbucketServerEntityProviderConfig[] {\n const providersConfig = config.getOptionalConfig(\n 'catalog.providers.bitbucketServer',\n );\n if (!providersConfig) {\n return [];\n }\n if (providersConfig.has('host')) {\n // simple/single config variant\n return [readProviderConfig(DEFAULT_PROVIDER_ID, providersConfig)];\n }\n\n return providersConfig.keys().map(id => {\n const providerConfig = providersConfig.getConfig(id);\n\n return readProviderConfig(id, providerConfig);\n });\n}\n\nfunction readProviderConfig(\n id: string,\n config: Config,\n): BitbucketServerEntityProviderConfig {\n const host = config.getString('host');\n const catalogPath =\n config.getOptionalString('catalogPath') ?? DEFAULT_CATALOG_PATH;\n const projectKeyPattern = config.getOptionalString('filters.projectKey');\n const repoSlugPattern = config.getOptionalString('filters.repoSlug');\n\n return {\n id,\n host,\n catalogPath,\n filters: {\n projectKey: projectKeyPattern ? new RegExp(projectKeyPattern) : undefined,\n repoSlug: repoSlugPattern ? new RegExp(repoSlugPattern) : undefined,\n },\n };\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport { Config } from '@backstage/config';\nimport { TaskRunner } from '@backstage/backend-tasks';\nimport * as uuid from 'uuid';\nimport {\n BitbucketServerLocationParser,\n defaultBitbucketServerLocationParser,\n} from './BitbucketServerLocationParser';\nimport {\n BitbucketServerIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport { BitbucketServerClient, paginated } from '../lib';\nimport { InputError } from '@backstage/errors';\nimport {\n BitbucketServerEntityProviderConfig,\n readProviderConfigs,\n} from './BitbucketServerEntityProviderConfig';\nimport { Entity } from '@backstage/catalog-model';\n\n/**\n * Discovers catalog files located in Bitbucket Server.\n * The provider will search your Bitbucket Server instance and register catalog files matching the configured path\n * as Location entity and via following processing steps add all contained catalog entities.\n * This can be useful as an alternative to static locations or manually adding things to the catalog.\n *\n * @public\n */\nexport class BitbucketServerEntityProvider implements EntityProvider {\n private readonly integration: BitbucketServerIntegration;\n private readonly config: BitbucketServerEntityProviderConfig;\n private readonly parser: BitbucketServerLocationParser;\n private readonly logger: Logger;\n private readonly scheduleFn: () => Promise<void>;\n private connection?: EntityProviderConnection;\n\n static fromConfig(\n config: Config,\n options: {\n logger: Logger;\n schedule: TaskRunner;\n parser?: BitbucketServerLocationParser;\n },\n ): BitbucketServerEntityProvider[] {\n const integrations = ScmIntegrations.fromConfig(config);\n\n return readProviderConfigs(config).map(providerConfig => {\n const integration = integrations.bitbucketServer.byHost(\n providerConfig.host,\n );\n if (!integration) {\n throw new InputError(\n `No BitbucketServer integration found that matches host ${providerConfig.host}`,\n );\n }\n return new BitbucketServerEntityProvider(\n providerConfig,\n integration,\n options.logger,\n options.schedule,\n options.parser,\n );\n });\n }\n\n private constructor(\n config: BitbucketServerEntityProviderConfig,\n integration: BitbucketServerIntegration,\n logger: Logger,\n schedule: TaskRunner,\n parser?: BitbucketServerLocationParser,\n ) {\n this.integration = integration;\n this.config = config;\n this.parser = parser || defaultBitbucketServerLocationParser;\n this.logger = logger.child({\n target: this.getProviderName(),\n });\n this.scheduleFn = this.createScheduleFn(schedule);\n }\n\n private createScheduleFn(schedule: TaskRunner): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return schedule.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class: BitbucketServerEntityProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(error);\n }\n },\n });\n };\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n getProviderName(): string {\n return `bitbucketServer-provider:${this.config.id}`;\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n }\n\n async refresh(logger: Logger) {\n if (!this.connection) {\n throw new Error('Not initialized');\n }\n\n logger.info('Discovering catalog files in Bitbucket Server repositories');\n\n const entities = await this.findEntities();\n\n await this.connection.applyMutation({\n type: 'full',\n entities: entities.map(entity => ({\n locationKey: this.getProviderName(),\n entity: entity,\n })),\n });\n\n logger.info(\n `Committed ${entities.length} entities for Bitbucket Server repositories`,\n );\n }\n\n private async findEntities(): Promise<Entity[]> {\n const client = BitbucketServerClient.fromConfig({\n config: this.integration.config,\n });\n const projects = paginated(options =>\n client.listProjects({ listOptions: options }),\n );\n const result: Entity[] = [];\n for await (const project of projects) {\n if (\n this.config?.filters?.projectKey &&\n !this.config.filters.projectKey.test(project.key)\n ) {\n continue;\n }\n const repositories = paginated(options =>\n client.listRepositories({\n projectKey: project.key,\n listOptions: options,\n }),\n );\n for await (const repository of repositories) {\n if (\n this.config?.filters?.repoSlug &&\n !this.config.filters.repoSlug.test(repository.slug)\n ) {\n continue;\n }\n for await (const entity of this.parser({\n client,\n logger: this.logger,\n location: {\n type: 'url',\n target: `${repository.links.self[0].href}${this.config.catalogPath}`,\n presence: 'optional',\n },\n })) {\n result.push(entity);\n }\n }\n }\n return result;\n }\n}\n"],"names":["fetch","getBitbucketServerRequestOptions","Request","defaultBitbucketServerLocationParser","locationSpecToLocationEntity","ScmIntegrations","InputError","uuid"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BO,MAAM,qBAAsB,CAAA;AAAA,EAGjC,OAAO,WAAW,OAEQ,EAAA;AACxB,IAAO,OAAA,IAAI,sBAAsB,OAAO,CAAA,CAAA;AAAA,GAC1C;AAAA,EAEA,YAAY,OAAuD,EAAA;AACjE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,aAAa,OAE+C,EAAA;AAChE,IAAA,OAAO,IAAK,CAAA,YAAA;AAAA,MACV,CAAA,EAAG,KAAK,MAAO,CAAA,UAAA,CAAA,SAAA,CAAA;AAAA,MACf,OAAQ,CAAA,WAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,iBAAiB,OAG8C,EAAA;AACnE,IAAA,OAAO,IAAK,CAAA,YAAA;AAAA,MACV,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,UAAuB,CAAA,UAAA,EAAA,kBAAA;AAAA,QACpC,OAAQ,CAAA,UAAA;AAAA,OACV,CAAA,MAAA,CAAA;AAAA,MACA,OAAQ,CAAA,WAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,OAIQ,EAAA;AACpB,IAAA,MAAM,IAAO,GAAA,IAAI,GAAI,CAAA,IAAA,CAAK,OAAO,UAAU,CAAA,CAAA;AAC3C,IAAO,OAAAA,yBAAA;AAAA,MACL,CAAA,EAAG,KAAK,QAAa,CAAA,EAAA,EAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,UAAA,CAAA,OAAA,EAAoB,OAAQ,CAAA,IAAA,CAAA,KAAA,EAAY,OAAQ,CAAA,IAAA,CAAA,CAAA;AAAA,MACnGC,4CAAA,CAAiC,KAAK,MAAM,CAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,cAAc,OAGmB,EAAA;AACrC,IAAA,MAAM,UAAU,CAAG,EAAA,IAAA,CAAK,OAAO,UAAuB,CAAA,UAAA,EAAA,OAAA,CAAQ,oBAAoB,OAAQ,CAAA,IAAA,CAAA,CAAA,CAAA;AAC1F,IAAA,MAAM,WAAW,MAAMD,yBAAA;AAAA,MACrB,OAAA;AAAA,MACAC,4CAAA,CAAiC,KAAK,MAAM,CAAA;AAAA,KAC9C,CAAA;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,YAAY,OAEV,EAAA;AACA,IAAA,MAAM,OAAO,IAAI,GAAA,CAAI,IAAK,CAAA,MAAA,CAAO,cAAc,EAAE,CAAA,CAAA;AAEjD,IAAO,OAAA;AAAA,MACL,IAAA,EAAM,CAAG,EAAA,IAAA,CAAK,QAAa,CAAA,EAAA,EAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,UAAA,CAAA,OAAA,EAAoB,OAAQ,CAAA,IAAA,CAAA,EAAO,OAAQ,CAAA,IAAA,CAAA,CAAA;AAAA,KACtG,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,YACZ,CAAA,QAAA,EACA,OAC4C,EAAA;AAC5C,IAAM,MAAA,OAAA,GAAU,IAAI,GAAA,CAAI,QAAQ,CAAA,CAAA;AAChC,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAA,IAAI,QAAQ,GAAM,CAAA,EAAA;AAChB,QAAA,OAAA,CAAQ,aAAa,MAAO,CAAA,GAAA,EAAK,OAAQ,CAAA,GAAA,CAAA,CAAM,UAAU,CAAA,CAAA;AAAA,OAC3D;AAAA,KACF;AACA,IAAO,OAAA,IAAA,CAAK,cAAc,OAAO,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAc,cAAuB,GAAsB,EAAA;AACzD,IAAA,OAAO,KAAK,GAAI,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,CAAC,QAAuB,KAAA;AAChD,MAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,KACtB,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAc,IAAI,GAA6B,EAAA;AAC7C,IAAO,OAAA,IAAA,CAAK,OAAQ,CAAA,IAAIC,aAAQ,CAAA,GAAA,CAAI,QAAS,EAAA,EAAG,EAAE,MAAA,EAAQ,KAAM,EAAC,CAAC,CAAA,CAAA;AAAA,GACpE;AAAA,EAEA,MAAc,QAAQ,GAAiC,EAAA;AACrD,IAAA,OAAOF,0BAAM,GAAK,EAAAC,4CAAA,CAAiC,IAAK,CAAA,MAAM,CAAC,CAAE,CAAA,IAAA;AAAA,MAC/D,CAAC,QAAuB,KAAA;AACtB,QAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,2BAA2B,GAAI,CAAA,MAAA,CAAA,CAAA,EAAU,IAAI,GAA6B,CAAA,uBAAA,EAAA,QAAA,CAAS,YAAY,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,WAC1G,CAAA;AAAA,SACF;AACA,QAAO,OAAA,QAAA,CAAA;AAAA,OACT;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAuBuB,gBAAA,SAAA,CACrB,SAGA,OACA,EAAA;AACA,EAAA,MAAM,IAAO,GAAA,OAAA,IAAW,EAAE,KAAA,EAAO,CAAE,EAAA,CAAA;AACnC,EAAI,IAAA,GAAA,CAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,IAAI,CAAA,CAAA;AACxB,IAAA,IAAA,CAAK,QAAQ,GAAI,CAAA,aAAA,CAAA;AACjB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,MAAQ,EAAA;AAC7B,MAAM,MAAA,IAAA,CAAA;AAAA,KACR;AAAA,GACF,QAAS,CAAC,GAAI,CAAA,UAAA,EAAA;AAChB;;ACrIa,MAAA,oCAAA,GACX,gBAAgBE,qCAAAA,CAAqC,OAElD,EAAA;AACD,EAAA,MAAMC,iDAA6B,CAAA,EAAE,QAAU,EAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AACnE,CAAA;;ACvBF,MAAM,oBAAuB,GAAA,oBAAA,CAAA;AAC7B,MAAM,mBAAsB,GAAA,SAAA,CAAA;AAYrB,SAAS,oBACd,MACuC,EAAA;AACvC,EAAA,MAAM,kBAAkB,MAAO,CAAA,iBAAA;AAAA,IAC7B,mCAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AACA,EAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,MAAM,CAAG,EAAA;AAE/B,IAAA,OAAO,CAAC,kBAAA,CAAmB,mBAAqB,EAAA,eAAe,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAA,OAAO,eAAgB,CAAA,IAAA,EAAO,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA;AACtC,IAAM,MAAA,cAAA,GAAiB,eAAgB,CAAA,SAAA,CAAU,EAAE,CAAA,CAAA;AAEnD,IAAO,OAAA,kBAAA,CAAmB,IAAI,cAAc,CAAA,CAAA;AAAA,GAC7C,CAAA,CAAA;AACH,CAAA;AAEA,SAAS,kBAAA,CACP,IACA,MACqC,EAAA;AAvDvC,EAAA,IAAA,EAAA,CAAA;AAwDE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAA,MAAM,WACJ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,aAAa,MAAtC,IAA2C,GAAA,EAAA,GAAA,oBAAA,CAAA;AAC7C,EAAM,MAAA,iBAAA,GAAoB,MAAO,CAAA,iBAAA,CAAkB,oBAAoB,CAAA,CAAA;AACvE,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,CAAA;AAEnE,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,OAAS,EAAA;AAAA,MACP,UAAY,EAAA,iBAAA,GAAoB,IAAI,MAAA,CAAO,iBAAiB,CAAI,GAAA,KAAA,CAAA;AAAA,MAChE,QAAU,EAAA,eAAA,GAAkB,IAAI,MAAA,CAAO,eAAe,CAAI,GAAA,KAAA,CAAA;AAAA,KAC5D;AAAA,GACF,CAAA;AACF;;ACvBO,MAAM,6BAAwD,CAAA;AAAA,EAQnE,OAAO,UACL,CAAA,MAAA,EACA,OAKiC,EAAA;AACjC,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEtD,IAAA,OAAO,mBAAoB,CAAA,MAAM,CAAE,CAAA,GAAA,CAAI,CAAkB,cAAA,KAAA;AACvD,MAAM,MAAA,WAAA,GAAc,aAAa,eAAgB,CAAA,MAAA;AAAA,QAC/C,cAAe,CAAA,IAAA;AAAA,OACjB,CAAA;AACA,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,0DAA0D,cAAe,CAAA,IAAA,CAAA,CAAA;AAAA,SAC3E,CAAA;AAAA,OACF;AACA,MAAA,OAAO,IAAI,6BAAA;AAAA,QACT,cAAA;AAAA,QACA,WAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,QACR,OAAQ,CAAA,QAAA;AAAA,QACR,OAAQ,CAAA,MAAA;AAAA,OACV,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,MACA,EAAA;AACA,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,SAAS,MAAU,IAAA,oCAAA,CAAA;AACxB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,QAAQ,CAAA,CAAA;AAAA,GAClD;AAAA,EAEQ,iBAAiB,QAA2C,EAAA;AAClE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,MAAA,OAAO,SAAS,GAAI,CAAA;AAAA,QAClB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC3D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,yBAAA,EAA4B,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACjD;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,QAAQ,MAAgB,EAAA;AAC5B,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAA,CAAO,KAAK,4DAA4D,CAAA,CAAA;AAExE,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,YAAa,EAAA,CAAA;AAEzC,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,QAAS,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,QAChC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAA;AAAA,OACA,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,aAAa,QAAS,CAAA,MAAA,CAAA,2CAAA,CAAA;AAAA,KACxB,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,YAAkC,GAAA;AA5JlD,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA6JI,IAAM,MAAA,MAAA,GAAS,sBAAsB,UAAW,CAAA;AAAA,MAC9C,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,KAC1B,CAAA,CAAA;AACD,IAAA,MAAM,QAAW,GAAA,SAAA;AAAA,MAAU,aACzB,MAAO,CAAA,YAAA,CAAa,EAAE,WAAA,EAAa,SAAS,CAAA;AAAA,KAC9C,CAAA;AACA,IAAA,MAAM,SAAmB,EAAC,CAAA;AAC1B,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAA,IAAA,CAAA,CACE,EAAK,GAAA,CAAA,EAAA,GAAA,IAAA,CAAA,MAAA,KAAL,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,UACtB,KAAA,CAAC,IAAK,CAAA,MAAA,CAAO,OAAQ,CAAA,UAAA,CAAW,IAAK,CAAA,OAAA,CAAQ,GAAG,CAChD,EAAA;AACA,QAAA,SAAA;AAAA,OACF;AACA,MAAA,MAAM,YAAe,GAAA,SAAA;AAAA,QAAU,CAAA,OAAA,KAC7B,OAAO,gBAAiB,CAAA;AAAA,UACtB,YAAY,OAAQ,CAAA,GAAA;AAAA,UACpB,WAAa,EAAA,OAAA;AAAA,SACd,CAAA;AAAA,OACH,CAAA;AACA,MAAA,WAAA,MAAiB,cAAc,YAAc,EAAA;AAC3C,QAAA,IAAA,CAAA,CACE,EAAK,GAAA,CAAA,EAAA,GAAA,IAAA,CAAA,MAAA,KAAL,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,QACtB,KAAA,CAAC,IAAK,CAAA,MAAA,CAAO,OAAQ,CAAA,QAAA,CAAS,IAAK,CAAA,UAAA,CAAW,IAAI,CAClD,EAAA;AACA,UAAA,SAAA;AAAA,SACF;AACA,QAAiB,WAAA,MAAA,MAAA,IAAU,KAAK,MAAO,CAAA;AAAA,UACrC,MAAA;AAAA,UACA,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,QAAU,EAAA;AAAA,YACR,IAAM,EAAA,KAAA;AAAA,YACN,MAAA,EAAQ,GAAG,UAAW,CAAA,KAAA,CAAM,KAAK,CAAG,CAAA,CAAA,IAAA,CAAA,EAAO,KAAK,MAAO,CAAA,WAAA,CAAA,CAAA;AAAA,YACvD,QAAU,EAAA,UAAA;AAAA,WACZ;AAAA,SACD,CAAG,EAAA;AACF,UAAA,MAAA,CAAO,KAAK,MAAM,CAAA,CAAA;AAAA,SACpB;AAAA,OACF;AAAA,KACF;AACA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AACF;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/lib/BitbucketServerClient.ts","../src/providers/BitbucketServerEntityProviderConfig.ts","../src/providers/BitbucketServerLocationParser.ts","../src/providers/BitbucketServerEntityProvider.ts","../src/service/BitbucketServerEntityProviderCatalogModule.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport fetch, { Request, Response } from 'node-fetch';\nimport {\n BitbucketServerIntegrationConfig,\n getBitbucketServerRequestOptions,\n} from '@backstage/integration';\nimport { BitbucketServerProject, BitbucketServerRepository } from './types';\n\n/**\n * A client for interacting with a Bitbucket Server instance\n *\n * @public\n */\nexport class BitbucketServerClient {\n private readonly config: BitbucketServerIntegrationConfig;\n\n static fromConfig(options: {\n config: BitbucketServerIntegrationConfig;\n }): BitbucketServerClient {\n return new BitbucketServerClient(options);\n }\n\n constructor(options: { config: BitbucketServerIntegrationConfig }) {\n this.config = options.config;\n }\n\n async listProjects(options: {\n listOptions?: BitbucketServerListOptions;\n }): Promise<BitbucketServerPagedResponse<BitbucketServerProject>> {\n return this.pagedRequest(\n `${this.config.apiBaseUrl}/projects`,\n options.listOptions,\n );\n }\n\n async listRepositories(options: {\n projectKey: string;\n listOptions?: BitbucketServerListOptions;\n }): Promise<BitbucketServerPagedResponse<BitbucketServerRepository>> {\n return this.pagedRequest(\n `${this.config.apiBaseUrl}/projects/${encodeURIComponent(\n options.projectKey,\n )}/repos`,\n options.listOptions,\n );\n }\n\n async getFile(options: {\n projectKey: string;\n repo: string;\n path: string;\n }): Promise<Response> {\n const base = new URL(this.config.apiBaseUrl);\n return fetch(\n `${base.protocol}//${base.host}/projects/${options.projectKey}/repos/${options.repo}/raw/${options.path}`,\n getBitbucketServerRequestOptions(this.config),\n );\n }\n\n async getRepository(options: {\n projectKey: string;\n repo: string;\n }): Promise<BitbucketServerRepository> {\n const request = `${this.config.apiBaseUrl}/projects/${options.projectKey}/repos/${options.repo}`;\n const response = await fetch(\n request,\n getBitbucketServerRequestOptions(this.config),\n );\n return response.json();\n }\n\n resolvePath(options: { projectKey: string; repo: string; path: string }): {\n path: string;\n } {\n const base = new URL(this.config.apiBaseUrl || '');\n\n return {\n path: `${base.protocol}//${base.host}/projects/${options.projectKey}/repos/${options.repo}${options.path}`,\n };\n }\n\n private async pagedRequest(\n endpoint: string,\n options?: BitbucketServerListOptions,\n ): Promise<BitbucketServerPagedResponse<any>> {\n const request = new URL(endpoint);\n for (const key in options) {\n if (options[key]) {\n request.searchParams.append(key, options[key]!.toString());\n }\n }\n return this.getTypeMapped(request);\n }\n\n private async getTypeMapped<T = any>(url: URL): Promise<T> {\n return this.get(url).then((response: Response) => {\n return response.json() as Promise<T>;\n });\n }\n\n private async get(url: URL): Promise<Response> {\n return this.request(new Request(url.toString(), { method: 'GET' }));\n }\n\n private async request(req: Request): Promise<Response> {\n return fetch(req, getBitbucketServerRequestOptions(this.config)).then(\n (response: Response) => {\n if (!response.ok) {\n throw new Error(\n `Unexpected response for ${req.method} ${req.url}. Expected 200 but got ${response.status} - ${response.statusText}`,\n );\n }\n return response;\n },\n );\n }\n}\n\n/**\n * @public\n */\nexport type BitbucketServerListOptions = {\n [key: string]: number | undefined;\n limit?: number | undefined;\n start?: number | undefined;\n};\n\n/**\n * @public\n */\nexport type BitbucketServerPagedResponse<T> = {\n size: number;\n limit: number;\n start: number;\n isLastPage: boolean;\n values: T[];\n nextPageStart: number;\n};\n\nexport async function* paginated(\n request: (\n options: BitbucketServerListOptions,\n ) => Promise<BitbucketServerPagedResponse<any>>,\n options?: BitbucketServerListOptions,\n) {\n const opts = options || { start: 0 };\n let res;\n do {\n res = await request(opts);\n opts.start = res.nextPageStart;\n for (const item of res.values) {\n yield item;\n }\n } while (!res.isLastPage);\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n readTaskScheduleDefinitionFromConfig,\n TaskScheduleDefinition,\n} from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\n\nconst DEFAULT_CATALOG_PATH = '/catalog-info.yaml';\nconst DEFAULT_PROVIDER_ID = 'default';\n\nexport type BitbucketServerEntityProviderConfig = {\n id: string;\n host: string;\n catalogPath: string;\n filters?: {\n projectKey?: RegExp;\n repoSlug?: RegExp;\n };\n schedule?: TaskScheduleDefinition;\n};\n\nexport function readProviderConfigs(\n config: Config,\n): BitbucketServerEntityProviderConfig[] {\n const providersConfig = config.getOptionalConfig(\n 'catalog.providers.bitbucketServer',\n );\n if (!providersConfig) {\n return [];\n }\n if (providersConfig.has('host')) {\n // simple/single config variant\n return [readProviderConfig(DEFAULT_PROVIDER_ID, providersConfig)];\n }\n\n return providersConfig.keys().map(id => {\n const providerConfig = providersConfig.getConfig(id);\n\n return readProviderConfig(id, providerConfig);\n });\n}\n\nfunction readProviderConfig(\n id: string,\n config: Config,\n): BitbucketServerEntityProviderConfig {\n const host = config.getString('host');\n const catalogPath =\n config.getOptionalString('catalogPath') ?? DEFAULT_CATALOG_PATH;\n const projectKeyPattern = config.getOptionalString('filters.projectKey');\n const repoSlugPattern = config.getOptionalString('filters.repoSlug');\n\n const schedule = config.has('schedule')\n ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n : undefined;\n\n return {\n id,\n host,\n catalogPath,\n filters: {\n projectKey: projectKeyPattern ? new RegExp(projectKeyPattern) : undefined,\n repoSlug: repoSlugPattern ? new RegExp(repoSlugPattern) : undefined,\n },\n schedule,\n };\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n LocationSpec,\n locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-backend';\nimport { Entity } from '@backstage/catalog-model';\nimport { Logger } from 'winston';\nimport { BitbucketServerClient } from '../lib';\n\n/**\n * A custom callback that reacts to finding a location by yielding entities.\n * Can be used for custom location/repository parsing logic.\n *\n * @public\n */\nexport type BitbucketServerLocationParser = (options: {\n client: BitbucketServerClient;\n location: LocationSpec;\n logger: Logger;\n}) => AsyncIterable<Entity>;\n\nexport const defaultBitbucketServerLocationParser =\n async function* defaultBitbucketServerLocationParser(options: {\n location: LocationSpec;\n }) {\n yield locationSpecToLocationEntity({ location: options.location });\n };\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n BitbucketServerIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport * as uuid from 'uuid';\nimport { BitbucketServerClient, paginated } from '../lib';\nimport {\n BitbucketServerEntityProviderConfig,\n readProviderConfigs,\n} from './BitbucketServerEntityProviderConfig';\nimport {\n BitbucketServerLocationParser,\n defaultBitbucketServerLocationParser,\n} from './BitbucketServerLocationParser';\n\n/**\n * Discovers catalog files located in Bitbucket Server.\n * The provider will search your Bitbucket Server instance and register catalog files matching the configured path\n * as Location entity and via following processing steps add all contained catalog entities.\n * This can be useful as an alternative to static locations or manually adding things to the catalog.\n *\n * @public\n */\nexport class BitbucketServerEntityProvider implements EntityProvider {\n private readonly integration: BitbucketServerIntegration;\n private readonly config: BitbucketServerEntityProviderConfig;\n private readonly parser: BitbucketServerLocationParser;\n private readonly logger: Logger;\n private readonly scheduleFn: () => Promise<void>;\n private connection?: EntityProviderConnection;\n\n static fromConfig(\n config: Config,\n options: {\n logger: Logger;\n parser?: BitbucketServerLocationParser;\n schedule?: TaskRunner;\n scheduler?: PluginTaskScheduler;\n },\n ): BitbucketServerEntityProvider[] {\n const integrations = ScmIntegrations.fromConfig(config);\n\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n return readProviderConfigs(config).map(providerConfig => {\n const integration = integrations.bitbucketServer.byHost(\n providerConfig.host,\n );\n if (!integration) {\n throw new InputError(\n `No BitbucketServer integration found that matches host ${providerConfig.host}`,\n );\n }\n\n if (!options.schedule && !providerConfig.schedule) {\n throw new Error(\n `No schedule provided neither via code nor config for bitbucketServer-provider:${providerConfig.id}.`,\n );\n }\n\n const taskRunner =\n options.schedule ??\n options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n return new BitbucketServerEntityProvider(\n providerConfig,\n integration,\n options.logger,\n taskRunner,\n options.parser,\n );\n });\n }\n\n private constructor(\n config: BitbucketServerEntityProviderConfig,\n integration: BitbucketServerIntegration,\n logger: Logger,\n taskRunner: TaskRunner,\n parser?: BitbucketServerLocationParser,\n ) {\n this.integration = integration;\n this.config = config;\n this.parser = parser || defaultBitbucketServerLocationParser;\n this.logger = logger.child({\n target: this.getProviderName(),\n });\n this.scheduleFn = this.createScheduleFn(taskRunner);\n }\n\n private createScheduleFn(taskRunner: TaskRunner): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class: BitbucketServerEntityProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(error);\n }\n },\n });\n };\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n getProviderName(): string {\n return `bitbucketServer-provider:${this.config.id}`;\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n }\n\n async refresh(logger: Logger) {\n if (!this.connection) {\n throw new Error('Not initialized');\n }\n\n logger.info('Discovering catalog files in Bitbucket Server repositories');\n\n const entities = await this.findEntities();\n\n await this.connection.applyMutation({\n type: 'full',\n entities: entities.map(entity => ({\n locationKey: this.getProviderName(),\n entity: entity,\n })),\n });\n\n logger.info(\n `Committed ${entities.length} entities for Bitbucket Server repositories`,\n );\n }\n\n private async findEntities(): Promise<Entity[]> {\n const client = BitbucketServerClient.fromConfig({\n config: this.integration.config,\n });\n const projects = paginated(options =>\n client.listProjects({ listOptions: options }),\n );\n const result: Entity[] = [];\n for await (const project of projects) {\n if (\n this.config?.filters?.projectKey &&\n !this.config.filters.projectKey.test(project.key)\n ) {\n continue;\n }\n const repositories = paginated(options =>\n client.listRepositories({\n projectKey: project.key,\n listOptions: options,\n }),\n );\n for await (const repository of repositories) {\n if (\n this.config?.filters?.repoSlug &&\n !this.config.filters.repoSlug.test(repository.slug)\n ) {\n continue;\n }\n for await (const entity of this.parser({\n client,\n logger: this.logger,\n location: {\n type: 'url',\n target: `${repository.links.self[0].href}${this.config.catalogPath}`,\n presence: 'optional',\n },\n })) {\n result.push(entity);\n }\n }\n }\n return result;\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n configServiceRef,\n createBackendModule,\n loggerServiceRef,\n loggerToWinstonLogger,\n schedulerServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { BitbucketServerEntityProvider } from '../providers';\n\n/**\n * @alpha\n */\nexport const bitbucketServerEntityProviderCatalogModule = createBackendModule({\n pluginId: 'catalog',\n moduleId: 'bitbucketServerEntityProvider',\n register(env) {\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: configServiceRef,\n logger: loggerServiceRef,\n scheduler: schedulerServiceRef,\n },\n async init({ catalog, config, logger, scheduler }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n const providers = BitbucketServerEntityProvider.fromConfig(config, {\n logger: winstonLogger,\n scheduler,\n });\n\n catalog.addEntityProvider(providers);\n },\n });\n },\n});\n"],"names":["fetch","getBitbucketServerRequestOptions","Request","readTaskScheduleDefinitionFromConfig","defaultBitbucketServerLocationParser","locationSpecToLocationEntity","ScmIntegrations","InputError","uuid","createBackendModule","catalogProcessingExtensionPoint","configServiceRef","loggerServiceRef","schedulerServiceRef","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BO,MAAM,qBAAsB,CAAA;AAAA,EAGjC,OAAO,WAAW,OAEQ,EAAA;AACxB,IAAO,OAAA,IAAI,sBAAsB,OAAO,CAAA,CAAA;AAAA,GAC1C;AAAA,EAEA,YAAY,OAAuD,EAAA;AACjE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,aAAa,OAE+C,EAAA;AAChE,IAAA,OAAO,IAAK,CAAA,YAAA;AAAA,MACV,CAAA,EAAG,KAAK,MAAO,CAAA,UAAA,CAAA,SAAA,CAAA;AAAA,MACf,OAAQ,CAAA,WAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,iBAAiB,OAG8C,EAAA;AACnE,IAAA,OAAO,IAAK,CAAA,YAAA;AAAA,MACV,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,UAAuB,CAAA,UAAA,EAAA,kBAAA;AAAA,QACpC,OAAQ,CAAA,UAAA;AAAA,OACV,CAAA,MAAA,CAAA;AAAA,MACA,OAAQ,CAAA,WAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,OAIQ,EAAA;AACpB,IAAA,MAAM,IAAO,GAAA,IAAI,GAAI,CAAA,IAAA,CAAK,OAAO,UAAU,CAAA,CAAA;AAC3C,IAAO,OAAAA,yBAAA;AAAA,MACL,CAAA,EAAG,KAAK,QAAa,CAAA,EAAA,EAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,UAAA,CAAA,OAAA,EAAoB,OAAQ,CAAA,IAAA,CAAA,KAAA,EAAY,OAAQ,CAAA,IAAA,CAAA,CAAA;AAAA,MACnGC,4CAAA,CAAiC,KAAK,MAAM,CAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,cAAc,OAGmB,EAAA;AACrC,IAAA,MAAM,UAAU,CAAG,EAAA,IAAA,CAAK,OAAO,UAAuB,CAAA,UAAA,EAAA,OAAA,CAAQ,oBAAoB,OAAQ,CAAA,IAAA,CAAA,CAAA,CAAA;AAC1F,IAAA,MAAM,WAAW,MAAMD,yBAAA;AAAA,MACrB,OAAA;AAAA,MACAC,4CAAA,CAAiC,KAAK,MAAM,CAAA;AAAA,KAC9C,CAAA;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,YAAY,OAEV,EAAA;AACA,IAAA,MAAM,OAAO,IAAI,GAAA,CAAI,IAAK,CAAA,MAAA,CAAO,cAAc,EAAE,CAAA,CAAA;AAEjD,IAAO,OAAA;AAAA,MACL,IAAA,EAAM,CAAG,EAAA,IAAA,CAAK,QAAa,CAAA,EAAA,EAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,UAAA,CAAA,OAAA,EAAoB,OAAQ,CAAA,IAAA,CAAA,EAAO,OAAQ,CAAA,IAAA,CAAA,CAAA;AAAA,KACtG,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,YACZ,CAAA,QAAA,EACA,OAC4C,EAAA;AAC5C,IAAM,MAAA,OAAA,GAAU,IAAI,GAAA,CAAI,QAAQ,CAAA,CAAA;AAChC,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAA,IAAI,QAAQ,GAAM,CAAA,EAAA;AAChB,QAAA,OAAA,CAAQ,aAAa,MAAO,CAAA,GAAA,EAAK,OAAQ,CAAA,GAAA,CAAA,CAAM,UAAU,CAAA,CAAA;AAAA,OAC3D;AAAA,KACF;AACA,IAAO,OAAA,IAAA,CAAK,cAAc,OAAO,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAc,cAAuB,GAAsB,EAAA;AACzD,IAAA,OAAO,KAAK,GAAI,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,CAAC,QAAuB,KAAA;AAChD,MAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,KACtB,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAc,IAAI,GAA6B,EAAA;AAC7C,IAAO,OAAA,IAAA,CAAK,OAAQ,CAAA,IAAIC,aAAQ,CAAA,GAAA,CAAI,QAAS,EAAA,EAAG,EAAE,MAAA,EAAQ,KAAM,EAAC,CAAC,CAAA,CAAA;AAAA,GACpE;AAAA,EAEA,MAAc,QAAQ,GAAiC,EAAA;AACrD,IAAA,OAAOF,0BAAM,GAAK,EAAAC,4CAAA,CAAiC,IAAK,CAAA,MAAM,CAAC,CAAE,CAAA,IAAA;AAAA,MAC/D,CAAC,QAAuB,KAAA;AACtB,QAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,2BAA2B,GAAI,CAAA,MAAA,CAAA,CAAA,EAAU,IAAI,GAA6B,CAAA,uBAAA,EAAA,QAAA,CAAS,YAAY,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,WAC1G,CAAA;AAAA,SACF;AACA,QAAO,OAAA,QAAA,CAAA;AAAA,OACT;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAuBuB,gBAAA,SAAA,CACrB,SAGA,OACA,EAAA;AACA,EAAA,MAAM,IAAO,GAAA,OAAA,IAAW,EAAE,KAAA,EAAO,CAAE,EAAA,CAAA;AACnC,EAAI,IAAA,GAAA,CAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,IAAI,CAAA,CAAA;AACxB,IAAA,IAAA,CAAK,QAAQ,GAAI,CAAA,aAAA,CAAA;AACjB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,MAAQ,EAAA;AAC7B,MAAM,MAAA,IAAA,CAAA;AAAA,KACR;AAAA,GACF,QAAS,CAAC,GAAI,CAAA,UAAA,EAAA;AAChB;;ACnJA,MAAM,oBAAuB,GAAA,oBAAA,CAAA;AAC7B,MAAM,mBAAsB,GAAA,SAAA,CAAA;AAarB,SAAS,oBACd,MACuC,EAAA;AACvC,EAAA,MAAM,kBAAkB,MAAO,CAAA,iBAAA;AAAA,IAC7B,mCAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AACA,EAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,MAAM,CAAG,EAAA;AAE/B,IAAA,OAAO,CAAC,kBAAA,CAAmB,mBAAqB,EAAA,eAAe,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAA,OAAO,eAAgB,CAAA,IAAA,EAAO,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA;AACtC,IAAM,MAAA,cAAA,GAAiB,eAAgB,CAAA,SAAA,CAAU,EAAE,CAAA,CAAA;AAEnD,IAAO,OAAA,kBAAA,CAAmB,IAAI,cAAc,CAAA,CAAA;AAAA,GAC7C,CAAA,CAAA;AACH,CAAA;AAEA,SAAS,kBAAA,CACP,IACA,MACqC,EAAA;AA5DvC,EAAA,IAAA,EAAA,CAAA;AA6DE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAA,MAAM,WACJ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,aAAa,MAAtC,IAA2C,GAAA,EAAA,GAAA,oBAAA,CAAA;AAC7C,EAAM,MAAA,iBAAA,GAAoB,MAAO,CAAA,iBAAA,CAAkB,oBAAoB,CAAA,CAAA;AACvE,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,CAAA;AAEnE,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCE,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,OAAS,EAAA;AAAA,MACP,UAAY,EAAA,iBAAA,GAAoB,IAAI,MAAA,CAAO,iBAAiB,CAAI,GAAA,KAAA,CAAA;AAAA,MAChE,QAAU,EAAA,eAAA,GAAkB,IAAI,MAAA,CAAO,eAAe,CAAI,GAAA,KAAA,CAAA;AAAA,KAC5D;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF;;AC7Ca,MAAA,oCAAA,GACX,gBAAgBC,qCAAAA,CAAqC,OAElD,EAAA;AACD,EAAA,MAAMC,iDAA6B,CAAA,EAAE,QAAU,EAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AACnE,CAAA;;ACOK,MAAM,6BAAwD,CAAA;AAAA,EAQnE,OAAO,UACL,CAAA,MAAA,EACA,OAMiC,EAAA;AACjC,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEtD,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAA,OAAO,mBAAoB,CAAA,MAAM,CAAE,CAAA,GAAA,CAAI,CAAkB,cAAA,KAAA;AAvE7D,MAAA,IAAA,EAAA,CAAA;AAwEM,MAAM,MAAA,WAAA,GAAc,aAAa,eAAgB,CAAA,MAAA;AAAA,QAC/C,cAAe,CAAA,IAAA;AAAA,OACjB,CAAA;AACA,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,0DAA0D,cAAe,CAAA,IAAA,CAAA,CAAA;AAAA,SAC3E,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,iFAAiF,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SAClG,CAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAA,OAAO,IAAI,6BAAA;AAAA,QACT,cAAA;AAAA,QACA,WAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,QACR,UAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,OACV,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,YACA,MACA,EAAA;AACA,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,SAAS,MAAU,IAAA,oCAAA,CAAA;AACxB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC3D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,yBAAA,EAA4B,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACjD;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,QAAQ,MAAgB,EAAA;AAC5B,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAA,CAAO,KAAK,4DAA4D,CAAA,CAAA;AAExE,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,YAAa,EAAA,CAAA;AAEzC,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,QAAS,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,QAChC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAA;AAAA,OACA,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,aAAa,QAAS,CAAA,MAAA,CAAA,2CAAA,CAAA;AAAA,KACxB,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,YAAkC,GAAA;AA5KlD,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA6KI,IAAM,MAAA,MAAA,GAAS,sBAAsB,UAAW,CAAA;AAAA,MAC9C,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,KAC1B,CAAA,CAAA;AACD,IAAA,MAAM,QAAW,GAAA,SAAA;AAAA,MAAU,aACzB,MAAO,CAAA,YAAA,CAAa,EAAE,WAAA,EAAa,SAAS,CAAA;AAAA,KAC9C,CAAA;AACA,IAAA,MAAM,SAAmB,EAAC,CAAA;AAC1B,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAA,IAAA,CAAA,CACE,EAAK,GAAA,CAAA,EAAA,GAAA,IAAA,CAAA,MAAA,KAAL,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,UACtB,KAAA,CAAC,IAAK,CAAA,MAAA,CAAO,OAAQ,CAAA,UAAA,CAAW,IAAK,CAAA,OAAA,CAAQ,GAAG,CAChD,EAAA;AACA,QAAA,SAAA;AAAA,OACF;AACA,MAAA,MAAM,YAAe,GAAA,SAAA;AAAA,QAAU,CAAA,OAAA,KAC7B,OAAO,gBAAiB,CAAA;AAAA,UACtB,YAAY,OAAQ,CAAA,GAAA;AAAA,UACpB,WAAa,EAAA,OAAA;AAAA,SACd,CAAA;AAAA,OACH,CAAA;AACA,MAAA,WAAA,MAAiB,cAAc,YAAc,EAAA;AAC3C,QAAA,IAAA,CAAA,CACE,EAAK,GAAA,CAAA,EAAA,GAAA,IAAA,CAAA,MAAA,KAAL,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,QACtB,KAAA,CAAC,IAAK,CAAA,MAAA,CAAO,OAAQ,CAAA,QAAA,CAAS,IAAK,CAAA,UAAA,CAAW,IAAI,CAClD,EAAA;AACA,UAAA,SAAA;AAAA,SACF;AACA,QAAiB,WAAA,MAAA,MAAA,IAAU,KAAK,MAAO,CAAA;AAAA,UACrC,MAAA;AAAA,UACA,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,QAAU,EAAA;AAAA,YACR,IAAM,EAAA,KAAA;AAAA,YACN,MAAA,EAAQ,GAAG,UAAW,CAAA,KAAA,CAAM,KAAK,CAAG,CAAA,CAAA,IAAA,CAAA,EAAO,KAAK,MAAO,CAAA,WAAA,CAAA,CAAA;AAAA,YACvD,QAAU,EAAA,UAAA;AAAA,WACZ;AAAA,SACD,CAAG,EAAA;AACF,UAAA,MAAA,CAAO,KAAK,MAAM,CAAA,CAAA;AAAA,SACpB;AAAA,OACF;AAAA,KACF;AACA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AACF;;AC1LO,MAAM,6CAA6CC,oCAAoB,CAAA;AAAA,EAC5E,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,+BAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,iDAAA;AAAA,QACT,MAAQ,EAAAC,iCAAA;AAAA,QACR,MAAQ,EAAAC,iCAAA;AAAA,QACR,SAAW,EAAAC,oCAAA;AAAA,OACb;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAM,MAAA,aAAA,GAAgBC,uCAAsB,MAAM,CAAA,CAAA;AAClD,QAAM,MAAA,SAAA,GAAY,6BAA8B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACjE,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,OAAA,CAAQ,kBAAkB,SAAS,CAAA,CAAA;AAAA,OACrC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,33 +1,27 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* A Backstage catalog backend module that helps integrate towards Bitbucket Server
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
2
8
|
import { BitbucketServerIntegrationConfig } from '@backstage/integration';
|
|
3
|
-
import { LocationSpec, EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-backend';
|
|
4
|
-
import { Logger } from 'winston';
|
|
5
9
|
import { Config } from '@backstage/config';
|
|
6
|
-
import { TaskRunner } from '@backstage/backend-tasks';
|
|
7
10
|
import { Entity } from '@backstage/catalog-model';
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
description: string;
|
|
16
|
-
links: Record<string, {
|
|
17
|
-
href: string;
|
|
18
|
-
}[]>;
|
|
19
|
-
};
|
|
20
|
-
/** @public */
|
|
21
|
-
declare type BitbucketServerProject = {
|
|
22
|
-
key: string;
|
|
23
|
-
};
|
|
11
|
+
import { EntityProvider } from '@backstage/plugin-catalog-backend';
|
|
12
|
+
import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
|
|
13
|
+
import { LocationSpec } from '@backstage/plugin-catalog-backend';
|
|
14
|
+
import { Logger } from 'winston';
|
|
15
|
+
import { PluginTaskScheduler } from '@backstage/backend-tasks';
|
|
16
|
+
import { Response as Response_2 } from 'node-fetch';
|
|
17
|
+
import { TaskRunner } from '@backstage/backend-tasks';
|
|
24
18
|
|
|
25
19
|
/**
|
|
26
20
|
* A client for interacting with a Bitbucket Server instance
|
|
27
21
|
*
|
|
28
22
|
* @public
|
|
29
23
|
*/
|
|
30
|
-
declare class BitbucketServerClient {
|
|
24
|
+
export declare class BitbucketServerClient {
|
|
31
25
|
private readonly config;
|
|
32
26
|
static fromConfig(options: {
|
|
33
27
|
config: BitbucketServerIntegrationConfig;
|
|
@@ -46,7 +40,7 @@ declare class BitbucketServerClient {
|
|
|
46
40
|
projectKey: string;
|
|
47
41
|
repo: string;
|
|
48
42
|
path: string;
|
|
49
|
-
}): Promise<
|
|
43
|
+
}): Promise<Response_2>;
|
|
50
44
|
getRepository(options: {
|
|
51
45
|
projectKey: string;
|
|
52
46
|
repo: string;
|
|
@@ -63,37 +57,6 @@ declare class BitbucketServerClient {
|
|
|
63
57
|
private get;
|
|
64
58
|
private request;
|
|
65
59
|
}
|
|
66
|
-
/**
|
|
67
|
-
* @public
|
|
68
|
-
*/
|
|
69
|
-
declare type BitbucketServerListOptions = {
|
|
70
|
-
[key: string]: number | undefined;
|
|
71
|
-
limit?: number | undefined;
|
|
72
|
-
start?: number | undefined;
|
|
73
|
-
};
|
|
74
|
-
/**
|
|
75
|
-
* @public
|
|
76
|
-
*/
|
|
77
|
-
declare type BitbucketServerPagedResponse<T> = {
|
|
78
|
-
size: number;
|
|
79
|
-
limit: number;
|
|
80
|
-
start: number;
|
|
81
|
-
isLastPage: boolean;
|
|
82
|
-
values: T[];
|
|
83
|
-
nextPageStart: number;
|
|
84
|
-
};
|
|
85
|
-
|
|
86
|
-
/**
|
|
87
|
-
* A custom callback that reacts to finding a location by yielding entities.
|
|
88
|
-
* Can be used for custom location/repository parsing logic.
|
|
89
|
-
*
|
|
90
|
-
* @public
|
|
91
|
-
*/
|
|
92
|
-
declare type BitbucketServerLocationParser = (options: {
|
|
93
|
-
client: BitbucketServerClient;
|
|
94
|
-
location: LocationSpec;
|
|
95
|
-
logger: Logger;
|
|
96
|
-
}) => AsyncIterable<Entity>;
|
|
97
60
|
|
|
98
61
|
/**
|
|
99
62
|
* Discovers catalog files located in Bitbucket Server.
|
|
@@ -103,7 +66,7 @@ declare type BitbucketServerLocationParser = (options: {
|
|
|
103
66
|
*
|
|
104
67
|
* @public
|
|
105
68
|
*/
|
|
106
|
-
declare class BitbucketServerEntityProvider implements EntityProvider {
|
|
69
|
+
export declare class BitbucketServerEntityProvider implements EntityProvider {
|
|
107
70
|
private readonly integration;
|
|
108
71
|
private readonly config;
|
|
109
72
|
private readonly parser;
|
|
@@ -112,8 +75,9 @@ declare class BitbucketServerEntityProvider implements EntityProvider {
|
|
|
112
75
|
private connection?;
|
|
113
76
|
static fromConfig(config: Config, options: {
|
|
114
77
|
logger: Logger;
|
|
115
|
-
schedule: TaskRunner;
|
|
116
78
|
parser?: BitbucketServerLocationParser;
|
|
79
|
+
schedule?: TaskRunner;
|
|
80
|
+
scheduler?: PluginTaskScheduler;
|
|
117
81
|
}): BitbucketServerEntityProvider[];
|
|
118
82
|
private constructor();
|
|
119
83
|
private createScheduleFn;
|
|
@@ -125,4 +89,56 @@ declare class BitbucketServerEntityProvider implements EntityProvider {
|
|
|
125
89
|
private findEntities;
|
|
126
90
|
}
|
|
127
91
|
|
|
128
|
-
|
|
92
|
+
/* Excluded from this release type: bitbucketServerEntityProviderCatalogModule */
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export declare type BitbucketServerListOptions = {
|
|
98
|
+
[key: string]: number | undefined;
|
|
99
|
+
limit?: number | undefined;
|
|
100
|
+
start?: number | undefined;
|
|
101
|
+
};
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* A custom callback that reacts to finding a location by yielding entities.
|
|
105
|
+
* Can be used for custom location/repository parsing logic.
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare type BitbucketServerLocationParser = (options: {
|
|
110
|
+
client: BitbucketServerClient;
|
|
111
|
+
location: LocationSpec;
|
|
112
|
+
logger: Logger;
|
|
113
|
+
}) => AsyncIterable<Entity>;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export declare type BitbucketServerPagedResponse<T> = {
|
|
119
|
+
size: number;
|
|
120
|
+
limit: number;
|
|
121
|
+
start: number;
|
|
122
|
+
isLastPage: boolean;
|
|
123
|
+
values: T[];
|
|
124
|
+
nextPageStart: number;
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
/** @public */
|
|
128
|
+
export declare type BitbucketServerProject = {
|
|
129
|
+
key: string;
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
/** @public */
|
|
133
|
+
export declare type BitbucketServerRepository = {
|
|
134
|
+
project: {
|
|
135
|
+
key: string;
|
|
136
|
+
};
|
|
137
|
+
slug: string;
|
|
138
|
+
description: string;
|
|
139
|
+
links: Record<string, {
|
|
140
|
+
href: string;
|
|
141
|
+
}[]>;
|
|
142
|
+
};
|
|
143
|
+
|
|
144
|
+
export { }
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-bitbucket-server",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3-next.0",
|
|
4
4
|
"main": "dist/index.cjs.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"publishConfig": {
|
|
8
8
|
"access": "public",
|
|
9
|
+
"alphaTypes": "dist/index.alpha.d.ts",
|
|
9
10
|
"main": "dist/index.cjs.js",
|
|
10
11
|
"types": "dist/index.d.ts"
|
|
11
12
|
},
|
|
@@ -23,34 +24,38 @@
|
|
|
23
24
|
],
|
|
24
25
|
"scripts": {
|
|
25
26
|
"start": "backstage-cli package start",
|
|
26
|
-
"build": "backstage-cli package build",
|
|
27
|
+
"build": "backstage-cli package build --experimental-type-build",
|
|
27
28
|
"lint": "backstage-cli package lint",
|
|
28
29
|
"test": "backstage-cli package test",
|
|
29
|
-
"clean": "backstage-cli package clean",
|
|
30
30
|
"prepack": "backstage-cli package prepack",
|
|
31
|
-
"postpack": "backstage-cli package postpack"
|
|
31
|
+
"postpack": "backstage-cli package postpack",
|
|
32
|
+
"clean": "backstage-cli package clean"
|
|
32
33
|
},
|
|
33
34
|
"dependencies": {
|
|
34
|
-
"@backstage/backend-common": "^0.
|
|
35
|
-
"@backstage/backend-
|
|
36
|
-
"@backstage/
|
|
37
|
-
"@backstage/
|
|
38
|
-
"@backstage/
|
|
39
|
-
"@backstage/
|
|
40
|
-
"@backstage/
|
|
35
|
+
"@backstage/backend-common": "^0.16.0-next.0",
|
|
36
|
+
"@backstage/backend-plugin-api": "^0.1.4-next.0",
|
|
37
|
+
"@backstage/backend-tasks": "^0.3.7-next.0",
|
|
38
|
+
"@backstage/catalog-model": "^1.1.3-next.0",
|
|
39
|
+
"@backstage/config": "^1.0.4-next.0",
|
|
40
|
+
"@backstage/errors": "^1.1.3-next.0",
|
|
41
|
+
"@backstage/integration": "^1.4.0-next.0",
|
|
42
|
+
"@backstage/plugin-catalog-backend": "^1.5.1-next.0",
|
|
43
|
+
"@backstage/plugin-catalog-node": "^1.2.1-next.0",
|
|
41
44
|
"@types/node-fetch": "^2.5.12",
|
|
42
45
|
"node-fetch": "^2.6.7",
|
|
43
46
|
"uuid": "^8.0.0",
|
|
44
47
|
"winston": "^3.2.1"
|
|
45
48
|
},
|
|
46
49
|
"devDependencies": {
|
|
47
|
-
"@backstage/backend-test-utils": "^0.1.
|
|
48
|
-
"@backstage/cli": "^0.
|
|
50
|
+
"@backstage/backend-test-utils": "^0.1.30-next.0",
|
|
51
|
+
"@backstage/cli": "^0.21.0-next.0",
|
|
52
|
+
"luxon": "^3.0.0",
|
|
49
53
|
"msw": "^0.47.0"
|
|
50
54
|
},
|
|
51
55
|
"files": [
|
|
52
|
-
"
|
|
53
|
-
"config.d.ts"
|
|
56
|
+
"alpha",
|
|
57
|
+
"config.d.ts",
|
|
58
|
+
"dist"
|
|
54
59
|
],
|
|
55
60
|
"configSchema": "config.d.ts"
|
|
56
61
|
}
|