@backstage/plugin-catalog-backend 0.19.3 → 0.21.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 +222 -0
- package/dist/index.cjs.js +941 -1865
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +192 -569
- package/migrations/20220116144621_remove_legacy.js +28 -0
- package/package.json +15 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,227 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend
|
|
2
2
|
|
|
3
|
+
## 0.21.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 9f2a8dc423: **BREAKING**: Removed all remnants of the old catalog engine implementation.
|
|
8
|
+
|
|
9
|
+
The old implementation has been deprecated for over half a year. To ensure that
|
|
10
|
+
you are not using the old implementation, check that your
|
|
11
|
+
`packages/backend/src/plugins/catalog.ts` creates the catalog builder using
|
|
12
|
+
`CatalogBuilder.create`. If you instead call `new CatalogBuilder`, you are on
|
|
13
|
+
the old implementation and will experience breakage if you upgrade to this
|
|
14
|
+
version. If you are still on the old version, see [the relevant change log
|
|
15
|
+
entry](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/CHANGELOG.md#patch-changes-27)
|
|
16
|
+
for migration instructions.
|
|
17
|
+
|
|
18
|
+
The minimal `packages/backend/src/plugins/catalog.ts` file is now:
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
export default async function createPlugin(
|
|
22
|
+
env: PluginEnvironment,
|
|
23
|
+
): Promise<Router> {
|
|
24
|
+
const builder = await CatalogBuilder.create(env);
|
|
25
|
+
builder.addProcessor(new ScaffolderEntitiesProcessor());
|
|
26
|
+
const { processingEngine, router } = await builder.build();
|
|
27
|
+
await processingEngine.start();
|
|
28
|
+
return router;
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
The following classes and interfaces have been removed:
|
|
33
|
+
|
|
34
|
+
- The `CatalogBuilder` constructor (see above; use `CatalogBuilder.create`
|
|
35
|
+
instead)
|
|
36
|
+
- `AddLocationResult`
|
|
37
|
+
- `CommonDatabase`
|
|
38
|
+
- `CreateDatabaseOptions`
|
|
39
|
+
- `createNextRouter` (use `createRouter` instead - or preferably, use the
|
|
40
|
+
`router` field returned for you by `catalogBuilder.build()`)
|
|
41
|
+
- `Database`
|
|
42
|
+
- `DatabaseEntitiesCatalog` (use `EntitiesCatalog` instead)
|
|
43
|
+
- `DatabaseLocationsCatalog` (use `LocationService` instead)
|
|
44
|
+
- `DatabaseLocationUpdateLogEvent`
|
|
45
|
+
- `DatabaseLocationUpdateLogStatus`
|
|
46
|
+
- `DatabaseManager`
|
|
47
|
+
- `DbEntitiesRequest`
|
|
48
|
+
- `DbEntitiesResponse`
|
|
49
|
+
- `DbEntityRequest`
|
|
50
|
+
- `DbEntityResponse`
|
|
51
|
+
- `DbLocationsRow`
|
|
52
|
+
- `DbLocationsRowWithStatus`
|
|
53
|
+
- `DbPageInfo`
|
|
54
|
+
- `EntitiesCatalog.batchAddOrUpdateEntities` (was only used by the legacy
|
|
55
|
+
engine)
|
|
56
|
+
- `EntityUpsertRequest`
|
|
57
|
+
- `EntityUpsertResponse`
|
|
58
|
+
- `HigherOrderOperation`
|
|
59
|
+
- `HigherOrderOperations`
|
|
60
|
+
- `LocationReader`
|
|
61
|
+
- `LocationReaders`
|
|
62
|
+
- `LocationResponse`
|
|
63
|
+
- `LocationsCatalog`
|
|
64
|
+
- `LocationUpdateLogEvent`
|
|
65
|
+
- `LocationUpdateStatus`
|
|
66
|
+
- `NextCatalogBuilder` (use `CatalogBuilder.create` instead)
|
|
67
|
+
- `NextRouterOptions` (use `RouterOptions` instead)
|
|
68
|
+
- `ReadLocationEntity`
|
|
69
|
+
- `ReadLocationError`
|
|
70
|
+
- `ReadLocationResult`
|
|
71
|
+
- `Transaction`
|
|
72
|
+
|
|
73
|
+
The `RouterOptions` interface has been un-deprecated, and has instead found use
|
|
74
|
+
for passing into `createRouter`. Its shape has been significantly changed to
|
|
75
|
+
accommodate the new router.
|
|
76
|
+
|
|
77
|
+
### Patch Changes
|
|
78
|
+
|
|
79
|
+
- e15ce5c16e: Integrate authorization into the delete entities endpoint
|
|
80
|
+
- dce98a92f7: Now when entities are deleted, the parent entity state is updated such that it will "heal" accidental deletes on the next refresh round.
|
|
81
|
+
- 02687954ca: Fixed a typo and made a little clarification to a warning message
|
|
82
|
+
- 48248e2db5: Integrate permissions into entity ancestry endpoint in catalog-backend
|
|
83
|
+
- 68edbbeafd: Fix bug with resource loading in permission integration
|
|
84
|
+
- 7e38acaa9e: Integrate permissions into catalog-backend location endpoints
|
|
85
|
+
- 6680853e0c: Export conditional permission policy helpers from catalog-backend
|
|
86
|
+
- 2b27e49eb1: Internal update to match status field changes in `@backstage/catalog-model`.
|
|
87
|
+
- Updated dependencies
|
|
88
|
+
- @backstage/integration@0.7.2
|
|
89
|
+
- @backstage/plugin-permission-common@0.4.0
|
|
90
|
+
- @backstage/backend-common@0.10.4
|
|
91
|
+
- @backstage/config@0.1.13
|
|
92
|
+
- @backstage/plugin-permission-node@0.4.0
|
|
93
|
+
- @backstage/plugin-catalog-common@0.1.1
|
|
94
|
+
- @backstage/catalog-model@0.9.10
|
|
95
|
+
- @backstage/catalog-client@0.5.5
|
|
96
|
+
|
|
97
|
+
## 0.21.0-next.0
|
|
98
|
+
|
|
99
|
+
### Minor Changes
|
|
100
|
+
|
|
101
|
+
- 9f2a8dc423: **BREAKING**: Removed all remnants of the old catalog engine implementation.
|
|
102
|
+
|
|
103
|
+
The old implementation has been deprecated for over half a year. To ensure that
|
|
104
|
+
you are not using the old implementation, check that your
|
|
105
|
+
`packages/backend/src/plugins/catalog.ts` creates the catalog builder using
|
|
106
|
+
`CatalogBuilder.create`. If you instead call `new CatalogBuilder`, you are on
|
|
107
|
+
the old implementation and will experience breakage if you upgrade to this
|
|
108
|
+
version. If you are still on the old version, see [the relevant change log
|
|
109
|
+
entry](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/CHANGELOG.md#patch-changes-27)
|
|
110
|
+
for migration instructions.
|
|
111
|
+
|
|
112
|
+
The minimal `packages/backend/src/plugins/catalog.ts` file is now:
|
|
113
|
+
|
|
114
|
+
```ts
|
|
115
|
+
export default async function createPlugin(
|
|
116
|
+
env: PluginEnvironment,
|
|
117
|
+
): Promise<Router> {
|
|
118
|
+
const builder = await CatalogBuilder.create(env);
|
|
119
|
+
builder.addProcessor(new ScaffolderEntitiesProcessor());
|
|
120
|
+
const { processingEngine, router } = await builder.build();
|
|
121
|
+
await processingEngine.start();
|
|
122
|
+
return router;
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
The following classes and interfaces have been removed:
|
|
127
|
+
|
|
128
|
+
- The `CatalogBuilder` constructor (see above; use `CatalogBuilder.create`
|
|
129
|
+
instead)
|
|
130
|
+
- `AddLocationResult`
|
|
131
|
+
- `CommonDatabase`
|
|
132
|
+
- `CreateDatabaseOptions`
|
|
133
|
+
- `createNextRouter` (use `createRouter` instead - or preferably, use the
|
|
134
|
+
`router` field returned for you by `catalogBuilder.build()`)
|
|
135
|
+
- `Database`
|
|
136
|
+
- `DatabaseEntitiesCatalog` (use `EntitiesCatalog` instead)
|
|
137
|
+
- `DatabaseLocationsCatalog` (use `LocationService` instead)
|
|
138
|
+
- `DatabaseLocationUpdateLogEvent`
|
|
139
|
+
- `DatabaseLocationUpdateLogStatus`
|
|
140
|
+
- `DatabaseManager`
|
|
141
|
+
- `DbEntitiesRequest`
|
|
142
|
+
- `DbEntitiesResponse`
|
|
143
|
+
- `DbEntityRequest`
|
|
144
|
+
- `DbEntityResponse`
|
|
145
|
+
- `DbLocationsRow`
|
|
146
|
+
- `DbLocationsRowWithStatus`
|
|
147
|
+
- `DbPageInfo`
|
|
148
|
+
- `EntitiesCatalog.batchAddOrUpdateEntities` (was only used by the legacy
|
|
149
|
+
engine)
|
|
150
|
+
- `EntityUpsertRequest`
|
|
151
|
+
- `EntityUpsertResponse`
|
|
152
|
+
- `HigherOrderOperation`
|
|
153
|
+
- `HigherOrderOperations`
|
|
154
|
+
- `LocationReader`
|
|
155
|
+
- `LocationReaders`
|
|
156
|
+
- `LocationResponse`
|
|
157
|
+
- `LocationsCatalog`
|
|
158
|
+
- `LocationUpdateLogEvent`
|
|
159
|
+
- `LocationUpdateStatus`
|
|
160
|
+
- `NextCatalogBuilder` (use `CatalogBuilder.create` instead)
|
|
161
|
+
- `NextRouterOptions` (use `RouterOptions` instead)
|
|
162
|
+
- `ReadLocationEntity`
|
|
163
|
+
- `ReadLocationError`
|
|
164
|
+
- `ReadLocationResult`
|
|
165
|
+
- `Transaction`
|
|
166
|
+
|
|
167
|
+
The `RouterOptions` interface has been un-deprecated, and has instead found use
|
|
168
|
+
for passing into `createRouter`. Its shape has been significantly changed to
|
|
169
|
+
accommodate the new router.
|
|
170
|
+
|
|
171
|
+
### Patch Changes
|
|
172
|
+
|
|
173
|
+
- e15ce5c16e: Integrate authorization into the delete entities endpoint
|
|
174
|
+
- dce98a92f7: Now when entities are deleted, the parent entity state is updated such that it will "heal" accidental deletes on the next refresh round.
|
|
175
|
+
- 02687954ca: Fixed a typo and made a little clarification to a warning message
|
|
176
|
+
- 48248e2db5: Integrate permissions into entity ancestry endpoint in catalog-backend
|
|
177
|
+
- 68edbbeafd: Fix bug with resource loading in permission integration
|
|
178
|
+
- 2b27e49eb1: Internal update to match status field changes in `@backstage/catalog-model`.
|
|
179
|
+
- Updated dependencies
|
|
180
|
+
- @backstage/plugin-permission-common@0.4.0-next.0
|
|
181
|
+
- @backstage/backend-common@0.10.4-next.0
|
|
182
|
+
- @backstage/config@0.1.13-next.0
|
|
183
|
+
- @backstage/plugin-permission-node@0.4.0-next.0
|
|
184
|
+
- @backstage/catalog-model@0.9.10-next.0
|
|
185
|
+
- @backstage/plugin-catalog-common@0.1.1-next.0
|
|
186
|
+
- @backstage/catalog-client@0.5.5-next.0
|
|
187
|
+
- @backstage/integration@0.7.2-next.0
|
|
188
|
+
|
|
189
|
+
## 0.20.0
|
|
190
|
+
|
|
191
|
+
### Minor Changes
|
|
192
|
+
|
|
193
|
+
- cd529c4094: In order to integrate the permissions system with the refresh endpoint in catalog-backend, a new AuthorizedRefreshService was created as a thin wrapper around the existing refresh service which performs authorization and handles the case when authorization is denied. In order to instantiate AuthorizedRefreshService, a permission client is required, which was added as a new field to `CatalogEnvironment`.
|
|
194
|
+
|
|
195
|
+
The new `permissions` field in `CatalogEnvironment` should already receive the permission client from the `PluginEnvrionment`, so there should be no changes required to the catalog backend setup. See [the create-app changelog](https://github.com/backstage/backstage/blob/master/packages/create-app/CHANGELOG.md) for more details.
|
|
196
|
+
|
|
197
|
+
### Patch Changes
|
|
198
|
+
|
|
199
|
+
- 0ae759dad4: Add catalog permission rules.
|
|
200
|
+
- 3b4d8caff6: Allow a custom GithubCredentialsProvider to be passed to the GitHub processors.
|
|
201
|
+
- 6fd70f8bc8: Provide support for Bitbucket servers with custom BaseURLs.
|
|
202
|
+
- 5333451def: Cleaned up API exports
|
|
203
|
+
- 730d01ab1a: Add apply-conditions endpoint for evaluating conditional permissions in catalog backend.
|
|
204
|
+
- 0a6c68582a: Add authorization to catalog-backend entities GET endpoints
|
|
205
|
+
- Updated dependencies
|
|
206
|
+
- @backstage/config@0.1.12
|
|
207
|
+
- @backstage/integration@0.7.1
|
|
208
|
+
- @backstage/backend-common@0.10.3
|
|
209
|
+
- @backstage/plugin-permission-node@0.3.0
|
|
210
|
+
- @backstage/errors@0.2.0
|
|
211
|
+
- @backstage/catalog-client@0.5.4
|
|
212
|
+
- @backstage/catalog-model@0.9.9
|
|
213
|
+
- @backstage/plugin-permission-common@0.3.1
|
|
214
|
+
|
|
215
|
+
## 0.19.4
|
|
216
|
+
|
|
217
|
+
### Patch Changes
|
|
218
|
+
|
|
219
|
+
- 7d4b4e937c: Uptake changes to the GitHub Credentials Provider interface.
|
|
220
|
+
- 3a63491c5f: Filter out projects with missing `default_branch` from GitLab Discovery.
|
|
221
|
+
- Updated dependencies
|
|
222
|
+
- @backstage/backend-common@0.10.1
|
|
223
|
+
- @backstage/integration@0.7.0
|
|
224
|
+
|
|
3
225
|
## 0.19.3
|
|
4
226
|
|
|
5
227
|
### Patch Changes
|