@backstage/plugin-catalog-backend-module-incremental-ingestion 0.0.0-nightly-20241015023351 → 0.0.0-nightly-20241018023335
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 +20 -5
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +0 -2
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +1 -8
- package/dist/index.d.ts +57 -4
- package/package.json +8 -8
- package/dist/types/catalogModuleIncrementalIngestionEntityProvider.d-Dr-cTBeb.d.ts +0 -57
package/CHANGELOG.md
CHANGED
|
@@ -1,17 +1,32 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-incremental-ingestion
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20241018023335
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/plugin-events-node@0.0.0-nightly-20241018023335
|
|
9
|
+
- @backstage/plugin-catalog-backend@0.0.0-nightly-20241018023335
|
|
10
|
+
- @backstage/backend-plugin-api@0.0.0-nightly-20241018023335
|
|
11
|
+
- @backstage/catalog-model@1.7.0
|
|
12
|
+
- @backstage/config@1.2.0
|
|
13
|
+
- @backstage/errors@1.2.4
|
|
14
|
+
- @backstage/plugin-catalog-node@0.0.0-nightly-20241018023335
|
|
15
|
+
- @backstage/plugin-permission-common@0.8.1
|
|
16
|
+
|
|
17
|
+
## 0.5.5
|
|
18
|
+
|
|
19
|
+
### Patch Changes
|
|
20
|
+
|
|
21
|
+
- 4b60e0c: Remove extension points from `/alpha` export, they're available from the main package already
|
|
7
22
|
- 094eaa3: Remove references to in-repo backend-common
|
|
8
23
|
- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
|
|
9
24
|
- 2107965: Turn down the logging level on most "all is well" type log messages
|
|
10
25
|
- Updated dependencies
|
|
11
|
-
- @backstage/plugin-catalog-backend@
|
|
12
|
-
- @backstage/plugin-events-node@0.
|
|
13
|
-
- @backstage/plugin-catalog-node@
|
|
14
|
-
- @backstage/backend-plugin-api@
|
|
26
|
+
- @backstage/plugin-catalog-backend@1.27.0
|
|
27
|
+
- @backstage/plugin-events-node@0.4.1
|
|
28
|
+
- @backstage/plugin-catalog-node@1.13.1
|
|
29
|
+
- @backstage/backend-plugin-api@1.0.1
|
|
15
30
|
- @backstage/catalog-model@1.7.0
|
|
16
31
|
- @backstage/config@1.2.0
|
|
17
32
|
- @backstage/errors@1.2.4
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -5,8 +5,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
5
5
|
var catalogModuleIncrementalIngestionEntityProvider = require('./module/catalogModuleIncrementalIngestionEntityProvider.cjs.js');
|
|
6
6
|
|
|
7
7
|
const _feature = catalogModuleIncrementalIngestionEntityProvider.catalogModuleIncrementalIngestionEntityProvider;
|
|
8
|
-
const incrementalIngestionProvidersExtensionPoint = catalogModuleIncrementalIngestionEntityProvider.incrementalIngestionProvidersExtensionPoint;
|
|
9
8
|
|
|
10
9
|
exports.default = _feature;
|
|
11
|
-
exports.incrementalIngestionProvidersExtensionPoint = incrementalIngestionProvidersExtensionPoint;
|
|
12
10
|
//# sourceMappingURL=alpha.cjs.js.map
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { default as feature } from './module';\
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}
|
package/dist/alpha.d.ts
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
|
-
import { I as IncrementalIngestionProviderExtensionPoint$1 } from './types/catalogModuleIncrementalIngestionEntityProvider.d-Dr-cTBeb.js';
|
|
3
|
-
import '@backstage/plugin-catalog-backend-module-incremental-ingestion';
|
|
4
2
|
|
|
5
3
|
/** @alpha */
|
|
6
4
|
declare const _feature: _backstage_backend_plugin_api.BackendFeature;
|
|
7
5
|
|
|
8
|
-
|
|
9
|
-
type IncrementalIngestionProviderExtensionPoint = IncrementalIngestionProviderExtensionPoint$1;
|
|
10
|
-
/** @alpha */
|
|
11
|
-
declare const incrementalIngestionProvidersExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<IncrementalIngestionProviderExtensionPoint$1>;
|
|
12
|
-
|
|
13
|
-
export { type IncrementalIngestionProviderExtensionPoint, _feature as default, incrementalIngestionProvidersExtensionPoint };
|
|
6
|
+
export { _feature as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
/// <reference types="express" />
|
|
2
|
-
|
|
2
|
+
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
3
|
+
import { SchedulerService, UrlReaderService } from '@backstage/backend-plugin-api';
|
|
4
|
+
import { IncrementalEntityProviderOptions as IncrementalEntityProviderOptions$1, IncrementalEntityProvider as IncrementalEntityProvider$1 } from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
|
|
3
5
|
import * as express from 'express';
|
|
4
6
|
import { PluginDatabaseManager } from '@backstage/backend-common';
|
|
5
7
|
import { Config } from '@backstage/config';
|
|
@@ -8,9 +10,60 @@ import { EventParams, EventSubscriber } from '@backstage/plugin-events-node';
|
|
|
8
10
|
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
|
|
9
11
|
import { DurationObjectUnits } from 'luxon';
|
|
10
12
|
import { Logger } from 'winston';
|
|
11
|
-
import { SchedulerService, UrlReaderService } from '@backstage/backend-plugin-api';
|
|
12
13
|
import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
|
|
13
|
-
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* Interface for {@link incrementalIngestionProvidersExtensionPoint}.
|
|
18
|
+
*/
|
|
19
|
+
interface IncrementalIngestionProviderExtensionPoint {
|
|
20
|
+
/** Adds a new incremental entity provider */
|
|
21
|
+
addProvider<TCursor, TContext>(config: {
|
|
22
|
+
options: IncrementalEntityProviderOptions$1;
|
|
23
|
+
provider: IncrementalEntityProvider$1<TCursor, TContext>;
|
|
24
|
+
}): void;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
*
|
|
29
|
+
* Extension point for registering incremental ingestion providers.
|
|
30
|
+
* The `catalogModuleIncrementalIngestionEntityProvider` must be installed for these providers to work.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
*
|
|
34
|
+
* ```ts
|
|
35
|
+
* backend.add(createBackendModule({
|
|
36
|
+
* pluginId: 'catalog',
|
|
37
|
+
* moduleId: 'my-incremental-provider',
|
|
38
|
+
* register(env) {
|
|
39
|
+
* env.registerInit({
|
|
40
|
+
* deps: {
|
|
41
|
+
* extension: incrementalIngestionProvidersExtensionPoint,
|
|
42
|
+
* },
|
|
43
|
+
* async init({ extension }) {
|
|
44
|
+
* extension.addProvider({
|
|
45
|
+
* burstInterval: ...,
|
|
46
|
+
* burstLength: ...,
|
|
47
|
+
* restLength: ...,
|
|
48
|
+
* }, {
|
|
49
|
+
* next(context, cursor) {
|
|
50
|
+
* ...
|
|
51
|
+
* },
|
|
52
|
+
* ...
|
|
53
|
+
* })
|
|
54
|
+
* })
|
|
55
|
+
* })
|
|
56
|
+
* }
|
|
57
|
+
* }))
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
declare const incrementalIngestionProvidersExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<IncrementalIngestionProviderExtensionPoint>;
|
|
61
|
+
/**
|
|
62
|
+
* Registers the incremental entity provider with the catalog processing extension point.
|
|
63
|
+
*
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
declare const catalogModuleIncrementalIngestionEntityProvider: _backstage_backend_plugin_api.BackendFeature;
|
|
14
67
|
|
|
15
68
|
/**
|
|
16
69
|
* Ingest entities into the catalog in bite-sized chunks.
|
|
@@ -177,4 +230,4 @@ declare class IncrementalCatalogBuilder {
|
|
|
177
230
|
addIncrementalEntityProvider<TCursor, TContext>(provider: IncrementalEntityProvider<TCursor, TContext>, options: IncrementalEntityProviderOptions): EventSubscriber;
|
|
178
231
|
}
|
|
179
232
|
|
|
180
|
-
export { type EntityIteratorResult, IncrementalCatalogBuilder, type IncrementalEntityEventResult, type IncrementalEntityProvider, type IncrementalEntityProviderOptions, type PluginEnvironment };
|
|
233
|
+
export { type EntityIteratorResult, IncrementalCatalogBuilder, type IncrementalEntityEventResult, type IncrementalEntityProvider, type IncrementalEntityProviderOptions, type IncrementalIngestionProviderExtensionPoint, type PluginEnvironment, catalogModuleIncrementalIngestionEntityProvider as default, incrementalIngestionProvidersExtensionPoint };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20241018023335",
|
|
4
4
|
"description": "An entity provider for streaming large asset sources into the catalog",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -53,13 +53,13 @@
|
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
55
|
"@backstage/backend-common": "^0.25.0",
|
|
56
|
-
"@backstage/backend-plugin-api": "0.0.0-nightly-
|
|
56
|
+
"@backstage/backend-plugin-api": "0.0.0-nightly-20241018023335",
|
|
57
57
|
"@backstage/catalog-model": "1.7.0",
|
|
58
58
|
"@backstage/config": "1.2.0",
|
|
59
59
|
"@backstage/errors": "1.2.4",
|
|
60
|
-
"@backstage/plugin-catalog-backend": "0.0.0-nightly-
|
|
61
|
-
"@backstage/plugin-catalog-node": "0.0.0-nightly-
|
|
62
|
-
"@backstage/plugin-events-node": "0.0.0-nightly-
|
|
60
|
+
"@backstage/plugin-catalog-backend": "0.0.0-nightly-20241018023335",
|
|
61
|
+
"@backstage/plugin-catalog-node": "0.0.0-nightly-20241018023335",
|
|
62
|
+
"@backstage/plugin-events-node": "0.0.0-nightly-20241018023335",
|
|
63
63
|
"@backstage/plugin-permission-common": "0.8.1",
|
|
64
64
|
"@types/express": "^4.17.6",
|
|
65
65
|
"@types/luxon": "^3.0.0",
|
|
@@ -70,8 +70,8 @@
|
|
|
70
70
|
"uuid": "^9.0.0"
|
|
71
71
|
},
|
|
72
72
|
"devDependencies": {
|
|
73
|
-
"@backstage/backend-defaults": "0.0.0-nightly-
|
|
74
|
-
"@backstage/backend-test-utils": "0.0.0-nightly-
|
|
75
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
73
|
+
"@backstage/backend-defaults": "0.0.0-nightly-20241018023335",
|
|
74
|
+
"@backstage/backend-test-utils": "0.0.0-nightly-20241018023335",
|
|
75
|
+
"@backstage/cli": "0.0.0-nightly-20241018023335"
|
|
76
76
|
}
|
|
77
77
|
}
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
|
-
import { IncrementalEntityProviderOptions, IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* @public
|
|
6
|
-
* Interface for {@link incrementalIngestionProvidersExtensionPoint}.
|
|
7
|
-
*/
|
|
8
|
-
interface IncrementalIngestionProviderExtensionPoint {
|
|
9
|
-
/** Adds a new incremental entity provider */
|
|
10
|
-
addProvider<TCursor, TContext>(config: {
|
|
11
|
-
options: IncrementalEntityProviderOptions;
|
|
12
|
-
provider: IncrementalEntityProvider<TCursor, TContext>;
|
|
13
|
-
}): void;
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* @public
|
|
17
|
-
*
|
|
18
|
-
* Extension point for registering incremental ingestion providers.
|
|
19
|
-
* The `catalogModuleIncrementalIngestionEntityProvider` must be installed for these providers to work.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
*
|
|
23
|
-
* ```ts
|
|
24
|
-
* backend.add(createBackendModule({
|
|
25
|
-
* pluginId: 'catalog',
|
|
26
|
-
* moduleId: 'my-incremental-provider',
|
|
27
|
-
* register(env) {
|
|
28
|
-
* env.registerInit({
|
|
29
|
-
* deps: {
|
|
30
|
-
* extension: incrementalIngestionProvidersExtensionPoint,
|
|
31
|
-
* },
|
|
32
|
-
* async init({ extension }) {
|
|
33
|
-
* extension.addProvider({
|
|
34
|
-
* burstInterval: ...,
|
|
35
|
-
* burstLength: ...,
|
|
36
|
-
* restLength: ...,
|
|
37
|
-
* }, {
|
|
38
|
-
* next(context, cursor) {
|
|
39
|
-
* ...
|
|
40
|
-
* },
|
|
41
|
-
* ...
|
|
42
|
-
* })
|
|
43
|
-
* })
|
|
44
|
-
* })
|
|
45
|
-
* }
|
|
46
|
-
* }))
|
|
47
|
-
* ```
|
|
48
|
-
*/
|
|
49
|
-
declare const incrementalIngestionProvidersExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<IncrementalIngestionProviderExtensionPoint>;
|
|
50
|
-
/**
|
|
51
|
-
* Registers the incremental entity provider with the catalog processing extension point.
|
|
52
|
-
*
|
|
53
|
-
* @public
|
|
54
|
-
*/
|
|
55
|
-
declare const catalogModuleIncrementalIngestionEntityProvider: _backstage_backend_plugin_api.BackendFeature;
|
|
56
|
-
|
|
57
|
-
export { type IncrementalIngestionProviderExtensionPoint as I, catalogModuleIncrementalIngestionEntityProvider as c, incrementalIngestionProvidersExtensionPoint as i };
|