From b838717e9235e6d02c47f7b98e660de0c4cf51f8 Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Wed, 2 Mar 2022 12:00:44 +0000 Subject: [PATCH 1/2] exort FetchUrlReader Signed-off-by: Brian Fletcher --- .changeset/olive-glasses-approve.md | 5 +++++ packages/backend-common/src/reading/index.ts | 1 + 2 files changed, 6 insertions(+) create mode 100644 .changeset/olive-glasses-approve.md diff --git a/.changeset/olive-glasses-approve.md b/.changeset/olive-glasses-approve.md new file mode 100644 index 0000000000..e74b7ef485 --- /dev/null +++ b/.changeset/olive-glasses-approve.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Export FetchUrlReader to facilitate more flexible configuration of the backend. diff --git a/packages/backend-common/src/reading/index.ts b/packages/backend-common/src/reading/index.ts index 2c3394e4fc..9c29bc93fe 100644 --- a/packages/backend-common/src/reading/index.ts +++ b/packages/backend-common/src/reading/index.ts @@ -19,6 +19,7 @@ export { BitbucketUrlReader } from './BitbucketUrlReader'; export { GithubUrlReader } from './GithubUrlReader'; export { GitlabUrlReader } from './GitlabUrlReader'; export { AwsS3UrlReader } from './AwsS3UrlReader'; +export { FetchUrlReader } from './FetchUrlReader'; export type { FromReadableArrayOptions, ReaderFactory, From fb01d26fd71802671926d354227f86b305b2fe5a Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Wed, 2 Mar 2022 12:27:49 +0000 Subject: [PATCH 2/2] adds api reports Signed-off-by: Brian Fletcher --- packages/backend-common/api-report.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 9b963f3fc9..4ed9bb1514 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -234,6 +234,21 @@ export type ErrorHandlerOptions = { logClientErrors?: boolean; }; +// @public +export class FetchUrlReader implements UrlReader { + static factory: ReaderFactory; + // (undocumented) + read(url: string): Promise; + // (undocumented) + readTree(): Promise; + // (undocumented) + readUrl(url: string, options?: ReadUrlOptions): Promise; + // (undocumented) + search(): Promise; + // (undocumented) + toString(): string; +} + // @public export type FromReadableArrayOptions = Array<{ data: Readable;