backend-defaults: rename and export urlReaderFactoriesServiceRef

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-08-06 14:21:28 +02:00
parent 6058a95955
commit 13d564e44f
3 changed files with 19 additions and 9 deletions
@@ -22,6 +22,7 @@ import { HarnessIntegration } from '@backstage/integration';
import { LoggerService } from '@backstage/backend-plugin-api';
import { Readable } from 'stream';
import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
import { ServiceRef } from '@backstage/backend-plugin-api';
import { UrlReaderService } from '@backstage/backend-plugin-api';
import { UrlReaderServiceReadTreeOptions } from '@backstage/backend-plugin-api';
import { UrlReaderServiceReadTreeResponse } from '@backstage/backend-plugin-api';
@@ -413,6 +414,13 @@ export type ReadUrlResponseFactoryFromStreamOptions = {
lastModifiedAt?: Date;
};
// @public
export const urlReaderFactoriesServiceRef: ServiceRef<
ReaderFactory,
'plugin',
'multiton'
>;
// @public
export type UrlReaderPredicateTuple = {
predicate: (url: URL) => boolean;
@@ -15,4 +15,7 @@
*/
export * from './lib';
export { urlReaderServiceFactory } from './urlReaderServiceFactory';
export {
urlReaderServiceFactory,
urlReaderFactoriesServiceRef,
} from './urlReaderServiceFactory';
@@ -30,7 +30,7 @@ import {
* Creating a service factory implementation for a Custom URL Reader.
* ```ts
* createServiceFactory({
* service: urlReaderProviderFactoriesServiceRef,
* service: urlReaderFactoriesServiceRef,
* deps: {},
* async factory() {
* return CustomUrlReader.factory;
@@ -38,12 +38,11 @@ import {
* });
* ```
*/
export const urlReaderProviderFactoriesServiceRef =
createServiceRef<ReaderFactory>({
id: 'core.urlReader.factories',
scope: 'plugin',
multiton: true,
});
export const urlReaderFactoriesServiceRef = createServiceRef<ReaderFactory>({
id: 'core.urlReader.factories',
scope: 'plugin',
multiton: true,
});
/**
* Reading content from external systems.
@@ -59,7 +58,7 @@ export const urlReaderServiceFactory = createServiceFactory({
deps: {
config: coreServices.rootConfig,
logger: coreServices.logger,
factories: urlReaderProviderFactoriesServiceRef,
factories: urlReaderFactoriesServiceRef,
},
async factory({ config, logger, factories }) {
return UrlReaders.default({