@backstage/plugin-catalog-backend-module-incremental-ingestion 0.5.5-next.1 → 0.5.5
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 +32 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +3 -130
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +3 -54
- package/dist/database/IncrementalIngestionDatabaseManager.cjs.js +487 -0
- package/dist/database/IncrementalIngestionDatabaseManager.cjs.js.map +1 -0
- package/dist/database/migrations.cjs.js +18 -0
- package/dist/database/migrations.cjs.js.map +1 -0
- package/dist/database/tables.cjs.js +6 -0
- package/dist/database/tables.cjs.js.map +1 -0
- package/dist/engine/IncrementalIngestionEngine.cjs.js +327 -0
- package/dist/engine/IncrementalIngestionEngine.cjs.js.map +1 -0
- package/dist/index.cjs.js +8 -83
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +57 -2
- package/dist/module/WrapperProviders.cjs.js +83 -0
- package/dist/module/WrapperProviders.cjs.js.map +1 -0
- package/dist/module/catalogModuleIncrementalIngestionEntityProvider.cjs.js +56 -0
- package/dist/module/catalogModuleIncrementalIngestionEntityProvider.cjs.js.map +1 -0
- package/dist/router/routes.cjs.js +218 -0
- package/dist/router/routes.cjs.js.map +1 -0
- package/dist/service/IncrementalCatalogBuilder.cjs.js +83 -0
- package/dist/service/IncrementalCatalogBuilder.cjs.js.map +1 -0
- package/dist/util.cjs.js +28 -0
- package/dist/util.cjs.js.map +1 -0
- package/package.json +13 -12
- package/dist/cjs/util-B3Qn9g5Y.cjs.js +0 -1063
- package/dist/cjs/util-B3Qn9g5Y.cjs.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-incremental-ingestion
|
|
2
2
|
|
|
3
|
+
## 0.5.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 4b60e0c: Remove extension points from `/alpha` export, they're available from the main package already
|
|
8
|
+
- 094eaa3: Remove references to in-repo backend-common
|
|
9
|
+
- 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.
|
|
10
|
+
- 2107965: Turn down the logging level on most "all is well" type log messages
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @backstage/plugin-catalog-backend@1.27.0
|
|
13
|
+
- @backstage/plugin-events-node@0.4.1
|
|
14
|
+
- @backstage/plugin-catalog-node@1.13.1
|
|
15
|
+
- @backstage/backend-plugin-api@1.0.1
|
|
16
|
+
- @backstage/catalog-model@1.7.0
|
|
17
|
+
- @backstage/config@1.2.0
|
|
18
|
+
- @backstage/errors@1.2.4
|
|
19
|
+
- @backstage/plugin-permission-common@0.8.1
|
|
20
|
+
|
|
21
|
+
## 0.5.5-next.2
|
|
22
|
+
|
|
23
|
+
### Patch Changes
|
|
24
|
+
|
|
25
|
+
- Updated dependencies
|
|
26
|
+
- @backstage/plugin-catalog-node@1.13.1-next.1
|
|
27
|
+
- @backstage/plugin-catalog-backend@1.26.2-next.2
|
|
28
|
+
- @backstage/backend-plugin-api@1.0.1-next.1
|
|
29
|
+
- @backstage/catalog-model@1.7.0
|
|
30
|
+
- @backstage/config@1.2.0
|
|
31
|
+
- @backstage/errors@1.2.4
|
|
32
|
+
- @backstage/plugin-events-node@0.4.1-next.1
|
|
33
|
+
- @backstage/plugin-permission-common@0.8.1
|
|
34
|
+
|
|
3
35
|
## 0.5.5-next.1
|
|
4
36
|
|
|
5
37
|
### Patch Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -2,136 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var
|
|
6
|
-
var alpha = require('@backstage/plugin-catalog-node/alpha');
|
|
7
|
-
var errors = require('@backstage/errors');
|
|
8
|
-
var luxon = require('luxon');
|
|
9
|
-
var util = require('./cjs/util-B3Qn9g5Y.cjs.js');
|
|
10
|
-
require('perf_hooks');
|
|
11
|
-
require('uuid');
|
|
12
|
-
require('@backstage/catalog-model');
|
|
13
|
-
require('@backstage/backend-common');
|
|
14
|
-
require('express');
|
|
15
|
-
require('express-promise-router');
|
|
5
|
+
var catalogModuleIncrementalIngestionEntityProvider = require('./module/catalogModuleIncrementalIngestionEntityProvider.cjs.js');
|
|
16
6
|
|
|
17
|
-
|
|
18
|
-
constructor(options) {
|
|
19
|
-
this.options = options;
|
|
20
|
-
}
|
|
21
|
-
migrate;
|
|
22
|
-
numberOfProvidersToConnect = 0;
|
|
23
|
-
readySignal = new util.Deferred();
|
|
24
|
-
wrap(provider, options) {
|
|
25
|
-
this.numberOfProvidersToConnect += 1;
|
|
26
|
-
return {
|
|
27
|
-
getProviderName: () => provider.getProviderName(),
|
|
28
|
-
connect: async (connection) => {
|
|
29
|
-
await this.startProvider(provider, options, connection);
|
|
30
|
-
this.numberOfProvidersToConnect -= 1;
|
|
31
|
-
if (this.numberOfProvidersToConnect === 0) {
|
|
32
|
-
this.readySignal.resolve();
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
};
|
|
36
|
-
}
|
|
37
|
-
async adminRouter() {
|
|
38
|
-
return await new util.IncrementalProviderRouter(
|
|
39
|
-
new util.IncrementalIngestionDatabaseManager({ client: this.options.client }),
|
|
40
|
-
this.options.logger
|
|
41
|
-
).createRouter();
|
|
42
|
-
}
|
|
43
|
-
async startProvider(provider, providerOptions, connection) {
|
|
44
|
-
const logger = this.options.logger.child({
|
|
45
|
-
entityProvider: provider.getProviderName()
|
|
46
|
-
});
|
|
47
|
-
try {
|
|
48
|
-
if (!this.migrate) {
|
|
49
|
-
this.migrate = Promise.resolve().then(async () => {
|
|
50
|
-
const apply = this.options.applyDatabaseMigrations ?? util.applyDatabaseMigrations;
|
|
51
|
-
await apply(this.options.client);
|
|
52
|
-
});
|
|
53
|
-
}
|
|
54
|
-
await this.migrate;
|
|
55
|
-
const { burstInterval, burstLength, restLength } = providerOptions;
|
|
56
|
-
logger.info(`Connecting`);
|
|
57
|
-
const manager = new util.IncrementalIngestionDatabaseManager({
|
|
58
|
-
client: this.options.client
|
|
59
|
-
});
|
|
60
|
-
const engine = new util.IncrementalIngestionEngine({
|
|
61
|
-
...providerOptions,
|
|
62
|
-
ready: this.readySignal,
|
|
63
|
-
manager,
|
|
64
|
-
logger,
|
|
65
|
-
provider,
|
|
66
|
-
restLength,
|
|
67
|
-
connection
|
|
68
|
-
});
|
|
69
|
-
const frequency = luxon.Duration.isDuration(burstInterval) ? burstInterval : luxon.Duration.fromObject(burstInterval);
|
|
70
|
-
const length = luxon.Duration.isDuration(burstLength) ? burstLength : luxon.Duration.fromObject(burstLength);
|
|
71
|
-
await this.options.scheduler.scheduleTask({
|
|
72
|
-
id: provider.getProviderName(),
|
|
73
|
-
fn: engine.taskFn.bind(engine),
|
|
74
|
-
frequency,
|
|
75
|
-
timeout: length
|
|
76
|
-
});
|
|
77
|
-
} catch (error) {
|
|
78
|
-
logger.warn(
|
|
79
|
-
`Failed to initialize incremental ingestion provider ${provider.getProviderName()}, ${errors.stringifyError(
|
|
80
|
-
error
|
|
81
|
-
)}`
|
|
82
|
-
);
|
|
83
|
-
throw error;
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
}
|
|
7
|
+
const _feature = catalogModuleIncrementalIngestionEntityProvider.catalogModuleIncrementalIngestionEntityProvider;
|
|
87
8
|
|
|
88
|
-
|
|
89
|
-
id: "catalog.incrementalIngestionProvider.providers"
|
|
90
|
-
});
|
|
91
|
-
const catalogModuleIncrementalIngestionEntityProvider = backendPluginApi.createBackendModule({
|
|
92
|
-
pluginId: "catalog",
|
|
93
|
-
moduleId: "incremental-ingestion-entity-provider",
|
|
94
|
-
register(env) {
|
|
95
|
-
const addedProviders = new Array();
|
|
96
|
-
env.registerExtensionPoint(incrementalIngestionProvidersExtensionPoint, {
|
|
97
|
-
addProvider({ options, provider }) {
|
|
98
|
-
addedProviders.push({ options, provider });
|
|
99
|
-
}
|
|
100
|
-
});
|
|
101
|
-
env.registerInit({
|
|
102
|
-
deps: {
|
|
103
|
-
catalog: alpha.catalogProcessingExtensionPoint,
|
|
104
|
-
config: backendPluginApi.coreServices.rootConfig,
|
|
105
|
-
database: backendPluginApi.coreServices.database,
|
|
106
|
-
httpRouter: backendPluginApi.coreServices.httpRouter,
|
|
107
|
-
logger: backendPluginApi.coreServices.logger,
|
|
108
|
-
scheduler: backendPluginApi.coreServices.scheduler
|
|
109
|
-
},
|
|
110
|
-
async init({
|
|
111
|
-
catalog,
|
|
112
|
-
config,
|
|
113
|
-
database,
|
|
114
|
-
httpRouter,
|
|
115
|
-
logger,
|
|
116
|
-
scheduler
|
|
117
|
-
}) {
|
|
118
|
-
const client = await database.getClient();
|
|
119
|
-
const providers = new WrapperProviders({
|
|
120
|
-
config,
|
|
121
|
-
logger,
|
|
122
|
-
client,
|
|
123
|
-
scheduler
|
|
124
|
-
});
|
|
125
|
-
for (const entry of addedProviders) {
|
|
126
|
-
const wrapped = providers.wrap(entry.provider, entry.options);
|
|
127
|
-
catalog.addEntityProvider(wrapped);
|
|
128
|
-
}
|
|
129
|
-
httpRouter.use(await providers.adminRouter());
|
|
130
|
-
}
|
|
131
|
-
});
|
|
132
|
-
}
|
|
133
|
-
});
|
|
134
|
-
|
|
135
|
-
exports.default = catalogModuleIncrementalIngestionEntityProvider;
|
|
136
|
-
exports.incrementalIngestionProvidersExtensionPoint = incrementalIngestionProvidersExtensionPoint;
|
|
9
|
+
exports.default = _feature;
|
|
137
10
|
//# sourceMappingURL=alpha.cjs.js.map
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":["../src/module/WrapperProviders.ts","../src/module/catalogModuleIncrementalIngestionEntityProvider.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 {\n LoggerService,\n RootConfigService,\n SchedulerService,\n} from '@backstage/backend-plugin-api';\nimport { stringifyError } from '@backstage/errors';\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport express from 'express';\nimport { Knex } from 'knex';\nimport { Duration } from 'luxon';\nimport { IncrementalIngestionDatabaseManager } from '../database/IncrementalIngestionDatabaseManager';\nimport { applyDatabaseMigrations } from '../database/migrations';\nimport { IncrementalIngestionEngine } from '../engine/IncrementalIngestionEngine';\nimport { IncrementalProviderRouter } from '../router/routes';\nimport {\n IncrementalEntityProvider,\n IncrementalEntityProviderOptions,\n} from '../types';\nimport { Deferred } from '../util';\n\n/**\n * Helps in the creation of the catalog entity providers that wrap the\n * incremental ones.\n */\nexport class WrapperProviders {\n private migrate: Promise<void> | undefined;\n private numberOfProvidersToConnect = 0;\n private readonly readySignal = new Deferred<void>();\n\n constructor(\n private readonly options: {\n config: RootConfigService;\n logger: LoggerService;\n client: Knex;\n scheduler: SchedulerService;\n applyDatabaseMigrations?: typeof applyDatabaseMigrations;\n },\n ) {}\n\n wrap(\n provider: IncrementalEntityProvider<unknown, unknown>,\n options: IncrementalEntityProviderOptions,\n ): EntityProvider {\n this.numberOfProvidersToConnect += 1;\n return {\n getProviderName: () => provider.getProviderName(),\n connect: async connection => {\n await this.startProvider(provider, options, connection);\n this.numberOfProvidersToConnect -= 1;\n if (this.numberOfProvidersToConnect === 0) {\n this.readySignal.resolve();\n }\n },\n };\n }\n\n async adminRouter(): Promise<express.Router> {\n return await new IncrementalProviderRouter(\n new IncrementalIngestionDatabaseManager({ client: this.options.client }),\n this.options.logger,\n ).createRouter();\n }\n\n private async startProvider(\n provider: IncrementalEntityProvider<unknown, unknown>,\n providerOptions: IncrementalEntityProviderOptions,\n connection: EntityProviderConnection,\n ) {\n const logger = this.options.logger.child({\n entityProvider: provider.getProviderName(),\n });\n\n try {\n if (!this.migrate) {\n this.migrate = Promise.resolve().then(async () => {\n const apply =\n this.options.applyDatabaseMigrations ?? applyDatabaseMigrations;\n await apply(this.options.client);\n });\n }\n\n await this.migrate;\n\n const { burstInterval, burstLength, restLength } = providerOptions;\n\n logger.info(`Connecting`);\n\n const manager = new IncrementalIngestionDatabaseManager({\n client: this.options.client,\n });\n const engine = new IncrementalIngestionEngine({\n ...providerOptions,\n ready: this.readySignal,\n manager,\n logger,\n provider,\n restLength,\n connection,\n });\n\n const frequency = Duration.isDuration(burstInterval)\n ? burstInterval\n : Duration.fromObject(burstInterval);\n const length = Duration.isDuration(burstLength)\n ? burstLength\n : Duration.fromObject(burstLength);\n\n await this.options.scheduler.scheduleTask({\n id: provider.getProviderName(),\n fn: engine.taskFn.bind(engine),\n frequency,\n timeout: length,\n });\n } catch (error) {\n logger.warn(\n `Failed to initialize incremental ingestion provider ${provider.getProviderName()}, ${stringifyError(\n error,\n )}`,\n );\n throw error;\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 coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport {\n IncrementalEntityProvider,\n IncrementalEntityProviderOptions,\n} from '@backstage/plugin-catalog-backend-module-incremental-ingestion';\nimport { WrapperProviders } from './WrapperProviders';\n\n/**\n * @alpha\n * Interface for {@link incrementalIngestionProvidersExtensionPoint}.\n */\nexport interface IncrementalIngestionProviderExtensionPoint {\n /** Adds a new incremental entity provider */\n addProvider<TCursor, TContext>(config: {\n options: IncrementalEntityProviderOptions;\n provider: IncrementalEntityProvider<TCursor, TContext>;\n }): void;\n}\n\n/**\n * @alpha\n *\n * Extension point for registering incremental ingestion providers.\n * The `catalogModuleIncrementalIngestionEntityProvider` must be installed for these providers to work.\n *\n * @example\n *\n * ```ts\n * backend.add(createBackendModule({\n * pluginId: 'catalog',\n * moduleId: 'my-incremental-provider',\n * register(env) {\n * env.registerInit({\n * deps: {\n * extension: incrementalIngestionProvidersExtensionPoint,\n * },\n * async init({ extension }) {\n * extension.addProvider({\n * burstInterval: ...,\n * burstLength: ...,\n * restLength: ...,\n * }, {\n * next(context, cursor) {\n * ...\n * },\n * ...\n * })\n * })\n * })\n * }\n * }))\n * ```\n */\nexport const incrementalIngestionProvidersExtensionPoint =\n createExtensionPoint<IncrementalIngestionProviderExtensionPoint>({\n id: 'catalog.incrementalIngestionProvider.providers',\n });\n\n/**\n * Registers the incremental entity provider with the catalog processing extension point.\n *\n * @alpha\n */\nexport const catalogModuleIncrementalIngestionEntityProvider =\n createBackendModule({\n pluginId: 'catalog',\n moduleId: 'incremental-ingestion-entity-provider',\n register(env) {\n const addedProviders = new Array<{\n provider: IncrementalEntityProvider<unknown, unknown>;\n options: IncrementalEntityProviderOptions;\n }>();\n\n env.registerExtensionPoint(incrementalIngestionProvidersExtensionPoint, {\n addProvider({ options, provider }) {\n addedProviders.push({ options, provider });\n },\n });\n\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n database: coreServices.database,\n httpRouter: coreServices.httpRouter,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n async init({\n catalog,\n config,\n database,\n httpRouter,\n logger,\n scheduler,\n }) {\n const client = await database.getClient();\n\n const providers = new WrapperProviders({\n config,\n logger,\n client,\n scheduler,\n });\n\n for (const entry of addedProviders) {\n const wrapped = providers.wrap(entry.provider, entry.options);\n catalog.addEntityProvider(wrapped);\n }\n\n httpRouter.use(await providers.adminRouter());\n },\n });\n },\n });\n"],"names":["Deferred","IncrementalProviderRouter","IncrementalIngestionDatabaseManager","applyDatabaseMigrations","IncrementalIngestionEngine","Duration","stringifyError","createExtensionPoint","createBackendModule","catalogProcessingExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;;;;AA2CO,MAAM,gBAAiB,CAAA;AAAA,EAK5B,YACmB,OAOjB,EAAA;AAPiB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AAAA,GAOhB;AAAA,EAZK,OAAA,CAAA;AAAA,EACA,0BAA6B,GAAA,CAAA,CAAA;AAAA,EACpB,WAAA,GAAc,IAAIA,aAAe,EAAA,CAAA;AAAA,EAYlD,IAAA,CACE,UACA,OACgB,EAAA;AAChB,IAAA,IAAA,CAAK,0BAA8B,IAAA,CAAA,CAAA;AACnC,IAAO,OAAA;AAAA,MACL,eAAA,EAAiB,MAAM,QAAA,CAAS,eAAgB,EAAA;AAAA,MAChD,OAAA,EAAS,OAAM,UAAc,KAAA;AAC3B,QAAA,MAAM,IAAK,CAAA,aAAA,CAAc,QAAU,EAAA,OAAA,EAAS,UAAU,CAAA,CAAA;AACtD,QAAA,IAAA,CAAK,0BAA8B,IAAA,CAAA,CAAA;AACnC,QAAI,IAAA,IAAA,CAAK,+BAA+B,CAAG,EAAA;AACzC,UAAA,IAAA,CAAK,YAAY,OAAQ,EAAA,CAAA;AAAA,SAC3B;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,WAAuC,GAAA;AAC3C,IAAA,OAAO,MAAM,IAAIC,8BAAA;AAAA,MACf,IAAIC,wCAAoC,CAAA,EAAE,QAAQ,IAAK,CAAA,OAAA,CAAQ,QAAQ,CAAA;AAAA,MACvE,KAAK,OAAQ,CAAA,MAAA;AAAA,MACb,YAAa,EAAA,CAAA;AAAA,GACjB;AAAA,EAEA,MAAc,aAAA,CACZ,QACA,EAAA,eAAA,EACA,UACA,EAAA;AACA,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,MACvC,cAAA,EAAgB,SAAS,eAAgB,EAAA;AAAA,KAC1C,CAAA,CAAA;AAED,IAAI,IAAA;AACF,MAAI,IAAA,CAAC,KAAK,OAAS,EAAA;AACjB,QAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAQ,OAAQ,EAAA,CAAE,KAAK,YAAY;AAChD,UAAM,MAAA,KAAA,GACJ,IAAK,CAAA,OAAA,CAAQ,uBAA2B,IAAAC,4BAAA,CAAA;AAC1C,UAAM,MAAA,KAAA,CAAM,IAAK,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,SAChC,CAAA,CAAA;AAAA,OACH;AAEA,MAAA,MAAM,IAAK,CAAA,OAAA,CAAA;AAEX,MAAA,MAAM,EAAE,aAAA,EAAe,WAAa,EAAA,UAAA,EAAe,GAAA,eAAA,CAAA;AAEnD,MAAA,MAAA,CAAO,KAAK,CAAY,UAAA,CAAA,CAAA,CAAA;AAExB,MAAM,MAAA,OAAA,GAAU,IAAID,wCAAoC,CAAA;AAAA,QACtD,MAAA,EAAQ,KAAK,OAAQ,CAAA,MAAA;AAAA,OACtB,CAAA,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIE,+BAA2B,CAAA;AAAA,QAC5C,GAAG,eAAA;AAAA,QACH,OAAO,IAAK,CAAA,WAAA;AAAA,QACZ,OAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,OACD,CAAA,CAAA;AAED,MAAM,MAAA,SAAA,GAAYC,eAAS,UAAW,CAAA,aAAa,IAC/C,aACA,GAAAA,cAAA,CAAS,WAAW,aAAa,CAAA,CAAA;AACrC,MAAM,MAAA,MAAA,GAASA,eAAS,UAAW,CAAA,WAAW,IAC1C,WACA,GAAAA,cAAA,CAAS,WAAW,WAAW,CAAA,CAAA;AAEnC,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,SAAA,CAAU,YAAa,CAAA;AAAA,QACxC,EAAA,EAAI,SAAS,eAAgB,EAAA;AAAA,QAC7B,EAAI,EAAA,MAAA,CAAO,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA,QAC7B,SAAA;AAAA,QACA,OAAS,EAAA,MAAA;AAAA,OACV,CAAA,CAAA;AAAA,aACM,KAAO,EAAA;AACd,MAAO,MAAA,CAAA,IAAA;AAAA,QACL,CAAuD,oDAAA,EAAA,QAAA,CAAS,eAAgB,EAAC,CAAK,EAAA,EAAAC,qBAAA;AAAA,UACpF,KAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH,CAAA;AACA,MAAM,MAAA,KAAA,CAAA;AAAA,KACR;AAAA,GACF;AACF;;ACnEO,MAAM,8CACXC,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA,gDAAA;AACN,CAAC,EAAA;AAOI,MAAM,kDACXC,oCAAoB,CAAA;AAAA,EAClB,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,uCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,cAAA,GAAiB,IAAI,KAGxB,EAAA,CAAA;AAEH,IAAA,GAAA,CAAI,uBAAuB,2CAA6C,EAAA;AAAA,MACtE,WAAY,CAAA,EAAE,OAAS,EAAA,QAAA,EAAY,EAAA;AACjC,QAAA,cAAA,CAAe,IAAK,CAAA,EAAE,OAAS,EAAA,QAAA,EAAU,CAAA,CAAA;AAAA,OAC3C;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,OAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,UAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,QAAM,MAAA,SAAA,GAAY,IAAI,gBAAiB,CAAA;AAAA,UACrC,MAAA;AAAA,UACA,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,KAAA,MAAW,SAAS,cAAgB,EAAA;AAClC,UAAA,MAAM,UAAU,SAAU,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,MAAM,OAAO,CAAA,CAAA;AAC5D,UAAA,OAAA,CAAQ,kBAAkB,OAAO,CAAA,CAAA;AAAA,SACnC;AAEA,QAAA,UAAA,CAAW,GAAI,CAAA,MAAM,SAAU,CAAA,WAAA,EAAa,CAAA,CAAA;AAAA,OAC9C;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
|
|
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,57 +1,6 @@
|
|
|
1
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
2
|
|
|
4
|
-
/**
|
|
5
|
-
|
|
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
|
-
* @alpha
|
|
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
|
-
* @alpha
|
|
54
|
-
*/
|
|
55
|
-
declare const catalogModuleIncrementalIngestionEntityProvider: _backstage_backend_plugin_api.BackendFeature;
|
|
3
|
+
/** @alpha */
|
|
4
|
+
declare const _feature: _backstage_backend_plugin_api.BackendFeature;
|
|
56
5
|
|
|
57
|
-
export {
|
|
6
|
+
export { _feature as default };
|