@backstage/plugin-catalog-node 1.19.0-next.1 → 1.19.1-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 +52 -0
- package/dist/index.d.ts +7 -0
- package/package.json +9 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,57 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-node
|
|
2
2
|
|
|
3
|
+
## 1.19.1-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/backend-plugin-api@1.4.4-next.0
|
|
9
|
+
- @backstage/plugin-permission-common@0.9.2-next.0
|
|
10
|
+
- @backstage/plugin-permission-node@0.10.5-next.0
|
|
11
|
+
- @backstage/plugin-catalog-common@1.1.6-next.0
|
|
12
|
+
- @backstage/catalog-client@1.12.0
|
|
13
|
+
|
|
14
|
+
## 1.19.0
|
|
15
|
+
|
|
16
|
+
### Minor Changes
|
|
17
|
+
|
|
18
|
+
- 0e9ec44: Introduced new `streamEntities` async generator method for the catalog.
|
|
19
|
+
|
|
20
|
+
Catalog API and Catalog Service now includes a `streamEntities` method that allows for streaming entities from the catalog.
|
|
21
|
+
This method is designed to handle large datasets efficiently by processing entities in a stream rather than loading them
|
|
22
|
+
all into memory at once. This is useful when you need to fetch a large number of entities but do not want to use pagination
|
|
23
|
+
or fetch all entities at once.
|
|
24
|
+
|
|
25
|
+
Example usage:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
const pageStream = catalogClient.streamEntities({ pageSize: 100 }, { token });
|
|
29
|
+
for await (const page of pageStream) {
|
|
30
|
+
// Handle page of entities
|
|
31
|
+
for (const entity of page) {
|
|
32
|
+
console.log(entity);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Patch Changes
|
|
38
|
+
|
|
39
|
+
- 2bbd24f: Order catalog processors by priority.
|
|
40
|
+
|
|
41
|
+
This change enables the ordering of catalog processors by their priority,
|
|
42
|
+
allowing for more control over the catalog processing sequence.
|
|
43
|
+
The default priority is set to 20, and processors can be assigned a custom
|
|
44
|
+
priority to influence their execution order. Lower number indicates higher priority.
|
|
45
|
+
The priority can be set by implementing the `getPriority` method in the processor class
|
|
46
|
+
or by adding a `catalog.processors.<processorName>.priority` configuration
|
|
47
|
+
in the `app-config.yaml` file. The configuration takes precedence over the method.
|
|
48
|
+
|
|
49
|
+
- Updated dependencies
|
|
50
|
+
- @backstage/catalog-client@1.12.0
|
|
51
|
+
- @backstage/types@1.2.2
|
|
52
|
+
- @backstage/backend-plugin-api@1.4.3
|
|
53
|
+
- @backstage/plugin-permission-node@0.10.4
|
|
54
|
+
|
|
3
55
|
## 1.19.0-next.1
|
|
4
56
|
|
|
5
57
|
### Minor Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -130,6 +130,13 @@ type CatalogProcessor = {
|
|
|
130
130
|
* @returns The same entity or a modified version of it
|
|
131
131
|
*/
|
|
132
132
|
postProcessEntity?(entity: Entity, location: LocationSpec$1, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
|
|
133
|
+
/**
|
|
134
|
+
* Returns a processor priority, which is used to determine the order in which
|
|
135
|
+
* processors are run. The default priority is 20, and lower value means
|
|
136
|
+
* that the processor runs earlier.
|
|
137
|
+
* @returns A number representing the priority of the processor.
|
|
138
|
+
*/
|
|
139
|
+
getPriority?(): number;
|
|
133
140
|
};
|
|
134
141
|
/**
|
|
135
142
|
* A parser, that is able to take the raw catalog descriptor data and turn it
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-node",
|
|
3
|
-
"version": "1.19.
|
|
3
|
+
"version": "1.19.1-next.0",
|
|
4
4
|
"description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library",
|
|
@@ -72,20 +72,20 @@
|
|
|
72
72
|
"test": "backstage-cli package test"
|
|
73
73
|
},
|
|
74
74
|
"dependencies": {
|
|
75
|
-
"@backstage/backend-plugin-api": "1.4.
|
|
76
|
-
"@backstage/catalog-client": "1.12.0
|
|
75
|
+
"@backstage/backend-plugin-api": "1.4.4-next.0",
|
|
76
|
+
"@backstage/catalog-client": "1.12.0",
|
|
77
77
|
"@backstage/catalog-model": "1.7.5",
|
|
78
78
|
"@backstage/errors": "1.2.7",
|
|
79
|
-
"@backstage/plugin-catalog-common": "1.1.
|
|
80
|
-
"@backstage/plugin-permission-common": "0.9.
|
|
81
|
-
"@backstage/plugin-permission-node": "0.10.
|
|
82
|
-
"@backstage/types": "1.2.
|
|
79
|
+
"@backstage/plugin-catalog-common": "1.1.6-next.0",
|
|
80
|
+
"@backstage/plugin-permission-common": "0.9.2-next.0",
|
|
81
|
+
"@backstage/plugin-permission-node": "0.10.5-next.0",
|
|
82
|
+
"@backstage/types": "1.2.2",
|
|
83
83
|
"lodash": "^4.17.21",
|
|
84
84
|
"yaml": "^2.0.0"
|
|
85
85
|
},
|
|
86
86
|
"devDependencies": {
|
|
87
|
-
"@backstage/backend-test-utils": "1.9.
|
|
88
|
-
"@backstage/cli": "0.34.
|
|
87
|
+
"@backstage/backend-test-utils": "1.9.1-next.1",
|
|
88
|
+
"@backstage/cli": "0.34.4-next.1",
|
|
89
89
|
"msw": "^1.0.0"
|
|
90
90
|
}
|
|
91
91
|
}
|