From 30c2be9bcd2457667e0259629e054e819461fb68 Mon Sep 17 00:00:00 2001 From: secustor Date: Wed, 17 Jul 2024 12:23:32 +0200 Subject: [PATCH 01/13] fix: Update @microsoft/api-extractor and use their api report resolution Signed-off-by: secustor --- .changeset/fluffy-pears-cry.md | 5 +++++ .prettierignore | 5 +++++ REVIEWING.md | 4 ++-- packages/repo-tools/package.json | 4 ++-- .../src/commands/api-reports/api-extractor.ts | 15 ++++++--------- 5 files changed, 20 insertions(+), 13 deletions(-) create mode 100644 .changeset/fluffy-pears-cry.md diff --git a/.changeset/fluffy-pears-cry.md b/.changeset/fluffy-pears-cry.md new file mode 100644 index 0000000000..ad7eed680c --- /dev/null +++ b/.changeset/fluffy-pears-cry.md @@ -0,0 +1,5 @@ +--- +'@backstage/repo-tools': patch +--- + +Update @microsoft/api-extractor and use their api report resolution diff --git a/.prettierignore b/.prettierignore index 3a16bd1388..2212e834c0 100644 --- a/.prettierignore +++ b/.prettierignore @@ -4,8 +4,13 @@ microsite coverage *.hbs templates +# old reports api-report.md api-report-*.md +# new reports +api-report.api.md +api-report-*.api.md + knip-report.md cli-report.md plugins/scaffolder-backend/sample-templates diff --git a/REVIEWING.md b/REVIEWING.md index c443c15d77..880577da40 100644 --- a/REVIEWING.md +++ b/REVIEWING.md @@ -68,7 +68,7 @@ In general our changeset feedback bot will take care of informing whether a chan Changes that do NOT need a new changeset: -- Changes to any test, storybook, or other local development files, for example, `MyComponent.test.tsx`, `MyComponent.stories.tsx`, `**mocks**/MyMock.ts`, `.eslintrc.js`, `setupTests.ts`, or `api-report.md`. Explained differently, it is only files that affect the published package that need changesets, such as source files and additional resources like `package.json`, `README.md`, `config.d.ts`, etc. +- Changes to any test, storybook, or other local development files, for example, `MyComponent.test.tsx`, `MyComponent.stories.tsx`, `**mocks**/MyMock.ts`, `.eslintrc.js`, `setupTests.ts`, or `api-report.api.md`. Explained differently, it is only files that affect the published package that need changesets, such as source files and additional resources like `package.json`, `README.md`, `config.d.ts`, etc. - When tweaking a change that has not yet been released, you can rely on and potentially modify the existing changeset instead. - Changes that do not belong to a published packages, either because it's not a package at all, such as `docs/`, or because the package is private, such as `packages/app`. - Changes that do not end up having an effect on the published package, such as whitespace fixes or code formatting changes. Although it's also fine to have a short changeset for these kind of changes too. @@ -168,7 +168,7 @@ In this section we will be talking about changed "types", but by that we mean an #### API Reports -We generate API Reports using the [API Extractor](https://api-extractor.com/) tool. These reports are generated for most packages in the Backstage repository, and are stored in the `api-report.md` file of each package. For CLI package we use custom tooling, and instead store the result in `cli-report.md`. Whenever the public API of a package changes, the API Report needs to be updated to reflect the new state of the API. Our CI checks will fail if the API reports are not up to date in a pull request. +We generate API Reports using the [API Extractor](https://api-extractor.com/) tool. These reports are generated for most packages in the Backstage repository, and are stored in the `api-report.api.md` file of each package. For CLI package we use custom tooling, and instead store the result in `cli-report.md`. Whenever the public API of a package changes, the API Report needs to be updated to reflect the new state of the API. Our CI checks will fail if the API reports are not up to date in a pull request. Each API report contains a list of all the exported types of each package. As long as the API report does not have any warnings it will contain the full publicly facing API of the package, meaning you do not need to consider any other changes to the package from the point of view of TypeScript API stability. diff --git a/packages/repo-tools/package.json b/packages/repo-tools/package.json index 8fcd5079a3..76fb74cc42 100644 --- a/packages/repo-tools/package.json +++ b/packages/repo-tools/package.json @@ -50,8 +50,8 @@ "@backstage/config-loader": "workspace:^", "@backstage/errors": "workspace:^", "@manypkg/get-packages": "^1.1.3", - "@microsoft/api-documenter": "^7.22.33", - "@microsoft/api-extractor": "^7.36.4", + "@microsoft/api-documenter": "^7.25.7", + "@microsoft/api-extractor": "^7.47.2", "@openapitools/openapi-generator-cli": "^2.7.0", "@stoplight/spectral-core": "^1.18.0", "@stoplight/spectral-formatters": "^1.1.0", diff --git a/packages/repo-tools/src/commands/api-reports/api-extractor.ts b/packages/repo-tools/src/commands/api-reports/api-extractor.ts index 371f122713..fa8dea5f28 100644 --- a/packages/repo-tools/src/commands/api-reports/api-extractor.ts +++ b/packages/repo-tools/src/commands/api-reports/api-extractor.ts @@ -393,19 +393,16 @@ export async function runApiExtraction({ ); const remainingReportFiles = new Set( - fs - .readdirSync(projectFolder) - .filter( - filename => - filename.match(/^(.+)-api-report\.md$/) || - filename.match(/^api-report(-.+)?\.md$/), - ), + fs.readdirSync(projectFolder).filter(filename => + // https://regex101.com/r/QDZIV0/1 + filename.match(/^.*?api-report(-[^.-]+)?(\.md(\.api\.md)?)$/), + ), ); for (const packageEntryPoint of packageEntryPoints) { const suffix = packageEntryPoint.name === 'index' ? '' : `-${packageEntryPoint.name}`; - const reportFileName = `api-report${suffix}.md`; + const reportFileName = `api-report${suffix}`; const reportPath = resolvePath(projectFolder, reportFileName); remainingReportFiles.delete(reportFileName); @@ -522,7 +519,7 @@ export async function runApiExtraction({ ) { shouldLogInstructions = true; const match = message.text.match( - /Please copy the file "(.*)" to "api-report\.md"/, + /Please copy the file "(.*)" to "api-report\.api\.md"/, ); if (match) { conflictingFile = match[1]; From 65da28ad53f73648a4240782add4441804c4f709 Mon Sep 17 00:00:00 2001 From: secustor Date: Sun, 21 Jul 2024 09:17:36 +0200 Subject: [PATCH 02/13] add newly generated api reports Signed-off-by: secustor --- .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 0 ...-report-auth.md => api-report-auth.api.md} | 0 ...eport-cache.md => api-report-cache.api.md} | 0 ...database.md => api-report-database.api.md} | 0 ...scovery.md => api-report-discovery.api.md} | 5 + ...httpAuth.md => api-report-httpAuth.api.md} | 0 ...Router.md => api-report-httpRouter.api.md} | 0 ...fecycle.md => api-report-lifecycle.api.md} | 0 ...ort-logger.md => api-report-logger.api.md} | 0 ...sions.md => api-report-permissions.api.md} | 0 ...Config.md => api-report-rootConfig.api.md} | 6 + ...Health.md => api-report-rootHealth.api.md} | 4 + ...er.md => api-report-rootHttpRouter.api.md} | 22 + ...cle.md => api-report-rootLifecycle.api.md} | 0 ...Logger.md => api-report-rootLogger.api.md} | 14 + ...heduler.md => api-report-scheduler.api.md} | 4 + ...lReader.md => api-report-urlReader.api.md} | 73 ++ ...userInfo.md => api-report-userInfo.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 64 ++ .../{api-report.md => api-report.api.md} | 80 +++ ...eport-alpha.md => api-report-alpha.api.md} | 5 + ...stUtils.md => api-report-testUtils.api.md} | 5 + .../{api-report.md => api-report.api.md} | 61 ++ .../{api-report.md => api-report.api.md} | 91 +++ .../{api-report.md => api-report.api.md} | 9 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 48 ++ .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 24 + .../{api-report.md => api-report.api.md} | 28 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 66 ++ .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + ...stUtils.md => api-report-testUtils.api.md} | 0 .../{api-report.md => api-report.api.md} | 180 ++++- ...eport-alpha.md => api-report-alpha.api.md} | 31 + .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 5 + ...wright.md => api-report-playwright.api.md} | 0 .../{api-report.md => api-report.api.md} | 12 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 119 ++++ .../{api-report.md => api-report.api.md} | 10 + .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 123 ++++ .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 7 + .../{api-report.md => api-report.api.md} | 34 +- .../{api-report.md => api-report.api.md} | 26 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 4 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 33 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 9 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 6 + .../{api-report.md => api-report.api.md} | 8 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 6 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 6 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 8 + .../{api-report.md => api-report.api.md} | 8 + .../{api-report.md => api-report.api.md} | 64 ++ .../{api-report.md => api-report.api.md} | 124 ++++ .../{api-report.md => api-report.api.md} | 0 .../bitbucket-cloud-common/api-report.api.md | 625 ++++++++++++++++++ ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 15 +- ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 10 +- .../{api-report.md => api-report.api.md} | 6 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 9 +- ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 17 +- ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 8 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 8 + .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 45 +- .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 25 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 8 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 12 +- .../{api-report.md => api-report.api.md} | 9 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 10 +- .../{api-report.md => api-report.api.md} | 6 + .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 81 +++ ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 12 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 4 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 42 ++ ...eport-alpha.md => api-report-alpha.api.md} | 18 + .../{api-report.md => api-report.api.md} | 18 + ...eport-alpha.md => api-report-alpha.api.md} | 7 + .../{api-report.md => api-report.api.md} | 111 ++++ .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 4 + ...eport-alpha.md => api-report-alpha.api.md} | 6 + .../{api-report.md => api-report.api.md} | 111 +++- .../{api-report.md => api-report.api.md} | 11 + .../{api-report.md => api-report.api.md} | 15 + .../{api-report.md => api-report.api.md} | 16 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 10 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + .../api-report.api.md | 86 +++ .../events-backend-test-utils/api-report.md | 63 -- ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 10 + ...eport-alpha.md => api-report-alpha.api.md} | 9 + .../{api-report.md => api-report.api.md} | 22 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 11 + ...eport-alpha.md => api-report-alpha.api.md} | 5 + .../home/{api-report.md => api-report.api.md} | 30 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 114 ++++ .../{api-report.md => api-report.api.md} | 5 + plugins/kubernetes-common/api-report.api.md | 604 +++++++++++++++++ plugins/kubernetes-common/api-report.md | 468 ------------- .../{api-report.md => api-report.api.md} | 56 ++ .../{api-report.md => api-report.api.md} | 169 +++++ .../{api-report.md => api-report.api.md} | 7 + .../{api-report.md => api-report.api.md} | 11 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 12 + .../{api-report.md => api-report.api.md} | 16 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 4 + ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../org/{api-report.md => api-report.api.md} | 13 + .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 11 + .../{api-report.md => api-report.api.md} | 4 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 13 +- .../{api-report.md => api-report.api.md} | 6 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 9 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 7 + .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 9 + .../{api-report.md => api-report.api.md} | 4 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 4 + .../{api-report.md => api-report.api.md} | 111 ++++ ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 11 + .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 12 + .../{api-report.md => api-report.api.md} | 45 ++ ...eport-alpha.md => api-report-alpha.api.md} | 45 ++ .../{api-report.md => api-report.api.md} | 39 ++ ...eport-alpha.md => api-report-alpha.api.md} | 6 + .../{api-report.md => api-report.api.md} | 52 ++ ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 10 + ...eport-alpha.md => api-report-alpha.api.md} | 5 + .../{api-report.md => api-report.api.md} | 95 +++ ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 7 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 47 ++ .../{api-report.md => api-report.api.md} | 10 + ...eport-alpha.md => api-report-alpha.api.md} | 5 + .../{api-report.md => api-report.api.md} | 9 + ...eport-alpha.md => api-report-alpha.api.md} | 6 + .../{api-report.md => api-report.api.md} | 20 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 5 + .../{api-report.md => api-report.api.md} | 20 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 20 + ...eport-alpha.md => api-report-alpha.api.md} | 7 + .../{api-report.md => api-report.api.md} | 15 + .../{api-report.md => api-report.api.md} | 13 + .../{api-report.md => api-report.api.md} | 12 + .../{api-report.md => api-report.api.md} | 9 + .../{api-report.md => api-report.api.md} | 9 + .../{api-report.md => api-report.api.md} | 0 ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 13 + .../{api-report.md => api-report.api.md} | 0 .../{api-report.md => api-report.api.md} | 12 + .../{api-report.md => api-report.api.md} | 13 + ...eport-alpha.md => api-report-alpha.api.md} | 5 + .../{api-report.md => api-report.api.md} | 32 + ...eport-alpha.md => api-report-alpha.api.md} | 0 .../{api-report.md => api-report.api.md} | 7 + .../{api-report.md => api-report.api.md} | 4 + ...eport-alpha.md => api-report-alpha.api.md} | 6 + .../{api-report.md => api-report.api.md} | 32 + 251 files changed, 4846 insertions(+), 580 deletions(-) rename packages/app-defaults/{api-report.md => api-report.api.md} (100%) rename packages/app-next-example-plugin/{api-report.md => api-report.api.md} (86%) rename packages/backend-app-api/{api-report-alpha.md => api-report-alpha.api.md} (73%) rename packages/backend-app-api/{api-report.md => api-report.api.md} (100%) rename packages/backend-defaults/{api-report-auth.md => api-report-auth.api.md} (100%) rename packages/backend-defaults/{api-report-cache.md => api-report-cache.api.md} (100%) rename packages/backend-defaults/{api-report-database.md => api-report-database.api.md} (100%) rename packages/backend-defaults/{api-report-discovery.md => api-report-discovery.api.md} (74%) rename packages/backend-defaults/{api-report-httpAuth.md => api-report-httpAuth.api.md} (100%) rename packages/backend-defaults/{api-report-httpRouter.md => api-report-httpRouter.api.md} (100%) rename packages/backend-defaults/{api-report-lifecycle.md => api-report-lifecycle.api.md} (100%) rename packages/backend-defaults/{api-report-logger.md => api-report-logger.api.md} (100%) rename packages/backend-defaults/{api-report-permissions.md => api-report-permissions.api.md} (100%) rename packages/backend-defaults/{api-report-rootConfig.md => api-report-rootConfig.api.md} (72%) rename packages/backend-defaults/{api-report-rootHealth.md => api-report-rootHealth.api.md} (71%) rename packages/backend-defaults/{api-report-rootHttpRouter.md => api-report-rootHttpRouter.api.md} (62%) rename packages/backend-defaults/{api-report-rootLifecycle.md => api-report-rootLifecycle.api.md} (100%) rename packages/backend-defaults/{api-report-rootLogger.md => api-report-rootLogger.api.md} (55%) rename packages/backend-defaults/{api-report-scheduler.md => api-report-scheduler.api.md} (81%) rename packages/backend-defaults/{api-report-urlReader.md => api-report-urlReader.api.md} (59%) rename packages/backend-defaults/{api-report-userInfo.md => api-report-userInfo.api.md} (100%) rename packages/backend-defaults/{api-report.md => api-report.api.md} (100%) rename packages/backend-dev-utils/{api-report.md => api-report.api.md} (100%) rename packages/backend-dynamic-feature-service/{api-report.md => api-report.api.md} (57%) rename packages/backend-openapi-utils/{api-report.md => api-report.api.md} (72%) rename packages/backend-plugin-api/{api-report-alpha.md => api-report-alpha.api.md} (73%) rename packages/backend-plugin-api/{api-report-testUtils.md => api-report-testUtils.api.md} (70%) rename packages/backend-plugin-api/{api-report.md => api-report.api.md} (75%) rename packages/backend-test-utils/{api-report.md => api-report.api.md} (62%) rename packages/catalog-client/{api-report.md => api-report.api.md} (92%) rename packages/catalog-model/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename packages/catalog-model/{api-report.md => api-report.api.md} (70%) rename packages/cli-common/{api-report.md => api-report.api.md} (100%) rename packages/cli-node/{api-report.md => api-report.api.md} (67%) rename packages/config-loader/{api-report.md => api-report.api.md} (72%) rename packages/config/{api-report.md => api-report.api.md} (100%) rename packages/core-app-api/{api-report.md => api-report.api.md} (70%) rename packages/core-compat-api/{api-report.md => api-report.api.md} (93%) rename packages/core-components/{api-report-alpha.md => api-report-alpha.api.md} (95%) rename packages/core-components/{api-report-testUtils.md => api-report-testUtils.api.md} (100%) rename packages/core-components/{api-report.md => api-report.api.md} (72%) rename packages/core-plugin-api/{api-report-alpha.md => api-report-alpha.api.md} (64%) rename packages/core-plugin-api/{api-report.md => api-report.api.md} (99%) rename packages/dev-utils/{api-report.md => api-report.api.md} (89%) rename packages/e2e-test-utils/{api-report-playwright.md => api-report-playwright.api.md} (100%) rename packages/errors/{api-report.md => api-report.api.md} (80%) rename packages/frontend-app-api/{api-report.md => api-report.api.md} (100%) rename packages/frontend-plugin-api/{api-report.md => api-report.api.md} (77%) rename packages/frontend-test-utils/{api-report.md => api-report.api.md} (84%) rename packages/integration-aws-node/{api-report.md => api-report.api.md} (86%) rename packages/integration-react/{api-report.md => api-report.api.md} (100%) rename packages/integration/{api-report.md => api-report.api.md} (66%) rename packages/release-manifests/{api-report.md => api-report.api.md} (100%) rename packages/test-utils/{api-report-alpha.md => api-report-alpha.api.md} (63%) rename packages/test-utils/{api-report.md => api-report.api.md} (82%) rename packages/theme/{api-report.md => api-report.api.md} (81%) rename packages/types/{api-report.md => api-report.api.md} (100%) rename packages/version-bridge/{api-report.md => api-report.api.md} (100%) rename packages/yarn-plugin/{api-report.md => api-report.api.md} (68%) rename plugins/api-docs-module-protoc-gen-doc/{api-report.md => api-report.api.md} (72%) rename plugins/api-docs/{api-report-alpha.md => api-report-alpha.api.md} (98%) rename plugins/api-docs/{api-report.md => api-report.api.md} (63%) rename plugins/app-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/app-backend/{api-report.md => api-report.api.md} (65%) rename plugins/app-node/{api-report.md => api-report.api.md} (100%) rename plugins/app-visualizer/{api-report.md => api-report.api.md} (93%) rename plugins/auth-backend-module-atlassian-provider/{api-report.md => api-report.api.md} (80%) rename plugins/auth-backend-module-aws-alb-provider/{api-report.md => api-report.api.md} (78%) rename plugins/auth-backend-module-azure-easyauth-provider/{api-report.md => api-report.api.md} (66%) rename plugins/auth-backend-module-bitbucket-provider/{api-report.md => api-report.api.md} (82%) rename plugins/auth-backend-module-cloudflare-access-provider/{api-report.md => api-report.api.md} (82%) rename plugins/auth-backend-module-gcp-iap-provider/{api-report.md => api-report.api.md} (84%) rename plugins/auth-backend-module-github-provider/{api-report.md => api-report.api.md} (80%) rename plugins/auth-backend-module-gitlab-provider/{api-report.md => api-report.api.md} (80%) rename plugins/auth-backend-module-google-provider/{api-report.md => api-report.api.md} (81%) rename plugins/auth-backend-module-guest-provider/{api-report.md => api-report.api.md} (71%) rename plugins/auth-backend-module-microsoft-provider/{api-report.md => api-report.api.md} (78%) rename plugins/auth-backend-module-oauth2-provider/{api-report.md => api-report.api.md} (80%) rename plugins/auth-backend-module-oauth2-proxy-provider/{api-report.md => api-report.api.md} (78%) rename plugins/auth-backend-module-oidc-provider/{api-report.md => api-report.api.md} (85%) rename plugins/auth-backend-module-okta-provider/{api-report.md => api-report.api.md} (80%) rename plugins/auth-backend-module-onelogin-provider/{api-report.md => api-report.api.md} (80%) rename plugins/auth-backend-module-pinniped-provider/{api-report.md => api-report.api.md} (67%) rename plugins/auth-backend-module-vmware-cloud-provider/{api-report.md => api-report.api.md} (72%) rename plugins/auth-backend/{api-report.md => api-report.api.md} (76%) rename plugins/auth-node/{api-report.md => api-report.api.md} (58%) rename plugins/auth-react/{api-report.md => api-report.api.md} (100%) create mode 100644 plugins/bitbucket-cloud-common/api-report.api.md rename plugins/catalog-backend-module-aws/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-aws/{api-report.md => api-report.api.md} (74%) rename plugins/catalog-backend-module-azure/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-azure/{api-report.md => api-report.api.md} (74%) rename plugins/catalog-backend-module-backstage-openapi/{api-report.md => api-report.api.md} (65%) rename plugins/catalog-backend-module-bitbucket-cloud/{api-report-alpha.md => api-report-alpha.api.md} (69%) rename plugins/catalog-backend-module-bitbucket-cloud/{api-report.md => api-report.api.md} (79%) rename plugins/catalog-backend-module-bitbucket-server/{api-report-alpha.md => api-report-alpha.api.md} (68%) rename plugins/catalog-backend-module-bitbucket-server/{api-report.md => api-report.api.md} (70%) rename plugins/catalog-backend-module-gcp/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-gcp/{api-report.md => api-report.api.md} (71%) rename plugins/catalog-backend-module-gerrit/{api-report-alpha.md => api-report-alpha.api.md} (69%) rename plugins/catalog-backend-module-gerrit/{api-report.md => api-report.api.md} (65%) rename plugins/catalog-backend-module-github-org/{api-report.md => api-report.api.md} (100%) rename plugins/catalog-backend-module-github/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-github/{api-report.md => api-report.api.md} (70%) rename plugins/catalog-backend-module-gitlab-org/{api-report.md => api-report.api.md} (100%) rename plugins/catalog-backend-module-gitlab/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-gitlab/{api-report.md => api-report.api.md} (65%) rename plugins/catalog-backend-module-incremental-ingestion/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-incremental-ingestion/{api-report.md => api-report.api.md} (82%) rename plugins/catalog-backend-module-ldap/{api-report.md => api-report.api.md} (100%) rename plugins/catalog-backend-module-logs/{api-report.md => api-report.api.md} (100%) rename plugins/catalog-backend-module-msgraph/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-msgraph/{api-report.md => api-report.api.md} (90%) rename plugins/catalog-backend-module-openapi/{api-report.md => api-report.api.md} (71%) rename plugins/catalog-backend-module-puppetdb/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend-module-puppetdb/{api-report.md => api-report.api.md} (68%) rename plugins/catalog-backend-module-scaffolder-entity-model/{api-report.md => api-report.api.md} (70%) rename plugins/catalog-backend-module-unprocessed/{api-report.md => api-report.api.md} (79%) rename plugins/catalog-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-backend/{api-report.md => api-report.api.md} (67%) rename plugins/catalog-common/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/catalog-common/{api-report.md => api-report.api.md} (60%) rename plugins/catalog-graph/{api-report-alpha.md => api-report-alpha.api.md} (97%) rename plugins/catalog-graph/{api-report.md => api-report.api.md} (95%) rename plugins/catalog-import/{api-report-alpha.md => api-report-alpha.api.md} (93%) rename plugins/catalog-import/{api-report.md => api-report.api.md} (62%) rename plugins/catalog-node/{api-report-alpha.md => api-report-alpha.api.md} (69%) rename plugins/catalog-node/{api-report.md => api-report.api.md} (78%) rename plugins/catalog-react/{api-report-alpha.md => api-report-alpha.api.md} (95%) rename plugins/catalog-react/{api-report.md => api-report.api.md} (65%) rename plugins/catalog-unprocessed-entities-common/{api-report.md => api-report.api.md} (100%) rename plugins/catalog-unprocessed-entities/{api-report.md => api-report.api.md} (91%) rename plugins/catalog/{api-report-alpha.md => api-report-alpha.api.md} (98%) rename plugins/catalog/{api-report.md => api-report.api.md} (58%) rename plugins/config-schema/{api-report.md => api-report.api.md} (60%) rename plugins/devtools-backend/{api-report.md => api-report.api.md} (59%) rename plugins/devtools-common/{api-report.md => api-report.api.md} (56%) rename plugins/devtools/{api-report-alpha.md => api-report-alpha.api.md} (94%) rename plugins/devtools/{api-report.md => api-report.api.md} (62%) rename plugins/events-backend-module-aws-sqs/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend-module-aws-sqs/{api-report.md => api-report.api.md} (71%) rename plugins/events-backend-module-azure/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend-module-azure/{api-report.md => api-report.api.md} (70%) rename plugins/events-backend-module-bitbucket-cloud/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend-module-bitbucket-cloud/{api-report.md => api-report.api.md} (70%) rename plugins/events-backend-module-gerrit/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend-module-gerrit/{api-report.md => api-report.api.md} (71%) rename plugins/events-backend-module-github/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend-module-github/{api-report.md => api-report.api.md} (76%) rename plugins/events-backend-module-gitlab/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend-module-gitlab/{api-report.md => api-report.api.md} (76%) create mode 100644 plugins/events-backend-test-utils/api-report.api.md delete mode 100644 plugins/events-backend-test-utils/api-report.md rename plugins/events-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/events-backend/{api-report.md => api-report.api.md} (70%) rename plugins/events-node/{api-report-alpha.md => api-report-alpha.api.md} (64%) rename plugins/events-node/{api-report.md => api-report.api.md} (63%) rename plugins/example-todo-list-backend/{api-report.md => api-report.api.md} (100%) rename plugins/example-todo-list-common/{api-report.md => api-report.api.md} (100%) rename plugins/example-todo-list/{api-report.md => api-report.api.md} (100%) rename plugins/home-react/{api-report.md => api-report.api.md} (69%) rename plugins/home/{api-report-alpha.md => api-report-alpha.api.md} (90%) rename plugins/home/{api-report.md => api-report.api.md} (75%) rename plugins/kubernetes-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/kubernetes-backend/{api-report.md => api-report.api.md} (54%) rename plugins/kubernetes-cluster/{api-report.md => api-report.api.md} (73%) create mode 100644 plugins/kubernetes-common/api-report.api.md delete mode 100644 plugins/kubernetes-common/api-report.md rename plugins/kubernetes-node/{api-report.md => api-report.api.md} (60%) rename plugins/kubernetes-react/{api-report.md => api-report.api.md} (51%) rename plugins/kubernetes/{api-report.md => api-report.api.md} (80%) rename plugins/notifications-backend-module-email/{api-report.md => api-report.api.md} (57%) rename plugins/notifications-backend/{api-report.md => api-report.api.md} (100%) rename plugins/notifications-common/{api-report.md => api-report.api.md} (64%) rename plugins/notifications-node/{api-report.md => api-report.api.md} (64%) rename plugins/notifications/{api-report.md => api-report.api.md} (100%) rename plugins/org-react/{api-report.md => api-report.api.md} (77%) rename plugins/org/{api-report-alpha.md => api-report-alpha.api.md} (97%) rename plugins/org/{api-report.md => api-report.api.md} (73%) rename plugins/permission-backend-module-policy-allow-all/{api-report.md => api-report.api.md} (100%) rename plugins/permission-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/permission-backend/{api-report.md => api-report.api.md} (62%) rename plugins/permission-common/{api-report.md => api-report.api.md} (97%) rename plugins/permission-node/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/permission-node/{api-report.md => api-report.api.md} (93%) rename plugins/permission-react/{api-report.md => api-report.api.md} (88%) rename plugins/proxy-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/proxy-backend/{api-report.md => api-report.api.md} (56%) rename plugins/scaffolder-backend-module-azure/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-bitbucket-cloud/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-bitbucket-server/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-bitbucket/{api-report.md => api-report.api.md} (80%) rename plugins/scaffolder-backend-module-confluence-to-markdown/{api-report.md => api-report.api.md} (82%) rename plugins/scaffolder-backend-module-cookiecutter/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-gcp/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-gerrit/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-gitea/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-github/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-gitlab/{api-report.md => api-report.api.md} (92%) rename plugins/scaffolder-backend-module-notifications/{api-report.md => api-report.api.md} (86%) rename plugins/scaffolder-backend-module-rails/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-sentry/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend-module-yeoman/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-backend/{api-report-alpha.md => api-report-alpha.api.md} (93%) rename plugins/scaffolder-backend/{api-report.md => api-report.api.md} (67%) rename plugins/scaffolder-common/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/scaffolder-common/{api-report.md => api-report.api.md} (77%) rename plugins/scaffolder-node-test-utils/{api-report.md => api-report.api.md} (100%) rename plugins/scaffolder-node/{api-report-alpha.md => api-report-alpha.api.md} (77%) rename plugins/scaffolder-node/{api-report.md => api-report.api.md} (73%) rename plugins/scaffolder-react/{api-report-alpha.md => api-report-alpha.api.md} (62%) rename plugins/scaffolder-react/{api-report.md => api-report.api.md} (80%) rename plugins/scaffolder/{api-report-alpha.md => api-report-alpha.api.md} (97%) rename plugins/scaffolder/{api-report.md => api-report.api.md} (80%) rename plugins/search-backend-module-catalog/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/search-backend-module-catalog/{api-report.md => api-report.api.md} (66%) rename plugins/search-backend-module-elasticsearch/{api-report-alpha.md => api-report-alpha.api.md} (77%) rename plugins/search-backend-module-elasticsearch/{api-report.md => api-report.api.md} (53%) rename plugins/search-backend-module-explore/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/search-backend-module-explore/{api-report.md => api-report.api.md} (74%) rename plugins/search-backend-module-pg/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/search-backend-module-pg/{api-report.md => api-report.api.md} (53%) rename plugins/search-backend-module-stack-overflow-collator/{api-report.md => api-report.api.md} (65%) rename plugins/search-backend-module-techdocs/{api-report-alpha.md => api-report-alpha.api.md} (77%) rename plugins/search-backend-module-techdocs/{api-report.md => api-report.api.md} (70%) rename plugins/search-backend-node/{api-report-alpha.md => api-report-alpha.api.md} (85%) rename plugins/search-backend-node/{api-report.md => api-report.api.md} (76%) rename plugins/search-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/search-backend/{api-report.md => api-report.api.md} (83%) rename plugins/search-common/{api-report.md => api-report.api.md} (64%) rename plugins/search-react/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/search-react/{api-report.md => api-report.api.md} (87%) rename plugins/search/{api-report-alpha.md => api-report-alpha.api.md} (92%) rename plugins/search/{api-report.md => api-report.api.md} (71%) rename plugins/signals-backend/{api-report.md => api-report.api.md} (60%) rename plugins/signals-node/{api-report.md => api-report.api.md} (64%) rename plugins/signals-react/{api-report.md => api-report.api.md} (60%) rename plugins/signals/{api-report.md => api-report.api.md} (67%) rename plugins/techdocs-addons-test-utils/{api-report.md => api-report.api.md} (100%) rename plugins/techdocs-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/techdocs-backend/{api-report.md => api-report.api.md} (77%) rename plugins/techdocs-module-addons-contrib/{api-report.md => api-report.api.md} (100%) rename plugins/techdocs-node/{api-report.md => api-report.api.md} (90%) rename plugins/techdocs-react/{api-report.md => api-report.api.md} (85%) rename plugins/techdocs/{api-report-alpha.md => api-report-alpha.api.md} (97%) rename plugins/techdocs/{api-report.md => api-report.api.md} (82%) rename plugins/user-settings-backend/{api-report-alpha.md => api-report-alpha.api.md} (100%) rename plugins/user-settings-backend/{api-report.md => api-report.api.md} (62%) rename plugins/user-settings-common/{api-report.md => api-report.api.md} (71%) rename plugins/user-settings/{api-report-alpha.md => api-report-alpha.api.md} (91%) rename plugins/user-settings/{api-report.md => api-report.api.md} (59%) diff --git a/packages/app-defaults/api-report.md b/packages/app-defaults/api-report.api.md similarity index 100% rename from packages/app-defaults/api-report.md rename to packages/app-defaults/api-report.api.md diff --git a/packages/app-next-example-plugin/api-report.md b/packages/app-next-example-plugin/api-report.api.md similarity index 86% rename from packages/app-next-example-plugin/api-report.md rename to packages/app-next-example-plugin/api-report.api.md index 1fc58dfc17..ededab5e47 100644 --- a/packages/app-next-example-plugin/api-report.md +++ b/packages/app-next-example-plugin/api-report.api.md @@ -52,5 +52,10 @@ export default examplePlugin; // @public (undocumented) export const ExampleSidebarItem: () => React_2.JSX.Element; +// Warnings were encountered during analysis: +// +// src/ExampleSidebarItem.d.ts:3:22 - (ae-undocumented) Missing documentation for "ExampleSidebarItem". +// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "examplePlugin". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/api-report-alpha.md b/packages/backend-app-api/api-report-alpha.api.md similarity index 73% rename from packages/backend-app-api/api-report-alpha.md rename to packages/backend-app-api/api-report-alpha.api.md index 163cc325a1..12a4b66d68 100644 --- a/packages/backend-app-api/api-report-alpha.md +++ b/packages/backend-app-api/api-report-alpha.api.md @@ -13,5 +13,9 @@ export const featureDiscoveryServiceFactory: ServiceFactory< 'singleton' >; +// Warnings were encountered during analysis: +// +// src/alpha/featureDiscoveryServiceFactory.d.ts:3:22 - (ae-undocumented) Missing documentation for "featureDiscoveryServiceFactory". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/api-report.md b/packages/backend-app-api/api-report.api.md similarity index 100% rename from packages/backend-app-api/api-report.md rename to packages/backend-app-api/api-report.api.md diff --git a/packages/backend-defaults/api-report-auth.md b/packages/backend-defaults/api-report-auth.api.md similarity index 100% rename from packages/backend-defaults/api-report-auth.md rename to packages/backend-defaults/api-report-auth.api.md diff --git a/packages/backend-defaults/api-report-cache.md b/packages/backend-defaults/api-report-cache.api.md similarity index 100% rename from packages/backend-defaults/api-report-cache.md rename to packages/backend-defaults/api-report-cache.api.md diff --git a/packages/backend-defaults/api-report-database.md b/packages/backend-defaults/api-report-database.api.md similarity index 100% rename from packages/backend-defaults/api-report-database.md rename to packages/backend-defaults/api-report-database.api.md diff --git a/packages/backend-defaults/api-report-discovery.md b/packages/backend-defaults/api-report-discovery.api.md similarity index 74% rename from packages/backend-defaults/api-report-discovery.md rename to packages/backend-defaults/api-report-discovery.api.md index d168d33a71..fe7d639ebc 100644 --- a/packages/backend-defaults/api-report-discovery.md +++ b/packages/backend-defaults/api-report-discovery.api.md @@ -23,5 +23,10 @@ export class HostDiscovery implements DiscoveryService { getExternalBaseUrl(pluginId: string): Promise; } +// Warnings were encountered during analysis: +// +// src/entrypoints/discovery/HostDiscovery.d.ts:46:5 - (ae-undocumented) Missing documentation for "getBaseUrl". +// src/entrypoints/discovery/HostDiscovery.d.ts:47:5 - (ae-undocumented) Missing documentation for "getExternalBaseUrl". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-httpAuth.md b/packages/backend-defaults/api-report-httpAuth.api.md similarity index 100% rename from packages/backend-defaults/api-report-httpAuth.md rename to packages/backend-defaults/api-report-httpAuth.api.md diff --git a/packages/backend-defaults/api-report-httpRouter.md b/packages/backend-defaults/api-report-httpRouter.api.md similarity index 100% rename from packages/backend-defaults/api-report-httpRouter.md rename to packages/backend-defaults/api-report-httpRouter.api.md diff --git a/packages/backend-defaults/api-report-lifecycle.md b/packages/backend-defaults/api-report-lifecycle.api.md similarity index 100% rename from packages/backend-defaults/api-report-lifecycle.md rename to packages/backend-defaults/api-report-lifecycle.api.md diff --git a/packages/backend-defaults/api-report-logger.md b/packages/backend-defaults/api-report-logger.api.md similarity index 100% rename from packages/backend-defaults/api-report-logger.md rename to packages/backend-defaults/api-report-logger.api.md diff --git a/packages/backend-defaults/api-report-permissions.md b/packages/backend-defaults/api-report-permissions.api.md similarity index 100% rename from packages/backend-defaults/api-report-permissions.md rename to packages/backend-defaults/api-report-permissions.api.md diff --git a/packages/backend-defaults/api-report-rootConfig.md b/packages/backend-defaults/api-report-rootConfig.api.md similarity index 72% rename from packages/backend-defaults/api-report-rootConfig.md rename to packages/backend-defaults/api-report-rootConfig.api.md index 2935ad1128..6c65d00a3b 100644 --- a/packages/backend-defaults/api-report-rootConfig.md +++ b/packages/backend-defaults/api-report-rootConfig.api.md @@ -31,5 +31,11 @@ export const rootConfigServiceFactory: (( ) => ServiceFactory) & ServiceFactory; +// Warnings were encountered during analysis: +// +// src/entrypoints/rootConfig/createConfigSecretEnumerator.d.ts:5:1 - (ae-undocumented) Missing documentation for "createConfigSecretEnumerator". +// src/entrypoints/rootConfig/rootConfigServiceFactory.d.ts:20:5 - (ae-undocumented) Missing documentation for "watch". +// src/entrypoints/rootConfig/rootConfigServiceFactory.d.ts:26:22 - (ae-undocumented) Missing documentation for "rootConfigServiceFactory". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-rootHealth.md b/packages/backend-defaults/api-report-rootHealth.api.md similarity index 71% rename from packages/backend-defaults/api-report-rootHealth.md rename to packages/backend-defaults/api-report-rootHealth.api.md index b26de7cfda..fa09590c26 100644 --- a/packages/backend-defaults/api-report-rootHealth.md +++ b/packages/backend-defaults/api-report-rootHealth.api.md @@ -13,5 +13,9 @@ export const rootHealthServiceFactory: ServiceFactory< 'singleton' >; +// Warnings were encountered during analysis: +// +// src/entrypoints/rootHealth/rootHealthServiceFactory.d.ts:5:22 - (ae-undocumented) Missing documentation for "rootHealthServiceFactory". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-rootHttpRouter.md b/packages/backend-defaults/api-report-rootHttpRouter.api.md similarity index 62% rename from packages/backend-defaults/api-report-rootHttpRouter.md rename to packages/backend-defaults/api-report-rootHttpRouter.api.md index 3686f25a12..672844a98e 100644 --- a/packages/backend-defaults/api-report-rootHttpRouter.md +++ b/packages/backend-defaults/api-report-rootHttpRouter.api.md @@ -154,5 +154,27 @@ export const rootHttpRouterServiceFactory: (( ) => ServiceFactory) & ServiceFactory; +// Warnings were encountered during analysis: +// +// src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:23:5 - (ae-undocumented) Missing documentation for "create". +// src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:25:5 - (ae-undocumented) Missing documentation for "use". +// src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "handler". +// src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". +// src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". +// src/entrypoints/rootHttpRouter/http/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". +// src/entrypoints/rootHttpRouter/http/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "stop". +// src/entrypoints/rootHttpRouter/http/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "port". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:9:1 - (ae-undocumented) Missing documentation for "RootHttpRouterConfigureContext". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:10:5 - (ae-undocumented) Missing documentation for "app". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:11:5 - (ae-undocumented) Missing documentation for "server". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:12:5 - (ae-undocumented) Missing documentation for "middleware". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:13:5 - (ae-undocumented) Missing documentation for "routes". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:16:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:17:5 - (ae-undocumented) Missing documentation for "healthRouter". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:18:5 - (ae-undocumented) Missing documentation for "applyDefaults". +// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:38:22 - (ae-undocumented) Missing documentation for "rootHttpRouterServiceFactory". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-rootLifecycle.md b/packages/backend-defaults/api-report-rootLifecycle.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootLifecycle.md rename to packages/backend-defaults/api-report-rootLifecycle.api.md diff --git a/packages/backend-defaults/api-report-rootLogger.md b/packages/backend-defaults/api-report-rootLogger.api.md similarity index 55% rename from packages/backend-defaults/api-report-rootLogger.md rename to packages/backend-defaults/api-report-rootLogger.api.md index b353039c03..59b6242095 100644 --- a/packages/backend-defaults/api-report-rootLogger.md +++ b/packages/backend-defaults/api-report-rootLogger.api.md @@ -51,5 +51,19 @@ export interface WinstonLoggerOptions { transports?: transport[]; } +// Warnings were encountered during analysis: +// +// src/entrypoints/rootLogger/WinstonLogger.d.ts:8:1 - (ae-undocumented) Missing documentation for "WinstonLoggerOptions". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:9:5 - (ae-undocumented) Missing documentation for "meta". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:10:5 - (ae-undocumented) Missing documentation for "level". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:11:5 - (ae-undocumented) Missing documentation for "format". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:12:5 - (ae-undocumented) Missing documentation for "transports". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:37:5 - (ae-undocumented) Missing documentation for "error". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:38:5 - (ae-undocumented) Missing documentation for "warn". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:39:5 - (ae-undocumented) Missing documentation for "info". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:40:5 - (ae-undocumented) Missing documentation for "debug". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:41:5 - (ae-undocumented) Missing documentation for "child". +// src/entrypoints/rootLogger/WinstonLogger.d.ts:42:5 - (ae-undocumented) Missing documentation for "addRedactions". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-scheduler.md b/packages/backend-defaults/api-report-scheduler.api.md similarity index 81% rename from packages/backend-defaults/api-report-scheduler.md rename to packages/backend-defaults/api-report-scheduler.api.md index 10c0c0a943..351873ad31 100644 --- a/packages/backend-defaults/api-report-scheduler.md +++ b/packages/backend-defaults/api-report-scheduler.api.md @@ -24,5 +24,9 @@ export const schedulerServiceFactory: ServiceFactory< 'singleton' >; +// Warnings were encountered during analysis: +// +// src/entrypoints/scheduler/lib/DefaultSchedulerService.d.ts:8:5 - (ae-undocumented) Missing documentation for "create". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-urlReader.md b/packages/backend-defaults/api-report-urlReader.api.md similarity index 59% rename from packages/backend-defaults/api-report-urlReader.md rename to packages/backend-defaults/api-report-urlReader.api.md index f8b8db2954..029332e12f 100644 --- a/packages/backend-defaults/api-report-urlReader.md +++ b/packages/backend-defaults/api-report-urlReader.api.md @@ -447,5 +447,78 @@ export type UrlReadersOptions = { factories?: ReaderFactory[]; }; +// Warnings were encountered during analysis: +// +// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:27:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:39:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:40:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:41:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:42:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:43:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:13:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:13:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:17:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:13:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:17:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:16:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:23:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:24:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:23:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:24:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:25:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:26:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:27:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:28:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:32:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:33:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:34:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:35:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:36:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:13:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:17:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:24:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:26:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:27:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:28:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:29:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:13:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:17:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:30:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:31:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:34:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:14:5 - (ae-undocumented) Missing documentation for "factory". +// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "read". +// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readUrl". +// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". +// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". +// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "toString". +// src/entrypoints/urlReader/lib/types.d.ts:75:5 - (ae-undocumented) Missing documentation for "fromTarArchive". +// src/entrypoints/urlReader/lib/types.d.ts:82:5 - (ae-undocumented) Missing documentation for "fromZipArchive". +// src/entrypoints/urlReader/lib/types.d.ts:83:5 - (ae-undocumented) Missing documentation for "fromReadableArray". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/api-report-userInfo.md b/packages/backend-defaults/api-report-userInfo.api.md similarity index 100% rename from packages/backend-defaults/api-report-userInfo.md rename to packages/backend-defaults/api-report-userInfo.api.md diff --git a/packages/backend-defaults/api-report.md b/packages/backend-defaults/api-report.api.md similarity index 100% rename from packages/backend-defaults/api-report.md rename to packages/backend-defaults/api-report.api.md diff --git a/packages/backend-dev-utils/api-report.md b/packages/backend-dev-utils/api-report.api.md similarity index 100% rename from packages/backend-dev-utils/api-report.md rename to packages/backend-dev-utils/api-report.api.md diff --git a/packages/backend-dynamic-feature-service/api-report.md b/packages/backend-dynamic-feature-service/api-report.api.md similarity index 57% rename from packages/backend-dynamic-feature-service/api-report.md rename to packages/backend-dynamic-feature-service/api-report.api.md index f6972da50b..5093458a6c 100644 --- a/packages/backend-dynamic-feature-service/api-report.md +++ b/packages/backend-dynamic-feature-service/api-report.api.md @@ -276,5 +276,69 @@ export interface ScannedPluginPackage { manifest: ScannedPluginManifest; } +// Warnings were encountered during analysis: +// +// src/loader/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "ModuleLoader". +// src/loader/types.d.ts:5:5 - (ae-undocumented) Missing documentation for "bootstrap". +// src/loader/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "load". +// src/manager/plugin-manager.d.ts:10:1 - (ae-undocumented) Missing documentation for "DynamicPluginManagerOptions". +// src/manager/plugin-manager.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". +// src/manager/plugin-manager.d.ts:12:5 - (ae-undocumented) Missing documentation for "logger". +// src/manager/plugin-manager.d.ts:13:5 - (ae-undocumented) Missing documentation for "preferAlpha". +// src/manager/plugin-manager.d.ts:14:5 - (ae-undocumented) Missing documentation for "moduleLoader". +// src/manager/plugin-manager.d.ts:19:1 - (ae-undocumented) Missing documentation for "DynamicPluginManager". +// src/manager/plugin-manager.d.ts:23:5 - (ae-undocumented) Missing documentation for "create". +// src/manager/plugin-manager.d.ts:27:5 - (ae-undocumented) Missing documentation for "availablePackages". +// src/manager/plugin-manager.d.ts:28:5 - (ae-undocumented) Missing documentation for "addBackendPlugin". +// src/manager/plugin-manager.d.ts:31:5 - (ae-undocumented) Missing documentation for "backendPlugins". +// src/manager/plugin-manager.d.ts:32:5 - (ae-undocumented) Missing documentation for "frontendPlugins". +// src/manager/plugin-manager.d.ts:33:5 - (ae-undocumented) Missing documentation for "plugins". +// src/manager/plugin-manager.d.ts:38:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceRef". +// src/manager/plugin-manager.d.ts:42:1 - (ae-undocumented) Missing documentation for "DynamicPluginsFactoryOptions". +// src/manager/plugin-manager.d.ts:43:5 - (ae-undocumented) Missing documentation for "moduleLoader". +// src/manager/plugin-manager.d.ts:48:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceFactory". +// src/manager/plugin-manager.d.ts:52:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFeatureDiscoveryServiceFactory". +// src/manager/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "LegacyPluginEnvironment". +// src/manager/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "DynamicPluginProvider". +// src/manager/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "plugins". +// src/manager/types.d.ts:52:1 - (ae-undocumented) Missing documentation for "BackendPluginProvider". +// src/manager/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "backendPlugins". +// src/manager/types.d.ts:58:1 - (ae-undocumented) Missing documentation for "FrontendPluginProvider". +// src/manager/types.d.ts:59:5 - (ae-undocumented) Missing documentation for "frontendPlugins". +// src/manager/types.d.ts:64:1 - (ae-undocumented) Missing documentation for "BaseDynamicPlugin". +// src/manager/types.d.ts:65:5 - (ae-undocumented) Missing documentation for "name". +// src/manager/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "version". +// src/manager/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "role". +// src/manager/types.d.ts:68:5 - (ae-undocumented) Missing documentation for "platform". +// src/manager/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "DynamicPlugin". +// src/manager/types.d.ts:77:1 - (ae-undocumented) Missing documentation for "FrontendDynamicPlugin". +// src/manager/types.d.ts:78:5 - (ae-undocumented) Missing documentation for "platform". +// src/manager/types.d.ts:83:1 - (ae-undocumented) Missing documentation for "BackendDynamicPlugin". +// src/manager/types.d.ts:84:5 - (ae-undocumented) Missing documentation for "platform". +// src/manager/types.d.ts:85:5 - (ae-undocumented) Missing documentation for "installer". +// src/manager/types.d.ts:90:1 - (ae-undocumented) Missing documentation for "BackendDynamicPluginInstaller". +// src/manager/types.d.ts:94:1 - (ae-undocumented) Missing documentation for "NewBackendPluginInstaller". +// src/manager/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "kind". +// src/manager/types.d.ts:96:5 - (ae-undocumented) Missing documentation for "install". +// src/manager/types.d.ts:109:1 - (ae-undocumented) Missing documentation for "LegacyBackendPluginInstaller". +// src/manager/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "kind". +// src/manager/types.d.ts:111:5 - (ae-undocumented) Missing documentation for "router". +// src/manager/types.d.ts:115:5 - (ae-undocumented) Missing documentation for "catalog". +// src/manager/types.d.ts:116:5 - (ae-undocumented) Missing documentation for "scaffolder". +// src/manager/types.d.ts:117:5 - (ae-undocumented) Missing documentation for "search". +// src/manager/types.d.ts:118:5 - (ae-undocumented) Missing documentation for "events". +// src/manager/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "permissions". +// src/manager/types.d.ts:126:1 - (ae-undocumented) Missing documentation for "isBackendDynamicPluginInstaller". +// src/scanner/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScannedPluginPackage". +// src/scanner/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "location". +// src/scanner/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "manifest". +// src/scanner/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "ScannedPluginManifest". +// src/schemas/appBackendModule.d.ts:2:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFrontendSchemas". +// src/schemas/rootLoggerServiceFactory.d.ts:2:22 - (ae-undocumented) Missing documentation for "dynamicPluginsRootLoggerServiceFactory". +// src/schemas/schemas.d.ts:7:1 - (ae-undocumented) Missing documentation for "DynamicPluginsSchemasService". +// src/schemas/schemas.d.ts:8:5 - (ae-undocumented) Missing documentation for "addDynamicPluginsSchemas". +// src/schemas/schemas.d.ts:21:1 - (ae-undocumented) Missing documentation for "DynamicPluginsSchemasOptions". +// src/schemas/schemas.d.ts:36:22 - (ae-undocumented) Missing documentation for "dynamicPluginsSchemasServiceFactory". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-openapi-utils/api-report.md b/packages/backend-openapi-utils/api-report.api.md similarity index 72% rename from packages/backend-openapi-utils/api-report.md rename to packages/backend-openapi-utils/api-report.api.md index 8e702b8c23..a0495f39b5 100644 --- a/packages/backend-openapi-utils/api-report.md +++ b/packages/backend-openapi-utils/api-report.api.md @@ -717,4 +717,84 @@ type ValueOf = T[keyof T]; // @public export const wrapInOpenApiTestServer: (app: Express_2) => Server | Express_2; + +// Warnings were encountered during analysis: +// +// src/router.d.ts:8:5 - (ae-undocumented) Missing documentation for "get". +// src/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "post". +// src/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "all". +// src/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "put". +// src/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "delete". +// src/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "patch". +// src/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "options". +// src/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "head". +// src/types/common.d.ts:14:1 - (ae-undocumented) Missing documentation for "PathDoc". +// src/types/common.d.ts:60:1 - (ae-undocumented) Missing documentation for "DocPathTemplate". +// src/types/common.d.ts:64:1 - (ae-undocumented) Missing documentation for "DocPathMethod". +// src/types/common.d.ts:68:1 - (ae-undocumented) Missing documentation for "DocPathTemplateMethod". +// src/types/common.d.ts:72:1 - (ae-undocumented) Missing documentation for "MethodAwareDocPath". +// src/types/common.d.ts:78:1 - (ae-undocumented) Missing documentation for "DocOperation". +// src/types/common.d.ts:82:1 - (ae-undocumented) Missing documentation for "ComponentTypes". +// src/types/common.d.ts:86:1 - (ae-undocumented) Missing documentation for "ComponentRef". +// src/types/common.d.ts:92:1 - (ae-undocumented) Missing documentation for "SchemaRef". +// src/types/common.d.ts:100:1 - (ae-undocumented) Missing documentation for "ObjectWithContentSchema". +// src/types/common.d.ts:114:1 - (ae-undocumented) Missing documentation for "LastOf". +// src/types/common.d.ts:118:1 - (ae-undocumented) Missing documentation for "Push". +// src/types/common.d.ts:122:1 - (ae-undocumented) Missing documentation for "TuplifyUnion". +// src/types/common.d.ts:126:1 - (ae-undocumented) Missing documentation for "ConvertAll". +// src/types/common.d.ts:134:1 - (ae-undocumented) Missing documentation for "UnknownIfNever". +// src/types/common.d.ts:138:1 - (ae-undocumented) Missing documentation for "ToTypeSafe". +// src/types/common.d.ts:142:1 - (ae-undocumented) Missing documentation for "DiscriminateUnion". +// src/types/common.d.ts:146:1 - (ae-undocumented) Missing documentation for "MapDiscriminatedUnion". +// src/types/common.d.ts:152:1 - (ae-undocumented) Missing documentation for "PickOptionalKeys". +// src/types/common.d.ts:160:1 - (ae-undocumented) Missing documentation for "PickRequiredKeys". +// src/types/common.d.ts:168:1 - (ae-undocumented) Missing documentation for "OptionalMap". +// src/types/common.d.ts:176:1 - (ae-undocumented) Missing documentation for "RequiredMap". +// src/types/common.d.ts:184:1 - (ae-undocumented) Missing documentation for "FullMap". +// src/types/common.d.ts:190:1 - (ae-undocumented) Missing documentation for "Filter". +// src/types/express.d.ts:21:5 - (ae-undocumented) Missing documentation for "__call". +// src/types/express.d.ts:22:5 - (ae-undocumented) Missing documentation for "__call". +// src/types/immutable.d.ts:18:1 - (ae-undocumented) Missing documentation for "ImmutableObject". +// src/types/immutable.d.ts:24:1 - (ae-undocumented) Missing documentation for "ImmutableReferenceObject". +// src/types/immutable.d.ts:28:1 - (ae-undocumented) Missing documentation for "ImmutableOpenAPIObject". +// src/types/immutable.d.ts:32:1 - (ae-undocumented) Missing documentation for "ImmutableContentObject". +// src/types/immutable.d.ts:36:1 - (ae-undocumented) Missing documentation for "ImmutableRequestBodyObject". +// src/types/immutable.d.ts:40:1 - (ae-undocumented) Missing documentation for "ImmutableResponseObject". +// src/types/immutable.d.ts:44:1 - (ae-undocumented) Missing documentation for "ImmutableParameterObject". +// src/types/immutable.d.ts:48:1 - (ae-undocumented) Missing documentation for "HeaderObject". +// src/types/immutable.d.ts:49:5 - (ae-undocumented) Missing documentation for "in". +// src/types/immutable.d.ts:50:5 - (ae-undocumented) Missing documentation for "style". +// src/types/immutable.d.ts:55:1 - (ae-undocumented) Missing documentation for "ImmutableHeaderObject". +// src/types/immutable.d.ts:59:1 - (ae-undocumented) Missing documentation for "CookieObject". +// src/types/immutable.d.ts:60:5 - (ae-undocumented) Missing documentation for "in". +// src/types/immutable.d.ts:61:5 - (ae-undocumented) Missing documentation for "style". +// src/types/immutable.d.ts:66:1 - (ae-undocumented) Missing documentation for "ImmutableCookieObject". +// src/types/immutable.d.ts:70:1 - (ae-undocumented) Missing documentation for "QueryObject". +// src/types/immutable.d.ts:71:5 - (ae-undocumented) Missing documentation for "in". +// src/types/immutable.d.ts:72:5 - (ae-undocumented) Missing documentation for "style". +// src/types/immutable.d.ts:77:1 - (ae-undocumented) Missing documentation for "ImmutableQueryObject". +// src/types/immutable.d.ts:81:1 - (ae-undocumented) Missing documentation for "PathObject". +// src/types/immutable.d.ts:82:5 - (ae-undocumented) Missing documentation for "in". +// src/types/immutable.d.ts:83:5 - (ae-undocumented) Missing documentation for "style". +// src/types/immutable.d.ts:88:1 - (ae-undocumented) Missing documentation for "ImmutablePathObject". +// src/types/immutable.d.ts:92:1 - (ae-undocumented) Missing documentation for "ImmutableSchemaObject". +// src/types/params.d.ts:7:1 - (ae-undocumented) Missing documentation for "DocParameter". +// src/types/params.d.ts:16:1 - (ae-undocumented) Missing documentation for "DocParameters". +// src/types/params.d.ts:22:1 - (ae-undocumented) Missing documentation for "ParameterSchema". +// src/types/params.d.ts:26:1 - (ae-undocumented) Missing documentation for "MapToSchema". +// src/types/params.d.ts:32:1 - (ae-undocumented) Missing documentation for "ParametersSchema". +// src/types/params.d.ts:36:1 - (ae-undocumented) Missing documentation for "HeaderSchema". +// src/types/params.d.ts:40:1 - (ae-undocumented) Missing documentation for "CookieSchema". +// src/types/params.d.ts:44:1 - (ae-undocumented) Missing documentation for "PathSchema". +// src/types/params.d.ts:48:1 - (ae-undocumented) Missing documentation for "QuerySchema". +// src/types/requests.d.ts:9:1 - (ae-undocumented) Missing documentation for "RequestBody". +// src/types/requests.d.ts:13:1 - (ae-undocumented) Missing documentation for "RequestBodySchema". +// src/types/responses.d.ts:9:1 - (ae-undocumented) Missing documentation for "Response". +// src/types/responses.d.ts:13:1 - (ae-undocumented) Missing documentation for "ResponseSchemas". +// src/utility.d.ts:5:1 - (ae-undocumented) Missing documentation for "Response". +// src/utility.d.ts:9:1 - (ae-undocumented) Missing documentation for "Request". +// src/utility.d.ts:13:1 - (ae-undocumented) Missing documentation for "HeaderParameters". +// src/utility.d.ts:17:1 - (ae-undocumented) Missing documentation for "CookieParameters". +// src/utility.d.ts:21:1 - (ae-undocumented) Missing documentation for "PathParameters". +// src/utility.d.ts:25:1 - (ae-undocumented) Missing documentation for "QueryParameters". ``` diff --git a/packages/backend-plugin-api/api-report-alpha.md b/packages/backend-plugin-api/api-report-alpha.api.md similarity index 73% rename from packages/backend-plugin-api/api-report-alpha.md rename to packages/backend-plugin-api/api-report-alpha.api.md index dea357502e..29c74e7ade 100644 --- a/packages/backend-plugin-api/api-report-alpha.md +++ b/packages/backend-plugin-api/api-report-alpha.api.md @@ -21,5 +21,10 @@ export const featureDiscoveryServiceRef: ServiceRef< 'singleton' >; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:1 - (ae-undocumented) Missing documentation for "FeatureDiscoveryService". +// src/alpha.d.ts:4:5 - (ae-undocumented) Missing documentation for "getBackendFeatures". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-plugin-api/api-report-testUtils.md b/packages/backend-plugin-api/api-report-testUtils.api.md similarity index 70% rename from packages/backend-plugin-api/api-report-testUtils.md rename to packages/backend-plugin-api/api-report-testUtils.api.md index 8c9bba8398..8f2f871e90 100644 --- a/packages/backend-plugin-api/api-report-testUtils.md +++ b/packages/backend-plugin-api/api-report-testUtils.api.md @@ -22,5 +22,10 @@ export interface PackagePathResolutionOverride { restore(): void; } +// Warnings were encountered during analysis: +// +// src/testUtils.d.ts:2:1 - (ae-undocumented) Missing documentation for "PackagePathResolutionOverride". +// src/testUtils.d.ts:7:1 - (ae-undocumented) Missing documentation for "OverridePackagePathResolutionOptions". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.api.md similarity index 75% rename from packages/backend-plugin-api/api-report.md rename to packages/backend-plugin-api/api-report.api.md index 89dfe40dd9..7cd89364d0 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.api.md @@ -735,4 +735,65 @@ export type UrlReaderServiceSearchResponseFile = { export interface UserInfoService { getUserInfo(credentials: BackstageCredentials): Promise; } + +// Warnings were encountered during analysis: +// +// src/deprecated.d.ts:6:1 - (ae-undocumented) Missing documentation for "ServiceRefConfig". +// src/deprecated.d.ts:11:1 - (ae-undocumented) Missing documentation for "RootServiceFactoryConfig". +// src/deprecated.d.ts:18:1 - (ae-undocumented) Missing documentation for "PluginServiceFactoryConfig". +// src/services/definitions/HttpRouterService.d.ts:8:5 - (ae-undocumented) Missing documentation for "path". +// src/services/definitions/HttpRouterService.d.ts:9:5 - (ae-undocumented) Missing documentation for "allow". +// src/services/definitions/LifecycleService.d.ts:5:1 - (ae-undocumented) Missing documentation for "LifecycleServiceStartupHook". +// src/services/definitions/LifecycleService.d.ts:9:1 - (ae-undocumented) Missing documentation for "LifecycleServiceStartupOptions". +// src/services/definitions/LifecycleService.d.ts:18:1 - (ae-undocumented) Missing documentation for "LifecycleServiceShutdownHook". +// src/services/definitions/LifecycleService.d.ts:22:1 - (ae-undocumented) Missing documentation for "LifecycleServiceShutdownOptions". +// src/services/definitions/LoggerService.d.ts:10:5 - (ae-undocumented) Missing documentation for "error". +// src/services/definitions/LoggerService.d.ts:11:5 - (ae-undocumented) Missing documentation for "warn". +// src/services/definitions/LoggerService.d.ts:12:5 - (ae-undocumented) Missing documentation for "info". +// src/services/definitions/LoggerService.d.ts:13:5 - (ae-undocumented) Missing documentation for "debug". +// src/services/definitions/LoggerService.d.ts:14:5 - (ae-undocumented) Missing documentation for "child". +// src/services/definitions/PermissionsService.d.ts:9:5 - (ae-undocumented) Missing documentation for "credentials". +// src/services/definitions/RootHealthService.d.ts:5:1 - (ae-undocumented) Missing documentation for "RootHealthService". +// src/services/definitions/UrlReaderService.d.ts:323:1 - (ae-undocumented) Missing documentation for "ReadTreeOptions". +// src/services/definitions/UrlReaderService.d.ts:328:1 - (ae-undocumented) Missing documentation for "ReadTreeResponse". +// src/services/definitions/UrlReaderService.d.ts:333:1 - (ae-undocumented) Missing documentation for "ReadTreeResponseDirOptions". +// src/services/definitions/UrlReaderService.d.ts:338:1 - (ae-undocumented) Missing documentation for "ReadTreeResponseFile". +// src/services/definitions/UrlReaderService.d.ts:343:1 - (ae-undocumented) Missing documentation for "ReadUrlResponse". +// src/services/definitions/UrlReaderService.d.ts:348:1 - (ae-undocumented) Missing documentation for "ReadUrlOptions". +// src/services/definitions/UrlReaderService.d.ts:353:1 - (ae-undocumented) Missing documentation for "SearchOptions". +// src/services/definitions/UrlReaderService.d.ts:358:1 - (ae-undocumented) Missing documentation for "SearchResponse". +// src/services/definitions/UrlReaderService.d.ts:363:1 - (ae-undocumented) Missing documentation for "SearchResponseFile". +// src/services/definitions/UserInfoService.d.ts:9:5 - (ae-undocumented) Missing documentation for "userEntityRef". +// src/services/definitions/UserInfoService.d.ts:10:5 - (ae-undocumented) Missing documentation for "ownershipEntityRefs". +// src/services/system/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "ServiceFactory". +// src/services/system/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "service". +// src/services/system/types.d.ts:34:1 - (ae-undocumented) Missing documentation for "ServiceFactoryCompat". +// src/services/system/types.d.ts:38:5 - (ae-undocumented) Missing documentation for "__call". +// src/services/system/types.d.ts:48:1 - (ae-undocumented) Missing documentation for "ServiceRefOptions". +// src/services/system/types.d.ts:49:5 - (ae-undocumented) Missing documentation for "id". +// src/services/system/types.d.ts:50:5 - (ae-undocumented) Missing documentation for "scope". +// src/services/system/types.d.ts:51:5 - (ae-undocumented) Missing documentation for "defaultFactory". +// src/services/system/types.d.ts:55:5 - (ae-undocumented) Missing documentation for "defaultFactory". +// src/services/system/types.d.ts:76:1 - (ae-undocumented) Missing documentation for "RootServiceFactoryOptions". +// src/services/system/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "service". +// src/services/system/types.d.ts:91:5 - (ae-undocumented) Missing documentation for "deps". +// src/services/system/types.d.ts:92:5 - (ae-undocumented) Missing documentation for "factory". +// src/services/system/types.d.ts:95:1 - (ae-undocumented) Missing documentation for "PluginServiceFactoryOptions". +// src/services/system/types.d.ts:109:5 - (ae-undocumented) Missing documentation for "service". +// src/services/system/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "deps". +// src/services/system/types.d.ts:111:5 - (ae-undocumented) Missing documentation for "createRootContext". +// src/services/system/types.d.ts:112:5 - (ae-undocumented) Missing documentation for "factory". +// src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BackendFeature". +// src/types.d.ts:3:5 - (ae-undocumented) Missing documentation for "$$type". +// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "BackendFeatureCompat". +// src/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "__call". +// src/wiring/factories.d.ts:39:5 - (ae-undocumented) Missing documentation for "register". +// src/wiring/factories.d.ts:67:5 - (ae-undocumented) Missing documentation for "register". +// src/wiring/index.d.ts:9:1 - (ae-undocumented) Missing documentation for "BackendPluginConfig". +// src/wiring/index.d.ts:14:1 - (ae-undocumented) Missing documentation for "BackendModuleConfig". +// src/wiring/index.d.ts:19:1 - (ae-undocumented) Missing documentation for "ExtensionPointConfig". +// src/wiring/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". +// src/wiring/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "registerInit". +// src/wiring/types.d.ts:39:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". +// src/wiring/types.d.ts:40:5 - (ae-undocumented) Missing documentation for "registerInit". ``` diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.api.md similarity index 62% rename from packages/backend-test-utils/api-report.md rename to packages/backend-test-utils/api-report.api.md index 2bea998596..1234297c2e 100644 --- a/packages/backend-test-utils/api-report.md +++ b/packages/backend-test-utils/api-report.api.md @@ -474,4 +474,95 @@ export class TestDatabases { // (undocumented) supports(id: TestDatabaseId): boolean; } + +// Warnings were encountered during analysis: +// +// src/cache/TestCaches.d.ts:27:5 - (ae-undocumented) Missing documentation for "setDefaults". +// src/cache/TestCaches.d.ts:31:5 - (ae-undocumented) Missing documentation for "supports". +// src/cache/TestCaches.d.ts:32:5 - (ae-undocumented) Missing documentation for "eachSupportedId". +// src/database/TestDatabases.d.ts:29:5 - (ae-undocumented) Missing documentation for "setDefaults". +// src/database/TestDatabases.d.ts:33:5 - (ae-undocumented) Missing documentation for "supports". +// src/database/TestDatabases.d.ts:34:5 - (ae-undocumented) Missing documentation for "eachSupportedId". +// src/deprecated.d.ts:6:1 - (ae-undocumented) Missing documentation for "MockDirectoryOptions". +// src/deprecated.d.ts:11:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". +// src/deprecated.d.ts:20:1 - (ae-undocumented) Missing documentation for "isDockerDisabledForTests". +// src/next/services/mockCredentials.d.ts:17:1 - (ae-undocumented) Missing documentation for "mockCredentials". +// src/next/services/mockCredentials.d.ts:58:9 - (ae-undocumented) Missing documentation for "invalidToken". +// src/next/services/mockCredentials.d.ts:59:9 - (ae-undocumented) Missing documentation for "invalidHeader". +// src/next/services/mockCredentials.d.ts:84:9 - (ae-undocumented) Missing documentation for "invalidToken". +// src/next/services/mockCredentials.d.ts:85:9 - (ae-undocumented) Missing documentation for "invalidCookie". +// src/next/services/mockCredentials.d.ts:116:9 - (ae-undocumented) Missing documentation for "invalidToken". +// src/next/services/mockCredentials.d.ts:117:9 - (ae-undocumented) Missing documentation for "invalidHeader". +// src/next/services/mockServices.d.ts:5:1 - (ae-undocumented) Missing documentation for "ServiceMock". +// src/next/services/mockServices.d.ts:13:1 - (ae-undocumented) Missing documentation for "mockServices". +// src/next/services/mockServices.d.ts:14:5 - (ae-undocumented) Missing documentation for "rootConfig". +// src/next/services/mockServices.d.ts:15:5 - (ae-undocumented) Missing documentation for "rootConfig". +// src/next/services/mockServices.d.ts:16:9 - (ae-undocumented) Missing documentation for "Options". +// src/next/services/mockServices.d.ts:19:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:21:5 - (ae-undocumented) Missing documentation for "rootLogger". +// src/next/services/mockServices.d.ts:22:5 - (ae-undocumented) Missing documentation for "rootLogger". +// src/next/services/mockServices.d.ts:23:9 - (ae-undocumented) Missing documentation for "Options". +// src/next/services/mockServices.d.ts:26:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:27:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:29:5 - (ae-undocumented) Missing documentation for "tokenManager". +// src/next/services/mockServices.d.ts:30:5 - (ae-undocumented) Missing documentation for "tokenManager". +// src/next/services/mockServices.d.ts:31:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:32:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:34:5 - (ae-undocumented) Missing documentation for "identity". +// src/next/services/mockServices.d.ts:35:5 - (ae-undocumented) Missing documentation for "identity". +// src/next/services/mockServices.d.ts:36:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:37:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:39:5 - (ae-undocumented) Missing documentation for "auth". +// src/next/services/mockServices.d.ts:43:5 - (ae-undocumented) Missing documentation for "auth". +// src/next/services/mockServices.d.ts:44:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:45:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:47:5 - (ae-undocumented) Missing documentation for "discovery". +// src/next/services/mockServices.d.ts:48:5 - (ae-undocumented) Missing documentation for "discovery". +// src/next/services/mockServices.d.ts:49:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:50:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:70:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/next/services/mockServices.d.ts:81:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:91:5 - (ae-undocumented) Missing documentation for "userInfo". +// src/next/services/mockServices.d.ts:99:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:101:5 - (ae-undocumented) Missing documentation for "cache". +// src/next/services/mockServices.d.ts:102:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:103:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:105:5 - (ae-undocumented) Missing documentation for "database". +// src/next/services/mockServices.d.ts:106:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:107:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:109:5 - (ae-undocumented) Missing documentation for "rootHealth". +// src/next/services/mockServices.d.ts:110:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:111:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:113:5 - (ae-undocumented) Missing documentation for "httpRouter". +// src/next/services/mockServices.d.ts:114:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:115:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:117:5 - (ae-undocumented) Missing documentation for "rootHttpRouter". +// src/next/services/mockServices.d.ts:118:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:119:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:121:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/next/services/mockServices.d.ts:122:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:123:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:125:5 - (ae-undocumented) Missing documentation for "logger". +// src/next/services/mockServices.d.ts:126:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:127:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:129:5 - (ae-undocumented) Missing documentation for "permissions". +// src/next/services/mockServices.d.ts:130:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:131:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:133:5 - (ae-undocumented) Missing documentation for "rootLifecycle". +// src/next/services/mockServices.d.ts:134:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:135:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:137:5 - (ae-undocumented) Missing documentation for "scheduler". +// src/next/services/mockServices.d.ts:138:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:139:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:141:5 - (ae-undocumented) Missing documentation for "urlReader". +// src/next/services/mockServices.d.ts:142:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:143:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:145:5 - (ae-undocumented) Missing documentation for "events". +// src/next/services/mockServices.d.ts:146:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:147:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/wiring/TestBackend.d.ts:4:1 - (ae-undocumented) Missing documentation for "TestBackendOptions". +// src/next/wiring/TestBackend.d.ts:5:5 - (ae-undocumented) Missing documentation for "extensionPoints". +// src/next/wiring/TestBackend.d.ts:13:5 - (ae-undocumented) Missing documentation for "features". +// src/next/wiring/TestBackend.d.ts:18:1 - (ae-undocumented) Missing documentation for "TestBackend". +// src/next/wiring/TestBackend.d.ts:29:1 - (ae-undocumented) Missing documentation for "startTestBackend". ``` diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.api.md similarity index 92% rename from packages/catalog-client/api-report.md rename to packages/catalog-client/api-report.api.md index 203028edce..aba99961f0 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.api.md @@ -302,4 +302,13 @@ export type ValidateEntityResponse = valid: false; errors: SerializedError[]; }; + +// Warnings were encountered during analysis: +// +// src/CatalogClient.d.ts:50:5 - (ae-undocumented) Missing documentation for "getEntityByName". +// src/types/api.d.ts:154:5 - (ae-undocumented) Missing documentation for "items". +// src/types/api.d.ts:203:5 - (ae-undocumented) Missing documentation for "entityRef". +// src/types/api.d.ts:211:5 - (ae-undocumented) Missing documentation for "rootEntityRef". +// src/types/api.d.ts:212:5 - (ae-undocumented) Missing documentation for "items". +// src/types/api.d.ts:305:5 - (ae-undocumented) Missing documentation for "token". ``` diff --git a/packages/catalog-model/api-report-alpha.md b/packages/catalog-model/api-report-alpha.api.md similarity index 100% rename from packages/catalog-model/api-report-alpha.md rename to packages/catalog-model/api-report-alpha.api.md diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.api.md similarity index 70% rename from packages/catalog-model/api-report.md rename to packages/catalog-model/api-report.api.md index ec03ce41e1..07dc6affd7 100644 --- a/packages/catalog-model/api-report.md +++ b/packages/catalog-model/api-report.api.md @@ -499,4 +499,52 @@ export type Validators = { isValidAnnotationValue(value: unknown): boolean; isValidTag(value: unknown): boolean; }; + +// Warnings were encountered during analysis: +// +// src/entity/conditions.d.ts:6:1 - (ae-undocumented) Missing documentation for "isApiEntity". +// src/entity/conditions.d.ts:10:1 - (ae-undocumented) Missing documentation for "isComponentEntity". +// src/entity/conditions.d.ts:14:1 - (ae-undocumented) Missing documentation for "isDomainEntity". +// src/entity/conditions.d.ts:18:1 - (ae-undocumented) Missing documentation for "isGroupEntity". +// src/entity/conditions.d.ts:22:1 - (ae-undocumented) Missing documentation for "isLocationEntity". +// src/entity/conditions.d.ts:26:1 - (ae-undocumented) Missing documentation for "isResourceEntity". +// src/entity/conditions.d.ts:30:1 - (ae-undocumented) Missing documentation for "isSystemEntity". +// src/entity/conditions.d.ts:34:1 - (ae-undocumented) Missing documentation for "isUserEntity". +// src/entity/policies/DefaultNamespaceEntityPolicy.d.ts:11:5 - (ae-undocumented) Missing documentation for "enforce". +// src/entity/policies/FieldFormatEntityPolicy.d.ts:17:5 - (ae-undocumented) Missing documentation for "enforce". +// src/entity/policies/GroupDefaultParentEntityPolicy.d.ts:14:5 - (ae-undocumented) Missing documentation for "enforce". +// src/entity/policies/NoForeignRootFieldsEntityPolicy.d.ts:11:5 - (ae-undocumented) Missing documentation for "enforce". +// src/entity/policies/SchemaValidEntityPolicy.d.ts:16:5 - (ae-undocumented) Missing documentation for "enforce". +// src/kinds/ApiEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/ApiEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/ApiEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/ComponentEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/ComponentEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/ComponentEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/DomainEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/DomainEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/DomainEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/GroupEntityV1alpha1.d.ts:8:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/GroupEntityV1alpha1.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/GroupEntityV1alpha1.d.ts:10:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/LocationEntityV1alpha1.d.ts:8:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/LocationEntityV1alpha1.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/LocationEntityV1alpha1.d.ts:10:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/ResourceEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/ResourceEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/ResourceEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/SystemEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/SystemEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/SystemEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". +// src/kinds/UserEntityV1alpha1.d.ts:8:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/kinds/UserEntityV1alpha1.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". +// src/kinds/UserEntityV1alpha1.d.ts:10:5 - (ae-undocumented) Missing documentation for "spec". +// src/validation/KubernetesValidatorFunctions.d.ts:11:5 - (ae-undocumented) Missing documentation for "isValidApiVersion". +// src/validation/KubernetesValidatorFunctions.d.ts:12:5 - (ae-undocumented) Missing documentation for "isValidKind". +// src/validation/KubernetesValidatorFunctions.d.ts:13:5 - (ae-undocumented) Missing documentation for "isValidObjectName". +// src/validation/KubernetesValidatorFunctions.d.ts:14:5 - (ae-undocumented) Missing documentation for "isValidNamespace". +// src/validation/KubernetesValidatorFunctions.d.ts:15:5 - (ae-undocumented) Missing documentation for "isValidLabelKey". +// src/validation/KubernetesValidatorFunctions.d.ts:16:5 - (ae-undocumented) Missing documentation for "isValidLabelValue". +// src/validation/KubernetesValidatorFunctions.d.ts:17:5 - (ae-undocumented) Missing documentation for "isValidAnnotationKey". +// src/validation/KubernetesValidatorFunctions.d.ts:18:5 - (ae-undocumented) Missing documentation for "isValidAnnotationValue". ``` diff --git a/packages/cli-common/api-report.md b/packages/cli-common/api-report.api.md similarity index 100% rename from packages/cli-common/api-report.md rename to packages/cli-common/api-report.api.md diff --git a/packages/cli-node/api-report.md b/packages/cli-node/api-report.api.md similarity index 67% rename from packages/cli-node/api-report.md rename to packages/cli-node/api-report.api.md index f22583dd25..8a0b9bc6df 100644 --- a/packages/cli-node/api-report.md +++ b/packages/cli-node/api-report.api.md @@ -175,4 +175,28 @@ export class PackageRoles { static getRoleFromPackage(pkgJson: unknown): PackageRole | undefined; static getRoleInfo(role: string): PackageRoleInfo; } + +// Warnings were encountered during analysis: +// +// src/monorepo/PackageGraph.d.ts:10:5 - (ae-undocumented) Missing documentation for "name". +// src/monorepo/PackageGraph.d.ts:11:5 - (ae-undocumented) Missing documentation for "version". +// src/monorepo/PackageGraph.d.ts:12:5 - (ae-undocumented) Missing documentation for "private". +// src/monorepo/PackageGraph.d.ts:13:5 - (ae-undocumented) Missing documentation for "main". +// src/monorepo/PackageGraph.d.ts:14:5 - (ae-undocumented) Missing documentation for "module". +// src/monorepo/PackageGraph.d.ts:15:5 - (ae-undocumented) Missing documentation for "types". +// src/monorepo/PackageGraph.d.ts:16:5 - (ae-undocumented) Missing documentation for "scripts". +// src/monorepo/PackageGraph.d.ts:19:5 - (ae-undocumented) Missing documentation for "bundled". +// src/monorepo/PackageGraph.d.ts:20:5 - (ae-undocumented) Missing documentation for "backstage". +// src/monorepo/PackageGraph.d.ts:36:5 - (ae-undocumented) Missing documentation for "exports". +// src/monorepo/PackageGraph.d.ts:37:5 - (ae-undocumented) Missing documentation for "typesVersions". +// src/monorepo/PackageGraph.d.ts:38:5 - (ae-undocumented) Missing documentation for "files". +// src/monorepo/PackageGraph.d.ts:39:5 - (ae-undocumented) Missing documentation for "publishConfig". +// src/monorepo/PackageGraph.d.ts:44:5 - (ae-undocumented) Missing documentation for "repository". +// src/monorepo/PackageGraph.d.ts:49:5 - (ae-undocumented) Missing documentation for "dependencies". +// src/monorepo/PackageGraph.d.ts:52:5 - (ae-undocumented) Missing documentation for "peerDependencies". +// src/monorepo/PackageGraph.d.ts:55:5 - (ae-undocumented) Missing documentation for "devDependencies". +// src/monorepo/PackageGraph.d.ts:58:5 - (ae-undocumented) Missing documentation for "optionalDependencies". +// src/roles/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "role". +// src/roles/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "platform". +// src/roles/types.d.ts:27:5 - (ae-undocumented) Missing documentation for "output". ``` diff --git a/packages/config-loader/api-report.md b/packages/config-loader/api-report.api.md similarity index 72% rename from packages/config-loader/api-report.md rename to packages/config-loader/api-report.api.md index e2741d609c..42b6dcab96 100644 --- a/packages/config-loader/api-report.md +++ b/packages/config-loader/api-report.api.md @@ -284,4 +284,32 @@ export type TransformFunc = ( path: string; }, ) => T | undefined; + +// Warnings were encountered during analysis: +// +// src/loader.d.ts:6:1 - (ae-undocumented) Missing documentation for "ConfigTarget". +// src/loader.d.ts:15:1 - (ae-undocumented) Missing documentation for "LoadConfigOptionsWatch". +// src/loader.d.ts:29:1 - (ae-undocumented) Missing documentation for "LoadConfigOptionsRemote". +// src/sources/ConfigSources.d.ts:42:5 - (ae-undocumented) Missing documentation for "watch". +// src/sources/ConfigSources.d.ts:43:5 - (ae-undocumented) Missing documentation for "rootDir". +// src/sources/ConfigSources.d.ts:44:5 - (ae-undocumented) Missing documentation for "remote". +// src/sources/ConfigSources.d.ts:60:5 - (ae-undocumented) Missing documentation for "targets". +// src/sources/ConfigSources.d.ts:68:5 - (ae-undocumented) Missing documentation for "argv". +// src/sources/ConfigSources.d.ts:69:5 - (ae-undocumented) Missing documentation for "env". +// src/sources/EnvConfigSource.d.ts:46:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/EnvConfigSource.d.ts:47:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/FileConfigSource.d.ts:40:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/FileConfigSource.d.ts:41:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/MutableConfigSource.d.ts:9:5 - (ae-undocumented) Missing documentation for "data". +// src/sources/MutableConfigSource.d.ts:10:5 - (ae-undocumented) Missing documentation for "context". +// src/sources/MutableConfigSource.d.ts:27:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/MutableConfigSource.d.ts:38:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/RemoteConfigSource.d.ts:39:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/RemoteConfigSource.d.ts:40:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/StaticConfigSource.d.ts:9:5 - (ae-undocumented) Missing documentation for "data". +// src/sources/StaticConfigSource.d.ts:10:5 - (ae-undocumented) Missing documentation for "context". +// src/sources/StaticConfigSource.d.ts:28:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/StaticConfigSource.d.ts:29:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "signal". +// src/sources/types.d.ts:54:5 - (ae-undocumented) Missing documentation for "readConfigData". ``` diff --git a/packages/config/api-report.md b/packages/config/api-report.api.md similarity index 100% rename from packages/config/api-report.md rename to packages/config/api-report.api.md diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.api.md similarity index 70% rename from packages/core-app-api/api-report.md rename to packages/core-app-api/api-report.api.md index 3d2c44a148..a326555cc1 100644 --- a/packages/core-app-api/api-report.md +++ b/packages/core-app-api/api-report.api.md @@ -683,4 +683,70 @@ export class WebStorage implements StorageApi { // (undocumented) snapshot(key: string): StorageValueSnapshot; } + +// Warnings were encountered during analysis: +// +// src/apis/implementations/AlertApi/AlertApiForwarder.d.ts:10:5 - (ae-undocumented) Missing documentation for "post". +// src/apis/implementations/AlertApi/AlertApiForwarder.d.ts:11:5 - (ae-undocumented) Missing documentation for "alert$". +// src/apis/implementations/AnalyticsApi/NoOpAnalyticsApi.d.ts:8:5 - (ae-undocumented) Missing documentation for "captureEvent". +// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:11:5 - (ae-undocumented) Missing documentation for "createWithStorage". +// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:15:5 - (ae-undocumented) Missing documentation for "getInstalledThemes". +// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:16:5 - (ae-undocumented) Missing documentation for "activeThemeId$". +// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:17:5 - (ae-undocumented) Missing documentation for "getActiveThemeId". +// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:18:5 - (ae-undocumented) Missing documentation for "setActiveThemeId". +// src/apis/implementations/DiscoveryApi/FrontendHostDiscovery.d.ts:37:5 - (ae-undocumented) Missing documentation for "getBaseUrl". +// src/apis/implementations/DiscoveryApi/UrlPatternDiscovery.d.ts:19:5 - (ae-undocumented) Missing documentation for "getBaseUrl". +// src/apis/implementations/ErrorApi/ErrorAlerter.d.ts:12:5 - (ae-undocumented) Missing documentation for "post". +// src/apis/implementations/ErrorApi/ErrorAlerter.d.ts:13:5 - (ae-undocumented) Missing documentation for "error$". +// src/apis/implementations/ErrorApi/ErrorApiForwarder.d.ts:10:5 - (ae-undocumented) Missing documentation for "post". +// src/apis/implementations/ErrorApi/ErrorApiForwarder.d.ts:11:5 - (ae-undocumented) Missing documentation for "error$". +// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:12:5 - (ae-undocumented) Missing documentation for "registerFlag". +// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:13:5 - (ae-undocumented) Missing documentation for "getRegisteredFlags". +// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:14:5 - (ae-undocumented) Missing documentation for "isActive". +// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:15:5 - (ae-undocumented) Missing documentation for "save". +// src/apis/implementations/OAuthRequestApi/OAuthRequestManager.d.ts:16:5 - (ae-undocumented) Missing documentation for "createAuthRequester". +// src/apis/implementations/OAuthRequestApi/OAuthRequestManager.d.ts:18:5 - (ae-undocumented) Missing documentation for "authRequest$". +// src/apis/implementations/StorageApi/WebStorage.d.ts:14:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/StorageApi/WebStorage.d.ts:19:5 - (ae-undocumented) Missing documentation for "get". +// src/apis/implementations/StorageApi/WebStorage.d.ts:20:5 - (ae-undocumented) Missing documentation for "snapshot". +// src/apis/implementations/StorageApi/WebStorage.d.ts:21:5 - (ae-undocumented) Missing documentation for "forBucket". +// src/apis/implementations/StorageApi/WebStorage.d.ts:22:5 - (ae-undocumented) Missing documentation for "set". +// src/apis/implementations/StorageApi/WebStorage.d.ts:23:5 - (ae-undocumented) Missing documentation for "remove". +// src/apis/implementations/StorageApi/WebStorage.d.ts:24:5 - (ae-undocumented) Missing documentation for "observe$". +// src/apis/implementations/auth/atlassian/AtlassianAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/bitbucket/BitbucketAuth.d.ts:18:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.d.ts:17:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/github/GithubAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/gitlab/GitlabAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/google/GoogleAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:17:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:22:5 - (ae-undocumented) Missing documentation for "getAccessToken". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:23:5 - (ae-undocumented) Missing documentation for "getIdToken". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:24:5 - (ae-undocumented) Missing documentation for "getProfile". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:25:5 - (ae-undocumented) Missing documentation for "getBackstageIdentity". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:26:5 - (ae-undocumented) Missing documentation for "signIn". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:27:5 - (ae-undocumented) Missing documentation for "signOut". +// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:28:5 - (ae-undocumented) Missing documentation for "sessionState$". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:33:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:37:5 - (ae-undocumented) Missing documentation for "signIn". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:38:5 - (ae-undocumented) Missing documentation for "signOut". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:39:5 - (ae-undocumented) Missing documentation for "sessionState$". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:40:5 - (ae-undocumented) Missing documentation for "getAccessToken". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:41:5 - (ae-undocumented) Missing documentation for "getIdToken". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:42:5 - (ae-undocumented) Missing documentation for "getBackstageIdentity". +// src/apis/implementations/auth/oauth2/OAuth2.d.ts:43:5 - (ae-undocumented) Missing documentation for "getProfile". +// src/apis/implementations/auth/okta/OktaAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/onelogin/OneLoginAuth.d.ts:19:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/saml/SamlAuth.d.ts:15:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/implementations/auth/saml/SamlAuth.d.ts:16:5 - (ae-undocumented) Missing documentation for "sessionState$". +// src/apis/implementations/auth/saml/SamlAuth.d.ts:18:5 - (ae-undocumented) Missing documentation for "signIn". +// src/apis/implementations/auth/saml/SamlAuth.d.ts:19:5 - (ae-undocumented) Missing documentation for "signOut". +// src/apis/implementations/auth/saml/SamlAuth.d.ts:20:5 - (ae-undocumented) Missing documentation for "getBackstageIdentity". +// src/apis/implementations/auth/saml/SamlAuth.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProfile". +// src/apis/implementations/auth/vmwareCloud/VMwareCloudAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/system/ApiFactoryRegistry.d.ts:29:5 - (ae-undocumented) Missing documentation for "get". +// src/apis/system/ApiFactoryRegistry.d.ts:32:5 - (ae-undocumented) Missing documentation for "getAllApis". +// src/apis/system/ApiResolver.d.ts:18:5 - (ae-undocumented) Missing documentation for "get". +// src/apis/system/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ApiFactoryHolder". +// src/app/AppRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "children". ``` diff --git a/packages/core-compat-api/api-report.md b/packages/core-compat-api/api-report.api.md similarity index 93% rename from packages/core-compat-api/api-report.md rename to packages/core-compat-api/api-report.api.md index ddb3bc6bf4..6d1390fd2f 100644 --- a/packages/core-compat-api/api-report.md +++ b/packages/core-compat-api/api-report.api.md @@ -113,5 +113,10 @@ export type ToNewRouteRef = ? ExternalRouteRef_2 : never; +// Warnings were encountered during analysis: +// +// src/apis/implementations/AnalyticsApi/NoOpAnalyticsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "captureEvent". +// src/convertLegacyApp.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyApp". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-components/api-report-alpha.md b/packages/core-components/api-report-alpha.api.md similarity index 95% rename from packages/core-components/api-report-alpha.md rename to packages/core-components/api-report-alpha.api.md index 1f4b999232..ea44f92093 100644 --- a/packages/core-components/api-report-alpha.md +++ b/packages/core-components/api-report-alpha.api.md @@ -54,5 +54,9 @@ export const coreComponentsTranslationRef: TranslationRef< } >; +// Warnings were encountered during analysis: +// +// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "coreComponentsTranslationRef". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-components/api-report-testUtils.md b/packages/core-components/api-report-testUtils.api.md similarity index 100% rename from packages/core-components/api-report-testUtils.md rename to packages/core-components/api-report-testUtils.api.md diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.api.md similarity index 72% rename from packages/core-components/api-report.md rename to packages/core-components/api-report.api.md index 9b4e9f6798..5b91140856 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.api.md @@ -1530,21 +1530,14 @@ export class UserIdentity implements IdentityApi { getIdToken?: () => Promise; signOut?: () => Promise; }): IdentityApi; - // (undocumented) getBackstageIdentity(): Promise; - // (undocumented) getCredentials(): Promise<{ token?: string | undefined; }>; - // (undocumented) getIdToken(): Promise; - // (undocumented) getProfile(): ProfileInfo; - // (undocumented) getProfileInfo(): Promise; - // (undocumented) getUserId(): string; - // (undocumented) signOut(): Promise; } @@ -1580,9 +1573,182 @@ export type WarningPanelClassKey = // Warnings were encountered during analysis: // +// src/components/AutoLogout/AutoLogout.d.ts:3:1 - (ae-undocumented) Missing documentation for "AutoLogoutProps". +// src/components/Avatar/Avatar.d.ts:3:1 - (ae-undocumented) Missing documentation for "AvatarClassKey". +// src/components/DependencyGraph/DefaultLabel.d.ts:4:1 - (ae-undocumented) Missing documentation for "DependencyGraphDefaultLabelClassKey". +// src/components/DependencyGraph/DefaultNode.d.ts:4:1 - (ae-undocumented) Missing documentation for "DependencyGraphDefaultNodeClassKey". +// src/components/DependencyGraph/Edge.d.ts:15:1 - (ae-undocumented) Missing documentation for "DependencyGraphEdgeClassKey". +// src/components/DependencyGraph/Node.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependencyGraphNodeClassKey". // src/components/DependencyGraph/types.d.ts:22:9 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode" // src/components/DependencyGraph/types.d.ts:26:9 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode" +// src/components/DependencyGraph/types.d.ts:143:9 - (ae-undocumented) Missing documentation for "LEFT". +// src/components/DependencyGraph/types.d.ts:144:9 - (ae-undocumented) Missing documentation for "RIGHT". +// src/components/DependencyGraph/types.d.ts:145:9 - (ae-undocumented) Missing documentation for "CENTER". +// src/components/DismissableBanner/DismissableBanner.d.ts:3:1 - (ae-undocumented) Missing documentation for "DismissableBannerClassKey". +// src/components/DismissableBanner/DismissableBanner.d.ts:8:1 - (ae-undocumented) Missing documentation for "DismissbleBannerClassKey". +// src/components/DismissableBanner/DismissableBanner.d.ts:16:22 - (ae-undocumented) Missing documentation for "DismissableBanner". +// src/components/EmptyState/EmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EmptyStateClassKey". +// src/components/EmptyState/EmptyStateImage.d.ts:6:1 - (ae-undocumented) Missing documentation for "EmptyStateImageClassKey". +// src/components/EmptyState/MissingAnnotationEmptyState.d.ts:10:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyStateClassKey". +// src/components/EmptyState/MissingAnnotationEmptyState.d.ts:15:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyState". +// src/components/ErrorPanel/ErrorPanel.d.ts:3:1 - (ae-undocumented) Missing documentation for "ErrorPanelClassKey". +// src/components/ErrorPanel/ErrorPanel.d.ts:5:1 - (ae-undocumented) Missing documentation for "ErrorPanelProps". +// src/components/FeatureDiscovery/FeatureCalloutCircular.d.ts:3:1 - (ae-undocumented) Missing documentation for "FeatureCalloutCircleClassKey". +// src/components/HeaderIconLinkRow/HeaderIconLinkRow.d.ts:4:1 - (ae-undocumented) Missing documentation for "HeaderIconLinkRowClassKey". +// src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:2:1 - (ae-undocumented) Missing documentation for "IconLinkVerticalProps". +// src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:12:1 - (ae-undocumented) Missing documentation for "IconLinkVerticalClassKey". +// src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:14:1 - (ae-undocumented) Missing documentation for "IconLinkVertical". +// src/components/HorizontalScrollGrid/HorizontalScrollGrid.d.ts:8:1 - (ae-undocumented) Missing documentation for "HorizontalScrollGridClassKey". +// src/components/Lifecycle/Lifecycle.d.ts:7:1 - (ae-undocumented) Missing documentation for "LifecycleClassKey". +// src/components/Lifecycle/Lifecycle.d.ts:8:1 - (ae-undocumented) Missing documentation for "Lifecycle". +// src/components/Link/Link.d.ts:6:1 - (ae-undocumented) Missing documentation for "LinkProps". +// src/components/LinkButton/LinkButton.d.ts:24:22 - (ae-undocumented) Missing documentation for "Button". +// src/components/LinkButton/LinkButton.d.ts:29:1 - (ae-undocumented) Missing documentation for "ButtonProps". +// src/components/MarkdownContent/MarkdownContent.d.ts:3:1 - (ae-undocumented) Missing documentation for "MarkdownContentClassKey". +// src/components/OAuthRequestDialog/LoginRequestListItem.d.ts:3:1 - (ae-undocumented) Missing documentation for "LoginRequestListItemClassKey". +// src/components/OAuthRequestDialog/OAuthRequestDialog.d.ts:2:1 - (ae-undocumented) Missing documentation for "OAuthRequestDialogClassKey". +// src/components/OAuthRequestDialog/OAuthRequestDialog.d.ts:3:1 - (ae-undocumented) Missing documentation for "OAuthRequestDialog". +// src/components/OverflowTooltip/OverflowTooltip.d.ts:9:1 - (ae-undocumented) Missing documentation for "OverflowTooltipClassKey". +// src/components/OverflowTooltip/OverflowTooltip.d.ts:10:1 - (ae-undocumented) Missing documentation for "OverflowTooltip". +// src/components/Progress/Progress.d.ts:3:1 - (ae-undocumented) Missing documentation for "Progress". +// src/components/ProgressBars/Gauge.d.ts:4:1 - (ae-undocumented) Missing documentation for "GaugeClassKey". +// src/components/ProgressBars/Gauge.d.ts:6:1 - (ae-undocumented) Missing documentation for "GaugeProps". +// src/components/ProgressBars/Gauge.d.ts:19:1 - (ae-undocumented) Missing documentation for "GaugePropsGetColorOptions". +// src/components/ProgressBars/Gauge.d.ts:26:1 - (ae-undocumented) Missing documentation for "GaugePropsGetColor". +// src/components/ProgressBars/GaugeCard.d.ts:20:1 - (ae-undocumented) Missing documentation for "GaugeCardClassKey". +// src/components/ProgressBars/LinearGauge.d.ts:11:1 - (ae-undocumented) Missing documentation for "LinearGauge". +// src/components/ResponseErrorPanel/ResponseErrorPanel.d.ts:3:1 - (ae-undocumented) Missing documentation for "ResponseErrorPanelClassKey". +// src/components/Select/Select.d.ts:3:1 - (ae-undocumented) Missing documentation for "SelectInputBaseClassKey". +// src/components/Select/Select.d.ts:5:1 - (ae-undocumented) Missing documentation for "SelectClassKey". +// src/components/Select/Select.d.ts:7:1 - (ae-undocumented) Missing documentation for "SelectItem". +// src/components/Select/Select.d.ts:12:1 - (ae-undocumented) Missing documentation for "SelectedItems". +// src/components/Select/Select.d.ts:27:1 - (ae-undocumented) Missing documentation for "SelectComponent". +// src/components/Select/static/ClosedDropdown.d.ts:3:1 - (ae-undocumented) Missing documentation for "ClosedDropdownClassKey". +// src/components/Select/static/OpenedDropdown.d.ts:2:1 - (ae-undocumented) Missing documentation for "OpenedDropdownClassKey". +// src/components/SimpleStepper/SimpleStepper.d.ts:16:1 - (ae-undocumented) Missing documentation for "SimpleStepper". +// src/components/SimpleStepper/SimpleStepperFooter.d.ts:3:1 - (ae-undocumented) Missing documentation for "SimpleStepperFooterClassKey". +// src/components/SimpleStepper/SimpleStepperStep.d.ts:3:1 - (ae-undocumented) Missing documentation for "SimpleStepperStepClassKey". +// src/components/SimpleStepper/SimpleStepperStep.d.ts:4:1 - (ae-undocumented) Missing documentation for "SimpleStepperStep". +// src/components/Status/Status.d.ts:2:1 - (ae-undocumented) Missing documentation for "StatusClassKey". +// src/components/Status/Status.d.ts:3:1 - (ae-undocumented) Missing documentation for "StatusOK". +// src/components/Status/Status.d.ts:4:1 - (ae-undocumented) Missing documentation for "StatusWarning". +// src/components/Status/Status.d.ts:5:1 - (ae-undocumented) Missing documentation for "StatusError". +// src/components/Status/Status.d.ts:6:1 - (ae-undocumented) Missing documentation for "StatusPending". +// src/components/Status/Status.d.ts:7:1 - (ae-undocumented) Missing documentation for "StatusRunning". +// src/components/Status/Status.d.ts:8:1 - (ae-undocumented) Missing documentation for "StatusAborted". +// src/components/StructuredMetadataTable/MetadataTable.d.ts:3:1 - (ae-undocumented) Missing documentation for "MetadataTableTitleCellClassKey". +// src/components/StructuredMetadataTable/MetadataTable.d.ts:4:1 - (ae-undocumented) Missing documentation for "MetadataTableCellClassKey". +// src/components/StructuredMetadataTable/MetadataTable.d.ts:5:1 - (ae-undocumented) Missing documentation for "MetadataTableListClassKey". +// src/components/StructuredMetadataTable/MetadataTable.d.ts:6:1 - (ae-undocumented) Missing documentation for "MetadataTableListItemClassKey". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:2:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTableListClassKey". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:3:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTableNestedListClassKey". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:5:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTableProps". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:6:5 - (ae-undocumented) Missing documentation for "metadata". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:9:5 - (ae-undocumented) Missing documentation for "dense". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "options". +// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:21:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTable". +// src/components/SupportButton/SupportButton.d.ts:8:1 - (ae-undocumented) Missing documentation for "SupportButtonClassKey". +// src/components/SupportButton/SupportButton.d.ts:9:1 - (ae-undocumented) Missing documentation for "SupportButton". +// src/components/TabbedLayout/RoutedTabs.d.ts:8:1 - (ae-undocumented) Missing documentation for "RoutedTabs". // src/components/TabbedLayout/RoutedTabs.d.ts:9:5 - (ae-forgotten-export) The symbol "SubRoute_2" needs to be exported by the entry point index.d.ts +// src/components/TabbedLayout/TabbedLayout.d.ts:29:1 - (ae-undocumented) Missing documentation for "TabbedLayout". +// src/components/TabbedLayout/TabbedLayout.d.ts:30:9 - (ae-undocumented) Missing documentation for "Route". +// src/components/Table/Filters.d.ts:3:1 - (ae-undocumented) Missing documentation for "TableFiltersClassKey". +// src/components/Table/SubvalueCell.d.ts:2:1 - (ae-undocumented) Missing documentation for "SubvalueCellClassKey". +// src/components/Table/SubvalueCell.d.ts:7:1 - (ae-undocumented) Missing documentation for "SubvalueCell". +// src/components/Table/Table.d.ts:4:1 - (ae-undocumented) Missing documentation for "TableHeaderClassKey". +// src/components/Table/Table.d.ts:5:1 - (ae-undocumented) Missing documentation for "TableToolbarClassKey". +// src/components/Table/Table.d.ts:7:1 - (ae-undocumented) Missing documentation for "FiltersContainerClassKey". +// src/components/Table/Table.d.ts:8:1 - (ae-undocumented) Missing documentation for "TableClassKey". +// src/components/Table/Table.d.ts:9:1 - (ae-undocumented) Missing documentation for "TableColumn". +// src/components/Table/Table.d.ts:10:5 - (ae-undocumented) Missing documentation for "highlight". +// src/components/Table/Table.d.ts:11:5 - (ae-undocumented) Missing documentation for "width". +// src/components/Table/Table.d.ts:13:1 - (ae-undocumented) Missing documentation for "TableFilter". +// src/components/Table/Table.d.ts:17:1 - (ae-undocumented) Missing documentation for "TableState". // src/components/Table/Table.d.ts:20:5 - (ae-forgotten-export) The symbol "SelectedFilters" needs to be exported by the entry point index.d.ts +// src/components/Table/Table.d.ts:22:1 - (ae-undocumented) Missing documentation for "TableProps". +// src/components/Table/Table.d.ts:23:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/Table/Table.d.ts:24:5 - (ae-undocumented) Missing documentation for "subtitle". +// src/components/Table/Table.d.ts:25:5 - (ae-undocumented) Missing documentation for "filters". +// src/components/Table/Table.d.ts:26:5 - (ae-undocumented) Missing documentation for "initialState". +// src/components/Table/Table.d.ts:27:5 - (ae-undocumented) Missing documentation for "emptyContent". +// src/components/Table/Table.d.ts:28:5 - (ae-undocumented) Missing documentation for "isLoading". +// src/components/Table/Table.d.ts:29:5 - (ae-undocumented) Missing documentation for "onStateChange". +// src/components/Table/Table.d.ts:31:1 - (ae-undocumented) Missing documentation for "TableOptions". +// src/components/Table/Table.d.ts:44:1 - (ae-undocumented) Missing documentation for "Table". +// src/components/Table/Table.d.ts:45:1 - (ae-undocumented) Missing documentation for "Table". +// src/components/Table/Table.d.ts:46:9 - (ae-undocumented) Missing documentation for "icons". +// src/components/TrendLine/TrendLine.d.ts:3:1 - (ae-undocumented) Missing documentation for "TrendLine". +// src/components/WarningPanel/WarningPanel.d.ts:2:1 - (ae-undocumented) Missing documentation for "WarningPanelClassKey". +// src/hooks/useQueryParamState.d.ts:2:1 - (ae-undocumented) Missing documentation for "useQueryParamState". +// src/hooks/useSupportConfig.d.ts:1:1 - (ae-undocumented) Missing documentation for "SupportItemLink". +// src/hooks/useSupportConfig.d.ts:5:1 - (ae-undocumented) Missing documentation for "SupportItem". +// src/hooks/useSupportConfig.d.ts:10:1 - (ae-undocumented) Missing documentation for "SupportConfig". +// src/hooks/useSupportConfig.d.ts:14:1 - (ae-undocumented) Missing documentation for "useSupportConfig". +// src/icons/icons.d.ts:27:1 - (ae-undocumented) Missing documentation for "CatalogIcon". +// src/icons/icons.d.ts:29:1 - (ae-undocumented) Missing documentation for "ChatIcon". +// src/icons/icons.d.ts:31:1 - (ae-undocumented) Missing documentation for "DashboardIcon". +// src/icons/icons.d.ts:33:1 - (ae-undocumented) Missing documentation for "DocsIcon". +// src/icons/icons.d.ts:35:1 - (ae-undocumented) Missing documentation for "EmailIcon". +// src/icons/icons.d.ts:37:1 - (ae-undocumented) Missing documentation for "GitHubIcon". +// src/icons/icons.d.ts:39:1 - (ae-undocumented) Missing documentation for "GroupIcon". +// src/icons/icons.d.ts:41:1 - (ae-undocumented) Missing documentation for "HelpIcon". +// src/icons/icons.d.ts:43:1 - (ae-undocumented) Missing documentation for "UserIcon". +// src/icons/icons.d.ts:45:1 - (ae-undocumented) Missing documentation for "WarningIcon". +// src/layout/BottomLink/BottomLink.d.ts:3:1 - (ae-undocumented) Missing documentation for "BottomLinkClassKey". +// src/layout/BottomLink/BottomLink.d.ts:5:1 - (ae-undocumented) Missing documentation for "BottomLinkProps". +// src/layout/Breadcrumbs/Breadcrumbs.d.ts:5:1 - (ae-undocumented) Missing documentation for "BreadcrumbsClickableTextClassKey". +// src/layout/Breadcrumbs/Breadcrumbs.d.ts:7:1 - (ae-undocumented) Missing documentation for "BreadcrumbsStyledBoxClassKey". +// src/layout/Breadcrumbs/Breadcrumbs.d.ts:9:1 - (ae-undocumented) Missing documentation for "BreadcrumbsCurrentPageClassKey". +// src/layout/Content/Content.d.ts:3:1 - (ae-undocumented) Missing documentation for "BackstageContentClassKey". +// src/layout/ContentHeader/ContentHeader.d.ts:6:1 - (ae-undocumented) Missing documentation for "ContentHeaderClassKey". +// src/layout/ErrorBoundary/ErrorBoundary.d.ts:7:1 - (ae-undocumented) Missing documentation for "ErrorBoundaryProps". // src/layout/ErrorBoundary/ErrorBoundary.d.ts:8:5 - (ae-forgotten-export) The symbol "SlackChannel" needs to be exported by the entry point index.d.ts +// src/layout/ErrorBoundary/ErrorBoundary.d.ts:16:22 - (ae-undocumented) Missing documentation for "ErrorBoundary". +// src/layout/ErrorPage/ErrorPage.d.ts:10:1 - (ae-undocumented) Missing documentation for "ErrorPageClassKey". +// src/layout/ErrorPage/MicDrop.d.ts:2:1 - (ae-undocumented) Missing documentation for "MicDropClassKey". +// src/layout/Header/Header.d.ts:3:1 - (ae-undocumented) Missing documentation for "HeaderClassKey". +// src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:6:1 - (ae-undocumented) Missing documentation for "HeaderActionMenuItem". +// src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:16:1 - (ae-undocumented) Missing documentation for "HeaderActionMenuProps". +// src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:22:1 - (ae-undocumented) Missing documentation for "HeaderActionMenu". +// src/layout/HeaderLabel/HeaderLabel.d.ts:3:1 - (ae-undocumented) Missing documentation for "HeaderLabelClassKey". +// src/layout/HeaderTabs/HeaderTabs.d.ts:4:1 - (ae-undocumented) Missing documentation for "HeaderTabsClassKey". +// src/layout/HeaderTabs/HeaderTabs.d.ts:5:1 - (ae-undocumented) Missing documentation for "Tab". +// src/layout/InfoCard/InfoCard.d.ts:6:1 - (ae-undocumented) Missing documentation for "InfoCardClassKey". +// src/layout/InfoCard/InfoCard.d.ts:8:1 - (ae-undocumented) Missing documentation for "CardActionsTopRightClassKey". +// src/layout/InfoCard/InfoCard.d.ts:10:1 - (ae-undocumented) Missing documentation for "InfoCardVariants". +// src/layout/ItemCard/ItemCardGrid.d.ts:4:1 - (ae-undocumented) Missing documentation for "ItemCardGridClassKey". +// src/layout/ItemCard/ItemCardGrid.d.ts:7:1 - (ae-undocumented) Missing documentation for "ItemCardGridProps". +// src/layout/ItemCard/ItemCardHeader.d.ts:4:1 - (ae-undocumented) Missing documentation for "ItemCardHeaderClassKey". +// src/layout/ItemCard/ItemCardHeader.d.ts:7:1 - (ae-undocumented) Missing documentation for "ItemCardHeaderProps". +// src/layout/Page/Page.d.ts:2:1 - (ae-undocumented) Missing documentation for "PageClassKey". +// src/layout/Page/Page.d.ts:7:1 - (ae-undocumented) Missing documentation for "Page". +// src/layout/Page/PageWithHeader.d.ts:6:1 - (ae-undocumented) Missing documentation for "PageWithHeader". +// src/layout/Sidebar/Bar.d.ts:4:1 - (ae-undocumented) Missing documentation for "SidebarClassKey". +// src/layout/Sidebar/Bar.d.ts:6:1 - (ae-undocumented) Missing documentation for "SidebarProps". +// src/layout/Sidebar/Items.d.ts:6:1 - (ae-undocumented) Missing documentation for "SidebarItemClassKey". +// src/layout/Sidebar/Items.d.ts:53:1 - (ae-undocumented) Missing documentation for "SidebarSearchField". +// src/layout/Sidebar/Items.d.ts:54:1 - (ae-undocumented) Missing documentation for "SidebarSpaceClassKey". +// src/layout/Sidebar/Items.d.ts:55:22 - (ae-undocumented) Missing documentation for "SidebarSpace". +// src/layout/Sidebar/Items.d.ts:56:1 - (ae-undocumented) Missing documentation for "SidebarSpacerClassKey". +// src/layout/Sidebar/Items.d.ts:57:22 - (ae-undocumented) Missing documentation for "SidebarSpacer". +// src/layout/Sidebar/Items.d.ts:58:1 - (ae-undocumented) Missing documentation for "SidebarDividerClassKey". +// src/layout/Sidebar/Items.d.ts:59:22 - (ae-undocumented) Missing documentation for "SidebarDivider". +// src/layout/Sidebar/Items.d.ts:60:22 - (ae-undocumented) Missing documentation for "SidebarScrollWrapper". +// src/layout/Sidebar/Page.d.ts:2:1 - (ae-undocumented) Missing documentation for "SidebarPageClassKey". +// src/layout/Sidebar/Page.d.ts:11:1 - (ae-undocumented) Missing documentation for "SidebarPage". +// src/layout/Sidebar/config.d.ts:3:1 - (ae-undocumented) Missing documentation for "SidebarOptions". +// src/layout/Sidebar/config.d.ts:8:1 - (ae-undocumented) Missing documentation for "SubmenuOptions". +// src/layout/Sidebar/config.d.ts:12:22 - (ae-undocumented) Missing documentation for "sidebarConfig". +// src/layout/Sidebar/config.d.ts:52:22 - (ae-undocumented) Missing documentation for "SIDEBAR_INTRO_LOCAL_STORAGE". +// src/layout/SignInPage/SignInPage.d.ts:16:1 - (ae-undocumented) Missing documentation for "SignInPage". +// src/layout/SignInPage/customProvider.d.ts:3:1 - (ae-undocumented) Missing documentation for "CustomProviderClassKey". +// src/layout/SignInPage/styles.d.ts:2:1 - (ae-undocumented) Missing documentation for "SignInPageClassKey". +// src/layout/SignInPage/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "SignInProviderConfig". +// src/layout/SignInPage/types.d.ts:10:1 - (ae-undocumented) Missing documentation for "IdentityProviders". +// src/layout/TabbedCard/TabbedCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "TabbedCardClassKey". +// src/layout/TabbedCard/TabbedCard.d.ts:7:1 - (ae-undocumented) Missing documentation for "BoldHeaderClassKey". +// src/layout/TabbedCard/TabbedCard.d.ts:18:1 - (ae-undocumented) Missing documentation for "TabbedCard". +// src/layout/TabbedCard/TabbedCard.d.ts:20:1 - (ae-undocumented) Missing documentation for "CardTabClassKey". +// src/overridableComponents.d.ts:78:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". ``` diff --git a/packages/core-plugin-api/api-report-alpha.md b/packages/core-plugin-api/api-report-alpha.api.md similarity index 64% rename from packages/core-plugin-api/api-report-alpha.md rename to packages/core-plugin-api/api-report-alpha.api.md index c0f0d02535..260e0365a7 100644 --- a/packages/core-plugin-api/api-report-alpha.md +++ b/packages/core-plugin-api/api-report-alpha.api.md @@ -239,5 +239,36 @@ export const useTranslationRef: < t: TranslationFunction; }; +// Warnings were encountered during analysis: +// +// src/apis/definitions/AppLanguageApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "AppLanguageApi". +// src/apis/definitions/AppLanguageApi.d.ts:19:22 - (ae-undocumented) Missing documentation for "appLanguageApiRef". +// src/apis/definitions/TranslationApi.d.ts:228:1 - (ae-undocumented) Missing documentation for "TranslationFunction". +// src/apis/definitions/TranslationApi.d.ts:231:5 - (ae-undocumented) Missing documentation for "__call". +// src/apis/definitions/TranslationApi.d.ts:234:1 - (ae-undocumented) Missing documentation for "TranslationSnapshot". +// src/apis/definitions/TranslationApi.d.ts:243:1 - (ae-undocumented) Missing documentation for "TranslationApi". +// src/apis/definitions/TranslationApi.d.ts:254:22 - (ae-undocumented) Missing documentation for "translationApiRef". +// src/translation/TranslationMessages.d.ts:17:5 - (ae-undocumented) Missing documentation for "$$type". +// src/translation/TranslationMessages.d.ts:33:5 - (ae-undocumented) Missing documentation for "ref". +// src/translation/TranslationMessages.d.ts:34:5 - (ae-undocumented) Missing documentation for "full". +// src/translation/TranslationMessages.d.ts:35:5 - (ae-undocumented) Missing documentation for "messages". +// src/translation/TranslationRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "TranslationRef". +// src/translation/TranslationRef.d.ts:7:5 - (ae-undocumented) Missing documentation for "$$type". +// src/translation/TranslationRef.d.ts:8:5 - (ae-undocumented) Missing documentation for "id". +// src/translation/TranslationRef.d.ts:9:5 - (ae-undocumented) Missing documentation for "T". +// src/translation/TranslationRef.d.ts:30:1 - (ae-undocumented) Missing documentation for "TranslationRefOptions". +// src/translation/TranslationRef.d.ts:37:5 - (ae-undocumented) Missing documentation for "id". +// src/translation/TranslationRef.d.ts:38:5 - (ae-undocumented) Missing documentation for "messages". +// src/translation/TranslationRef.d.ts:39:5 - (ae-undocumented) Missing documentation for "translations". +// src/translation/TranslationRef.d.ts:42:1 - (ae-undocumented) Missing documentation for "createTranslationRef". +// src/translation/TranslationResource.d.ts:3:1 - (ae-undocumented) Missing documentation for "TranslationResource". +// src/translation/TranslationResource.d.ts:4:5 - (ae-undocumented) Missing documentation for "$$type". +// src/translation/TranslationResource.d.ts:5:5 - (ae-undocumented) Missing documentation for "id". +// src/translation/TranslationResource.d.ts:8:1 - (ae-undocumented) Missing documentation for "TranslationResourceOptions". +// src/translation/TranslationResource.d.ts:17:5 - (ae-undocumented) Missing documentation for "ref". +// src/translation/TranslationResource.d.ts:18:5 - (ae-undocumented) Missing documentation for "translations". +// src/translation/TranslationResource.d.ts:21:1 - (ae-undocumented) Missing documentation for "createTranslationResource". +// src/translation/useTranslationRef.d.ts:4:22 - (ae-undocumented) Missing documentation for "useTranslationRef". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.api.md similarity index 99% rename from packages/core-plugin-api/api-report.md rename to packages/core-plugin-api/api-report.api.md index 134b338c92..d412f59b2d 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.api.md @@ -797,4 +797,8 @@ export function withApis( ): React_2.JSX.Element; displayName: string; }; + +// Warnings were encountered during analysis: +// +// src/routing/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "AnyParams". ``` diff --git a/packages/dev-utils/api-report.md b/packages/dev-utils/api-report.api.md similarity index 89% rename from packages/dev-utils/api-report.md rename to packages/dev-utils/api-report.api.md index 1a7b765fab..ccde681f41 100644 --- a/packages/dev-utils/api-report.md +++ b/packages/dev-utils/api-report.api.md @@ -67,4 +67,9 @@ export const SidebarSignOutButton: (props: { icon?: IconComponent; text?: string; }) => React_2.JSX.Element; + +// Warnings were encountered during analysis: +// +// src/components/EntityGridItem/EntityGridItem.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityGridItem". +// src/devApp/render.d.ts:7:1 - (ae-undocumented) Missing documentation for "DevAppPageOptions". ``` diff --git a/packages/e2e-test-utils/api-report-playwright.md b/packages/e2e-test-utils/api-report-playwright.api.md similarity index 100% rename from packages/e2e-test-utils/api-report-playwright.md rename to packages/e2e-test-utils/api-report-playwright.api.md diff --git a/packages/errors/api-report.md b/packages/errors/api-report.api.md similarity index 80% rename from packages/errors/api-report.md rename to packages/errors/api-report.api.md index 894aac8413..d2ba2d22ff 100644 --- a/packages/errors/api-report.md +++ b/packages/errors/api-report.api.md @@ -155,4 +155,16 @@ export class ServiceUnavailableError extends CustomErrorBase {} // @public export function stringifyError(error: unknown): string; + +// Warnings were encountered during analysis: +// +// src/errors/ResponseError.d.ts:32:5 - (ae-undocumented) Missing documentation for "statusCode". +// src/errors/ResponseError.d.ts:33:5 - (ae-undocumented) Missing documentation for "statusText". +// src/errors/common.d.ts:8:5 - (ae-undocumented) Missing documentation for "name". +// src/errors/common.d.ts:16:5 - (ae-undocumented) Missing documentation for "name". +// src/errors/common.d.ts:24:5 - (ae-undocumented) Missing documentation for "name". +// src/errors/common.d.ts:35:5 - (ae-undocumented) Missing documentation for "name". +// src/errors/common.d.ts:44:5 - (ae-undocumented) Missing documentation for "name". +// src/errors/common.d.ts:52:5 - (ae-undocumented) Missing documentation for "name". +// src/errors/common.d.ts:60:5 - (ae-undocumented) Missing documentation for "name". ``` diff --git a/packages/frontend-app-api/api-report.md b/packages/frontend-app-api/api-report.api.md similarity index 100% rename from packages/frontend-app-api/api-report.md rename to packages/frontend-app-api/api-report.api.md diff --git a/packages/frontend-plugin-api/api-report.md b/packages/frontend-plugin-api/api-report.api.md similarity index 77% rename from packages/frontend-plugin-api/api-report.md rename to packages/frontend-plugin-api/api-report.api.md index c36f8b9b3e..9afcb1b91e 100644 --- a/packages/frontend-plugin-api/api-report.md +++ b/packages/frontend-plugin-api/api-report.api.md @@ -1752,4 +1752,123 @@ export { useTranslationRef }; export { vmwareCloudAuthApiRef }; export { withApis }; + +// Warnings were encountered during analysis: +// +// src/apis/definitions/AppTreeApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "id". +// src/apis/definitions/AppTreeApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/apis/definitions/AppTreeApi.d.ts:17:5 - (ae-undocumented) Missing documentation for "extension". +// src/apis/definitions/AppTreeApi.d.ts:18:5 - (ae-undocumented) Missing documentation for "disabled". +// src/apis/definitions/AppTreeApi.d.ts:19:5 - (ae-undocumented) Missing documentation for "config". +// src/apis/definitions/AppTreeApi.d.ts:20:5 - (ae-undocumented) Missing documentation for "source". +// src/apis/definitions/AppTreeApi.d.ts:32:5 - (ae-undocumented) Missing documentation for "attachedTo". +// src/apis/definitions/AppTreeApi.d.ts:36:5 - (ae-undocumented) Missing documentation for "attachments". +// src/apis/definitions/ComponentsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "getComponent". +// src/apis/definitions/IconsApi.d.ts:8:5 - (ae-undocumented) Missing documentation for "getIcon". +// src/apis/definitions/IconsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "listIconKeys". +// src/apis/definitions/RouteResolutionApi.d.ts:19:1 - (ae-undocumented) Missing documentation for "RouteResolutionApiResolveOptions". +// src/apis/definitions/RouteResolutionApi.d.ts:29:1 - (ae-undocumented) Missing documentation for "RouteResolutionApi". +// src/apis/definitions/RouteResolutionApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "resolve". +// src/components/ExtensionBoundary.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionBoundaryProps". +// src/components/ExtensionBoundary.d.ts:5:5 - (ae-undocumented) Missing documentation for "node". +// src/components/ExtensionBoundary.d.ts:6:5 - (ae-undocumented) Missing documentation for "routable". +// src/components/ExtensionBoundary.d.ts:7:5 - (ae-undocumented) Missing documentation for "children". +// src/components/ExtensionBoundary.d.ts:10:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". +// src/components/coreComponentRefs.d.ts:3:22 - (ae-undocumented) Missing documentation for "coreComponentRefs". +// src/components/createComponentRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ComponentRef". +// src/components/createComponentRef.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentRef". +// src/extensions/createApiExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createApiExtension". +// src/extensions/createApiExtension.d.ts:20:1 - (ae-undocumented) Missing documentation for "createApiExtension". +// src/extensions/createApiExtension.d.ts:21:11 - (ae-undocumented) Missing documentation for "factoryDataRef". +// src/extensions/createAppRootWrapperExtension.d.ts:28:1 - (ae-undocumented) Missing documentation for "createAppRootWrapperExtension". +// src/extensions/createAppRootWrapperExtension.d.ts:29:11 - (ae-undocumented) Missing documentation for "componentDataRef". +// src/extensions/createComponentExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentExtension". +// src/extensions/createComponentExtension.d.ts:26:1 - (ae-undocumented) Missing documentation for "createComponentExtension". +// src/extensions/createComponentExtension.d.ts:27:11 - (ae-undocumented) Missing documentation for "componentDataRef". +// src/extensions/createNavItemExtension.d.ts:17:1 - (ae-undocumented) Missing documentation for "createNavItemExtension". +// src/extensions/createNavItemExtension.d.ts:18:11 - (ae-undocumented) Missing documentation for "targetDataRef". +// src/extensions/createNavLogoExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "createNavLogoExtension". +// src/extensions/createNavLogoExtension.d.ts:14:11 - (ae-undocumented) Missing documentation for "logoElementsDataRef". +// src/extensions/createRouterExtension.d.ts:28:1 - (ae-undocumented) Missing documentation for "createRouterExtension". +// src/extensions/createRouterExtension.d.ts:29:11 - (ae-undocumented) Missing documentation for "componentDataRef". +// src/extensions/createSignInPageExtension.d.ts:10:1 - (ae-undocumented) Missing documentation for "createSignInPageExtension". +// src/extensions/createSignInPageExtension.d.ts:26:1 - (ae-undocumented) Missing documentation for "createSignInPageExtension". +// src/extensions/createSignInPageExtension.d.ts:27:11 - (ae-undocumented) Missing documentation for "componentDataRef". +// src/extensions/createThemeExtension.d.ts:3:1 - (ae-undocumented) Missing documentation for "createThemeExtension". +// src/extensions/createThemeExtension.d.ts:5:1 - (ae-undocumented) Missing documentation for "createThemeExtension". +// src/extensions/createThemeExtension.d.ts:6:11 - (ae-undocumented) Missing documentation for "themeDataRef". +// src/extensions/createTranslationExtension.d.ts:3:1 - (ae-undocumented) Missing documentation for "createTranslationExtension". +// src/extensions/createTranslationExtension.d.ts:8:1 - (ae-undocumented) Missing documentation for "createTranslationExtension". +// src/extensions/createTranslationExtension.d.ts:9:11 - (ae-undocumented) Missing documentation for "translationDataRef". +// src/routing/ExternalRouteRef.d.ts:12:5 - (ae-undocumented) Missing documentation for "$$type". +// src/routing/ExternalRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "T". +// src/routing/ExternalRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "optional". +// src/routing/RouteRef.d.ts:12:5 - (ae-undocumented) Missing documentation for "$$type". +// src/routing/RouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "T". +// src/routing/SubRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "$$type". +// src/routing/SubRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "T". +// src/routing/SubRouteRef.d.ts:15:5 - (ae-undocumented) Missing documentation for "path". +// src/schema/createSchemaFromZod.d.ts:4:1 - (ae-undocumented) Missing documentation for "createSchemaFromZod". +// src/schema/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PortableSchema". +// src/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "CoreProgressProps". +// src/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "CoreNotFoundErrorPageProps". +// src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CoreErrorBoundaryFallbackProps". +// src/wiring/coreExtensionData.d.ts:4:22 - (ae-undocumented) Missing documentation for "coreExtensionData". +// src/wiring/createExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataMap". +// src/wiring/createExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "AnyExtensionInputMap". +// src/wiring/createExtension.d.ts:50:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". +// src/wiring/createExtension.d.ts:51:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtension.d.ts:52:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtension.d.ts:53:5 - (ae-undocumented) Missing documentation for "name". +// src/wiring/createExtension.d.ts:54:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtension.d.ts:58:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtension.d.ts:59:5 - (ae-undocumented) Missing documentation for "inputs". +// src/wiring/createExtension.d.ts:60:5 - (ae-undocumented) Missing documentation for "output". +// src/wiring/createExtension.d.ts:61:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/createExtension.d.ts:62:5 - (ae-undocumented) Missing documentation for "factory". +// src/wiring/createExtension.d.ts:69:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". +// src/wiring/createExtension.d.ts:70:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createExtension.d.ts:71:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtension.d.ts:72:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtension.d.ts:73:5 - (ae-undocumented) Missing documentation for "name". +// src/wiring/createExtension.d.ts:74:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtension.d.ts:78:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtension.d.ts:79:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/createExtension.d.ts:82:1 - (ae-undocumented) Missing documentation for "createExtension". +// src/wiring/createExtensionDataRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:11:1 - (ae-undocumented) Missing documentation for "ConfigurableExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "optional". +// src/wiring/createExtensionDataRef.d.ts:19:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtensionInput.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionInput". +// src/wiring/createExtensionInput.d.ts:7:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createExtensionInput.d.ts:8:5 - (ae-undocumented) Missing documentation for "extensionData". +// src/wiring/createExtensionInput.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". +// src/wiring/createExtensionInput.d.ts:12:1 - (ae-undocumented) Missing documentation for "createExtensionInput". +// src/wiring/createExtensionOverrides.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionOverridesOptions". +// src/wiring/createExtensionOverrides.d.ts:5:5 - (ae-undocumented) Missing documentation for "extensions". +// src/wiring/createExtensionOverrides.d.ts:6:5 - (ae-undocumented) Missing documentation for "featureFlags". +// src/wiring/createExtensionOverrides.d.ts:9:1 - (ae-undocumented) Missing documentation for "createExtensionOverrides". +// src/wiring/createPlugin.d.ts:5:1 - (ae-undocumented) Missing documentation for "PluginOptions". +// src/wiring/createPlugin.d.ts:6:5 - (ae-undocumented) Missing documentation for "id". +// src/wiring/createPlugin.d.ts:7:5 - (ae-undocumented) Missing documentation for "routes". +// src/wiring/createPlugin.d.ts:8:5 - (ae-undocumented) Missing documentation for "externalRoutes". +// src/wiring/createPlugin.d.ts:9:5 - (ae-undocumented) Missing documentation for "extensions". +// src/wiring/createPlugin.d.ts:10:5 - (ae-undocumented) Missing documentation for "featureFlags". +// src/wiring/createPlugin.d.ts:19:1 - (ae-undocumented) Missing documentation for "createPlugin". +// src/wiring/resolveExtensionDefinition.d.ts:3:1 - (ae-undocumented) Missing documentation for "Extension". +// src/wiring/resolveExtensionDefinition.d.ts:4:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/resolveExtensionDefinition.d.ts:5:5 - (ae-undocumented) Missing documentation for "id". +// src/wiring/resolveExtensionDefinition.d.ts:6:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/resolveExtensionDefinition.d.ts:10:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/resolveExtensionDefinition.d.ts:11:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "AnyRoutes". +// src/wiring/types.d.ts:16:1 - (ae-undocumented) Missing documentation for "AnyExternalRoutes". +// src/wiring/types.d.ts:20:1 - (ae-undocumented) Missing documentation for "BackstagePlugin". +// src/wiring/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "id". +// src/wiring/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "routes". +// src/wiring/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "externalRoutes". +// src/wiring/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "ExtensionOverrides". +// src/wiring/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/types.d.ts:31:1 - (ae-undocumented) Missing documentation for "FrontendFeature". ``` diff --git a/packages/frontend-test-utils/api-report.md b/packages/frontend-test-utils/api-report.api.md similarity index 84% rename from packages/frontend-test-utils/api-report.md rename to packages/frontend-test-utils/api-report.api.md index 10b84b0981..ebe02dee2c 100644 --- a/packages/frontend-test-utils/api-report.md +++ b/packages/frontend-test-utils/api-report.api.md @@ -140,4 +140,14 @@ export type TestAppOptions = { }; export { withLogCollector }; + +// Warnings were encountered during analysis: +// +// src/apis/AnalyticsApi/MockAnalyticsApi.d.ts:10:5 - (ae-undocumented) Missing documentation for "captureEvent". +// src/apis/AnalyticsApi/MockAnalyticsApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "getEvents". +// src/app/createExtensionTester.d.ts:5:1 - (ae-undocumented) Missing documentation for "ExtensionTester". +// src/app/createExtensionTester.d.ts:7:5 - (ae-undocumented) Missing documentation for "add". +// src/app/createExtensionTester.d.ts:10:5 - (ae-undocumented) Missing documentation for "render". +// src/app/createExtensionTester.d.ts:15:1 - (ae-undocumented) Missing documentation for "createExtensionTester". +// src/deprecated.d.ts:5:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". ``` diff --git a/packages/integration-aws-node/api-report.md b/packages/integration-aws-node/api-report.api.md similarity index 86% rename from packages/integration-aws-node/api-report.md rename to packages/integration-aws-node/api-report.api.md index d9ed25e193..80b1eee3ba 100644 --- a/packages/integration-aws-node/api-report.md +++ b/packages/integration-aws-node/api-report.api.md @@ -35,5 +35,9 @@ export class DefaultAwsCredentialsManager implements AwsCredentialsManager { ): Promise; } +// Warnings were encountered during analysis: +// +// src/DefaultAwsCredentialsManager.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/integration-react/api-report.md b/packages/integration-react/api-report.api.md similarity index 100% rename from packages/integration-react/api-report.md rename to packages/integration-react/api-report.api.md diff --git a/packages/integration/api-report.md b/packages/integration/api-report.api.md similarity index 66% rename from packages/integration/api-report.md rename to packages/integration/api-report.api.md index e9b67bb6c1..e14a93b9a4 100644 --- a/packages/integration/api-report.md +++ b/packages/integration/api-report.api.md @@ -1027,4 +1027,127 @@ export class SingleInstanceGithubCredentialsProvider static create: (config: GithubIntegrationConfig) => GithubCredentialsProvider; getCredentials(opts: { url: string }): Promise; } + +// Warnings were encountered during analysis: +// +// src/ScmIntegrations.d.ts:21:5 - (ae-undocumented) Missing documentation for "awsS3". +// src/ScmIntegrations.d.ts:22:5 - (ae-undocumented) Missing documentation for "awsCodeCommit". +// src/ScmIntegrations.d.ts:23:5 - (ae-undocumented) Missing documentation for "azure". +// src/ScmIntegrations.d.ts:27:5 - (ae-undocumented) Missing documentation for "bitbucket". +// src/ScmIntegrations.d.ts:28:5 - (ae-undocumented) Missing documentation for "bitbucketCloud". +// src/ScmIntegrations.d.ts:29:5 - (ae-undocumented) Missing documentation for "bitbucketServer". +// src/ScmIntegrations.d.ts:30:5 - (ae-undocumented) Missing documentation for "gerrit". +// src/ScmIntegrations.d.ts:31:5 - (ae-undocumented) Missing documentation for "github". +// src/ScmIntegrations.d.ts:32:5 - (ae-undocumented) Missing documentation for "gitlab". +// src/ScmIntegrations.d.ts:33:5 - (ae-undocumented) Missing documentation for "gitea". +// src/ScmIntegrations.d.ts:34:5 - (ae-undocumented) Missing documentation for "harness". +// src/ScmIntegrations.d.ts:43:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/ScmIntegrations.d.ts:45:5 - (ae-undocumented) Missing documentation for "awsS3". +// src/ScmIntegrations.d.ts:46:5 - (ae-undocumented) Missing documentation for "awsCodeCommit". +// src/ScmIntegrations.d.ts:47:5 - (ae-undocumented) Missing documentation for "azure". +// src/ScmIntegrations.d.ts:51:5 - (ae-undocumented) Missing documentation for "bitbucket". +// src/ScmIntegrations.d.ts:52:5 - (ae-undocumented) Missing documentation for "bitbucketCloud". +// src/ScmIntegrations.d.ts:53:5 - (ae-undocumented) Missing documentation for "bitbucketServer". +// src/ScmIntegrations.d.ts:54:5 - (ae-undocumented) Missing documentation for "gerrit". +// src/ScmIntegrations.d.ts:55:5 - (ae-undocumented) Missing documentation for "github". +// src/ScmIntegrations.d.ts:56:5 - (ae-undocumented) Missing documentation for "gitlab". +// src/ScmIntegrations.d.ts:57:5 - (ae-undocumented) Missing documentation for "gitea". +// src/ScmIntegrations.d.ts:58:5 - (ae-undocumented) Missing documentation for "harness". +// src/ScmIntegrations.d.ts:59:5 - (ae-undocumented) Missing documentation for "list". +// src/ScmIntegrations.d.ts:60:5 - (ae-undocumented) Missing documentation for "byUrl". +// src/ScmIntegrations.d.ts:61:5 - (ae-undocumented) Missing documentation for "byHost". +// src/ScmIntegrations.d.ts:62:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/ScmIntegrations.d.ts:67:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:11:5 - (ae-undocumented) Missing documentation for "type". +// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "config". +// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/awsS3/AwsS3Integration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/awsS3/AwsS3Integration.d.ts:11:5 - (ae-undocumented) Missing documentation for "type". +// src/awsS3/AwsS3Integration.d.ts:12:5 - (ae-undocumented) Missing documentation for "title". +// src/awsS3/AwsS3Integration.d.ts:13:5 - (ae-undocumented) Missing documentation for "config". +// src/awsS3/AwsS3Integration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/awsS3/AwsS3Integration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/azure/AzureIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/azure/AzureIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/azure/AzureIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/azure/AzureIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/azure/AzureIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/azure/AzureIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/azure/DefaultAzureDevOpsCredentialsProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "fromIntegrations". +// src/azure/DefaultAzureDevOpsCredentialsProvider.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/azure/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/bitbucket/BitbucketIntegration.d.ts:11:5 - (ae-undocumented) Missing documentation for "factory". +// src/bitbucket/BitbucketIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "type". +// src/bitbucket/BitbucketIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "title". +// src/bitbucket/BitbucketIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "config". +// src/bitbucket/BitbucketIntegration.d.ts:16:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/bitbucket/BitbucketIntegration.d.ts:21:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/bitbucketServer/BitbucketServerIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/bitbucketServer/BitbucketServerIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/bitbucketServer/BitbucketServerIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/bitbucketServer/BitbucketServerIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/bitbucketServer/BitbucketServerIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/bitbucketServer/BitbucketServerIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/gerrit/GerritIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/gerrit/GerritIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/gerrit/GerritIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/gerrit/GerritIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/gerrit/GerritIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/gerrit/GerritIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/gitea/GiteaIntegration.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". +// src/gitea/GiteaIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/gitea/GiteaIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/gitea/GiteaIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/gitea/GiteaIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/gitea/GiteaIntegration.d.ts:19:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/github/DefaultGithubCredentialsProvider.d.ts:13:5 - (ae-undocumented) Missing documentation for "fromIntegrations". +// src/github/GithubIntegration.d.ts:11:5 - (ae-undocumented) Missing documentation for "factory". +// src/github/GithubIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "type". +// src/github/GithubIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "title". +// src/github/GithubIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "config". +// src/github/GithubIntegration.d.ts:16:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/github/GithubIntegration.d.ts:21:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/github/GithubIntegration.d.ts:22:5 - (ae-undocumented) Missing documentation for "parseRateLimitInfo". +// src/github/SingleInstanceGithubCredentialsProvider.d.ts:12:5 - (ae-undocumented) Missing documentation for "getAllInstallations". +// src/github/SingleInstanceGithubCredentialsProvider.d.ts:13:5 - (ae-undocumented) Missing documentation for "getAppToken". +// src/github/SingleInstanceGithubCredentialsProvider.d.ts:26:5 - (ae-undocumented) Missing documentation for "create". +// src/github/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/gitlab/DefaultGitlabCredentialsProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "fromIntegrations". +// src/gitlab/DefaultGitlabCredentialsProvider.d.ts:12:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/gitlab/GitLabIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/gitlab/GitLabIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/gitlab/GitLabIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/gitlab/GitLabIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/gitlab/GitLabIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/gitlab/GitLabIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/gitlab/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "GitlabCredentials". +// src/gitlab/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "GitlabCredentialsProvider". +// src/gitlab/types.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/harness/HarnessIntegration.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". +// src/harness/HarnessIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". +// src/harness/HarnessIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". +// src/harness/HarnessIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/harness/HarnessIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "resolveUrl". +// src/harness/HarnessIntegration.d.ts:19:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". +// src/registry.d.ts:19:5 - (ae-undocumented) Missing documentation for "awsS3". +// src/registry.d.ts:20:5 - (ae-undocumented) Missing documentation for "awsCodeCommit". +// src/registry.d.ts:21:5 - (ae-undocumented) Missing documentation for "azure". +// src/registry.d.ts:25:5 - (ae-undocumented) Missing documentation for "bitbucket". +// src/registry.d.ts:26:5 - (ae-undocumented) Missing documentation for "bitbucketCloud". +// src/registry.d.ts:27:5 - (ae-undocumented) Missing documentation for "bitbucketServer". +// src/registry.d.ts:28:5 - (ae-undocumented) Missing documentation for "gerrit". +// src/registry.d.ts:29:5 - (ae-undocumented) Missing documentation for "github". +// src/registry.d.ts:30:5 - (ae-undocumented) Missing documentation for "gitlab". +// src/registry.d.ts:31:5 - (ae-undocumented) Missing documentation for "gitea". +// src/registry.d.ts:32:5 - (ae-undocumented) Missing documentation for "harness". +// src/types.d.ts:93:5 - (ae-undocumented) Missing documentation for "isRateLimited". ``` diff --git a/packages/release-manifests/api-report.md b/packages/release-manifests/api-report.api.md similarity index 100% rename from packages/release-manifests/api-report.md rename to packages/release-manifests/api-report.api.md diff --git a/packages/test-utils/api-report-alpha.md b/packages/test-utils/api-report-alpha.api.md similarity index 63% rename from packages/test-utils/api-report-alpha.md rename to packages/test-utils/api-report-alpha.api.md index 945c754f83..ba098135fb 100644 --- a/packages/test-utils/api-report-alpha.md +++ b/packages/test-utils/api-report-alpha.api.md @@ -28,5 +28,12 @@ export class MockTranslationApi implements TranslationApi { >(): Observable>; } +// Warnings were encountered during analysis: +// +// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "MockTranslationApi". +// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:6:5 - (ae-undocumented) Missing documentation for "create". +// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:8:5 - (ae-undocumented) Missing documentation for "getTranslation". +// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "translation$". + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/test-utils/api-report.md b/packages/test-utils/api-report.api.md similarity index 82% rename from packages/test-utils/api-report.md rename to packages/test-utils/api-report.api.md index ae54c588ba..4a1f297c4e 100644 --- a/packages/test-utils/api-report.md +++ b/packages/test-utils/api-report.api.md @@ -83,37 +83,21 @@ export function mockBreakpoint(options: { matches: boolean }): void; // @public export class MockConfigApi implements ConfigApi { constructor(data: JsonObject); - // (undocumented) get(key?: string): T; - // (undocumented) getBoolean(key: string): boolean; - // (undocumented) getConfig(key: string): Config; - // (undocumented) getConfigArray(key: string): Config[]; - // (undocumented) getNumber(key: string): number; - // (undocumented) getOptional(key?: string): T | undefined; - // (undocumented) getOptionalBoolean(key: string): boolean | undefined; - // (undocumented) getOptionalConfig(key: string): Config | undefined; - // (undocumented) getOptionalConfigArray(key: string): Config[] | undefined; - // (undocumented) getOptionalNumber(key: string): number | undefined; - // (undocumented) getOptionalString(key: string): string | undefined; - // (undocumented) getOptionalStringArray(key: string): string[] | undefined; - // (undocumented) getString(key: string): string; - // (undocumented) getStringArray(key: string): string[]; - // (undocumented) has(key: string): boolean; - // (undocumented) keys(): string[]; } @@ -141,7 +125,6 @@ export type MockErrorApiOptions = { // @public export class MockFetchApi implements FetchApi { constructor(options?: MockFetchApiOptions); - // (undocumented) get fetch(): typeof crossFetch; } @@ -289,4 +272,21 @@ export function wrapInTestApp( Component: ComponentType | ReactNode, options?: TestAppOptions, ): ReactElement; + +// Warnings were encountered during analysis: +// +// src/deprecated.d.ts:5:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". +// src/testUtils/apis/AnalyticsApi/MockAnalyticsApi.d.ts:10:5 - (ae-undocumented) Missing documentation for "captureEvent". +// src/testUtils/apis/AnalyticsApi/MockAnalyticsApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "getEvents". +// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:28:5 - (ae-undocumented) Missing documentation for "post". +// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:29:5 - (ae-undocumented) Missing documentation for "error$". +// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:33:5 - (ae-undocumented) Missing documentation for "getErrors". +// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:34:5 - (ae-undocumented) Missing documentation for "waitForError". +// src/testUtils/apis/PermissionApi/MockPermissionApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "authorize". +// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:19:5 - (ae-undocumented) Missing documentation for "create". +// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:20:5 - (ae-undocumented) Missing documentation for "forBucket". +// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:21:5 - (ae-undocumented) Missing documentation for "snapshot". +// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:22:5 - (ae-undocumented) Missing documentation for "set". +// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:23:5 - (ae-undocumented) Missing documentation for "remove". +// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:24:5 - (ae-undocumented) Missing documentation for "observe$". ``` diff --git a/packages/theme/api-report.md b/packages/theme/api-report.api.md similarity index 81% rename from packages/theme/api-report.md rename to packages/theme/api-report.api.md index 988569ece7..b380ce9fd1 100644 --- a/packages/theme/api-report.md +++ b/packages/theme/api-report.api.md @@ -459,4 +459,30 @@ export interface UnifiedThemeProviderProps { // (undocumented) theme: UnifiedTheme; } + +// Warnings were encountered during analysis: +// +// src/base/createBaseThemeOptions.d.ts:14:5 - (ae-undocumented) Missing documentation for "palette". +// src/base/createBaseThemeOptions.d.ts:15:5 - (ae-undocumented) Missing documentation for "defaultPageTheme". +// src/base/createBaseThemeOptions.d.ts:16:5 - (ae-undocumented) Missing documentation for "pageTheme". +// src/base/createBaseThemeOptions.d.ts:17:5 - (ae-undocumented) Missing documentation for "fontFamily". +// src/base/createBaseThemeOptions.d.ts:18:5 - (ae-undocumented) Missing documentation for "htmlFontSize". +// src/base/createBaseThemeOptions.d.ts:19:5 - (ae-undocumented) Missing documentation for "typography". +// src/unified/UnifiedTheme.d.ts:17:5 - (ae-undocumented) Missing documentation for "palette". +// src/unified/UnifiedTheme.d.ts:18:5 - (ae-undocumented) Missing documentation for "defaultPageTheme". +// src/unified/UnifiedTheme.d.ts:19:5 - (ae-undocumented) Missing documentation for "pageTheme". +// src/unified/UnifiedTheme.d.ts:20:5 - (ae-undocumented) Missing documentation for "fontFamily". +// src/unified/UnifiedTheme.d.ts:21:5 - (ae-undocumented) Missing documentation for "htmlFontSize". +// src/unified/UnifiedTheme.d.ts:22:5 - (ae-undocumented) Missing documentation for "components". +// src/unified/UnifiedTheme.d.ts:23:5 - (ae-undocumented) Missing documentation for "typography". +// src/unified/UnifiedThemeProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "children". +// src/unified/UnifiedThemeProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "theme". +// src/unified/UnifiedThemeProvider.d.ts:11:5 - (ae-undocumented) Missing documentation for "noCssBaseline". +// src/unified/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "getTheme". +// src/v4/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "palette". +// src/v4/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "page". +// src/v4/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "getPageTheme". +// src/v4/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "palette". +// src/v4/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "page". +// src/v4/types.d.ts:44:5 - (ae-undocumented) Missing documentation for "getPageTheme". ``` diff --git a/packages/types/api-report.md b/packages/types/api-report.api.md similarity index 100% rename from packages/types/api-report.md rename to packages/types/api-report.api.md diff --git a/packages/version-bridge/api-report.md b/packages/version-bridge/api-report.api.md similarity index 100% rename from packages/version-bridge/api-report.md rename to packages/version-bridge/api-report.api.md diff --git a/packages/yarn-plugin/api-report.md b/packages/yarn-plugin/api-report.api.md similarity index 68% rename from packages/yarn-plugin/api-report.md rename to packages/yarn-plugin/api-report.api.md index f0300ec9a1..b246b802bb 100644 --- a/packages/yarn-plugin/api-report.md +++ b/packages/yarn-plugin/api-report.api.md @@ -8,4 +8,8 @@ import { Plugin as Plugin_2 } from '@yarnpkg/core'; // @public (undocumented) const plugin: Plugin_2; export default plugin; + +// Warnings were encountered during analysis: +// +// src/index.d.ts:11:15 - (ae-undocumented) Missing documentation for "plugin". ``` diff --git a/plugins/api-docs-module-protoc-gen-doc/api-report.md b/plugins/api-docs-module-protoc-gen-doc/api-report.api.md similarity index 72% rename from plugins/api-docs-module-protoc-gen-doc/api-report.md rename to plugins/api-docs-module-protoc-gen-doc/api-report.api.md index 836f8313d8..355b867e9a 100644 --- a/plugins/api-docs-module-protoc-gen-doc/api-report.md +++ b/plugins/api-docs-module-protoc-gen-doc/api-report.api.md @@ -11,4 +11,8 @@ export const grpcDocsApiWidget: { title: string; component: (definition: string) => React_2.JSX.Element; }; + +// Warnings were encountered during analysis: +// +// src/widgets.d.ts:5:22 - (ae-undocumented) Missing documentation for "grpcDocsApiWidget". ``` diff --git a/plugins/api-docs/api-report-alpha.md b/plugins/api-docs/api-report-alpha.api.md similarity index 98% rename from plugins/api-docs/api-report-alpha.md rename to plugins/api-docs/api-report-alpha.api.md index 820978b877..66fa1b1be5 100644 --- a/plugins/api-docs/api-report-alpha.md +++ b/plugins/api-docs/api-report-alpha.api.md @@ -427,5 +427,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.api.md similarity index 63% rename from plugins/api-docs/api-report.md rename to plugins/api-docs/api-report.api.md index 3c3f245a3c..023b8e02ee 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.api.md @@ -229,4 +229,37 @@ export const TrpcApiDefinitionWidget: ( export type TrpcApiDefinitionWidgetProps = { definition: string; }; + +// Warnings were encountered during analysis: +// +// src/components/ApiDefinitionCard/ApiDefinitionCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "ApiDefinitionCard". +// src/components/ApiDefinitionCard/ApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "ApiDefinitionWidget". +// src/components/ApiDefinitionCard/ApiDefinitionWidget.d.ts:10:1 - (ae-undocumented) Missing documentation for "defaultDefinitionWidgets". +// src/components/ApiDefinitionCard/ApiTypeTitle.d.ts:6:22 - (ae-undocumented) Missing documentation for "ApiTypeTitle". +// src/components/ApisCards/ConsumedApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConsumedApisCard". +// src/components/ApisCards/HasApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "HasApisCard". +// src/components/ApisCards/ProvidedApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ProvidedApisCard". +// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidgetProps". +// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidget". +// src/components/ComponentsCards/ConsumingComponentsCard.d.ts:6:22 - (ae-undocumented) Missing documentation for "ConsumingComponentsCard". +// src/components/ComponentsCards/ProvidingComponentsCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "ProvidingComponentsCard". +// src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "GraphQlDefinitionWidgetProps". +// src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "GraphQlDefinitionWidget". +// src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "OpenApiDefinitionWidgetProps". +// src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.d.ts:9:22 - (ae-undocumented) Missing documentation for "OpenApiDefinitionWidget". +// src/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "PlainApiDefinitionWidgetProps". +// src/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.d.ts:8:22 - (ae-undocumented) Missing documentation for "PlainApiDefinitionWidget". +// src/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "TrpcApiDefinitionWidgetProps". +// src/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "TrpcApiDefinitionWidget". +// src/config.d.ts:4:22 - (ae-undocumented) Missing documentation for "apiDocsConfigRef". +// src/config.d.ts:6:1 - (ae-undocumented) Missing documentation for "ApiDocsConfig". +// src/config.d.ts:7:5 - (ae-undocumented) Missing documentation for "getApiDefinitionWidget". +// src/plugin.d.ts:4:22 - (ae-undocumented) Missing documentation for "apiDocsPlugin". +// src/plugin.d.ts:10:22 - (ae-undocumented) Missing documentation for "ApiExplorerPage". +// src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityApiDefinitionCard". +// src/plugin.d.ts:14:22 - (ae-undocumented) Missing documentation for "EntityConsumedApisCard". +// src/plugin.d.ts:19:22 - (ae-undocumented) Missing documentation for "EntityConsumingComponentsCard". +// src/plugin.d.ts:23:22 - (ae-undocumented) Missing documentation for "EntityProvidedApisCard". +// src/plugin.d.ts:28:22 - (ae-undocumented) Missing documentation for "EntityProvidingComponentsCard". +// src/plugin.d.ts:32:22 - (ae-undocumented) Missing documentation for "EntityHasApisCard". ``` diff --git a/plugins/app-backend/api-report-alpha.md b/plugins/app-backend/api-report-alpha.api.md similarity index 100% rename from plugins/app-backend/api-report-alpha.md rename to plugins/app-backend/api-report-alpha.api.md diff --git a/plugins/app-backend/api-report.md b/plugins/app-backend/api-report.api.md similarity index 65% rename from plugins/app-backend/api-report.md rename to plugins/app-backend/api-report.api.md index bb0ebb67db..3de36b0338 100644 --- a/plugins/app-backend/api-report.md +++ b/plugins/app-backend/api-report.api.md @@ -30,4 +30,13 @@ export interface RouterOptions { schema?: ConfigSchema; staticFallbackHandler?: express.Handler; } + +// Warnings were encountered during analysis: +// +// src/service/router.d.ts:7:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:8:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:56:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/app-node/api-report.md b/plugins/app-node/api-report.api.md similarity index 100% rename from plugins/app-node/api-report.md rename to plugins/app-node/api-report.api.md diff --git a/plugins/app-visualizer/api-report.md b/plugins/app-visualizer/api-report.api.md similarity index 93% rename from plugins/app-visualizer/api-report.md rename to plugins/app-visualizer/api-report.api.md index 48eca04ed8..7466ff24f6 100644 --- a/plugins/app-visualizer/api-report.md +++ b/plugins/app-visualizer/api-report.api.md @@ -71,5 +71,9 @@ const visualizerPlugin: FrontendPlugin< >; export default visualizerPlugin; +// Warnings were encountered during analysis: +// +// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-atlassian-provider/api-report.md b/plugins/auth-backend-module-atlassian-provider/api-report.api.md similarity index 80% rename from plugins/auth-backend-module-atlassian-provider/api-report.md rename to plugins/auth-backend-module-atlassian-provider/api-report.api.md index 7abdf7ee70..7f32330451 100644 --- a/plugins/auth-backend-module-atlassian-provider/api-report.md +++ b/plugins/auth-backend-module-atlassian-provider/api-report.api.md @@ -27,4 +27,9 @@ export namespace atlassianSignInResolvers { // @public (undocumented) const authModuleAtlassianProvider: BackendFeature; export default authModuleAtlassianProvider; + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "atlassianAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAtlassianProvider". ``` diff --git a/plugins/auth-backend-module-aws-alb-provider/api-report.md b/plugins/auth-backend-module-aws-alb-provider/api-report.api.md similarity index 78% rename from plugins/auth-backend-module-aws-alb-provider/api-report.md rename to plugins/auth-backend-module-aws-alb-provider/api-report.api.md index b3a9ce4517..c7437a1b9d 100644 --- a/plugins/auth-backend-module-aws-alb-provider/api-report.md +++ b/plugins/auth-backend-module-aws-alb-provider/api-report.api.md @@ -46,4 +46,10 @@ export namespace awsAlbSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:6:22 - (ae-undocumented) Missing documentation for "awsAlbAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAwsAlbProvider". +// src/resolvers.d.ts:8:11 - (ae-undocumented) Missing documentation for "emailMatchingUserEntityProfileEmail". ``` diff --git a/plugins/auth-backend-module-azure-easyauth-provider/api-report.md b/plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md similarity index 66% rename from plugins/auth-backend-module-azure-easyauth-provider/api-report.md rename to plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md index 9d337e3f34..3292654787 100644 --- a/plugins/auth-backend-module-azure-easyauth-provider/api-report.md +++ b/plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md @@ -36,5 +36,13 @@ export namespace azureEasyAuthSignInResolvers { >; } +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:5:22 - (ae-undocumented) Missing documentation for "azureEasyAuthAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAzureEasyAuthProvider". +// src/resolvers.d.ts:3:1 - (ae-undocumented) Missing documentation for "azureEasyAuthSignInResolvers". +// src/resolvers.d.ts:4:11 - (ae-undocumented) Missing documentation for "idMatchingUserEntityAnnotation". +// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "AzureEasyAuthResult". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-bitbucket-provider/api-report.md b/plugins/auth-backend-module-bitbucket-provider/api-report.api.md similarity index 82% rename from plugins/auth-backend-module-bitbucket-provider/api-report.md rename to plugins/auth-backend-module-bitbucket-provider/api-report.api.md index ceb4141fd9..210a292050 100644 --- a/plugins/auth-backend-module-bitbucket-provider/api-report.md +++ b/plugins/auth-backend-module-bitbucket-provider/api-report.api.md @@ -31,4 +31,9 @@ export namespace bitbucketSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "bitbucketAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleBitbucketProvider". ``` diff --git a/plugins/auth-backend-module-cloudflare-access-provider/api-report.md b/plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md similarity index 82% rename from plugins/auth-backend-module-cloudflare-access-provider/api-report.md rename to plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md index 1547190d39..b9943b2bef 100644 --- a/plugins/auth-backend-module-cloudflare-access-provider/api-report.md +++ b/plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md @@ -60,4 +60,10 @@ export namespace cloudflareAccessSignInResolvers { export function createCloudflareAccessAuthenticator(options?: { cache?: CacheService; }): ProxyAuthenticator; + +// Warnings were encountered during analysis: +// +// src/types.d.ts:55:1 - (ae-undocumented) Missing documentation for "CloudflareAccessGroup". +// src/types.d.ts:72:1 - (ae-undocumented) Missing documentation for "CloudflareAccessIdentityProfile". +// src/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "CloudflareAccessResult". ``` diff --git a/plugins/auth-backend-module-gcp-iap-provider/api-report.md b/plugins/auth-backend-module-gcp-iap-provider/api-report.api.md similarity index 84% rename from plugins/auth-backend-module-gcp-iap-provider/api-report.md rename to plugins/auth-backend-module-gcp-iap-provider/api-report.api.md index 1476694f99..72887276d5 100644 --- a/plugins/auth-backend-module-gcp-iap-provider/api-report.md +++ b/plugins/auth-backend-module-gcp-iap-provider/api-report.api.md @@ -50,5 +50,10 @@ export type GcpIapTokenInfo = { [key: string]: JsonPrimitive; }; +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:2:22 - (ae-undocumented) Missing documentation for "gcpIapAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGcpIapProvider". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-github-provider/api-report.md b/plugins/auth-backend-module-github-provider/api-report.api.md similarity index 80% rename from plugins/auth-backend-module-github-provider/api-report.md rename to plugins/auth-backend-module-github-provider/api-report.api.md index 222305adfd..0578c23d3e 100644 --- a/plugins/auth-backend-module-github-provider/api-report.md +++ b/plugins/auth-backend-module-github-provider/api-report.api.md @@ -27,4 +27,9 @@ export namespace githubSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "githubAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGithubProvider". ``` diff --git a/plugins/auth-backend-module-gitlab-provider/api-report.md b/plugins/auth-backend-module-gitlab-provider/api-report.api.md similarity index 80% rename from plugins/auth-backend-module-gitlab-provider/api-report.md rename to plugins/auth-backend-module-gitlab-provider/api-report.api.md index 44c5ffb214..a72c00c6e5 100644 --- a/plugins/auth-backend-module-gitlab-provider/api-report.md +++ b/plugins/auth-backend-module-gitlab-provider/api-report.api.md @@ -27,4 +27,9 @@ export namespace gitlabSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "gitlabAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGitlabProvider". ``` diff --git a/plugins/auth-backend-module-google-provider/api-report.md b/plugins/auth-backend-module-google-provider/api-report.api.md similarity index 81% rename from plugins/auth-backend-module-google-provider/api-report.md rename to plugins/auth-backend-module-google-provider/api-report.api.md index eeefb8e837..a2fc1bbce9 100644 --- a/plugins/auth-backend-module-google-provider/api-report.md +++ b/plugins/auth-backend-module-google-provider/api-report.api.md @@ -28,5 +28,10 @@ export namespace googleSignInResolvers { >; } +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "googleAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGoogleProvider". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-guest-provider/api-report.md b/plugins/auth-backend-module-guest-provider/api-report.api.md similarity index 71% rename from plugins/auth-backend-module-guest-provider/api-report.md rename to plugins/auth-backend-module-guest-provider/api-report.api.md index b0ba5386a2..b100e5270b 100644 --- a/plugins/auth-backend-module-guest-provider/api-report.md +++ b/plugins/auth-backend-module-guest-provider/api-report.api.md @@ -8,4 +8,8 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @public (undocumented) const authModuleGuestProvider: BackendFeature; export default authModuleGuestProvider; + +// Warnings were encountered during analysis: +// +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGuestProvider". ``` diff --git a/plugins/auth-backend-module-microsoft-provider/api-report.md b/plugins/auth-backend-module-microsoft-provider/api-report.api.md similarity index 78% rename from plugins/auth-backend-module-microsoft-provider/api-report.md rename to plugins/auth-backend-module-microsoft-provider/api-report.api.md index 6aef395d7c..3e7775cfa8 100644 --- a/plugins/auth-backend-module-microsoft-provider/api-report.md +++ b/plugins/auth-backend-module-microsoft-provider/api-report.api.md @@ -37,4 +37,10 @@ export namespace microsoftSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "microsoftAuthenticator". +// src/deprecated.d.ts:5:22 - (ae-undocumented) Missing documentation for "authModuleMicrosoftProvider". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleMicrosoftProvider". ``` diff --git a/plugins/auth-backend-module-oauth2-provider/api-report.md b/plugins/auth-backend-module-oauth2-provider/api-report.api.md similarity index 80% rename from plugins/auth-backend-module-oauth2-provider/api-report.md rename to plugins/auth-backend-module-oauth2-provider/api-report.api.md index 632591ec04..5648d043a2 100644 --- a/plugins/auth-backend-module-oauth2-provider/api-report.md +++ b/plugins/auth-backend-module-oauth2-provider/api-report.api.md @@ -27,4 +27,9 @@ export namespace oauth2SignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "oauth2Authenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOauth2Provider". ``` diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/api-report.md b/plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md similarity index 78% rename from plugins/auth-backend-module-oauth2-proxy-provider/api-report.md rename to plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md index 5c5cefd734..27b3a9feb2 100644 --- a/plugins/auth-backend-module-oauth2-proxy-provider/api-report.md +++ b/plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md @@ -32,4 +32,9 @@ export type OAuth2ProxyResult = { headers: IncomingHttpHeaders; getHeader(name: string): string | undefined; }; + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:10:22 - (ae-undocumented) Missing documentation for "oauth2ProxyAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOauth2ProxyProvider". ``` diff --git a/plugins/auth-backend-module-oidc-provider/api-report.md b/plugins/auth-backend-module-oidc-provider/api-report.api.md similarity index 85% rename from plugins/auth-backend-module-oidc-provider/api-report.md rename to plugins/auth-backend-module-oidc-provider/api-report.api.md index cd0a99e7fc..df717a9e1e 100644 --- a/plugins/auth-backend-module-oidc-provider/api-report.md +++ b/plugins/auth-backend-module-oidc-provider/api-report.api.md @@ -46,4 +46,9 @@ export namespace oidcSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:13:22 - (ae-undocumented) Missing documentation for "oidcAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOidcProvider". ``` diff --git a/plugins/auth-backend-module-okta-provider/api-report.md b/plugins/auth-backend-module-okta-provider/api-report.api.md similarity index 80% rename from plugins/auth-backend-module-okta-provider/api-report.md rename to plugins/auth-backend-module-okta-provider/api-report.api.md index a142265100..97e587df76 100644 --- a/plugins/auth-backend-module-okta-provider/api-report.md +++ b/plugins/auth-backend-module-okta-provider/api-report.api.md @@ -27,4 +27,9 @@ export namespace oktaSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "oktaAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOktaProvider". ``` diff --git a/plugins/auth-backend-module-onelogin-provider/api-report.md b/plugins/auth-backend-module-onelogin-provider/api-report.api.md similarity index 80% rename from plugins/auth-backend-module-onelogin-provider/api-report.md rename to plugins/auth-backend-module-onelogin-provider/api-report.api.md index 1991f00e0b..a636d96ae0 100644 --- a/plugins/auth-backend-module-onelogin-provider/api-report.md +++ b/plugins/auth-backend-module-onelogin-provider/api-report.api.md @@ -27,4 +27,9 @@ export namespace oneLoginSignInResolvers { unknown >; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "oneLoginAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOneLoginProvider". ``` diff --git a/plugins/auth-backend-module-pinniped-provider/api-report.md b/plugins/auth-backend-module-pinniped-provider/api-report.api.md similarity index 67% rename from plugins/auth-backend-module-pinniped-provider/api-report.md rename to plugins/auth-backend-module-pinniped-provider/api-report.api.md index e15f4ee324..a0500f5e74 100644 --- a/plugins/auth-backend-module-pinniped-provider/api-report.md +++ b/plugins/auth-backend-module-pinniped-provider/api-report.api.md @@ -37,4 +37,12 @@ export class PinnipedStrategyCache { client: BaseClient; }>; } + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:4:1 - (ae-undocumented) Missing documentation for "PinnipedStrategyCache". +// src/authenticator.d.ts:11:5 - (ae-undocumented) Missing documentation for "getStrategy". +// src/authenticator.d.ts:20:22 - (ae-undocumented) Missing documentation for "pinnipedAuthenticator". +// src/deprecated.d.ts:5:22 - (ae-undocumented) Missing documentation for "authModulePinnipedProvider". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModulePinnipedProvider". ``` diff --git a/plugins/auth-backend-module-vmware-cloud-provider/api-report.md b/plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md similarity index 72% rename from plugins/auth-backend-module-vmware-cloud-provider/api-report.md rename to plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md index 2a27d8fc7c..c970b237a9 100644 --- a/plugins/auth-backend-module-vmware-cloud-provider/api-report.md +++ b/plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md @@ -43,4 +43,12 @@ export namespace vmwareCloudSignInResolvers { export type VMwarePassportProfile = PassportProfile & { organizationId?: string; }; + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:4:1 - (ae-undocumented) Missing documentation for "VMwareCloudAuthenticatorContext". +// src/authenticator.d.ts:5:5 - (ae-undocumented) Missing documentation for "organizationId". +// src/authenticator.d.ts:6:5 - (ae-undocumented) Missing documentation for "providerStrategy". +// src/authenticator.d.ts:7:5 - (ae-undocumented) Missing documentation for "helper". +// src/authenticator.d.ts:10:1 - (ae-undocumented) Missing documentation for "VMwarePassportProfile". ``` diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.api.md similarity index 76% rename from plugins/auth-backend/api-report.md rename to plugins/auth-backend/api-report.api.md index 20690528d1..fff72d034c 100644 --- a/plugins/auth-backend/api-report.md +++ b/plugins/auth-backend/api-report.api.md @@ -700,4 +700,68 @@ export const verifyNonce: (req: express.Request, providerId: string) => void; // @public @deprecated (undocumented) export type WebMessageResponse = WebMessageResponse_2; + +// Warnings were encountered during analysis: +// +// src/identity/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "TokenParams". +// src/lib/flow/authFlowHelpers.d.ts:8:22 - (ae-undocumented) Missing documentation for "postMessageResponse". +// src/lib/flow/authFlowHelpers.d.ts:13:22 - (ae-undocumented) Missing documentation for "ensuresXRequestedWith". +// src/lib/flow/types.d.ts:6:1 - (ae-undocumented) Missing documentation for "WebMessageResponse". +// src/lib/oauth/OAuthAdapter.d.ts:10:1 - (ae-undocumented) Missing documentation for "OAuthAdapterOptions". +// src/lib/oauth/OAuthAdapter.d.ts:23:1 - (ae-undocumented) Missing documentation for "OAuthAdapter". +// src/lib/oauth/OAuthAdapter.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/lib/oauth/OAuthAdapter.d.ts:29:5 - (ae-undocumented) Missing documentation for "start". +// src/lib/oauth/OAuthAdapter.d.ts:30:5 - (ae-undocumented) Missing documentation for "frameHandler". +// src/lib/oauth/OAuthAdapter.d.ts:31:5 - (ae-undocumented) Missing documentation for "logout". +// src/lib/oauth/OAuthAdapter.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". +// src/lib/oauth/OAuthEnvironmentHandler.d.ts:6:22 - (ae-undocumented) Missing documentation for "OAuthEnvironmentHandler". +// src/lib/oauth/helpers.d.ts:7:22 - (ae-undocumented) Missing documentation for "readState". +// src/lib/oauth/helpers.d.ts:12:22 - (ae-undocumented) Missing documentation for "encodeState". +// src/lib/oauth/helpers.d.ts:17:22 - (ae-undocumented) Missing documentation for "verifyNonce". +// src/lib/oauth/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "OAuthResult". +// src/lib/oauth/types.d.ts:44:1 - (ae-undocumented) Missing documentation for "OAuthResponse". +// src/lib/oauth/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "OAuthProviderInfo". +// src/lib/oauth/types.d.ts:75:1 - (ae-undocumented) Missing documentation for "OAuthState". +// src/lib/oauth/types.d.ts:80:1 - (ae-undocumented) Missing documentation for "OAuthStartRequest". +// src/lib/oauth/types.d.ts:88:1 - (ae-undocumented) Missing documentation for "OAuthRefreshRequest". +// src/lib/oauth/types.d.ts:96:1 - (ae-undocumented) Missing documentation for "OAuthLogoutRequest". +// src/lib/oauth/types.d.ts:103:1 - (ae-undocumented) Missing documentation for "OAuthHandlers". +// src/providers/azure-easyauth/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "EasyAuthResult". +// src/providers/bitbucket/provider.d.ts:9:1 - (ae-undocumented) Missing documentation for "BitbucketOAuthResult". +// src/providers/bitbucket/provider.d.ts:23:1 - (ae-undocumented) Missing documentation for "BitbucketPassportProfile". +// src/providers/bitbucketServer/provider.d.ts:7:1 - (ae-undocumented) Missing documentation for "BitbucketServerOAuthResult". +// src/providers/cloudflare-access/provider.d.ts:89:1 - (ae-undocumented) Missing documentation for "CloudflareAccessResult". +// src/providers/github/provider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GithubOAuthResult". +// src/providers/oauth2-proxy/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "OAuth2ProxyResult". +// src/providers/oidc/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "OidcAuthResult". +// src/providers/prepareBackstageIdentityResponse.d.ts:6:22 - (ae-undocumented) Missing documentation for "prepareBackstageIdentityResponse". +// src/providers/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "ProviderFactories". +// src/providers/router.d.ts:27:1 - (ae-undocumented) Missing documentation for "createOriginFilter". +// src/providers/saml/provider.d.ts:6:1 - (ae-undocumented) Missing documentation for "SamlAuthResult". +// src/providers/types.d.ts:7:1 - (ae-undocumented) Missing documentation for "AuthResolverCatalogUserQuery". +// src/providers/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "AuthResolverContext". +// src/providers/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CookieConfigurer". +// src/providers/types.d.ts:22:1 - (ae-undocumented) Missing documentation for "OAuthStartResponse". +// src/providers/types.d.ts:36:1 - (ae-undocumented) Missing documentation for "AuthProviderConfig". +// src/providers/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "AuthProviderRouteHandlers". +// src/providers/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "AuthProviderFactory". +// src/providers/types.d.ts:51:1 - (ae-undocumented) Missing documentation for "AuthResponse". +// src/providers/types.d.ts:56:1 - (ae-undocumented) Missing documentation for "ProfileInfo". +// src/providers/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "SignInInfo". +// src/providers/types.d.ts:66:1 - (ae-undocumented) Missing documentation for "SignInResolver". +// src/providers/types.d.ts:96:1 - (ae-undocumented) Missing documentation for "StateEncoder". +// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "database". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "tokenManager". +// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "tokenFactoryAlgorithm". +// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "providerFactories". +// src/service/router.d.ts:19:5 - (ae-undocumented) Missing documentation for "disableDefaultProviderFactories". +// src/service/router.d.ts:20:5 - (ae-undocumented) Missing documentation for "catalogApi". +// src/service/router.d.ts:21:5 - (ae-undocumented) Missing documentation for "ownershipResolver". +// src/service/router.d.ts:24:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/auth-node/api-report.md b/plugins/auth-node/api-report.api.md similarity index 58% rename from plugins/auth-node/api-report.md rename to plugins/auth-node/api-report.api.md index 5a8750127d..4cf9d5fd4b 100644 --- a/plugins/auth-node/api-report.md +++ b/plugins/auth-node/api-report.api.md @@ -703,4 +703,128 @@ export type WebMessageResponse = type: 'authorization_response'; error: Error; }; + +// Warnings were encountered during analysis: +// +// src/extensions/AuthOwnershipResolutionExtensionPoint.d.ts:3:1 - (ae-undocumented) Missing documentation for "AuthOwnershipResolutionExtensionPoint". +// src/extensions/AuthOwnershipResolutionExtensionPoint.d.ts:4:5 - (ae-undocumented) Missing documentation for "setAuthOwnershipResolver". +// src/extensions/AuthOwnershipResolutionExtensionPoint.d.ts:7:22 - (ae-undocumented) Missing documentation for "authOwnershipResolutionExtensionPoint". +// src/extensions/AuthProvidersExtensionPoint.d.ts:3:1 - (ae-undocumented) Missing documentation for "AuthProviderRegistrationOptions". +// src/extensions/AuthProvidersExtensionPoint.d.ts:4:5 - (ae-undocumented) Missing documentation for "providerId". +// src/extensions/AuthProvidersExtensionPoint.d.ts:5:5 - (ae-undocumented) Missing documentation for "factory". +// src/extensions/AuthProvidersExtensionPoint.d.ts:8:1 - (ae-undocumented) Missing documentation for "AuthProvidersExtensionPoint". +// src/extensions/AuthProvidersExtensionPoint.d.ts:9:5 - (ae-undocumented) Missing documentation for "registerProvider". +// src/extensions/AuthProvidersExtensionPoint.d.ts:12:22 - (ae-undocumented) Missing documentation for "authProvidersExtensionPoint". +// src/flow/sendWebMessageResponse.d.ts:17:1 - (ae-undocumented) Missing documentation for "sendWebMessageResponse". +// src/identity/DefaultIdentityClient.d.ts:35:5 - (ae-undocumented) Missing documentation for "getIdentity". +// src/identity/IdentityClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "create". +// src/oauth/OAuthEnvironmentHandler.d.ts:5:1 - (ae-undocumented) Missing documentation for "OAuthEnvironmentHandler". +// src/oauth/OAuthEnvironmentHandler.d.ts:7:5 - (ae-undocumented) Missing documentation for "mapConfig". +// src/oauth/OAuthEnvironmentHandler.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". +// src/oauth/OAuthEnvironmentHandler.d.ts:10:5 - (ae-undocumented) Missing documentation for "frameHandler". +// src/oauth/OAuthEnvironmentHandler.d.ts:11:5 - (ae-undocumented) Missing documentation for "refresh". +// src/oauth/OAuthEnvironmentHandler.d.ts:12:5 - (ae-undocumented) Missing documentation for "logout". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:6:1 - (ae-undocumented) Missing documentation for "PassportOAuthResult". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:17:1 - (ae-undocumented) Missing documentation for "PassportOAuthPrivateInfo". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:21:1 - (ae-undocumented) Missing documentation for "PassportOAuthDoneCallback". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:23:1 - (ae-undocumented) Missing documentation for "PassportOAuthAuthenticatorHelper". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:25:5 - (ae-undocumented) Missing documentation for "defaultProfileTransform". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:26:5 - (ae-undocumented) Missing documentation for "from". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:28:5 - (ae-undocumented) Missing documentation for "start". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:32:5 - (ae-undocumented) Missing documentation for "authenticate". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:33:5 - (ae-undocumented) Missing documentation for "refresh". +// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:34:5 - (ae-undocumented) Missing documentation for "fetchProfile". +// src/oauth/createOAuthProviderFactory.d.ts:6:1 - (ae-undocumented) Missing documentation for "createOAuthProviderFactory". +// src/oauth/createOAuthRouteHandlers.d.ts:6:1 - (ae-undocumented) Missing documentation for "OAuthRouteHandlersOptions". +// src/oauth/createOAuthRouteHandlers.d.ts:7:5 - (ae-undocumented) Missing documentation for "authenticator". +// src/oauth/createOAuthRouteHandlers.d.ts:8:5 - (ae-undocumented) Missing documentation for "appUrl". +// src/oauth/createOAuthRouteHandlers.d.ts:9:5 - (ae-undocumented) Missing documentation for "baseUrl". +// src/oauth/createOAuthRouteHandlers.d.ts:10:5 - (ae-undocumented) Missing documentation for "isOriginAllowed". +// src/oauth/createOAuthRouteHandlers.d.ts:11:5 - (ae-undocumented) Missing documentation for "providerId". +// src/oauth/createOAuthRouteHandlers.d.ts:12:5 - (ae-undocumented) Missing documentation for "config". +// src/oauth/createOAuthRouteHandlers.d.ts:13:5 - (ae-undocumented) Missing documentation for "resolverContext". +// src/oauth/createOAuthRouteHandlers.d.ts:14:5 - (ae-undocumented) Missing documentation for "additionalScopes". +// src/oauth/createOAuthRouteHandlers.d.ts:15:5 - (ae-undocumented) Missing documentation for "stateTransform". +// src/oauth/createOAuthRouteHandlers.d.ts:16:5 - (ae-undocumented) Missing documentation for "profileTransform". +// src/oauth/createOAuthRouteHandlers.d.ts:17:5 - (ae-undocumented) Missing documentation for "cookieConfigurer". +// src/oauth/createOAuthRouteHandlers.d.ts:18:5 - (ae-undocumented) Missing documentation for "signInResolver". +// src/oauth/createOAuthRouteHandlers.d.ts:21:1 - (ae-undocumented) Missing documentation for "createOAuthRouteHandlers". +// src/oauth/state.d.ts:16:1 - (ae-undocumented) Missing documentation for "OAuthStateTransform". +// src/oauth/state.d.ts:22:1 - (ae-undocumented) Missing documentation for "encodeOAuthState". +// src/oauth/state.d.ts:24:1 - (ae-undocumented) Missing documentation for "decodeOAuthState". +// src/oauth/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "OAuthSession". +// src/oauth/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "accessToken". +// src/oauth/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "tokenType". +// src/oauth/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "idToken". +// src/oauth/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "scope". +// src/oauth/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "expiresInSeconds". +// src/oauth/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "refreshToken". +// src/oauth/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "refreshTokenExpiresInSeconds". +// src/oauth/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorScopeOptions". +// src/oauth/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "persist". +// src/oauth/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "required". +// src/oauth/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "transform". +// src/oauth/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorStartInput". +// src/oauth/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "scope". +// src/oauth/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "state". +// src/oauth/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "req". +// src/oauth/types.d.ts:36:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorAuthenticateInput". +// src/oauth/types.d.ts:37:5 - (ae-undocumented) Missing documentation for "req". +// src/oauth/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorRefreshInput". +// src/oauth/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "scope". +// src/oauth/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "refreshToken". +// src/oauth/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "req". +// src/oauth/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorLogoutInput". +// src/oauth/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "accessToken". +// src/oauth/types.d.ts:48:5 - (ae-undocumented) Missing documentation for "refreshToken". +// src/oauth/types.d.ts:49:5 - (ae-undocumented) Missing documentation for "req". +// src/oauth/types.d.ts:52:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorResult". +// src/oauth/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "fullProfile". +// src/oauth/types.d.ts:54:5 - (ae-undocumented) Missing documentation for "session". +// src/oauth/types.d.ts:57:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticator". +// src/oauth/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "defaultProfileTransform". +// src/oauth/types.d.ts:60:5 - (ae-undocumented) Missing documentation for "shouldPersistScopes". +// src/oauth/types.d.ts:61:5 - (ae-undocumented) Missing documentation for "scopes". +// src/oauth/types.d.ts:62:5 - (ae-undocumented) Missing documentation for "initialize". +// src/oauth/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "start". +// src/oauth/types.d.ts:70:5 - (ae-undocumented) Missing documentation for "authenticate". +// src/oauth/types.d.ts:71:5 - (ae-undocumented) Missing documentation for "refresh". +// src/oauth/types.d.ts:72:5 - (ae-undocumented) Missing documentation for "logout". +// src/oauth/types.d.ts:75:1 - (ae-undocumented) Missing documentation for "createOAuthAuthenticator". +// src/passport/PassportHelpers.d.ts:6:1 - (ae-undocumented) Missing documentation for "PassportHelpers". +// src/passport/PassportHelpers.d.ts:8:5 - (ae-undocumented) Missing documentation for "transformProfile". +// src/passport/PassportHelpers.d.ts:9:5 - (ae-undocumented) Missing documentation for "executeRedirectStrategy". +// src/passport/PassportHelpers.d.ts:19:5 - (ae-undocumented) Missing documentation for "executeFrameHandlerStrategy". +// src/passport/PassportHelpers.d.ts:23:5 - (ae-undocumented) Missing documentation for "executeRefreshTokenStrategy". +// src/passport/PassportHelpers.d.ts:34:5 - (ae-undocumented) Missing documentation for "executeFetchUserProfileStrategy". +// src/passport/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PassportProfile". +// src/passport/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "PassportDoneCallback". +// src/proxy/createProxyAuthProviderFactory.d.ts:5:1 - (ae-undocumented) Missing documentation for "createProxyAuthProviderFactory". +// src/proxy/createProxyRouteHandlers.d.ts:5:1 - (ae-undocumented) Missing documentation for "ProxyAuthRouteHandlersOptions". +// src/proxy/createProxyRouteHandlers.d.ts:6:5 - (ae-undocumented) Missing documentation for "authenticator". +// src/proxy/createProxyRouteHandlers.d.ts:7:5 - (ae-undocumented) Missing documentation for "config". +// src/proxy/createProxyRouteHandlers.d.ts:8:5 - (ae-undocumented) Missing documentation for "resolverContext". +// src/proxy/createProxyRouteHandlers.d.ts:9:5 - (ae-undocumented) Missing documentation for "signInResolver". +// src/proxy/createProxyRouteHandlers.d.ts:10:5 - (ae-undocumented) Missing documentation for "profileTransform". +// src/proxy/createProxyRouteHandlers.d.ts:13:1 - (ae-undocumented) Missing documentation for "createProxyAuthRouteHandlers". +// src/proxy/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ProxyAuthenticator". +// src/proxy/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "defaultProfileTransform". +// src/proxy/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "initialize". +// src/proxy/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "authenticate". +// src/proxy/types.d.ts:18:1 - (ae-undocumented) Missing documentation for "createProxyAuthenticator". +// src/sign-in/createSignInResolverFactory.d.ts:5:1 - (ae-undocumented) Missing documentation for "SignInResolverFactory". +// src/sign-in/createSignInResolverFactory.d.ts:6:5 - (ae-undocumented) Missing documentation for "__call". +// src/sign-in/createSignInResolverFactory.d.ts:7:5 - (ae-undocumented) Missing documentation for "optionsJsonSchema". +// src/sign-in/createSignInResolverFactory.d.ts:10:1 - (ae-undocumented) Missing documentation for "SignInResolverFactoryOptions". +// src/sign-in/createSignInResolverFactory.d.ts:11:5 - (ae-undocumented) Missing documentation for "optionsSchema". +// src/sign-in/createSignInResolverFactory.d.ts:12:5 - (ae-undocumented) Missing documentation for "create". +// src/sign-in/createSignInResolverFactory.d.ts:15:1 - (ae-undocumented) Missing documentation for "createSignInResolverFactory". +// src/sign-in/readDeclarativeSignInResolver.d.ts:5:1 - (ae-undocumented) Missing documentation for "ReadDeclarativeSignInResolverOptions". +// src/sign-in/readDeclarativeSignInResolver.d.ts:6:5 - (ae-undocumented) Missing documentation for "config". +// src/sign-in/readDeclarativeSignInResolver.d.ts:7:5 - (ae-undocumented) Missing documentation for "signInResolverFactories". +// src/sign-in/readDeclarativeSignInResolver.d.ts:12:1 - (ae-undocumented) Missing documentation for "readDeclarativeSignInResolver". +// src/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "resolveOwnershipEntityRefs". +// src/types.d.ts:204:1 - (ae-undocumented) Missing documentation for "AuthProviderConfig". +// src/types.d.ts:224:1 - (ae-undocumented) Missing documentation for "AuthProviderFactory". +// src/types.d.ts:250:1 - (ae-undocumented) Missing documentation for "ClientAuthResponse". ``` diff --git a/plugins/auth-react/api-report.md b/plugins/auth-react/api-report.api.md similarity index 100% rename from plugins/auth-react/api-report.md rename to plugins/auth-react/api-report.api.md diff --git a/plugins/bitbucket-cloud-common/api-report.api.md b/plugins/bitbucket-cloud-common/api-report.api.md new file mode 100644 index 0000000000..93fcbffbc6 --- /dev/null +++ b/plugins/bitbucket-cloud-common/api-report.api.md @@ -0,0 +1,625 @@ +## API Report File for "@backstage/plugin-bitbucket-cloud-common" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BitbucketCloudIntegrationConfig } from '@backstage/integration'; + +// @public (undocumented) +export class BitbucketCloudClient { + // (undocumented) + static fromConfig( + config: BitbucketCloudIntegrationConfig, + ): BitbucketCloudClient; + // (undocumented) + listProjectsByWorkspace( + workspace: string, + options?: FilterAndSortOptions & PartialResponseOptions, + ): WithPagination; + // (undocumented) + listRepositoriesByWorkspace( + workspace: string, + options?: FilterAndSortOptions & PartialResponseOptions, + ): WithPagination; + // (undocumented) + listWorkspaces( + options?: FilterAndSortOptions & PartialResponseOptions, + ): WithPagination; + // (undocumented) + searchCode( + workspace: string, + query: string, + options?: FilterAndSortOptions & PartialResponseOptions, + ): WithPagination; +} + +// @public (undocumented) +export namespace Events { + // (undocumented) + export interface Change { + // (undocumented) + closed: boolean; + // (undocumented) + commits: Models.Commit[]; + // (undocumented) + created: boolean; + // (undocumented) + forced: boolean; + // (undocumented) + links: ChangeLinks; + // (undocumented) + new: Models.Branch; + // (undocumented) + old: Models.Branch; + // (undocumented) + truncated: boolean; + } + // (undocumented) + export interface ChangeLinks { + // (undocumented) + commits: Models.Link; + // (undocumented) + diff: Models.Link; + // (undocumented) + html: Models.Link; + } + // (undocumented) + export interface RepoEvent { + // (undocumented) + actor: Models.Account; + // (undocumented) + repository: Models.Repository & { + workspace: Models.Workspace; + }; + } + // (undocumented) + export interface RepoPush { + // (undocumented) + changes: Change[]; + } + // (undocumented) + export interface RepoPushEvent extends RepoEvent { + // (undocumented) + push: RepoPush; + } +} + +// @public (undocumented) +export type FilterAndSortOptions = { + q?: string; + sort?: string; +}; + +// @public (undocumented) +export namespace Models { + export interface Account extends ModelObject { + // (undocumented) + created_on?: string; + // (undocumented) + display_name?: string; + // (undocumented) + links?: AccountLinks; + // (undocumented) + username?: string; + // (undocumented) + uuid?: string; + } + export interface AccountLinks { + // (undocumented) + [key: string]: unknown; + // (undocumented) + avatar?: Link; + } + export interface Author extends ModelObject { + raw?: string; + // (undocumented) + user?: Account; + } + export interface BaseCommit extends ModelObject { + // (undocumented) + author?: Author; + // (undocumented) + date?: string; + // (undocumented) + hash?: string; + // (undocumented) + message?: string; + // (undocumented) + parents?: Array; + // (undocumented) + summary?: BaseCommitSummary; + } + // (undocumented) + export interface BaseCommitSummary { + html?: string; + markup?: BaseCommitSummaryMarkupEnum; + raw?: string; + } + const BaseCommitSummaryMarkupEnum: { + readonly Markdown: 'markdown'; + readonly Creole: 'creole'; + readonly Plaintext: 'plaintext'; + }; + export type BaseCommitSummaryMarkupEnum = + (typeof BaseCommitSummaryMarkupEnum)[keyof typeof BaseCommitSummaryMarkupEnum]; + export interface Branch { + default_merge_strategy?: string; + // (undocumented) + links?: RefLinks; + merge_strategies?: Array; + name?: string; + // (undocumented) + target?: Commit; + // (undocumented) + type: string; + } + const BranchMergeStrategiesEnum: { + readonly MergeCommit: 'merge_commit'; + readonly Squash: 'squash'; + readonly FastForward: 'fast_forward'; + }; + export type BranchMergeStrategiesEnum = + (typeof BranchMergeStrategiesEnum)[keyof typeof BranchMergeStrategiesEnum]; + export interface Commit extends BaseCommit { + // (undocumented) + participants?: Array; + // (undocumented) + repository?: Repository; + } + export interface CommitFile { + // (undocumented) + [key: string]: unknown; + // (undocumented) + attributes?: CommitFileAttributesEnum; + // (undocumented) + commit?: Commit; + escaped_path?: string; + path?: string; + // (undocumented) + type: string; + } + const // (undocumented) + CommitFileAttributesEnum: { + readonly Link: 'link'; + readonly Executable: 'executable'; + readonly Subrepository: 'subrepository'; + readonly Binary: 'binary'; + readonly Lfs: 'lfs'; + }; + // (undocumented) + export type CommitFileAttributesEnum = + (typeof CommitFileAttributesEnum)[keyof typeof CommitFileAttributesEnum]; + export interface Link { + // (undocumented) + href?: string; + // (undocumented) + name?: string; + } + export interface ModelObject { + // (undocumented) + [key: string]: unknown; + // (undocumented) + type: string; + } + export interface Paginated { + next?: string; + page?: number; + pagelen?: number; + previous?: string; + size?: number; + values?: Array | Set; + } + export interface PaginatedProjects extends Paginated { + values?: Set; + } + export interface PaginatedRepositories extends Paginated { + values?: Set; + } + export interface PaginatedWorkspaces extends Paginated { + values?: Set; + } + export interface Participant extends ModelObject { + // (undocumented) + approved?: boolean; + participated_on?: string; + // (undocumented) + role?: ParticipantRoleEnum; + // (undocumented) + state?: ParticipantStateEnum; + // (undocumented) + user?: Account; + } + const // (undocumented) + ParticipantRoleEnum: { + readonly Participant: 'PARTICIPANT'; + readonly Reviewer: 'REVIEWER'; + }; + // (undocumented) + export type ParticipantRoleEnum = + (typeof ParticipantRoleEnum)[keyof typeof ParticipantRoleEnum]; + const // (undocumented) + ParticipantStateEnum: { + readonly Approved: 'approved'; + readonly ChangesRequested: 'changes_requested'; + readonly Null: 'null'; + }; + // (undocumented) + export type ParticipantStateEnum = + (typeof ParticipantStateEnum)[keyof typeof ParticipantStateEnum]; + export interface Project extends ModelObject { + // (undocumented) + created_on?: string; + // (undocumented) + description?: string; + has_publicly_visible_repos?: boolean; + is_private?: boolean; + key?: string; + // (undocumented) + links?: ProjectLinks; + name?: string; + // (undocumented) + owner?: Team; + // (undocumented) + updated_on?: string; + uuid?: string; + } + // (undocumented) + export interface ProjectLinks { + // (undocumented) + avatar?: Link; + // (undocumented) + html?: Link; + } + // (undocumented) + export interface RefLinks { + // (undocumented) + commits?: Link; + // (undocumented) + html?: Link; + // (undocumented) + self?: Link; + } + export interface Repository extends ModelObject { + // (undocumented) + created_on?: string; + // (undocumented) + description?: string; + fork_policy?: RepositoryForkPolicyEnum; + full_name?: string; + has_issues?: boolean; + has_wiki?: boolean; + // (undocumented) + is_private?: boolean; + // (undocumented) + language?: string; + // (undocumented) + links?: RepositoryLinks; + // (undocumented) + mainbranch?: Branch; + // (undocumented) + name?: string; + // (undocumented) + owner?: Account; + // (undocumented) + parent?: Repository; + // (undocumented) + project?: Project; + // (undocumented) + scm?: RepositoryScmEnum; + // (undocumented) + size?: number; + slug?: string; + // (undocumented) + updated_on?: string; + uuid?: string; + } + const RepositoryForkPolicyEnum: { + readonly AllowForks: 'allow_forks'; + readonly NoPublicForks: 'no_public_forks'; + readonly NoForks: 'no_forks'; + }; + export type RepositoryForkPolicyEnum = + (typeof RepositoryForkPolicyEnum)[keyof typeof RepositoryForkPolicyEnum]; + const // (undocumented) + RepositoryScmEnum: { + readonly Git: 'git'; + }; + // (undocumented) + export interface RepositoryLinks { + // (undocumented) + avatar?: Link; + // (undocumented) + clone?: Array; + // (undocumented) + commits?: Link; + // (undocumented) + downloads?: Link; + // (undocumented) + forks?: Link; + // (undocumented) + hooks?: Link; + // (undocumented) + html?: Link; + // (undocumented) + pullrequests?: Link; + // (undocumented) + self?: Link; + // (undocumented) + watchers?: Link; + } + // (undocumented) + export type RepositoryScmEnum = + (typeof RepositoryScmEnum)[keyof typeof RepositoryScmEnum]; + // (undocumented) + export interface SearchCodeSearchResult { + // (undocumented) + readonly content_match_count?: number; + // (undocumented) + readonly content_matches?: Array; + // (undocumented) + file?: CommitFile; + // (undocumented) + readonly path_matches?: Array; + // (undocumented) + readonly type?: string; + } + // (undocumented) + export interface SearchContentMatch { + // (undocumented) + readonly lines?: Array; + } + // (undocumented) + export interface SearchLine { + // (undocumented) + readonly line?: number; + // (undocumented) + readonly segments?: Array; + } + // (undocumented) + export interface SearchResultPage extends Paginated { + // (undocumented) + readonly query_substituted?: boolean; + readonly values?: Array; + } + // (undocumented) + export interface SearchSegment { + // (undocumented) + readonly match?: boolean; + // (undocumented) + readonly text?: string; + } + export interface Team extends Account { + // (undocumented) + links?: TeamLinks; + } + export interface TeamLinks extends AccountLinks { + // (undocumented) + html?: Link; + // (undocumented) + members?: Link; + // (undocumented) + projects?: Link; + // (undocumented) + repositories?: Link; + // (undocumented) + self?: Link; + } + export interface Workspace extends ModelObject { + // (undocumented) + created_on?: string; + is_private?: boolean; + // (undocumented) + links?: WorkspaceLinks; + name?: string; + slug?: string; + // (undocumented) + updated_on?: string; + uuid?: string; + } + // (undocumented) + export interface WorkspaceLinks { + // (undocumented) + avatar?: Link; + // (undocumented) + html?: Link; + // (undocumented) + members?: Link; + // (undocumented) + owners?: Link; + // (undocumented) + projects?: Link; + // (undocumented) + repositories?: Link; + // (undocumented) + self?: Link; + // (undocumented) + snippets?: Link; + } +} + +// @public (undocumented) +export type PaginationOptions = { + page?: number; + pagelen?: number; +}; + +// @public (undocumented) +export type PartialResponseOptions = { + fields?: string; +}; + +// @public (undocumented) +export type RequestOptions = FilterAndSortOptions & + PaginationOptions & + PartialResponseOptions & { + [key: string]: string | number | undefined; + }; + +// @public (undocumented) +export class WithPagination< + TPage extends Models.Paginated, + TResultItem, +> { + constructor( + createUrl: (options: PaginationOptions) => URL, + fetch: (url: URL) => Promise, + ); + // (undocumented) + getPage(options?: PaginationOptions): Promise; + // (undocumented) + iteratePages(options?: PaginationOptions): AsyncGenerator; + // (undocumented) + iterateResults( + options?: PaginationOptions, + ): AsyncGenerator, void, unknown>; +} + +// Warnings were encountered during analysis: +// +// src/BitbucketCloudClient.d.ts:6:1 - (ae-undocumented) Missing documentation for "BitbucketCloudClient". +// src/BitbucketCloudClient.d.ts:8:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/BitbucketCloudClient.d.ts:10:5 - (ae-undocumented) Missing documentation for "searchCode". +// src/BitbucketCloudClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "listRepositoriesByWorkspace". +// src/BitbucketCloudClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "listProjectsByWorkspace". +// src/BitbucketCloudClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "listWorkspaces". +// src/events/index.d.ts:3:1 - (ae-undocumented) Missing documentation for "Events". +// src/events/index.d.ts:5:5 - (ae-undocumented) Missing documentation for "RepoEvent". +// src/events/index.d.ts:6:9 - (ae-undocumented) Missing documentation for "repository". +// src/events/index.d.ts:9:9 - (ae-undocumented) Missing documentation for "actor". +// src/events/index.d.ts:12:5 - (ae-undocumented) Missing documentation for "RepoPushEvent". +// src/events/index.d.ts:13:9 - (ae-undocumented) Missing documentation for "push". +// src/events/index.d.ts:16:5 - (ae-undocumented) Missing documentation for "RepoPush". +// src/events/index.d.ts:17:9 - (ae-undocumented) Missing documentation for "changes". +// src/events/index.d.ts:20:5 - (ae-undocumented) Missing documentation for "Change". +// src/events/index.d.ts:21:9 - (ae-undocumented) Missing documentation for "old". +// src/events/index.d.ts:22:9 - (ae-undocumented) Missing documentation for "new". +// src/events/index.d.ts:23:9 - (ae-undocumented) Missing documentation for "truncated". +// src/events/index.d.ts:24:9 - (ae-undocumented) Missing documentation for "created". +// src/events/index.d.ts:25:9 - (ae-undocumented) Missing documentation for "forced". +// src/events/index.d.ts:26:9 - (ae-undocumented) Missing documentation for "closed". +// src/events/index.d.ts:27:9 - (ae-undocumented) Missing documentation for "links". +// src/events/index.d.ts:28:9 - (ae-undocumented) Missing documentation for "commits". +// src/events/index.d.ts:31:5 - (ae-undocumented) Missing documentation for "ChangeLinks". +// src/events/index.d.ts:32:9 - (ae-undocumented) Missing documentation for "commits". +// src/events/index.d.ts:33:9 - (ae-undocumented) Missing documentation for "diff". +// src/events/index.d.ts:34:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:13:1 - (ae-undocumented) Missing documentation for "Models". +// src/models/index.d.ts:19:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:20:9 - (ae-undocumented) Missing documentation for "display_name". +// src/models/index.d.ts:21:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:22:9 - (ae-undocumented) Missing documentation for "username". +// src/models/index.d.ts:23:9 - (ae-undocumented) Missing documentation for "uuid". +// src/models/index.d.ts:30:9 - (ae-undocumented) Missing documentation for "__index". +// src/models/index.d.ts:31:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:42:9 - (ae-undocumented) Missing documentation for "user". +// src/models/index.d.ts:49:9 - (ae-undocumented) Missing documentation for "author". +// src/models/index.d.ts:50:9 - (ae-undocumented) Missing documentation for "date". +// src/models/index.d.ts:51:9 - (ae-undocumented) Missing documentation for "hash". +// src/models/index.d.ts:52:9 - (ae-undocumented) Missing documentation for "message". +// src/models/index.d.ts:53:9 - (ae-undocumented) Missing documentation for "parents". +// src/models/index.d.ts:54:9 - (ae-undocumented) Missing documentation for "summary". +// src/models/index.d.ts:59:5 - (ae-undocumented) Missing documentation for "BaseCommitSummary". +// src/models/index.d.ts:92:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:97:9 - (ae-undocumented) Missing documentation for "target". +// src/models/index.d.ts:98:9 - (ae-undocumented) Missing documentation for "type". +// src/models/index.d.ts:127:9 - (ae-undocumented) Missing documentation for "participants". +// src/models/index.d.ts:128:9 - (ae-undocumented) Missing documentation for "repository". +// src/models/index.d.ts:135:9 - (ae-undocumented) Missing documentation for "__index". +// src/models/index.d.ts:136:9 - (ae-undocumented) Missing documentation for "attributes". +// src/models/index.d.ts:137:9 - (ae-undocumented) Missing documentation for "commit". +// src/models/index.d.ts:146:9 - (ae-undocumented) Missing documentation for "type". +// src/models/index.d.ts:151:11 - (ae-undocumented) Missing documentation for "CommitFileAttributesEnum". +// src/models/index.d.ts:161:5 - (ae-undocumented) Missing documentation for "CommitFileAttributesEnum". +// src/models/index.d.ts:167:9 - (ae-undocumented) Missing documentation for "href". +// src/models/index.d.ts:168:9 - (ae-undocumented) Missing documentation for "name". +// src/models/index.d.ts:175:9 - (ae-undocumented) Missing documentation for "__index". +// src/models/index.d.ts:176:9 - (ae-undocumented) Missing documentation for "type". +// src/models/index.d.ts:243:9 - (ae-undocumented) Missing documentation for "approved". +// src/models/index.d.ts:248:9 - (ae-undocumented) Missing documentation for "role". +// src/models/index.d.ts:249:9 - (ae-undocumented) Missing documentation for "state". +// src/models/index.d.ts:250:9 - (ae-undocumented) Missing documentation for "user". +// src/models/index.d.ts:255:11 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". +// src/models/index.d.ts:262:5 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". +// src/models/index.d.ts:266:11 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". +// src/models/index.d.ts:274:5 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". +// src/models/index.d.ts:281:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:282:9 - (ae-undocumented) Missing documentation for "description". +// src/models/index.d.ts:300:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:305:9 - (ae-undocumented) Missing documentation for "owner". +// src/models/index.d.ts:306:9 - (ae-undocumented) Missing documentation for "updated_on". +// src/models/index.d.ts:315:5 - (ae-undocumented) Missing documentation for "ProjectLinks". +// src/models/index.d.ts:316:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:317:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:322:5 - (ae-undocumented) Missing documentation for "RefLinks". +// src/models/index.d.ts:323:9 - (ae-undocumented) Missing documentation for "commits". +// src/models/index.d.ts:324:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:325:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:332:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:333:9 - (ae-undocumented) Missing documentation for "description". +// src/models/index.d.ts:362:9 - (ae-undocumented) Missing documentation for "is_private". +// src/models/index.d.ts:363:9 - (ae-undocumented) Missing documentation for "language". +// src/models/index.d.ts:364:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:365:9 - (ae-undocumented) Missing documentation for "mainbranch". +// src/models/index.d.ts:366:9 - (ae-undocumented) Missing documentation for "name". +// src/models/index.d.ts:367:9 - (ae-undocumented) Missing documentation for "owner". +// src/models/index.d.ts:368:9 - (ae-undocumented) Missing documentation for "parent". +// src/models/index.d.ts:369:9 - (ae-undocumented) Missing documentation for "project". +// src/models/index.d.ts:370:9 - (ae-undocumented) Missing documentation for "scm". +// src/models/index.d.ts:371:9 - (ae-undocumented) Missing documentation for "size". +// src/models/index.d.ts:376:9 - (ae-undocumented) Missing documentation for "updated_on". +// src/models/index.d.ts:411:11 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". +// src/models/index.d.ts:417:5 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". +// src/models/index.d.ts:421:5 - (ae-undocumented) Missing documentation for "RepositoryLinks". +// src/models/index.d.ts:422:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:423:9 - (ae-undocumented) Missing documentation for "clone". +// src/models/index.d.ts:424:9 - (ae-undocumented) Missing documentation for "commits". +// src/models/index.d.ts:425:9 - (ae-undocumented) Missing documentation for "downloads". +// src/models/index.d.ts:426:9 - (ae-undocumented) Missing documentation for "forks". +// src/models/index.d.ts:427:9 - (ae-undocumented) Missing documentation for "hooks". +// src/models/index.d.ts:428:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:429:9 - (ae-undocumented) Missing documentation for "pullrequests". +// src/models/index.d.ts:430:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:431:9 - (ae-undocumented) Missing documentation for "watchers". +// src/models/index.d.ts:436:5 - (ae-undocumented) Missing documentation for "SearchCodeSearchResult". +// src/models/index.d.ts:437:9 - (ae-undocumented) Missing documentation for "content_match_count". +// src/models/index.d.ts:438:9 - (ae-undocumented) Missing documentation for "content_matches". +// src/models/index.d.ts:439:9 - (ae-undocumented) Missing documentation for "file". +// src/models/index.d.ts:440:9 - (ae-undocumented) Missing documentation for "path_matches". +// src/models/index.d.ts:441:9 - (ae-undocumented) Missing documentation for "type". +// src/models/index.d.ts:446:5 - (ae-undocumented) Missing documentation for "SearchContentMatch". +// src/models/index.d.ts:447:9 - (ae-undocumented) Missing documentation for "lines". +// src/models/index.d.ts:452:5 - (ae-undocumented) Missing documentation for "SearchLine". +// src/models/index.d.ts:453:9 - (ae-undocumented) Missing documentation for "line". +// src/models/index.d.ts:454:9 - (ae-undocumented) Missing documentation for "segments". +// src/models/index.d.ts:459:5 - (ae-undocumented) Missing documentation for "SearchResultPage". +// src/models/index.d.ts:460:9 - (ae-undocumented) Missing documentation for "query_substituted". +// src/models/index.d.ts:469:5 - (ae-undocumented) Missing documentation for "SearchSegment". +// src/models/index.d.ts:470:9 - (ae-undocumented) Missing documentation for "match". +// src/models/index.d.ts:471:9 - (ae-undocumented) Missing documentation for "text". +// src/models/index.d.ts:478:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:485:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:486:9 - (ae-undocumented) Missing documentation for "members". +// src/models/index.d.ts:487:9 - (ae-undocumented) Missing documentation for "projects". +// src/models/index.d.ts:488:9 - (ae-undocumented) Missing documentation for "repositories". +// src/models/index.d.ts:489:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:497:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:503:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:512:9 - (ae-undocumented) Missing documentation for "updated_on". +// src/models/index.d.ts:521:5 - (ae-undocumented) Missing documentation for "WorkspaceLinks". +// src/models/index.d.ts:522:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:523:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:524:9 - (ae-undocumented) Missing documentation for "members". +// src/models/index.d.ts:525:9 - (ae-undocumented) Missing documentation for "owners". +// src/models/index.d.ts:526:9 - (ae-undocumented) Missing documentation for "projects". +// src/models/index.d.ts:527:9 - (ae-undocumented) Missing documentation for "repositories". +// src/models/index.d.ts:528:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:529:9 - (ae-undocumented) Missing documentation for "snippets". +// src/pagination.d.ts:3:1 - (ae-undocumented) Missing documentation for "PaginationOptions". +// src/pagination.d.ts:8:1 - (ae-undocumented) Missing documentation for "WithPagination". +// src/pagination.d.ts:12:5 - (ae-undocumented) Missing documentation for "getPage". +// src/pagination.d.ts:13:5 - (ae-undocumented) Missing documentation for "iteratePages". +// src/pagination.d.ts:14:5 - (ae-undocumented) Missing documentation for "iterateResults". +// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "FilterAndSortOptions". +// src/types.d.ts:8:1 - (ae-undocumented) Missing documentation for "PartialResponseOptions". +// src/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "RequestOptions". +``` diff --git a/plugins/catalog-backend-module-aws/api-report-alpha.md b/plugins/catalog-backend-module-aws/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-aws/api-report-alpha.md rename to plugins/catalog-backend-module-aws/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-aws/api-report.md b/plugins/catalog-backend-module-aws/api-report.api.md similarity index 74% rename from plugins/catalog-backend-module-aws/api-report.md rename to plugins/catalog-backend-module-aws/api-report.api.md index 98d757270e..2f5a9bb105 100644 --- a/plugins/catalog-backend-module-aws/api-report.md +++ b/plugins/catalog-backend-module-aws/api-report.api.md @@ -89,7 +89,6 @@ export class AwsS3DiscoveryProcessor implements CatalogProcessor { // @public export class AwsS3EntityProvider implements EntityProvider { - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( @@ -100,7 +99,6 @@ export class AwsS3EntityProvider implements EntityProvider { scheduler?: SchedulerService; }, ): AwsS3EntityProvider[]; - // (undocumented) getProviderName(): string; // (undocumented) refresh(logger: LoggerService): Promise; @@ -114,4 +112,17 @@ export type EksClusterEntityTransformer = ( cluster: Cluster, accountId: string, ) => Promise; + +// Warnings were encountered during analysis: +// +// src/processors/AwsEKSClusterProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/AwsEKSClusterProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/AwsEKSClusterProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/processors/AwsOrganizationCloudAccountProcessor.d.ts:17:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/AwsOrganizationCloudAccountProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/AwsOrganizationCloudAccountProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/processors/AwsS3DiscoveryProcessor.d.ts:15:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/AwsS3DiscoveryProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/providers/AwsS3EntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/AwsS3EntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-azure/api-report-alpha.md b/plugins/catalog-backend-module-azure/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-azure/api-report-alpha.md rename to plugins/catalog-backend-module-azure/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-azure/api-report.md b/plugins/catalog-backend-module-azure/api-report.api.md similarity index 74% rename from plugins/catalog-backend-module-azure/api-report.md rename to plugins/catalog-backend-module-azure/api-report.api.md index 9220b08ab4..78f9a29d1d 100644 --- a/plugins/catalog-backend-module-azure/api-report.md +++ b/plugins/catalog-backend-module-azure/api-report.api.md @@ -39,7 +39,6 @@ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor { // @public export class AzureDevOpsEntityProvider implements EntityProvider { - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( @@ -50,9 +49,16 @@ export class AzureDevOpsEntityProvider implements EntityProvider { scheduler?: SchedulerService; }, ): AzureDevOpsEntityProvider[]; - // (undocumented) getProviderName(): string; // (undocumented) refresh(logger: LoggerService): Promise; } + +// Warnings were encountered during analysis: +// +// src/processors/AzureDevOpsDiscoveryProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/AzureDevOpsDiscoveryProcessor.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/AzureDevOpsDiscoveryProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/providers/AzureDevOpsEntityProvider.d.ts:19:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/AzureDevOpsEntityProvider.d.ts:30:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-backstage-openapi/api-report.md b/plugins/catalog-backend-module-backstage-openapi/api-report.api.md similarity index 65% rename from plugins/catalog-backend-module-backstage-openapi/api-report.md rename to plugins/catalog-backend-module-backstage-openapi/api-report.api.md index 06334182cb..88ad499e84 100644 --- a/plugins/catalog-backend-module-backstage-openapi/api-report.md +++ b/plugins/catalog-backend-module-backstage-openapi/api-report.api.md @@ -18,5 +18,11 @@ export type MetaApiDocsPluginOptions = { // @public (undocumented) export const metaOpenApiDocsPluginId = 'meta-api-docs'; +// Warnings were encountered during analysis: +// +// src/index.d.ts:4:1 - (ae-undocumented) Missing documentation for "MetaApiDocsPluginOptions". +// src/index.d.ts:10:22 - (ae-undocumented) Missing documentation for "metaOpenApiDocsPluginId". +// src/index.d.ts:14:22 - (ae-undocumented) Missing documentation for "catalogModuleInternalOpenApiSpec". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.md b/plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md similarity index 69% rename from plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.md rename to plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md index 34ec7a692a..3f0a2d1514 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md @@ -9,5 +9,9 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const catalogModuleBitbucketCloudEntityProvider: BackendFeature; export default catalogModuleBitbucketCloudEntityProvider; +// Warnings were encountered during analysis: +// +// src/module/catalogModuleBitbucketCloudEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketCloudEntityProvider". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report.md b/plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md similarity index 79% rename from plugins/catalog-backend-module-bitbucket-cloud/api-report.md rename to plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md index bba0b754e2..47e8184aea 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/api-report.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md @@ -16,7 +16,6 @@ import { TokenManager } from '@backstage/backend-common'; // @public export class BitbucketCloudEntityProvider implements EntityProvider { - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( @@ -30,13 +29,17 @@ export class BitbucketCloudEntityProvider implements EntityProvider { tokenManager?: TokenManager; }, ): BitbucketCloudEntityProvider[]; - // (undocumented) getProviderName(): string; - // (undocumented) getTaskId(): string; // (undocumented) onRepoPush(event: Events.RepoPushEvent): Promise; // (undocumented) refresh(logger: LoggerService): Promise; } + +// Warnings were encountered during analysis: +// +// src/providers/BitbucketCloudEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/BitbucketCloudEntityProvider.d.ts:45:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/BitbucketCloudEntityProvider.d.ts:48:5 - (ae-undocumented) Missing documentation for "onRepoPush". ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report-alpha.md b/plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md similarity index 68% rename from plugins/catalog-backend-module-bitbucket-server/api-report-alpha.md rename to plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md index 7edb314814..49648580f8 100644 --- a/plugins/catalog-backend-module-bitbucket-server/api-report-alpha.md +++ b/plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md @@ -9,5 +9,9 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const catalogModuleBitbucketServerEntityProvider: BackendFeature; export default catalogModuleBitbucketServerEntityProvider; +// Warnings were encountered during analysis: +// +// src/module/catalogModuleBitbucketServerEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketServerEntityProvider". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report.md b/plugins/catalog-backend-module-bitbucket-server/api-report.api.md similarity index 70% rename from plugins/catalog-backend-module-bitbucket-server/api-report.md rename to plugins/catalog-backend-module-bitbucket-server/api-report.api.md index 211096639c..a269d91d93 100644 --- a/plugins/catalog-backend-module-bitbucket-server/api-report.md +++ b/plugins/catalog-backend-module-bitbucket-server/api-report.api.md @@ -49,7 +49,6 @@ export class BitbucketServerClient { // @public export class BitbucketServerEntityProvider implements EntityProvider { - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( @@ -61,7 +60,6 @@ export class BitbucketServerEntityProvider implements EntityProvider { scheduler?: SchedulerService; }, ): BitbucketServerEntityProvider[]; - // (undocumented) getProviderName(): string; // (undocumented) refresh(logger: LoggerService): Promise; @@ -111,4 +109,19 @@ export type BitbucketServerRepository = { >; archived: boolean; }; + +// Warnings were encountered during analysis: +// +// src/lib/BitbucketServerClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/lib/BitbucketServerClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "listProjects". +// src/lib/BitbucketServerClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "listRepositories". +// src/lib/BitbucketServerClient.d.ts:24:5 - (ae-undocumented) Missing documentation for "getFile". +// src/lib/BitbucketServerClient.d.ts:29:5 - (ae-undocumented) Missing documentation for "getRepository". +// src/lib/BitbucketServerClient.d.ts:33:5 - (ae-undocumented) Missing documentation for "resolvePath". +// src/lib/BitbucketServerClient.d.ts:48:1 - (ae-undocumented) Missing documentation for "BitbucketServerListOptions". +// src/lib/BitbucketServerClient.d.ts:56:1 - (ae-undocumented) Missing documentation for "BitbucketServerPagedResponse". +// src/lib/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BitbucketServerRepository". +// src/lib/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "BitbucketServerProject". +// src/providers/BitbucketServerEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/BitbucketServerEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-gcp/api-report-alpha.md b/plugins/catalog-backend-module-gcp/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gcp/api-report-alpha.md rename to plugins/catalog-backend-module-gcp/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-gcp/api-report.md b/plugins/catalog-backend-module-gcp/api-report.api.md similarity index 71% rename from plugins/catalog-backend-module-gcp/api-report.md rename to plugins/catalog-backend-module-gcp/api-report.api.md index 6260d07c88..cf490f09ae 100644 --- a/plugins/catalog-backend-module-gcp/api-report.md +++ b/plugins/catalog-backend-module-gcp/api-report.api.md @@ -46,4 +46,12 @@ export class GkeEntityProvider implements EntityProvider { // (undocumented) refresh(): Promise; } + +// Warnings were encountered during analysis: +// +// src/providers/GkeEntityProvider.d.ts:17:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GkeEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfigWithClient". +// src/providers/GkeEntityProvider.d.ts:28:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GkeEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "connect". +// src/providers/GkeEntityProvider.d.ts:35:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-gerrit/api-report-alpha.md b/plugins/catalog-backend-module-gerrit/api-report-alpha.api.md similarity index 69% rename from plugins/catalog-backend-module-gerrit/api-report-alpha.md rename to plugins/catalog-backend-module-gerrit/api-report-alpha.api.md index 02aceb07c6..0774a27299 100644 --- a/plugins/catalog-backend-module-gerrit/api-report-alpha.md +++ b/plugins/catalog-backend-module-gerrit/api-report-alpha.api.md @@ -9,5 +9,9 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const catalogModuleGerritEntityProvider: BackendFeature; export default catalogModuleGerritEntityProvider; +// Warnings were encountered during analysis: +// +// src/module/catalogModuleGerritEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleGerritEntityProvider". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gerrit/api-report.md b/plugins/catalog-backend-module-gerrit/api-report.api.md similarity index 65% rename from plugins/catalog-backend-module-gerrit/api-report.md rename to plugins/catalog-backend-module-gerrit/api-report.api.md index abf2a83e7b..29c8af4212 100644 --- a/plugins/catalog-backend-module-gerrit/api-report.md +++ b/plugins/catalog-backend-module-gerrit/api-report.api.md @@ -29,5 +29,13 @@ export class GerritEntityProvider implements EntityProvider { refresh(logger: LoggerService): Promise; } +// Warnings were encountered during analysis: +// +// src/providers/GerritEntityProvider.d.ts:6:1 - (ae-undocumented) Missing documentation for "GerritEntityProvider". +// src/providers/GerritEntityProvider.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GerritEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GerritEntityProvider.d.ts:19:5 - (ae-undocumented) Missing documentation for "connect". +// src/providers/GerritEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "refresh". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github-org/api-report.md b/plugins/catalog-backend-module-github-org/api-report.api.md similarity index 100% rename from plugins/catalog-backend-module-github-org/api-report.md rename to plugins/catalog-backend-module-github-org/api-report.api.md diff --git a/plugins/catalog-backend-module-github/api-report-alpha.md b/plugins/catalog-backend-module-github/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-github/api-report-alpha.md rename to plugins/catalog-backend-module-github/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-github/api-report.md b/plugins/catalog-backend-module-github/api-report.api.md similarity index 70% rename from plugins/catalog-backend-module-github/api-report.md rename to plugins/catalog-backend-module-github/api-report.api.md index 025d845644..ff118b92f8 100644 --- a/plugins/catalog-backend-module-github/api-report.md +++ b/plugins/catalog-backend-module-github/api-report.api.md @@ -83,7 +83,6 @@ export class GitHubEntityProvider implements EntityProvider { // @public export class GithubEntityProvider implements EntityProvider, EventSubscriber { - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( @@ -95,13 +94,10 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { scheduler?: SchedulerService; }, ): GithubEntityProvider[]; - // (undocumented) getProviderName(): string; - // (undocumented) onEvent(params: EventParams): Promise; // (undocumented) refresh(logger: LoggerService): Promise; - // (undocumented) supportsEventTopics(): string[]; } @@ -154,14 +150,12 @@ export class GithubMultiOrgEntityProvider implements EntityProvider { teamTransformer?: TeamTransformer; alwaysUseDefaultNamespace?: boolean; }); - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( config: Config, options: GithubMultiOrgEntityProviderOptions, ): GithubMultiOrgEntityProvider; - // (undocumented) getProviderName(): string; read(options?: { logger?: LoggerService }): Promise; } @@ -231,14 +225,12 @@ export class GithubOrgEntityProvider implements EntityProvider { userTransformer?: UserTransformer; teamTransformer?: TeamTransformer; }); - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( config: Config, options: GithubOrgEntityProviderOptions, ): GithubOrgEntityProvider; - // (undocumented) getProviderName(): string; read(options?: { logger?: LoggerService }): Promise; } @@ -326,4 +318,41 @@ export type UserTransformer = ( item: GithubUser, ctx: TransformerContext, ) => Promise; + +// Warnings were encountered during analysis: +// +// src/analyzers/GithubLocationAnalyzer.d.ts:7:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzerOptions". +// src/analyzers/GithubLocationAnalyzer.d.ts:15:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzer". +// src/analyzers/GithubLocationAnalyzer.d.ts:21:5 - (ae-undocumented) Missing documentation for "supports". +// src/analyzers/GithubLocationAnalyzer.d.ts:22:5 - (ae-undocumented) Missing documentation for "analyze". +// src/deprecated.d.ts:10:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProvider". +// src/deprecated.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/deprecated.d.ts:17:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProviderOptions". +// src/deprecated.d.ts:22:1 - (ae-undocumented) Missing documentation for "GitHubEntityProvider". +// src/deprecated.d.ts:24:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/deprecated.d.ts:30:5 - (ae-undocumented) Missing documentation for "connect". +// src/deprecated.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/deprecated.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". +// src/lib/defaultTransformers.d.ts:10:5 - (ae-undocumented) Missing documentation for "client". +// src/lib/defaultTransformers.d.ts:11:5 - (ae-undocumented) Missing documentation for "query". +// src/lib/defaultTransformers.d.ts:12:5 - (ae-undocumented) Missing documentation for "org". +// src/processors/GithubDiscoveryProcessor.d.ts:25:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/GithubDiscoveryProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/GithubDiscoveryProcessor.d.ts:35:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/processors/GithubMultiOrgReaderProcessor.d.ts:19:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/GithubMultiOrgReaderProcessor.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/GithubMultiOrgReaderProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/processors/GithubOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/GithubOrgReaderProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/GithubOrgReaderProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/providers/GithubEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GithubEntityProvider.d.ts:34:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/GithubEntityProvider.d.ts:52:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:61:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:72:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:82:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:94:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:103:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubMultiOrgEntityProvider.d.ts:85:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GithubOrgEntityProvider.d.ts:71:5 - (ae-undocumented) Missing documentation for "fromConfig". ``` diff --git a/plugins/catalog-backend-module-gitlab-org/api-report.md b/plugins/catalog-backend-module-gitlab-org/api-report.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab-org/api-report.md rename to plugins/catalog-backend-module-gitlab-org/api-report.api.md diff --git a/plugins/catalog-backend-module-gitlab/api-report-alpha.md b/plugins/catalog-backend-module-gitlab/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab/api-report-alpha.md rename to plugins/catalog-backend-module-gitlab/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-gitlab/api-report.md b/plugins/catalog-backend-module-gitlab/api-report.api.md similarity index 65% rename from plugins/catalog-backend-module-gitlab/api-report.md rename to plugins/catalog-backend-module-gitlab/api-report.api.md index b2c71c787b..143d4b5823 100644 --- a/plugins/catalog-backend-module-gitlab/api-report.md +++ b/plugins/catalog-backend-module-gitlab/api-report.api.md @@ -171,4 +171,29 @@ export interface UserTransformerOptions { // (undocumented) user: GitLabUser; } + +// Warnings were encountered during analysis: +// +// src/GitLabDiscoveryProcessor.d.ts:14:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/GitLabDiscoveryProcessor.d.ts:20:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/GitLabDiscoveryProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/lib/types.d.ts:48:1 - (ae-undocumented) Missing documentation for "GitLabGroupSamlIdentity". +// src/lib/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "group". +// src/lib/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "providerConfig". +// src/lib/types.d.ts:208:5 - (ae-undocumented) Missing documentation for "user". +// src/lib/types.d.ts:209:5 - (ae-undocumented) Missing documentation for "integrationConfig". +// src/lib/types.d.ts:210:5 - (ae-undocumented) Missing documentation for "providerConfig". +// src/lib/types.d.ts:211:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". +// src/lib/types.d.ts:225:5 - (ae-undocumented) Missing documentation for "groups". +// src/lib/types.d.ts:226:5 - (ae-undocumented) Missing documentation for "providerConfig". +// src/lib/types.d.ts:227:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:34:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:35:5 - (ae-undocumented) Missing documentation for "connect". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:76:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' +// src/providers/GitlabDiscoveryEntityProvider.d.ts:77:30 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag +// src/providers/GitlabDiscoveryEntityProvider.d.ts:77:17 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" +// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "connect". ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.md b/plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.md rename to plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report.md b/plugins/catalog-backend-module-incremental-ingestion/api-report.api.md similarity index 82% rename from plugins/catalog-backend-module-incremental-ingestion/api-report.md rename to plugins/catalog-backend-module-incremental-ingestion/api-report.api.md index 22b497b2f7..5f2abb5f60 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/api-report.md +++ b/plugins/catalog-backend-module-incremental-ingestion/api-report.api.md @@ -94,4 +94,12 @@ export type PluginEnvironment = { reader: UrlReaderService; permissions: PermissionEvaluator; }; + +// Warnings were encountered during analysis: +// +// src/service/IncrementalCatalogBuilder.d.ts:6:1 - (ae-undocumented) Missing documentation for "IncrementalCatalogBuilder". +// src/service/IncrementalCatalogBuilder.d.ts:20:5 - (ae-undocumented) Missing documentation for "build". +// src/service/IncrementalCatalogBuilder.d.ts:23:5 - (ae-undocumented) Missing documentation for "addIncrementalEntityProvider". +// src/types.d.ts:107:1 - (ae-undocumented) Missing documentation for "IncrementalEntityProviderOptions". +// src/types.d.ts:146:1 - (ae-undocumented) Missing documentation for "PluginEnvironment". ``` diff --git a/plugins/catalog-backend-module-ldap/api-report.md b/plugins/catalog-backend-module-ldap/api-report.api.md similarity index 100% rename from plugins/catalog-backend-module-ldap/api-report.md rename to plugins/catalog-backend-module-ldap/api-report.api.md diff --git a/plugins/catalog-backend-module-logs/api-report.md b/plugins/catalog-backend-module-logs/api-report.api.md similarity index 100% rename from plugins/catalog-backend-module-logs/api-report.md rename to plugins/catalog-backend-module-logs/api-report.api.md diff --git a/plugins/catalog-backend-module-msgraph/api-report-alpha.md b/plugins/catalog-backend-module-msgraph/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-msgraph/api-report-alpha.md rename to plugins/catalog-backend-module-msgraph/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.api.md similarity index 90% rename from plugins/catalog-backend-module-msgraph/api-report.md rename to plugins/catalog-backend-module-msgraph/api-report.api.md index acc3b8531b..449825df37 100644 --- a/plugins/catalog-backend-module-msgraph/api-report.md +++ b/plugins/catalog-backend-module-msgraph/api-report.api.md @@ -128,14 +128,12 @@ export class MicrosoftGraphOrgEntityProvider implements EntityProvider { organizationTransformer?: OrganizationTransformer; providerConfigTransformer?: ProviderConfigTransformer; }); - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( configRoot: Config, options: MicrosoftGraphOrgEntityProviderOptions, ): MicrosoftGraphOrgEntityProvider[]; - // (undocumented) getProviderName(): string; read(options?: { logger?: LoggerService }): Promise; } @@ -292,4 +290,14 @@ export type UserTransformer = ( user: MicrosoftGraph.User, userPhoto?: string, ) => Promise; + +// Warnings were encountered during analysis: +// +// src/microsoftGraph/client.d.ts:109:5 - (ae-undocumented) Missing documentation for "getUserPhoto". +// src/microsoftGraph/client.d.ts:129:5 - (ae-undocumented) Missing documentation for "getGroupPhoto". +// src/microsoftGraph/client.d.ts:176:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-msgraph" does not have an export "entityName" +// src/processors/MicrosoftGraphOrgEntityProvider.d.ts:120:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:32:5 - (ae-undocumented) Missing documentation for "readLocation". ``` diff --git a/plugins/catalog-backend-module-openapi/api-report.md b/plugins/catalog-backend-module-openapi/api-report.api.md similarity index 71% rename from plugins/catalog-backend-module-openapi/api-report.md rename to plugins/catalog-backend-module-openapi/api-report.api.md index d79d852387..c913e63294 100644 --- a/plugins/catalog-backend-module-openapi/api-report.md +++ b/plugins/catalog-backend-module-openapi/api-report.api.md @@ -47,5 +47,14 @@ export class OpenApiRefProcessor implements CatalogProcessor { preProcessEntity(entity: Entity, location: LocationSpec): Promise; } +// Warnings were encountered during analysis: +// +// src/OpenApiRefProcessor.d.ts:12:1 - (ae-undocumented) Missing documentation for "OpenApiRefProcessor". +// src/OpenApiRefProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/OpenApiRefProcessor.d.ts:25:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/OpenApiRefProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "preProcessEntity". +// src/index.d.ts:8:22 - (ae-undocumented) Missing documentation for "openApiPlaceholderResolver". +// src/jsonSchemaRefPlaceholderResolver.d.ts:4:1 - (ae-undocumented) Missing documentation for "jsonSchemaRefPlaceholderResolver". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-puppetdb/api-report-alpha.md b/plugins/catalog-backend-module-puppetdb/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-puppetdb/api-report-alpha.md rename to plugins/catalog-backend-module-puppetdb/api-report-alpha.api.md diff --git a/plugins/catalog-backend-module-puppetdb/api-report.md b/plugins/catalog-backend-module-puppetdb/api-report.api.md similarity index 68% rename from plugins/catalog-backend-module-puppetdb/api-report.md rename to plugins/catalog-backend-module-puppetdb/api-report.api.md index 691b752a6b..1b22398086 100644 --- a/plugins/catalog-backend-module-puppetdb/api-report.md +++ b/plugins/catalog-backend-module-puppetdb/api-report.api.md @@ -24,7 +24,6 @@ export const defaultResourceTransformer: ResourceTransformer; // @public export class PuppetDbEntityProvider implements EntityProvider { - // (undocumented) connect(connection: EntityProviderConnection): Promise; static fromConfig( config: Config, @@ -35,7 +34,6 @@ export class PuppetDbEntityProvider implements EntityProvider { transformer?: ResourceTransformer; }, ): PuppetDbEntityProvider[]; - // (undocumented) getProviderName(): string; refresh(logger: LoggerService): Promise; } @@ -77,4 +75,12 @@ export type ResourceTransformer = ( node: PuppetNode, config: PuppetDbEntityProviderConfig, ) => Promise; + +// Warnings were encountered during analysis: +// +// src/providers/PuppetDbEntityProvider.d.ts:40:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/PuppetDbEntityProvider.d.ts:42:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "LoggerService" +// src/providers/PuppetDbEntityProvider.d.ts:42:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "TaskRunner" +// src/providers/PuppetDbEntityProvider.d.ts:52:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/PuppetDbEntityProvider.d.ts:54:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "TaskRunner" ``` diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/api-report.md b/plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md similarity index 70% rename from plugins/catalog-backend-module-scaffolder-entity-model/api-report.md rename to plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md index 49542b0396..e4af5d5ef5 100644 --- a/plugins/catalog-backend-module-scaffolder-entity-model/api-report.md +++ b/plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md @@ -26,4 +26,10 @@ export class ScaffolderEntitiesProcessor implements CatalogProcessor { // (undocumented) validateEntityKind(entity: Entity): Promise; } + +// Warnings were encountered during analysis: +// +// src/processor/ScaffolderEntitiesProcessor.d.ts:10:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processor/ScaffolderEntitiesProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "validateEntityKind". +// src/processor/ScaffolderEntitiesProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "postProcessEntity". ``` diff --git a/plugins/catalog-backend-module-unprocessed/api-report.md b/plugins/catalog-backend-module-unprocessed/api-report.api.md similarity index 79% rename from plugins/catalog-backend-module-unprocessed/api-report.md rename to plugins/catalog-backend-module-unprocessed/api-report.api.md index 493082ac7c..ea3a9d974c 100644 --- a/plugins/catalog-backend-module-unprocessed/api-report.md +++ b/plugins/catalog-backend-module-unprocessed/api-report.api.md @@ -27,4 +27,9 @@ export class UnprocessedEntitiesModule { // (undocumented) registerRoutes(): void; } + +// Warnings were encountered during analysis: +// +// src/UnprocessedEntitiesModule.d.ts:15:5 - (ae-undocumented) Missing documentation for "create". +// src/UnprocessedEntitiesModule.d.ts:26:5 - (ae-undocumented) Missing documentation for "registerRoutes". ``` diff --git a/plugins/catalog-backend/api-report-alpha.md b/plugins/catalog-backend/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-backend/api-report-alpha.md rename to plugins/catalog-backend/api-report-alpha.api.md diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.api.md similarity index 67% rename from plugins/catalog-backend/api-report.md rename to plugins/catalog-backend/api-report.api.md index 7717066d2a..1c3949adfa 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.api.md @@ -478,4 +478,85 @@ export class UrlReaderProcessor implements CatalogProcessor_2 { cache: CatalogProcessorCache_2, ): Promise; } + +// Warnings were encountered during analysis: +// +// src/constants.d.ts:2:22 - (ae-undocumented) Missing documentation for "CATALOG_CONFLICTS_TOPIC". +// src/constants.d.ts:4:22 - (ae-undocumented) Missing documentation for "CATALOG_ERRORS_TOPIC". +// src/deprecated.d.ts:8:22 - (ae-undocumented) Missing documentation for "locationSpecToMetadataName". +// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "locationSpecToLocationEntity". +// src/deprecated.d.ts:18:22 - (ae-undocumented) Missing documentation for "processingResult". +// src/deprecated.d.ts:31:1 - (ae-undocumented) Missing documentation for "EntitiesSearchFilter". +// src/deprecated.d.ts:36:1 - (ae-undocumented) Missing documentation for "EntityFilter". +// src/deprecated.d.ts:41:1 - (ae-undocumented) Missing documentation for "DeferredEntity". +// src/deprecated.d.ts:46:1 - (ae-undocumented) Missing documentation for "EntityRelationSpec". +// src/deprecated.d.ts:51:1 - (ae-undocumented) Missing documentation for "CatalogProcessor". +// src/deprecated.d.ts:56:1 - (ae-undocumented) Missing documentation for "CatalogProcessorParser". +// src/deprecated.d.ts:61:1 - (ae-undocumented) Missing documentation for "CatalogProcessorCache". +// src/deprecated.d.ts:66:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEmit". +// src/deprecated.d.ts:71:1 - (ae-undocumented) Missing documentation for "CatalogProcessorLocationResult". +// src/deprecated.d.ts:76:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEntityResult". +// src/deprecated.d.ts:81:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRelationResult". +// src/deprecated.d.ts:86:1 - (ae-undocumented) Missing documentation for "CatalogProcessorErrorResult". +// src/deprecated.d.ts:91:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRefreshKeysResult". +// src/deprecated.d.ts:96:1 - (ae-undocumented) Missing documentation for "CatalogProcessorResult". +// src/deprecated.d.ts:101:1 - (ae-undocumented) Missing documentation for "EntityProvider". +// src/deprecated.d.ts:106:1 - (ae-undocumented) Missing documentation for "EntityProviderConnection". +// src/deprecated.d.ts:111:1 - (ae-undocumented) Missing documentation for "EntityProviderMutation". +// src/deprecated.d.ts:129:1 - (ae-undocumented) Missing documentation for "AnalyzeOptions". +// src/deprecated.d.ts:134:1 - (ae-undocumented) Missing documentation for "LocationAnalyzer". +// src/deprecated.d.ts:139:1 - (ae-undocumented) Missing documentation for "ScmLocationAnalyzer". +// src/deprecated.d.ts:144:1 - (ae-undocumented) Missing documentation for "PlaceholderResolver". +// src/deprecated.d.ts:149:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverParams". +// src/deprecated.d.ts:154:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverRead". +// src/deprecated.d.ts:159:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverResolveUrl". +// src/deprecated.d.ts:164:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationRequest". +// src/deprecated.d.ts:169:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationResponse". +// src/deprecated.d.ts:202:22 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactory". +// src/deprecated.d.ts:207:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". +// src/deprecated.d.ts:212:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". +// src/deprecated.d.ts:217:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:9:1 - (ae-undocumented) Missing documentation for "CodeOwnersProcessor". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:23:5 - (ae-undocumented) Missing documentation for "preProcessEntity". +// src/modules/core/AnnotateLocationEntityProcessor.d.ts:6:1 - (ae-undocumented) Missing documentation for "AnnotateLocationEntityProcessor". +// src/modules/core/AnnotateLocationEntityProcessor.d.ts:11:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/AnnotateLocationEntityProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "preProcessEntity". +// src/modules/core/AnnotateScmSlugEntityProcessor.d.ts:7:1 - (ae-undocumented) Missing documentation for "AnnotateScmSlugEntityProcessor". +// src/modules/core/AnnotateScmSlugEntityProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/AnnotateScmSlugEntityProcessor.d.ts:14:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/modules/core/AnnotateScmSlugEntityProcessor.d.ts:17:5 - (ae-undocumented) Missing documentation for "preProcessEntity". +// src/modules/core/BuiltinKindsEntityProcessor.d.ts:5:1 - (ae-undocumented) Missing documentation for "BuiltinKindsEntityProcessor". +// src/modules/core/BuiltinKindsEntityProcessor.d.ts:7:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/BuiltinKindsEntityProcessor.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateEntityKind". +// src/modules/core/BuiltinKindsEntityProcessor.d.ts:9:5 - (ae-undocumented) Missing documentation for "postProcessEntity". +// src/modules/core/FileReaderProcessor.d.ts:4:1 - (ae-undocumented) Missing documentation for "FileReaderProcessor". +// src/modules/core/FileReaderProcessor.d.ts:5:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/FileReaderProcessor.d.ts:6:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/modules/core/LocationEntityProcessor.d.ts:10:1 - (ae-undocumented) Missing documentation for "LocationEntityProcessorOptions". +// src/modules/core/LocationEntityProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/LocationEntityProcessor.d.ts:29:5 - (ae-undocumented) Missing documentation for "postProcessEntity". +// src/modules/core/PlaceholderProcessor.d.ts:8:1 - (ae-undocumented) Missing documentation for "PlaceholderProcessorOptions". +// src/modules/core/PlaceholderProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/PlaceholderProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "preProcessEntity". +// src/modules/core/UrlReaderProcessor.d.ts:6:1 - (ae-undocumented) Missing documentation for "UrlReaderProcessor". +// src/modules/core/UrlReaderProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/UrlReaderProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/modules/util/parse.d.ts:5:1 - (ae-undocumented) Missing documentation for "parseEntityYaml". +// src/processing/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "start". +// src/processing/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "stop". +// src/search/DefaultCatalogCollator.d.ts:11:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollator". +// src/search/DefaultCatalogCollator.d.ts:12:5 - (ae-undocumented) Missing documentation for "discovery". +// src/search/DefaultCatalogCollator.d.ts:13:5 - (ae-undocumented) Missing documentation for "locationTemplate". +// src/search/DefaultCatalogCollator.d.ts:14:5 - (ae-undocumented) Missing documentation for "filter". +// src/search/DefaultCatalogCollator.d.ts:15:5 - (ae-undocumented) Missing documentation for "catalogClient". +// src/search/DefaultCatalogCollator.d.ts:16:5 - (ae-undocumented) Missing documentation for "type". +// src/search/DefaultCatalogCollator.d.ts:17:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/search/DefaultCatalogCollator.d.ts:18:5 - (ae-undocumented) Missing documentation for "tokenManager". +// src/search/DefaultCatalogCollator.d.ts:19:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/search/DefaultCatalogCollator.d.ts:31:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". +// src/search/DefaultCatalogCollator.d.ts:33:5 - (ae-undocumented) Missing documentation for "execute". +// src/service/CatalogBuilder.d.ts:19:1 - (ae-undocumented) Missing documentation for "CatalogEnvironment". +// src/service/CatalogBuilder.d.ts:232:5 - (ae-undocumented) Missing documentation for "subscribe". ``` diff --git a/plugins/catalog-common/api-report-alpha.md b/plugins/catalog-common/api-report-alpha.api.md similarity index 100% rename from plugins/catalog-common/api-report-alpha.md rename to plugins/catalog-common/api-report-alpha.api.md diff --git a/plugins/catalog-common/api-report.md b/plugins/catalog-common/api-report.api.md similarity index 60% rename from plugins/catalog-common/api-report.md rename to plugins/catalog-common/api-report.api.md index 231c8aac34..95b1d9b6c6 100644 --- a/plugins/catalog-common/api-report.md +++ b/plugins/catalog-common/api-report.api.md @@ -64,4 +64,16 @@ export type LocationSpec = { target: string; presence?: 'optional' | 'required'; }; + +// Warnings were encountered during analysis: +// +// src/ingestion/LocationAnalyzer.d.ts:5:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationRequest". +// src/ingestion/LocationAnalyzer.d.ts:10:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationResponse". +// src/ingestion/LocationAnalyzer.d.ts:39:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationEntityField". +// src/search/CatalogEntityDocument.d.ts:9:5 - (ae-undocumented) Missing documentation for "componentType". +// src/search/CatalogEntityDocument.d.ts:10:5 - (ae-undocumented) Missing documentation for "type". +// src/search/CatalogEntityDocument.d.ts:11:5 - (ae-undocumented) Missing documentation for "namespace". +// src/search/CatalogEntityDocument.d.ts:12:5 - (ae-undocumented) Missing documentation for "kind". +// src/search/CatalogEntityDocument.d.ts:13:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/search/CatalogEntityDocument.d.ts:14:5 - (ae-undocumented) Missing documentation for "owner". ``` diff --git a/plugins/catalog-graph/api-report-alpha.md b/plugins/catalog-graph/api-report-alpha.api.md similarity index 97% rename from plugins/catalog-graph/api-report-alpha.md rename to plugins/catalog-graph/api-report-alpha.api.md index f4699e9ceb..8d0137fed7 100644 --- a/plugins/catalog-graph/api-report-alpha.md +++ b/plugins/catalog-graph/api-report-alpha.api.md @@ -165,5 +165,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-graph/api-report.md b/plugins/catalog-graph/api-report.api.md similarity index 95% rename from plugins/catalog-graph/api-report.md rename to plugins/catalog-graph/api-report.api.md index fc40e5b6c4..44f0f93e1e 100644 --- a/plugins/catalog-graph/api-report.md +++ b/plugins/catalog-graph/api-report.api.md @@ -138,4 +138,8 @@ export type EntityRelationsGraphProps = { // @public export type RelationPairs = [string, string][]; + +// Warnings were encountered during analysis: +// +// src/components/EntityRelationsGraph/EntityRelationsGraph.d.ts:9:1 - (ae-undocumented) Missing documentation for "EntityRelationsGraphProps". ``` diff --git a/plugins/catalog-import/api-report-alpha.md b/plugins/catalog-import/api-report-alpha.api.md similarity index 93% rename from plugins/catalog-import/api-report-alpha.md rename to plugins/catalog-import/api-report-alpha.api.md index 1706404b94..a70d8c46c8 100644 --- a/plugins/catalog-import/api-report-alpha.md +++ b/plugins/catalog-import/api-report-alpha.api.md @@ -67,5 +67,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-import/api-report.md b/plugins/catalog-import/api-report.api.md similarity index 62% rename from plugins/catalog-import/api-report.md rename to plugins/catalog-import/api-report.api.md index c61aa97b06..8c26da769d 100644 --- a/plugins/catalog-import/api-report.md +++ b/plugins/catalog-import/api-report.api.md @@ -366,4 +366,46 @@ export interface StepPrepareCreatePullRequestProps { // Warnings were encountered during analysis: // // src/api/CatalogImportApi.d.ts:25:5 - (ae-forgotten-export) The symbol "PartialEntity" needs to be exported by the entry point index.d.ts +// src/api/CatalogImportApi.d.ts:33:5 - (ae-undocumented) Missing documentation for "analyzeUrl". +// src/api/CatalogImportApi.d.ts:34:5 - (ae-undocumented) Missing documentation for "preparePullRequest". +// src/api/CatalogImportApi.d.ts:38:5 - (ae-undocumented) Missing documentation for "submitPullRequest". +// src/api/CatalogImportClient.d.ts:26:5 - (ae-undocumented) Missing documentation for "analyzeUrl". +// src/api/CatalogImportClient.d.ts:27:5 - (ae-undocumented) Missing documentation for "preparePullRequest". +// src/api/CatalogImportClient.d.ts:31:5 - (ae-undocumented) Missing documentation for "submitPullRequest". +// src/components/EntityListComponent/EntityListComponent.d.ts:9:5 - (ae-undocumented) Missing documentation for "locations". +// src/components/EntityListComponent/EntityListComponent.d.ts:13:5 - (ae-undocumented) Missing documentation for "locationListItemIcon". +// src/components/EntityListComponent/EntityListComponent.d.ts:14:5 - (ae-undocumented) Missing documentation for "collapsed". +// src/components/EntityListComponent/EntityListComponent.d.ts:15:5 - (ae-undocumented) Missing documentation for "firstListItem". +// src/components/EntityListComponent/EntityListComponent.d.ts:16:5 - (ae-undocumented) Missing documentation for "onItemClick". +// src/components/EntityListComponent/EntityListComponent.d.ts:17:5 - (ae-undocumented) Missing documentation for "withLinks". +// src/components/ImportInfoCard/ImportInfoCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "exampleLocationUrl". +// src/components/ImportInfoCard/ImportInfoCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "exampleRepositoryUrl". +// src/components/ImportStepper/ImportStepper.d.ts:11:5 - (ae-undocumented) Missing documentation for "initialUrl". +// src/components/ImportStepper/ImportStepper.d.ts:12:5 - (ae-undocumented) Missing documentation for "generateStepper". +// src/components/ImportStepper/ImportStepper.d.ts:13:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:10:5 - (ae-undocumented) Missing documentation for "onAnalysis". +// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:13:5 - (ae-undocumented) Missing documentation for "disablePullRequest". +// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:14:5 - (ae-undocumented) Missing documentation for "analysisUrl". +// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:15:5 - (ae-undocumented) Missing documentation for "exampleLocationUrl". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:10:5 - (ae-undocumented) Missing documentation for "name". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:11:5 - (ae-undocumented) Missing documentation for "options". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:12:5 - (ae-undocumented) Missing documentation for "required". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:13:5 - (ae-undocumented) Missing documentation for "errors". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:14:5 - (ae-undocumented) Missing documentation for "rules". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:15:5 - (ae-undocumented) Missing documentation for "loading". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:16:5 - (ae-undocumented) Missing documentation for "loadingText". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:17:5 - (ae-undocumented) Missing documentation for "helperText". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:18:5 - (ae-undocumented) Missing documentation for "errorHelperText". +// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:19:5 - (ae-undocumented) Missing documentation for "textFieldProps". +// src/components/StepPrepareCreatePullRequest/PreviewCatalogInfoComponent.d.ts:9:5 - (ae-undocumented) Missing documentation for "repositoryUrl". +// src/components/StepPrepareCreatePullRequest/PreviewCatalogInfoComponent.d.ts:10:5 - (ae-undocumented) Missing documentation for "entities". +// src/components/StepPrepareCreatePullRequest/PreviewCatalogInfoComponent.d.ts:11:5 - (ae-undocumented) Missing documentation for "classes". +// src/components/StepPrepareCreatePullRequest/PreviewPullRequestComponent.d.ts:8:5 - (ae-undocumented) Missing documentation for "title". +// src/components/StepPrepareCreatePullRequest/PreviewPullRequestComponent.d.ts:9:5 - (ae-undocumented) Missing documentation for "description". +// src/components/StepPrepareCreatePullRequest/PreviewPullRequestComponent.d.ts:10:5 - (ae-undocumented) Missing documentation for "classes". +// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:20:5 - (ae-undocumented) Missing documentation for "analyzeResult". +// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:23:5 - (ae-undocumented) Missing documentation for "onPrepare". +// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:26:5 - (ae-undocumented) Missing documentation for "onGoBack". +// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:27:5 - (ae-undocumented) Missing documentation for "renderFormFields". +// src/components/useImportState.d.ts:80:1 - (ae-undocumented) Missing documentation for "ImportState". ``` diff --git a/plugins/catalog-node/api-report-alpha.md b/plugins/catalog-node/api-report-alpha.api.md similarity index 69% rename from plugins/catalog-node/api-report-alpha.md rename to plugins/catalog-node/api-report-alpha.api.md index ba02079ceb..6fc361896d 100644 --- a/plugins/catalog-node/api-report-alpha.md +++ b/plugins/catalog-node/api-report-alpha.api.md @@ -98,5 +98,23 @@ export const catalogProcessingExtensionPoint: ExtensionPoint; +// Warnings were encountered during analysis: +// +// src/extensions.d.ts:8:1 - (ae-undocumented) Missing documentation for "CatalogProcessingExtensionPoint". +// src/extensions.d.ts:9:5 - (ae-undocumented) Missing documentation for "addProcessor". +// src/extensions.d.ts:10:5 - (ae-undocumented) Missing documentation for "addEntityProvider". +// src/extensions.d.ts:11:5 - (ae-undocumented) Missing documentation for "addPlaceholderResolver". +// src/extensions.d.ts:12:5 - (ae-undocumented) Missing documentation for "setOnProcessingErrorHandler". +// src/extensions.d.ts:18:1 - (ae-undocumented) Missing documentation for "CatalogModelExtensionPoint". +// src/extensions.d.ts:36:22 - (ae-undocumented) Missing documentation for "catalogProcessingExtensionPoint". +// src/extensions.d.ts:40:1 - (ae-undocumented) Missing documentation for "CatalogAnalysisExtensionPoint". +// src/extensions.d.ts:63:22 - (ae-undocumented) Missing documentation for "catalogAnalysisExtensionPoint". +// src/extensions.d.ts:65:22 - (ae-undocumented) Missing documentation for "catalogModelExtensionPoint". +// src/extensions.d.ts:69:1 - (ae-undocumented) Missing documentation for "CatalogPermissionRuleInput". +// src/extensions.d.ts:73:1 - (ae-undocumented) Missing documentation for "CatalogPermissionExtensionPoint". +// src/extensions.d.ts:74:5 - (ae-undocumented) Missing documentation for "addPermissions". +// src/extensions.d.ts:75:5 - (ae-undocumented) Missing documentation for "addPermissionRules". +// src/extensions.d.ts:80:22 - (ae-undocumented) Missing documentation for "catalogPermissionExtensionPoint". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-node/api-report.md b/plugins/catalog-node/api-report.api.md similarity index 78% rename from plugins/catalog-node/api-report.md rename to plugins/catalog-node/api-report.api.md index 43209aa862..5c18c4756e 100644 --- a/plugins/catalog-node/api-report.md +++ b/plugins/catalog-node/api-report.api.md @@ -243,4 +243,22 @@ export type ScmLocationAnalyzer = { existing: AnalyzeLocationExistingEntity[]; }>; }; + +// Warnings were encountered during analysis: +// +// src/api/processor.d.ts:9:1 - (ae-undocumented) Missing documentation for "CatalogProcessor". +// src/api/processor.d.ts:104:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEmit". +// src/api/processor.d.ts:106:1 - (ae-undocumented) Missing documentation for "CatalogProcessorLocationResult". +// src/api/processor.d.ts:111:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEntityResult". +// src/api/processor.d.ts:117:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRelationResult". +// src/api/processor.d.ts:122:1 - (ae-undocumented) Missing documentation for "CatalogProcessorErrorResult". +// src/api/processor.d.ts:128:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRefreshKeysResult". +// src/api/processor.d.ts:133:1 - (ae-undocumented) Missing documentation for "CatalogProcessorResult". +// src/processing/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverRead". +// src/processing/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverResolveUrl". +// src/processing/types.d.ts:19:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverParams". +// src/processing/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "PlaceholderResolver". +// src/processing/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "LocationAnalyzer". +// src/processing/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "AnalyzeOptions". +// src/processing/types.d.ts:45:1 - (ae-undocumented) Missing documentation for "ScmLocationAnalyzer". ``` diff --git a/plugins/catalog-react/api-report-alpha.md b/plugins/catalog-react/api-report-alpha.api.md similarity index 95% rename from plugins/catalog-react/api-report-alpha.md rename to plugins/catalog-react/api-report-alpha.api.md index 516d655967..6873fa6cfa 100644 --- a/plugins/catalog-react/api-report-alpha.md +++ b/plugins/catalog-react/api-report-alpha.api.md @@ -221,5 +221,12 @@ export function useEntityPermission( error?: Error; }; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:9:22 - (ae-undocumented) Missing documentation for "catalogExtensionData". +// src/alpha.d.ts:15:1 - (ae-undocumented) Missing documentation for "createEntityCardExtension". +// src/alpha.d.ts:34:1 - (ae-undocumented) Missing documentation for "createEntityContentExtension". +// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogReactTranslationRef". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.api.md similarity index 65% rename from plugins/catalog-react/api-report.md rename to plugins/catalog-react/api-report.api.md index 0293fca239..aafe29e16d 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.api.md @@ -839,4 +839,115 @@ export function useStarredEntity( toggleStarredEntity: () => void; isStarredEntity: boolean; }; + +// Warnings were encountered during analysis: +// +// src/apis/StarredEntitiesApi/MockStarredEntitiesApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "toggleStarred". +// src/apis/StarredEntitiesApi/MockStarredEntitiesApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "starredEntitie$". +// src/components/CatalogFilterLayout/CatalogFilterLayout.d.ts:15:22 - (ae-undocumented) Missing documentation for "CatalogFilterLayout". +// src/components/DefaultFilters/DefaultFilters.d.ts:16:22 - (ae-undocumented) Missing documentation for "DefaultFilters". +// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:6:1 - (ae-undocumented) Missing documentation for "AllowedEntityFilters". +// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:12:1 - (ae-undocumented) Missing documentation for "EntityAutocompletePickerProps". +// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:25:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityAutocompletePickerClassKey". +// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:27:1 - (ae-undocumented) Missing documentation for "EntityAutocompletePicker". +// src/components/EntityKindPicker/EntityKindPicker.d.ts:13:5 - (ae-undocumented) Missing documentation for "initialFilter". +// src/components/EntityKindPicker/EntityKindPicker.d.ts:14:5 - (ae-undocumented) Missing documentation for "hidden". +// src/components/EntityKindPicker/EntityKindPicker.d.ts:17:22 - (ae-undocumented) Missing documentation for "EntityKindPicker". +// src/components/EntityLifecyclePicker/EntityLifecyclePicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityLifecyclePickerClassKey". +// src/components/EntityLifecyclePicker/EntityLifecyclePicker.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityLifecyclePicker". +// src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityNamespacePickerClassKey". +// src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:10:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". +// src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:13:22 - (ae-undocumented) Missing documentation for "EntityNamespacePicker". +// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityOwnerPickerClassKey". +// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:7:1 - (ae-undocumented) Missing documentation for "EntityOwnerPickerProps". +// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:11:22 - (ae-undocumented) Missing documentation for "EntityOwnerPicker". +// src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityProcessingStatusPickerClassKey". +// src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityProcessingStatusPicker". +// src/components/EntityRefLink/humanize.d.ts:8:1 - (ae-undocumented) Missing documentation for "humanizeEntityRef". +// src/components/EntitySearchBar/EntitySearchBar.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntitySearchBarClassKey". +// src/components/EntityTable/EntityTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "title". +// src/components/EntityTable/EntityTable.d.ts:11:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/EntityTable/EntityTable.d.ts:12:5 - (ae-undocumented) Missing documentation for "entities". +// src/components/EntityTable/EntityTable.d.ts:13:5 - (ae-undocumented) Missing documentation for "emptyContent". +// src/components/EntityTable/EntityTable.d.ts:14:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/EntityTable/EntityTable.d.ts:15:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/EntityTable/columns.d.ts:4:22 - (ae-undocumented) Missing documentation for "columnFactories". +// src/components/EntityTagPicker/EntityTagPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityTagPickerClassKey". +// src/components/EntityTagPicker/EntityTagPicker.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntityTagPickerProps". +// src/components/EntityTagPicker/EntityTagPicker.d.ts:9:22 - (ae-undocumented) Missing documentation for "EntityTagPicker". +// src/components/EntityTypePicker/EntityTypePicker.d.ts:8:5 - (ae-undocumented) Missing documentation for "initialFilter". +// src/components/EntityTypePicker/EntityTypePicker.d.ts:9:5 - (ae-undocumented) Missing documentation for "hidden". +// src/components/EntityTypePicker/EntityTypePicker.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityTypePicker". +// src/components/FavoriteEntity/FavoriteEntity.d.ts:5:1 - (ae-undocumented) Missing documentation for "FavoriteEntityProps". +// src/components/MissingAnnotationEmptyState/MissingAnnotationEmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyStateClassKey". +// src/components/UnregisterEntityDialog/UnregisterEntityDialog.d.ts:4:1 - (ae-undocumented) Missing documentation for "UnregisterEntityDialogProps". +// src/components/UnregisterEntityDialog/UnregisterEntityDialog.d.ts:11:22 - (ae-undocumented) Missing documentation for "UnregisterEntityDialog". +// src/components/UserListPicker/UserListPicker.d.ts:5:1 - (ae-undocumented) Missing documentation for "CatalogReactUserListPickerClassKey". +// src/components/UserListPicker/UserListPicker.d.ts:15:1 - (ae-undocumented) Missing documentation for "UserListPickerProps". +// src/components/UserListPicker/UserListPicker.d.ts:20:22 - (ae-undocumented) Missing documentation for "UserListPicker". +// src/filters.d.ts:8:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:10:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:11:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:18:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:20:5 - (ae-undocumented) Missing documentation for "getTypes". +// src/filters.d.ts:21:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:22:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:29:5 - (ae-undocumented) Missing documentation for "values". +// src/filters.d.ts:31:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:32:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:33:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:40:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:42:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:43:5 - (ae-undocumented) Missing documentation for "getFullTextFilters". +// src/filters.d.ts:47:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:57:5 - (ae-undocumented) Missing documentation for "values". +// src/filters.d.ts:59:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:60:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:72:5 - (ae-undocumented) Missing documentation for "values". +// src/filters.d.ts:74:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:75:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:76:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:83:5 - (ae-undocumented) Missing documentation for "values". +// src/filters.d.ts:85:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:86:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:87:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:92:1 - (ae-undocumented) Missing documentation for "EntityUserFilter". +// src/filters.d.ts:93:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:94:5 - (ae-undocumented) Missing documentation for "refs". +// src/filters.d.ts:96:5 - (ae-undocumented) Missing documentation for "owned". +// src/filters.d.ts:97:5 - (ae-undocumented) Missing documentation for "all". +// src/filters.d.ts:98:5 - (ae-undocumented) Missing documentation for "starred". +// src/filters.d.ts:99:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:100:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:101:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:109:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:110:5 - (ae-undocumented) Missing documentation for "isOwnedEntity". +// src/filters.d.ts:111:5 - (ae-undocumented) Missing documentation for "isStarredEntity". +// src/filters.d.ts:113:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:114:5 - (ae-undocumented) Missing documentation for "toQueryValue". +// src/filters.d.ts:121:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:123:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". +// src/filters.d.ts:124:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/filters.d.ts:131:5 - (ae-undocumented) Missing documentation for "value". +// src/filters.d.ts:133:5 - (ae-undocumented) Missing documentation for "filterEntity". +// src/hooks/useEntity.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntityLoadingStatus". +// src/hooks/useEntity.d.ts:16:5 - (ae-undocumented) Missing documentation for "children". +// src/hooks/useEntity.d.ts:17:5 - (ae-undocumented) Missing documentation for "entity". +// src/hooks/useEntity.d.ts:18:5 - (ae-undocumented) Missing documentation for "loading". +// src/hooks/useEntity.d.ts:19:5 - (ae-undocumented) Missing documentation for "error". +// src/hooks/useEntity.d.ts:20:5 - (ae-undocumented) Missing documentation for "refresh". +// src/hooks/useEntity.d.ts:34:5 - (ae-undocumented) Missing documentation for "children". +// src/hooks/useEntity.d.ts:35:5 - (ae-undocumented) Missing documentation for "entity". +// src/hooks/useEntityListProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "DefaultEntityFilters". +// src/hooks/useEntityListProvider.d.ts:18:1 - (ae-undocumented) Missing documentation for "EntityListContextProps". +// src/hooks/useEntityListProvider.d.ts:57:1 - (ae-undocumented) Missing documentation for "EntityListProviderProps". +// src/hooks/useStarredEntities.d.ts:3:1 - (ae-undocumented) Missing documentation for "useStarredEntities". +// src/hooks/useStarredEntity.d.ts:3:1 - (ae-undocumented) Missing documentation for "useStarredEntity". +// src/overridableComponents.d.ts:6:1 - (ae-undocumented) Missing documentation for "CatalogReactComponentsNameToClassKey". +// src/overridableComponents.d.ts:17:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". +// src/testUtils/providers.d.ts:4:1 - (ae-undocumented) Missing documentation for "MockEntityListContextProvider". +// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityFilter". +// src/types.d.ts:25:1 - (ae-undocumented) Missing documentation for "UserListFilterKind". +// src/utils/getEntitySourceLocation.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntitySourceLocation". +// src/utils/getEntitySourceLocation.d.ts:9:1 - (ae-undocumented) Missing documentation for "getEntitySourceLocation". ``` diff --git a/plugins/catalog-unprocessed-entities-common/api-report.md b/plugins/catalog-unprocessed-entities-common/api-report.api.md similarity index 100% rename from plugins/catalog-unprocessed-entities-common/api-report.md rename to plugins/catalog-unprocessed-entities-common/api-report.api.md diff --git a/plugins/catalog-unprocessed-entities/api-report.md b/plugins/catalog-unprocessed-entities/api-report.api.md similarity index 91% rename from plugins/catalog-unprocessed-entities/api-report.md rename to plugins/catalog-unprocessed-entities/api-report.api.md index 7d8f6299da..dd0386204a 100644 --- a/plugins/catalog-unprocessed-entities/api-report.md +++ b/plugins/catalog-unprocessed-entities/api-report.api.md @@ -73,5 +73,9 @@ export type UnprocessedEntityError = { }; }; +// Warnings were encountered during analysis: +// +// src/components/UnprocessedEntities.d.ts:3:22 - (ae-undocumented) Missing documentation for "UnprocessedEntitiesContent". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog/api-report-alpha.md b/plugins/catalog/api-report-alpha.api.md similarity index 98% rename from plugins/catalog/api-report-alpha.md rename to plugins/catalog/api-report-alpha.api.md index b448ae9288..0dd7778dc3 100644 --- a/plugins/catalog/api-report-alpha.md +++ b/plugins/catalog/api-report-alpha.api.md @@ -870,5 +870,11 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha/createCatalogFilterExtension.d.ts:4:1 - (ae-undocumented) Missing documentation for "createCatalogFilterExtension". +// src/alpha/plugin.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". +// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogTranslationRef". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.api.md similarity index 58% rename from plugins/catalog/api-report.md rename to plugins/catalog/api-report.api.md index 4017e8d494..2d149c4c51 100644 --- a/plugins/catalog/api-report.md +++ b/plugins/catalog/api-report.api.md @@ -265,7 +265,6 @@ export class DefaultEntityPresentationApi implements EntityPresentationApi { options: DefaultEntityPresentationApiOptions, ): EntityPresentationApi; static createLocal(): EntityPresentationApi; - // (undocumented) forEntity( entityOrRef: Entity | string, context?: { @@ -668,4 +667,114 @@ export type SystemDiagramCardClassKey = | 'componentNode' | 'apiNode' | 'resourceNode'; + +// Warnings were encountered during analysis: +// +// src/apis/StarredEntitiesApi/DefaultStarredEntitiesApi.d.ts:15:5 - (ae-undocumented) Missing documentation for "toggleStarred". +// src/apis/StarredEntitiesApi/DefaultStarredEntitiesApi.d.ts:16:5 - (ae-undocumented) Missing documentation for "starredEntitie$". +// src/components/AboutCard/AboutCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/AboutCard/AboutContent.d.ts:9:5 - (ae-undocumented) Missing documentation for "entity". +// src/components/AboutCard/AboutContent.d.ts:12:1 - (ae-undocumented) Missing documentation for "AboutContent". +// src/components/AboutCard/AboutField.d.ts:8:5 - (ae-undocumented) Missing documentation for "label". +// src/components/AboutCard/AboutField.d.ts:9:5 - (ae-undocumented) Missing documentation for "value". +// src/components/AboutCard/AboutField.d.ts:10:5 - (ae-undocumented) Missing documentation for "gridSizes". +// src/components/AboutCard/AboutField.d.ts:11:5 - (ae-undocumented) Missing documentation for "children". +// src/components/AboutCard/AboutField.d.ts:14:1 - (ae-undocumented) Missing documentation for "AboutField". +// src/components/CatalogKindHeader/CatalogKindHeader.d.ts:23:1 - (ae-undocumented) Missing documentation for "CatalogKindHeader". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:12:5 - (ae-undocumented) Missing documentation for "initiallySelectedFilter". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:13:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:14:5 - (ae-undocumented) Missing documentation for "actions". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:15:5 - (ae-undocumented) Missing documentation for "initialKind". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:16:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:17:5 - (ae-undocumented) Missing documentation for "emptyContent". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:18:5 - (ae-undocumented) Missing documentation for "ownerPickerMode". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:19:5 - (ae-undocumented) Missing documentation for "pagination". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:22:5 - (ae-undocumented) Missing documentation for "filters". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:23:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:9:5 - (ae-undocumented) Missing documentation for "icon". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:10:5 - (ae-undocumented) Missing documentation for "result". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:11:5 - (ae-undocumented) Missing documentation for "highlight". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:12:5 - (ae-undocumented) Missing documentation for "rank". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:13:5 - (ae-undocumented) Missing documentation for "lineClamp". +// src/components/CatalogTable/CatalogTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/CatalogTable/CatalogTable.d.ts:11:5 - (ae-undocumented) Missing documentation for "actions". +// src/components/CatalogTable/CatalogTable.d.ts:12:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/CatalogTable/CatalogTable.d.ts:13:5 - (ae-undocumented) Missing documentation for "emptyContent". +// src/components/CatalogTable/CatalogTable.d.ts:14:5 - (ae-undocumented) Missing documentation for "subtitle". +// src/components/CatalogTable/CatalogTable.d.ts:17:22 - (ae-undocumented) Missing documentation for "CatalogTable". +// src/components/CatalogTable/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "CatalogTableRow". +// src/components/CatalogTable/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "entity". +// src/components/CatalogTable/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "resolved". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "DependencyOfComponentsCardProps". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependsOnComponentsCardProps". +// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependsOnResourcesCardProps". +// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/EntityContextMenu/EntityContextMenu.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntityContextMenuClassKey". +// src/components/EntityLabelsCard/EntityLabelsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntityLabelsCardProps". +// src/components/EntityLabelsCard/EntityLabelsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/EntityLabelsCard/EntityLabelsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/EntityLayout/EntityLayout.d.ts:6:1 - (ae-undocumented) Missing documentation for "EntityLayoutRouteProps". +// src/components/EntityLayout/EntityLayout.d.ts:25:1 - (ae-undocumented) Missing documentation for "EntityLayoutProps". +// src/components/EntityLayout/EntityLayout.d.ts:26:5 - (ae-undocumented) Missing documentation for "UNSTABLE_extraContextMenuItems". +// src/components/EntityLayout/EntityLayout.d.ts:27:5 - (ae-undocumented) Missing documentation for "UNSTABLE_contextMenuOptions". +// src/components/EntityLayout/EntityLayout.d.ts:28:5 - (ae-undocumented) Missing documentation for "children". +// src/components/EntityLayout/EntityLayout.d.ts:29:5 - (ae-undocumented) Missing documentation for "NotFoundComponent". +// src/components/EntityLinksCard/EntityLinksCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntityLinksCardProps". +// src/components/EntityLinksCard/EntityLinksCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "cols". +// src/components/EntityLinksCard/EntityLinksCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/EntityLinksCard/EntityLinksEmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityLinksEmptyStateClassKey". +// src/components/EntityLinksCard/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "Breakpoint". +// src/components/EntityLinksCard/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "ColumnBreakpoints". +// src/components/EntitySwitch/EntitySwitch.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntitySwitchCaseProps". +// src/components/EntitySwitch/EntitySwitch.d.ts:6:5 - (ae-undocumented) Missing documentation for "if". +// src/components/EntitySwitch/EntitySwitch.d.ts:9:5 - (ae-undocumented) Missing documentation for "children". +// src/components/EntitySwitch/EntitySwitch.d.ts:16:5 - (ae-undocumented) Missing documentation for "children". +// src/components/EntitySwitch/EntitySwitch.d.ts:17:5 - (ae-undocumented) Missing documentation for "renderMultipleMatches". +// src/components/EntitySwitch/EntitySwitch.d.ts:20:22 - (ae-undocumented) Missing documentation for "EntitySwitch". +// src/components/EntitySwitch/conditions.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityPredicates". +// src/components/EntitySwitch/conditions.d.ts:4:5 - (ae-undocumented) Missing documentation for "kind". +// src/components/EntitySwitch/conditions.d.ts:5:5 - (ae-undocumented) Missing documentation for "type". +// src/components/FilteredEntityLayout/index.d.ts:6:22 - (ae-undocumented) Missing documentation for "FilteredEntityLayout". +// src/components/FilteredEntityLayout/index.d.ts:13:22 - (ae-undocumented) Missing documentation for "FilterContainer". +// src/components/FilteredEntityLayout/index.d.ts:24:22 - (ae-undocumented) Missing documentation for "EntityListContainer". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasComponentsCardProps". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasResourcesCardProps". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasSubcomponentsCardProps". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasSystemsCardProps". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/RelatedEntitiesCard/RelatedEntitiesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "RelatedEntitiesCardProps". +// src/components/SystemDiagramCard/SystemDiagramCard.d.ts:3:1 - (ae-undocumented) Missing documentation for "SystemDiagramCardClassKey". +// src/overridableComponents.d.ts:7:1 - (ae-undocumented) Missing documentation for "PluginCatalogComponentsNameToClassKey". +// src/overridableComponents.d.ts:13:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". +// src/plugin.d.ts:16:22 - (ae-undocumented) Missing documentation for "catalogPlugin". +// src/plugin.d.ts:37:22 - (ae-undocumented) Missing documentation for "CatalogIndexPage". +// src/plugin.d.ts:39:22 - (ae-undocumented) Missing documentation for "CatalogEntityPage". +// src/plugin.d.ts:54:22 - (ae-undocumented) Missing documentation for "EntityLinksCard". +// src/plugin.d.ts:56:22 - (ae-undocumented) Missing documentation for "EntityLabelsCard". +// src/plugin.d.ts:58:22 - (ae-undocumented) Missing documentation for "EntityHasSystemsCard". +// src/plugin.d.ts:60:22 - (ae-undocumented) Missing documentation for "EntityHasComponentsCard". +// src/plugin.d.ts:62:22 - (ae-undocumented) Missing documentation for "EntityHasSubcomponentsCard". +// src/plugin.d.ts:64:22 - (ae-undocumented) Missing documentation for "EntityHasResourcesCard". +// src/plugin.d.ts:66:22 - (ae-undocumented) Missing documentation for "EntityDependsOnComponentsCard". +// src/plugin.d.ts:68:22 - (ae-undocumented) Missing documentation for "EntityDependencyOfComponentsCard". +// src/plugin.d.ts:70:22 - (ae-undocumented) Missing documentation for "EntityDependsOnResourcesCard". +// src/plugin.d.ts:72:22 - (ae-undocumented) Missing documentation for "RelatedEntitiesCard". +// src/plugin.d.ts:74:22 - (ae-undocumented) Missing documentation for "CatalogSearchResultListItem". ``` diff --git a/plugins/config-schema/api-report.md b/plugins/config-schema/api-report.api.md similarity index 60% rename from plugins/config-schema/api-report.md rename to plugins/config-schema/api-report.api.md index 16630ae8d0..00a7a7fe0c 100644 --- a/plugins/config-schema/api-report.md +++ b/plugins/config-schema/api-report.api.md @@ -44,4 +44,15 @@ export class StaticSchemaLoader implements ConfigSchemaApi { // (undocumented) schema$(): Observable; } + +// Warnings were encountered during analysis: +// +// src/api/StaticSchemaLoader.d.ts:13:5 - (ae-undocumented) Missing documentation for "schema$". +// src/api/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "ConfigSchemaResult". +// src/api/types.d.ts:5:5 - (ae-undocumented) Missing documentation for "schema". +// src/api/types.d.ts:8:1 - (ae-undocumented) Missing documentation for "ConfigSchemaApi". +// src/api/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "schema$". +// src/api/types.d.ts:12:22 - (ae-undocumented) Missing documentation for "configSchemaApiRef". +// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "configSchemaPlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConfigSchemaPage". ``` diff --git a/plugins/devtools-backend/api-report.md b/plugins/devtools-backend/api-report.api.md similarity index 59% rename from plugins/devtools-backend/api-report.md rename to plugins/devtools-backend/api-report.api.md index 5fceda3d46..f150975beb 100644 --- a/plugins/devtools-backend/api-report.md +++ b/plugins/devtools-backend/api-report.api.md @@ -48,4 +48,19 @@ export interface RouterOptions { // (undocumented) permissions: PermissionsService; } + +// Warnings were encountered during analysis: +// +// src/api/DevToolsBackendApi.d.ts:5:1 - (ae-undocumented) Missing documentation for "DevToolsBackendApi". +// src/api/DevToolsBackendApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "listExternalDependencyDetails". +// src/api/DevToolsBackendApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "listConfig". +// src/api/DevToolsBackendApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "listInfo". +// src/service/router.d.ts:6:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:7:5 - (ae-undocumented) Missing documentation for "devToolsBackendApi". +// src/service/router.d.ts:8:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "permissions". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:15:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/devtools-common/api-report.md b/plugins/devtools-common/api-report.api.md similarity index 56% rename from plugins/devtools-common/api-report.md rename to plugins/devtools-common/api-report.api.md index 83af75d11a..bf71f1b87a 100644 --- a/plugins/devtools-common/api-report.md +++ b/plugins/devtools-common/api-report.api.md @@ -73,4 +73,20 @@ export type PackageDependency = { name: string; versions: string; }; + +// Warnings were encountered during analysis: +// +// src/permissions.d.ts:4:22 - (ae-undocumented) Missing documentation for "devToolsAdministerPermission". +// src/permissions.d.ts:8:22 - (ae-undocumented) Missing documentation for "devToolsInfoReadPermission". +// src/permissions.d.ts:12:22 - (ae-undocumented) Missing documentation for "devToolsConfigReadPermission". +// src/permissions.d.ts:16:22 - (ae-undocumented) Missing documentation for "devToolsExternalDependenciesReadPermission". +// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "Endpoint". +// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "ExternalDependency". +// src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "DevToolsInfo". +// src/types.d.ts:25:1 - (ae-undocumented) Missing documentation for "PackageDependency". +// src/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "ExternalDependencyStatus". +// src/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "healthy". +// src/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "unhealthy". +// src/types.d.ts:35:1 - (ae-undocumented) Missing documentation for "ConfigInfo". +// src/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "ConfigError". ``` diff --git a/plugins/devtools/api-report-alpha.md b/plugins/devtools/api-report-alpha.api.md similarity index 94% rename from plugins/devtools/api-report-alpha.md rename to plugins/devtools/api-report-alpha.api.md index 1b026d1f78..5db9e75117 100644 --- a/plugins/devtools/api-report-alpha.md +++ b/plugins/devtools/api-report-alpha.api.md @@ -89,5 +89,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha/plugin.d.ts:12:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/devtools/api-report.md b/plugins/devtools/api-report.api.md similarity index 62% rename from plugins/devtools/api-report.md rename to plugins/devtools/api-report.api.md index bba36a5a9a..75dfdc32f6 100644 --- a/plugins/devtools/api-report.md +++ b/plugins/devtools/api-report.api.md @@ -57,4 +57,14 @@ export type SubRoute = { } >; }; + +// Warnings were encountered during analysis: +// +// src/components/Content/ConfigContent/ConfigContent.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConfigContent". +// src/components/Content/ExternalDependenciesContent/ExternalDependenciesContent.d.ts:5:22 - (ae-undocumented) Missing documentation for "ExternalDependenciesContent". +// src/components/Content/InfoContent/InfoContent.d.ts:3:22 - (ae-undocumented) Missing documentation for "InfoContent". +// src/components/DevToolsLayout/DevToolsLayout.d.ts:4:1 - (ae-undocumented) Missing documentation for "SubRoute". +// src/components/DevToolsLayout/DevToolsLayout.d.ts:13:1 - (ae-undocumented) Missing documentation for "DevToolsLayoutProps". +// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "devToolsPlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "DevToolsPage". ``` diff --git a/plugins/events-backend-module-aws-sqs/api-report-alpha.md b/plugins/events-backend-module-aws-sqs/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-aws-sqs/api-report-alpha.md rename to plugins/events-backend-module-aws-sqs/api-report-alpha.api.md diff --git a/plugins/events-backend-module-aws-sqs/api-report.md b/plugins/events-backend-module-aws-sqs/api-report.api.md similarity index 71% rename from plugins/events-backend-module-aws-sqs/api-report.md rename to plugins/events-backend-module-aws-sqs/api-report.api.md index ac806bf01b..eee183519d 100644 --- a/plugins/events-backend-module-aws-sqs/api-report.md +++ b/plugins/events-backend-module-aws-sqs/api-report.api.md @@ -20,4 +20,9 @@ export class AwsSqsConsumingEventPublisher { // (undocumented) start(): Promise; } + +// Warnings were encountered during analysis: +// +// src/publisher/AwsSqsConsumingEventPublisher.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/publisher/AwsSqsConsumingEventPublisher.d.ts:28:5 - (ae-undocumented) Missing documentation for "start". ``` diff --git a/plugins/events-backend-module-azure/api-report-alpha.md b/plugins/events-backend-module-azure/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-azure/api-report-alpha.md rename to plugins/events-backend-module-azure/api-report-alpha.api.md diff --git a/plugins/events-backend-module-azure/api-report.md b/plugins/events-backend-module-azure/api-report.api.md similarity index 70% rename from plugins/events-backend-module-azure/api-report.md rename to plugins/events-backend-module-azure/api-report.api.md index 66529ef2d4..0ad4d4e9fd 100644 --- a/plugins/events-backend-module-azure/api-report.md +++ b/plugins/events-backend-module-azure/api-report.api.md @@ -15,4 +15,9 @@ export class AzureDevOpsEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } + +// Warnings were encountered during analysis: +// +// src/router/AzureDevOpsEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". +// src/router/AzureDevOpsEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report-alpha.md b/plugins/events-backend-module-bitbucket-cloud/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-bitbucket-cloud/api-report-alpha.md rename to plugins/events-backend-module-bitbucket-cloud/api-report-alpha.api.md diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report.md b/plugins/events-backend-module-bitbucket-cloud/api-report.api.md similarity index 70% rename from plugins/events-backend-module-bitbucket-cloud/api-report.md rename to plugins/events-backend-module-bitbucket-cloud/api-report.api.md index ba4f61d739..51aa7f27cb 100644 --- a/plugins/events-backend-module-bitbucket-cloud/api-report.md +++ b/plugins/events-backend-module-bitbucket-cloud/api-report.api.md @@ -15,4 +15,9 @@ export class BitbucketCloudEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } + +// Warnings were encountered during analysis: +// +// src/router/BitbucketCloudEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". +// src/router/BitbucketCloudEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-gerrit/api-report-alpha.md b/plugins/events-backend-module-gerrit/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-gerrit/api-report-alpha.md rename to plugins/events-backend-module-gerrit/api-report-alpha.api.md diff --git a/plugins/events-backend-module-gerrit/api-report.md b/plugins/events-backend-module-gerrit/api-report.api.md similarity index 71% rename from plugins/events-backend-module-gerrit/api-report.md rename to plugins/events-backend-module-gerrit/api-report.api.md index c75857aa43..7a3f75ca6f 100644 --- a/plugins/events-backend-module-gerrit/api-report.md +++ b/plugins/events-backend-module-gerrit/api-report.api.md @@ -15,4 +15,9 @@ export class GerritEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } + +// Warnings were encountered during analysis: +// +// src/router/GerritEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". +// src/router/GerritEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-github/api-report-alpha.md b/plugins/events-backend-module-github/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-github/api-report-alpha.md rename to plugins/events-backend-module-github/api-report-alpha.api.md diff --git a/plugins/events-backend-module-github/api-report.md b/plugins/events-backend-module-github/api-report.api.md similarity index 76% rename from plugins/events-backend-module-github/api-report.md rename to plugins/events-backend-module-github/api-report.api.md index 5341f86039..a3b8adaaa5 100644 --- a/plugins/events-backend-module-github/api-report.md +++ b/plugins/events-backend-module-github/api-report.api.md @@ -22,4 +22,9 @@ export class GithubEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } + +// Warnings were encountered during analysis: +// +// src/router/GithubEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". +// src/router/GithubEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-gitlab/api-report-alpha.md b/plugins/events-backend-module-gitlab/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-gitlab/api-report-alpha.md rename to plugins/events-backend-module-gitlab/api-report-alpha.api.md diff --git a/plugins/events-backend-module-gitlab/api-report.md b/plugins/events-backend-module-gitlab/api-report.api.md similarity index 76% rename from plugins/events-backend-module-gitlab/api-report.md rename to plugins/events-backend-module-gitlab/api-report.api.md index f348436375..9753380364 100644 --- a/plugins/events-backend-module-gitlab/api-report.md +++ b/plugins/events-backend-module-gitlab/api-report.api.md @@ -20,4 +20,9 @@ export class GitlabEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } + +// Warnings were encountered during analysis: +// +// src/router/GitlabEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". +// src/router/GitlabEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-test-utils/api-report.api.md b/plugins/events-backend-test-utils/api-report.api.md new file mode 100644 index 0000000000..d88a9dbee0 --- /dev/null +++ b/plugins/events-backend-test-utils/api-report.api.md @@ -0,0 +1,86 @@ +## API Report File for "@backstage/plugin-events-backend-test-utils" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { EventBroker } from '@backstage/plugin-events-node'; +import { EventParams } from '@backstage/plugin-events-node'; +import { EventPublisher } from '@backstage/plugin-events-node'; +import { EventsService } from '@backstage/plugin-events-node'; +import { EventsServiceSubscribeOptions } from '@backstage/plugin-events-node'; +import { EventSubscriber } from '@backstage/plugin-events-node'; + +// @public @deprecated (undocumented) +export class TestEventBroker implements EventBroker { + // (undocumented) + publish(params: EventParams): Promise; + // (undocumented) + readonly published: EventParams[]; + // (undocumented) + subscribe( + ...subscribers: Array> + ): void; + // (undocumented) + readonly subscribed: EventSubscriber[]; +} + +// @public @deprecated (undocumented) +export class TestEventPublisher implements EventPublisher { + // (undocumented) + get eventBroker(): EventBroker | undefined; + // (undocumented) + setEventBroker(eventBroker: EventBroker): Promise; +} + +// @public (undocumented) +export class TestEventsService implements EventsService { + // (undocumented) + publish(params: EventParams): Promise; + // (undocumented) + get published(): EventParams[]; + // (undocumented) + reset(): void; + // (undocumented) + subscribe(options: EventsServiceSubscribeOptions): Promise; + // (undocumented) + get subscribed(): EventsServiceSubscribeOptions[]; +} + +// @public @deprecated (undocumented) +export class TestEventSubscriber implements EventSubscriber { + constructor(name: string, topics: string[]); + // (undocumented) + readonly name: string; + // (undocumented) + onEvent(params: EventParams): Promise; + // (undocumented) + readonly receivedEvents: Record; + // (undocumented) + supportsEventTopics(): string[]; + // (undocumented) + readonly topics: string[]; +} + +// Warnings were encountered during analysis: +// +// src/testUtils/TestEventBroker.d.ts:6:1 - (ae-undocumented) Missing documentation for "TestEventBroker". +// src/testUtils/TestEventBroker.d.ts:7:5 - (ae-undocumented) Missing documentation for "published". +// src/testUtils/TestEventBroker.d.ts:8:5 - (ae-undocumented) Missing documentation for "subscribed". +// src/testUtils/TestEventBroker.d.ts:9:5 - (ae-undocumented) Missing documentation for "publish". +// src/testUtils/TestEventBroker.d.ts:10:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/testUtils/TestEventPublisher.d.ts:6:1 - (ae-undocumented) Missing documentation for "TestEventPublisher". +// src/testUtils/TestEventPublisher.d.ts:8:5 - (ae-undocumented) Missing documentation for "setEventBroker". +// src/testUtils/TestEventPublisher.d.ts:9:5 - (ae-undocumented) Missing documentation for "eventBroker". +// src/testUtils/TestEventSubscriber.d.ts:6:1 - (ae-undocumented) Missing documentation for "TestEventSubscriber". +// src/testUtils/TestEventSubscriber.d.ts:7:5 - (ae-undocumented) Missing documentation for "name". +// src/testUtils/TestEventSubscriber.d.ts:8:5 - (ae-undocumented) Missing documentation for "topics". +// src/testUtils/TestEventSubscriber.d.ts:9:5 - (ae-undocumented) Missing documentation for "receivedEvents". +// src/testUtils/TestEventSubscriber.d.ts:11:5 - (ae-undocumented) Missing documentation for "supportsEventTopics". +// src/testUtils/TestEventSubscriber.d.ts:12:5 - (ae-undocumented) Missing documentation for "onEvent". +// src/testUtils/TestEventsService.d.ts:3:1 - (ae-undocumented) Missing documentation for "TestEventsService". +// src/testUtils/TestEventsService.d.ts:5:5 - (ae-undocumented) Missing documentation for "publish". +// src/testUtils/TestEventsService.d.ts:6:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/testUtils/TestEventsService.d.ts:7:5 - (ae-undocumented) Missing documentation for "published". +// src/testUtils/TestEventsService.d.ts:8:5 - (ae-undocumented) Missing documentation for "subscribed". +// src/testUtils/TestEventsService.d.ts:9:5 - (ae-undocumented) Missing documentation for "reset". +``` diff --git a/plugins/events-backend-test-utils/api-report.md b/plugins/events-backend-test-utils/api-report.md deleted file mode 100644 index 9630c3d4e2..0000000000 --- a/plugins/events-backend-test-utils/api-report.md +++ /dev/null @@ -1,63 +0,0 @@ -## API Report File for "@backstage/plugin-events-backend-test-utils" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { EventBroker } from '@backstage/plugin-events-node'; -import { EventParams } from '@backstage/plugin-events-node'; -import { EventPublisher } from '@backstage/plugin-events-node'; -import { EventsService } from '@backstage/plugin-events-node'; -import { EventsServiceSubscribeOptions } from '@backstage/plugin-events-node'; -import { EventSubscriber } from '@backstage/plugin-events-node'; - -// @public @deprecated (undocumented) -export class TestEventBroker implements EventBroker { - // (undocumented) - publish(params: EventParams): Promise; - // (undocumented) - readonly published: EventParams[]; - // (undocumented) - subscribe( - ...subscribers: Array> - ): void; - // (undocumented) - readonly subscribed: EventSubscriber[]; -} - -// @public @deprecated (undocumented) -export class TestEventPublisher implements EventPublisher { - // (undocumented) - get eventBroker(): EventBroker | undefined; - // (undocumented) - setEventBroker(eventBroker: EventBroker): Promise; -} - -// @public (undocumented) -export class TestEventsService implements EventsService { - // (undocumented) - publish(params: EventParams): Promise; - // (undocumented) - get published(): EventParams[]; - // (undocumented) - reset(): void; - // (undocumented) - subscribe(options: EventsServiceSubscribeOptions): Promise; - // (undocumented) - get subscribed(): EventsServiceSubscribeOptions[]; -} - -// @public @deprecated (undocumented) -export class TestEventSubscriber implements EventSubscriber { - constructor(name: string, topics: string[]); - // (undocumented) - readonly name: string; - // (undocumented) - onEvent(params: EventParams): Promise; - // (undocumented) - readonly receivedEvents: Record; - // (undocumented) - supportsEventTopics(): string[]; - // (undocumented) - readonly topics: string[]; -} -``` diff --git a/plugins/events-backend/api-report-alpha.md b/plugins/events-backend/api-report-alpha.api.md similarity index 100% rename from plugins/events-backend/api-report-alpha.md rename to plugins/events-backend/api-report-alpha.api.md diff --git a/plugins/events-backend/api-report.md b/plugins/events-backend/api-report.api.md similarity index 70% rename from plugins/events-backend/api-report.md rename to plugins/events-backend/api-report.api.md index 8b5d4e8d31..5511d8c410 100644 --- a/plugins/events-backend/api-report.md +++ b/plugins/events-backend/api-report.api.md @@ -56,4 +56,14 @@ export class HttpPostIngressEventPublisher { logger: LoggerService; }): HttpPostIngressEventPublisher; } + +// Warnings were encountered during analysis: +// +// src/service/DefaultEventBroker.d.ts:21:5 - (ae-undocumented) Missing documentation for "publish". +// src/service/DefaultEventBroker.d.ts:22:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/service/EventsBackend.d.ts:14:5 - (ae-undocumented) Missing documentation for "setEventBroker". +// src/service/EventsBackend.d.ts:15:5 - (ae-undocumented) Missing documentation for "addPublishers". +// src/service/EventsBackend.d.ts:16:5 - (ae-undocumented) Missing documentation for "addSubscribers". +// src/service/http/HttpPostIngressEventPublisher.d.ts:15:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/service/http/HttpPostIngressEventPublisher.d.ts:24:5 - (ae-undocumented) Missing documentation for "bind". ``` diff --git a/plugins/events-node/api-report-alpha.md b/plugins/events-node/api-report-alpha.api.md similarity index 64% rename from plugins/events-node/api-report-alpha.md rename to plugins/events-node/api-report-alpha.api.md index f61048ac94..d11b170365 100644 --- a/plugins/events-node/api-report-alpha.md +++ b/plugins/events-node/api-report-alpha.api.md @@ -28,5 +28,14 @@ export interface EventsExtensionPoint { // @alpha (undocumented) export const eventsExtensionPoint: ExtensionPoint; +// Warnings were encountered during analysis: +// +// src/extensions.d.ts:5:1 - (ae-undocumented) Missing documentation for "EventsExtensionPoint". +// src/extensions.d.ts:9:5 - (ae-undocumented) Missing documentation for "setEventBroker". +// src/extensions.d.ts:13:5 - (ae-undocumented) Missing documentation for "addPublishers". +// src/extensions.d.ts:17:5 - (ae-undocumented) Missing documentation for "addSubscribers". +// src/extensions.d.ts:18:5 - (ae-undocumented) Missing documentation for "addHttpPostIngress". +// src/extensions.d.ts:23:22 - (ae-undocumented) Missing documentation for "eventsExtensionPoint". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-node/api-report.md b/plugins/events-node/api-report.api.md similarity index 63% rename from plugins/events-node/api-report.md rename to plugins/events-node/api-report.api.md index d8a2281faa..c885c7ec10 100644 --- a/plugins/events-node/api-report.md +++ b/plugins/events-node/api-report.api.md @@ -128,4 +128,26 @@ export abstract class SubTopicEventRouter extends EventRouter { // (undocumented) protected abstract determineSubTopic(params: EventParams): string | undefined; } + +// Warnings were encountered during analysis: +// +// src/api/DefaultEventsService.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". +// src/api/DefaultEventsService.d.ts:26:5 - (ae-undocumented) Missing documentation for "publish". +// src/api/DefaultEventsService.d.ts:27:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/api/EventParams.d.ts:4:1 - (ae-undocumented) Missing documentation for "EventParams". +// src/api/EventPublisher.d.ts:15:5 - (ae-undocumented) Missing documentation for "setEventBroker". +// src/api/EventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "getSubscriberId". +// src/api/EventRouter.d.ts:19:5 - (ae-undocumented) Missing documentation for "determineDestinationTopic". +// src/api/EventRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "onEvent". +// src/api/EventsService.d.ts:26:1 - (ae-undocumented) Missing documentation for "EventsServiceSubscribeOptions". +// src/api/EventsService.d.ts:37:1 - (ae-undocumented) Missing documentation for "EventsServiceEventHandler". +// src/api/SubTopicEventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "determineSubTopic". +// src/api/SubTopicEventRouter.d.ts:19:5 - (ae-undocumented) Missing documentation for "determineDestinationTopic". +// src/api/http/HttpPostIngressOptions.d.ts:5:1 - (ae-undocumented) Missing documentation for "HttpPostIngressOptions". +// src/api/http/HttpPostIngressOptions.d.ts:6:5 - (ae-undocumented) Missing documentation for "topic". +// src/api/http/HttpPostIngressOptions.d.ts:7:5 - (ae-undocumented) Missing documentation for "validator". +// src/api/http/validation/RequestDetails.d.ts:4:1 - (ae-undocumented) Missing documentation for "RequestDetails". +// src/api/http/validation/RequestRejectionDetails.d.ts:8:5 - (ae-undocumented) Missing documentation for "status". +// src/api/http/validation/RequestRejectionDetails.d.ts:9:5 - (ae-undocumented) Missing documentation for "payload". +// src/service.d.ts:10:22 - (ae-undocumented) Missing documentation for "eventsServiceFactory". ``` diff --git a/plugins/example-todo-list-backend/api-report.md b/plugins/example-todo-list-backend/api-report.api.md similarity index 100% rename from plugins/example-todo-list-backend/api-report.md rename to plugins/example-todo-list-backend/api-report.api.md diff --git a/plugins/example-todo-list-common/api-report.md b/plugins/example-todo-list-common/api-report.api.md similarity index 100% rename from plugins/example-todo-list-common/api-report.md rename to plugins/example-todo-list-common/api-report.api.md diff --git a/plugins/example-todo-list/api-report.md b/plugins/example-todo-list/api-report.api.md similarity index 100% rename from plugins/example-todo-list/api-report.md rename to plugins/example-todo-list/api-report.api.md diff --git a/plugins/home-react/api-report.md b/plugins/home-react/api-report.api.md similarity index 69% rename from plugins/home-react/api-report.md rename to plugins/home-react/api-report.api.md index 268f598a63..802d73605c 100644 --- a/plugins/home-react/api-report.md +++ b/plugins/home-react/api-report.api.md @@ -74,4 +74,15 @@ export const SettingsModal: (props: { componentName?: string; children: JSX.Element; }) => React_2.JSX.Element; + +// Warnings were encountered during analysis: +// +// src/components/SettingsModal.d.ts:3:22 - (ae-undocumented) Missing documentation for "SettingsModal". +// src/extensions.d.ts:6:1 - (ae-undocumented) Missing documentation for "ComponentRenderer". +// src/extensions.d.ts:12:1 - (ae-undocumented) Missing documentation for "ComponentParts". +// src/extensions.d.ts:21:1 - (ae-undocumented) Missing documentation for "RendererProps". +// src/extensions.d.ts:27:1 - (ae-undocumented) Missing documentation for "CardExtensionProps". +// src/extensions.d.ts:33:1 - (ae-undocumented) Missing documentation for "CardLayout". +// src/extensions.d.ts:48:1 - (ae-undocumented) Missing documentation for "CardSettings". +// src/extensions.d.ts:55:1 - (ae-undocumented) Missing documentation for "CardConfig". ``` diff --git a/plugins/home/api-report-alpha.md b/plugins/home/api-report-alpha.api.md similarity index 90% rename from plugins/home/api-report-alpha.md rename to plugins/home/api-report-alpha.api.md index 429af86a12..84c5082717 100644 --- a/plugins/home/api-report-alpha.md +++ b/plugins/home/api-report-alpha.api.md @@ -78,5 +78,10 @@ export const titleExtensionDataRef: ConfigurableExtensionDataRef< {} >; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "titleExtensionDataRef". +// src/alpha.d.ts:8:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/home/api-report.md b/plugins/home/api-report.api.md similarity index 75% rename from plugins/home/api-report.md rename to plugins/home/api-report.api.md index 023c649ab4..985aed50ca 100644 --- a/plugins/home/api-report.md +++ b/plugins/home/api-report.api.md @@ -327,4 +327,34 @@ export const WelcomeTitle: ({ export type WelcomeTitleLanguageProps = { language?: string[]; }; + +// Warnings were encountered during analysis: +// +// src/api/VisitsApi.d.ts:106:22 - (ae-undocumented) Missing documentation for "visitsApiRef". +// src/api/VisitsStorageApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "VisitsStorageApiOptions". +// src/api/VisitsStorageApi.d.ts:20:5 - (ae-undocumented) Missing documentation for "create". +// src/api/VisitsWebStorageApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "VisitsWebStorageApiOptions". +// src/api/VisitsWebStorageApi.d.ts:14:5 - (ae-undocumented) Missing documentation for "create". +// src/assets/TemplateBackstageLogo.d.ts:3:22 - (ae-undocumented) Missing documentation for "TemplateBackstageLogo". +// src/assets/TemplateBackstageLogoIcon.d.ts:3:22 - (ae-undocumented) Missing documentation for "TemplateBackstageLogoIcon". +// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "createCardExtension". +// src/deprecated.d.ts:12:1 - (ae-undocumented) Missing documentation for "CardExtensionProps". +// src/deprecated.d.ts:17:1 - (ae-undocumented) Missing documentation for "CardLayout". +// src/deprecated.d.ts:22:1 - (ae-undocumented) Missing documentation for "CardSettings". +// src/deprecated.d.ts:27:1 - (ae-undocumented) Missing documentation for "CardConfig". +// src/deprecated.d.ts:32:1 - (ae-undocumented) Missing documentation for "ComponentParts". +// src/deprecated.d.ts:37:1 - (ae-undocumented) Missing documentation for "ComponentRenderer". +// src/deprecated.d.ts:42:1 - (ae-undocumented) Missing documentation for "RendererProps". +// src/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "SettingsModal". +// src/homePageComponents/HeaderWorldClock/HeaderWorldClock.d.ts:3:1 - (ae-undocumented) Missing documentation for "ClockConfig". +// src/homePageComponents/Toolkit/Context.d.ts:3:1 - (ae-undocumented) Missing documentation for "Tool". +// src/homePageComponents/VisitedByType/Content.d.ts:4:1 - (ae-undocumented) Missing documentation for "VisitedByTypeKind". +// src/homePageComponents/VisitedByType/Content.d.ts:6:1 - (ae-undocumented) Missing documentation for "VisitedByTypeProps". +// src/homePageComponents/WelcomeTitle/WelcomeTitle.d.ts:3:1 - (ae-undocumented) Missing documentation for "WelcomeTitleLanguageProps". +// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "homePlugin". +// src/plugin.d.ts:9:22 - (ae-undocumented) Missing documentation for "HomepageCompositionRoot". +// src/plugin.d.ts:14:22 - (ae-undocumented) Missing documentation for "ComponentAccordion". +// src/plugin.d.ts:24:22 - (ae-undocumented) Missing documentation for "ComponentTabs". +// src/plugin.d.ts:32:22 - (ae-undocumented) Missing documentation for "ComponentTab". +// src/plugin.d.ts:53:22 - (ae-undocumented) Missing documentation for "HomePageRandomJoke". ``` diff --git a/plugins/kubernetes-backend/api-report-alpha.md b/plugins/kubernetes-backend/api-report-alpha.api.md similarity index 100% rename from plugins/kubernetes-backend/api-report-alpha.md rename to plugins/kubernetes-backend/api-report-alpha.api.md diff --git a/plugins/kubernetes-backend/api-report.md b/plugins/kubernetes-backend/api-report.api.md similarity index 54% rename from plugins/kubernetes-backend/api-report.md rename to plugins/kubernetes-backend/api-report.api.md index 2711085b81..9b2919ef66 100644 --- a/plugins/kubernetes-backend/api-report.md +++ b/plugins/kubernetes-backend/api-report.api.md @@ -425,4 +425,118 @@ export type SigningCreds = { secretAccessKey: string | undefined; sessionToken: string | undefined; }; + +// Warnings were encountered during analysis: +// +// src/auth/AksStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "AksStrategy". +// src/auth/AksStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/AksStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/AksStrategy.d.ts:10:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/AnonymousStrategy.d.ts:6:1 - (ae-undocumented) Missing documentation for "AnonymousStrategy". +// src/auth/AnonymousStrategy.d.ts:7:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/AnonymousStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/AnonymousStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/AwsIamStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "SigningCreds". +// src/auth/AwsIamStrategy.d.ts:16:1 - (ae-undocumented) Missing documentation for "AwsIamStrategy". +// src/auth/AwsIamStrategy.d.ts:21:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/AwsIamStrategy.d.ts:22:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/AwsIamStrategy.d.ts:24:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/AzureIdentityStrategy.d.ts:8:1 - (ae-undocumented) Missing documentation for "AzureIdentityStrategy". +// src/auth/AzureIdentityStrategy.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/AzureIdentityStrategy.d.ts:15:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/AzureIdentityStrategy.d.ts:19:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/DispatchStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "DispatchStrategyOptions". +// src/auth/DispatchStrategy.d.ts:19:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/DispatchStrategy.d.ts:20:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/DispatchStrategy.d.ts:21:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/GoogleServiceAccountStrategy.d.ts:6:1 - (ae-undocumented) Missing documentation for "GoogleServiceAccountStrategy". +// src/auth/GoogleServiceAccountStrategy.d.ts:7:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/GoogleServiceAccountStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/GoogleServiceAccountStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/GoogleStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "GoogleStrategy". +// src/auth/GoogleStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/GoogleStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/GoogleStrategy.d.ts:10:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/OidcStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "OidcStrategy". +// src/auth/OidcStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/OidcStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/OidcStrategy.d.ts:10:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/ServiceAccountStrategy.d.ts:6:1 - (ae-undocumented) Missing documentation for "ServiceAccountStrategy". +// src/auth/ServiceAccountStrategy.d.ts:7:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/auth/ServiceAccountStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/auth/ServiceAccountStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/auth/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "AuthenticationStrategy". +// src/auth/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "KubernetesCredential". +// src/service/KubernetesBuilder.d.ts:14:1 - (ae-undocumented) Missing documentation for "KubernetesEnvironment". +// src/service/KubernetesBuilder.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/KubernetesBuilder.d.ts:16:5 - (ae-undocumented) Missing documentation for "config". +// src/service/KubernetesBuilder.d.ts:17:5 - (ae-undocumented) Missing documentation for "catalogApi". +// src/service/KubernetesBuilder.d.ts:18:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/KubernetesBuilder.d.ts:19:5 - (ae-undocumented) Missing documentation for "permissions". +// src/service/KubernetesBuilder.d.ts:20:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/KubernetesBuilder.d.ts:21:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/KubernetesBuilder.d.ts:44:1 - (ae-undocumented) Missing documentation for "KubernetesBuilder". +// src/service/KubernetesBuilder.d.ts:45:5 - (ae-undocumented) Missing documentation for "env". +// src/service/KubernetesBuilder.d.ts:53:5 - (ae-undocumented) Missing documentation for "createBuilder". +// src/service/KubernetesBuilder.d.ts:55:5 - (ae-undocumented) Missing documentation for "build". +// src/service/KubernetesBuilder.d.ts:56:5 - (ae-undocumented) Missing documentation for "setClusterSupplier". +// src/service/KubernetesBuilder.d.ts:57:5 - (ae-undocumented) Missing documentation for "setDefaultClusterRefreshInterval". +// src/service/KubernetesBuilder.d.ts:58:5 - (ae-undocumented) Missing documentation for "setObjectsProvider". +// src/service/KubernetesBuilder.d.ts:59:5 - (ae-undocumented) Missing documentation for "setFetcher". +// src/service/KubernetesBuilder.d.ts:60:5 - (ae-undocumented) Missing documentation for "setServiceLocator". +// src/service/KubernetesBuilder.d.ts:61:5 - (ae-undocumented) Missing documentation for "setProxy". +// src/service/KubernetesBuilder.d.ts:62:5 - (ae-undocumented) Missing documentation for "setAuthStrategyMap". +// src/service/KubernetesBuilder.d.ts:65:5 - (ae-undocumented) Missing documentation for "addAuthStrategy". +// src/service/KubernetesBuilder.d.ts:66:5 - (ae-undocumented) Missing documentation for "buildCustomResources". +// src/service/KubernetesBuilder.d.ts:67:5 - (ae-undocumented) Missing documentation for "buildClusterSupplier". +// src/service/KubernetesBuilder.d.ts:68:5 - (ae-undocumented) Missing documentation for "buildObjectsProvider". +// src/service/KubernetesBuilder.d.ts:69:5 - (ae-undocumented) Missing documentation for "buildFetcher". +// src/service/KubernetesBuilder.d.ts:70:5 - (ae-undocumented) Missing documentation for "buildServiceLocator". +// src/service/KubernetesBuilder.d.ts:71:5 - (ae-undocumented) Missing documentation for "buildMultiTenantServiceLocator". +// src/service/KubernetesBuilder.d.ts:72:5 - (ae-undocumented) Missing documentation for "buildSingleTenantServiceLocator". +// src/service/KubernetesBuilder.d.ts:73:5 - (ae-undocumented) Missing documentation for "buildCatalogRelationServiceLocator". +// src/service/KubernetesBuilder.d.ts:74:5 - (ae-undocumented) Missing documentation for "buildHttpServiceLocator". +// src/service/KubernetesBuilder.d.ts:75:5 - (ae-undocumented) Missing documentation for "buildProxy". +// src/service/KubernetesBuilder.d.ts:76:5 - (ae-undocumented) Missing documentation for "buildRouter". +// src/service/KubernetesBuilder.d.ts:77:5 - (ae-undocumented) Missing documentation for "buildAuthStrategyMap". +// src/service/KubernetesBuilder.d.ts:80:5 - (ae-undocumented) Missing documentation for "fetchClusterDetails". +// src/service/KubernetesBuilder.d.ts:83:5 - (ae-undocumented) Missing documentation for "getServiceLocatorMethod". +// src/service/KubernetesBuilder.d.ts:84:5 - (ae-undocumented) Missing documentation for "getFetcher". +// src/service/KubernetesBuilder.d.ts:85:5 - (ae-undocumented) Missing documentation for "getClusterSupplier". +// src/service/KubernetesBuilder.d.ts:86:5 - (ae-undocumented) Missing documentation for "getServiceLocator". +// src/service/KubernetesBuilder.d.ts:87:5 - (ae-undocumented) Missing documentation for "getObjectsProvider". +// src/service/KubernetesBuilder.d.ts:88:5 - (ae-undocumented) Missing documentation for "getObjectTypesToFetch". +// src/service/KubernetesBuilder.d.ts:89:5 - (ae-undocumented) Missing documentation for "getProxy". +// src/service/KubernetesBuilder.d.ts:90:5 - (ae-undocumented) Missing documentation for "getAuthStrategyMap". +// src/service/KubernetesFanOutHandler.d.ts:9:22 - (ae-undocumented) Missing documentation for "DEFAULT_OBJECTS". +// src/service/KubernetesProxy.d.ts:50:5 - (ae-undocumented) Missing documentation for "createRequestHandler". +// src/service/router.d.ts:12:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "catalogApi". +// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "clusterSupplier". +// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "permissions". +// src/types/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "ServiceLocatorMethod". +// src/types/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProviderOptions". +// src/types/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". +// src/types/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "config". +// src/types/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "fetcher". +// src/types/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "serviceLocator". +// src/types/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "customResources". +// src/types/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "objectTypesToFetch". +// src/types/types.d.ts:26:1 - (ae-undocumented) Missing documentation for "ObjectsByEntityRequest". +// src/types/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProvider". +// src/types/types.d.ts:34:1 - (ae-undocumented) Missing documentation for "CustomResourcesByEntity". +// src/types/types.d.ts:39:1 - (ae-undocumented) Missing documentation for "AuthMetadata". +// src/types/types.d.ts:44:1 - (ae-undocumented) Missing documentation for "ClusterDetails". +// src/types/types.d.ts:49:1 - (ae-undocumented) Missing documentation for "KubernetesClustersSupplier". +// src/types/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "KubernetesObjectTypes". +// src/types/types.d.ts:57:1 - (ae-undocumented) Missing documentation for "ObjectToFetch". +// src/types/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "CustomResource". +// src/types/types.d.ts:65:1 - (ae-undocumented) Missing documentation for "ObjectFetchParams". +// src/types/types.d.ts:69:1 - (ae-undocumented) Missing documentation for "FetchResponseWrapper". +// src/types/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "KubernetesFetcher". +// src/types/types.d.ts:77:1 - (ae-undocumented) Missing documentation for "ServiceLocatorRequestContext". +// src/types/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "KubernetesServiceLocator". ``` diff --git a/plugins/kubernetes-cluster/api-report.md b/plugins/kubernetes-cluster/api-report.api.md similarity index 73% rename from plugins/kubernetes-cluster/api-report.md rename to plugins/kubernetes-cluster/api-report.api.md index 10d248097a..5e16134c2d 100644 --- a/plugins/kubernetes-cluster/api-report.md +++ b/plugins/kubernetes-cluster/api-report.api.md @@ -21,4 +21,9 @@ export const isKubernetesClusterAvailable: (entity: Entity) => boolean; // @public (undocumented) export const Router: () => React_2.JSX.Element; + +// Warnings were encountered during analysis: +// +// src/Router.d.ts:8:22 - (ae-undocumented) Missing documentation for "isKubernetesClusterAvailable". +// src/Router.d.ts:14:22 - (ae-undocumented) Missing documentation for "Router". ``` diff --git a/plugins/kubernetes-common/api-report.api.md b/plugins/kubernetes-common/api-report.api.md new file mode 100644 index 0000000000..283788cfe5 --- /dev/null +++ b/plugins/kubernetes-common/api-report.api.md @@ -0,0 +1,604 @@ +## API Report File for "@backstage/plugin-kubernetes-common" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BasicPermission } from '@backstage/plugin-permission-common'; +import { Entity } from '@backstage/catalog-model'; +import { FetchResponse as FetchResponse_2 } from '@backstage/plugin-kubernetes-common'; +import type { JsonObject } from '@backstage/types'; +import type { JsonValue } from '@backstage/types'; +import { ObjectsByEntityResponse as ObjectsByEntityResponse_2 } from '@backstage/plugin-kubernetes-common'; +import { PodStatus } from '@kubernetes/client-node'; +import { V1ConfigMap } from '@kubernetes/client-node'; +import { V1CronJob } from '@kubernetes/client-node'; +import { V1DaemonSet } from '@kubernetes/client-node'; +import { V1Deployment } from '@kubernetes/client-node'; +import { V1Ingress } from '@kubernetes/client-node'; +import { V1Job } from '@kubernetes/client-node'; +import { V1LimitRange } from '@kubernetes/client-node'; +import { V1Pod } from '@kubernetes/client-node'; +import { V1ReplicaSet } from '@kubernetes/client-node'; +import { V1ResourceQuota } from '@kubernetes/client-node'; +import { V1Service } from '@kubernetes/client-node'; +import { V1StatefulSet } from '@kubernetes/client-node'; +import { V2HorizontalPodAutoscaler } from '@kubernetes/client-node'; + +// @public +export const ANNOTATION_KUBERNETES_API_SERVER = 'kubernetes.io/api-server'; + +// @public +export const ANNOTATION_KUBERNETES_API_SERVER_CA = + 'kubernetes.io/api-server-certificate-authority'; + +// @public +export const ANNOTATION_KUBERNETES_AUTH_PROVIDER = + 'kubernetes.io/auth-provider'; + +// @public +export const ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE = + 'kubernetes.io/aws-assume-role'; + +// @public +export const ANNOTATION_KUBERNETES_AWS_CLUSTER_ID = + 'kubernetes.io/x-k8s-aws-id'; + +// @public +export const ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID = + 'kubernetes.io/aws-external-id'; + +// @public +export const ANNOTATION_KUBERNETES_DASHBOARD_APP = + 'kubernetes.io/dashboard-app'; + +// @public +export const ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS = + 'kubernetes.io/dashboard-parameters'; + +// @public +export const ANNOTATION_KUBERNETES_DASHBOARD_URL = + 'kubernetes.io/dashboard-url'; + +// @public +export const ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER = + 'kubernetes.io/oidc-token-provider'; + +// @public +export const ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP = + 'kubernetes.io/skip-metrics-lookup'; + +// @public +export const ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY = + 'kubernetes.io/skip-tls-verify'; + +// @public (undocumented) +export type AuthProviderType = 'google' | 'serviceAccount' | 'aws' | 'azure'; + +// @public (undocumented) +export interface ClientContainerStatus { + // (undocumented) + container: string; + // (undocumented) + cpuUsage: ClientCurrentResourceUsage; + // (undocumented) + memoryUsage: ClientCurrentResourceUsage; +} + +// @public (undocumented) +export interface ClientCurrentResourceUsage { + // (undocumented) + currentUsage: number | string; + // (undocumented) + limitTotal: number | string; + // (undocumented) + requestTotal: number | string; +} + +// @public (undocumented) +export interface ClientPodStatus { + // (undocumented) + containers: ClientContainerStatus[]; + // (undocumented) + cpu: ClientCurrentResourceUsage; + // (undocumented) + memory: ClientCurrentResourceUsage; + // (undocumented) + pod: V1Pod; +} + +// @public (undocumented) +export interface ClusterAttributes { + dashboardApp?: string; + dashboardParameters?: JsonObject; + dashboardUrl?: string; + name: string; + title?: string; +} + +// @public (undocumented) +export interface ClusterObjects { + // (undocumented) + cluster: ClusterAttributes; + // (undocumented) + errors: KubernetesFetchError[]; + // (undocumented) + podMetrics: ClientPodStatus[]; + // (undocumented) + resources: FetchResponse[]; +} + +// @public (undocumented) +export interface ConfigMapFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'configmaps'; +} + +// @public (undocumented) +export interface CronJobsFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'cronjobs'; +} + +// @public (undocumented) +export interface CustomObjectsByEntityRequest { + // (undocumented) + auth: KubernetesRequestAuth; + // (undocumented) + customResources: CustomResourceMatcher[]; + // (undocumented) + entity: Entity; +} + +// @public (undocumented) +export interface CustomResourceFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'customresources'; +} + +// @public (undocumented) +export interface CustomResourceMatcher { + // (undocumented) + apiVersion: string; + // (undocumented) + group: string; + // (undocumented) + plural: string; +} + +// @public (undocumented) +export interface DaemonSetsFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'daemonsets'; +} + +// @public (undocumented) +export interface DeploymentFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'deployments'; +} + +// @public (undocumented) +export interface DeploymentResources { + // (undocumented) + deployments: V1Deployment[]; + // (undocumented) + horizontalPodAutoscalers: V2HorizontalPodAutoscaler[]; + // (undocumented) + pods: V1Pod[]; + // (undocumented) + replicaSets: V1ReplicaSet[]; +} + +// @public +export interface DetectedError { + // (undocumented) + message: string; + // (undocumented) + occurrenceCount: number; + // (undocumented) + proposedFix?: ProposedFix; + // (undocumented) + severity: ErrorSeverity; + // (undocumented) + sourceRef: ResourceRef; + // (undocumented) + type: string; +} + +// @public +export type DetectedErrorsByCluster = Map; + +// @public +export const detectErrors: ( + objects: ObjectsByEntityResponse_2, +) => DetectedErrorsByCluster; + +// @public (undocumented) +export interface DocsSolution extends ProposedFixBase { + // (undocumented) + docsLink: string; + // (undocumented) + type: 'docs'; +} + +// @public (undocumented) +export interface ErrorMapper { + // (undocumented) + detectErrors: (resource: T) => DetectedError[]; +} + +// @public +export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; + +// @public (undocumented) +export interface EventsSolution extends ProposedFixBase { + // (undocumented) + podName: string; + // (undocumented) + type: 'events'; +} + +// @public (undocumented) +export type FetchResponse = + | PodFetchResponse + | ServiceFetchResponse + | ConfigMapFetchResponse + | DeploymentFetchResponse + | LimitRangeFetchResponse + | ResourceQuotaFetchResponse + | ReplicaSetsFetchResponse + | HorizontalPodAutoscalersFetchResponse + | JobsFetchResponse + | CronJobsFetchResponse + | IngressesFetchResponse + | CustomResourceFetchResponse + | StatefulSetsFetchResponse + | DaemonSetsFetchResponse + | PodStatusFetchResponse; + +// @public (undocumented) +export interface GroupedResponses extends DeploymentResources { + // (undocumented) + configMaps: V1ConfigMap[]; + // (undocumented) + cronJobs: V1CronJob[]; + // (undocumented) + customResources: any[]; + // (undocumented) + daemonSets: V1DaemonSet[]; + // (undocumented) + ingresses: V1Ingress[]; + // (undocumented) + jobs: V1Job[]; + // (undocumented) + services: V1Service[]; + // (undocumented) + statefulsets: V1StatefulSet[]; +} + +// @public (undocumented) +export const groupResponses: ( + fetchResponse: FetchResponse_2[], +) => GroupedResponses; + +// @public (undocumented) +export interface HorizontalPodAutoscalersFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'horizontalpodautoscalers'; +} + +// @public (undocumented) +export interface IngressesFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'ingresses'; +} + +// @public (undocumented) +export interface JobsFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'jobs'; +} + +// @public (undocumented) +export type KubernetesErrorTypes = + | 'BAD_REQUEST' + | 'UNAUTHORIZED_ERROR' + | 'NOT_FOUND' + | 'SYSTEM_ERROR' + | 'UNKNOWN_ERROR'; + +// @public (undocumented) +export type KubernetesFetchError = StatusError | RawFetchError; + +// @public +export const kubernetesPermissions: BasicPermission[]; + +// @public +export const kubernetesProxyPermission: BasicPermission; + +// @public (undocumented) +export type KubernetesRequestAuth = { + [providerKey: string]: JsonValue | undefined; +}; + +// @public (undocumented) +export interface KubernetesRequestBody { + // (undocumented) + auth?: KubernetesRequestAuth; + // (undocumented) + entity: Entity; +} + +// @public (undocumented) +export interface LimitRangeFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'limitranges'; +} + +// @public (undocumented) +export interface LogSolution extends ProposedFixBase { + // (undocumented) + container: string; + // (undocumented) + type: 'logs'; +} + +// @public (undocumented) +export interface ObjectsByEntityResponse { + // (undocumented) + items: ClusterObjects[]; +} + +// @public (undocumented) +export interface PodFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'pods'; +} + +// @public (undocumented) +export interface PodStatusFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'podstatus'; +} + +// @public (undocumented) +export type ProposedFix = LogSolution | DocsSolution | EventsSolution; + +// @public (undocumented) +export interface ProposedFixBase { + // (undocumented) + actions: string[]; + // (undocumented) + errorType: string; + // (undocumented) + rootCauseExplanation: string; +} + +// @public (undocumented) +export interface RawFetchError { + // (undocumented) + errorType: 'FETCH_ERROR'; + // (undocumented) + message: string; +} + +// @public (undocumented) +export interface ReplicaSetsFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'replicasets'; +} + +// @public (undocumented) +export interface ResourceQuotaFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'resourcequotas'; +} + +// @public +export interface ResourceRef { + // (undocumented) + apiGroup: string; + // (undocumented) + kind: string; + // (undocumented) + name: string; + // (undocumented) + namespace: string; +} + +// @public (undocumented) +export interface ServiceFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'services'; +} + +// @public (undocumented) +export interface StatefulSetsFetchResponse { + // (undocumented) + resources: Array; + // (undocumented) + type: 'statefulsets'; +} + +// @public (undocumented) +export interface StatusError { + // (undocumented) + errorType: KubernetesErrorTypes; + // (undocumented) + resourcePath?: string; + // (undocumented) + statusCode?: number; +} + +// @public (undocumented) +export interface WorkloadsByEntityRequest { + // (undocumented) + auth: KubernetesRequestAuth; + // (undocumented) + entity: Entity; +} + +// Warnings were encountered during analysis: +// +// src/error-detection/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "name". +// src/error-detection/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "namespace". +// src/error-detection/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "kind". +// src/error-detection/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "apiGroup". +// src/error-detection/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "type". +// src/error-detection/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "severity". +// src/error-detection/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "message". +// src/error-detection/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "proposedFix". +// src/error-detection/types.d.ts:34:5 - (ae-undocumented) Missing documentation for "sourceRef". +// src/error-detection/types.d.ts:35:5 - (ae-undocumented) Missing documentation for "occurrenceCount". +// src/error-detection/types.d.ts:38:1 - (ae-undocumented) Missing documentation for "ProposedFix". +// src/error-detection/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "ProposedFixBase". +// src/error-detection/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "errorType". +// src/error-detection/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "rootCauseExplanation". +// src/error-detection/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "actions". +// src/error-detection/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "LogSolution". +// src/error-detection/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "type". +// src/error-detection/types.d.ts:48:5 - (ae-undocumented) Missing documentation for "container". +// src/error-detection/types.d.ts:51:1 - (ae-undocumented) Missing documentation for "DocsSolution". +// src/error-detection/types.d.ts:52:5 - (ae-undocumented) Missing documentation for "type". +// src/error-detection/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "docsLink". +// src/error-detection/types.d.ts:56:1 - (ae-undocumented) Missing documentation for "EventsSolution". +// src/error-detection/types.d.ts:57:5 - (ae-undocumented) Missing documentation for "type". +// src/error-detection/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "podName". +// src/error-detection/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "ErrorMapper". +// src/error-detection/types.d.ts:62:5 - (ae-undocumented) Missing documentation for "detectErrors". +// src/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "KubernetesRequestAuth". +// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "CustomResourceMatcher". +// src/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "group". +// src/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "plural". +// src/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "WorkloadsByEntityRequest". +// src/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "auth". +// src/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "entity". +// src/types.d.ts:20:1 - (ae-undocumented) Missing documentation for "CustomObjectsByEntityRequest". +// src/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "auth". +// src/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "customResources". +// src/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "entity". +// src/types.d.ts:26:1 - (ae-undocumented) Missing documentation for "KubernetesRequestBody". +// src/types.d.ts:27:5 - (ae-undocumented) Missing documentation for "auth". +// src/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "entity". +// src/types.d.ts:31:1 - (ae-undocumented) Missing documentation for "ClusterAttributes". +// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "ClusterObjects". +// src/types.d.ts:74:5 - (ae-undocumented) Missing documentation for "cluster". +// src/types.d.ts:75:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:76:5 - (ae-undocumented) Missing documentation for "podMetrics". +// src/types.d.ts:77:5 - (ae-undocumented) Missing documentation for "errors". +// src/types.d.ts:80:1 - (ae-undocumented) Missing documentation for "ObjectsByEntityResponse". +// src/types.d.ts:81:5 - (ae-undocumented) Missing documentation for "items". +// src/types.d.ts:84:1 - (ae-undocumented) Missing documentation for "AuthProviderType". +// src/types.d.ts:86:1 - (ae-undocumented) Missing documentation for "FetchResponse". +// src/types.d.ts:88:1 - (ae-undocumented) Missing documentation for "PodFetchResponse". +// src/types.d.ts:89:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:93:1 - (ae-undocumented) Missing documentation for "ServiceFetchResponse". +// src/types.d.ts:94:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:98:1 - (ae-undocumented) Missing documentation for "ConfigMapFetchResponse". +// src/types.d.ts:99:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:100:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:103:1 - (ae-undocumented) Missing documentation for "DeploymentFetchResponse". +// src/types.d.ts:104:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:108:1 - (ae-undocumented) Missing documentation for "ReplicaSetsFetchResponse". +// src/types.d.ts:109:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:113:1 - (ae-undocumented) Missing documentation for "LimitRangeFetchResponse". +// src/types.d.ts:114:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:115:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:118:1 - (ae-undocumented) Missing documentation for "ResourceQuotaFetchResponse". +// src/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:120:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:123:1 - (ae-undocumented) Missing documentation for "HorizontalPodAutoscalersFetchResponse". +// src/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:128:1 - (ae-undocumented) Missing documentation for "JobsFetchResponse". +// src/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:130:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:133:1 - (ae-undocumented) Missing documentation for "CronJobsFetchResponse". +// src/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:138:1 - (ae-undocumented) Missing documentation for "IngressesFetchResponse". +// src/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:143:1 - (ae-undocumented) Missing documentation for "CustomResourceFetchResponse". +// src/types.d.ts:144:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:145:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:148:1 - (ae-undocumented) Missing documentation for "StatefulSetsFetchResponse". +// src/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:150:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:153:1 - (ae-undocumented) Missing documentation for "DaemonSetsFetchResponse". +// src/types.d.ts:154:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:158:1 - (ae-undocumented) Missing documentation for "PodStatusFetchResponse". +// src/types.d.ts:159:5 - (ae-undocumented) Missing documentation for "type". +// src/types.d.ts:160:5 - (ae-undocumented) Missing documentation for "resources". +// src/types.d.ts:163:1 - (ae-undocumented) Missing documentation for "KubernetesFetchError". +// src/types.d.ts:165:1 - (ae-undocumented) Missing documentation for "StatusError". +// src/types.d.ts:166:5 - (ae-undocumented) Missing documentation for "errorType". +// src/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "statusCode". +// src/types.d.ts:168:5 - (ae-undocumented) Missing documentation for "resourcePath". +// src/types.d.ts:171:1 - (ae-undocumented) Missing documentation for "RawFetchError". +// src/types.d.ts:172:5 - (ae-undocumented) Missing documentation for "errorType". +// src/types.d.ts:173:5 - (ae-undocumented) Missing documentation for "message". +// src/types.d.ts:176:1 - (ae-undocumented) Missing documentation for "KubernetesErrorTypes". +// src/types.d.ts:178:1 - (ae-undocumented) Missing documentation for "ClientCurrentResourceUsage". +// src/types.d.ts:179:5 - (ae-undocumented) Missing documentation for "currentUsage". +// src/types.d.ts:180:5 - (ae-undocumented) Missing documentation for "requestTotal". +// src/types.d.ts:181:5 - (ae-undocumented) Missing documentation for "limitTotal". +// src/types.d.ts:184:1 - (ae-undocumented) Missing documentation for "ClientContainerStatus". +// src/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "container". +// src/types.d.ts:186:5 - (ae-undocumented) Missing documentation for "cpuUsage". +// src/types.d.ts:187:5 - (ae-undocumented) Missing documentation for "memoryUsage". +// src/types.d.ts:190:1 - (ae-undocumented) Missing documentation for "ClientPodStatus". +// src/types.d.ts:191:5 - (ae-undocumented) Missing documentation for "pod". +// src/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "cpu". +// src/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "memory". +// src/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "containers". +// src/types.d.ts:197:1 - (ae-undocumented) Missing documentation for "DeploymentResources". +// src/types.d.ts:198:5 - (ae-undocumented) Missing documentation for "pods". +// src/types.d.ts:199:5 - (ae-undocumented) Missing documentation for "replicaSets". +// src/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "deployments". +// src/types.d.ts:201:5 - (ae-undocumented) Missing documentation for "horizontalPodAutoscalers". +// src/types.d.ts:204:1 - (ae-undocumented) Missing documentation for "GroupedResponses". +// src/types.d.ts:205:5 - (ae-undocumented) Missing documentation for "services". +// src/types.d.ts:206:5 - (ae-undocumented) Missing documentation for "configMaps". +// src/types.d.ts:207:5 - (ae-undocumented) Missing documentation for "ingresses". +// src/types.d.ts:208:5 - (ae-undocumented) Missing documentation for "jobs". +// src/types.d.ts:209:5 - (ae-undocumented) Missing documentation for "cronJobs". +// src/types.d.ts:210:5 - (ae-undocumented) Missing documentation for "customResources". +// src/types.d.ts:211:5 - (ae-undocumented) Missing documentation for "statefulsets". +// src/types.d.ts:212:5 - (ae-undocumented) Missing documentation for "daemonSets". +// src/util/response.d.ts:4:22 - (ae-undocumented) Missing documentation for "groupResponses". +``` diff --git a/plugins/kubernetes-common/api-report.md b/plugins/kubernetes-common/api-report.md deleted file mode 100644 index 81e9ca28e7..0000000000 --- a/plugins/kubernetes-common/api-report.md +++ /dev/null @@ -1,468 +0,0 @@ -## API Report File for "@backstage/plugin-kubernetes-common" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { BasicPermission } from '@backstage/plugin-permission-common'; -import { Entity } from '@backstage/catalog-model'; -import { FetchResponse as FetchResponse_2 } from '@backstage/plugin-kubernetes-common'; -import type { JsonObject } from '@backstage/types'; -import type { JsonValue } from '@backstage/types'; -import { ObjectsByEntityResponse as ObjectsByEntityResponse_2 } from '@backstage/plugin-kubernetes-common'; -import { PodStatus } from '@kubernetes/client-node'; -import { V1ConfigMap } from '@kubernetes/client-node'; -import { V1CronJob } from '@kubernetes/client-node'; -import { V1DaemonSet } from '@kubernetes/client-node'; -import { V1Deployment } from '@kubernetes/client-node'; -import { V1Ingress } from '@kubernetes/client-node'; -import { V1Job } from '@kubernetes/client-node'; -import { V1LimitRange } from '@kubernetes/client-node'; -import { V1Pod } from '@kubernetes/client-node'; -import { V1ReplicaSet } from '@kubernetes/client-node'; -import { V1ResourceQuota } from '@kubernetes/client-node'; -import { V1Service } from '@kubernetes/client-node'; -import { V1StatefulSet } from '@kubernetes/client-node'; -import { V2HorizontalPodAutoscaler } from '@kubernetes/client-node'; - -// @public -export const ANNOTATION_KUBERNETES_API_SERVER = 'kubernetes.io/api-server'; - -// @public -export const ANNOTATION_KUBERNETES_API_SERVER_CA = - 'kubernetes.io/api-server-certificate-authority'; - -// @public -export const ANNOTATION_KUBERNETES_AUTH_PROVIDER = - 'kubernetes.io/auth-provider'; - -// @public -export const ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE = - 'kubernetes.io/aws-assume-role'; - -// @public -export const ANNOTATION_KUBERNETES_AWS_CLUSTER_ID = - 'kubernetes.io/x-k8s-aws-id'; - -// @public -export const ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID = - 'kubernetes.io/aws-external-id'; - -// @public -export const ANNOTATION_KUBERNETES_DASHBOARD_APP = - 'kubernetes.io/dashboard-app'; - -// @public -export const ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS = - 'kubernetes.io/dashboard-parameters'; - -// @public -export const ANNOTATION_KUBERNETES_DASHBOARD_URL = - 'kubernetes.io/dashboard-url'; - -// @public -export const ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER = - 'kubernetes.io/oidc-token-provider'; - -// @public -export const ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP = - 'kubernetes.io/skip-metrics-lookup'; - -// @public -export const ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY = - 'kubernetes.io/skip-tls-verify'; - -// @public (undocumented) -export type AuthProviderType = 'google' | 'serviceAccount' | 'aws' | 'azure'; - -// @public (undocumented) -export interface ClientContainerStatus { - // (undocumented) - container: string; - // (undocumented) - cpuUsage: ClientCurrentResourceUsage; - // (undocumented) - memoryUsage: ClientCurrentResourceUsage; -} - -// @public (undocumented) -export interface ClientCurrentResourceUsage { - // (undocumented) - currentUsage: number | string; - // (undocumented) - limitTotal: number | string; - // (undocumented) - requestTotal: number | string; -} - -// @public (undocumented) -export interface ClientPodStatus { - // (undocumented) - containers: ClientContainerStatus[]; - // (undocumented) - cpu: ClientCurrentResourceUsage; - // (undocumented) - memory: ClientCurrentResourceUsage; - // (undocumented) - pod: V1Pod; -} - -// @public (undocumented) -export interface ClusterAttributes { - dashboardApp?: string; - dashboardParameters?: JsonObject; - dashboardUrl?: string; - name: string; - title?: string; -} - -// @public (undocumented) -export interface ClusterObjects { - // (undocumented) - cluster: ClusterAttributes; - // (undocumented) - errors: KubernetesFetchError[]; - // (undocumented) - podMetrics: ClientPodStatus[]; - // (undocumented) - resources: FetchResponse[]; -} - -// @public (undocumented) -export interface ConfigMapFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'configmaps'; -} - -// @public (undocumented) -export interface CronJobsFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'cronjobs'; -} - -// @public (undocumented) -export interface CustomObjectsByEntityRequest { - // (undocumented) - auth: KubernetesRequestAuth; - // (undocumented) - customResources: CustomResourceMatcher[]; - // (undocumented) - entity: Entity; -} - -// @public (undocumented) -export interface CustomResourceFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'customresources'; -} - -// @public (undocumented) -export interface CustomResourceMatcher { - // (undocumented) - apiVersion: string; - // (undocumented) - group: string; - // (undocumented) - plural: string; -} - -// @public (undocumented) -export interface DaemonSetsFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'daemonsets'; -} - -// @public (undocumented) -export interface DeploymentFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'deployments'; -} - -// @public (undocumented) -export interface DeploymentResources { - // (undocumented) - deployments: V1Deployment[]; - // (undocumented) - horizontalPodAutoscalers: V2HorizontalPodAutoscaler[]; - // (undocumented) - pods: V1Pod[]; - // (undocumented) - replicaSets: V1ReplicaSet[]; -} - -// @public -export interface DetectedError { - // (undocumented) - message: string; - // (undocumented) - occurrenceCount: number; - // (undocumented) - proposedFix?: ProposedFix; - // (undocumented) - severity: ErrorSeverity; - // (undocumented) - sourceRef: ResourceRef; - // (undocumented) - type: string; -} - -// @public -export type DetectedErrorsByCluster = Map; - -// @public -export const detectErrors: ( - objects: ObjectsByEntityResponse_2, -) => DetectedErrorsByCluster; - -// @public (undocumented) -export interface DocsSolution extends ProposedFixBase { - // (undocumented) - docsLink: string; - // (undocumented) - type: 'docs'; -} - -// @public (undocumented) -export interface ErrorMapper { - // (undocumented) - detectErrors: (resource: T) => DetectedError[]; -} - -// @public -export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; - -// @public (undocumented) -export interface EventsSolution extends ProposedFixBase { - // (undocumented) - podName: string; - // (undocumented) - type: 'events'; -} - -// @public (undocumented) -export type FetchResponse = - | PodFetchResponse - | ServiceFetchResponse - | ConfigMapFetchResponse - | DeploymentFetchResponse - | LimitRangeFetchResponse - | ResourceQuotaFetchResponse - | ReplicaSetsFetchResponse - | HorizontalPodAutoscalersFetchResponse - | JobsFetchResponse - | CronJobsFetchResponse - | IngressesFetchResponse - | CustomResourceFetchResponse - | StatefulSetsFetchResponse - | DaemonSetsFetchResponse - | PodStatusFetchResponse; - -// @public (undocumented) -export interface GroupedResponses extends DeploymentResources { - // (undocumented) - configMaps: V1ConfigMap[]; - // (undocumented) - cronJobs: V1CronJob[]; - // (undocumented) - customResources: any[]; - // (undocumented) - daemonSets: V1DaemonSet[]; - // (undocumented) - ingresses: V1Ingress[]; - // (undocumented) - jobs: V1Job[]; - // (undocumented) - services: V1Service[]; - // (undocumented) - statefulsets: V1StatefulSet[]; -} - -// @public (undocumented) -export const groupResponses: ( - fetchResponse: FetchResponse_2[], -) => GroupedResponses; - -// @public (undocumented) -export interface HorizontalPodAutoscalersFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'horizontalpodautoscalers'; -} - -// @public (undocumented) -export interface IngressesFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'ingresses'; -} - -// @public (undocumented) -export interface JobsFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'jobs'; -} - -// @public (undocumented) -export type KubernetesErrorTypes = - | 'BAD_REQUEST' - | 'UNAUTHORIZED_ERROR' - | 'NOT_FOUND' - | 'SYSTEM_ERROR' - | 'UNKNOWN_ERROR'; - -// @public (undocumented) -export type KubernetesFetchError = StatusError | RawFetchError; - -// @public -export const kubernetesPermissions: BasicPermission[]; - -// @public -export const kubernetesProxyPermission: BasicPermission; - -// @public (undocumented) -export type KubernetesRequestAuth = { - [providerKey: string]: JsonValue | undefined; -}; - -// @public (undocumented) -export interface KubernetesRequestBody { - // (undocumented) - auth?: KubernetesRequestAuth; - // (undocumented) - entity: Entity; -} - -// @public (undocumented) -export interface LimitRangeFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'limitranges'; -} - -// @public (undocumented) -export interface LogSolution extends ProposedFixBase { - // (undocumented) - container: string; - // (undocumented) - type: 'logs'; -} - -// @public (undocumented) -export interface ObjectsByEntityResponse { - // (undocumented) - items: ClusterObjects[]; -} - -// @public (undocumented) -export interface PodFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'pods'; -} - -// @public (undocumented) -export interface PodStatusFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'podstatus'; -} - -// @public (undocumented) -export type ProposedFix = LogSolution | DocsSolution | EventsSolution; - -// @public (undocumented) -export interface ProposedFixBase { - // (undocumented) - actions: string[]; - // (undocumented) - errorType: string; - // (undocumented) - rootCauseExplanation: string; -} - -// @public (undocumented) -export interface RawFetchError { - // (undocumented) - errorType: 'FETCH_ERROR'; - // (undocumented) - message: string; -} - -// @public (undocumented) -export interface ReplicaSetsFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'replicasets'; -} - -// @public (undocumented) -export interface ResourceQuotaFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'resourcequotas'; -} - -// @public -export interface ResourceRef { - // (undocumented) - apiGroup: string; - // (undocumented) - kind: string; - // (undocumented) - name: string; - // (undocumented) - namespace: string; -} - -// @public (undocumented) -export interface ServiceFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'services'; -} - -// @public (undocumented) -export interface StatefulSetsFetchResponse { - // (undocumented) - resources: Array; - // (undocumented) - type: 'statefulsets'; -} - -// @public (undocumented) -export interface StatusError { - // (undocumented) - errorType: KubernetesErrorTypes; - // (undocumented) - resourcePath?: string; - // (undocumented) - statusCode?: number; -} - -// @public (undocumented) -export interface WorkloadsByEntityRequest { - // (undocumented) - auth: KubernetesRequestAuth; - // (undocumented) - entity: Entity; -} -``` diff --git a/plugins/kubernetes-node/api-report.md b/plugins/kubernetes-node/api-report.api.md similarity index 60% rename from plugins/kubernetes-node/api-report.md rename to plugins/kubernetes-node/api-report.api.md index f5b210b424..20c7f76b1f 100644 --- a/plugins/kubernetes-node/api-report.md +++ b/plugins/kubernetes-node/api-report.api.md @@ -282,4 +282,60 @@ export interface ServiceLocatorRequestContext { // (undocumented) objectTypesToFetch: Set; } + +// Warnings were encountered during analysis: +// +// src/auth/PinnipedHelper.d.ts:7:1 - (ae-undocumented) Missing documentation for "PinnipedClientCerts". +// src/auth/PinnipedHelper.d.ts:16:1 - (ae-undocumented) Missing documentation for "PinnipedParameters". +// src/auth/PinnipedHelper.d.ts:31:1 - (ae-undocumented) Missing documentation for "PinnipedHelper". +// src/auth/PinnipedHelper.d.ts:34:5 - (ae-undocumented) Missing documentation for "tokenCredentialRequest". +// src/extensions.d.ts:8:5 - (ae-undocumented) Missing documentation for "addObjectsProvider". +// src/extensions.d.ts:22:5 - (ae-undocumented) Missing documentation for "addClusterSupplier". +// src/extensions.d.ts:36:5 - (ae-undocumented) Missing documentation for "addAuthStrategy". +// src/extensions.d.ts:50:5 - (ae-undocumented) Missing documentation for "addFetcher". +// src/extensions.d.ts:64:5 - (ae-undocumented) Missing documentation for "addServiceLocator". +// src/types/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProvider". +// src/types/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "getKubernetesObjectsByEntity". +// src/types/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "getCustomResourcesByEntity". +// src/types/types.d.ts:21:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsByEntity". +// src/types/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "entity". +// src/types/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "auth". +// src/types/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "CustomResourcesByEntity". +// src/types/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "customResources". +// src/types/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "ClusterDetails". +// src/types/types.d.ts:50:5 - (ae-undocumented) Missing documentation for "url". +// src/types/types.d.ts:51:5 - (ae-undocumented) Missing documentation for "authMetadata". +// src/types/types.d.ts:52:5 - (ae-undocumented) Missing documentation for "skipTLSVerify". +// src/types/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "caData". +// src/types/types.d.ts:59:5 - (ae-undocumented) Missing documentation for "caFile". +// src/types/types.d.ts:131:1 - (ae-undocumented) Missing documentation for "AuthenticationStrategy". +// src/types/types.d.ts:132:5 - (ae-undocumented) Missing documentation for "getCredential". +// src/types/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "validateCluster". +// src/types/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". +// src/types/types.d.ts:140:1 - (ae-undocumented) Missing documentation for "KubernetesObjectTypes". +// src/types/types.d.ts:145:1 - (ae-undocumented) Missing documentation for "ObjectToFetch". +// src/types/types.d.ts:146:5 - (ae-undocumented) Missing documentation for "objectType". +// src/types/types.d.ts:147:5 - (ae-undocumented) Missing documentation for "group". +// src/types/types.d.ts:148:5 - (ae-undocumented) Missing documentation for "apiVersion". +// src/types/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "plural". +// src/types/types.d.ts:155:1 - (ae-undocumented) Missing documentation for "CustomResource". +// src/types/types.d.ts:156:5 - (ae-undocumented) Missing documentation for "objectType". +// src/types/types.d.ts:162:1 - (ae-undocumented) Missing documentation for "ObjectFetchParams". +// src/types/types.d.ts:163:5 - (ae-undocumented) Missing documentation for "serviceId". +// src/types/types.d.ts:164:5 - (ae-undocumented) Missing documentation for "clusterDetails". +// src/types/types.d.ts:165:5 - (ae-undocumented) Missing documentation for "credential". +// src/types/types.d.ts:166:5 - (ae-undocumented) Missing documentation for "objectTypesToFetch". +// src/types/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "labelSelector". +// src/types/types.d.ts:168:5 - (ae-undocumented) Missing documentation for "customResources". +// src/types/types.d.ts:169:5 - (ae-undocumented) Missing documentation for "namespace". +// src/types/types.d.ts:175:1 - (ae-undocumented) Missing documentation for "FetchResponseWrapper". +// src/types/types.d.ts:176:5 - (ae-undocumented) Missing documentation for "errors". +// src/types/types.d.ts:177:5 - (ae-undocumented) Missing documentation for "responses". +// src/types/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "fetchObjectsForService". +// src/types/types.d.ts:186:5 - (ae-undocumented) Missing documentation for "fetchPodMetricsByNamespaces". +// src/types/types.d.ts:191:1 - (ae-undocumented) Missing documentation for "ServiceLocatorRequestContext". +// src/types/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "objectTypesToFetch". +// src/types/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "customResources". +// src/types/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "credentials". +// src/types/types.d.ts:201:5 - (ae-undocumented) Missing documentation for "getClustersByEntity". ``` diff --git a/plugins/kubernetes-react/api-report.md b/plugins/kubernetes-react/api-report.api.md similarity index 51% rename from plugins/kubernetes-react/api-report.md rename to plugins/kubernetes-react/api-report.api.md index adb75a7d60..9b0080f019 100644 --- a/plugins/kubernetes-react/api-report.md +++ b/plugins/kubernetes-react/api-report.api.md @@ -865,4 +865,173 @@ export const usePodMetrics: ( clusterName: string, matcher: PodMetricsMatcher, ) => ClientPodStatus | undefined; + +// Warnings were encountered during analysis: +// +// src/api/KubernetesBackendClient.d.ts:6:1 - (ae-undocumented) Missing documentation for "KubernetesBackendClient". +// src/api/KubernetesBackendClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "getCluster". +// src/api/KubernetesBackendClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "getObjectsByEntity". +// src/api/KubernetesBackendClient.d.ts:24:5 - (ae-undocumented) Missing documentation for "getWorkloadsByEntity". +// src/api/KubernetesBackendClient.d.ts:25:5 - (ae-undocumented) Missing documentation for "getCustomObjectsByEntity". +// src/api/KubernetesBackendClient.d.ts:26:5 - (ae-undocumented) Missing documentation for "getClusters". +// src/api/KubernetesBackendClient.d.ts:30:5 - (ae-undocumented) Missing documentation for "proxy". +// src/api/KubernetesClusterLinkFormatter.d.ts:4:1 - (ae-undocumented) Missing documentation for "KubernetesClusterLinkFormatter". +// src/api/KubernetesClusterLinkFormatter.d.ts:11:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/KubernetesProxyClient.d.ts:15:5 - (ae-undocumented) Missing documentation for "getEventsByInvolvedObjectName". +// src/api/KubernetesProxyClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "getPodLogs". +// src/api/formatters/AksClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "AksClusterLinksFormatter". +// src/api/formatters/AksClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/formatters/EksClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "EksClusterLinksFormatter". +// src/api/formatters/EksClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/formatters/GkeClusterLinksFormatter.d.ts:4:1 - (ae-undocumented) Missing documentation for "GkeClusterLinksFormatter". +// src/api/formatters/GkeClusterLinksFormatter.d.ts:7:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/formatters/OpenshiftClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "OpenshiftClusterLinksFormatter". +// src/api/formatters/OpenshiftClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/formatters/RancherClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "RancherClusterLinksFormatter". +// src/api/formatters/RancherClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/formatters/StandardClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "StandardClusterLinksFormatter". +// src/api/formatters/StandardClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/api/formatters/index.d.ts:11:22 - (ae-undocumented) Missing documentation for "DEFAULT_FORMATTER_NAME". +// src/api/formatters/index.d.ts:13:1 - (ae-undocumented) Missing documentation for "getDefaultFormatters". +// src/api/types.d.ts:5:22 - (ae-undocumented) Missing documentation for "kubernetesApiRef". +// src/api/types.d.ts:7:22 - (ae-undocumented) Missing documentation for "kubernetesProxyApiRef". +// src/api/types.d.ts:9:22 - (ae-undocumented) Missing documentation for "kubernetesClusterLinkFormatterApiRef". +// src/api/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "KubernetesApi". +// src/api/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "getObjectsByEntity". +// src/api/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "getClusters". +// src/api/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "getCluster". +// src/api/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "getWorkloadsByEntity". +// src/api/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "getCustomObjectsByEntity". +// src/api/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "proxy". +// src/api/types.d.ts:33:1 - (ae-undocumented) Missing documentation for "KubernetesProxyApi". +// src/api/types.d.ts:34:5 - (ae-undocumented) Missing documentation for "getPodLogs". +// src/api/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "getEventsByInvolvedObjectName". +// src/api/types.d.ts:52:1 - (ae-undocumented) Missing documentation for "FormatClusterLinkOptions". +// src/api/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "KubernetesClusterLinkFormatterApi". +// src/api/types.d.ts:61:5 - (ae-undocumented) Missing documentation for "formatClusterLink". +// src/components/CronJobsAccordions/CronJobsAccordions.d.ts:7:1 - (ae-undocumented) Missing documentation for "CronJobsAccordionsProps". +// src/components/CronJobsAccordions/CronJobsAccordions.d.ts:15:22 - (ae-undocumented) Missing documentation for "CronJobsAccordions". +// src/components/CustomResources/CustomResources.d.ts:7:1 - (ae-undocumented) Missing documentation for "CustomResourcesProps". +// src/components/CustomResources/CustomResources.d.ts:8:5 - (ae-undocumented) Missing documentation for "children". +// src/components/CustomResources/CustomResources.d.ts:15:22 - (ae-undocumented) Missing documentation for "CustomResources". +// src/components/ErrorPanel/ErrorPanel.d.ts:8:1 - (ae-undocumented) Missing documentation for "ErrorPanelProps". +// src/components/ErrorPanel/ErrorPanel.d.ts:19:22 - (ae-undocumented) Missing documentation for "ErrorPanel". +// src/components/ErrorReporting/ErrorReporting.d.ts:8:1 - (ae-undocumented) Missing documentation for "ErrorReportingProps". +// src/components/ErrorReporting/ErrorReporting.d.ts:17:22 - (ae-undocumented) Missing documentation for "ErrorReporting". +// src/components/HorizontalPodAutoscalers/HorizontalPodAutoscalerDrawer.d.ts:4:22 - (ae-undocumented) Missing documentation for "HorizontalPodAutoscalerDrawer". +// src/components/IngressesAccordions/IngressesAccordions.d.ts:7:1 - (ae-undocumented) Missing documentation for "IngressesAccordionsProps". +// src/components/IngressesAccordions/IngressesAccordions.d.ts:13:22 - (ae-undocumented) Missing documentation for "IngressesAccordions". +// src/components/JobsAccordions/JobsAccordions.d.ts:8:1 - (ae-undocumented) Missing documentation for "JobsAccordionsProps". +// src/components/JobsAccordions/JobsAccordions.d.ts:17:22 - (ae-undocumented) Missing documentation for "JobsAccordions". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:10:5 - (ae-undocumented) Missing documentation for "metadata". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:18:5 - (ae-undocumented) Missing documentation for "open". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:19:5 - (ae-undocumented) Missing documentation for "kubernetesObject". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:20:5 - (ae-undocumented) Missing documentation for "label". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:21:5 - (ae-undocumented) Missing documentation for "drawerContentsHeader". +// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:22:5 - (ae-undocumented) Missing documentation for "children". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:9:1 - (ae-undocumented) Missing documentation for "LinkErrorPanelProps". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:19:22 - (ae-undocumented) Missing documentation for "LinkErrorPanel". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:25:1 - (ae-undocumented) Missing documentation for "KubernetesDrawerable". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:26:5 - (ae-undocumented) Missing documentation for "metadata". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:32:1 - (ae-undocumented) Missing documentation for "KubernetesStructuredMetadataTableDrawerProps". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:33:5 - (ae-undocumented) Missing documentation for "object". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:34:5 - (ae-undocumented) Missing documentation for "renderObject". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:35:5 - (ae-undocumented) Missing documentation for "buttonVariant". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:36:5 - (ae-undocumented) Missing documentation for "kind". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:37:5 - (ae-undocumented) Missing documentation for "expanded". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:38:5 - (ae-undocumented) Missing documentation for "children". +// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:44:22 - (ae-undocumented) Missing documentation for "KubernetesStructuredMetadataTableDrawer". +// src/components/KubernetesDrawer/ManifestYaml.d.ts:8:5 - (ae-undocumented) Missing documentation for "object". +// src/components/PodExecTerminal/PodExecTerminal.d.ts:10:5 - (ae-undocumented) Missing documentation for "cluster". +// src/components/PodExecTerminal/PodExecTerminal.d.ts:11:5 - (ae-undocumented) Missing documentation for "containerName". +// src/components/PodExecTerminal/PodExecTerminal.d.ts:12:5 - (ae-undocumented) Missing documentation for "podName". +// src/components/PodExecTerminal/PodExecTerminal.d.ts:13:5 - (ae-undocumented) Missing documentation for "podNamespace". +// src/components/Pods/ErrorList/ErrorList.d.ts:9:5 - (ae-undocumented) Missing documentation for "podAndErrors". +// src/components/Pods/Events/Events.d.ts:9:5 - (ae-undocumented) Missing documentation for "warningEventsOnly". +// src/components/Pods/Events/Events.d.ts:10:5 - (ae-undocumented) Missing documentation for "events". +// src/components/Pods/Events/Events.d.ts:24:5 - (ae-undocumented) Missing documentation for "involvedObjectName". +// src/components/Pods/Events/Events.d.ts:25:5 - (ae-undocumented) Missing documentation for "namespace". +// src/components/Pods/Events/Events.d.ts:26:5 - (ae-undocumented) Missing documentation for "clusterName". +// src/components/Pods/Events/Events.d.ts:27:5 - (ae-undocumented) Missing documentation for "warningEventsOnly". +// src/components/Pods/Events/useEvents.d.ts:7:5 - (ae-undocumented) Missing documentation for "involvedObjectName". +// src/components/Pods/Events/useEvents.d.ts:8:5 - (ae-undocumented) Missing documentation for "namespace". +// src/components/Pods/Events/useEvents.d.ts:9:5 - (ae-undocumented) Missing documentation for "clusterName". +// src/components/Pods/FixDialog/FixDialog.d.ts:10:5 - (ae-undocumented) Missing documentation for "open". +// src/components/Pods/FixDialog/FixDialog.d.ts:11:5 - (ae-undocumented) Missing documentation for "clusterName". +// src/components/Pods/FixDialog/FixDialog.d.ts:12:5 - (ae-undocumented) Missing documentation for "pod". +// src/components/Pods/FixDialog/FixDialog.d.ts:13:5 - (ae-undocumented) Missing documentation for "error". +// src/components/Pods/PodDrawer/ContainerCard.d.ts:11:5 - (ae-undocumented) Missing documentation for "podScope". +// src/components/Pods/PodDrawer/ContainerCard.d.ts:12:5 - (ae-undocumented) Missing documentation for "containerSpec". +// src/components/Pods/PodDrawer/ContainerCard.d.ts:13:5 - (ae-undocumented) Missing documentation for "containerStatus". +// src/components/Pods/PodDrawer/ContainerCard.d.ts:14:5 - (ae-undocumented) Missing documentation for "containerMetrics". +// src/components/Pods/PodDrawer/PendingPodContent.d.ts:9:5 - (ae-undocumented) Missing documentation for "pod". +// src/components/Pods/PodDrawer/PodDrawer.d.ts:9:5 - (ae-undocumented) Missing documentation for "open". +// src/components/Pods/PodDrawer/PodDrawer.d.ts:10:5 - (ae-undocumented) Missing documentation for "podAndErrors". +// src/components/Pods/PodLogs/PodLogs.d.ts:9:5 - (ae-undocumented) Missing documentation for "containerScope". +// src/components/Pods/PodLogs/PodLogs.d.ts:10:5 - (ae-undocumented) Missing documentation for "previous". +// src/components/Pods/PodLogs/PodLogsDialog.d.ts:9:5 - (ae-undocumented) Missing documentation for "containerScope". +// src/components/Pods/PodLogs/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "podName". +// src/components/Pods/PodLogs/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "podNamespace". +// src/components/Pods/PodLogs/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "cluster". +// src/components/Pods/PodLogs/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "containerName". +// src/components/Pods/PodLogs/usePodLogs.d.ts:8:5 - (ae-undocumented) Missing documentation for "containerScope". +// src/components/Pods/PodLogs/usePodLogs.d.ts:9:5 - (ae-undocumented) Missing documentation for "previous". +// src/components/Pods/PodsTable.d.ts:9:22 - (ae-undocumented) Missing documentation for "READY_COLUMNS". +// src/components/Pods/PodsTable.d.ts:15:22 - (ae-undocumented) Missing documentation for "RESOURCE_COLUMNS". +// src/components/Pods/PodsTable.d.ts:21:1 - (ae-undocumented) Missing documentation for "PodColumns". +// src/components/Pods/PodsTable.d.ts:27:1 - (ae-undocumented) Missing documentation for "PodsTablesProps". +// src/components/Pods/PodsTable.d.ts:37:22 - (ae-undocumented) Missing documentation for "PodsTable". +// src/components/Pods/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "cluster". +// src/components/Pods/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "pod". +// src/components/Pods/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "errors". +// src/components/ResourceUtilization/ResourceUtilization.d.ts:8:5 - (ae-undocumented) Missing documentation for "compressed". +// src/components/ResourceUtilization/ResourceUtilization.d.ts:9:5 - (ae-undocumented) Missing documentation for "title". +// src/components/ResourceUtilization/ResourceUtilization.d.ts:10:5 - (ae-undocumented) Missing documentation for "usage". +// src/components/ResourceUtilization/ResourceUtilization.d.ts:11:5 - (ae-undocumented) Missing documentation for "total". +// src/components/ResourceUtilization/ResourceUtilization.d.ts:12:5 - (ae-undocumented) Missing documentation for "totalFormatted". +// src/components/ServicesAccordions/ServicesAccordions.d.ts:7:1 - (ae-undocumented) Missing documentation for "ServicesAccordionsProps". +// src/components/ServicesAccordions/ServicesAccordions.d.ts:13:22 - (ae-undocumented) Missing documentation for "ServicesAccordions". +// src/hooks/Cluster.d.ts:6:22 - (ae-undocumented) Missing documentation for "ClusterContext". +// src/hooks/GroupedResponses.d.ts:8:22 - (ae-undocumented) Missing documentation for "GroupedResponsesContext". +// src/hooks/PodNamesWithErrors.d.ts:5:22 - (ae-undocumented) Missing documentation for "PodNamesWithErrorsContext". +// src/hooks/PodNamesWithMetrics.d.ts:6:22 - (ae-undocumented) Missing documentation for "PodNamesWithMetricsContext". +// src/hooks/useKubernetesObjects.d.ts:7:1 - (ae-undocumented) Missing documentation for "KubernetesObjects". +// src/hooks/useKubernetesObjects.d.ts:8:5 - (ae-undocumented) Missing documentation for "kubernetesObjects". +// src/hooks/useKubernetesObjects.d.ts:9:5 - (ae-undocumented) Missing documentation for "loading". +// src/hooks/useKubernetesObjects.d.ts:10:5 - (ae-undocumented) Missing documentation for "error". +// src/hooks/useKubernetesObjects.d.ts:16:22 - (ae-undocumented) Missing documentation for "useKubernetesObjects". +// src/hooks/useMatchingErrors.d.ts:15:1 - (ae-undocumented) Missing documentation for "ErrorMatcher". +// src/hooks/usePodMetrics.d.ts:13:1 - (ae-undocumented) Missing documentation for "PodMetricsMatcher". +// src/kubernetes-auth-provider/AksKubernetesAuthProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "AksKubernetesAuthProvider". +// src/kubernetes-auth-provider/AksKubernetesAuthProvider.d.ts:8:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/AksKubernetesAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GoogleKubernetesAuthProvider". +// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:6:5 - (ae-undocumented) Missing documentation for "authProvider". +// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:8:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/kubernetes-auth-provider/KubernetesAuthProviders.d.ts:5:1 - (ae-undocumented) Missing documentation for "KubernetesAuthProviders". +// src/kubernetes-auth-provider/KubernetesAuthProviders.d.ts:14:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/KubernetesAuthProviders.d.ts:15:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "OidcKubernetesAuthProvider". +// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:6:5 - (ae-undocumented) Missing documentation for "providerName". +// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:7:5 - (ae-undocumented) Missing documentation for "authProvider". +// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/kubernetes-auth-provider/ServerSideAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/ServerSideAuthProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/kubernetes-auth-provider/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "KubernetesAuthProvider". +// src/kubernetes-auth-provider/types.d.ts:4:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/types.d.ts:5:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/kubernetes-auth-provider/types.d.ts:10:22 - (ae-undocumented) Missing documentation for "kubernetesAuthProvidersApiRef". +// src/kubernetes-auth-provider/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "KubernetesAuthProvidersApi". +// src/kubernetes-auth-provider/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". +// src/kubernetes-auth-provider/types.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredentials". +// src/types/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ClusterLinksFormatterOptions". +// src/types/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "dashboardUrl". +// src/types/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "dashboardParameters". +// src/types/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "object". +// src/types/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". +// src/types/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "ClusterLinksFormatter". +// src/types/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "formatClusterLink". ``` diff --git a/plugins/kubernetes/api-report.md b/plugins/kubernetes/api-report.api.md similarity index 80% rename from plugins/kubernetes/api-report.md rename to plugins/kubernetes/api-report.api.md index 64b56cf786..e5038b674a 100644 --- a/plugins/kubernetes/api-report.md +++ b/plugins/kubernetes/api-report.api.md @@ -47,4 +47,11 @@ export const Router: (props: { }) => React_2.JSX.Element; export * from '@backstage/plugin-kubernetes-react'; + +// Warnings were encountered during analysis: +// +// src/Router.d.ts:3:22 - (ae-undocumented) Missing documentation for "isKubernetesAvailable". +// src/Router.d.ts:4:22 - (ae-undocumented) Missing documentation for "Router". +// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "kubernetesPlugin". +// src/plugin.d.ts:17:22 - (ae-undocumented) Missing documentation for "EntityKubernetesContent". ``` diff --git a/plugins/notifications-backend-module-email/api-report.md b/plugins/notifications-backend-module-email/api-report.api.md similarity index 57% rename from plugins/notifications-backend-module-email/api-report.md rename to plugins/notifications-backend-module-email/api-report.api.md index be3b58d1fd..2116bd4ef4 100644 --- a/plugins/notifications-backend-module-email/api-report.md +++ b/plugins/notifications-backend-module-email/api-report.api.md @@ -29,4 +29,15 @@ export interface NotificationTemplateRenderer { // (undocumented) getText?(notification: Notification_2): Promise; } + +// Warnings were encountered during analysis: +// +// src/extensions.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationTemplateRenderer". +// src/extensions.d.ts:6:5 - (ae-undocumented) Missing documentation for "getSubject". +// src/extensions.d.ts:7:5 - (ae-undocumented) Missing documentation for "getText". +// src/extensions.d.ts:8:5 - (ae-undocumented) Missing documentation for "getHtml". +// src/extensions.d.ts:13:1 - (ae-undocumented) Missing documentation for "NotificationsEmailTemplateExtensionPoint". +// src/extensions.d.ts:14:5 - (ae-undocumented) Missing documentation for "setTemplateRenderer". +// src/extensions.d.ts:19:22 - (ae-undocumented) Missing documentation for "notificationsEmailTemplateExtensionPoint". +// src/module.d.ts:4:22 - (ae-undocumented) Missing documentation for "notificationsModuleEmail". ``` diff --git a/plugins/notifications-backend/api-report.md b/plugins/notifications-backend/api-report.api.md similarity index 100% rename from plugins/notifications-backend/api-report.md rename to plugins/notifications-backend/api-report.api.md diff --git a/plugins/notifications-common/api-report.md b/plugins/notifications-common/api-report.api.md similarity index 64% rename from plugins/notifications-common/api-report.md rename to plugins/notifications-common/api-report.api.md index 0f59a85849..a02bfb2eaa 100644 --- a/plugins/notifications-common/api-report.md +++ b/plugins/notifications-common/api-report.api.md @@ -67,4 +67,16 @@ export type NotificationStatus = { unread: number; read: number; }; + +// Warnings were encountered during analysis: +// +// src/filters.d.ts:4:22 - (ae-undocumented) Missing documentation for "getProcessorFiltersFromConfig". +// src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "NotificationSeverity". +// src/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "NotificationPayload". +// src/types.d.ts:36:1 - (ae-undocumented) Missing documentation for "Notification". +// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "NotificationStatus". +// src/types.d.ts:84:1 - (ae-undocumented) Missing documentation for "NewNotificationSignal". +// src/types.d.ts:89:1 - (ae-undocumented) Missing documentation for "NotificationReadSignal". +// src/types.d.ts:94:1 - (ae-undocumented) Missing documentation for "NotificationSignal". +// src/types.d.ts:98:1 - (ae-undocumented) Missing documentation for "NotificationProcessorFilters". ``` diff --git a/plugins/notifications-node/api-report.md b/plugins/notifications-node/api-report.api.md similarity index 64% rename from plugins/notifications-node/api-report.md rename to plugins/notifications-node/api-report.api.md index 995b98bc21..869bf6c6bb 100644 --- a/plugins/notifications-node/api-report.md +++ b/plugins/notifications-node/api-report.api.md @@ -87,4 +87,20 @@ export interface NotificationsProcessingExtensionPoint { // @public (undocumented) export const notificationsProcessingExtensionPoint: ExtensionPoint; + +// Warnings were encountered during analysis: +// +// src/extensions.d.ts:73:1 - (ae-undocumented) Missing documentation for "NotificationsProcessingExtensionPoint". +// src/extensions.d.ts:74:5 - (ae-undocumented) Missing documentation for "addProcessor". +// src/extensions.d.ts:79:22 - (ae-undocumented) Missing documentation for "notificationsProcessingExtensionPoint". +// src/extensions.d.ts:84:1 - (ae-undocumented) Missing documentation for "NotificationProcessorFilters". +// src/lib.d.ts:3:22 - (ae-undocumented) Missing documentation for "notificationService". +// src/service/DefaultNotificationService.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationServiceOptions". +// src/service/DefaultNotificationService.d.ts:10:1 - (ae-undocumented) Missing documentation for "NotificationRecipients". +// src/service/DefaultNotificationService.d.ts:26:1 - (ae-undocumented) Missing documentation for "NotificationSendOptions". +// src/service/DefaultNotificationService.d.ts:31:1 - (ae-undocumented) Missing documentation for "DefaultNotificationService". +// src/service/DefaultNotificationService.d.ts:35:5 - (ae-undocumented) Missing documentation for "create". +// src/service/DefaultNotificationService.d.ts:36:5 - (ae-undocumented) Missing documentation for "send". +// src/service/NotificationService.d.ts:3:1 - (ae-undocumented) Missing documentation for "NotificationService". +// src/service/NotificationService.d.ts:4:5 - (ae-undocumented) Missing documentation for "send". ``` diff --git a/plugins/notifications/api-report.md b/plugins/notifications/api-report.api.md similarity index 100% rename from plugins/notifications/api-report.md rename to plugins/notifications/api-report.api.md diff --git a/plugins/org-react/api-report.md b/plugins/org-react/api-report.api.md similarity index 77% rename from plugins/org-react/api-report.md rename to plugins/org-react/api-report.api.md index 5cfe5ca90a..924f1ea7ca 100644 --- a/plugins/org-react/api-report.md +++ b/plugins/org-react/api-report.api.md @@ -19,5 +19,9 @@ export type GroupListPickerProps = { onChange: (value: GroupEntity | undefined) => void; }; +// Warnings were encountered during analysis: +// +// src/components/GroupListPicker/GroupListPicker.d.ts:15:22 - (ae-undocumented) Missing documentation for "GroupListPicker". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/api-report-alpha.md b/plugins/org/api-report-alpha.api.md similarity index 97% rename from plugins/org/api-report-alpha.md rename to plugins/org/api-report-alpha.api.md index 1040b61733..eaa98f98d1 100644 --- a/plugins/org/api-report-alpha.md +++ b/plugins/org/api-report-alpha.api.md @@ -161,5 +161,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/api-report.md b/plugins/org/api-report.api.md similarity index 73% rename from plugins/org/api-report.md rename to plugins/org/api-report.api.md index af03687240..fd1e3010e9 100644 --- a/plugins/org/api-report.md +++ b/plugins/org/api-report.api.md @@ -102,4 +102,17 @@ export const UserProfileCard: (props: { variant?: InfoCardVariants; showLinks?: boolean; }) => React_2.JSX.Element; + +// Warnings were encountered during analysis: +// +// src/components/Cards/Group/GroupProfile/GroupProfileCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "GroupProfileCard". +// src/components/Cards/Group/MembersList/MembersListCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "MembersListCard". +// src/components/Cards/OwnershipCard/OwnershipCard.d.ts:5:22 - (ae-undocumented) Missing documentation for "OwnershipCard". +// src/components/Cards/User/UserProfileCard/UserProfileCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "UserProfileCard". +// src/components/Cards/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "EntityRelationAggregation". +// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "orgPlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "EntityGroupProfileCard". +// src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityMembersListCard". +// src/plugin.d.ts:21:22 - (ae-undocumented) Missing documentation for "EntityOwnershipCard". +// src/plugin.d.ts:30:22 - (ae-undocumented) Missing documentation for "EntityUserProfileCard". ``` diff --git a/plugins/permission-backend-module-policy-allow-all/api-report.md b/plugins/permission-backend-module-policy-allow-all/api-report.api.md similarity index 100% rename from plugins/permission-backend-module-policy-allow-all/api-report.md rename to plugins/permission-backend-module-policy-allow-all/api-report.api.md diff --git a/plugins/permission-backend/api-report-alpha.md b/plugins/permission-backend/api-report-alpha.api.md similarity index 100% rename from plugins/permission-backend/api-report-alpha.md rename to plugins/permission-backend/api-report-alpha.api.md diff --git a/plugins/permission-backend/api-report.md b/plugins/permission-backend/api-report.api.md similarity index 62% rename from plugins/permission-backend/api-report.md rename to plugins/permission-backend/api-report.api.md index bd976a8d7b..11d5ca7d62 100644 --- a/plugins/permission-backend/api-report.md +++ b/plugins/permission-backend/api-report.api.md @@ -35,4 +35,15 @@ export interface RouterOptions { // (undocumented) userInfo?: UserInfoService; } + +// Warnings were encountered during analysis: +// +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "policy". +// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "identity". +// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:19:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:20:5 - (ae-undocumented) Missing documentation for "userInfo". ``` diff --git a/plugins/permission-common/api-report.md b/plugins/permission-common/api-report.api.md similarity index 97% rename from plugins/permission-common/api-report.md rename to plugins/permission-common/api-report.api.md index 465c43846f..856b650dba 100644 --- a/plugins/permission-common/api-report.md +++ b/plugins/permission-common/api-report.api.md @@ -261,4 +261,8 @@ export type ResourcePermission = export function toPermissionEvaluator( permissionAuthorizer: PermissionAuthorizer, ): PermissionEvaluator; + +// Warnings were encountered during analysis: +// +// src/types/permission.d.ts:71:5 - (ae-undocumented) Missing documentation for "authorize". ``` diff --git a/plugins/permission-node/api-report-alpha.md b/plugins/permission-node/api-report-alpha.api.md similarity index 100% rename from plugins/permission-node/api-report-alpha.md rename to plugins/permission-node/api-report-alpha.api.md diff --git a/plugins/permission-node/api-report.md b/plugins/permission-node/api-report.api.md similarity index 93% rename from plugins/permission-node/api-report.md rename to plugins/permission-node/api-report.api.md index 0f0885e180..8dd8ac3c88 100644 --- a/plugins/permission-node/api-report.md +++ b/plugins/permission-node/api-report.api.md @@ -149,7 +149,7 @@ export type CreatePermissionIntegrationRouterResourceOptions< > = { resourceType: TResourceType; permissions?: Array; - rules: PermissionRule>[]; + rules: PermissionRule>[]; getResources?: ( resourceRefs: string[], ) => Promise>; @@ -255,8 +255,8 @@ export type PermissionRule< description: string; resourceType: TResourceType; paramsSchema?: z.ZodSchema; - apply(resource: TResource, params: NoInfer): boolean; - toQuery(params: NoInfer): PermissionCriteria; + apply(resource: TResource, params: NoInfer_2): boolean; + toQuery(params: NoInfer_2): PermissionCriteria; }; // @public @@ -295,4 +295,11 @@ export class ServerPermissionClient implements PermissionsService { }, ): ServerPermissionClient; } + +// Warnings were encountered during analysis: +// +// src/ServerPermissionClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/ServerPermissionClient.d.ts:18:5 - (ae-undocumented) Missing documentation for "authorizeConditional". +// src/ServerPermissionClient.d.ts:19:5 - (ae-undocumented) Missing documentation for "authorize". +// src/policy/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "handle". ``` diff --git a/plugins/permission-react/api-report.md b/plugins/permission-react/api-report.api.md similarity index 88% rename from plugins/permission-react/api-report.md rename to plugins/permission-react/api-report.api.md index 4c51d16b80..d1b5de1d9e 100644 --- a/plugins/permission-react/api-report.md +++ b/plugins/permission-react/api-report.api.md @@ -100,4 +100,10 @@ export function usePermission( resourceRef: string | undefined; }, ): AsyncPermissionResult; + +// Warnings were encountered during analysis: +// +// src/apis/IdentityPermissionApi.d.ts:14:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/IdentityPermissionApi.d.ts:19:5 - (ae-undocumented) Missing documentation for "authorize". +// src/hooks/usePermission.d.ts:3:1 - (ae-undocumented) Missing documentation for "AsyncPermissionResult". ``` diff --git a/plugins/proxy-backend/api-report-alpha.md b/plugins/proxy-backend/api-report-alpha.api.md similarity index 100% rename from plugins/proxy-backend/api-report-alpha.md rename to plugins/proxy-backend/api-report-alpha.api.md diff --git a/plugins/proxy-backend/api-report.md b/plugins/proxy-backend/api-report.api.md similarity index 56% rename from plugins/proxy-backend/api-report.md rename to plugins/proxy-backend/api-report.api.md index 9e1b5087f1..7590d3b8d4 100644 --- a/plugins/proxy-backend/api-report.md +++ b/plugins/proxy-backend/api-report.api.md @@ -24,4 +24,13 @@ export interface RouterOptions { // (undocumented) skipInvalidProxies?: boolean; } + +// Warnings were encountered during analysis: +// +// src/service/router.d.ts:8:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "skipInvalidProxies". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "reviveConsumedRequestBodies". ``` diff --git a/plugins/scaffolder-backend-module-azure/api-report.md b/plugins/scaffolder-backend-module-azure/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-azure/api-report.md rename to plugins/scaffolder-backend-module-azure/api-report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket-cloud/api-report.md b/plugins/scaffolder-backend-module-bitbucket-cloud/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-bitbucket-cloud/api-report.md rename to plugins/scaffolder-backend-module-bitbucket-cloud/api-report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket-server/api-report.md b/plugins/scaffolder-backend-module-bitbucket-server/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-bitbucket-server/api-report.md rename to plugins/scaffolder-backend-module-bitbucket-server/api-report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket/api-report.md b/plugins/scaffolder-backend-module-bitbucket/api-report.api.md similarity index 80% rename from plugins/scaffolder-backend-module-bitbucket/api-report.md rename to plugins/scaffolder-backend-module-bitbucket/api-report.api.md index 952b1665fb..34c9eb8c67 100644 --- a/plugins/scaffolder-backend-module-bitbucket/api-report.md +++ b/plugins/scaffolder-backend-module-bitbucket/api-report.api.md @@ -56,4 +56,11 @@ export const createPublishBitbucketServerAction: typeof bitbucketServer.createPu // @public @deprecated (undocumented) export const createPublishBitbucketServerPullRequestAction: typeof bitbucketServer.createPublishBitbucketServerPullRequestAction; + +// Warnings were encountered during analysis: +// +// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". +// src/deprecated.d.ts:11:22 - (ae-undocumented) Missing documentation for "createBitbucketPipelinesRunAction". +// src/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". +// src/deprecated.d.ts:26:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". ``` diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md b/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md similarity index 82% rename from plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md rename to plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md index 2dd5e244dd..4d08c12e7d 100644 --- a/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md +++ b/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md @@ -26,4 +26,8 @@ export const createConfluenceToMarkdownAction: (options: { }, JsonObject >; + +// Warnings were encountered during analysis: +// +// src/actions/confluence/confluenceToMarkdown.d.ts:7:22 - (ae-undocumented) Missing documentation for "createConfluenceToMarkdownAction". ``` diff --git a/plugins/scaffolder-backend-module-cookiecutter/api-report.md b/plugins/scaffolder-backend-module-cookiecutter/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-cookiecutter/api-report.md rename to plugins/scaffolder-backend-module-cookiecutter/api-report.api.md diff --git a/plugins/scaffolder-backend-module-gcp/api-report.md b/plugins/scaffolder-backend-module-gcp/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gcp/api-report.md rename to plugins/scaffolder-backend-module-gcp/api-report.api.md diff --git a/plugins/scaffolder-backend-module-gerrit/api-report.md b/plugins/scaffolder-backend-module-gerrit/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gerrit/api-report.md rename to plugins/scaffolder-backend-module-gerrit/api-report.api.md diff --git a/plugins/scaffolder-backend-module-gitea/api-report.md b/plugins/scaffolder-backend-module-gitea/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gitea/api-report.md rename to plugins/scaffolder-backend-module-gitea/api-report.api.md diff --git a/plugins/scaffolder-backend-module-github/api-report.md b/plugins/scaffolder-backend-module-github/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-github/api-report.md rename to plugins/scaffolder-backend-module-github/api-report.api.md diff --git a/plugins/scaffolder-backend-module-gitlab/api-report.md b/plugins/scaffolder-backend-module-gitlab/api-report.api.md similarity index 92% rename from plugins/scaffolder-backend-module-gitlab/api-report.md rename to plugins/scaffolder-backend-module-gitlab/api-report.api.md index 49bda648f6..f00055a876 100644 --- a/plugins/scaffolder-backend-module-gitlab/api-report.md +++ b/plugins/scaffolder-backend-module-gitlab/api-report.api.md @@ -277,4 +277,13 @@ export enum IssueType { // (undocumented) TEST = 'test_case', } + +// Warnings were encountered during analysis: +// +// src/commonGitlabConfig.d.ts:23:5 - (ae-undocumented) Missing documentation for "ISSUE". +// src/commonGitlabConfig.d.ts:24:5 - (ae-undocumented) Missing documentation for "INCIDENT". +// src/commonGitlabConfig.d.ts:25:5 - (ae-undocumented) Missing documentation for "TEST". +// src/commonGitlabConfig.d.ts:26:5 - (ae-undocumented) Missing documentation for "TASK". +// src/commonGitlabConfig.d.ts:34:5 - (ae-undocumented) Missing documentation for "CLOSE". +// src/commonGitlabConfig.d.ts:35:5 - (ae-undocumented) Missing documentation for "REOPEN". ``` diff --git a/plugins/scaffolder-backend-module-notifications/api-report.md b/plugins/scaffolder-backend-module-notifications/api-report.api.md similarity index 86% rename from plugins/scaffolder-backend-module-notifications/api-report.md rename to plugins/scaffolder-backend-module-notifications/api-report.api.md index 091782449f..7e283573b0 100644 --- a/plugins/scaffolder-backend-module-notifications/api-report.md +++ b/plugins/scaffolder-backend-module-notifications/api-report.api.md @@ -29,4 +29,8 @@ export function createSendNotificationAction(options: { // @public const scaffolderModuleNotifications: BackendFeature; export default scaffolderModuleNotifications; + +// Warnings were encountered during analysis: +// +// src/actions/sendNotification.d.ts:6:1 - (ae-undocumented) Missing documentation for "createSendNotificationAction". ``` diff --git a/plugins/scaffolder-backend-module-rails/api-report.md b/plugins/scaffolder-backend-module-rails/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-rails/api-report.md rename to plugins/scaffolder-backend-module-rails/api-report.api.md diff --git a/plugins/scaffolder-backend-module-sentry/api-report.md b/plugins/scaffolder-backend-module-sentry/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-sentry/api-report.md rename to plugins/scaffolder-backend-module-sentry/api-report.api.md diff --git a/plugins/scaffolder-backend-module-yeoman/api-report.md b/plugins/scaffolder-backend-module-yeoman/api-report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-yeoman/api-report.md rename to plugins/scaffolder-backend-module-yeoman/api-report.api.md diff --git a/plugins/scaffolder-backend/api-report-alpha.md b/plugins/scaffolder-backend/api-report-alpha.api.md similarity index 93% rename from plugins/scaffolder-backend/api-report-alpha.md rename to plugins/scaffolder-backend/api-report-alpha.api.md index db62c6caf7..d53ce7a4e4 100644 --- a/plugins/scaffolder-backend/api-report-alpha.md +++ b/plugins/scaffolder-backend/api-report-alpha.api.md @@ -93,5 +93,9 @@ export const scaffolderTemplateConditions: Conditions<{ >; }>; +// Warnings were encountered during analysis: +// +// src/service/conditionExports.d.ts:48:22 - (ae-undocumented) Missing documentation for "createScaffolderActionConditionalDecision". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.api.md similarity index 67% rename from plugins/scaffolder-backend/api-report.md rename to plugins/scaffolder-backend/api-report.api.md index 3d76fb8fb1..082e0baaa5 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.api.md @@ -835,4 +835,115 @@ export type TemplatePermissionRuleInput< typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, TParams >; + +// Warnings were encountered during analysis: +// +// src/deprecated.d.ts:8:1 - (ae-undocumented) Missing documentation for "ActionContext". +// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "createTemplateAction". +// src/deprecated.d.ts:18:1 - (ae-undocumented) Missing documentation for "TaskSecrets". +// src/deprecated.d.ts:23:1 - (ae-undocumented) Missing documentation for "TemplateAction". +// src/lib/templating/SecureTemplater.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateFilter". +// src/lib/templating/SecureTemplater.d.ts:11:1 - (ae-undocumented) Missing documentation for "TemplateGlobal". +// src/scaffolder/actions/TemplateActionRegistry.d.ts:8:5 - (ae-undocumented) Missing documentation for "register". +// src/scaffolder/actions/TemplateActionRegistry.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". +// src/scaffolder/actions/TemplateActionRegistry.d.ts:10:5 - (ae-undocumented) Missing documentation for "list". +// src/scaffolder/actions/builtin/createBuiltinActions.d.ts:37:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". +// src/scaffolder/actions/deprecated.d.ts:11:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". +// src/scaffolder/actions/deprecated.d.ts:15:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". +// src/scaffolder/actions/deprecated.d.ts:19:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". +// src/scaffolder/actions/deprecated.d.ts:23:22 - (ae-undocumented) Missing documentation for "createGithubIssuesLabelAction". +// src/scaffolder/actions/deprecated.d.ts:27:1 - (ae-undocumented) Missing documentation for "CreateGithubPullRequestActionOptions". +// src/scaffolder/actions/deprecated.d.ts:31:22 - (ae-undocumented) Missing documentation for "createGithubRepoCreateAction". +// src/scaffolder/actions/deprecated.d.ts:35:22 - (ae-undocumented) Missing documentation for "createGithubRepoPushAction". +// src/scaffolder/actions/deprecated.d.ts:39:22 - (ae-undocumented) Missing documentation for "createGithubWebhookAction". +// src/scaffolder/actions/deprecated.d.ts:43:22 - (ae-undocumented) Missing documentation for "createPublishGithubAction". +// src/scaffolder/actions/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "createPublishGithubPullRequestAction". +// src/scaffolder/actions/deprecated.d.ts:69:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketAction". +// src/scaffolder/actions/deprecated.d.ts:73:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". +// src/scaffolder/actions/deprecated.d.ts:77:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". +// src/scaffolder/actions/deprecated.d.ts:81:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". +// src/scaffolder/actions/deprecated.d.ts:85:22 - (ae-undocumented) Missing documentation for "createPublishAzureAction". +// src/scaffolder/actions/deprecated.d.ts:89:22 - (ae-undocumented) Missing documentation for "createPublishGerritAction". +// src/scaffolder/actions/deprecated.d.ts:93:22 - (ae-undocumented) Missing documentation for "createPublishGerritReviewAction". +// src/scaffolder/actions/deprecated.d.ts:97:22 - (ae-undocumented) Missing documentation for "createPublishGitlabAction". +// src/scaffolder/actions/deprecated.d.ts:101:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:41:5 - (ae-undocumented) Missing documentation for "create". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:48:5 - (ae-undocumented) Missing documentation for "list". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:53:5 - (ae-undocumented) Missing documentation for "getTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:54:5 - (ae-undocumented) Missing documentation for "createTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:55:5 - (ae-undocumented) Missing documentation for "claimTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:56:5 - (ae-undocumented) Missing documentation for "heartbeatTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:57:5 - (ae-undocumented) Missing documentation for "listStaleTasks". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:65:5 - (ae-undocumented) Missing documentation for "completeTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:70:5 - (ae-undocumented) Missing documentation for "emitLogEvent". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:73:5 - (ae-undocumented) Missing documentation for "getTaskState". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:78:5 - (ae-undocumented) Missing documentation for "saveTaskState". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:82:5 - (ae-undocumented) Missing documentation for "listEvents". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:85:5 - (ae-undocumented) Missing documentation for "shutdownTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:86:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:90:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:93:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:97:5 - (ae-undocumented) Missing documentation for "cancelTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:100:5 - (ae-undocumented) Missing documentation for "recoverTasks". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:24:5 - (ae-undocumented) Missing documentation for "create". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:26:5 - (ae-undocumented) Missing documentation for "spec". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:27:5 - (ae-undocumented) Missing documentation for "cancelSignal". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:28:5 - (ae-undocumented) Missing documentation for "secrets". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:29:5 - (ae-undocumented) Missing documentation for "createdBy". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:30:5 - (ae-undocumented) Missing documentation for "getWorkspaceName". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:31:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:35:5 - (ae-undocumented) Missing documentation for "done". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:36:5 - (ae-undocumented) Missing documentation for "emitLog". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:37:5 - (ae-undocumented) Missing documentation for "getTaskState". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:40:5 - (ae-undocumented) Missing documentation for "updateCheckpoint". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:49:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:52:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:53:5 - (ae-undocumented) Missing documentation for "complete". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:55:5 - (ae-undocumented) Missing documentation for "getInitiatorCredentials". +// src/scaffolder/tasks/StorageTaskBroker.d.ts:83:5 - (ae-undocumented) Missing documentation for "workspace". +// src/scaffolder/tasks/TaskWorker.d.ts:60:5 - (ae-undocumented) Missing documentation for "create". +// src/scaffolder/tasks/TaskWorker.d.ts:61:5 - (ae-undocumented) Missing documentation for "recoverTasks". +// src/scaffolder/tasks/TaskWorker.d.ts:62:5 - (ae-undocumented) Missing documentation for "start". +// src/scaffolder/tasks/TaskWorker.d.ts:63:5 - (ae-undocumented) Missing documentation for "stop". +// src/scaffolder/tasks/TaskWorker.d.ts:64:5 - (ae-undocumented) Missing documentation for "onReadyToClaimTask". +// src/scaffolder/tasks/TaskWorker.d.ts:65:5 - (ae-undocumented) Missing documentation for "runOneTask". +// src/scaffolder/tasks/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "cancelTask". +// src/scaffolder/tasks/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "createTask". +// src/scaffolder/tasks/types.d.ts:126:5 - (ae-undocumented) Missing documentation for "recoverTasks". +// src/scaffolder/tasks/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "getTask". +// src/scaffolder/tasks/types.d.ts:130:5 - (ae-undocumented) Missing documentation for "claimTask". +// src/scaffolder/tasks/types.d.ts:131:5 - (ae-undocumented) Missing documentation for "completeTask". +// src/scaffolder/tasks/types.d.ts:136:5 - (ae-undocumented) Missing documentation for "heartbeatTask". +// src/scaffolder/tasks/types.d.ts:137:5 - (ae-undocumented) Missing documentation for "listStaleTasks". +// src/scaffolder/tasks/types.d.ts:144:5 - (ae-undocumented) Missing documentation for "list". +// src/scaffolder/tasks/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "emitLogEvent". +// src/scaffolder/tasks/types.d.ts:150:5 - (ae-undocumented) Missing documentation for "getTaskState". +// src/scaffolder/tasks/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "saveTaskState". +// src/scaffolder/tasks/types.d.ts:159:5 - (ae-undocumented) Missing documentation for "listEvents". +// src/scaffolder/tasks/types.d.ts:162:5 - (ae-undocumented) Missing documentation for "shutdownTask". +// src/scaffolder/tasks/types.d.ts:163:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/scaffolder/tasks/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/scaffolder/tasks/types.d.ts:170:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/service/router.d.ts:19:1 - (ae-undocumented) Missing documentation for "TemplatePermissionRuleInput". +// src/service/router.d.ts:24:1 - (ae-undocumented) Missing documentation for "ActionPermissionRuleInput". +// src/service/router.d.ts:31:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:32:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:33:5 - (ae-undocumented) Missing documentation for "reader". +// src/service/router.d.ts:34:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/service/router.d.ts:35:5 - (ae-undocumented) Missing documentation for "database". +// src/service/router.d.ts:36:5 - (ae-undocumented) Missing documentation for "catalogClient". +// src/service/router.d.ts:37:5 - (ae-undocumented) Missing documentation for "scheduler". +// src/service/router.d.ts:38:5 - (ae-undocumented) Missing documentation for "actions". +// src/service/router.d.ts:43:5 - (ae-undocumented) Missing documentation for "taskWorkers". +// src/service/router.d.ts:49:5 - (ae-undocumented) Missing documentation for "taskBroker". +// src/service/router.d.ts:50:5 - (ae-undocumented) Missing documentation for "additionalTemplateFilters". +// src/service/router.d.ts:51:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". +// src/service/router.d.ts:52:5 - (ae-undocumented) Missing documentation for "additionalWorkspaceProviders". +// src/service/router.d.ts:53:5 - (ae-undocumented) Missing documentation for "permissions". +// src/service/router.d.ts:54:5 - (ae-undocumented) Missing documentation for "permissionRules". +// src/service/router.d.ts:55:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:56:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:57:5 - (ae-undocumented) Missing documentation for "identity". +// src/service/router.d.ts:58:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:59:5 - (ae-undocumented) Missing documentation for "autocompleteHandlers". ``` diff --git a/plugins/scaffolder-common/api-report-alpha.md b/plugins/scaffolder-common/api-report-alpha.api.md similarity index 100% rename from plugins/scaffolder-common/api-report-alpha.md rename to plugins/scaffolder-common/api-report-alpha.api.md diff --git a/plugins/scaffolder-common/api-report.md b/plugins/scaffolder-common/api-report.api.md similarity index 77% rename from plugins/scaffolder-common/api-report.md rename to plugins/scaffolder-common/api-report.api.md index 8d7a61910d..2058c08203 100644 --- a/plugins/scaffolder-common/api-report.md +++ b/plugins/scaffolder-common/api-report.api.md @@ -123,4 +123,15 @@ export interface TemplatePresentationV1beta3 extends JsonObject { export interface TemplateRecoveryV1beta3 extends JsonObject { EXPERIMENTAL_strategy?: 'none' | 'startOver'; } + +// Warnings were encountered during analysis: +// +// src/TemplateEntityV1beta3.d.ts:102:5 - (ae-undocumented) Missing documentation for "id". +// src/TemplateEntityV1beta3.d.ts:103:5 - (ae-undocumented) Missing documentation for "name". +// src/TemplateEntityV1beta3.d.ts:104:5 - (ae-undocumented) Missing documentation for "action". +// src/TemplateEntityV1beta3.d.ts:105:5 - (ae-undocumented) Missing documentation for "input". +// src/TemplateEntityV1beta3.d.ts:106:5 - (ae-undocumented) Missing documentation for "if". +// src/TemplateEntityV1beta3.d.ts:107:5 - (ae-undocumented) Missing documentation for ""backstage:permissions"". +// src/TemplateEntityV1beta3.d.ts:115:5 - (ae-undocumented) Missing documentation for ""backstage:permissions"". +// src/TemplateEntityV1beta3.d.ts:123:5 - (ae-undocumented) Missing documentation for "tags". ``` diff --git a/plugins/scaffolder-node-test-utils/api-report.md b/plugins/scaffolder-node-test-utils/api-report.api.md similarity index 100% rename from plugins/scaffolder-node-test-utils/api-report.md rename to plugins/scaffolder-node-test-utils/api-report.api.md diff --git a/plugins/scaffolder-node/api-report-alpha.md b/plugins/scaffolder-node/api-report-alpha.api.md similarity index 77% rename from plugins/scaffolder-node/api-report-alpha.md rename to plugins/scaffolder-node/api-report-alpha.api.md index c9b8130f0e..2258515b6d 100644 --- a/plugins/scaffolder-node/api-report-alpha.md +++ b/plugins/scaffolder-node/api-report-alpha.api.md @@ -109,5 +109,17 @@ export interface WorkspaceProvider { }): Promise; } +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:9:5 - (ae-undocumented) Missing documentation for "addActions". +// src/alpha.d.ts:23:5 - (ae-undocumented) Missing documentation for "setTaskBroker". +// src/alpha.d.ts:37:5 - (ae-undocumented) Missing documentation for "addTemplateFilters". +// src/alpha.d.ts:38:5 - (ae-undocumented) Missing documentation for "addTemplateGlobals". +// src/alpha.d.ts:64:5 - (ae-undocumented) Missing documentation for "addAutocompleteProvider". +// src/alpha.d.ts:81:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/alpha.d.ts:85:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/alpha.d.ts:88:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/alpha.d.ts:99:5 - (ae-undocumented) Missing documentation for "addProviders". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.api.md similarity index 73% rename from plugins/scaffolder-node/api-report.md rename to plugins/scaffolder-node/api-report.api.md index 6bfa743415..3dc385f202 100644 --- a/plugins/scaffolder-node/api-report.md +++ b/plugins/scaffolder-node/api-report.api.md @@ -478,4 +478,49 @@ export type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined; export type TemplateGlobal = | ((...args: JsonValue[]) => JsonValue | undefined) | JsonValue; + +// Warnings were encountered during analysis: +// +// src/actions/createTemplateAction.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateExample". +// src/actions/createTemplateAction.d.ts:11:1 - (ae-undocumented) Missing documentation for "TemplateActionOptions". +// src/actions/gitHelpers.d.ts:5:1 - (ae-undocumented) Missing documentation for "initRepoAndPush". +// src/actions/gitHelpers.d.ts:27:1 - (ae-undocumented) Missing documentation for "commitAndPushRepo". +// src/actions/gitHelpers.d.ts:49:1 - (ae-undocumented) Missing documentation for "cloneRepo". +// src/actions/gitHelpers.d.ts:66:1 - (ae-undocumented) Missing documentation for "createBranch". +// src/actions/gitHelpers.d.ts:80:1 - (ae-undocumented) Missing documentation for "addFiles". +// src/actions/gitHelpers.d.ts:94:1 - (ae-undocumented) Missing documentation for "commitAndPushBranch". +// src/actions/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "TemplateAction". +// src/actions/util.d.ts:5:22 - (ae-undocumented) Missing documentation for "getRepoSourceDirectory". +// src/actions/util.d.ts:9:22 - (ae-undocumented) Missing documentation for "parseRepoUrl". +// src/files/serializeDirectoryContents.d.ts:6:1 - (ae-undocumented) Missing documentation for "serializeDirectoryContents". +// src/files/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "SerializedFile". +// src/files/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "path". +// src/files/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "content". +// src/files/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "executable". +// src/files/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "symlink". +// src/tasks/types.d.ts:82:5 - (ae-undocumented) Missing documentation for "cancelSignal". +// src/tasks/types.d.ts:83:5 - (ae-undocumented) Missing documentation for "spec". +// src/tasks/types.d.ts:84:5 - (ae-undocumented) Missing documentation for "secrets". +// src/tasks/types.d.ts:85:5 - (ae-undocumented) Missing documentation for "createdBy". +// src/tasks/types.d.ts:86:5 - (ae-undocumented) Missing documentation for "done". +// src/tasks/types.d.ts:87:5 - (ae-undocumented) Missing documentation for "isDryRun". +// src/tasks/types.d.ts:88:5 - (ae-undocumented) Missing documentation for "complete". +// src/tasks/types.d.ts:89:5 - (ae-undocumented) Missing documentation for "emitLog". +// src/tasks/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "getTaskState". +// src/tasks/types.d.ts:93:5 - (ae-undocumented) Missing documentation for "updateCheckpoint". +// src/tasks/types.d.ts:102:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/tasks/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/tasks/types.d.ts:106:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/tasks/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "getWorkspaceName". +// src/tasks/types.d.ts:111:5 - (ae-undocumented) Missing documentation for "getInitiatorCredentials". +// src/tasks/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "cancel". +// src/tasks/types.d.ts:120:5 - (ae-undocumented) Missing documentation for "claim". +// src/tasks/types.d.ts:121:5 - (ae-undocumented) Missing documentation for "recoverTasks". +// src/tasks/types.d.ts:122:5 - (ae-undocumented) Missing documentation for "dispatch". +// src/tasks/types.d.ts:123:5 - (ae-undocumented) Missing documentation for "vacuumTasks". +// src/tasks/types.d.ts:126:5 - (ae-undocumented) Missing documentation for "event$". +// src/tasks/types.d.ts:132:5 - (ae-undocumented) Missing documentation for "get". +// src/tasks/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "list". +// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "TemplateFilter". +// src/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "TemplateGlobal". ``` diff --git a/plugins/scaffolder-react/api-report-alpha.md b/plugins/scaffolder-react/api-report-alpha.api.md similarity index 62% rename from plugins/scaffolder-react/api-report-alpha.md rename to plugins/scaffolder-react/api-report-alpha.api.md index 545cc02e9e..b9f0569714 100644 --- a/plugins/scaffolder-react/api-report-alpha.md +++ b/plugins/scaffolder-react/api-report-alpha.api.md @@ -318,5 +318,50 @@ export type WorkflowProps = { | 'layouts' >; +// Warnings were encountered during analysis: +// +// src/next/components/ScaffolderField/ScaffolderField.d.ts:7:5 - (ae-undocumented) Missing documentation for "rawDescription". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:8:5 - (ae-undocumented) Missing documentation for "errors". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:9:5 - (ae-undocumented) Missing documentation for "rawErrors". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:10:5 - (ae-undocumented) Missing documentation for "help". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:11:5 - (ae-undocumented) Missing documentation for "rawHelp". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:12:5 - (ae-undocumented) Missing documentation for "required". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:13:5 - (ae-undocumented) Missing documentation for "disabled". +// src/next/components/ScaffolderField/ScaffolderField.d.ts:14:5 - (ae-undocumented) Missing documentation for "displayLabel". +// src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScaffolderPageContextMenuProps". +// src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.d.ts:14:1 - (ae-undocumented) Missing documentation for "ScaffolderPageContextMenu". +// src/next/components/Stepper/createAsyncValidators.d.ts:6:1 - (ae-undocumented) Missing documentation for "FormValidation". +// src/next/components/Stepper/createAsyncValidators.d.ts:10:22 - (ae-undocumented) Missing documentation for "createAsyncValidators". +// src/next/components/TaskSteps/TaskSteps.d.ts:10:5 - (ae-undocumented) Missing documentation for "steps". +// src/next/components/TaskSteps/TaskSteps.d.ts:11:5 - (ae-undocumented) Missing documentation for "activeStep". +// src/next/components/TaskSteps/TaskSteps.d.ts:12:5 - (ae-undocumented) Missing documentation for "isComplete". +// src/next/components/TaskSteps/TaskSteps.d.ts:13:5 - (ae-undocumented) Missing documentation for "isError". +// src/next/components/TemplateCard/TemplateCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "template". +// src/next/components/TemplateCard/TemplateCard.d.ts:10:5 - (ae-undocumented) Missing documentation for "additionalLinks". +// src/next/components/TemplateCard/TemplateCard.d.ts:15:5 - (ae-undocumented) Missing documentation for "onSelected". +// src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "ScaffolderReactTemplateCategoryPickerClassKey". +// src/next/components/TemplateGroup/TemplateGroup.d.ts:10:5 - (ae-undocumented) Missing documentation for "templates". +// src/next/components/TemplateGroup/TemplateGroup.d.ts:18:5 - (ae-undocumented) Missing documentation for "onSelected". +// src/next/components/TemplateGroup/TemplateGroup.d.ts:19:5 - (ae-undocumented) Missing documentation for "title". +// src/next/components/TemplateGroup/TemplateGroup.d.ts:20:5 - (ae-undocumented) Missing documentation for "components". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:8:1 - (ae-undocumented) Missing documentation for "TemplateGroupsProps". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:9:5 - (ae-undocumented) Missing documentation for "groups". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:10:5 - (ae-undocumented) Missing documentation for "templateFilter". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:11:5 - (ae-undocumented) Missing documentation for "TemplateCardComponent". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:14:5 - (ae-undocumented) Missing documentation for "onTemplateSelected". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:15:5 - (ae-undocumented) Missing documentation for "additionalLinksForEntity". +// src/next/components/TemplateGroups/TemplateGroups.d.ts:24:22 - (ae-undocumented) Missing documentation for "TemplateGroups". +// src/next/components/Workflow/Workflow.d.ts:7:1 - (ae-undocumented) Missing documentation for "WorkflowProps". +// src/next/components/Workflow/Workflow.d.ts:20:22 - (ae-undocumented) Missing documentation for "Workflow". +// src/next/components/Workflow/Workflow.d.ts:24:22 - (ae-undocumented) Missing documentation for "EmbeddableWorkflow". +// src/next/hooks/useTemplateParameterSchema.d.ts:5:22 - (ae-undocumented) Missing documentation for "useTemplateParameterSchema". +// src/next/hooks/useTemplateSchema.d.ts:10:5 - (ae-undocumented) Missing documentation for "uiSchema". +// src/next/hooks/useTemplateSchema.d.ts:11:5 - (ae-undocumented) Missing documentation for "mergedSchema". +// src/next/hooks/useTemplateSchema.d.ts:12:5 - (ae-undocumented) Missing documentation for "schema". +// src/next/hooks/useTemplateSchema.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". +// src/next/hooks/useTemplateSchema.d.ts:14:5 - (ae-undocumented) Missing documentation for "description". +// src/next/overridableComponents.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScaffolderReactComponentsNameToClassKey". +// src/next/overridableComponents.d.ts:9:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-react/api-report.md b/plugins/scaffolder-react/api-report.api.md similarity index 80% rename from plugins/scaffolder-react/api-report.md rename to plugins/scaffolder-react/api-report.api.md index f73365f0ac..0fcb3fbf04 100644 --- a/plugins/scaffolder-react/api-report.md +++ b/plugins/scaffolder-react/api-report.api.md @@ -528,5 +528,44 @@ export const useTaskEventStream: (taskId: string) => TaskStream; // @public export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets; +// Warnings were encountered during analysis: +// +// src/api/ref.d.ts:3:22 - (ae-undocumented) Missing documentation for "scaffolderApiRef". +// src/api/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputLink". +// src/api/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputText". +// src/api/types.d.ts:67:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskOutput". +// src/api/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "templateRef". +// src/api/types.d.ts:96:5 - (ae-undocumented) Missing documentation for "values". +// src/api/types.d.ts:97:5 - (ae-undocumented) Missing documentation for "secrets". +// src/api/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "taskId". +// src/api/types.d.ts:113:5 - (ae-undocumented) Missing documentation for "allowedHosts". +// src/api/types.d.ts:121:5 - (ae-undocumented) Missing documentation for "integrations". +// src/api/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "taskId". +// src/api/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "after". +// src/api/types.d.ts:137:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunOptions". +// src/api/types.d.ts:138:5 - (ae-undocumented) Missing documentation for "template". +// src/api/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "values". +// src/api/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "secrets". +// src/api/types.d.ts:141:5 - (ae-undocumented) Missing documentation for "directoryContents". +// src/api/types.d.ts:147:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunResponse". +// src/api/types.d.ts:148:5 - (ae-undocumented) Missing documentation for "directoryContents". +// src/api/types.d.ts:153:5 - (ae-undocumented) Missing documentation for "log". +// src/api/types.d.ts:154:5 - (ae-undocumented) Missing documentation for "steps". +// src/api/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "output". +// src/api/types.d.ts:163:5 - (ae-undocumented) Missing documentation for "getTemplateParameterSchema". +// src/api/types.d.ts:171:5 - (ae-undocumented) Missing documentation for "getTask". +// src/api/types.d.ts:178:5 - (ae-undocumented) Missing documentation for "listTasks". +// src/api/types.d.ts:183:5 - (ae-undocumented) Missing documentation for "getIntegrationsList". +// src/api/types.d.ts:188:5 - (ae-undocumented) Missing documentation for "streamLogs". +// src/api/types.d.ts:189:5 - (ae-undocumented) Missing documentation for "dryRun". +// src/api/types.d.ts:190:5 - (ae-undocumented) Missing documentation for "autocomplete". +// src/components/types.d.ts:7:1 - (ae-undocumented) Missing documentation for "TemplateGroupFilter". +// src/extensions/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "uiSchema". +// src/extensions/types.d.ts:30:5 - (ae-undocumented) Missing documentation for ""ui:options"". +// src/layouts/createScaffolderLayout.d.ts:16:5 - (ae-undocumented) Missing documentation for "name". +// src/layouts/createScaffolderLayout.d.ts:17:5 - (ae-undocumented) Missing documentation for "component". +// src/secrets/SecretsContext.d.ts:14:5 - (ae-undocumented) Missing documentation for "setSecrets". +// src/secrets/SecretsContext.d.ts:15:5 - (ae-undocumented) Missing documentation for "secrets". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder/api-report-alpha.md b/plugins/scaffolder/api-report-alpha.api.md similarity index 97% rename from plugins/scaffolder/api-report-alpha.md rename to plugins/scaffolder/api-report-alpha.api.md index 4e8ded2644..9cbbfe5ee9 100644 --- a/plugins/scaffolder/api-report-alpha.md +++ b/plugins/scaffolder/api-report-alpha.api.md @@ -311,5 +311,11 @@ export type TemplateWizardPageProps = { }; }; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". +// src/next/TemplateListPage/TemplateListPage.d.ts:7:1 - (ae-undocumented) Missing documentation for "TemplateListPageProps". +// src/next/TemplateWizardPage/TemplateWizardPage.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateWizardPageProps". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.api.md similarity index 80% rename from plugins/scaffolder/api-report.md rename to plugins/scaffolder/api-report.api.md index 81cf0ecced..ae8a440161 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.api.md @@ -669,4 +669,56 @@ export const TemplateTypePicker: () => React_2.JSX.Element | null; // @public @deprecated (undocumented) export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets_2; + +// Warnings were encountered during analysis: +// +// src/api.d.ts:23:5 - (ae-undocumented) Missing documentation for "listTasks". +// src/api.d.ts:28:5 - (ae-undocumented) Missing documentation for "getIntegrationsList". +// src/api.d.ts:29:5 - (ae-undocumented) Missing documentation for "getTemplateParameterSchema". +// src/api.d.ts:30:5 - (ae-undocumented) Missing documentation for "scaffold". +// src/api.d.ts:31:5 - (ae-undocumented) Missing documentation for "getTask". +// src/api.d.ts:32:5 - (ae-undocumented) Missing documentation for "streamLogs". +// src/api.d.ts:33:5 - (ae-undocumented) Missing documentation for "dryRun". +// src/api.d.ts:36:5 - (ae-undocumented) Missing documentation for "listActions". +// src/api.d.ts:37:5 - (ae-undocumented) Missing documentation for "cancelTask". +// src/api.d.ts:38:5 - (ae-undocumented) Missing documentation for "autocomplete". +// src/components/OngoingTask/OngoingTask.d.ts:6:22 - (ae-undocumented) Missing documentation for "OngoingTask". +// src/components/fields/EntityPicker/schema.d.ts:15:22 - (ae-undocumented) Missing documentation for "EntityPickerFieldSchema". +// src/components/fields/EntityTagsPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "EntityTagsPickerFieldSchema". +// src/components/fields/OwnedEntityPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "OwnedEntityPickerFieldSchema". +// src/components/fields/OwnerPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "OwnerPickerFieldSchema". +// src/components/fields/RepoUrlPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "RepoUrlPickerFieldSchema". +// src/components/fields/utils.d.ts:9:5 - (ae-undocumented) Missing documentation for "schema". +// src/components/fields/utils.d.ts:10:5 - (ae-undocumented) Missing documentation for "type". +// src/components/fields/utils.d.ts:11:5 - (ae-undocumented) Missing documentation for "uiOptionsType". +// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "rootRouteRef". +// src/deprecated.d.ts:12:22 - (ae-undocumented) Missing documentation for "createScaffolderFieldExtension". +// src/deprecated.d.ts:17:22 - (ae-undocumented) Missing documentation for "ScaffolderFieldExtensions". +// src/deprecated.d.ts:24:22 - (ae-undocumented) Missing documentation for "useTemplateSecrets". +// src/deprecated.d.ts:29:22 - (ae-undocumented) Missing documentation for "scaffolderApiRef". +// src/deprecated.d.ts:34:1 - (ae-undocumented) Missing documentation for "ScaffolderApi". +// src/deprecated.d.ts:39:1 - (ae-undocumented) Missing documentation for "ScaffolderUseTemplateSecrets". +// src/deprecated.d.ts:44:1 - (ae-undocumented) Missing documentation for "TemplateParameterSchema". +// src/deprecated.d.ts:49:1 - (ae-undocumented) Missing documentation for "CustomFieldExtensionSchema". +// src/deprecated.d.ts:54:1 - (ae-undocumented) Missing documentation for "CustomFieldValidator". +// src/deprecated.d.ts:59:1 - (ae-undocumented) Missing documentation for "FieldExtensionOptions". +// src/deprecated.d.ts:64:1 - (ae-undocumented) Missing documentation for "FieldExtensionComponentProps". +// src/deprecated.d.ts:69:1 - (ae-undocumented) Missing documentation for "FieldExtensionComponent". +// src/deprecated.d.ts:74:1 - (ae-undocumented) Missing documentation for "ListActionsResponse". +// src/deprecated.d.ts:79:1 - (ae-undocumented) Missing documentation for "LogEvent". +// src/deprecated.d.ts:84:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunOptions". +// src/deprecated.d.ts:89:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunResponse". +// src/deprecated.d.ts:94:1 - (ae-undocumented) Missing documentation for "ScaffolderGetIntegrationsListOptions". +// src/deprecated.d.ts:99:1 - (ae-undocumented) Missing documentation for "ScaffolderGetIntegrationsListResponse". +// src/deprecated.d.ts:104:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputlink". +// src/deprecated.d.ts:109:1 - (ae-undocumented) Missing documentation for "ScaffolderScaffoldOptions". +// src/deprecated.d.ts:114:1 - (ae-undocumented) Missing documentation for "ScaffolderScaffoldResponse". +// src/deprecated.d.ts:119:1 - (ae-undocumented) Missing documentation for "ScaffolderStreamLogsOptions". +// src/deprecated.d.ts:124:1 - (ae-undocumented) Missing documentation for "ScaffolderTask". +// src/deprecated.d.ts:129:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskOutput". +// src/deprecated.d.ts:134:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskStatus". +// src/deprecated.d.ts:139:22 - (ae-undocumented) Missing documentation for "createScaffolderLayout". +// src/deprecated.d.ts:144:22 - (ae-undocumented) Missing documentation for "ScaffolderLayouts". +// src/deprecated.d.ts:151:1 - (ae-undocumented) Missing documentation for "LayoutTemplate". +// src/deprecated.d.ts:156:1 - (ae-undocumented) Missing documentation for "LayoutOptions". ``` diff --git a/plugins/search-backend-module-catalog/api-report-alpha.md b/plugins/search-backend-module-catalog/api-report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-catalog/api-report-alpha.md rename to plugins/search-backend-module-catalog/api-report-alpha.api.md diff --git a/plugins/search-backend-module-catalog/api-report.md b/plugins/search-backend-module-catalog/api-report.api.md similarity index 66% rename from plugins/search-backend-module-catalog/api-report.md rename to plugins/search-backend-module-catalog/api-report.api.md index aed73254cc..5a1efffcb7 100644 --- a/plugins/search-backend-module-catalog/api-report.md +++ b/plugins/search-backend-module-catalog/api-report.api.md @@ -51,4 +51,14 @@ export type DefaultCatalogCollatorFactoryOptions = { catalogClient?: CatalogApi; entityTransformer?: CatalogCollatorEntityTransformer; }; + +// Warnings were encountered during analysis: +// +// src/collators/CatalogCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". +// src/collators/DefaultCatalogCollatorFactory.d.ts:11:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". +// src/collators/DefaultCatalogCollatorFactory.d.ts:39:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/DefaultCatalogCollatorFactory.d.ts:40:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/collators/DefaultCatalogCollatorFactory.d.ts:47:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/collators/DefaultCatalogCollatorFactory.d.ts:49:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/defaultCatalogCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". ``` diff --git a/plugins/search-backend-module-elasticsearch/api-report-alpha.md b/plugins/search-backend-module-elasticsearch/api-report-alpha.api.md similarity index 77% rename from plugins/search-backend-module-elasticsearch/api-report-alpha.md rename to plugins/search-backend-module-elasticsearch/api-report-alpha.api.md index 23a4664f9c..e612215a87 100644 --- a/plugins/search-backend-module-elasticsearch/api-report-alpha.md +++ b/plugins/search-backend-module-elasticsearch/api-report-alpha.api.md @@ -20,5 +20,10 @@ export interface ElasticSearchQueryTranslatorExtensionPoint { // @alpha export const elasticsearchTranslatorExtensionPoint: ExtensionPoint; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:1 - (ae-undocumented) Missing documentation for "ElasticSearchQueryTranslatorExtensionPoint". +// src/alpha.d.ts:4:5 - (ae-undocumented) Missing documentation for "setTranslator". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-elasticsearch/api-report.md b/plugins/search-backend-module-elasticsearch/api-report.api.md similarity index 53% rename from plugins/search-backend-module-elasticsearch/api-report.md rename to plugins/search-backend-module-elasticsearch/api-report.api.md index c565a554ed..4b55c64495 100644 --- a/plugins/search-backend-module-elasticsearch/api-report.md +++ b/plugins/search-backend-module-elasticsearch/api-report.api.md @@ -457,4 +457,99 @@ export interface OpenSearchNodeOptions { // (undocumented) url: URL; } + +// Warnings were encountered during analysis: +// +// src/engines/ElasticSearchClientOptions.d.ts:29:5 - (ae-undocumented) Missing documentation for "provider". +// src/engines/ElasticSearchClientOptions.d.ts:30:5 - (ae-undocumented) Missing documentation for "region". +// src/engines/ElasticSearchClientOptions.d.ts:31:5 - (ae-undocumented) Missing documentation for "service". +// src/engines/ElasticSearchClientOptions.d.ts:32:5 - (ae-undocumented) Missing documentation for "auth". +// src/engines/ElasticSearchClientOptions.d.ts:33:5 - (ae-undocumented) Missing documentation for "connection". +// src/engines/ElasticSearchClientOptions.d.ts:34:5 - (ae-undocumented) Missing documentation for "node". +// src/engines/ElasticSearchClientOptions.d.ts:35:5 - (ae-undocumented) Missing documentation for "nodes". +// src/engines/ElasticSearchClientOptions.d.ts:46:5 - (ae-undocumented) Missing documentation for "provider". +// src/engines/ElasticSearchClientOptions.d.ts:47:5 - (ae-undocumented) Missing documentation for "auth". +// src/engines/ElasticSearchClientOptions.d.ts:48:5 - (ae-undocumented) Missing documentation for "Connection". +// src/engines/ElasticSearchClientOptions.d.ts:49:5 - (ae-undocumented) Missing documentation for "node". +// src/engines/ElasticSearchClientOptions.d.ts:50:5 - (ae-undocumented) Missing documentation for "nodes". +// src/engines/ElasticSearchClientOptions.d.ts:51:5 - (ae-undocumented) Missing documentation for "cloud". +// src/engines/ElasticSearchClientOptions.d.ts:64:5 - (ae-undocumented) Missing documentation for "Transport". +// src/engines/ElasticSearchClientOptions.d.ts:65:5 - (ae-undocumented) Missing documentation for "maxRetries". +// src/engines/ElasticSearchClientOptions.d.ts:66:5 - (ae-undocumented) Missing documentation for "requestTimeout". +// src/engines/ElasticSearchClientOptions.d.ts:67:5 - (ae-undocumented) Missing documentation for "pingTimeout". +// src/engines/ElasticSearchClientOptions.d.ts:68:5 - (ae-undocumented) Missing documentation for "sniffInterval". +// src/engines/ElasticSearchClientOptions.d.ts:69:5 - (ae-undocumented) Missing documentation for "sniffOnStart". +// src/engines/ElasticSearchClientOptions.d.ts:70:5 - (ae-undocumented) Missing documentation for "sniffEndpoint". +// src/engines/ElasticSearchClientOptions.d.ts:71:5 - (ae-undocumented) Missing documentation for "sniffOnConnectionFault". +// src/engines/ElasticSearchClientOptions.d.ts:72:5 - (ae-undocumented) Missing documentation for "resurrectStrategy". +// src/engines/ElasticSearchClientOptions.d.ts:73:5 - (ae-undocumented) Missing documentation for "suggestCompression". +// src/engines/ElasticSearchClientOptions.d.ts:74:5 - (ae-undocumented) Missing documentation for "compression". +// src/engines/ElasticSearchClientOptions.d.ts:75:5 - (ae-undocumented) Missing documentation for "ssl". +// src/engines/ElasticSearchClientOptions.d.ts:76:5 - (ae-undocumented) Missing documentation for "agent". +// src/engines/ElasticSearchClientOptions.d.ts:77:5 - (ae-undocumented) Missing documentation for "nodeFilter". +// src/engines/ElasticSearchClientOptions.d.ts:78:5 - (ae-undocumented) Missing documentation for "nodeSelector". +// src/engines/ElasticSearchClientOptions.d.ts:79:5 - (ae-undocumented) Missing documentation for "headers". +// src/engines/ElasticSearchClientOptions.d.ts:80:5 - (ae-undocumented) Missing documentation for "opaqueIdPrefix". +// src/engines/ElasticSearchClientOptions.d.ts:81:5 - (ae-undocumented) Missing documentation for "name". +// src/engines/ElasticSearchClientOptions.d.ts:82:5 - (ae-undocumented) Missing documentation for "proxy". +// src/engines/ElasticSearchClientOptions.d.ts:83:5 - (ae-undocumented) Missing documentation for "enableMetaHeader". +// src/engines/ElasticSearchClientOptions.d.ts:84:5 - (ae-undocumented) Missing documentation for "disablePrototypePoisoningProtection". +// src/engines/ElasticSearchClientOptions.d.ts:89:1 - (ae-undocumented) Missing documentation for "OpenSearchAuth". +// src/engines/ElasticSearchClientOptions.d.ts:96:1 - (ae-undocumented) Missing documentation for "ElasticSearchAuth". +// src/engines/ElasticSearchClientOptions.d.ts:105:1 - (ae-undocumented) Missing documentation for "ElasticSearchNodeOptions". +// src/engines/ElasticSearchClientOptions.d.ts:106:5 - (ae-undocumented) Missing documentation for "url". +// src/engines/ElasticSearchClientOptions.d.ts:107:5 - (ae-undocumented) Missing documentation for "id". +// src/engines/ElasticSearchClientOptions.d.ts:108:5 - (ae-undocumented) Missing documentation for "agent". +// src/engines/ElasticSearchClientOptions.d.ts:109:5 - (ae-undocumented) Missing documentation for "ssl". +// src/engines/ElasticSearchClientOptions.d.ts:110:5 - (ae-undocumented) Missing documentation for "headers". +// src/engines/ElasticSearchClientOptions.d.ts:111:5 - (ae-undocumented) Missing documentation for "roles". +// src/engines/ElasticSearchClientOptions.d.ts:121:1 - (ae-undocumented) Missing documentation for "OpenSearchNodeOptions". +// src/engines/ElasticSearchClientOptions.d.ts:122:5 - (ae-undocumented) Missing documentation for "url". +// src/engines/ElasticSearchClientOptions.d.ts:123:5 - (ae-undocumented) Missing documentation for "id". +// src/engines/ElasticSearchClientOptions.d.ts:124:5 - (ae-undocumented) Missing documentation for "agent". +// src/engines/ElasticSearchClientOptions.d.ts:125:5 - (ae-undocumented) Missing documentation for "ssl". +// src/engines/ElasticSearchClientOptions.d.ts:126:5 - (ae-undocumented) Missing documentation for "headers". +// src/engines/ElasticSearchClientOptions.d.ts:127:5 - (ae-undocumented) Missing documentation for "roles". +// src/engines/ElasticSearchClientOptions.d.ts:136:1 - (ae-undocumented) Missing documentation for "ElasticSearchAgentOptions". +// src/engines/ElasticSearchClientOptions.d.ts:137:5 - (ae-undocumented) Missing documentation for "keepAlive". +// src/engines/ElasticSearchClientOptions.d.ts:138:5 - (ae-undocumented) Missing documentation for "keepAliveMsecs". +// src/engines/ElasticSearchClientOptions.d.ts:139:5 - (ae-undocumented) Missing documentation for "maxSockets". +// src/engines/ElasticSearchClientOptions.d.ts:140:5 - (ae-undocumented) Missing documentation for "maxFreeSockets". +// src/engines/ElasticSearchClientOptions.d.ts:145:1 - (ae-undocumented) Missing documentation for "ElasticSearchConnectionConstructor". +// src/engines/ElasticSearchClientOptions.d.ts:146:5 - (ae-undocumented) Missing documentation for "__new". +// src/engines/ElasticSearchClientOptions.d.ts:147:5 - (ae-undocumented) Missing documentation for "statuses". +// src/engines/ElasticSearchClientOptions.d.ts:151:5 - (ae-undocumented) Missing documentation for "roles". +// src/engines/ElasticSearchClientOptions.d.ts:161:1 - (ae-undocumented) Missing documentation for "OpenSearchConnectionConstructor". +// src/engines/ElasticSearchClientOptions.d.ts:162:5 - (ae-undocumented) Missing documentation for "__new". +// src/engines/ElasticSearchClientOptions.d.ts:163:5 - (ae-undocumented) Missing documentation for "statuses". +// src/engines/ElasticSearchClientOptions.d.ts:167:5 - (ae-undocumented) Missing documentation for "roles". +// src/engines/ElasticSearchClientOptions.d.ts:176:1 - (ae-undocumented) Missing documentation for "ElasticSearchTransportConstructor". +// src/engines/ElasticSearchClientOptions.d.ts:177:5 - (ae-undocumented) Missing documentation for "__new". +// src/engines/ElasticSearchClientOptions.d.ts:178:5 - (ae-undocumented) Missing documentation for "sniffReasons". +// src/engines/ElasticSearchClientWrapper.d.ts:8:1 - (ae-undocumented) Missing documentation for "ElasticSearchAliasAction". +// src/engines/ElasticSearchClientWrapper.d.ts:32:1 - (ae-undocumented) Missing documentation for "ElasticSearchIndexAction". +// src/engines/ElasticSearchClientWrapper.d.ts:57:5 - (ae-undocumented) Missing documentation for "fromClientOptions". +// src/engines/ElasticSearchClientWrapper.d.ts:58:5 - (ae-undocumented) Missing documentation for "search". +// src/engines/ElasticSearchClientWrapper.d.ts:62:5 - (ae-undocumented) Missing documentation for "bulk". +// src/engines/ElasticSearchClientWrapper.d.ts:67:5 - (ae-undocumented) Missing documentation for "putIndexTemplate". +// src/engines/ElasticSearchClientWrapper.d.ts:68:5 - (ae-undocumented) Missing documentation for "listIndices". +// src/engines/ElasticSearchClientWrapper.d.ts:71:5 - (ae-undocumented) Missing documentation for "indexExists". +// src/engines/ElasticSearchClientWrapper.d.ts:74:5 - (ae-undocumented) Missing documentation for "deleteIndex". +// src/engines/ElasticSearchClientWrapper.d.ts:80:5 - (ae-undocumented) Missing documentation for "getAliases". +// src/engines/ElasticSearchClientWrapper.d.ts:83:5 - (ae-undocumented) Missing documentation for "createIndex". +// src/engines/ElasticSearchClientWrapper.d.ts:86:5 - (ae-undocumented) Missing documentation for "updateAliases". +// src/engines/ElasticSearchSearchEngine.d.ts:45:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightOptions". +// src/engines/ElasticSearchSearchEngine.d.ts:53:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightConfig". +// src/engines/ElasticSearchSearchEngine.d.ts:63:1 - (ae-undocumented) Missing documentation for "ElasticSearchSearchEngine". +// src/engines/ElasticSearchSearchEngine.d.ts:72:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/engines/ElasticSearchSearchEngine.d.ts:94:5 - (ae-undocumented) Missing documentation for "translator". +// src/engines/ElasticSearchSearchEngine.d.ts:95:5 - (ae-undocumented) Missing documentation for "setTranslator". +// src/engines/ElasticSearchSearchEngine.d.ts:96:5 - (ae-undocumented) Missing documentation for "setIndexTemplate". +// src/engines/ElasticSearchSearchEngine.d.ts:97:5 - (ae-undocumented) Missing documentation for "getIndexer". +// src/engines/ElasticSearchSearchEngine.d.ts:98:5 - (ae-undocumented) Missing documentation for "query". +// src/engines/ElasticSearchSearchEngine.d.ts:108:1 - (ae-undocumented) Missing documentation for "decodePageCursor". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:29:5 - (ae-undocumented) Missing documentation for "indexName". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:40:5 - (ae-undocumented) Missing documentation for "initialize". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:41:5 - (ae-undocumented) Missing documentation for "index". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:42:5 - (ae-undocumented) Missing documentation for "finalize". ``` diff --git a/plugins/search-backend-module-explore/api-report-alpha.md b/plugins/search-backend-module-explore/api-report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-explore/api-report-alpha.md rename to plugins/search-backend-module-explore/api-report-alpha.api.md diff --git a/plugins/search-backend-module-explore/api-report.md b/plugins/search-backend-module-explore/api-report.api.md similarity index 74% rename from plugins/search-backend-module-explore/api-report.md rename to plugins/search-backend-module-explore/api-report.api.md index 79163df05c..39a732c2ca 100644 --- a/plugins/search-backend-module-explore/api-report.md +++ b/plugins/search-backend-module-explore/api-report.api.md @@ -40,4 +40,11 @@ export type ToolDocumentCollatorFactoryOptions = { tokenManager?: TokenManager; auth?: AuthService; }; + +// Warnings were encountered during analysis: +// +// src/collators/ToolDocumentCollatorFactory.d.ts:32:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/ToolDocumentCollatorFactory.d.ts:37:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/collators/ToolDocumentCollatorFactory.d.ts:38:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/ToolDocumentCollatorFactory.d.ts:39:5 - (ae-undocumented) Missing documentation for "execute". ``` diff --git a/plugins/search-backend-module-pg/api-report-alpha.md b/plugins/search-backend-module-pg/api-report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-pg/api-report-alpha.md rename to plugins/search-backend-module-pg/api-report-alpha.api.md diff --git a/plugins/search-backend-module-pg/api-report.md b/plugins/search-backend-module-pg/api-report.api.md similarity index 53% rename from plugins/search-backend-module-pg/api-report.md rename to plugins/search-backend-module-pg/api-report.api.md index f0dea48b9c..af9a139261 100644 --- a/plugins/search-backend-module-pg/api-report.md +++ b/plugins/search-backend-module-pg/api-report.api.md @@ -188,4 +188,51 @@ export interface RawDocumentRow { // (undocumented) type: string; } + +// Warnings were encountered during analysis: +// +// src/PgSearchEngine/PgSearchEngine.d.ts:52:1 - (ae-undocumented) Missing documentation for "PgSearchEngine". +// src/PgSearchEngine/PgSearchEngine.d.ts:64:5 - (ae-undocumented) Missing documentation for "from". +// src/PgSearchEngine/PgSearchEngine.d.ts:69:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/PgSearchEngine/PgSearchEngine.d.ts:70:5 - (ae-undocumented) Missing documentation for "supported". +// src/PgSearchEngine/PgSearchEngine.d.ts:71:5 - (ae-undocumented) Missing documentation for "translator". +// src/PgSearchEngine/PgSearchEngine.d.ts:72:5 - (ae-undocumented) Missing documentation for "setTranslator". +// src/PgSearchEngine/PgSearchEngine.d.ts:73:5 - (ae-undocumented) Missing documentation for "getIndexer". +// src/PgSearchEngine/PgSearchEngine.d.ts:74:5 - (ae-undocumented) Missing documentation for "query". +// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:6:1 - (ae-undocumented) Missing documentation for "PgSearchEngineIndexerOptions". +// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:13:1 - (ae-undocumented) Missing documentation for "PgSearchEngineIndexer". +// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:20:5 - (ae-undocumented) Missing documentation for "initialize". +// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:21:5 - (ae-undocumented) Missing documentation for "index". +// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:22:5 - (ae-undocumented) Missing documentation for "finalize". +// src/database/DatabaseDocumentStore.d.ts:6:1 - (ae-undocumented) Missing documentation for "DatabaseDocumentStore". +// src/database/DatabaseDocumentStore.d.ts:8:5 - (ae-undocumented) Missing documentation for "create". +// src/database/DatabaseDocumentStore.d.ts:9:5 - (ae-undocumented) Missing documentation for "supported". +// src/database/DatabaseDocumentStore.d.ts:11:5 - (ae-undocumented) Missing documentation for "transaction". +// src/database/DatabaseDocumentStore.d.ts:12:5 - (ae-undocumented) Missing documentation for "getTransaction". +// src/database/DatabaseDocumentStore.d.ts:13:5 - (ae-undocumented) Missing documentation for "prepareInsert". +// src/database/DatabaseDocumentStore.d.ts:14:5 - (ae-undocumented) Missing documentation for "completeInsert". +// src/database/DatabaseDocumentStore.d.ts:15:5 - (ae-undocumented) Missing documentation for "insertDocuments". +// src/database/DatabaseDocumentStore.d.ts:16:5 - (ae-undocumented) Missing documentation for "query". +// src/database/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "PgSearchQuery". +// src/database/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "fields". +// src/database/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "types". +// src/database/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "pgTerm". +// src/database/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "offset". +// src/database/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "limit". +// src/database/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "options". +// src/database/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "DatabaseStore". +// src/database/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "transaction". +// src/database/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "getTransaction". +// src/database/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "prepareInsert". +// src/database/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "insertDocuments". +// src/database/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "completeInsert". +// src/database/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "query". +// src/database/types.d.ts:23:1 - (ae-undocumented) Missing documentation for "RawDocumentRow". +// src/database/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "document". +// src/database/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "type". +// src/database/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "hash". +// src/database/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "DocumentResultRow". +// src/database/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "document". +// src/database/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "type". +// src/database/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "highlight". ``` diff --git a/plugins/search-backend-module-stack-overflow-collator/api-report.md b/plugins/search-backend-module-stack-overflow-collator/api-report.api.md similarity index 65% rename from plugins/search-backend-module-stack-overflow-collator/api-report.md rename to plugins/search-backend-module-stack-overflow-collator/api-report.api.md index 3b9b79c597..aeb7bd03ea 100644 --- a/plugins/search-backend-module-stack-overflow-collator/api-report.md +++ b/plugins/search-backend-module-stack-overflow-collator/api-report.api.md @@ -58,4 +58,14 @@ export type StackOverflowQuestionsCollatorFactoryOptions = { export type StackOverflowQuestionsRequestParams = { [key: string]: string | string[] | number; }; + +// Warnings were encountered during analysis: +// +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:12:5 - (ae-undocumented) Missing documentation for "answers". +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:13:5 - (ae-undocumented) Missing documentation for "tags". +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:43:5 - (ae-undocumented) Missing documentation for "requestParams". +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:50:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:52:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:54:5 - (ae-undocumented) Missing documentation for "execute". ``` diff --git a/plugins/search-backend-module-techdocs/api-report-alpha.md b/plugins/search-backend-module-techdocs/api-report-alpha.api.md similarity index 77% rename from plugins/search-backend-module-techdocs/api-report-alpha.md rename to plugins/search-backend-module-techdocs/api-report-alpha.api.md index 4176bd56c6..16dd73f705 100644 --- a/plugins/search-backend-module-techdocs/api-report-alpha.md +++ b/plugins/search-backend-module-techdocs/api-report-alpha.api.md @@ -20,5 +20,10 @@ export interface TechDocsCollatorEntityTransformerExtensionPoint { // @alpha export const techdocsCollatorEntityTransformerExtensionPoint: ExtensionPoint; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformerExtensionPoint". +// src/alpha.d.ts:4:5 - (ae-undocumented) Missing documentation for "setTransformer". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-techdocs/api-report.md b/plugins/search-backend-module-techdocs/api-report.api.md similarity index 70% rename from plugins/search-backend-module-techdocs/api-report.md rename to plugins/search-backend-module-techdocs/api-report.api.md index 9c9fae1a38..3ef7bea9c1 100644 --- a/plugins/search-backend-module-techdocs/api-report.md +++ b/plugins/search-backend-module-techdocs/api-report.api.md @@ -54,4 +54,13 @@ export type TechDocsCollatorFactoryOptions = { legacyPathCasing?: boolean; entityTransformer?: TechDocsCollatorEntityTransformer; }; + +// Warnings were encountered during analysis: +// +// src/collators/DefaultTechDocsCollatorFactory.d.ts:34:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:35:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:45:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:46:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/TechDocsCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformer". +// src/collators/defaultTechDocsCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultTechDocsCollatorEntityTransformer". ``` diff --git a/plugins/search-backend-node/api-report-alpha.md b/plugins/search-backend-node/api-report-alpha.api.md similarity index 85% rename from plugins/search-backend-node/api-report-alpha.md rename to plugins/search-backend-node/api-report-alpha.api.md index e1d5bd024d..5c5503db13 100644 --- a/plugins/search-backend-node/api-report-alpha.md +++ b/plugins/search-backend-node/api-report-alpha.api.md @@ -52,5 +52,11 @@ export const searchIndexServiceRef: ServiceRef< 'singleton' >; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:39:5 - (ae-undocumented) Missing documentation for "addCollator". +// src/alpha.d.ts:40:5 - (ae-undocumented) Missing documentation for "addDecorator". +// src/alpha.d.ts:47:5 - (ae-undocumented) Missing documentation for "setSearchEngine". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-node/api-report.md b/plugins/search-backend-node/api-report.api.md similarity index 76% rename from plugins/search-backend-node/api-report.md rename to plugins/search-backend-node/api-report.api.md index 4e769d0eae..b2dae26f86 100644 --- a/plugins/search-backend-node/api-report.md +++ b/plugins/search-backend-node/api-report.api.md @@ -210,4 +210,24 @@ export type TestPipelineResult = { error: unknown; documents: IndexableDocument[]; }; + +// Warnings were encountered during analysis: +// +// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:52:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:65:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/engines/LunrSearchEngine.d.ts:25:5 - (ae-undocumented) Missing documentation for "lunrIndices". +// src/engines/LunrSearchEngine.d.ts:26:5 - (ae-undocumented) Missing documentation for "docStore". +// src/engines/LunrSearchEngine.d.ts:27:5 - (ae-undocumented) Missing documentation for "logger". +// src/engines/LunrSearchEngine.d.ts:28:5 - (ae-undocumented) Missing documentation for "highlightPreTag". +// src/engines/LunrSearchEngine.d.ts:29:5 - (ae-undocumented) Missing documentation for "highlightPostTag". +// src/engines/LunrSearchEngine.d.ts:33:5 - (ae-undocumented) Missing documentation for "translator". +// src/engines/LunrSearchEngine.d.ts:34:5 - (ae-undocumented) Missing documentation for "setTranslator". +// src/engines/LunrSearchEngine.d.ts:35:5 - (ae-undocumented) Missing documentation for "getIndexer". +// src/engines/LunrSearchEngine.d.ts:36:5 - (ae-undocumented) Missing documentation for "query". +// src/engines/LunrSearchEngineIndexer.d.ts:13:5 - (ae-undocumented) Missing documentation for "initialize". +// src/engines/LunrSearchEngineIndexer.d.ts:14:5 - (ae-undocumented) Missing documentation for "finalize". +// src/engines/LunrSearchEngineIndexer.d.ts:15:5 - (ae-undocumented) Missing documentation for "index". +// src/engines/LunrSearchEngineIndexer.d.ts:16:5 - (ae-undocumented) Missing documentation for "buildIndex". +// src/engines/LunrSearchEngineIndexer.d.ts:17:5 - (ae-undocumented) Missing documentation for "getDocumentStore". ``` diff --git a/plugins/search-backend/api-report-alpha.md b/plugins/search-backend/api-report-alpha.api.md similarity index 100% rename from plugins/search-backend/api-report-alpha.md rename to plugins/search-backend/api-report-alpha.api.md diff --git a/plugins/search-backend/api-report.md b/plugins/search-backend/api-report.api.md similarity index 83% rename from plugins/search-backend/api-report.md rename to plugins/search-backend/api-report.api.md index b3f617e5e1..8f739c76f1 100644 --- a/plugins/search-backend/api-report.md +++ b/plugins/search-backend/api-report.api.md @@ -28,4 +28,9 @@ export type RouterOptions = { auth?: AuthService; httpAuth?: HttpAuthService; }; + +// Warnings were encountered during analysis: +// +// src/service/router.d.ts:10:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:23:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/search-common/api-report.md b/plugins/search-common/api-report.api.md similarity index 64% rename from plugins/search-common/api-report.md rename to plugins/search-common/api-report.api.md index 497defc46d..8cda7b0168 100644 --- a/plugins/search-common/api-report.md +++ b/plugins/search-common/api-report.api.md @@ -116,4 +116,24 @@ export type SearchResult = Result; // @public (undocumented) export type SearchResultSet = ResultSet; + +// Warnings were encountered during analysis: +// +// src/types.d.ts:8:1 - (ae-undocumented) Missing documentation for "SearchQuery". +// src/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "term". +// src/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "types". +// src/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "filters". +// src/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "pageLimit". +// src/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "pageCursor". +// src/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "fields". +// src/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "Result". +// src/types.d.ts:64:1 - (ae-undocumented) Missing documentation for "ResultSet". +// src/types.d.ts:65:5 - (ae-undocumented) Missing documentation for "results". +// src/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "nextPageCursor". +// src/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "previousPageCursor". +// src/types.d.ts:68:5 - (ae-undocumented) Missing documentation for "numberOfResults". +// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "SearchResult". +// src/types.d.ts:77:1 - (ae-undocumented) Missing documentation for "SearchResultSet". +// src/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "IndexableResult". +// src/types.d.ts:85:1 - (ae-undocumented) Missing documentation for "IndexableResultSet". ``` diff --git a/plugins/search-react/api-report-alpha.md b/plugins/search-react/api-report-alpha.api.md similarity index 100% rename from plugins/search-react/api-report-alpha.md rename to plugins/search-react/api-report-alpha.api.md diff --git a/plugins/search-react/api-report.md b/plugins/search-react/api-report.api.md similarity index 87% rename from plugins/search-react/api-report.md rename to plugins/search-react/api-report.api.md index 3efed073d8..46097fe188 100644 --- a/plugins/search-react/api-report.md +++ b/plugins/search-react/api-report.api.md @@ -483,4 +483,24 @@ export const useSearchContextCheck: () => boolean; export const useSearchResultListItemExtensions: ( children: ReactNode, ) => (result: SearchResult_2, key?: number) => React_2.JSX.Element; + +// Warnings were encountered during analysis: +// +// src/api.d.ts:5:22 - (ae-undocumented) Missing documentation for "searchApiRef". +// src/api.d.ts:9:1 - (ae-undocumented) Missing documentation for "SearchApi". +// src/api.d.ts:10:5 - (ae-undocumented) Missing documentation for "query". +// src/api.d.ts:18:5 - (ae-undocumented) Missing documentation for "mockedResults". +// src/api.d.ts:20:5 - (ae-undocumented) Missing documentation for "query". +// src/components/DefaultResultListItem/DefaultResultListItem.d.ts:26:15 - (ae-undocumented) Missing documentation for "HigherOrderDefaultResultListItem". +// src/components/HighlightedSearchResultText/HighlightedSearchResultText.d.ts:15:22 - (ae-undocumented) Missing documentation for "HighlightedSearchResultText". +// src/components/SearchFilter/SearchFilter.Autocomplete.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchAutocompleteFilterProps". +// src/components/SearchFilter/SearchFilter.Autocomplete.d.ts:14:22 - (ae-undocumented) Missing documentation for "AutocompleteFilter". +// src/components/SearchFilter/SearchFilter.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchFilterComponentProps". +// src/components/SearchFilter/SearchFilter.d.ts:27:1 - (ae-undocumented) Missing documentation for "SearchFilterWrapperProps". +// src/components/SearchFilter/SearchFilter.d.ts:34:22 - (ae-undocumented) Missing documentation for "CheckboxFilter". +// src/components/SearchFilter/SearchFilter.d.ts:38:22 - (ae-undocumented) Missing documentation for "SelectFilter". +// src/components/SearchFilter/SearchFilter.d.ts:42:15 - (ae-undocumented) Missing documentation for "SearchFilter". +// src/components/SearchResultPager/SearchResultPager.d.ts:5:22 - (ae-undocumented) Missing documentation for "SearchResultPager". +// src/context/SearchContext.d.ts:9:1 - (ae-undocumented) Missing documentation for "SearchContextValue". +// src/context/SearchContext.d.ts:23:1 - (ae-undocumented) Missing documentation for "SearchContextState". ``` diff --git a/plugins/search/api-report-alpha.md b/plugins/search/api-report-alpha.api.md similarity index 92% rename from plugins/search/api-report-alpha.md rename to plugins/search/api-report-alpha.api.md index 9b8f21fa43..36c703a669 100644 --- a/plugins/search/api-report-alpha.md +++ b/plugins/search/api-report-alpha.api.md @@ -194,5 +194,12 @@ export const searchPage: ExtensionDefinition<{ }; }>; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "searchApi". +// src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "searchPage". +// src/alpha.d.ts:9:22 - (ae-undocumented) Missing documentation for "searchNavItem". +// src/alpha.d.ts:13:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/api-report.md b/plugins/search/api-report.api.md similarity index 71% rename from plugins/search/api-report.md rename to plugins/search/api-report.api.md index a47c11b194..5ff64322e2 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.api.md @@ -140,4 +140,19 @@ export type SidebarSearchProps = { // @public export function useSearchModal(initialState?: boolean): SearchModalValue; + +// Warnings were encountered during analysis: +// +// src/components/SearchModal/SearchModal.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchModalChildrenProps". +// src/components/SearchModal/SearchModal.d.ts:14:1 - (ae-undocumented) Missing documentation for "SearchModalProps". +// src/components/SearchModal/SearchModal.d.ts:41:22 - (ae-undocumented) Missing documentation for "SearchModal". +// src/components/SearchPage/SearchPage.d.ts:6:22 - (ae-undocumented) Missing documentation for "SearchPage". +// src/components/SearchType/SearchType.Accordion.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchTypeAccordionProps". +// src/components/SearchType/SearchType.Tabs.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchTypeTabsProps". +// src/components/SearchType/SearchType.d.ts:18:15 - (ae-undocumented) Missing documentation for "SearchType". +// src/components/SidebarSearch/SidebarSearch.d.ts:14:22 - (ae-undocumented) Missing documentation for "SidebarSearch". +// src/plugin.d.ts:6:22 - (ae-undocumented) Missing documentation for "searchPlugin". +// src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "SearchPage". +// src/plugin.d.ts:16:22 - (ae-undocumented) Missing documentation for "SidebarSearchModal". +// src/plugin.d.ts:20:22 - (ae-undocumented) Missing documentation for "HomePageSearchBar". ``` diff --git a/plugins/signals-backend/api-report.md b/plugins/signals-backend/api-report.api.md similarity index 60% rename from plugins/signals-backend/api-report.md rename to plugins/signals-backend/api-report.api.md index 10f74ba37e..5e3069f382 100644 --- a/plugins/signals-backend/api-report.md +++ b/plugins/signals-backend/api-report.api.md @@ -41,5 +41,18 @@ export interface RouterOptions { const signalsPlugin: BackendFeature; export default signalsPlugin; +// Warnings were encountered during analysis: +// +// src/service/router.d.ts:8:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "events". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "identity". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "userInfo". +// src/service/router.d.ts:19:1 - (ae-undocumented) Missing documentation for "createRouter". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals-node/api-report.md b/plugins/signals-node/api-report.api.md similarity index 64% rename from plugins/signals-node/api-report.md rename to plugins/signals-node/api-report.api.md index a368dd2ece..97f06a8ede 100644 --- a/plugins/signals-node/api-report.md +++ b/plugins/signals-node/api-report.api.md @@ -58,5 +58,17 @@ export const signalsServiceRef: ServiceRef< 'singleton' >; +// Warnings were encountered during analysis: +// +// src/DefaultSignalsService.d.ts:5:1 - (ae-undocumented) Missing documentation for "DefaultSignalsService". +// src/DefaultSignalsService.d.ts:7:5 - (ae-undocumented) Missing documentation for "create". +// src/DefaultSignalsService.d.ts:19:22 - (ae-undocumented) Missing documentation for "DefaultSignalService". +// src/SignalsService.d.ts:4:1 - (ae-undocumented) Missing documentation for "SignalsService". +// src/SignalsService.d.ts:15:1 - (ae-undocumented) Missing documentation for "SignalService". +// src/lib.d.ts:3:22 - (ae-undocumented) Missing documentation for "signalsServiceRef". +// src/lib.d.ts:8:22 - (ae-undocumented) Missing documentation for "signalService". +// src/types.d.ts:6:1 - (ae-undocumented) Missing documentation for "SignalsServiceOptions". +// src/types.d.ts:10:1 - (ae-undocumented) Missing documentation for "SignalPayload". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals-react/api-report.md b/plugins/signals-react/api-report.api.md similarity index 60% rename from plugins/signals-react/api-report.md rename to plugins/signals-react/api-report.api.md index 87d856288b..f17f53366a 100644 --- a/plugins/signals-react/api-report.md +++ b/plugins/signals-react/api-report.api.md @@ -32,5 +32,14 @@ export const useSignal: ( isSignalsAvailable: boolean; }; +// Warnings were encountered during analysis: +// +// src/api/SignalApi.d.ts:3:22 - (ae-undocumented) Missing documentation for "signalApiRef". +// src/api/SignalApi.d.ts:5:1 - (ae-undocumented) Missing documentation for "SignalSubscriber". +// src/api/SignalApi.d.ts:6:5 - (ae-undocumented) Missing documentation for "unsubscribe". +// src/api/SignalApi.d.ts:9:1 - (ae-undocumented) Missing documentation for "SignalApi". +// src/api/SignalApi.d.ts:10:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/hooks/useSignal.d.ts:3:22 - (ae-undocumented) Missing documentation for "useSignal". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals/api-report.md b/plugins/signals/api-report.api.md similarity index 67% rename from plugins/signals/api-report.md rename to plugins/signals/api-report.api.md index ca7695aeec..27a4a3fea5 100644 --- a/plugins/signals/api-report.md +++ b/plugins/signals/api-report.api.md @@ -36,5 +36,14 @@ export const SignalsDisplay: () => null; // @public (undocumented) export const signalsPlugin: BackstagePlugin<{}, {}>; +// Warnings were encountered during analysis: +// +// src/api/SignalClient.d.ts:5:1 - (ae-undocumented) Missing documentation for "SignalClient". +// src/api/SignalClient.d.ts:10:5 - (ae-undocumented) Missing documentation for "DEFAULT_CONNECT_TIMEOUT_MS". +// src/api/SignalClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "DEFAULT_RECONNECT_TIMEOUT_MS". +// src/api/SignalClient.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". +// src/api/SignalClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/plugin.d.ts:2:22 - (ae-undocumented) Missing documentation for "signalsPlugin". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs-addons-test-utils/api-report.md b/plugins/techdocs-addons-test-utils/api-report.api.md similarity index 100% rename from plugins/techdocs-addons-test-utils/api-report.md rename to plugins/techdocs-addons-test-utils/api-report.api.md diff --git a/plugins/techdocs-backend/api-report-alpha.md b/plugins/techdocs-backend/api-report-alpha.api.md similarity index 100% rename from plugins/techdocs-backend/api-report-alpha.md rename to plugins/techdocs-backend/api-report-alpha.api.md diff --git a/plugins/techdocs-backend/api-report.md b/plugins/techdocs-backend/api-report.api.md similarity index 77% rename from plugins/techdocs-backend/api-report.md rename to plugins/techdocs-backend/api-report.api.md index dceb0a4d9a..59d21df21c 100644 --- a/plugins/techdocs-backend/api-report.md +++ b/plugins/techdocs-backend/api-report.api.md @@ -112,4 +112,17 @@ export type TechDocsCollatorOptions = { export type TechDocsDocument = TechDocsDocument_2; export * from '@backstage/plugin-techdocs-node'; + +// Warnings were encountered during analysis: +// +// src/index.d.ts:16:1 - (ae-undocumented) Missing documentation for "DocsBuildStrategy". +// src/index.d.ts:21:1 - (ae-undocumented) Missing documentation for "ShouldBuildParameters". +// src/index.d.ts:28:1 - (ae-undocumented) Missing documentation for "TechDocsDocument". +// src/search/DefaultTechDocsCollator.d.ts:31:5 - (ae-undocumented) Missing documentation for "type". +// src/search/DefaultTechDocsCollator.d.ts:32:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/search/DefaultTechDocsCollator.d.ts:34:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/search/DefaultTechDocsCollator.d.ts:35:5 - (ae-undocumented) Missing documentation for "execute". +// src/search/DefaultTechDocsCollator.d.ts:36:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". +// src/search/index.d.ts:12:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorFactoryOptions". +// src/search/index.d.ts:17:22 - (ae-undocumented) Missing documentation for "DefaultTechDocsCollatorFactory". ``` diff --git a/plugins/techdocs-module-addons-contrib/api-report.md b/plugins/techdocs-module-addons-contrib/api-report.api.md similarity index 100% rename from plugins/techdocs-module-addons-contrib/api-report.md rename to plugins/techdocs-module-addons-contrib/api-report.api.md diff --git a/plugins/techdocs-node/api-report.md b/plugins/techdocs-node/api-report.api.md similarity index 90% rename from plugins/techdocs-node/api-report.md rename to plugins/techdocs-node/api-report.api.md index ea93ddfc98..ad6e01636f 100644 --- a/plugins/techdocs-node/api-report.md +++ b/plugins/techdocs-node/api-report.api.md @@ -365,4 +365,16 @@ export class UrlPreparer implements PreparerBase { prepare(entity: Entity, options?: PreparerOptions): Promise; shouldCleanPreparedDirectory(): boolean; } + +// Warnings were encountered during analysis: +// +// src/extensions.d.ts:10:5 - (ae-undocumented) Missing documentation for "setBuildStrategy". +// src/extensions.d.ts:11:5 - (ae-undocumented) Missing documentation for "setBuildLogTransport". +// src/extensions.d.ts:25:5 - (ae-undocumented) Missing documentation for "setTechdocsGenerator". +// src/extensions.d.ts:39:5 - (ae-undocumented) Missing documentation for "registerPreparer". +// src/extensions.d.ts:53:5 - (ae-undocumented) Missing documentation for "registerPublisher". +// src/stages/generate/index.d.ts:10:22 - (ae-undocumented) Missing documentation for "getMkDocsYml". +// src/stages/publish/publish.d.ts:10:5 - (ae-undocumented) Missing documentation for "register". +// src/stages/publish/publish.d.ts:11:5 - (ae-undocumented) Missing documentation for "get". +// src/techdocsTypes.d.ts:39:5 - (ae-undocumented) Missing documentation for "shouldBuild". ``` diff --git a/plugins/techdocs-react/api-report.md b/plugins/techdocs-react/api-report.api.md similarity index 85% rename from plugins/techdocs-react/api-report.md rename to plugins/techdocs-react/api-report.api.md index c158bbd81e..73f122068e 100644 --- a/plugins/techdocs-react/api-report.md +++ b/plugins/techdocs-react/api-report.api.md @@ -192,4 +192,17 @@ export const useTechDocsAddons: () => { // @public export const useTechDocsReaderPage: () => TechDocsReaderPageValue; + +// Warnings were encountered during analysis: +// +// src/api.d.ts:9:5 - (ae-undocumented) Missing documentation for "getCookie". +// src/api.d.ts:12:5 - (ae-undocumented) Missing documentation for "getApiOrigin". +// src/api.d.ts:13:5 - (ae-undocumented) Missing documentation for "getTechDocsMetadata". +// src/api.d.ts:14:5 - (ae-undocumented) Missing documentation for "getEntityMetadata". +// src/api.d.ts:34:5 - (ae-undocumented) Missing documentation for "getApiOrigin". +// src/api.d.ts:35:5 - (ae-undocumented) Missing documentation for "getStorageUrl". +// src/api.d.ts:36:5 - (ae-undocumented) Missing documentation for "getBuilder". +// src/api.d.ts:37:5 - (ae-undocumented) Missing documentation for "getEntityDocs". +// src/api.d.ts:38:5 - (ae-undocumented) Missing documentation for "syncEntityDocs". +// src/api.d.ts:39:5 - (ae-undocumented) Missing documentation for "getBaseUrl". ``` diff --git a/plugins/techdocs/api-report-alpha.md b/plugins/techdocs/api-report-alpha.api.md similarity index 97% rename from plugins/techdocs/api-report-alpha.md rename to plugins/techdocs/api-report-alpha.api.md index 19bdccc948..8a9ce1e1dc 100644 --- a/plugins/techdocs/api-report-alpha.md +++ b/plugins/techdocs/api-report-alpha.api.md @@ -314,5 +314,10 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{ params: SearchResultListItemBlueprintParams; }>; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "techDocsSearchResultListItemExtension". +// src/alpha.d.ts:10:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/api-report.md b/plugins/techdocs/api-report.api.md similarity index 82% rename from plugins/techdocs/api-report.md rename to plugins/techdocs/api-report.api.md index c58a946287..3d90d05eca 100644 --- a/plugins/techdocs/api-report.md +++ b/plugins/techdocs/api-report.api.md @@ -506,4 +506,36 @@ export class TechDocsStorageClient implements TechDocsStorageApi_2 { logHandler?: (line: string) => void, ): Promise; } + +// Warnings were encountered during analysis: +// +// src/api.d.ts:31:5 - (ae-undocumented) Missing documentation for "getApiOrigin". +// src/api.d.ts:32:5 - (ae-undocumented) Missing documentation for "getStorageUrl". +// src/api.d.ts:33:5 - (ae-undocumented) Missing documentation for "getBuilder". +// src/api.d.ts:34:5 - (ae-undocumented) Missing documentation for "getEntityDocs". +// src/api.d.ts:35:5 - (ae-undocumented) Missing documentation for "syncEntityDocs". +// src/api.d.ts:36:5 - (ae-undocumented) Missing documentation for "getBaseUrl". +// src/api.d.ts:45:5 - (ae-undocumented) Missing documentation for "getApiOrigin". +// src/api.d.ts:46:5 - (ae-undocumented) Missing documentation for "getTechDocsMetadata". +// src/api.d.ts:47:5 - (ae-undocumented) Missing documentation for "getEntityMetadata". +// src/client.d.ts:11:5 - (ae-undocumented) Missing documentation for "configApi". +// src/client.d.ts:12:5 - (ae-undocumented) Missing documentation for "discoveryApi". +// src/client.d.ts:19:5 - (ae-undocumented) Missing documentation for "getCookie". +// src/client.d.ts:22:5 - (ae-undocumented) Missing documentation for "getApiOrigin". +// src/client.d.ts:49:5 - (ae-undocumented) Missing documentation for "configApi". +// src/client.d.ts:50:5 - (ae-undocumented) Missing documentation for "discoveryApi". +// src/client.d.ts:59:5 - (ae-undocumented) Missing documentation for "getApiOrigin". +// src/client.d.ts:60:5 - (ae-undocumented) Missing documentation for "getStorageUrl". +// src/client.d.ts:61:5 - (ae-undocumented) Missing documentation for "getBuilder". +// src/client.d.ts:80:5 - (ae-undocumented) Missing documentation for "getBaseUrl". +// src/home/components/TechDocsCustomHome.d.ts:16:5 - (ae-undocumented) Missing documentation for "title". +// src/home/components/TechDocsCustomHome.d.ts:17:5 - (ae-undocumented) Missing documentation for "description". +// src/home/components/TechDocsCustomHome.d.ts:18:5 - (ae-undocumented) Missing documentation for "panelType". +// src/home/components/TechDocsCustomHome.d.ts:19:5 - (ae-undocumented) Missing documentation for "panelCSS". +// src/home/components/TechDocsCustomHome.d.ts:20:5 - (ae-undocumented) Missing documentation for "filterPredicate". +// src/home/components/TechDocsCustomHome.d.ts:28:5 - (ae-undocumented) Missing documentation for "label". +// src/home/components/TechDocsCustomHome.d.ts:29:5 - (ae-undocumented) Missing documentation for "panels". +// src/index.d.ts:21:1 - (ae-undocumented) Missing documentation for "DeprecatedTechDocsMetadata". +// src/index.d.ts:27:1 - (ae-undocumented) Missing documentation for "DeprecatedTechDocsEntityMetadata". +// src/reader/components/TechDocsReaderPage/TechDocsReaderPage.d.ts:26:1 - (ae-undocumented) Missing documentation for "TechDocsReaderPageProps". ``` diff --git a/plugins/user-settings-backend/api-report-alpha.md b/plugins/user-settings-backend/api-report-alpha.api.md similarity index 100% rename from plugins/user-settings-backend/api-report-alpha.md rename to plugins/user-settings-backend/api-report-alpha.api.md diff --git a/plugins/user-settings-backend/api-report.md b/plugins/user-settings-backend/api-report.api.md similarity index 62% rename from plugins/user-settings-backend/api-report.md rename to plugins/user-settings-backend/api-report.api.md index 04aecca574..ac33b9af5d 100644 --- a/plugins/user-settings-backend/api-report.md +++ b/plugins/user-settings-backend/api-report.api.md @@ -18,5 +18,12 @@ export type RouterOptions = { signals?: SignalsService; }; +// Warnings were encountered during analysis: +// +// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "database". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "identity". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "signals". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings-common/api-report.md b/plugins/user-settings-common/api-report.api.md similarity index 71% rename from plugins/user-settings-common/api-report.md rename to plugins/user-settings-common/api-report.api.md index b69f4a4190..a984f71e47 100644 --- a/plugins/user-settings-common/api-report.md +++ b/plugins/user-settings-common/api-report.api.md @@ -9,5 +9,9 @@ export type UserSettingsSignal = { key: string; }; +// Warnings were encountered during analysis: +// +// src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "UserSettingsSignal". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings/api-report-alpha.md b/plugins/user-settings/api-report-alpha.api.md similarity index 91% rename from plugins/user-settings/api-report-alpha.md rename to plugins/user-settings/api-report-alpha.api.md index 63db1defe0..0a5dbde28d 100644 --- a/plugins/user-settings/api-report-alpha.md +++ b/plugins/user-settings/api-report-alpha.api.md @@ -127,5 +127,11 @@ export const userSettingsTranslationRef: TranslationRef< } >; +// Warnings were encountered during analysis: +// +// src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "settingsNavItem". +// src/alpha.d.ts:9:15 - (ae-undocumented) Missing documentation for "_default". +// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "userSettingsTranslationRef". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings/api-report.md b/plugins/user-settings/api-report.api.md similarity index 59% rename from plugins/user-settings/api-report.md rename to plugins/user-settings/api-report.api.md index cee35724bb..6169668adc 100644 --- a/plugins/user-settings/api-report.md +++ b/plugins/user-settings/api-report.api.md @@ -179,4 +179,36 @@ export const useUserProfile: () => displayName: string; loading: false; }; + +// Warnings were encountered during analysis: +// +// src/apis/StorageApi/UserSettingsStorage.d.ts:21:5 - (ae-undocumented) Missing documentation for "create". +// src/apis/StorageApi/UserSettingsStorage.d.ts:29:5 - (ae-undocumented) Missing documentation for "forBucket". +// src/apis/StorageApi/UserSettingsStorage.d.ts:30:5 - (ae-undocumented) Missing documentation for "remove". +// src/apis/StorageApi/UserSettingsStorage.d.ts:31:5 - (ae-undocumented) Missing documentation for "set". +// src/apis/StorageApi/UserSettingsStorage.d.ts:32:5 - (ae-undocumented) Missing documentation for "observe$". +// src/apis/StorageApi/UserSettingsStorage.d.ts:33:5 - (ae-undocumented) Missing documentation for "snapshot". +// src/components/AuthProviders/DefaultProviderSettings.d.ts:3:22 - (ae-undocumented) Missing documentation for "DefaultProviderSettings". +// src/components/AuthProviders/ProviderSettingsItem.d.ts:4:22 - (ae-undocumented) Missing documentation for "ProviderSettingsItem". +// src/components/AuthProviders/UserSettingsAuthProviders.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsAuthProviders". +// src/components/FeatureFlags/UserSettingsFeatureFlags.d.ts:5:22 - (ae-undocumented) Missing documentation for "UserSettingsFeatureFlags". +// src/components/General/UserSettingsAppearanceCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsAppearanceCard". +// src/components/General/UserSettingsGeneral.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsGeneral". +// src/components/General/UserSettingsIdentityCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsIdentityCard". +// src/components/General/UserSettingsLanguageToggle.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsLanguageToggle". +// src/components/General/UserSettingsMenu.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsMenu". +// src/components/General/UserSettingsPinToggle.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsPinToggle". +// src/components/General/UserSettingsProfileCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsProfileCard". +// src/components/General/UserSettingsSignInAvatar.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsSignInAvatar". +// src/components/General/UserSettingsThemeToggle.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsThemeToggle". +// src/components/Settings.d.ts:4:22 - (ae-undocumented) Missing documentation for "Settings". +// src/components/SettingsLayout/SettingsLayout.d.ts:4:1 - (ae-undocumented) Missing documentation for "SettingsLayoutRouteProps". +// src/components/SettingsLayout/SettingsLayout.d.ts:15:1 - (ae-undocumented) Missing documentation for "SettingsLayoutProps". +// src/components/SettingsLayout/SettingsLayout.d.ts:23:22 - (ae-undocumented) Missing documentation for "SettingsLayout". +// src/components/SettingsPage/SettingsPage.d.ts:3:22 - (ae-undocumented) Missing documentation for "SettingsPage". +// src/components/UserSettingsTab/UserSettingsTab.d.ts:3:22 - (ae-undocumented) Missing documentation for "USER_SETTINGS_TAB_KEY". +// src/components/UserSettingsTab/UserSettingsTab.d.ts:5:1 - (ae-undocumented) Missing documentation for "UserSettingsTabProps". +// src/components/useUserProfileInfo.d.ts:3:22 - (ae-undocumented) Missing documentation for "useUserProfile". +// src/plugin.d.ts:4:22 - (ae-undocumented) Missing documentation for "userSettingsPlugin". +// src/plugin.d.ts:8:22 - (ae-undocumented) Missing documentation for "UserSettingsPage". ``` From a2ae88d21a77aa4596905877b88e81ba70911d28 Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 14:02:43 +0200 Subject: [PATCH 03/13] feat: use report.api.md pattern for api reports Signed-off-by: secustor --- .prettierignore | 4 ++-- .../src/commands/api-reports/api-extractor.ts | 11 +++++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.prettierignore b/.prettierignore index 2212e834c0..c7a16065e5 100644 --- a/.prettierignore +++ b/.prettierignore @@ -8,8 +8,8 @@ templates api-report.md api-report-*.md # new reports -api-report.api.md -api-report-*.api.md +report.api.md +report-*.api.md knip-report.md cli-report.md diff --git a/packages/repo-tools/src/commands/api-reports/api-extractor.ts b/packages/repo-tools/src/commands/api-reports/api-extractor.ts index fa8dea5f28..4546b292c8 100644 --- a/packages/repo-tools/src/commands/api-reports/api-extractor.ts +++ b/packages/repo-tools/src/commands/api-reports/api-extractor.ts @@ -393,16 +393,19 @@ export async function runApiExtraction({ ); const remainingReportFiles = new Set( - fs.readdirSync(projectFolder).filter(filename => - // https://regex101.com/r/QDZIV0/1 - filename.match(/^.*?api-report(-[^.-]+)?(\.md(\.api\.md)?)$/), + fs.readdirSync(projectFolder).filter( + filename => + // https://regex101.com/r/QDZIV0/2 + filename !== 'knip-report.md' && + // this has to temporarily match all old api report formats + filename.match(/^.*?(api-)?report(-[^.-]+)?(.*?)\.md$/), ), ); for (const packageEntryPoint of packageEntryPoints) { const suffix = packageEntryPoint.name === 'index' ? '' : `-${packageEntryPoint.name}`; - const reportFileName = `api-report${suffix}`; + const reportFileName = `report${suffix}`; const reportPath = resolvePath(projectFolder, reportFileName); remainingReportFiles.delete(reportFileName); From c28596309f8ba79516614072fdf1e45206d29b33 Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 14:05:09 +0200 Subject: [PATCH 04/13] update files Signed-off-by: secustor --- .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 2 +- ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...-report-auth.api.md => report-auth.api.md} | 0 ...eport-cache.api.md => report-cache.api.md} | 0 ...database.api.md => report-database.api.md} | 0 ...scovery.api.md => report-discovery.api.md} | 0 ...httpAuth.api.md => report-httpAuth.api.md} | 0 ...Router.api.md => report-httpRouter.api.md} | 0 ...fecycle.api.md => report-lifecycle.api.md} | 0 ...ort-logger.api.md => report-logger.api.md} | 0 ...sions.api.md => report-permissions.api.md} | 0 ...Config.api.md => report-rootConfig.api.md} | 0 ...Health.api.md => report-rootHealth.api.md} | 0 ...er.api.md => report-rootHttpRouter.api.md} | 1 + ...cle.api.md => report-rootLifecycle.api.md} | 0 ...Logger.api.md => report-rootLogger.api.md} | 0 ...heduler.api.md => report-scheduler.api.md} | 0 ...lReader.api.md => report-urlReader.api.md} | 0 ...userInfo.api.md => report-userInfo.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 ...stUtils.api.md => report-testUtils.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 6 +- .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 ...stUtils.api.md => report-testUtils.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...wright.api.md => report-playwright.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 1618 +++++++---------- .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 2 +- .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 2 +- .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../home/{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...pi-report-alpha.md => report-alpha.api.md} | 4 + .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../org/{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 8 +- .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 38 +- ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 4 +- .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 2 +- .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 .../{api-report.api.md => report.api.md} | 0 ...eport-alpha.api.md => report-alpha.api.md} | 2 +- .../{api-report.api.md => report.api.md} | 0 250 files changed, 700 insertions(+), 989 deletions(-) rename packages/app-defaults/{api-report.api.md => report.api.md} (100%) rename packages/app-next-example-plugin/{api-report.api.md => report.api.md} (96%) rename packages/backend-app-api/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename packages/backend-app-api/{api-report.api.md => report.api.md} (100%) rename packages/backend-defaults/{api-report-auth.api.md => report-auth.api.md} (100%) rename packages/backend-defaults/{api-report-cache.api.md => report-cache.api.md} (100%) rename packages/backend-defaults/{api-report-database.api.md => report-database.api.md} (100%) rename packages/backend-defaults/{api-report-discovery.api.md => report-discovery.api.md} (100%) rename packages/backend-defaults/{api-report-httpAuth.api.md => report-httpAuth.api.md} (100%) rename packages/backend-defaults/{api-report-httpRouter.api.md => report-httpRouter.api.md} (100%) rename packages/backend-defaults/{api-report-lifecycle.api.md => report-lifecycle.api.md} (100%) rename packages/backend-defaults/{api-report-logger.api.md => report-logger.api.md} (100%) rename packages/backend-defaults/{api-report-permissions.api.md => report-permissions.api.md} (100%) rename packages/backend-defaults/{api-report-rootConfig.api.md => report-rootConfig.api.md} (100%) rename packages/backend-defaults/{api-report-rootHealth.api.md => report-rootHealth.api.md} (100%) rename packages/backend-defaults/{api-report-rootHttpRouter.api.md => report-rootHttpRouter.api.md} (98%) rename packages/backend-defaults/{api-report-rootLifecycle.api.md => report-rootLifecycle.api.md} (100%) rename packages/backend-defaults/{api-report-rootLogger.api.md => report-rootLogger.api.md} (100%) rename packages/backend-defaults/{api-report-scheduler.api.md => report-scheduler.api.md} (100%) rename packages/backend-defaults/{api-report-urlReader.api.md => report-urlReader.api.md} (100%) rename packages/backend-defaults/{api-report-userInfo.api.md => report-userInfo.api.md} (100%) rename packages/backend-defaults/{api-report.api.md => report.api.md} (100%) rename packages/backend-dev-utils/{api-report.api.md => report.api.md} (100%) rename packages/backend-dynamic-feature-service/{api-report.api.md => report.api.md} (100%) rename packages/backend-openapi-utils/{api-report.api.md => report.api.md} (100%) rename packages/backend-plugin-api/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename packages/backend-plugin-api/{api-report-testUtils.api.md => report-testUtils.api.md} (100%) rename packages/backend-plugin-api/{api-report.api.md => report.api.md} (100%) rename packages/backend-test-utils/{api-report.api.md => report.api.md} (100%) rename packages/catalog-client/{api-report.api.md => report.api.md} (100%) rename packages/catalog-model/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename packages/catalog-model/{api-report.api.md => report.api.md} (100%) rename packages/cli-common/{api-report.api.md => report.api.md} (100%) rename packages/cli-node/{api-report.api.md => report.api.md} (100%) rename packages/config-loader/{api-report.api.md => report.api.md} (97%) rename packages/config/{api-report.api.md => report.api.md} (100%) rename packages/core-app-api/{api-report.api.md => report.api.md} (100%) rename packages/core-compat-api/{api-report.api.md => report.api.md} (100%) rename packages/core-components/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename packages/core-components/{api-report-testUtils.api.md => report-testUtils.api.md} (100%) rename packages/core-components/{api-report.api.md => report.api.md} (100%) rename packages/core-plugin-api/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename packages/core-plugin-api/{api-report.api.md => report.api.md} (100%) rename packages/dev-utils/{api-report.api.md => report.api.md} (100%) rename packages/e2e-test-utils/{api-report-playwright.api.md => report-playwright.api.md} (100%) rename packages/errors/{api-report.api.md => report.api.md} (100%) rename packages/frontend-app-api/{api-report.api.md => report.api.md} (100%) rename packages/frontend-plugin-api/{api-report.api.md => report.api.md} (60%) rename packages/frontend-test-utils/{api-report.api.md => report.api.md} (100%) rename packages/integration-aws-node/{api-report.api.md => report.api.md} (100%) rename packages/integration-react/{api-report.api.md => report.api.md} (100%) rename packages/integration/{api-report.api.md => report.api.md} (100%) rename packages/release-manifests/{api-report.api.md => report.api.md} (100%) rename packages/test-utils/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename packages/test-utils/{api-report.api.md => report.api.md} (100%) rename packages/theme/{api-report.api.md => report.api.md} (100%) rename packages/types/{api-report.api.md => report.api.md} (100%) rename packages/version-bridge/{api-report.api.md => report.api.md} (100%) rename packages/yarn-plugin/{api-report.api.md => report.api.md} (100%) rename plugins/api-docs-module-protoc-gen-doc/{api-report.api.md => report.api.md} (100%) rename plugins/api-docs/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/api-docs/{api-report.api.md => report.api.md} (100%) rename plugins/app-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/app-backend/{api-report.api.md => report.api.md} (100%) rename plugins/app-node/{api-report.api.md => report.api.md} (100%) rename plugins/app-visualizer/{api-report.api.md => report.api.md} (97%) rename plugins/auth-backend-module-atlassian-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-aws-alb-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-azure-easyauth-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-bitbucket-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-cloudflare-access-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-gcp-iap-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-github-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-gitlab-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-google-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-guest-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-microsoft-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-oauth2-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-oauth2-proxy-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-oidc-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-okta-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-onelogin-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-pinniped-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend-module-vmware-cloud-provider/{api-report.api.md => report.api.md} (100%) rename plugins/auth-backend/{api-report.api.md => report.api.md} (100%) rename plugins/auth-node/{api-report.api.md => report.api.md} (100%) rename plugins/auth-react/{api-report.api.md => report.api.md} (100%) rename plugins/bitbucket-cloud-common/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-aws/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-aws/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-azure/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-azure/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-backstage-openapi/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-bitbucket-cloud/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-bitbucket-cloud/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-bitbucket-server/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-bitbucket-server/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-gcp/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-gcp/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-gerrit/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-gerrit/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-github-org/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-github/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-github/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-gitlab-org/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-gitlab/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-gitlab/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-incremental-ingestion/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-incremental-ingestion/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-ldap/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-logs/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-msgraph/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-msgraph/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-openapi/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-puppetdb/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend-module-puppetdb/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-scaffolder-entity-model/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend-module-unprocessed/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-backend/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-common/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-common/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-graph/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-graph/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-import/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-import/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-node/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-node/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-react/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog-react/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-unprocessed-entities-common/{api-report.api.md => report.api.md} (100%) rename plugins/catalog-unprocessed-entities/{api-report.api.md => report.api.md} (100%) rename plugins/catalog/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/catalog/{api-report.api.md => report.api.md} (100%) rename plugins/config-schema/{api-report.api.md => report.api.md} (100%) rename plugins/devtools-backend/{api-report.api.md => report.api.md} (100%) rename plugins/devtools-common/{api-report.api.md => report.api.md} (100%) rename plugins/devtools/{api-report-alpha.api.md => report-alpha.api.md} (97%) rename plugins/devtools/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-module-aws-sqs/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend-module-aws-sqs/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-module-azure/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend-module-azure/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-module-bitbucket-cloud/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend-module-bitbucket-cloud/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-module-gerrit/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend-module-gerrit/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-module-github/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend-module-github/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-module-gitlab/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend-module-gitlab/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend-test-utils/{api-report.api.md => report.api.md} (100%) rename plugins/events-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-backend/{api-report.api.md => report.api.md} (100%) rename plugins/events-node/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/events-node/{api-report.api.md => report.api.md} (100%) rename plugins/example-todo-list-backend/{api-report.api.md => report.api.md} (100%) rename plugins/example-todo-list-common/{api-report.api.md => report.api.md} (100%) rename plugins/example-todo-list/{api-report.api.md => report.api.md} (100%) rename plugins/home-react/{api-report.api.md => report.api.md} (100%) rename plugins/home/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/home/{api-report.api.md => report.api.md} (100%) rename plugins/kubernetes-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/kubernetes-backend/{api-report.api.md => report.api.md} (100%) rename plugins/kubernetes-cluster/{api-report.api.md => report.api.md} (100%) rename plugins/kubernetes-common/{api-report.api.md => report.api.md} (100%) rename plugins/kubernetes-node/{api-report.api.md => report.api.md} (100%) rename plugins/kubernetes-react/{api-report.api.md => report.api.md} (100%) rename plugins/kubernetes/{api-report-alpha.md => report-alpha.api.md} (97%) rename plugins/kubernetes/{api-report.api.md => report.api.md} (100%) rename plugins/notifications-backend-module-email/{api-report.api.md => report.api.md} (100%) rename plugins/notifications-backend/{api-report.api.md => report.api.md} (100%) rename plugins/notifications-common/{api-report.api.md => report.api.md} (100%) rename plugins/notifications-node/{api-report.api.md => report.api.md} (100%) rename plugins/notifications/{api-report.api.md => report.api.md} (100%) rename plugins/org-react/{api-report.api.md => report.api.md} (100%) rename plugins/org/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/org/{api-report.api.md => report.api.md} (100%) rename plugins/permission-backend-module-policy-allow-all/{api-report.api.md => report.api.md} (100%) rename plugins/permission-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/permission-backend/{api-report.api.md => report.api.md} (100%) rename plugins/permission-common/{api-report.api.md => report.api.md} (100%) rename plugins/permission-node/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/permission-node/{api-report.api.md => report.api.md} (100%) rename plugins/permission-react/{api-report.api.md => report.api.md} (100%) rename plugins/proxy-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/proxy-backend/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-azure/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-bitbucket-cloud/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-bitbucket-server/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-bitbucket/{api-report.api.md => report.api.md} (90%) rename plugins/scaffolder-backend-module-confluence-to-markdown/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-cookiecutter/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-gcp/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-gerrit/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-gitea/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-github/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-gitlab/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-notifications/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-rails/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-sentry/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend-module-yeoman/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/scaffolder-backend/{api-report.api.md => report.api.md} (96%) rename plugins/scaffolder-common/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/scaffolder-common/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-node-test-utils/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-node/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/scaffolder-node/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder-react/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/scaffolder-react/{api-report.api.md => report.api.md} (100%) rename plugins/scaffolder/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/scaffolder/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-module-catalog/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend-module-catalog/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-module-elasticsearch/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend-module-elasticsearch/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-module-explore/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend-module-explore/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-module-pg/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend-module-pg/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-module-stack-overflow-collator/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-module-techdocs/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend-module-techdocs/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend-node/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend-node/{api-report.api.md => report.api.md} (100%) rename plugins/search-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-backend/{api-report.api.md => report.api.md} (100%) rename plugins/search-common/{api-report.api.md => report.api.md} (100%) rename plugins/search-react/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/search-react/{api-report.api.md => report.api.md} (100%) rename plugins/search/{api-report-alpha.api.md => report-alpha.api.md} (97%) rename plugins/search/{api-report.api.md => report.api.md} (100%) rename plugins/signals-backend/{api-report.api.md => report.api.md} (100%) rename plugins/signals-node/{api-report.api.md => report.api.md} (100%) rename plugins/signals-react/{api-report.api.md => report.api.md} (100%) rename plugins/signals/{api-report.api.md => report.api.md} (100%) rename plugins/techdocs-addons-test-utils/{api-report.api.md => report.api.md} (100%) rename plugins/techdocs-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/techdocs-backend/{api-report.api.md => report.api.md} (100%) rename plugins/techdocs-module-addons-contrib/{api-report.api.md => report.api.md} (100%) rename plugins/techdocs-node/{api-report.api.md => report.api.md} (100%) rename plugins/techdocs-react/{api-report.api.md => report.api.md} (100%) rename plugins/techdocs/{api-report-alpha.api.md => report-alpha.api.md} (99%) rename plugins/techdocs/{api-report.api.md => report.api.md} (100%) rename plugins/user-settings-backend/{api-report-alpha.api.md => report-alpha.api.md} (100%) rename plugins/user-settings-backend/{api-report.api.md => report.api.md} (100%) rename plugins/user-settings-common/{api-report.api.md => report.api.md} (100%) rename plugins/user-settings/{api-report-alpha.api.md => report-alpha.api.md} (97%) rename plugins/user-settings/{api-report.api.md => report.api.md} (100%) diff --git a/packages/app-defaults/api-report.api.md b/packages/app-defaults/report.api.md similarity index 100% rename from packages/app-defaults/api-report.api.md rename to packages/app-defaults/report.api.md diff --git a/packages/app-next-example-plugin/api-report.api.md b/packages/app-next-example-plugin/report.api.md similarity index 96% rename from packages/app-next-example-plugin/api-report.api.md rename to packages/app-next-example-plugin/report.api.md index ededab5e47..842e58aeb5 100644 --- a/packages/app-next-example-plugin/api-report.api.md +++ b/packages/app-next-example-plugin/report.api.md @@ -55,7 +55,7 @@ export const ExampleSidebarItem: () => React_2.JSX.Element; // Warnings were encountered during analysis: // // src/ExampleSidebarItem.d.ts:3:22 - (ae-undocumented) Missing documentation for "ExampleSidebarItem". -// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "examplePlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "examplePlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/api-report-alpha.api.md b/packages/backend-app-api/report-alpha.api.md similarity index 100% rename from packages/backend-app-api/api-report-alpha.api.md rename to packages/backend-app-api/report-alpha.api.md diff --git a/packages/backend-app-api/api-report.api.md b/packages/backend-app-api/report.api.md similarity index 100% rename from packages/backend-app-api/api-report.api.md rename to packages/backend-app-api/report.api.md diff --git a/packages/backend-defaults/api-report-auth.api.md b/packages/backend-defaults/report-auth.api.md similarity index 100% rename from packages/backend-defaults/api-report-auth.api.md rename to packages/backend-defaults/report-auth.api.md diff --git a/packages/backend-defaults/api-report-cache.api.md b/packages/backend-defaults/report-cache.api.md similarity index 100% rename from packages/backend-defaults/api-report-cache.api.md rename to packages/backend-defaults/report-cache.api.md diff --git a/packages/backend-defaults/api-report-database.api.md b/packages/backend-defaults/report-database.api.md similarity index 100% rename from packages/backend-defaults/api-report-database.api.md rename to packages/backend-defaults/report-database.api.md diff --git a/packages/backend-defaults/api-report-discovery.api.md b/packages/backend-defaults/report-discovery.api.md similarity index 100% rename from packages/backend-defaults/api-report-discovery.api.md rename to packages/backend-defaults/report-discovery.api.md diff --git a/packages/backend-defaults/api-report-httpAuth.api.md b/packages/backend-defaults/report-httpAuth.api.md similarity index 100% rename from packages/backend-defaults/api-report-httpAuth.api.md rename to packages/backend-defaults/report-httpAuth.api.md diff --git a/packages/backend-defaults/api-report-httpRouter.api.md b/packages/backend-defaults/report-httpRouter.api.md similarity index 100% rename from packages/backend-defaults/api-report-httpRouter.api.md rename to packages/backend-defaults/report-httpRouter.api.md diff --git a/packages/backend-defaults/api-report-lifecycle.api.md b/packages/backend-defaults/report-lifecycle.api.md similarity index 100% rename from packages/backend-defaults/api-report-lifecycle.api.md rename to packages/backend-defaults/report-lifecycle.api.md diff --git a/packages/backend-defaults/api-report-logger.api.md b/packages/backend-defaults/report-logger.api.md similarity index 100% rename from packages/backend-defaults/api-report-logger.api.md rename to packages/backend-defaults/report-logger.api.md diff --git a/packages/backend-defaults/api-report-permissions.api.md b/packages/backend-defaults/report-permissions.api.md similarity index 100% rename from packages/backend-defaults/api-report-permissions.api.md rename to packages/backend-defaults/report-permissions.api.md diff --git a/packages/backend-defaults/api-report-rootConfig.api.md b/packages/backend-defaults/report-rootConfig.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootConfig.api.md rename to packages/backend-defaults/report-rootConfig.api.md diff --git a/packages/backend-defaults/api-report-rootHealth.api.md b/packages/backend-defaults/report-rootHealth.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootHealth.api.md rename to packages/backend-defaults/report-rootHealth.api.md diff --git a/packages/backend-defaults/api-report-rootHttpRouter.api.md b/packages/backend-defaults/report-rootHttpRouter.api.md similarity index 98% rename from packages/backend-defaults/api-report-rootHttpRouter.api.md rename to packages/backend-defaults/report-rootHttpRouter.api.md index 672844a98e..9a435f5c27 100644 --- a/packages/backend-defaults/api-report-rootHttpRouter.api.md +++ b/packages/backend-defaults/report-rootHttpRouter.api.md @@ -159,6 +159,7 @@ export const rootHttpRouterServiceFactory: (( // src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:23:5 - (ae-undocumented) Missing documentation for "create". // src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:25:5 - (ae-undocumented) Missing documentation for "use". // src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "handler". +// src/entrypoints/rootHttpRouter/createHealthRouter.d.ts:6:1 - (ae-undocumented) Missing documentation for "createHealthRouter". // src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". // src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". // src/entrypoints/rootHttpRouter/http/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". diff --git a/packages/backend-defaults/api-report-rootLifecycle.api.md b/packages/backend-defaults/report-rootLifecycle.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootLifecycle.api.md rename to packages/backend-defaults/report-rootLifecycle.api.md diff --git a/packages/backend-defaults/api-report-rootLogger.api.md b/packages/backend-defaults/report-rootLogger.api.md similarity index 100% rename from packages/backend-defaults/api-report-rootLogger.api.md rename to packages/backend-defaults/report-rootLogger.api.md diff --git a/packages/backend-defaults/api-report-scheduler.api.md b/packages/backend-defaults/report-scheduler.api.md similarity index 100% rename from packages/backend-defaults/api-report-scheduler.api.md rename to packages/backend-defaults/report-scheduler.api.md diff --git a/packages/backend-defaults/api-report-urlReader.api.md b/packages/backend-defaults/report-urlReader.api.md similarity index 100% rename from packages/backend-defaults/api-report-urlReader.api.md rename to packages/backend-defaults/report-urlReader.api.md diff --git a/packages/backend-defaults/api-report-userInfo.api.md b/packages/backend-defaults/report-userInfo.api.md similarity index 100% rename from packages/backend-defaults/api-report-userInfo.api.md rename to packages/backend-defaults/report-userInfo.api.md diff --git a/packages/backend-defaults/api-report.api.md b/packages/backend-defaults/report.api.md similarity index 100% rename from packages/backend-defaults/api-report.api.md rename to packages/backend-defaults/report.api.md diff --git a/packages/backend-dev-utils/api-report.api.md b/packages/backend-dev-utils/report.api.md similarity index 100% rename from packages/backend-dev-utils/api-report.api.md rename to packages/backend-dev-utils/report.api.md diff --git a/packages/backend-dynamic-feature-service/api-report.api.md b/packages/backend-dynamic-feature-service/report.api.md similarity index 100% rename from packages/backend-dynamic-feature-service/api-report.api.md rename to packages/backend-dynamic-feature-service/report.api.md diff --git a/packages/backend-openapi-utils/api-report.api.md b/packages/backend-openapi-utils/report.api.md similarity index 100% rename from packages/backend-openapi-utils/api-report.api.md rename to packages/backend-openapi-utils/report.api.md diff --git a/packages/backend-plugin-api/api-report-alpha.api.md b/packages/backend-plugin-api/report-alpha.api.md similarity index 100% rename from packages/backend-plugin-api/api-report-alpha.api.md rename to packages/backend-plugin-api/report-alpha.api.md diff --git a/packages/backend-plugin-api/api-report-testUtils.api.md b/packages/backend-plugin-api/report-testUtils.api.md similarity index 100% rename from packages/backend-plugin-api/api-report-testUtils.api.md rename to packages/backend-plugin-api/report-testUtils.api.md diff --git a/packages/backend-plugin-api/api-report.api.md b/packages/backend-plugin-api/report.api.md similarity index 100% rename from packages/backend-plugin-api/api-report.api.md rename to packages/backend-plugin-api/report.api.md diff --git a/packages/backend-test-utils/api-report.api.md b/packages/backend-test-utils/report.api.md similarity index 100% rename from packages/backend-test-utils/api-report.api.md rename to packages/backend-test-utils/report.api.md diff --git a/packages/catalog-client/api-report.api.md b/packages/catalog-client/report.api.md similarity index 100% rename from packages/catalog-client/api-report.api.md rename to packages/catalog-client/report.api.md diff --git a/packages/catalog-model/api-report-alpha.api.md b/packages/catalog-model/report-alpha.api.md similarity index 100% rename from packages/catalog-model/api-report-alpha.api.md rename to packages/catalog-model/report-alpha.api.md diff --git a/packages/catalog-model/api-report.api.md b/packages/catalog-model/report.api.md similarity index 100% rename from packages/catalog-model/api-report.api.md rename to packages/catalog-model/report.api.md diff --git a/packages/cli-common/api-report.api.md b/packages/cli-common/report.api.md similarity index 100% rename from packages/cli-common/api-report.api.md rename to packages/cli-common/report.api.md diff --git a/packages/cli-node/api-report.api.md b/packages/cli-node/report.api.md similarity index 100% rename from packages/cli-node/api-report.api.md rename to packages/cli-node/report.api.md diff --git a/packages/config-loader/api-report.api.md b/packages/config-loader/report.api.md similarity index 97% rename from packages/config-loader/api-report.api.md rename to packages/config-loader/report.api.md index 42b6dcab96..0bb88a67b3 100644 --- a/packages/config-loader/api-report.api.md +++ b/packages/config-loader/report.api.md @@ -293,9 +293,9 @@ export type TransformFunc = ( // src/sources/ConfigSources.d.ts:42:5 - (ae-undocumented) Missing documentation for "watch". // src/sources/ConfigSources.d.ts:43:5 - (ae-undocumented) Missing documentation for "rootDir". // src/sources/ConfigSources.d.ts:44:5 - (ae-undocumented) Missing documentation for "remote". -// src/sources/ConfigSources.d.ts:60:5 - (ae-undocumented) Missing documentation for "targets". -// src/sources/ConfigSources.d.ts:68:5 - (ae-undocumented) Missing documentation for "argv". -// src/sources/ConfigSources.d.ts:69:5 - (ae-undocumented) Missing documentation for "env". +// src/sources/ConfigSources.d.ts:65:5 - (ae-undocumented) Missing documentation for "targets". +// src/sources/ConfigSources.d.ts:73:5 - (ae-undocumented) Missing documentation for "argv". +// src/sources/ConfigSources.d.ts:74:5 - (ae-undocumented) Missing documentation for "env". // src/sources/EnvConfigSource.d.ts:46:5 - (ae-undocumented) Missing documentation for "readConfigData". // src/sources/EnvConfigSource.d.ts:47:5 - (ae-undocumented) Missing documentation for "toString". // src/sources/FileConfigSource.d.ts:40:5 - (ae-undocumented) Missing documentation for "readConfigData". diff --git a/packages/config/api-report.api.md b/packages/config/report.api.md similarity index 100% rename from packages/config/api-report.api.md rename to packages/config/report.api.md diff --git a/packages/core-app-api/api-report.api.md b/packages/core-app-api/report.api.md similarity index 100% rename from packages/core-app-api/api-report.api.md rename to packages/core-app-api/report.api.md diff --git a/packages/core-compat-api/api-report.api.md b/packages/core-compat-api/report.api.md similarity index 100% rename from packages/core-compat-api/api-report.api.md rename to packages/core-compat-api/report.api.md diff --git a/packages/core-components/api-report-alpha.api.md b/packages/core-components/report-alpha.api.md similarity index 100% rename from packages/core-components/api-report-alpha.api.md rename to packages/core-components/report-alpha.api.md diff --git a/packages/core-components/api-report-testUtils.api.md b/packages/core-components/report-testUtils.api.md similarity index 100% rename from packages/core-components/api-report-testUtils.api.md rename to packages/core-components/report-testUtils.api.md diff --git a/packages/core-components/api-report.api.md b/packages/core-components/report.api.md similarity index 100% rename from packages/core-components/api-report.api.md rename to packages/core-components/report.api.md diff --git a/packages/core-plugin-api/api-report-alpha.api.md b/packages/core-plugin-api/report-alpha.api.md similarity index 100% rename from packages/core-plugin-api/api-report-alpha.api.md rename to packages/core-plugin-api/report-alpha.api.md diff --git a/packages/core-plugin-api/api-report.api.md b/packages/core-plugin-api/report.api.md similarity index 100% rename from packages/core-plugin-api/api-report.api.md rename to packages/core-plugin-api/report.api.md diff --git a/packages/dev-utils/api-report.api.md b/packages/dev-utils/report.api.md similarity index 100% rename from packages/dev-utils/api-report.api.md rename to packages/dev-utils/report.api.md diff --git a/packages/e2e-test-utils/api-report-playwright.api.md b/packages/e2e-test-utils/report-playwright.api.md similarity index 100% rename from packages/e2e-test-utils/api-report-playwright.api.md rename to packages/e2e-test-utils/report-playwright.api.md diff --git a/packages/errors/api-report.api.md b/packages/errors/report.api.md similarity index 100% rename from packages/errors/api-report.api.md rename to packages/errors/report.api.md diff --git a/packages/frontend-app-api/api-report.api.md b/packages/frontend-app-api/report.api.md similarity index 100% rename from packages/frontend-app-api/api-report.api.md rename to packages/frontend-app-api/report.api.md diff --git a/packages/frontend-plugin-api/api-report.api.md b/packages/frontend-plugin-api/report.api.md similarity index 60% rename from packages/frontend-plugin-api/api-report.api.md rename to packages/frontend-plugin-api/report.api.md index 9afcb1b91e..24aa1d5b52 100644 --- a/packages/frontend-plugin-api/api-report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -89,6 +89,8 @@ import { useTranslationRef } from '@backstage/core-plugin-api/alpha'; import { vmwareCloudAuthApiRef } from '@backstage/core-plugin-api'; import { withApis } from '@backstage/core-plugin-api'; import { z } from 'zod'; +import { ZodSchema } from 'zod'; +import { ZodTypeDef } from 'zod'; export { AlertApi }; @@ -146,13 +148,26 @@ export { AnyApiFactory }; export { AnyApiRef }; // @public (undocumented) -export type AnyExtensionDataRef = ExtensionDataRef< - unknown, - string, - { - optional?: true; - } ->; +export type AnyExtensionDataMap = { + [name in string]: ExtensionDataRef< + unknown, + string, + { + optional?: true; + } + >; +}; + +// @public (undocumented) +export type AnyExtensionInputMap = { + [inputName in string]: ExtensionInput< + AnyExtensionDataMap, + { + optional: boolean; + singleton: boolean; + } + >; +}; // @public (undocumented) export type AnyExternalRoutes = { @@ -171,26 +186,6 @@ export type AnyRoutes = { [name in string]: RouteRef | SubRouteRef; }; -// @public -export const ApiBlueprint: ExtensionBlueprint<{ - kind: 'api'; - name: undefined; - params: { - factory: AnyApiFactory; - }; - output: ConfigurableExtensionDataRef; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - factory: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - }; -}>; - export { ApiFactory }; export { ApiHolder }; @@ -239,51 +234,9 @@ export interface AppNodeSpec { // (undocumented) readonly id: string; // (undocumented) - readonly source?: FrontendPlugin; + readonly source?: BackstagePlugin; } -// @public -export const AppRootElementBlueprint: ExtensionBlueprint<{ - kind: 'app-root-element'; - name: undefined; - params: { - element: JSX.Element | (() => JSX.Element); - }; - output: ConfigurableExtensionDataRef; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: never; -}>; - -// @public -export const AppRootWrapperBlueprint: ExtensionBlueprint<{ - kind: 'app-root-wrapper'; - name: undefined; - params: { - Component: ComponentType>; - }; - output: ConfigurableExtensionDataRef< - React_2.ComponentType<{ - children?: React_2.ReactNode; - }>, - 'app.root.wrapper', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - component: ConfigurableExtensionDataRef< - React_2.ComponentType<{ - children?: React_2.ReactNode; - }>, - 'app.root.wrapper', - {} - >; - }; -}>; - export { AppTheme }; export { AppThemeApi }; @@ -317,6 +270,21 @@ export { BackstageIdentityApi }; export { BackstageIdentityResponse }; +// @public (undocumented) +export interface BackstagePlugin< + Routes extends AnyRoutes = AnyRoutes, + ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, +> { + // (undocumented) + readonly $$type: '@backstage/BackstagePlugin'; + // (undocumented) + readonly externalRoutes: ExternalRoutes; + // (undocumented) + readonly id: string; + // (undocumented) + readonly routes: Routes; +} + export { BackstageUserIdentity }; export { bitbucketAuthApiRef }; @@ -350,19 +318,17 @@ export { configApiRef }; // @public (undocumented) export interface ConfigurableExtensionDataRef< - TData, TId extends string, + TData, TConfig extends { optional?: true; } = {}, > extends ExtensionDataRef { - // (undocumented) - (t: TData): ExtensionDataValue; // (undocumented) optional(): ConfigurableExtensionDataRef< - TData, TId, - TConfig & { + TData, + TData & { optional: true; } >; @@ -377,7 +343,7 @@ export const coreComponentRefs: { // @public (undocumented) export type CoreErrorBoundaryFallbackProps = { - plugin?: FrontendPlugin; + plugin?: BackstagePlugin; error: Error; resetError: () => void; }; @@ -385,14 +351,14 @@ export type CoreErrorBoundaryFallbackProps = { // @public (undocumented) export const coreExtensionData: { reactElement: ConfigurableExtensionDataRef< - JSX_2.Element, 'core.reactElement', + JSX_2.Element, {} >; - routePath: ConfigurableExtensionDataRef; + routePath: ConfigurableExtensionDataRef<'core.routing.path', string, {}>; routeRef: ConfigurableExtensionDataRef< - RouteRef, 'core.routing.ref', + RouteRef, {} >; }; @@ -405,56 +371,133 @@ export type CoreNotFoundErrorPageProps = { // @public (undocumented) export type CoreProgressProps = {}; +// @public (undocumented) +export function createApiExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>( + options: ( + | { + api: AnyApiRef; + factory: (options: { + config: TConfig; + inputs: Expand>; + }) => AnyApiFactory; + } + | { + factory: AnyApiFactory; + } + ) & { + configSchema?: PortableSchema; + inputs?: TInputs; + }, +): ExtensionDefinition; + +// @public (undocumented) +export namespace createApiExtension { + const // (undocumented) + factoryDataRef: ConfigurableExtensionDataRef< + 'core.api.factory', + AnyApiFactory, + {} + >; +} + export { createApiFactory }; export { createApiRef }; +// @public +export function createAppRootElementExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + element: + | JSX_2.Element + | ((options: { + inputs: Expand>; + config: TConfig; + }) => JSX_2.Element); +}): ExtensionDefinition; + +// @public +export function createAppRootWrapperExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + Component: ComponentType< + PropsWithChildren<{ + inputs: Expand>; + config: TConfig; + }> + >; +}): ExtensionDefinition; + // @public (undocumented) -export function createComponentExtension(options: { +export namespace createAppRootWrapperExtension { + const // (undocumented) + componentDataRef: ConfigurableExtensionDataRef< + 'app.root.wrapper', + React_2.ComponentType<{ + children?: React_2.ReactNode; + }>, + {} + >; +} + +// @public (undocumented) +export function createComponentExtension< + TProps extends {}, + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { ref: ComponentRef; name?: string; disabled?: boolean; + inputs?: TInputs; + configSchema?: PortableSchema; loader: | { - lazy: () => Promise>; + lazy: (values: { + config: TConfig; + inputs: Expand>; + }) => Promise>; } | { - sync: () => ComponentType; + sync: (values: { + config: TConfig; + inputs: Expand>; + }) => ComponentType; }; -}): ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - { - ref: ComponentRef; - impl: ComponentType; - }, - 'core.component.component', - {} - >; - inputs: { - [x: string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }; - params: never; - kind: 'component'; - name: string; -}>; +}): ExtensionDefinition; // @public (undocumented) export namespace createComponentExtension { const // (undocumented) componentDataRef: ConfigurableExtensionDataRef< + 'core.component.component', { ref: ComponentRef; impl: ComponentType; }, - 'core.component.component', {} >; } @@ -466,189 +509,142 @@ export function createComponentRef(options: { // @public (undocumented) export function createExtension< - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, + TOutput extends AnyExtensionDataMap, + TInputs extends AnyExtensionInputMap, + TConfig, + TConfigInput, TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - const TKind extends string | undefined = undefined, - const TName extends string | undefined = undefined, >( options: CreateExtensionOptions< - TKind, - TName, - UOutput, + TOutput, TInputs, - TConfigSchema, - UFactoryOutput + TConfig, + TConfigInput, + TConfigSchema >, -): ExtensionDefinition<{ - config: string extends keyof TConfigSchema - ? {} - : { - [key in keyof TConfigSchema]: z.infer>; - }; - configInput: string extends keyof TConfigSchema - ? {} - : z.input< - z.ZodObject<{ - [key in keyof TConfigSchema]: ReturnType; - }> - >; - output: UOutput; - inputs: TInputs; - params: never; - kind: string | undefined extends TKind ? undefined : TKind; - name: string | undefined extends TName ? undefined : TName; -}>; +): ExtensionDefinition< + TConfig & + (string extends keyof TConfigSchema + ? {} + : { + [key in keyof TConfigSchema]: z.infer>; + }), + TConfigInput & + (string extends keyof TConfigSchema + ? {} + : z.input< + z.ZodObject<{ + [key in keyof TConfigSchema]: ReturnType; + }> + >) +>; // @public export function createExtensionBlueprint< - TParams extends object, - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, + TParams, + TInputs extends AnyExtensionInputMap, + TOutput extends AnyExtensionDataMap, TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - TKind extends string, - TName extends string | undefined = undefined, - TDataRefs extends { - [name in string]: AnyExtensionDataRef; - } = never, + TDataRefs extends AnyExtensionDataMap = never, >( options: CreateExtensionBlueprintOptions< - TKind, - TName, TParams, - UOutput, TInputs, + TOutput, TConfigSchema, - UFactoryOutput, TDataRefs >, -): ExtensionBlueprint<{ - kind: TKind; - name: TName; - params: TParams; - output: UOutput; - inputs: string extends keyof TInputs ? {} : TInputs; - config: string extends keyof TConfigSchema +): ExtensionBlueprint< + TParams, + TInputs, + TOutput, + string extends keyof TConfigSchema ? {} : { [key in keyof TConfigSchema]: z.infer>; - }; - configInput: string extends keyof TConfigSchema + }, + string extends keyof TConfigSchema ? {} : z.input< z.ZodObject<{ [key in keyof TConfigSchema]: ReturnType; }> - >; - dataRefs: TDataRefs; -}>; + >, + TDataRefs +>; // @public (undocumented) -export type CreateExtensionBlueprintOptions< - TKind extends string, - TName extends string | undefined, +export interface CreateExtensionBlueprintOptions< TParams, - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, + TInputs extends AnyExtensionInputMap, + TOutput extends AnyExtensionDataMap, TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - TDataRefs extends { - [name in string]: AnyExtensionDataRef; - }, -> = { - kind: TKind; + TDataRefs extends AnyExtensionDataMap, +> { + // (undocumented) attachTo: { id: string; input: string; }; - disabled?: boolean; - inputs?: TInputs; - output: Array; - name?: TName; + // (undocumented) config?: { schema: TConfigSchema; }; + // (undocumented) + dataRefs?: TDataRefs; + // (undocumented) + disabled?: boolean; + // (undocumented) factory( params: TParams, context: { node: AppNode; - apis: ApiHolder; config: { [key in keyof TConfigSchema]: z.infer>; }; inputs: Expand>; }, - ): Iterable; - dataRefs?: TDataRefs; -} & VerifyExtensionFactoryOutput; + ): Expand>; + // (undocumented) + inputs?: TInputs; + // (undocumented) + kind: string; + // (undocumented) + namespace?: string; + // (undocumented) + output: TOutput; +} // @public @deprecated (undocumented) export function createExtensionDataRef( id: string, -): ConfigurableExtensionDataRef; +): ConfigurableExtensionDataRef; // @public (undocumented) export function createExtensionDataRef(): { with(options: { id: TId; - }): ConfigurableExtensionDataRef; + }): ConfigurableExtensionDataRef; }; // @public (undocumented) export function createExtensionInput< - UExtensionData extends ExtensionDataRef< - unknown, - string, - { - optional?: true; - } - >, + TExtensionData extends AnyExtensionDataMap, TConfig extends { singleton?: boolean; optional?: boolean; }, >( - extensionData: Array, - config?: TConfig & { - replaces?: Array<{ - id: string; - input: string; - }>; - }, + extensionData: TExtensionData, + config?: TConfig, ): ExtensionInput< - UExtensionData, + TExtensionData, { singleton: TConfig['singleton'] extends true ? true : false; optional: TConfig['optional'] extends true ? true : false; @@ -656,45 +652,57 @@ export function createExtensionInput< >; // @public (undocumented) -export type CreateExtensionOptions< - TKind extends string | undefined, - TName extends string | undefined, - UOutput extends AnyExtensionDataRef, - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, +export interface CreateExtensionOptions< + TOutput extends AnyExtensionDataMap, + TInputs extends AnyExtensionInputMap, + TConfig, + TConfigInput, TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, -> = { - kind?: TKind; - name?: TName; +> { + // (undocumented) attachTo: { id: string; input: string; }; - disabled?: boolean; - inputs?: TInputs; - output: Array; + // (undocumented) config?: { schema: TConfigSchema; }; + // @deprecated (undocumented) + configSchema?: PortableSchema; + // (undocumented) + disabled?: boolean; + // (undocumented) factory(context: { node: AppNode; - apis: ApiHolder; - config: { - [key in keyof TConfigSchema]: z.infer>; - }; + config: TConfig & + (string extends keyof TConfigSchema + ? {} + : { + [key in keyof TConfigSchema]: z.infer< + ReturnType + >; + }); inputs: Expand>; - }): Iterable; -} & VerifyExtensionFactoryOutput; + }): Expand>; + // (undocumented) + inputs?: TInputs; + // (undocumented) + kind?: string; + // (undocumented) + name?: string; + // (undocumented) + namespace?: string; + // (undocumented) + output: TOutput; +} + +// @public (undocumented) +export function createExtensionOverrides( + options: ExtensionOverridesOptions, +): ExtensionOverrides; // @public export function createExternalRouteRef< @@ -703,11 +711,13 @@ export function createExternalRouteRef< [param in TParamKeys]: string; } | undefined = undefined, + TOptional extends boolean = false, TParamKeys extends string = string, >(options?: { readonly params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]; + optional?: TOptional; defaultTarget?: string; }): ExternalRouteRef< keyof TParams extends never @@ -716,47 +726,100 @@ export function createExternalRouteRef< ? TParams : { [param in TParamKeys]: string; - } + }, + TOptional >; -// @public (undocumented) -export function createFrontendModule< - TId extends string, - TExtensions extends readonly ExtensionDefinition[] = [], ->(options: CreateFrontendModuleOptions): FrontendModule; - -// @public (undocumented) -export interface CreateFrontendModuleOptions< - TPluginId extends string, - TExtensions extends readonly ExtensionDefinition[], -> { - // (undocumented) - extensions?: TExtensions; - // (undocumented) - featureFlags?: FeatureFlagConfig[]; - // (undocumented) - pluginId: TPluginId; -} - -// @public (undocumented) -export function createFrontendPlugin< - TId extends string, - TRoutes extends AnyRoutes = {}, - TExternalRoutes extends AnyExternalRoutes = {}, - TExtensions extends readonly ExtensionDefinition[] = [], ->( - options: PluginOptions, -): FrontendPlugin< - TRoutes, - TExternalRoutes, +// @public +export function createNavItemExtension(options: { + namespace?: string; + name?: string; + routeRef: RouteRef; + title: string; + icon: IconComponent_2; +}): ExtensionDefinition< { - [KExtension in TExtensions[number] as ResolveExtensionId< - KExtension, - TId - >]: KExtension; + title: string; + }, + { + title?: string | undefined; } >; +// @public (undocumented) +export namespace createNavItemExtension { + const // (undocumented) + targetDataRef: ConfigurableExtensionDataRef< + 'core.nav-item.target', + { + title: string; + icon: IconComponent_2; + routeRef: RouteRef; + }, + {} + >; +} + +// @public +export function createNavLogoExtension(options: { + name?: string; + namespace?: string; + logoIcon: JSX.Element; + logoFull: JSX.Element; +}): ExtensionDefinition<{}, {}>; + +// @public (undocumented) +export namespace createNavLogoExtension { + const // (undocumented) + logoElementsDataRef: ConfigurableExtensionDataRef< + 'core.nav-logo.logo-elements', + { + logoIcon?: JSX.Element | undefined; + logoFull?: JSX.Element | undefined; + }, + {} + >; +} + +// @public +export function createPageExtension< + TConfig extends { + path: string; + }, + TInputs extends AnyExtensionInputMap, +>( + options: ( + | { + defaultPath: string; + } + | { + configSchema: PortableSchema; + } + ) & { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + disabled?: boolean; + inputs?: TInputs; + routeRef?: RouteRef; + loader: (options: { + config: TConfig; + inputs: Expand>; + }) => Promise; + }, +): ExtensionDefinition; + +// @public (undocumented) +export function createPlugin< + Routes extends AnyRoutes = {}, + ExternalRoutes extends AnyExternalRoutes = {}, +>( + options: PluginOptions, +): BackstagePlugin; + // @public export function createRouteRef< TParams extends @@ -777,6 +840,75 @@ export function createRouteRef< } >; +// @public +export function createRouterExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + Component: ComponentType< + PropsWithChildren<{ + inputs: Expand>; + config: TConfig; + }> + >; +}): ExtensionDefinition; + +// @public (undocumented) +export namespace createRouterExtension { + const // (undocumented) + componentDataRef: ConfigurableExtensionDataRef< + 'app.router.wrapper', + React_2.ComponentType<{ + children?: React_2.ReactNode; + }>, + {} + >; +} + +// @public @deprecated (undocumented) +export function createSchemaFromZod( + schemaCreator: (zImpl: typeof z) => ZodSchema, +): PortableSchema; + +// @public (undocumented) +export function createSignInPageExtension< + TConfig extends {}, + TInputs extends AnyExtensionInputMap, +>(options: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; + }; + configSchema?: PortableSchema; + disabled?: boolean; + inputs?: TInputs; + loader: (options: { + config: TConfig; + inputs: Expand>; + }) => Promise>; +}): ExtensionDefinition; + +// @public (undocumented) +export namespace createSignInPageExtension { + const // (undocumented) + componentDataRef: ConfigurableExtensionDataRef< + 'core.sign-in-page.component', + React_2.ComponentType, + {} + >; +} + // @public export function createSubRouteRef< Path extends string, @@ -786,6 +918,44 @@ export function createSubRouteRef< parent: RouteRef; }): MakeSubRouteRef, ParentParams>; +// @public (undocumented) +export function createThemeExtension( + theme: AppTheme, +): ExtensionDefinition<{}, {}>; + +// @public (undocumented) +export namespace createThemeExtension { + const // (undocumented) + themeDataRef: ConfigurableExtensionDataRef< + 'core.theme.theme', + AppTheme, + {} + >; +} + +// @public (undocumented) +export function createTranslationExtension(options: { + name?: string; + resource: TranslationResource | TranslationMessages; +}): ExtensionDefinition<{}, {}>; + +// @public (undocumented) +export namespace createTranslationExtension { + const // (undocumented) + translationDataRef: ConfigurableExtensionDataRef< + 'core.translation.translation', + | TranslationResource + | TranslationMessages< + string, + { + [x: string]: string; + }, + boolean + >, + {} + >; +} + export { createTranslationMessages }; export { createTranslationRef }; @@ -823,154 +993,87 @@ export interface Extension { // @public (undocumented) export interface ExtensionBlueprint< - T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters, + TParams, + TInputs extends AnyExtensionInputMap, + TOutput extends AnyExtensionDataMap, + TConfig extends { + [key in string]: unknown; + }, + TConfigInput extends { + [key in string]: unknown; + }, + TDataRefs extends AnyExtensionDataMap, > { // (undocumented) - dataRefs: T['dataRefs']; - // (undocumented) - make(args: { - name?: TNewName; - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - params: T['params']; - }): ExtensionDefinition<{ - kind: T['kind']; - name: string | undefined extends TNewName ? T['name'] : TNewName; - config: T['config']; - configInput: T['configInput']; - output: T['output']; - inputs: T['inputs']; - params: T['params']; - }>; - makeWithOverrides< - TNewName extends string | undefined, + dataRefs: TDataRefs; + make< TExtensionConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - UFactoryOutput extends ExtensionDataValue, - UNewOutput extends AnyExtensionDataRef, - TExtraInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, - >(args: { - name?: TNewName; - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - inputs?: TExtraInputs & { - [KName in keyof T['inputs']]?: `Error: Input '${KName & - string}' is already defined in parent definition`; - }; - output?: Array; - config?: { - schema: TExtensionConfigSchema & { - [KName in keyof T['config']]?: `Error: Config key '${KName & - string}' is already defined in parent schema`; + >( + args: { + namespace?: string; + name?: string; + attachTo?: { + id: string; + input: string; }; - }; - factory( - originalFactory: ( - params: T['params'], - context?: { - config?: T['config']; - inputs?: ResolveInputValueOverrides>; - }, - ) => ExtensionDataContainer>, - context: { - node: AppNode; - apis: ApiHolder; - config: T['config'] & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; + disabled?: boolean; + inputs?: TInputs; + output?: TOutput; + config?: { + schema: TExtensionConfigSchema & { + [KName in keyof TConfig]?: `Error: Config key '${KName & + string}' is already defined in parent schema`; }; - inputs: Expand>; - }, - ): Iterable & - VerifyExtensionFactoryOutput< - AnyExtensionDataRef extends UNewOutput - ? NonNullable - : UNewOutput, - UFactoryOutput + }; + } & ( + | { + factory( + originalFactory: ( + params: TParams, + context?: { + config?: TConfig; + inputs?: Expand>; + }, + ) => Expand>, + context: { + node: AppNode; + config: TConfig & { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType + >; + }; + inputs: Expand>; + }, + ): Expand>; + } + | { + params: TParams; + } + ), + ): ExtensionDefinition< + { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType >; - }): ExtensionDefinition<{ - config: (string extends keyof TExtensionConfigSchema - ? {} - : { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }) & - T['config']; - configInput: (string extends keyof TExtensionConfigSchema - ? {} - : z.input< - z.ZodObject<{ - [key in keyof TExtensionConfigSchema]: ReturnType< - TExtensionConfigSchema[key] - >; - }> - >) & - T['configInput']; - output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput; - inputs: T['inputs'] & TExtraInputs; - kind: T['kind']; - name: string | undefined extends TNewName ? T['name'] : TNewName; - params: T['params']; - }>; + } & TConfig, + z.input< + z.ZodObject<{ + [key in keyof TExtensionConfigSchema]: ReturnType< + TExtensionConfigSchema[key] + >; + }> + > & + TConfigInput + >; } -// @public (undocumented) -export type ExtensionBlueprintParameters = { - kind: string; - name?: string; - params?: object; - configInput?: { - [K in string]: any; - }; - config?: { - [K in string]: any; - }; - output?: AnyExtensionDataRef; - inputs?: { - [KName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }; - dataRefs?: { - [name in string]: AnyExtensionDataRef; - }; -}; - // @public (undocumented) export function ExtensionBoundary( props: ExtensionBoundaryProps, ): React_2.JSX.Element; -// @public (undocumented) -export namespace ExtensionBoundary { - // (undocumented) - export function lazy( - appNode: AppNode, - lazyElement: () => Promise, - ): JSX.Element; -} - // @public (undocumented) export interface ExtensionBoundaryProps { // (undocumented) @@ -980,28 +1083,6 @@ export interface ExtensionBoundaryProps { routable?: boolean; } -// @public (undocumented) -export type ExtensionDataContainer = - Iterable< - UExtensionData extends ExtensionDataRef< - infer IData, - infer IId, - infer IConfig - > - ? IConfig['optional'] extends true - ? never - : ExtensionDataValue - : never - > & { - get( - ref: ExtensionDataRef, - ): UExtensionData extends ExtensionDataRef - ? IConfig['optional'] extends true - ? IData | undefined - : IData - : never; - }; - // @public (undocumented) export type ExtensionDataRef< TData, @@ -1010,154 +1091,51 @@ export type ExtensionDataRef< optional?: true; } = {}, > = { - readonly $$type: '@backstage/ExtensionDataRef'; - readonly id: TId; - readonly T: TData; - readonly config: TConfig; + id: TId; + T: TData; + config: TConfig; + $$type: '@backstage/ExtensionDataRef'; +}; + +// @public +export type ExtensionDataValues = { + [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends { + optional: true; + } + ? never + : DataName]: TExtensionData[DataName]['T']; +} & { + [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends { + optional: true; + } + ? DataName + : never]?: TExtensionData[DataName]['T']; }; // @public (undocumented) -export type ExtensionDataRefToValue = - TDataRef extends ExtensionDataRef - ? ExtensionDataValue - : never; - -// @public (undocumented) -export type ExtensionDataValue = { - readonly $$type: '@backstage/ExtensionDataValue'; - readonly id: TId; - readonly value: TData; -}; - -// @public (undocumented) -export type ExtensionDefinition< - T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters, -> = { +export interface ExtensionDefinition { + // (undocumented) $$type: '@backstage/ExtensionDefinition'; - readonly T: T; - override< - TExtensionConfigSchema extends { - [key in string]: (zImpl: typeof z) => z.ZodType; - }, - UFactoryOutput extends ExtensionDataValue, - UNewOutput extends AnyExtensionDataRef, - TExtraInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, - >( - args: Expand< - { - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - inputs?: TExtraInputs & { - [KName in keyof T['inputs']]?: `Error: Input '${KName & - string}' is already defined in parent definition`; - }; - output?: Array; - config?: { - schema: TExtensionConfigSchema & { - [KName in keyof T['config']]?: `Error: Config key '${KName & - string}' is already defined in parent schema`; - }; - }; - factory?( - originalFactory: ( - context?: Expand< - { - config?: T['config']; - inputs?: ResolveInputValueOverrides>; - } & ([T['params']] extends [never] - ? {} - : { - params?: Partial; - }) - >, - ) => ExtensionDataContainer>, - context: { - node: AppNode; - apis: ApiHolder; - config: T['config'] & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }; - inputs: Expand>; - }, - ): Iterable; - } & ([T['params']] extends [never] - ? {} - : { - params?: Partial; - }) - > & - VerifyExtensionFactoryOutput< - AnyExtensionDataRef extends UNewOutput - ? NonNullable - : UNewOutput, - UFactoryOutput - >, - ): ExtensionDefinition<{ - kind: T['kind']; - name: T['name']; - output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput; - inputs: T['inputs'] & TExtraInputs; - config: T['config'] & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }; - configInput: T['configInput'] & - z.input< - z.ZodObject<{ - [key in keyof TExtensionConfigSchema]: ReturnType< - TExtensionConfigSchema[key] - >; - }> - >; - }>; -}; - -// @public (undocumented) -export type ExtensionDefinitionParameters = { - kind?: string; - name?: string; - configInput?: { - [K in string]: any; + // (undocumented) + readonly attachTo: { + id: string; + input: string; }; - config?: { - [K in string]: any; - }; - output?: AnyExtensionDataRef; - inputs?: { - [KName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }; - params?: object; -}; + // (undocumented) + readonly configSchema?: PortableSchema; + // (undocumented) + readonly disabled: boolean; + // (undocumented) + readonly kind?: string; + // (undocumented) + readonly name?: string; + // (undocumented) + readonly namespace?: string; +} // @public (undocumented) export interface ExtensionInput< - UExtensionData extends ExtensionDataRef< - unknown, - string, - { - optional?: true; - } - >, + TExtensionData extends AnyExtensionDataMap, TConfig extends { singleton: boolean; optional: boolean; @@ -1168,12 +1146,7 @@ export interface ExtensionInput< // (undocumented) config: TConfig; // (undocumented) - extensionData: Array; - // (undocumented) - replaces?: Array<{ - id: string; - input: string; - }>; + extensionData: TExtensionData; } // @public (undocumented) @@ -1182,13 +1155,24 @@ export interface ExtensionOverrides { readonly $$type: '@backstage/ExtensionOverrides'; } +// @public (undocumented) +export interface ExtensionOverridesOptions { + // (undocumented) + extensions: ExtensionDefinition[]; + // (undocumented) + featureFlags?: FeatureFlagConfig[]; +} + // @public export interface ExternalRouteRef< TParams extends AnyRouteRefParams = AnyRouteRefParams, + TOptional extends boolean = boolean, > { // (undocumented) readonly $$type: '@backstage/ExternalRouteRef'; // (undocumented) + readonly optional: TOptional; + // (undocumented) readonly T: TParams; } @@ -1211,42 +1195,8 @@ export { FetchApi }; export { fetchApiRef }; -// @public @deprecated (undocumented) -export type FrontendFeature = FrontendPlugin | ExtensionOverrides; - // @public (undocumented) -export interface FrontendModule { - // (undocumented) - readonly $$type: '@backstage/FrontendModule'; - // (undocumented) - readonly pluginId: string; -} - -// @public (undocumented) -export interface FrontendPlugin< - TRoutes extends AnyRoutes = AnyRoutes, - TExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, - TExtensionMap extends { - [id in string]: ExtensionDefinition; - } = { - [id in string]: ExtensionDefinition; - }, -> { - // (undocumented) - readonly $$type: '@backstage/FrontendPlugin'; - // (undocumented) - readonly externalRoutes: TExternalRoutes; - // (undocumented) - getExtension(id: TId): TExtensionMap[TId]; - // (undocumented) - readonly id: string; - // (undocumented) - readonly routes: TRoutes; - // (undocumented) - withOverrides(options: { - extensions: Array; - }): FrontendPlugin; -} +export type FrontendFeature = BackstagePlugin | ExtensionOverrides; export { githubAuthApiRef }; @@ -1255,34 +1205,40 @@ export { gitlabAuthApiRef }; export { googleAuthApiRef }; // @public (undocumented) -export const IconBundleBlueprint: ExtensionBlueprint<{ - kind: 'icon-bundle'; - name: undefined; - params: { +export const IconBundleBlueprint: ExtensionBlueprint< + { icons: { [x: string]: IconComponent; }; - }; - output: ConfigurableExtensionDataRef< - { - [x: string]: IconComponent; - }, - 'core.icons', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { + }, + AnyExtensionInputMap, + { icons: ConfigurableExtensionDataRef< + 'core.icons', { [x: string]: IconComponent; }, - 'core.icons', {} >; - }; -}>; + }, + { + icons: string; + test: string; + }, + { + test: string; + icons?: string | undefined; + }, + { + icons: ConfigurableExtensionDataRef< + 'core.icons', + { + [x: string]: IconComponent; + }, + {} + >; + } +>; // @public export type IconComponent = ComponentType< @@ -1311,71 +1267,6 @@ export { identityApiRef }; export { microsoftAuthApiRef }; -// @public -export const NavItemBlueprint: ExtensionBlueprint<{ - kind: 'nav-item'; - name: undefined; - params: { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }; - output: ConfigurableExtensionDataRef< - { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }, - 'core.nav-item.target', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - target: ConfigurableExtensionDataRef< - { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }, - 'core.nav-item.target', - {} - >; - }; -}>; - -// @public -export const NavLogoBlueprint: ExtensionBlueprint<{ - kind: 'nav-logo'; - name: undefined; - params: { - logoIcon: JSX.Element; - logoFull: JSX.Element; - }; - output: ConfigurableExtensionDataRef< - { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; - }, - 'core.nav-logo.logo-elements', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - logoElements: ConfigurableExtensionDataRef< - { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; - }, - 'core.nav-logo.logo-elements', - {} - >; - }; -}>; - export { OAuthApi }; export { OAuthRequestApi }; @@ -1394,54 +1285,23 @@ export { oneloginAuthApiRef }; export { OpenIdConnectApi }; -// @public -export const PageBlueprint: ExtensionBlueprint<{ - kind: 'page'; - name: undefined; - params: { - defaultPath: string; - loader: () => Promise; - routeRef?: RouteRef | undefined; - }; - output: - | ConfigurableExtensionDataRef - | ConfigurableExtensionDataRef - | ConfigurableExtensionDataRef< - RouteRef, - 'core.routing.ref', - { - optional: true; - } - >; - inputs: {}; - config: { - path: string | undefined; - }; - configInput: { - path?: string | undefined; - }; - dataRefs: never; -}>; - export { PendingOAuthRequest }; // @public (undocumented) export interface PluginOptions< - TId extends string, - TRoutes extends AnyRoutes, - TExternalRoutes extends AnyExternalRoutes, - TExtensions extends readonly ExtensionDefinition[], + Routes extends AnyRoutes, + ExternalRoutes extends AnyExternalRoutes, > { // (undocumented) - extensions?: TExtensions; + extensions?: ExtensionDefinition[]; // (undocumented) - externalRoutes?: TExternalRoutes; + externalRoutes?: ExternalRoutes; // (undocumented) featureFlags?: FeatureFlagConfig[]; // (undocumented) - id: TId; + id: string; // (undocumented) - routes?: TRoutes; + routes?: Routes; } // @public (undocumented) @@ -1455,13 +1315,11 @@ export { ProfileInfo }; export { ProfileInfoApi }; // @public -export type ResolvedExtensionInput< - TExtensionInput extends ExtensionInput, -> = TExtensionInput['extensionData'] extends Array - ? { - node: AppNode; - } & ExtensionDataContainer - : never; +export type ResolvedExtensionInput = + { + node: AppNode; + output: ExtensionDataValues; + }; // @public export type ResolvedExtensionInputs< @@ -1470,79 +1328,14 @@ export type ResolvedExtensionInputs< }, > = { [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton'] - ? Array>> + ? Array>> : false extends TInputs[InputName]['config']['optional'] - ? Expand> - : Expand | undefined>; + ? Expand> + : Expand< + ResolvedExtensionInput | undefined + >; }; -// @public (undocumented) -export type ResolveInputValueOverrides< - TInputs extends { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - } = { - [inputName in string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, -> = Expand< - { - [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< - any, - { - optional: infer IOptional extends boolean; - singleton: boolean; - } - > - ? IOptional extends true - ? never - : KName - : never]: TInputs[KName] extends ExtensionInput< - infer IDataRefs, - { - optional: boolean; - singleton: infer ISingleton extends boolean; - } - > - ? ISingleton extends true - ? Iterable> - : Array>> - : never; - } & { - [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< - any, - { - optional: infer IOptional extends boolean; - singleton: boolean; - } - > - ? IOptional extends true - ? KName - : never - : never]?: TInputs[KName] extends ExtensionInput< - infer IDataRefs, - { - optional: boolean; - singleton: infer ISingleton extends boolean; - } - > - ? ISingleton extends true - ? Iterable> - : Array>> - : never; - } ->; - // @public export type RouteFunc = ( ...[params]: TParams extends undefined @@ -1550,34 +1343,6 @@ export type RouteFunc = ( : readonly [params: TParams] ) => string; -// @public (undocumented) -export const RouterBlueprint: ExtensionBlueprint<{ - kind: 'app-router-component'; - name: undefined; - params: { - Component: ComponentType>; - }; - output: ConfigurableExtensionDataRef< - ComponentType<{ - children?: ReactNode; - }>, - 'app.router.wrapper', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - component: ConfigurableExtensionDataRef< - ComponentType<{ - children?: ReactNode; - }>, - 'app.router.wrapper', - {} - >; - }; -}>; - // @public export interface RouteRef< TParams extends AnyRouteRefParams = AnyRouteRefParams, @@ -1595,7 +1360,7 @@ export interface RouteResolutionApi { anyRouteRef: | RouteRef | SubRouteRef - | ExternalRouteRef, + | ExternalRouteRef, options?: RouteResolutionApiResolveOptions, ): RouteFunc | undefined; } @@ -1612,30 +1377,6 @@ export { SessionApi }; export { SessionState }; -// @public -export const SignInPageBlueprint: ExtensionBlueprint<{ - kind: 'sign-in-page'; - name: undefined; - params: { - loader: () => Promise>; - }; - output: ConfigurableExtensionDataRef< - React_2.ComponentType, - 'core.sign-in-page.component', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - component: ConfigurableExtensionDataRef< - React_2.ComponentType, - 'core.sign-in-page.component', - {} - >; - }; -}>; - export { StorageApi }; export { storageApiRef }; @@ -1654,60 +1395,6 @@ export interface SubRouteRef< readonly T: TParams; } -// @public -export const ThemeBlueprint: ExtensionBlueprint<{ - kind: 'theme'; - name: undefined; - params: { - theme: AppTheme; - }; - output: ConfigurableExtensionDataRef; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - theme: ConfigurableExtensionDataRef; - }; -}>; - -// @public -export const TranslationBlueprint: ExtensionBlueprint<{ - kind: 'translation'; - name: undefined; - params: { - resource: TranslationResource | TranslationMessages; - }; - output: ConfigurableExtensionDataRef< - | TranslationResource - | TranslationMessages< - string, - { - [x: string]: string; - }, - boolean - >, - 'core.translation.translation', - {} - >; - inputs: {}; - config: {}; - configInput: {}; - dataRefs: { - translation: ConfigurableExtensionDataRef< - | TranslationResource - | TranslationMessages< - string, - { - [x: string]: string; - }, - boolean - >, - 'core.translation.translation', - {} - >; - }; -}>; - export { TranslationMessages }; export { TranslationMessagesOptions }; @@ -1734,13 +1421,18 @@ export function useComponentRef( ref: ComponentRef, ): ComponentType; +// @public +export function useRouteRef< + TOptional extends boolean, + TParams extends AnyRouteRefParams, +>( + routeRef: ExternalRouteRef, +): TOptional extends true ? RouteFunc | undefined : RouteFunc; + // @public export function useRouteRef( - routeRef: - | RouteRef - | SubRouteRef - | ExternalRouteRef, -): RouteFunc | undefined; + routeRef: RouteRef | SubRouteRef, +): RouteFunc; // @public export function useRouteRefParams( @@ -1771,12 +1463,12 @@ export { withApis }; // src/apis/definitions/RouteResolutionApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "resolve". // src/components/ExtensionBoundary.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionBoundaryProps". // src/components/ExtensionBoundary.d.ts:5:5 - (ae-undocumented) Missing documentation for "node". -// src/components/ExtensionBoundary.d.ts:6:5 - (ae-undocumented) Missing documentation for "routable". -// src/components/ExtensionBoundary.d.ts:7:5 - (ae-undocumented) Missing documentation for "children". -// src/components/ExtensionBoundary.d.ts:10:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". +// src/components/ExtensionBoundary.d.ts:12:5 - (ae-undocumented) Missing documentation for "children". +// src/components/ExtensionBoundary.d.ts:15:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". // src/components/coreComponentRefs.d.ts:3:22 - (ae-undocumented) Missing documentation for "coreComponentRefs". // src/components/createComponentRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ComponentRef". // src/components/createComponentRef.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentRef". +// src/extensions/IconBundleBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "IconBundleBlueprint". // src/extensions/createApiExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createApiExtension". // src/extensions/createApiExtension.d.ts:20:1 - (ae-undocumented) Missing documentation for "createApiExtension". // src/extensions/createApiExtension.d.ts:21:11 - (ae-undocumented) Missing documentation for "factoryDataRef". @@ -1785,8 +1477,8 @@ export { withApis }; // src/extensions/createComponentExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentExtension". // src/extensions/createComponentExtension.d.ts:26:1 - (ae-undocumented) Missing documentation for "createComponentExtension". // src/extensions/createComponentExtension.d.ts:27:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/extensions/createNavItemExtension.d.ts:17:1 - (ae-undocumented) Missing documentation for "createNavItemExtension". -// src/extensions/createNavItemExtension.d.ts:18:11 - (ae-undocumented) Missing documentation for "targetDataRef". +// src/extensions/createNavItemExtension.d.ts:19:1 - (ae-undocumented) Missing documentation for "createNavItemExtension". +// src/extensions/createNavItemExtension.d.ts:20:11 - (ae-undocumented) Missing documentation for "targetDataRef". // src/extensions/createNavLogoExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "createNavLogoExtension". // src/extensions/createNavLogoExtension.d.ts:14:11 - (ae-undocumented) Missing documentation for "logoElementsDataRef". // src/extensions/createRouterExtension.d.ts:28:1 - (ae-undocumented) Missing documentation for "createRouterExtension". @@ -1808,37 +1500,51 @@ export { withApis }; // src/routing/SubRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "$$type". // src/routing/SubRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "T". // src/routing/SubRouteRef.d.ts:15:5 - (ae-undocumented) Missing documentation for "path". -// src/schema/createSchemaFromZod.d.ts:4:1 - (ae-undocumented) Missing documentation for "createSchemaFromZod". +// src/schema/createSchemaFromZod.d.ts:7:1 - (ae-undocumented) Missing documentation for "createSchemaFromZod". // src/schema/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PortableSchema". // src/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "CoreProgressProps". // src/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "CoreNotFoundErrorPageProps". // src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CoreErrorBoundaryFallbackProps". // src/wiring/coreExtensionData.d.ts:4:22 - (ae-undocumented) Missing documentation for "coreExtensionData". -// src/wiring/createExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataMap". -// src/wiring/createExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "AnyExtensionInputMap". -// src/wiring/createExtension.d.ts:50:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". -// src/wiring/createExtension.d.ts:51:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtension.d.ts:52:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtension.d.ts:53:5 - (ae-undocumented) Missing documentation for "name". -// src/wiring/createExtension.d.ts:54:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtension.d.ts:58:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtension.d.ts:59:5 - (ae-undocumented) Missing documentation for "inputs". -// src/wiring/createExtension.d.ts:60:5 - (ae-undocumented) Missing documentation for "output". -// src/wiring/createExtension.d.ts:61:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/createExtension.d.ts:62:5 - (ae-undocumented) Missing documentation for "factory". -// src/wiring/createExtension.d.ts:69:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". -// src/wiring/createExtension.d.ts:70:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createExtension.d.ts:71:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtension.d.ts:72:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtension.d.ts:73:5 - (ae-undocumented) Missing documentation for "name". -// src/wiring/createExtension.d.ts:74:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtension.d.ts:78:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtension.d.ts:79:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/createExtension.d.ts:82:1 - (ae-undocumented) Missing documentation for "createExtension". +// src/wiring/createExtension.d.ts:8:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataMap". +// src/wiring/createExtension.d.ts:14:1 - (ae-undocumented) Missing documentation for "AnyExtensionInputMap". +// src/wiring/createExtension.d.ts:51:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". +// src/wiring/createExtension.d.ts:54:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtension.d.ts:55:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtension.d.ts:56:5 - (ae-undocumented) Missing documentation for "name". +// src/wiring/createExtension.d.ts:57:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtension.d.ts:61:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtension.d.ts:62:5 - (ae-undocumented) Missing documentation for "inputs". +// src/wiring/createExtension.d.ts:63:5 - (ae-undocumented) Missing documentation for "output". +// src/wiring/createExtension.d.ts:65:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/createExtension.d.ts:66:5 - (ae-undocumented) Missing documentation for "config". +// src/wiring/createExtension.d.ts:69:5 - (ae-undocumented) Missing documentation for "factory". +// src/wiring/createExtension.d.ts:78:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". +// src/wiring/createExtension.d.ts:79:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createExtension.d.ts:80:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtension.d.ts:81:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtension.d.ts:82:5 - (ae-undocumented) Missing documentation for "name". +// src/wiring/createExtension.d.ts:83:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtension.d.ts:87:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtension.d.ts:88:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/createExtension.d.ts:91:1 - (ae-undocumented) Missing documentation for "createExtension". +// src/wiring/createExtensionBlueprint.d.ts:8:1 - (ae-undocumented) Missing documentation for "CreateExtensionBlueprintOptions". +// src/wiring/createExtensionBlueprint.d.ts:11:5 - (ae-undocumented) Missing documentation for "kind". +// src/wiring/createExtensionBlueprint.d.ts:12:5 - (ae-undocumented) Missing documentation for "namespace". +// src/wiring/createExtensionBlueprint.d.ts:13:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/createExtensionBlueprint.d.ts:17:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/createExtensionBlueprint.d.ts:18:5 - (ae-undocumented) Missing documentation for "inputs". +// src/wiring/createExtensionBlueprint.d.ts:19:5 - (ae-undocumented) Missing documentation for "output". +// src/wiring/createExtensionBlueprint.d.ts:20:5 - (ae-undocumented) Missing documentation for "config". +// src/wiring/createExtensionBlueprint.d.ts:23:5 - (ae-undocumented) Missing documentation for "factory". +// src/wiring/createExtensionBlueprint.d.ts:30:5 - (ae-undocumented) Missing documentation for "dataRefs". +// src/wiring/createExtensionBlueprint.d.ts:35:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprint". +// src/wiring/createExtensionBlueprint.d.ts:40:5 - (ae-undocumented) Missing documentation for "dataRefs". // src/wiring/createExtensionDataRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ExtensionDataRef". // src/wiring/createExtensionDataRef.d.ts:11:1 - (ae-undocumented) Missing documentation for "ConfigurableExtensionDataRef". // src/wiring/createExtensionDataRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "optional". -// src/wiring/createExtensionDataRef.d.ts:19:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:22:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:24:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". // src/wiring/createExtensionInput.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionInput". // src/wiring/createExtensionInput.d.ts:7:5 - (ae-undocumented) Missing documentation for "$$type". // src/wiring/createExtensionInput.d.ts:8:5 - (ae-undocumented) Missing documentation for "extensionData". diff --git a/packages/frontend-test-utils/api-report.api.md b/packages/frontend-test-utils/report.api.md similarity index 100% rename from packages/frontend-test-utils/api-report.api.md rename to packages/frontend-test-utils/report.api.md diff --git a/packages/integration-aws-node/api-report.api.md b/packages/integration-aws-node/report.api.md similarity index 100% rename from packages/integration-aws-node/api-report.api.md rename to packages/integration-aws-node/report.api.md diff --git a/packages/integration-react/api-report.api.md b/packages/integration-react/report.api.md similarity index 100% rename from packages/integration-react/api-report.api.md rename to packages/integration-react/report.api.md diff --git a/packages/integration/api-report.api.md b/packages/integration/report.api.md similarity index 100% rename from packages/integration/api-report.api.md rename to packages/integration/report.api.md diff --git a/packages/release-manifests/api-report.api.md b/packages/release-manifests/report.api.md similarity index 100% rename from packages/release-manifests/api-report.api.md rename to packages/release-manifests/report.api.md diff --git a/packages/test-utils/api-report-alpha.api.md b/packages/test-utils/report-alpha.api.md similarity index 100% rename from packages/test-utils/api-report-alpha.api.md rename to packages/test-utils/report-alpha.api.md diff --git a/packages/test-utils/api-report.api.md b/packages/test-utils/report.api.md similarity index 100% rename from packages/test-utils/api-report.api.md rename to packages/test-utils/report.api.md diff --git a/packages/theme/api-report.api.md b/packages/theme/report.api.md similarity index 100% rename from packages/theme/api-report.api.md rename to packages/theme/report.api.md diff --git a/packages/types/api-report.api.md b/packages/types/report.api.md similarity index 100% rename from packages/types/api-report.api.md rename to packages/types/report.api.md diff --git a/packages/version-bridge/api-report.api.md b/packages/version-bridge/report.api.md similarity index 100% rename from packages/version-bridge/api-report.api.md rename to packages/version-bridge/report.api.md diff --git a/packages/yarn-plugin/api-report.api.md b/packages/yarn-plugin/report.api.md similarity index 100% rename from packages/yarn-plugin/api-report.api.md rename to packages/yarn-plugin/report.api.md diff --git a/plugins/api-docs-module-protoc-gen-doc/api-report.api.md b/plugins/api-docs-module-protoc-gen-doc/report.api.md similarity index 100% rename from plugins/api-docs-module-protoc-gen-doc/api-report.api.md rename to plugins/api-docs-module-protoc-gen-doc/report.api.md diff --git a/plugins/api-docs/api-report-alpha.api.md b/plugins/api-docs/report-alpha.api.md similarity index 100% rename from plugins/api-docs/api-report-alpha.api.md rename to plugins/api-docs/report-alpha.api.md diff --git a/plugins/api-docs/api-report.api.md b/plugins/api-docs/report.api.md similarity index 100% rename from plugins/api-docs/api-report.api.md rename to plugins/api-docs/report.api.md diff --git a/plugins/app-backend/api-report-alpha.api.md b/plugins/app-backend/report-alpha.api.md similarity index 100% rename from plugins/app-backend/api-report-alpha.api.md rename to plugins/app-backend/report-alpha.api.md diff --git a/plugins/app-backend/api-report.api.md b/plugins/app-backend/report.api.md similarity index 100% rename from plugins/app-backend/api-report.api.md rename to plugins/app-backend/report.api.md diff --git a/plugins/app-node/api-report.api.md b/plugins/app-node/report.api.md similarity index 100% rename from plugins/app-node/api-report.api.md rename to plugins/app-node/report.api.md diff --git a/plugins/app-visualizer/api-report.api.md b/plugins/app-visualizer/report.api.md similarity index 97% rename from plugins/app-visualizer/api-report.api.md rename to plugins/app-visualizer/report.api.md index 7466ff24f6..7495797a79 100644 --- a/plugins/app-visualizer/api-report.api.md +++ b/plugins/app-visualizer/report.api.md @@ -73,7 +73,7 @@ export default visualizerPlugin; // Warnings were encountered during analysis: // -// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-atlassian-provider/api-report.api.md b/plugins/auth-backend-module-atlassian-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-atlassian-provider/api-report.api.md rename to plugins/auth-backend-module-atlassian-provider/report.api.md diff --git a/plugins/auth-backend-module-aws-alb-provider/api-report.api.md b/plugins/auth-backend-module-aws-alb-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-aws-alb-provider/api-report.api.md rename to plugins/auth-backend-module-aws-alb-provider/report.api.md diff --git a/plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md b/plugins/auth-backend-module-azure-easyauth-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-azure-easyauth-provider/api-report.api.md rename to plugins/auth-backend-module-azure-easyauth-provider/report.api.md diff --git a/plugins/auth-backend-module-bitbucket-provider/api-report.api.md b/plugins/auth-backend-module-bitbucket-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-bitbucket-provider/api-report.api.md rename to plugins/auth-backend-module-bitbucket-provider/report.api.md diff --git a/plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md b/plugins/auth-backend-module-cloudflare-access-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-cloudflare-access-provider/api-report.api.md rename to plugins/auth-backend-module-cloudflare-access-provider/report.api.md diff --git a/plugins/auth-backend-module-gcp-iap-provider/api-report.api.md b/plugins/auth-backend-module-gcp-iap-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-gcp-iap-provider/api-report.api.md rename to plugins/auth-backend-module-gcp-iap-provider/report.api.md diff --git a/plugins/auth-backend-module-github-provider/api-report.api.md b/plugins/auth-backend-module-github-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-github-provider/api-report.api.md rename to plugins/auth-backend-module-github-provider/report.api.md diff --git a/plugins/auth-backend-module-gitlab-provider/api-report.api.md b/plugins/auth-backend-module-gitlab-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-gitlab-provider/api-report.api.md rename to plugins/auth-backend-module-gitlab-provider/report.api.md diff --git a/plugins/auth-backend-module-google-provider/api-report.api.md b/plugins/auth-backend-module-google-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-google-provider/api-report.api.md rename to plugins/auth-backend-module-google-provider/report.api.md diff --git a/plugins/auth-backend-module-guest-provider/api-report.api.md b/plugins/auth-backend-module-guest-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-guest-provider/api-report.api.md rename to plugins/auth-backend-module-guest-provider/report.api.md diff --git a/plugins/auth-backend-module-microsoft-provider/api-report.api.md b/plugins/auth-backend-module-microsoft-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-microsoft-provider/api-report.api.md rename to plugins/auth-backend-module-microsoft-provider/report.api.md diff --git a/plugins/auth-backend-module-oauth2-provider/api-report.api.md b/plugins/auth-backend-module-oauth2-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-oauth2-provider/api-report.api.md rename to plugins/auth-backend-module-oauth2-provider/report.api.md diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md b/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-oauth2-proxy-provider/api-report.api.md rename to plugins/auth-backend-module-oauth2-proxy-provider/report.api.md diff --git a/plugins/auth-backend-module-oidc-provider/api-report.api.md b/plugins/auth-backend-module-oidc-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-oidc-provider/api-report.api.md rename to plugins/auth-backend-module-oidc-provider/report.api.md diff --git a/plugins/auth-backend-module-okta-provider/api-report.api.md b/plugins/auth-backend-module-okta-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-okta-provider/api-report.api.md rename to plugins/auth-backend-module-okta-provider/report.api.md diff --git a/plugins/auth-backend-module-onelogin-provider/api-report.api.md b/plugins/auth-backend-module-onelogin-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-onelogin-provider/api-report.api.md rename to plugins/auth-backend-module-onelogin-provider/report.api.md diff --git a/plugins/auth-backend-module-pinniped-provider/api-report.api.md b/plugins/auth-backend-module-pinniped-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-pinniped-provider/api-report.api.md rename to plugins/auth-backend-module-pinniped-provider/report.api.md diff --git a/plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md b/plugins/auth-backend-module-vmware-cloud-provider/report.api.md similarity index 100% rename from plugins/auth-backend-module-vmware-cloud-provider/api-report.api.md rename to plugins/auth-backend-module-vmware-cloud-provider/report.api.md diff --git a/plugins/auth-backend/api-report.api.md b/plugins/auth-backend/report.api.md similarity index 100% rename from plugins/auth-backend/api-report.api.md rename to plugins/auth-backend/report.api.md diff --git a/plugins/auth-node/api-report.api.md b/plugins/auth-node/report.api.md similarity index 100% rename from plugins/auth-node/api-report.api.md rename to plugins/auth-node/report.api.md diff --git a/plugins/auth-react/api-report.api.md b/plugins/auth-react/report.api.md similarity index 100% rename from plugins/auth-react/api-report.api.md rename to plugins/auth-react/report.api.md diff --git a/plugins/bitbucket-cloud-common/api-report.api.md b/plugins/bitbucket-cloud-common/report.api.md similarity index 100% rename from plugins/bitbucket-cloud-common/api-report.api.md rename to plugins/bitbucket-cloud-common/report.api.md diff --git a/plugins/catalog-backend-module-aws/api-report-alpha.api.md b/plugins/catalog-backend-module-aws/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-aws/api-report-alpha.api.md rename to plugins/catalog-backend-module-aws/report-alpha.api.md diff --git a/plugins/catalog-backend-module-aws/api-report.api.md b/plugins/catalog-backend-module-aws/report.api.md similarity index 100% rename from plugins/catalog-backend-module-aws/api-report.api.md rename to plugins/catalog-backend-module-aws/report.api.md diff --git a/plugins/catalog-backend-module-azure/api-report-alpha.api.md b/plugins/catalog-backend-module-azure/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-azure/api-report-alpha.api.md rename to plugins/catalog-backend-module-azure/report-alpha.api.md diff --git a/plugins/catalog-backend-module-azure/api-report.api.md b/plugins/catalog-backend-module-azure/report.api.md similarity index 100% rename from plugins/catalog-backend-module-azure/api-report.api.md rename to plugins/catalog-backend-module-azure/report.api.md diff --git a/plugins/catalog-backend-module-backstage-openapi/api-report.api.md b/plugins/catalog-backend-module-backstage-openapi/report.api.md similarity index 100% rename from plugins/catalog-backend-module-backstage-openapi/api-report.api.md rename to plugins/catalog-backend-module-backstage-openapi/report.api.md diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/api-report-alpha.api.md rename to plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md diff --git a/plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/api-report.api.md rename to plugins/catalog-backend-module-bitbucket-cloud/report.api.md diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-server/api-report-alpha.api.md rename to plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md diff --git a/plugins/catalog-backend-module-bitbucket-server/api-report.api.md b/plugins/catalog-backend-module-bitbucket-server/report.api.md similarity index 100% rename from plugins/catalog-backend-module-bitbucket-server/api-report.api.md rename to plugins/catalog-backend-module-bitbucket-server/report.api.md diff --git a/plugins/catalog-backend-module-gcp/api-report-alpha.api.md b/plugins/catalog-backend-module-gcp/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gcp/api-report-alpha.api.md rename to plugins/catalog-backend-module-gcp/report-alpha.api.md diff --git a/plugins/catalog-backend-module-gcp/api-report.api.md b/plugins/catalog-backend-module-gcp/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gcp/api-report.api.md rename to plugins/catalog-backend-module-gcp/report.api.md diff --git a/plugins/catalog-backend-module-gerrit/api-report-alpha.api.md b/plugins/catalog-backend-module-gerrit/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gerrit/api-report-alpha.api.md rename to plugins/catalog-backend-module-gerrit/report-alpha.api.md diff --git a/plugins/catalog-backend-module-gerrit/api-report.api.md b/plugins/catalog-backend-module-gerrit/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gerrit/api-report.api.md rename to plugins/catalog-backend-module-gerrit/report.api.md diff --git a/plugins/catalog-backend-module-github-org/api-report.api.md b/plugins/catalog-backend-module-github-org/report.api.md similarity index 100% rename from plugins/catalog-backend-module-github-org/api-report.api.md rename to plugins/catalog-backend-module-github-org/report.api.md diff --git a/plugins/catalog-backend-module-github/api-report-alpha.api.md b/plugins/catalog-backend-module-github/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-github/api-report-alpha.api.md rename to plugins/catalog-backend-module-github/report-alpha.api.md diff --git a/plugins/catalog-backend-module-github/api-report.api.md b/plugins/catalog-backend-module-github/report.api.md similarity index 100% rename from plugins/catalog-backend-module-github/api-report.api.md rename to plugins/catalog-backend-module-github/report.api.md diff --git a/plugins/catalog-backend-module-gitlab-org/api-report.api.md b/plugins/catalog-backend-module-gitlab-org/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab-org/api-report.api.md rename to plugins/catalog-backend-module-gitlab-org/report.api.md diff --git a/plugins/catalog-backend-module-gitlab/api-report-alpha.api.md b/plugins/catalog-backend-module-gitlab/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab/api-report-alpha.api.md rename to plugins/catalog-backend-module-gitlab/report-alpha.api.md diff --git a/plugins/catalog-backend-module-gitlab/api-report.api.md b/plugins/catalog-backend-module-gitlab/report.api.md similarity index 100% rename from plugins/catalog-backend-module-gitlab/api-report.api.md rename to plugins/catalog-backend-module-gitlab/report.api.md diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.api.md b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-incremental-ingestion/api-report-alpha.api.md rename to plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md similarity index 100% rename from plugins/catalog-backend-module-incremental-ingestion/api-report.api.md rename to plugins/catalog-backend-module-incremental-ingestion/report.api.md diff --git a/plugins/catalog-backend-module-ldap/api-report.api.md b/plugins/catalog-backend-module-ldap/report.api.md similarity index 100% rename from plugins/catalog-backend-module-ldap/api-report.api.md rename to plugins/catalog-backend-module-ldap/report.api.md diff --git a/plugins/catalog-backend-module-logs/api-report.api.md b/plugins/catalog-backend-module-logs/report.api.md similarity index 100% rename from plugins/catalog-backend-module-logs/api-report.api.md rename to plugins/catalog-backend-module-logs/report.api.md diff --git a/plugins/catalog-backend-module-msgraph/api-report-alpha.api.md b/plugins/catalog-backend-module-msgraph/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-msgraph/api-report-alpha.api.md rename to plugins/catalog-backend-module-msgraph/report-alpha.api.md diff --git a/plugins/catalog-backend-module-msgraph/api-report.api.md b/plugins/catalog-backend-module-msgraph/report.api.md similarity index 100% rename from plugins/catalog-backend-module-msgraph/api-report.api.md rename to plugins/catalog-backend-module-msgraph/report.api.md diff --git a/plugins/catalog-backend-module-openapi/api-report.api.md b/plugins/catalog-backend-module-openapi/report.api.md similarity index 100% rename from plugins/catalog-backend-module-openapi/api-report.api.md rename to plugins/catalog-backend-module-openapi/report.api.md diff --git a/plugins/catalog-backend-module-puppetdb/api-report-alpha.api.md b/plugins/catalog-backend-module-puppetdb/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend-module-puppetdb/api-report-alpha.api.md rename to plugins/catalog-backend-module-puppetdb/report-alpha.api.md diff --git a/plugins/catalog-backend-module-puppetdb/api-report.api.md b/plugins/catalog-backend-module-puppetdb/report.api.md similarity index 100% rename from plugins/catalog-backend-module-puppetdb/api-report.api.md rename to plugins/catalog-backend-module-puppetdb/report.api.md diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md b/plugins/catalog-backend-module-scaffolder-entity-model/report.api.md similarity index 100% rename from plugins/catalog-backend-module-scaffolder-entity-model/api-report.api.md rename to plugins/catalog-backend-module-scaffolder-entity-model/report.api.md diff --git a/plugins/catalog-backend-module-unprocessed/api-report.api.md b/plugins/catalog-backend-module-unprocessed/report.api.md similarity index 100% rename from plugins/catalog-backend-module-unprocessed/api-report.api.md rename to plugins/catalog-backend-module-unprocessed/report.api.md diff --git a/plugins/catalog-backend/api-report-alpha.api.md b/plugins/catalog-backend/report-alpha.api.md similarity index 100% rename from plugins/catalog-backend/api-report-alpha.api.md rename to plugins/catalog-backend/report-alpha.api.md diff --git a/plugins/catalog-backend/api-report.api.md b/plugins/catalog-backend/report.api.md similarity index 100% rename from plugins/catalog-backend/api-report.api.md rename to plugins/catalog-backend/report.api.md diff --git a/plugins/catalog-common/api-report-alpha.api.md b/plugins/catalog-common/report-alpha.api.md similarity index 100% rename from plugins/catalog-common/api-report-alpha.api.md rename to plugins/catalog-common/report-alpha.api.md diff --git a/plugins/catalog-common/api-report.api.md b/plugins/catalog-common/report.api.md similarity index 100% rename from plugins/catalog-common/api-report.api.md rename to plugins/catalog-common/report.api.md diff --git a/plugins/catalog-graph/api-report-alpha.api.md b/plugins/catalog-graph/report-alpha.api.md similarity index 100% rename from plugins/catalog-graph/api-report-alpha.api.md rename to plugins/catalog-graph/report-alpha.api.md diff --git a/plugins/catalog-graph/api-report.api.md b/plugins/catalog-graph/report.api.md similarity index 100% rename from plugins/catalog-graph/api-report.api.md rename to plugins/catalog-graph/report.api.md diff --git a/plugins/catalog-import/api-report-alpha.api.md b/plugins/catalog-import/report-alpha.api.md similarity index 100% rename from plugins/catalog-import/api-report-alpha.api.md rename to plugins/catalog-import/report-alpha.api.md diff --git a/plugins/catalog-import/api-report.api.md b/plugins/catalog-import/report.api.md similarity index 100% rename from plugins/catalog-import/api-report.api.md rename to plugins/catalog-import/report.api.md diff --git a/plugins/catalog-node/api-report-alpha.api.md b/plugins/catalog-node/report-alpha.api.md similarity index 100% rename from plugins/catalog-node/api-report-alpha.api.md rename to plugins/catalog-node/report-alpha.api.md diff --git a/plugins/catalog-node/api-report.api.md b/plugins/catalog-node/report.api.md similarity index 100% rename from plugins/catalog-node/api-report.api.md rename to plugins/catalog-node/report.api.md diff --git a/plugins/catalog-react/api-report-alpha.api.md b/plugins/catalog-react/report-alpha.api.md similarity index 100% rename from plugins/catalog-react/api-report-alpha.api.md rename to plugins/catalog-react/report-alpha.api.md diff --git a/plugins/catalog-react/api-report.api.md b/plugins/catalog-react/report.api.md similarity index 100% rename from plugins/catalog-react/api-report.api.md rename to plugins/catalog-react/report.api.md diff --git a/plugins/catalog-unprocessed-entities-common/api-report.api.md b/plugins/catalog-unprocessed-entities-common/report.api.md similarity index 100% rename from plugins/catalog-unprocessed-entities-common/api-report.api.md rename to plugins/catalog-unprocessed-entities-common/report.api.md diff --git a/plugins/catalog-unprocessed-entities/api-report.api.md b/plugins/catalog-unprocessed-entities/report.api.md similarity index 100% rename from plugins/catalog-unprocessed-entities/api-report.api.md rename to plugins/catalog-unprocessed-entities/report.api.md diff --git a/plugins/catalog/api-report-alpha.api.md b/plugins/catalog/report-alpha.api.md similarity index 100% rename from plugins/catalog/api-report-alpha.api.md rename to plugins/catalog/report-alpha.api.md diff --git a/plugins/catalog/api-report.api.md b/plugins/catalog/report.api.md similarity index 100% rename from plugins/catalog/api-report.api.md rename to plugins/catalog/report.api.md diff --git a/plugins/config-schema/api-report.api.md b/plugins/config-schema/report.api.md similarity index 100% rename from plugins/config-schema/api-report.api.md rename to plugins/config-schema/report.api.md diff --git a/plugins/devtools-backend/api-report.api.md b/plugins/devtools-backend/report.api.md similarity index 100% rename from plugins/devtools-backend/api-report.api.md rename to plugins/devtools-backend/report.api.md diff --git a/plugins/devtools-common/api-report.api.md b/plugins/devtools-common/report.api.md similarity index 100% rename from plugins/devtools-common/api-report.api.md rename to plugins/devtools-common/report.api.md diff --git a/plugins/devtools/api-report-alpha.api.md b/plugins/devtools/report-alpha.api.md similarity index 97% rename from plugins/devtools/api-report-alpha.api.md rename to plugins/devtools/report-alpha.api.md index 5db9e75117..dbf690bc09 100644 --- a/plugins/devtools/api-report-alpha.api.md +++ b/plugins/devtools/report-alpha.api.md @@ -91,7 +91,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha/plugin.d.ts:12:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha/plugin.d.ts:16:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/devtools/api-report.api.md b/plugins/devtools/report.api.md similarity index 100% rename from plugins/devtools/api-report.api.md rename to plugins/devtools/report.api.md diff --git a/plugins/events-backend-module-aws-sqs/api-report-alpha.api.md b/plugins/events-backend-module-aws-sqs/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-aws-sqs/api-report-alpha.api.md rename to plugins/events-backend-module-aws-sqs/report-alpha.api.md diff --git a/plugins/events-backend-module-aws-sqs/api-report.api.md b/plugins/events-backend-module-aws-sqs/report.api.md similarity index 100% rename from plugins/events-backend-module-aws-sqs/api-report.api.md rename to plugins/events-backend-module-aws-sqs/report.api.md diff --git a/plugins/events-backend-module-azure/api-report-alpha.api.md b/plugins/events-backend-module-azure/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-azure/api-report-alpha.api.md rename to plugins/events-backend-module-azure/report-alpha.api.md diff --git a/plugins/events-backend-module-azure/api-report.api.md b/plugins/events-backend-module-azure/report.api.md similarity index 100% rename from plugins/events-backend-module-azure/api-report.api.md rename to plugins/events-backend-module-azure/report.api.md diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report-alpha.api.md b/plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-bitbucket-cloud/api-report-alpha.api.md rename to plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md diff --git a/plugins/events-backend-module-bitbucket-cloud/api-report.api.md b/plugins/events-backend-module-bitbucket-cloud/report.api.md similarity index 100% rename from plugins/events-backend-module-bitbucket-cloud/api-report.api.md rename to plugins/events-backend-module-bitbucket-cloud/report.api.md diff --git a/plugins/events-backend-module-gerrit/api-report-alpha.api.md b/plugins/events-backend-module-gerrit/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-gerrit/api-report-alpha.api.md rename to plugins/events-backend-module-gerrit/report-alpha.api.md diff --git a/plugins/events-backend-module-gerrit/api-report.api.md b/plugins/events-backend-module-gerrit/report.api.md similarity index 100% rename from plugins/events-backend-module-gerrit/api-report.api.md rename to plugins/events-backend-module-gerrit/report.api.md diff --git a/plugins/events-backend-module-github/api-report-alpha.api.md b/plugins/events-backend-module-github/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-github/api-report-alpha.api.md rename to plugins/events-backend-module-github/report-alpha.api.md diff --git a/plugins/events-backend-module-github/api-report.api.md b/plugins/events-backend-module-github/report.api.md similarity index 100% rename from plugins/events-backend-module-github/api-report.api.md rename to plugins/events-backend-module-github/report.api.md diff --git a/plugins/events-backend-module-gitlab/api-report-alpha.api.md b/plugins/events-backend-module-gitlab/report-alpha.api.md similarity index 100% rename from plugins/events-backend-module-gitlab/api-report-alpha.api.md rename to plugins/events-backend-module-gitlab/report-alpha.api.md diff --git a/plugins/events-backend-module-gitlab/api-report.api.md b/plugins/events-backend-module-gitlab/report.api.md similarity index 100% rename from plugins/events-backend-module-gitlab/api-report.api.md rename to plugins/events-backend-module-gitlab/report.api.md diff --git a/plugins/events-backend-test-utils/api-report.api.md b/plugins/events-backend-test-utils/report.api.md similarity index 100% rename from plugins/events-backend-test-utils/api-report.api.md rename to plugins/events-backend-test-utils/report.api.md diff --git a/plugins/events-backend/api-report-alpha.api.md b/plugins/events-backend/report-alpha.api.md similarity index 100% rename from plugins/events-backend/api-report-alpha.api.md rename to plugins/events-backend/report-alpha.api.md diff --git a/plugins/events-backend/api-report.api.md b/plugins/events-backend/report.api.md similarity index 100% rename from plugins/events-backend/api-report.api.md rename to plugins/events-backend/report.api.md diff --git a/plugins/events-node/api-report-alpha.api.md b/plugins/events-node/report-alpha.api.md similarity index 100% rename from plugins/events-node/api-report-alpha.api.md rename to plugins/events-node/report-alpha.api.md diff --git a/plugins/events-node/api-report.api.md b/plugins/events-node/report.api.md similarity index 100% rename from plugins/events-node/api-report.api.md rename to plugins/events-node/report.api.md diff --git a/plugins/example-todo-list-backend/api-report.api.md b/plugins/example-todo-list-backend/report.api.md similarity index 100% rename from plugins/example-todo-list-backend/api-report.api.md rename to plugins/example-todo-list-backend/report.api.md diff --git a/plugins/example-todo-list-common/api-report.api.md b/plugins/example-todo-list-common/report.api.md similarity index 100% rename from plugins/example-todo-list-common/api-report.api.md rename to plugins/example-todo-list-common/report.api.md diff --git a/plugins/example-todo-list/api-report.api.md b/plugins/example-todo-list/report.api.md similarity index 100% rename from plugins/example-todo-list/api-report.api.md rename to plugins/example-todo-list/report.api.md diff --git a/plugins/home-react/api-report.api.md b/plugins/home-react/report.api.md similarity index 100% rename from plugins/home-react/api-report.api.md rename to plugins/home-react/report.api.md diff --git a/plugins/home/api-report-alpha.api.md b/plugins/home/report-alpha.api.md similarity index 100% rename from plugins/home/api-report-alpha.api.md rename to plugins/home/report-alpha.api.md diff --git a/plugins/home/api-report.api.md b/plugins/home/report.api.md similarity index 100% rename from plugins/home/api-report.api.md rename to plugins/home/report.api.md diff --git a/plugins/kubernetes-backend/api-report-alpha.api.md b/plugins/kubernetes-backend/report-alpha.api.md similarity index 100% rename from plugins/kubernetes-backend/api-report-alpha.api.md rename to plugins/kubernetes-backend/report-alpha.api.md diff --git a/plugins/kubernetes-backend/api-report.api.md b/plugins/kubernetes-backend/report.api.md similarity index 100% rename from plugins/kubernetes-backend/api-report.api.md rename to plugins/kubernetes-backend/report.api.md diff --git a/plugins/kubernetes-cluster/api-report.api.md b/plugins/kubernetes-cluster/report.api.md similarity index 100% rename from plugins/kubernetes-cluster/api-report.api.md rename to plugins/kubernetes-cluster/report.api.md diff --git a/plugins/kubernetes-common/api-report.api.md b/plugins/kubernetes-common/report.api.md similarity index 100% rename from plugins/kubernetes-common/api-report.api.md rename to plugins/kubernetes-common/report.api.md diff --git a/plugins/kubernetes-node/api-report.api.md b/plugins/kubernetes-node/report.api.md similarity index 100% rename from plugins/kubernetes-node/api-report.api.md rename to plugins/kubernetes-node/report.api.md diff --git a/plugins/kubernetes-react/api-report.api.md b/plugins/kubernetes-react/report.api.md similarity index 100% rename from plugins/kubernetes-react/api-report.api.md rename to plugins/kubernetes-react/report.api.md diff --git a/plugins/kubernetes/api-report-alpha.md b/plugins/kubernetes/report-alpha.api.md similarity index 97% rename from plugins/kubernetes/api-report-alpha.md rename to plugins/kubernetes/report-alpha.api.md index 9ba748577f..f257d56587 100644 --- a/plugins/kubernetes/api-report-alpha.md +++ b/plugins/kubernetes/report-alpha.api.md @@ -162,5 +162,9 @@ const _default: FrontendPlugin< >; export default _default; +// Warnings were encountered during analysis: +// +// src/alpha/plugin.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes/api-report.api.md b/plugins/kubernetes/report.api.md similarity index 100% rename from plugins/kubernetes/api-report.api.md rename to plugins/kubernetes/report.api.md diff --git a/plugins/notifications-backend-module-email/api-report.api.md b/plugins/notifications-backend-module-email/report.api.md similarity index 100% rename from plugins/notifications-backend-module-email/api-report.api.md rename to plugins/notifications-backend-module-email/report.api.md diff --git a/plugins/notifications-backend/api-report.api.md b/plugins/notifications-backend/report.api.md similarity index 100% rename from plugins/notifications-backend/api-report.api.md rename to plugins/notifications-backend/report.api.md diff --git a/plugins/notifications-common/api-report.api.md b/plugins/notifications-common/report.api.md similarity index 100% rename from plugins/notifications-common/api-report.api.md rename to plugins/notifications-common/report.api.md diff --git a/plugins/notifications-node/api-report.api.md b/plugins/notifications-node/report.api.md similarity index 100% rename from plugins/notifications-node/api-report.api.md rename to plugins/notifications-node/report.api.md diff --git a/plugins/notifications/api-report.api.md b/plugins/notifications/report.api.md similarity index 100% rename from plugins/notifications/api-report.api.md rename to plugins/notifications/report.api.md diff --git a/plugins/org-react/api-report.api.md b/plugins/org-react/report.api.md similarity index 100% rename from plugins/org-react/api-report.api.md rename to plugins/org-react/report.api.md diff --git a/plugins/org/api-report-alpha.api.md b/plugins/org/report-alpha.api.md similarity index 100% rename from plugins/org/api-report-alpha.api.md rename to plugins/org/report-alpha.api.md diff --git a/plugins/org/api-report.api.md b/plugins/org/report.api.md similarity index 100% rename from plugins/org/api-report.api.md rename to plugins/org/report.api.md diff --git a/plugins/permission-backend-module-policy-allow-all/api-report.api.md b/plugins/permission-backend-module-policy-allow-all/report.api.md similarity index 100% rename from plugins/permission-backend-module-policy-allow-all/api-report.api.md rename to plugins/permission-backend-module-policy-allow-all/report.api.md diff --git a/plugins/permission-backend/api-report-alpha.api.md b/plugins/permission-backend/report-alpha.api.md similarity index 100% rename from plugins/permission-backend/api-report-alpha.api.md rename to plugins/permission-backend/report-alpha.api.md diff --git a/plugins/permission-backend/api-report.api.md b/plugins/permission-backend/report.api.md similarity index 100% rename from plugins/permission-backend/api-report.api.md rename to plugins/permission-backend/report.api.md diff --git a/plugins/permission-common/api-report.api.md b/plugins/permission-common/report.api.md similarity index 100% rename from plugins/permission-common/api-report.api.md rename to plugins/permission-common/report.api.md diff --git a/plugins/permission-node/api-report-alpha.api.md b/plugins/permission-node/report-alpha.api.md similarity index 100% rename from plugins/permission-node/api-report-alpha.api.md rename to plugins/permission-node/report-alpha.api.md diff --git a/plugins/permission-node/api-report.api.md b/plugins/permission-node/report.api.md similarity index 100% rename from plugins/permission-node/api-report.api.md rename to plugins/permission-node/report.api.md diff --git a/plugins/permission-react/api-report.api.md b/plugins/permission-react/report.api.md similarity index 100% rename from plugins/permission-react/api-report.api.md rename to plugins/permission-react/report.api.md diff --git a/plugins/proxy-backend/api-report-alpha.api.md b/plugins/proxy-backend/report-alpha.api.md similarity index 100% rename from plugins/proxy-backend/api-report-alpha.api.md rename to plugins/proxy-backend/report-alpha.api.md diff --git a/plugins/proxy-backend/api-report.api.md b/plugins/proxy-backend/report.api.md similarity index 100% rename from plugins/proxy-backend/api-report.api.md rename to plugins/proxy-backend/report.api.md diff --git a/plugins/scaffolder-backend-module-azure/api-report.api.md b/plugins/scaffolder-backend-module-azure/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-azure/api-report.api.md rename to plugins/scaffolder-backend-module-azure/report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket-cloud/api-report.api.md b/plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-bitbucket-cloud/api-report.api.md rename to plugins/scaffolder-backend-module-bitbucket-cloud/report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket-server/api-report.api.md b/plugins/scaffolder-backend-module-bitbucket-server/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-bitbucket-server/api-report.api.md rename to plugins/scaffolder-backend-module-bitbucket-server/report.api.md diff --git a/plugins/scaffolder-backend-module-bitbucket/api-report.api.md b/plugins/scaffolder-backend-module-bitbucket/report.api.md similarity index 90% rename from plugins/scaffolder-backend-module-bitbucket/api-report.api.md rename to plugins/scaffolder-backend-module-bitbucket/report.api.md index 34c9eb8c67..8721760248 100644 --- a/plugins/scaffolder-backend-module-bitbucket/api-report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket/report.api.md @@ -59,8 +59,8 @@ export const createPublishBitbucketServerPullRequestAction: typeof bitbucketServ // Warnings were encountered during analysis: // -// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". -// src/deprecated.d.ts:11:22 - (ae-undocumented) Missing documentation for "createBitbucketPipelinesRunAction". -// src/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". -// src/deprecated.d.ts:26:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". +// src/deprecated.d.ts:8:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". +// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "createBitbucketPipelinesRunAction". +// src/deprecated.d.ts:29:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". +// src/deprecated.d.ts:34:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". ``` diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md b/plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-confluence-to-markdown/api-report.api.md rename to plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md diff --git a/plugins/scaffolder-backend-module-cookiecutter/api-report.api.md b/plugins/scaffolder-backend-module-cookiecutter/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-cookiecutter/api-report.api.md rename to plugins/scaffolder-backend-module-cookiecutter/report.api.md diff --git a/plugins/scaffolder-backend-module-gcp/api-report.api.md b/plugins/scaffolder-backend-module-gcp/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gcp/api-report.api.md rename to plugins/scaffolder-backend-module-gcp/report.api.md diff --git a/plugins/scaffolder-backend-module-gerrit/api-report.api.md b/plugins/scaffolder-backend-module-gerrit/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gerrit/api-report.api.md rename to plugins/scaffolder-backend-module-gerrit/report.api.md diff --git a/plugins/scaffolder-backend-module-gitea/api-report.api.md b/plugins/scaffolder-backend-module-gitea/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gitea/api-report.api.md rename to plugins/scaffolder-backend-module-gitea/report.api.md diff --git a/plugins/scaffolder-backend-module-github/api-report.api.md b/plugins/scaffolder-backend-module-github/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-github/api-report.api.md rename to plugins/scaffolder-backend-module-github/report.api.md diff --git a/plugins/scaffolder-backend-module-gitlab/api-report.api.md b/plugins/scaffolder-backend-module-gitlab/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-gitlab/api-report.api.md rename to plugins/scaffolder-backend-module-gitlab/report.api.md diff --git a/plugins/scaffolder-backend-module-notifications/api-report.api.md b/plugins/scaffolder-backend-module-notifications/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-notifications/api-report.api.md rename to plugins/scaffolder-backend-module-notifications/report.api.md diff --git a/plugins/scaffolder-backend-module-rails/api-report.api.md b/plugins/scaffolder-backend-module-rails/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-rails/api-report.api.md rename to plugins/scaffolder-backend-module-rails/report.api.md diff --git a/plugins/scaffolder-backend-module-sentry/api-report.api.md b/plugins/scaffolder-backend-module-sentry/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-sentry/api-report.api.md rename to plugins/scaffolder-backend-module-sentry/report.api.md diff --git a/plugins/scaffolder-backend-module-yeoman/api-report.api.md b/plugins/scaffolder-backend-module-yeoman/report.api.md similarity index 100% rename from plugins/scaffolder-backend-module-yeoman/api-report.api.md rename to plugins/scaffolder-backend-module-yeoman/report.api.md diff --git a/plugins/scaffolder-backend/api-report-alpha.api.md b/plugins/scaffolder-backend/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-backend/api-report-alpha.api.md rename to plugins/scaffolder-backend/report-alpha.api.md diff --git a/plugins/scaffolder-backend/api-report.api.md b/plugins/scaffolder-backend/report.api.md similarity index 96% rename from plugins/scaffolder-backend/api-report.api.md rename to plugins/scaffolder-backend/report.api.md index 082e0baaa5..f51d756528 100644 --- a/plugins/scaffolder-backend/api-report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -848,25 +848,25 @@ export type TemplatePermissionRuleInput< // src/scaffolder/actions/TemplateActionRegistry.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". // src/scaffolder/actions/TemplateActionRegistry.d.ts:10:5 - (ae-undocumented) Missing documentation for "list". // src/scaffolder/actions/builtin/createBuiltinActions.d.ts:37:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". -// src/scaffolder/actions/deprecated.d.ts:11:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". -// src/scaffolder/actions/deprecated.d.ts:15:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". -// src/scaffolder/actions/deprecated.d.ts:19:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". -// src/scaffolder/actions/deprecated.d.ts:23:22 - (ae-undocumented) Missing documentation for "createGithubIssuesLabelAction". -// src/scaffolder/actions/deprecated.d.ts:27:1 - (ae-undocumented) Missing documentation for "CreateGithubPullRequestActionOptions". -// src/scaffolder/actions/deprecated.d.ts:31:22 - (ae-undocumented) Missing documentation for "createGithubRepoCreateAction". -// src/scaffolder/actions/deprecated.d.ts:35:22 - (ae-undocumented) Missing documentation for "createGithubRepoPushAction". -// src/scaffolder/actions/deprecated.d.ts:39:22 - (ae-undocumented) Missing documentation for "createGithubWebhookAction". -// src/scaffolder/actions/deprecated.d.ts:43:22 - (ae-undocumented) Missing documentation for "createPublishGithubAction". -// src/scaffolder/actions/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "createPublishGithubPullRequestAction". -// src/scaffolder/actions/deprecated.d.ts:69:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketAction". -// src/scaffolder/actions/deprecated.d.ts:73:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". -// src/scaffolder/actions/deprecated.d.ts:77:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". -// src/scaffolder/actions/deprecated.d.ts:81:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". -// src/scaffolder/actions/deprecated.d.ts:85:22 - (ae-undocumented) Missing documentation for "createPublishAzureAction". -// src/scaffolder/actions/deprecated.d.ts:89:22 - (ae-undocumented) Missing documentation for "createPublishGerritAction". -// src/scaffolder/actions/deprecated.d.ts:93:22 - (ae-undocumented) Missing documentation for "createPublishGerritReviewAction". -// src/scaffolder/actions/deprecated.d.ts:97:22 - (ae-undocumented) Missing documentation for "createPublishGitlabAction". -// src/scaffolder/actions/deprecated.d.ts:101:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". +// src/scaffolder/actions/deprecated.d.ts:12:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". +// src/scaffolder/actions/deprecated.d.ts:17:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". +// src/scaffolder/actions/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". +// src/scaffolder/actions/deprecated.d.ts:27:22 - (ae-undocumented) Missing documentation for "createGithubIssuesLabelAction". +// src/scaffolder/actions/deprecated.d.ts:32:1 - (ae-undocumented) Missing documentation for "CreateGithubPullRequestActionOptions". +// src/scaffolder/actions/deprecated.d.ts:37:22 - (ae-undocumented) Missing documentation for "createGithubRepoCreateAction". +// src/scaffolder/actions/deprecated.d.ts:42:22 - (ae-undocumented) Missing documentation for "createGithubRepoPushAction". +// src/scaffolder/actions/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "createGithubWebhookAction". +// src/scaffolder/actions/deprecated.d.ts:52:22 - (ae-undocumented) Missing documentation for "createPublishGithubAction". +// src/scaffolder/actions/deprecated.d.ts:57:22 - (ae-undocumented) Missing documentation for "createPublishGithubPullRequestAction". +// src/scaffolder/actions/deprecated.d.ts:79:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketAction". +// src/scaffolder/actions/deprecated.d.ts:84:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". +// src/scaffolder/actions/deprecated.d.ts:89:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". +// src/scaffolder/actions/deprecated.d.ts:94:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". +// src/scaffolder/actions/deprecated.d.ts:99:22 - (ae-undocumented) Missing documentation for "createPublishAzureAction". +// src/scaffolder/actions/deprecated.d.ts:104:22 - (ae-undocumented) Missing documentation for "createPublishGerritAction". +// src/scaffolder/actions/deprecated.d.ts:109:22 - (ae-undocumented) Missing documentation for "createPublishGerritReviewAction". +// src/scaffolder/actions/deprecated.d.ts:114:22 - (ae-undocumented) Missing documentation for "createPublishGitlabAction". +// src/scaffolder/actions/deprecated.d.ts:119:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:41:5 - (ae-undocumented) Missing documentation for "create". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:48:5 - (ae-undocumented) Missing documentation for "list". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:53:5 - (ae-undocumented) Missing documentation for "getTask". diff --git a/plugins/scaffolder-common/api-report-alpha.api.md b/plugins/scaffolder-common/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-common/api-report-alpha.api.md rename to plugins/scaffolder-common/report-alpha.api.md diff --git a/plugins/scaffolder-common/api-report.api.md b/plugins/scaffolder-common/report.api.md similarity index 100% rename from plugins/scaffolder-common/api-report.api.md rename to plugins/scaffolder-common/report.api.md diff --git a/plugins/scaffolder-node-test-utils/api-report.api.md b/plugins/scaffolder-node-test-utils/report.api.md similarity index 100% rename from plugins/scaffolder-node-test-utils/api-report.api.md rename to plugins/scaffolder-node-test-utils/report.api.md diff --git a/plugins/scaffolder-node/api-report-alpha.api.md b/plugins/scaffolder-node/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-node/api-report-alpha.api.md rename to plugins/scaffolder-node/report-alpha.api.md diff --git a/plugins/scaffolder-node/api-report.api.md b/plugins/scaffolder-node/report.api.md similarity index 100% rename from plugins/scaffolder-node/api-report.api.md rename to plugins/scaffolder-node/report.api.md diff --git a/plugins/scaffolder-react/api-report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md similarity index 100% rename from plugins/scaffolder-react/api-report-alpha.api.md rename to plugins/scaffolder-react/report-alpha.api.md diff --git a/plugins/scaffolder-react/api-report.api.md b/plugins/scaffolder-react/report.api.md similarity index 100% rename from plugins/scaffolder-react/api-report.api.md rename to plugins/scaffolder-react/report.api.md diff --git a/plugins/scaffolder/api-report-alpha.api.md b/plugins/scaffolder/report-alpha.api.md similarity index 100% rename from plugins/scaffolder/api-report-alpha.api.md rename to plugins/scaffolder/report-alpha.api.md diff --git a/plugins/scaffolder/api-report.api.md b/plugins/scaffolder/report.api.md similarity index 100% rename from plugins/scaffolder/api-report.api.md rename to plugins/scaffolder/report.api.md diff --git a/plugins/search-backend-module-catalog/api-report-alpha.api.md b/plugins/search-backend-module-catalog/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-catalog/api-report-alpha.api.md rename to plugins/search-backend-module-catalog/report-alpha.api.md diff --git a/plugins/search-backend-module-catalog/api-report.api.md b/plugins/search-backend-module-catalog/report.api.md similarity index 100% rename from plugins/search-backend-module-catalog/api-report.api.md rename to plugins/search-backend-module-catalog/report.api.md diff --git a/plugins/search-backend-module-elasticsearch/api-report-alpha.api.md b/plugins/search-backend-module-elasticsearch/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-elasticsearch/api-report-alpha.api.md rename to plugins/search-backend-module-elasticsearch/report-alpha.api.md diff --git a/plugins/search-backend-module-elasticsearch/api-report.api.md b/plugins/search-backend-module-elasticsearch/report.api.md similarity index 100% rename from plugins/search-backend-module-elasticsearch/api-report.api.md rename to plugins/search-backend-module-elasticsearch/report.api.md diff --git a/plugins/search-backend-module-explore/api-report-alpha.api.md b/plugins/search-backend-module-explore/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-explore/api-report-alpha.api.md rename to plugins/search-backend-module-explore/report-alpha.api.md diff --git a/plugins/search-backend-module-explore/api-report.api.md b/plugins/search-backend-module-explore/report.api.md similarity index 100% rename from plugins/search-backend-module-explore/api-report.api.md rename to plugins/search-backend-module-explore/report.api.md diff --git a/plugins/search-backend-module-pg/api-report-alpha.api.md b/plugins/search-backend-module-pg/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-pg/api-report-alpha.api.md rename to plugins/search-backend-module-pg/report-alpha.api.md diff --git a/plugins/search-backend-module-pg/api-report.api.md b/plugins/search-backend-module-pg/report.api.md similarity index 100% rename from plugins/search-backend-module-pg/api-report.api.md rename to plugins/search-backend-module-pg/report.api.md diff --git a/plugins/search-backend-module-stack-overflow-collator/api-report.api.md b/plugins/search-backend-module-stack-overflow-collator/report.api.md similarity index 100% rename from plugins/search-backend-module-stack-overflow-collator/api-report.api.md rename to plugins/search-backend-module-stack-overflow-collator/report.api.md diff --git a/plugins/search-backend-module-techdocs/api-report-alpha.api.md b/plugins/search-backend-module-techdocs/report-alpha.api.md similarity index 100% rename from plugins/search-backend-module-techdocs/api-report-alpha.api.md rename to plugins/search-backend-module-techdocs/report-alpha.api.md diff --git a/plugins/search-backend-module-techdocs/api-report.api.md b/plugins/search-backend-module-techdocs/report.api.md similarity index 100% rename from plugins/search-backend-module-techdocs/api-report.api.md rename to plugins/search-backend-module-techdocs/report.api.md diff --git a/plugins/search-backend-node/api-report-alpha.api.md b/plugins/search-backend-node/report-alpha.api.md similarity index 100% rename from plugins/search-backend-node/api-report-alpha.api.md rename to plugins/search-backend-node/report-alpha.api.md diff --git a/plugins/search-backend-node/api-report.api.md b/plugins/search-backend-node/report.api.md similarity index 100% rename from plugins/search-backend-node/api-report.api.md rename to plugins/search-backend-node/report.api.md diff --git a/plugins/search-backend/api-report-alpha.api.md b/plugins/search-backend/report-alpha.api.md similarity index 100% rename from plugins/search-backend/api-report-alpha.api.md rename to plugins/search-backend/report-alpha.api.md diff --git a/plugins/search-backend/api-report.api.md b/plugins/search-backend/report.api.md similarity index 100% rename from plugins/search-backend/api-report.api.md rename to plugins/search-backend/report.api.md diff --git a/plugins/search-common/api-report.api.md b/plugins/search-common/report.api.md similarity index 100% rename from plugins/search-common/api-report.api.md rename to plugins/search-common/report.api.md diff --git a/plugins/search-react/api-report-alpha.api.md b/plugins/search-react/report-alpha.api.md similarity index 100% rename from plugins/search-react/api-report-alpha.api.md rename to plugins/search-react/report-alpha.api.md diff --git a/plugins/search-react/api-report.api.md b/plugins/search-react/report.api.md similarity index 100% rename from plugins/search-react/api-report.api.md rename to plugins/search-react/report.api.md diff --git a/plugins/search/api-report-alpha.api.md b/plugins/search/report-alpha.api.md similarity index 97% rename from plugins/search/api-report-alpha.api.md rename to plugins/search/report-alpha.api.md index 36c703a669..052340c432 100644 --- a/plugins/search/api-report-alpha.api.md +++ b/plugins/search/report-alpha.api.md @@ -198,8 +198,8 @@ export const searchPage: ExtensionDefinition<{ // // src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "searchApi". // src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "searchPage". -// src/alpha.d.ts:9:22 - (ae-undocumented) Missing documentation for "searchNavItem". -// src/alpha.d.ts:13:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:12:22 - (ae-undocumented) Missing documentation for "searchNavItem". +// src/alpha.d.ts:18:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/api-report.api.md b/plugins/search/report.api.md similarity index 100% rename from plugins/search/api-report.api.md rename to plugins/search/report.api.md diff --git a/plugins/signals-backend/api-report.api.md b/plugins/signals-backend/report.api.md similarity index 100% rename from plugins/signals-backend/api-report.api.md rename to plugins/signals-backend/report.api.md diff --git a/plugins/signals-node/api-report.api.md b/plugins/signals-node/report.api.md similarity index 100% rename from plugins/signals-node/api-report.api.md rename to plugins/signals-node/report.api.md diff --git a/plugins/signals-react/api-report.api.md b/plugins/signals-react/report.api.md similarity index 100% rename from plugins/signals-react/api-report.api.md rename to plugins/signals-react/report.api.md diff --git a/plugins/signals/api-report.api.md b/plugins/signals/report.api.md similarity index 100% rename from plugins/signals/api-report.api.md rename to plugins/signals/report.api.md diff --git a/plugins/techdocs-addons-test-utils/api-report.api.md b/plugins/techdocs-addons-test-utils/report.api.md similarity index 100% rename from plugins/techdocs-addons-test-utils/api-report.api.md rename to plugins/techdocs-addons-test-utils/report.api.md diff --git a/plugins/techdocs-backend/api-report-alpha.api.md b/plugins/techdocs-backend/report-alpha.api.md similarity index 100% rename from plugins/techdocs-backend/api-report-alpha.api.md rename to plugins/techdocs-backend/report-alpha.api.md diff --git a/plugins/techdocs-backend/api-report.api.md b/plugins/techdocs-backend/report.api.md similarity index 100% rename from plugins/techdocs-backend/api-report.api.md rename to plugins/techdocs-backend/report.api.md diff --git a/plugins/techdocs-module-addons-contrib/api-report.api.md b/plugins/techdocs-module-addons-contrib/report.api.md similarity index 100% rename from plugins/techdocs-module-addons-contrib/api-report.api.md rename to plugins/techdocs-module-addons-contrib/report.api.md diff --git a/plugins/techdocs-node/api-report.api.md b/plugins/techdocs-node/report.api.md similarity index 100% rename from plugins/techdocs-node/api-report.api.md rename to plugins/techdocs-node/report.api.md diff --git a/plugins/techdocs-react/api-report.api.md b/plugins/techdocs-react/report.api.md similarity index 100% rename from plugins/techdocs-react/api-report.api.md rename to plugins/techdocs-react/report.api.md diff --git a/plugins/techdocs/api-report-alpha.api.md b/plugins/techdocs/report-alpha.api.md similarity index 99% rename from plugins/techdocs/api-report-alpha.api.md rename to plugins/techdocs/report-alpha.api.md index 8a9ce1e1dc..c2f75be11e 100644 --- a/plugins/techdocs/api-report-alpha.api.md +++ b/plugins/techdocs/report-alpha.api.md @@ -317,7 +317,7 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{ // Warnings were encountered during analysis: // // src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "techDocsSearchResultListItemExtension". -// src/alpha.d.ts:10:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:16:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/api-report.api.md b/plugins/techdocs/report.api.md similarity index 100% rename from plugins/techdocs/api-report.api.md rename to plugins/techdocs/report.api.md diff --git a/plugins/user-settings-backend/api-report-alpha.api.md b/plugins/user-settings-backend/report-alpha.api.md similarity index 100% rename from plugins/user-settings-backend/api-report-alpha.api.md rename to plugins/user-settings-backend/report-alpha.api.md diff --git a/plugins/user-settings-backend/api-report.api.md b/plugins/user-settings-backend/report.api.md similarity index 100% rename from plugins/user-settings-backend/api-report.api.md rename to plugins/user-settings-backend/report.api.md diff --git a/plugins/user-settings-common/api-report.api.md b/plugins/user-settings-common/report.api.md similarity index 100% rename from plugins/user-settings-common/api-report.api.md rename to plugins/user-settings-common/report.api.md diff --git a/plugins/user-settings/api-report-alpha.api.md b/plugins/user-settings/report-alpha.api.md similarity index 97% rename from plugins/user-settings/api-report-alpha.api.md rename to plugins/user-settings/report-alpha.api.md index 0a5dbde28d..299bbc3498 100644 --- a/plugins/user-settings/api-report-alpha.api.md +++ b/plugins/user-settings/report-alpha.api.md @@ -130,7 +130,7 @@ export const userSettingsTranslationRef: TranslationRef< // Warnings were encountered during analysis: // // src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "settingsNavItem". -// src/alpha.d.ts:9:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:11:15 - (ae-undocumented) Missing documentation for "_default". // src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "userSettingsTranslationRef". // (No @packageDocumentation comment for this package) diff --git a/plugins/user-settings/api-report.api.md b/plugins/user-settings/report.api.md similarity index 100% rename from plugins/user-settings/api-report.api.md rename to plugins/user-settings/report.api.md From abfbf718130c4240c80705cfa4567c30bb28e16f Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 14:07:18 +0200 Subject: [PATCH 05/13] update changesets Signed-off-by: secustor --- .changeset/fluffy-pears-cry.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.changeset/fluffy-pears-cry.md b/.changeset/fluffy-pears-cry.md index ad7eed680c..2da74eb857 100644 --- a/.changeset/fluffy-pears-cry.md +++ b/.changeset/fluffy-pears-cry.md @@ -1,5 +1,6 @@ --- -'@backstage/repo-tools': patch +'@backstage/repo-tools': minor --- -Update @microsoft/api-extractor and use their api report resolution +Update @microsoft/api-extractor and use their api report resolution. +Change api report format from `api-report.md` to `report.api.md` From 3dff35c220f245ed408fd989546cb7c8b71a95ef Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 15:21:53 +0200 Subject: [PATCH 06/13] use extractor output to remove reports from tracking set Signed-off-by: secustor --- .../repo-tools/src/commands/api-reports/api-extractor.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/repo-tools/src/commands/api-reports/api-extractor.ts b/packages/repo-tools/src/commands/api-reports/api-extractor.ts index 4546b292c8..70b4e54739 100644 --- a/packages/repo-tools/src/commands/api-reports/api-extractor.ts +++ b/packages/repo-tools/src/commands/api-reports/api-extractor.ts @@ -407,7 +407,6 @@ export async function runApiExtraction({ packageEntryPoint.name === 'index' ? '' : `-${packageEntryPoint.name}`; const reportFileName = `report${suffix}`; const reportPath = resolvePath(projectFolder, reportFileName); - remainingReportFiles.delete(reportFileName); const warningCountBefore = await countApiReportWarnings(reportPath); @@ -485,6 +484,11 @@ export async function runApiExtraction({ ignoreMissingEntryPoint: true, }); + // remove extracted reports from current list + for (const reportConfig of extractorConfig.reportConfigs) { + remainingReportFiles.delete(reportConfig.fileName); + } + // The `packageFolder` needs to point to the location within `dist-types` in order for relative // paths to be logged. Unfortunately the `prepare` method above derives it from the `packageJsonFullPath`, // which needs to point to the actual file, so we override `packageFolder` afterwards. From 23c2602fc38448763a688cb0ada268dec2f3ff32 Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 15:23:06 +0200 Subject: [PATCH 07/13] update docs Signed-off-by: secustor --- REVIEWING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/REVIEWING.md b/REVIEWING.md index 880577da40..7517791ebd 100644 --- a/REVIEWING.md +++ b/REVIEWING.md @@ -168,7 +168,7 @@ In this section we will be talking about changed "types", but by that we mean an #### API Reports -We generate API Reports using the [API Extractor](https://api-extractor.com/) tool. These reports are generated for most packages in the Backstage repository, and are stored in the `api-report.api.md` file of each package. For CLI package we use custom tooling, and instead store the result in `cli-report.md`. Whenever the public API of a package changes, the API Report needs to be updated to reflect the new state of the API. Our CI checks will fail if the API reports are not up to date in a pull request. +We generate API Reports using the [API Extractor](https://api-extractor.com/) tool. These reports are generated for most packages in the Backstage repository, and are stored in the `report.api.md` file of each package. For CLI package we use custom tooling, and instead store the result in `cli-report.md`. Whenever the public API of a package changes, the API Report needs to be updated to reflect the new state of the API. Our CI checks will fail if the API reports are not up to date in a pull request. Each API report contains a list of all the exported types of each package. As long as the API report does not have any warnings it will contain the full publicly facing API of the package, meaning you do not need to consider any other changes to the package from the point of view of TypeScript API stability. From d427b560739b4538253ba04533bd5dbec80056ed Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 15:23:56 +0200 Subject: [PATCH 08/13] update docs Signed-off-by: secustor --- REVIEWING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/REVIEWING.md b/REVIEWING.md index 7517791ebd..66af880f43 100644 --- a/REVIEWING.md +++ b/REVIEWING.md @@ -68,7 +68,7 @@ In general our changeset feedback bot will take care of informing whether a chan Changes that do NOT need a new changeset: -- Changes to any test, storybook, or other local development files, for example, `MyComponent.test.tsx`, `MyComponent.stories.tsx`, `**mocks**/MyMock.ts`, `.eslintrc.js`, `setupTests.ts`, or `api-report.api.md`. Explained differently, it is only files that affect the published package that need changesets, such as source files and additional resources like `package.json`, `README.md`, `config.d.ts`, etc. +- Changes to any test, storybook, or other local development files, for example, `MyComponent.test.tsx`, `MyComponent.stories.tsx`, `**mocks**/MyMock.ts`, `.eslintrc.js`, `setupTests.ts`, or `report.api.md`. Explained differently, it is only files that affect the published package that need changesets, such as source files and additional resources like `package.json`, `README.md`, `config.d.ts`, etc. - When tweaking a change that has not yet been released, you can rely on and potentially modify the existing changeset instead. - Changes that do not belong to a published packages, either because it's not a package at all, such as `docs/`, or because the package is private, such as `packages/app`. - Changes that do not end up having an effect on the published package, such as whitespace fixes or code formatting changes. Although it's also fine to have a short changeset for these kind of changes too. From d784231fbc471d82e281888229ad4a29d19e76e2 Mon Sep 17 00:00:00 2001 From: secustor Date: Fri, 26 Jul 2024 15:43:53 +0200 Subject: [PATCH 09/13] fixup microsite links Signed-off-by: secustor --- .../03-common-extension-blueprints.md | 6 +++--- plugins/api-docs/README-alpha.md | 14 +++++++------- plugins/org/README-alpha.md | 8 ++++---- scripts/list-backend-feature.js | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/frontend-system/building-plugins/03-common-extension-blueprints.md b/docs/frontend-system/building-plugins/03-common-extension-blueprints.md index 5193fd85b1..d08de7012d 100644 --- a/docs/frontend-system/building-plugins/03-common-extension-blueprints.md +++ b/docs/frontend-system/building-plugins/03-common-extension-blueprints.md @@ -50,14 +50,14 @@ Translation extension provide custom translation messages for the app. They can These are the [extension blueprints](../architecture/23-extension-blueprints.md) provided by the Backstage core feature plugins. -### EntityCard - [Reference](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) +### EntityCard - [Reference](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) Creates entity cards to be displayed on the entity pages of the catalog plugin. Exported as `EntityCardBlueprint`. -### EntityContent - [Reference](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) +### EntityContent - [Reference](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) Creates entity content to be displayed on the entity pages of the catalog plugin. Exported as `EntityContentBlueprint`. -### SearchResultListItem - [Reference](https://github.com/backstage/backstage/blob/master/plugins/search-react/api-report-alpha.md) +### SearchResultListItem - [Reference](https://github.com/backstage/backstage/blob/master/plugins/search-react/report-alpha.api.md) Creates search result list items for different types of search results, to be displayed in search result lists. Exported as `SearchResultListItemBlueprint`. diff --git a/plugins/api-docs/README-alpha.md b/plugins/api-docs/README-alpha.md index 07f4d5b6bc..d92fdb53da 100644 --- a/plugins/api-docs/README-alpha.md +++ b/plugins/api-docs/README-alpha.md @@ -309,7 +309,7 @@ See a complete cards list below: ##### Has Apis Entity Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders a table of entities that have an api relation with a particular Software catalog entity. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders a table of entities that have an api relation with a particular Software catalog entity. | Kind | Namespace | Name | Id | | ------------- | ---------- | ---------- | ------------------------------- | @@ -382,7 +382,7 @@ For more information about where to place extension overrides, see the official ##### Definition Entity Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders an entity api definition widget. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders an entity api definition widget. | Kind | Namespace | Name | Id | | ------------- | ---------- | ------------ | --------------------------------- | @@ -455,7 +455,7 @@ For more information about where to place extension overrides, see the official ##### Provided Apis Entity Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders a table of apis provided by a particular Software Catalog Component. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders a table of apis provided by a particular Software Catalog Component. | Kind | Namespace | Name | Id | | ------------- | ---------- | --------------- | ------------------------------------ | @@ -528,7 +528,7 @@ For more information about where to place extension overrides, see the official ##### Consumed Apis Entity Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders a table of apis consumed by a particular Software Catalog Component. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders a table of apis consumed by a particular Software Catalog Component. | Kind | Namespace | Name | Id | | ------------- | ---------- | --------------- | ------------------------------------ | @@ -601,7 +601,7 @@ For more information about where to place extension overrides, see the official ##### Providing Components Entity Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders a table of components that provides a particular Software Catalog api. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders a table of components that provides a particular Software Catalog api. | Kind | Namespace | Name | Id | | ------------- | ---------- | ---------------------- | ------------------------------------------- | @@ -676,7 +676,7 @@ For more information about where to place extension overrides, see the official ##### Consuming Components Entity Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders a table of components that consumes a particular Software Catalog api. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders a table of components that consumes a particular Software Catalog api. | Kind | Namespace | Name | Id | | ------------- | ---------- | ---------------------- | ------------------------------------------- | @@ -760,7 +760,7 @@ See a complete contents list below: ##### Definition Entity Content -An [entity content](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that renders a tab in the entity page showing a particular entity api definition. +An [entity content](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that renders a tab in the entity page showing a particular entity api definition. | Kind | Namespace | Name | Id | | ---------------- | ---------- | ------------ | ------------------------------------ | diff --git a/plugins/org/README-alpha.md b/plugins/org/README-alpha.md index 91aaa28167..942192252b 100644 --- a/plugins/org/README-alpha.md +++ b/plugins/org/README-alpha.md @@ -90,7 +90,7 @@ Route binding is also possible through code. For more information, see [this](ht ### Entity Group Profile Card -This [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension allows you to view, edit, or update groups metadata, such as team avatar, name, email, parent, and child groups. +This [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension allows you to view, edit, or update groups metadata, such as team avatar, name, email, parent, and child groups. | Kind | Namespace | Name | Id | | ------------- | --------- | --------------- | ------------------------------- | @@ -142,7 +142,7 @@ For more information about where to place extension overrides, see the official ### Entity Members List Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that displays the names and emails of group members. By clicking the member's name, you'll be directed to the user's catalog page, and the email opens your default email program. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that displays the names and emails of group members. By clicking the member's name, you'll be directed to the user's catalog page, and the email opens your default email program. | Kind | Namespace | Name | Id | | ------------- | --------- | -------------- | ------------------------------ | @@ -194,7 +194,7 @@ For more information about where to place extension overrides, see the official ### Entity Ownership Card -An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension that displays direct or aggregated group or user ownership relationships. Each entity listed in the card links to its respective entity page in the catalog. +An [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension that displays direct or aggregated group or user ownership relationships. Each entity listed in the card links to its respective entity page in the catalog. | Kind | Namespace | Name | Id | | ------------- | --------- | ----------- | --------------------------- | @@ -246,7 +246,7 @@ For more information about where to place extension overrides, see the official ### Entity User Profile Card -This [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md) extension allows you to view user metadata including avatar, name, email, and team. Clicking on the email link will open your default email program while clicking on the team link will direct you to the team page in the catalog plugin. +This [entity card](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/report-alpha.api.md) extension allows you to view user metadata including avatar, name, email, and team. Clicking on the email link will open your default email program while clicking on the team link will direct you to the team page in the catalog plugin. | Kind | Namespace | Name | Id | | ------------- | --------- | -------------- | ------------------------------ | diff --git a/scripts/list-backend-feature.js b/scripts/list-backend-feature.js index 53cff217b1..91bce6852b 100644 --- a/scripts/list-backend-feature.js +++ b/scripts/list-backend-feature.js @@ -52,7 +52,7 @@ async function main(args) { backendFeatureReport.alpha = false; } - const apiReportAlphaPath = join(pkg.dir, 'api-report-alpha.md'); + const apiReportAlphaPath = join(pkg.dir, 'report-alpha.api.md'); if (fs.existsSync(apiReportAlphaPath)) { const apiReportAlpha = ( await fs.readFile(apiReportAlphaPath) From 831571c2512e0396cfe9f9be0d1d7ff61f17d5f9 Mon Sep 17 00:00:00 2001 From: secustor Date: Mon, 23 Sep 2024 14:54:45 +0200 Subject: [PATCH 10/13] merge new changes Signed-off-by: secustor --- .../app-next-example-plugin/report.api.md | 2 +- packages/backend-app-api/report-alpha.api.md | 2 +- packages/backend-app-api/report.api.md | 10 + .../backend-defaults/report-discovery.api.md | 4 +- .../backend-defaults/report-urlReader.api.md | 6 +- packages/backend-defaults/report.api.md | 4 + .../report.api.md | 76 +- packages/backend-plugin-api/report.api.md | 47 +- packages/backend-test-utils/report.api.md | 126 +- .../catalog-client/api-report-testUtils.md | 71 - packages/cli-node/report.api.md | 18 +- packages/config-loader/report.api.md | 12 +- packages/core-compat-api/report.api.md | 2 + packages/core-components/report.api.md | 16 +- packages/dev-utils/report.api.md | 3 +- packages/frontend-app-api/report.api.md | 4 + packages/frontend-defaults/api-report.md | 43 - packages/frontend-plugin-api/report.api.md | 1737 ++++++++++------- packages/frontend-test-utils/report.api.md | 14 +- plugins/api-docs/report-alpha.api.md | 2 +- plugins/api-docs/report.api.md | 17 +- plugins/app-backend/report.api.md | 12 +- plugins/app-visualizer/report.api.md | 2 +- plugins/app/api-report.md | 713 ------- .../api-report.md | 25 - .../api-report.md | 33 - plugins/auth-backend/report.api.md | 32 +- plugins/bitbucket-cloud-common/api-report.md | 485 ----- plugins/bitbucket-cloud-common/report.api.md | 170 +- .../catalog-backend-module-aws/report.api.md | 4 +- .../report.api.md | 4 +- .../report.api.md | 6 +- .../report.api.md | 4 +- .../report.api.md | 10 +- .../report.api.md | 42 +- .../report.api.md | 36 +- .../report.api.md | 4 +- .../catalog-backend-module-ldap/report.api.md | 11 +- .../report.api.md | 2 +- .../report.api.md | 10 +- plugins/catalog-backend/report.api.md | 16 +- plugins/catalog-graph/report-alpha.api.md | 2 +- plugins/catalog-graph/report.api.md | 5 +- plugins/catalog-import/report-alpha.api.md | 2 +- plugins/catalog-node/api-report-testUtils.md | 27 - plugins/catalog-node/report-alpha.api.md | 32 +- plugins/catalog-node/report.api.md | 14 +- plugins/catalog-react/report-alpha.api.md | 5 +- plugins/catalog-react/report.api.md | 15 +- plugins/catalog/report-alpha.api.md | 5 +- plugins/catalog/report.api.md | 95 +- plugins/devtools-backend/report.api.md | 16 +- plugins/devtools/report-alpha.api.md | 2 +- plugins/home/report-alpha.api.md | 4 +- plugins/kubernetes-backend/report.api.md | 14 +- plugins/kubernetes/report-alpha.api.md | 2 +- plugins/notifications/report.api.md | 24 + plugins/org/report-alpha.api.md | 2 +- plugins/org/report.api.md | 4 +- plugins/permission-node/report.api.md | 6 +- plugins/proxy-backend/report.api.md | 12 +- plugins/scaffolder-backend/report.api.md | 113 +- plugins/scaffolder-node/report.api.md | 1 + plugins/scaffolder/report-alpha.api.md | 6 +- .../report.api.md | 10 +- .../report.api.md | 28 +- .../report.api.md | 1 + .../search-backend-module-pg/report.api.md | 16 +- .../report.api.md | 8 +- plugins/search-backend-node/report.api.md | 6 +- plugins/search-backend/report.api.md | 4 +- plugins/search-react/report-alpha.api.md | 7 + plugins/search-react/report.api.md | 3 +- plugins/search/report-alpha.api.md | 8 +- plugins/search/report.api.md | 14 +- plugins/signals-backend/report.api.md | 20 +- plugins/signals/report.api.md | 1 + plugins/techdocs-backend/report.api.md | 10 +- plugins/techdocs-common/api-report.md | 11 - plugins/techdocs/report-alpha.api.md | 4 +- plugins/techdocs/report.api.md | 2 +- plugins/user-settings-backend/report.api.md | 7 - plugins/user-settings/report-alpha.api.md | 4 +- yarn.lock | 257 +-- 84 files changed, 1816 insertions(+), 2850 deletions(-) delete mode 100644 packages/catalog-client/api-report-testUtils.md delete mode 100644 packages/frontend-defaults/api-report.md delete mode 100644 plugins/app/api-report.md delete mode 100644 plugins/auth-backend-module-auth0-provider/api-report.md delete mode 100644 plugins/auth-backend-module-bitbucket-server-provider/api-report.md delete mode 100644 plugins/bitbucket-cloud-common/api-report.md delete mode 100644 plugins/catalog-node/api-report-testUtils.md delete mode 100644 plugins/techdocs-common/api-report.md diff --git a/packages/app-next-example-plugin/report.api.md b/packages/app-next-example-plugin/report.api.md index 842e58aeb5..3094fee56e 100644 --- a/packages/app-next-example-plugin/report.api.md +++ b/packages/app-next-example-plugin/report.api.md @@ -55,7 +55,7 @@ export const ExampleSidebarItem: () => React_2.JSX.Element; // Warnings were encountered during analysis: // // src/ExampleSidebarItem.d.ts:3:22 - (ae-undocumented) Missing documentation for "ExampleSidebarItem". -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "examplePlugin". +// src/plugin.d.ts:22:22 - (ae-undocumented) Missing documentation for "examplePlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/report-alpha.api.md b/packages/backend-app-api/report-alpha.api.md index 12a4b66d68..e3f11bb800 100644 --- a/packages/backend-app-api/report-alpha.api.md +++ b/packages/backend-app-api/report-alpha.api.md @@ -15,7 +15,7 @@ export const featureDiscoveryServiceFactory: ServiceFactory< // Warnings were encountered during analysis: // -// src/alpha/featureDiscoveryServiceFactory.d.ts:3:22 - (ae-undocumented) Missing documentation for "featureDiscoveryServiceFactory". +// src/alpha/featureDiscoveryServiceFactory.d.ts:5:22 - (ae-undocumented) Missing documentation for "featureDiscoveryServiceFactory". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/report.api.md b/packages/backend-app-api/report.api.md index 88fa34e6e4..ec32ec9b67 100644 --- a/packages/backend-app-api/report.api.md +++ b/packages/backend-app-api/report.api.md @@ -32,4 +32,14 @@ export interface CreateSpecializedBackendOptions { // (undocumented) defaultServiceFactories: ServiceFactory[]; } + +// Warnings were encountered during analysis: +// +// src/wiring/createSpecializedBackend.d.ts:5:1 - (ae-undocumented) Missing documentation for "createSpecializedBackend". +// src/wiring/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "Backend". +// src/wiring/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "add". +// src/wiring/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". +// src/wiring/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "stop". +// src/wiring/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "CreateSpecializedBackendOptions". +// src/wiring/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "defaultServiceFactories". ``` diff --git a/packages/backend-defaults/report-discovery.api.md b/packages/backend-defaults/report-discovery.api.md index fe7d639ebc..e39d281b4e 100644 --- a/packages/backend-defaults/report-discovery.api.md +++ b/packages/backend-defaults/report-discovery.api.md @@ -25,8 +25,8 @@ export class HostDiscovery implements DiscoveryService { // Warnings were encountered during analysis: // -// src/entrypoints/discovery/HostDiscovery.d.ts:46:5 - (ae-undocumented) Missing documentation for "getBaseUrl". -// src/entrypoints/discovery/HostDiscovery.d.ts:47:5 - (ae-undocumented) Missing documentation for "getExternalBaseUrl". +// src/entrypoints/discovery/HostDiscovery.d.ts:44:5 - (ae-undocumented) Missing documentation for "getBaseUrl". +// src/entrypoints/discovery/HostDiscovery.d.ts:45:5 - (ae-undocumented) Missing documentation for "getExternalBaseUrl". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-urlReader.api.md b/packages/backend-defaults/report-urlReader.api.md index 029332e12f..7b41ce33e4 100644 --- a/packages/backend-defaults/report-urlReader.api.md +++ b/packages/backend-defaults/report-urlReader.api.md @@ -516,9 +516,9 @@ export type UrlReadersOptions = { // src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". // src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". // src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/types.d.ts:75:5 - (ae-undocumented) Missing documentation for "fromTarArchive". -// src/entrypoints/urlReader/lib/types.d.ts:82:5 - (ae-undocumented) Missing documentation for "fromZipArchive". -// src/entrypoints/urlReader/lib/types.d.ts:83:5 - (ae-undocumented) Missing documentation for "fromReadableArray". +// src/entrypoints/urlReader/lib/types.d.ts:74:5 - (ae-undocumented) Missing documentation for "fromTarArchive". +// src/entrypoints/urlReader/lib/types.d.ts:81:5 - (ae-undocumented) Missing documentation for "fromZipArchive". +// src/entrypoints/urlReader/lib/types.d.ts:82:5 - (ae-undocumented) Missing documentation for "fromReadableArray". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report.api.md b/packages/backend-defaults/report.api.md index def38beda7..9878336d27 100644 --- a/packages/backend-defaults/report.api.md +++ b/packages/backend-defaults/report.api.md @@ -11,4 +11,8 @@ export function createBackend(): Backend; // @public export const discoveryFeatureLoader: BackendFeature; + +// Warnings were encountered during analysis: +// +// src/CreateBackend.d.ts:6:1 - (ae-undocumented) Missing documentation for "createBackend". ``` diff --git a/packages/backend-dynamic-feature-service/report.api.md b/packages/backend-dynamic-feature-service/report.api.md index 5093458a6c..9170fedf43 100644 --- a/packages/backend-dynamic-feature-service/report.api.md +++ b/packages/backend-dynamic-feature-service/report.api.md @@ -293,42 +293,43 @@ export interface ScannedPluginPackage { // src/manager/plugin-manager.d.ts:31:5 - (ae-undocumented) Missing documentation for "backendPlugins". // src/manager/plugin-manager.d.ts:32:5 - (ae-undocumented) Missing documentation for "frontendPlugins". // src/manager/plugin-manager.d.ts:33:5 - (ae-undocumented) Missing documentation for "plugins". -// src/manager/plugin-manager.d.ts:38:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceRef". -// src/manager/plugin-manager.d.ts:42:1 - (ae-undocumented) Missing documentation for "DynamicPluginsFactoryOptions". -// src/manager/plugin-manager.d.ts:43:5 - (ae-undocumented) Missing documentation for "moduleLoader". -// src/manager/plugin-manager.d.ts:48:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceFactory". -// src/manager/plugin-manager.d.ts:52:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFeatureDiscoveryServiceFactory". -// src/manager/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "LegacyPluginEnvironment". -// src/manager/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "DynamicPluginProvider". -// src/manager/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "plugins". -// src/manager/types.d.ts:52:1 - (ae-undocumented) Missing documentation for "BackendPluginProvider". -// src/manager/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "backendPlugins". -// src/manager/types.d.ts:58:1 - (ae-undocumented) Missing documentation for "FrontendPluginProvider". -// src/manager/types.d.ts:59:5 - (ae-undocumented) Missing documentation for "frontendPlugins". -// src/manager/types.d.ts:64:1 - (ae-undocumented) Missing documentation for "BaseDynamicPlugin". -// src/manager/types.d.ts:65:5 - (ae-undocumented) Missing documentation for "name". -// src/manager/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "version". -// src/manager/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "role". -// src/manager/types.d.ts:68:5 - (ae-undocumented) Missing documentation for "platform". -// src/manager/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "DynamicPlugin". -// src/manager/types.d.ts:77:1 - (ae-undocumented) Missing documentation for "FrontendDynamicPlugin". -// src/manager/types.d.ts:78:5 - (ae-undocumented) Missing documentation for "platform". -// src/manager/types.d.ts:83:1 - (ae-undocumented) Missing documentation for "BackendDynamicPlugin". -// src/manager/types.d.ts:84:5 - (ae-undocumented) Missing documentation for "platform". -// src/manager/types.d.ts:85:5 - (ae-undocumented) Missing documentation for "installer". -// src/manager/types.d.ts:90:1 - (ae-undocumented) Missing documentation for "BackendDynamicPluginInstaller". -// src/manager/types.d.ts:94:1 - (ae-undocumented) Missing documentation for "NewBackendPluginInstaller". -// src/manager/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "kind". -// src/manager/types.d.ts:96:5 - (ae-undocumented) Missing documentation for "install". -// src/manager/types.d.ts:109:1 - (ae-undocumented) Missing documentation for "LegacyBackendPluginInstaller". -// src/manager/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "kind". -// src/manager/types.d.ts:111:5 - (ae-undocumented) Missing documentation for "router". -// src/manager/types.d.ts:115:5 - (ae-undocumented) Missing documentation for "catalog". -// src/manager/types.d.ts:116:5 - (ae-undocumented) Missing documentation for "scaffolder". -// src/manager/types.d.ts:117:5 - (ae-undocumented) Missing documentation for "search". -// src/manager/types.d.ts:118:5 - (ae-undocumented) Missing documentation for "events". -// src/manager/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "permissions". -// src/manager/types.d.ts:126:1 - (ae-undocumented) Missing documentation for "isBackendDynamicPluginInstaller". +// src/manager/plugin-manager.d.ts:39:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceRef". +// src/manager/plugin-manager.d.ts:43:1 - (ae-undocumented) Missing documentation for "DynamicPluginsFactoryOptions". +// src/manager/plugin-manager.d.ts:44:5 - (ae-undocumented) Missing documentation for "moduleLoader". +// src/manager/plugin-manager.d.ts:50:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceFactoryWithOptions". +// src/manager/plugin-manager.d.ts:55:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceFactory". +// src/manager/plugin-manager.d.ts:60:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFeatureDiscoveryServiceFactory". +// src/manager/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "LegacyPluginEnvironment". +// src/manager/types.d.ts:45:1 - (ae-undocumented) Missing documentation for "DynamicPluginProvider". +// src/manager/types.d.ts:46:5 - (ae-undocumented) Missing documentation for "plugins". +// src/manager/types.d.ts:51:1 - (ae-undocumented) Missing documentation for "BackendPluginProvider". +// src/manager/types.d.ts:52:5 - (ae-undocumented) Missing documentation for "backendPlugins". +// src/manager/types.d.ts:57:1 - (ae-undocumented) Missing documentation for "FrontendPluginProvider". +// src/manager/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "frontendPlugins". +// src/manager/types.d.ts:63:1 - (ae-undocumented) Missing documentation for "BaseDynamicPlugin". +// src/manager/types.d.ts:64:5 - (ae-undocumented) Missing documentation for "name". +// src/manager/types.d.ts:65:5 - (ae-undocumented) Missing documentation for "version". +// src/manager/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "role". +// src/manager/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "platform". +// src/manager/types.d.ts:72:1 - (ae-undocumented) Missing documentation for "DynamicPlugin". +// src/manager/types.d.ts:76:1 - (ae-undocumented) Missing documentation for "FrontendDynamicPlugin". +// src/manager/types.d.ts:77:5 - (ae-undocumented) Missing documentation for "platform". +// src/manager/types.d.ts:82:1 - (ae-undocumented) Missing documentation for "BackendDynamicPlugin". +// src/manager/types.d.ts:83:5 - (ae-undocumented) Missing documentation for "platform". +// src/manager/types.d.ts:84:5 - (ae-undocumented) Missing documentation for "installer". +// src/manager/types.d.ts:89:1 - (ae-undocumented) Missing documentation for "BackendDynamicPluginInstaller". +// src/manager/types.d.ts:93:1 - (ae-undocumented) Missing documentation for "NewBackendPluginInstaller". +// src/manager/types.d.ts:94:5 - (ae-undocumented) Missing documentation for "kind". +// src/manager/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "install". +// src/manager/types.d.ts:108:1 - (ae-undocumented) Missing documentation for "LegacyBackendPluginInstaller". +// src/manager/types.d.ts:109:5 - (ae-undocumented) Missing documentation for "kind". +// src/manager/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "router". +// src/manager/types.d.ts:114:5 - (ae-undocumented) Missing documentation for "catalog". +// src/manager/types.d.ts:115:5 - (ae-undocumented) Missing documentation for "scaffolder". +// src/manager/types.d.ts:116:5 - (ae-undocumented) Missing documentation for "search". +// src/manager/types.d.ts:117:5 - (ae-undocumented) Missing documentation for "events". +// src/manager/types.d.ts:118:5 - (ae-undocumented) Missing documentation for "permissions". +// src/manager/types.d.ts:125:1 - (ae-undocumented) Missing documentation for "isBackendDynamicPluginInstaller". // src/scanner/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScannedPluginPackage". // src/scanner/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "location". // src/scanner/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "manifest". @@ -338,7 +339,8 @@ export interface ScannedPluginPackage { // src/schemas/schemas.d.ts:7:1 - (ae-undocumented) Missing documentation for "DynamicPluginsSchemasService". // src/schemas/schemas.d.ts:8:5 - (ae-undocumented) Missing documentation for "addDynamicPluginsSchemas". // src/schemas/schemas.d.ts:21:1 - (ae-undocumented) Missing documentation for "DynamicPluginsSchemasOptions". -// src/schemas/schemas.d.ts:36:22 - (ae-undocumented) Missing documentation for "dynamicPluginsSchemasServiceFactory". +// src/schemas/schemas.d.ts:36:22 - (ae-undocumented) Missing documentation for "dynamicPluginsSchemasServiceFactoryWithOptions". +// src/schemas/schemas.d.ts:40:22 - (ae-undocumented) Missing documentation for "dynamicPluginsSchemasServiceFactory". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-plugin-api/report.api.md b/packages/backend-plugin-api/report.api.md index 7cd89364d0..e03179e851 100644 --- a/packages/backend-plugin-api/report.api.md +++ b/packages/backend-plugin-api/report.api.md @@ -738,9 +738,6 @@ export interface UserInfoService { // Warnings were encountered during analysis: // -// src/deprecated.d.ts:6:1 - (ae-undocumented) Missing documentation for "ServiceRefConfig". -// src/deprecated.d.ts:11:1 - (ae-undocumented) Missing documentation for "RootServiceFactoryConfig". -// src/deprecated.d.ts:18:1 - (ae-undocumented) Missing documentation for "PluginServiceFactoryConfig". // src/services/definitions/HttpRouterService.d.ts:8:5 - (ae-undocumented) Missing documentation for "path". // src/services/definitions/HttpRouterService.d.ts:9:5 - (ae-undocumented) Missing documentation for "allow". // src/services/definitions/LifecycleService.d.ts:5:1 - (ae-undocumented) Missing documentation for "LifecycleServiceStartupHook". @@ -754,26 +751,15 @@ export interface UserInfoService { // src/services/definitions/LoggerService.d.ts:14:5 - (ae-undocumented) Missing documentation for "child". // src/services/definitions/PermissionsService.d.ts:9:5 - (ae-undocumented) Missing documentation for "credentials". // src/services/definitions/RootHealthService.d.ts:5:1 - (ae-undocumented) Missing documentation for "RootHealthService". -// src/services/definitions/UrlReaderService.d.ts:323:1 - (ae-undocumented) Missing documentation for "ReadTreeOptions". -// src/services/definitions/UrlReaderService.d.ts:328:1 - (ae-undocumented) Missing documentation for "ReadTreeResponse". -// src/services/definitions/UrlReaderService.d.ts:333:1 - (ae-undocumented) Missing documentation for "ReadTreeResponseDirOptions". -// src/services/definitions/UrlReaderService.d.ts:338:1 - (ae-undocumented) Missing documentation for "ReadTreeResponseFile". -// src/services/definitions/UrlReaderService.d.ts:343:1 - (ae-undocumented) Missing documentation for "ReadUrlResponse". -// src/services/definitions/UrlReaderService.d.ts:348:1 - (ae-undocumented) Missing documentation for "ReadUrlOptions". -// src/services/definitions/UrlReaderService.d.ts:353:1 - (ae-undocumented) Missing documentation for "SearchOptions". -// src/services/definitions/UrlReaderService.d.ts:358:1 - (ae-undocumented) Missing documentation for "SearchResponse". -// src/services/definitions/UrlReaderService.d.ts:363:1 - (ae-undocumented) Missing documentation for "SearchResponseFile". // src/services/definitions/UserInfoService.d.ts:9:5 - (ae-undocumented) Missing documentation for "userEntityRef". // src/services/definitions/UserInfoService.d.ts:10:5 - (ae-undocumented) Missing documentation for "ownershipEntityRefs". -// src/services/system/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "ServiceFactory". -// src/services/system/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "service". -// src/services/system/types.d.ts:34:1 - (ae-undocumented) Missing documentation for "ServiceFactoryCompat". -// src/services/system/types.d.ts:38:5 - (ae-undocumented) Missing documentation for "__call". -// src/services/system/types.d.ts:48:1 - (ae-undocumented) Missing documentation for "ServiceRefOptions". -// src/services/system/types.d.ts:49:5 - (ae-undocumented) Missing documentation for "id". -// src/services/system/types.d.ts:50:5 - (ae-undocumented) Missing documentation for "scope". -// src/services/system/types.d.ts:51:5 - (ae-undocumented) Missing documentation for "defaultFactory". -// src/services/system/types.d.ts:55:5 - (ae-undocumented) Missing documentation for "defaultFactory". +// src/services/system/types.d.ts:35:1 - (ae-undocumented) Missing documentation for "ServiceFactory". +// src/services/system/types.d.ts:36:5 - (ae-undocumented) Missing documentation for "service". +// src/services/system/types.d.ts:39:1 - (ae-undocumented) Missing documentation for "ServiceRefOptions". +// src/services/system/types.d.ts:40:5 - (ae-undocumented) Missing documentation for "id". +// src/services/system/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "scope". +// src/services/system/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "multiton". +// src/services/system/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "defaultFactory". // src/services/system/types.d.ts:76:1 - (ae-undocumented) Missing documentation for "RootServiceFactoryOptions". // src/services/system/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "service". // src/services/system/types.d.ts:91:5 - (ae-undocumented) Missing documentation for "deps". @@ -785,15 +771,12 @@ export interface UserInfoService { // src/services/system/types.d.ts:112:5 - (ae-undocumented) Missing documentation for "factory". // src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BackendFeature". // src/types.d.ts:3:5 - (ae-undocumented) Missing documentation for "$$type". -// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "BackendFeatureCompat". -// src/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "__call". -// src/wiring/factories.d.ts:39:5 - (ae-undocumented) Missing documentation for "register". -// src/wiring/factories.d.ts:67:5 - (ae-undocumented) Missing documentation for "register". -// src/wiring/index.d.ts:9:1 - (ae-undocumented) Missing documentation for "BackendPluginConfig". -// src/wiring/index.d.ts:14:1 - (ae-undocumented) Missing documentation for "BackendModuleConfig". -// src/wiring/index.d.ts:19:1 - (ae-undocumented) Missing documentation for "ExtensionPointConfig". -// src/wiring/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". -// src/wiring/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "registerInit". -// src/wiring/types.d.ts:39:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". -// src/wiring/types.d.ts:40:5 - (ae-undocumented) Missing documentation for "registerInit". +// src/wiring/createBackendFeatureLoader.d.ts:10:5 - (ae-undocumented) Missing documentation for "deps". +// src/wiring/createBackendFeatureLoader.d.ts:13:5 - (ae-undocumented) Missing documentation for "loader". +// src/wiring/createBackendModule.d.ts:21:5 - (ae-undocumented) Missing documentation for "register". +// src/wiring/createBackendPlugin.d.ts:17:5 - (ae-undocumented) Missing documentation for "register". +// src/wiring/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". +// src/wiring/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "registerInit". +// src/wiring/types.d.ts:44:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". +// src/wiring/types.d.ts:45:5 - (ae-undocumented) Missing documentation for "registerInit". ``` diff --git a/packages/backend-test-utils/report.api.md b/packages/backend-test-utils/report.api.md index 1234297c2e..1235cd7cb3 100644 --- a/packages/backend-test-utils/report.api.md +++ b/packages/backend-test-utils/report.api.md @@ -483,9 +483,6 @@ export class TestDatabases { // src/database/TestDatabases.d.ts:29:5 - (ae-undocumented) Missing documentation for "setDefaults". // src/database/TestDatabases.d.ts:33:5 - (ae-undocumented) Missing documentation for "supports". // src/database/TestDatabases.d.ts:34:5 - (ae-undocumented) Missing documentation for "eachSupportedId". -// src/deprecated.d.ts:6:1 - (ae-undocumented) Missing documentation for "MockDirectoryOptions". -// src/deprecated.d.ts:11:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". -// src/deprecated.d.ts:20:1 - (ae-undocumented) Missing documentation for "isDockerDisabledForTests". // src/next/services/mockCredentials.d.ts:17:1 - (ae-undocumented) Missing documentation for "mockCredentials". // src/next/services/mockCredentials.d.ts:58:9 - (ae-undocumented) Missing documentation for "invalidToken". // src/next/services/mockCredentials.d.ts:59:9 - (ae-undocumented) Missing documentation for "invalidHeader". @@ -499,70 +496,63 @@ export class TestDatabases { // src/next/services/mockServices.d.ts:15:5 - (ae-undocumented) Missing documentation for "rootConfig". // src/next/services/mockServices.d.ts:16:9 - (ae-undocumented) Missing documentation for "Options". // src/next/services/mockServices.d.ts:19:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:21:5 - (ae-undocumented) Missing documentation for "rootLogger". +// src/next/services/mockServices.d.ts:20:15 - (ae-undocumented) Missing documentation for "mock". // src/next/services/mockServices.d.ts:22:5 - (ae-undocumented) Missing documentation for "rootLogger". -// src/next/services/mockServices.d.ts:23:9 - (ae-undocumented) Missing documentation for "Options". -// src/next/services/mockServices.d.ts:26:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:27:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:29:5 - (ae-undocumented) Missing documentation for "tokenManager". -// src/next/services/mockServices.d.ts:30:5 - (ae-undocumented) Missing documentation for "tokenManager". -// src/next/services/mockServices.d.ts:31:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:32:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:34:5 - (ae-undocumented) Missing documentation for "identity". -// src/next/services/mockServices.d.ts:35:5 - (ae-undocumented) Missing documentation for "identity". -// src/next/services/mockServices.d.ts:36:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:37:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:39:5 - (ae-undocumented) Missing documentation for "auth". -// src/next/services/mockServices.d.ts:43:5 - (ae-undocumented) Missing documentation for "auth". -// src/next/services/mockServices.d.ts:44:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:45:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:47:5 - (ae-undocumented) Missing documentation for "discovery". -// src/next/services/mockServices.d.ts:48:5 - (ae-undocumented) Missing documentation for "discovery". -// src/next/services/mockServices.d.ts:49:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:50:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:70:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/next/services/mockServices.d.ts:81:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:91:5 - (ae-undocumented) Missing documentation for "userInfo". -// src/next/services/mockServices.d.ts:99:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:101:5 - (ae-undocumented) Missing documentation for "cache". -// src/next/services/mockServices.d.ts:102:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:103:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:105:5 - (ae-undocumented) Missing documentation for "database". -// src/next/services/mockServices.d.ts:106:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:107:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:109:5 - (ae-undocumented) Missing documentation for "rootHealth". -// src/next/services/mockServices.d.ts:110:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:111:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:113:5 - (ae-undocumented) Missing documentation for "httpRouter". -// src/next/services/mockServices.d.ts:114:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:115:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:117:5 - (ae-undocumented) Missing documentation for "rootHttpRouter". -// src/next/services/mockServices.d.ts:118:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:119:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:121:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/next/services/mockServices.d.ts:122:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:123:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:125:5 - (ae-undocumented) Missing documentation for "logger". -// src/next/services/mockServices.d.ts:126:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:127:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:129:5 - (ae-undocumented) Missing documentation for "permissions". -// src/next/services/mockServices.d.ts:130:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:131:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:133:5 - (ae-undocumented) Missing documentation for "rootLifecycle". -// src/next/services/mockServices.d.ts:134:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:135:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:137:5 - (ae-undocumented) Missing documentation for "scheduler". -// src/next/services/mockServices.d.ts:138:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:139:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:141:5 - (ae-undocumented) Missing documentation for "urlReader". -// src/next/services/mockServices.d.ts:142:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:143:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:145:5 - (ae-undocumented) Missing documentation for "events". -// src/next/services/mockServices.d.ts:146:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:147:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/wiring/TestBackend.d.ts:4:1 - (ae-undocumented) Missing documentation for "TestBackendOptions". -// src/next/wiring/TestBackend.d.ts:5:5 - (ae-undocumented) Missing documentation for "extensionPoints". -// src/next/wiring/TestBackend.d.ts:13:5 - (ae-undocumented) Missing documentation for "features". -// src/next/wiring/TestBackend.d.ts:18:1 - (ae-undocumented) Missing documentation for "TestBackend". -// src/next/wiring/TestBackend.d.ts:29:1 - (ae-undocumented) Missing documentation for "startTestBackend". +// src/next/services/mockServices.d.ts:23:5 - (ae-undocumented) Missing documentation for "rootLogger". +// src/next/services/mockServices.d.ts:24:9 - (ae-undocumented) Missing documentation for "Options". +// src/next/services/mockServices.d.ts:27:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:28:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:30:5 - (ae-undocumented) Missing documentation for "auth". +// src/next/services/mockServices.d.ts:34:5 - (ae-undocumented) Missing documentation for "auth". +// src/next/services/mockServices.d.ts:35:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:36:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:38:5 - (ae-undocumented) Missing documentation for "discovery". +// src/next/services/mockServices.d.ts:39:5 - (ae-undocumented) Missing documentation for "discovery". +// src/next/services/mockServices.d.ts:40:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:41:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:61:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/next/services/mockServices.d.ts:72:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:82:5 - (ae-undocumented) Missing documentation for "userInfo". +// src/next/services/mockServices.d.ts:90:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:92:5 - (ae-undocumented) Missing documentation for "cache". +// src/next/services/mockServices.d.ts:93:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:94:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:96:5 - (ae-undocumented) Missing documentation for "database". +// src/next/services/mockServices.d.ts:97:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:98:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:100:5 - (ae-undocumented) Missing documentation for "rootHealth". +// src/next/services/mockServices.d.ts:101:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:102:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:104:5 - (ae-undocumented) Missing documentation for "httpRouter". +// src/next/services/mockServices.d.ts:105:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:106:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:108:5 - (ae-undocumented) Missing documentation for "rootHttpRouter". +// src/next/services/mockServices.d.ts:109:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:110:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:112:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/next/services/mockServices.d.ts:113:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:114:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:116:5 - (ae-undocumented) Missing documentation for "logger". +// src/next/services/mockServices.d.ts:117:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:118:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:120:5 - (ae-undocumented) Missing documentation for "permissions". +// src/next/services/mockServices.d.ts:121:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:122:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:124:5 - (ae-undocumented) Missing documentation for "rootLifecycle". +// src/next/services/mockServices.d.ts:125:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:126:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:128:5 - (ae-undocumented) Missing documentation for "scheduler". +// src/next/services/mockServices.d.ts:129:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:130:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:132:5 - (ae-undocumented) Missing documentation for "urlReader". +// src/next/services/mockServices.d.ts:133:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:134:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/services/mockServices.d.ts:136:5 - (ae-undocumented) Missing documentation for "events". +// src/next/services/mockServices.d.ts:137:15 - (ae-undocumented) Missing documentation for "factory". +// src/next/services/mockServices.d.ts:138:15 - (ae-undocumented) Missing documentation for "mock". +// src/next/wiring/TestBackend.d.ts:5:1 - (ae-undocumented) Missing documentation for "TestBackendOptions". +// src/next/wiring/TestBackend.d.ts:6:5 - (ae-undocumented) Missing documentation for "extensionPoints". +// src/next/wiring/TestBackend.d.ts:14:5 - (ae-undocumented) Missing documentation for "features". +// src/next/wiring/TestBackend.d.ts:19:1 - (ae-undocumented) Missing documentation for "TestBackend". +// src/next/wiring/TestBackend.d.ts:30:1 - (ae-undocumented) Missing documentation for "startTestBackend". ``` diff --git a/packages/catalog-client/api-report-testUtils.md b/packages/catalog-client/api-report-testUtils.md deleted file mode 100644 index 88d14b4f7a..0000000000 --- a/packages/catalog-client/api-report-testUtils.md +++ /dev/null @@ -1,71 +0,0 @@ -## API Report File for "@backstage/catalog-client" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { AddLocationRequest } from '@backstage/catalog-client'; -import { AddLocationResponse } from '@backstage/catalog-client'; -import { CatalogApi } from '@backstage/catalog-client'; -import { CompoundEntityRef } from '@backstage/catalog-model'; -import { Entity } from '@backstage/catalog-model'; -import { GetEntitiesByRefsRequest } from '@backstage/catalog-client'; -import { GetEntitiesByRefsResponse } from '@backstage/catalog-client'; -import { GetEntitiesRequest } from '@backstage/catalog-client'; -import { GetEntitiesResponse } from '@backstage/catalog-client'; -import { GetEntityAncestorsRequest } from '@backstage/catalog-client'; -import { GetEntityAncestorsResponse } from '@backstage/catalog-client'; -import { GetEntityFacetsRequest } from '@backstage/catalog-client'; -import { GetEntityFacetsResponse } from '@backstage/catalog-client'; -import { Location as Location_2 } from '@backstage/catalog-client'; -import { QueryEntitiesRequest } from '@backstage/catalog-client'; -import { QueryEntitiesResponse } from '@backstage/catalog-client'; -import { ValidateEntityResponse } from '@backstage/catalog-client'; - -// @public -export class InMemoryCatalogClient implements CatalogApi { - constructor(options?: { entities?: Entity[] }); - // (undocumented) - addLocation(_location: AddLocationRequest): Promise; - // (undocumented) - getEntities(request?: GetEntitiesRequest): Promise; - // (undocumented) - getEntitiesByRefs( - request: GetEntitiesByRefsRequest, - ): Promise; - // (undocumented) - getEntityAncestors( - request: GetEntityAncestorsRequest, - ): Promise; - // (undocumented) - getEntityByRef( - entityRef: string | CompoundEntityRef, - ): Promise; - // (undocumented) - getEntityFacets( - request: GetEntityFacetsRequest, - ): Promise; - // (undocumented) - getLocationByEntity( - _entityRef: string | CompoundEntityRef, - ): Promise; - // (undocumented) - getLocationById(_id: string): Promise; - // (undocumented) - getLocationByRef(_locationRef: string): Promise; - // (undocumented) - queryEntities(request?: QueryEntitiesRequest): Promise; - // (undocumented) - refreshEntity(_entityRef: string): Promise; - // (undocumented) - removeEntityByUid(uid: string): Promise; - // (undocumented) - removeLocationById(_id: string): Promise; - // (undocumented) - validateEntity( - _entity: Entity, - _locationRef: string, - ): Promise; -} - -// (No @packageDocumentation comment for this package) -``` diff --git a/packages/cli-node/report.api.md b/packages/cli-node/report.api.md index 8a0b9bc6df..97dab9684d 100644 --- a/packages/cli-node/report.api.md +++ b/packages/cli-node/report.api.md @@ -187,15 +187,15 @@ export class PackageRoles { // src/monorepo/PackageGraph.d.ts:16:5 - (ae-undocumented) Missing documentation for "scripts". // src/monorepo/PackageGraph.d.ts:19:5 - (ae-undocumented) Missing documentation for "bundled". // src/monorepo/PackageGraph.d.ts:20:5 - (ae-undocumented) Missing documentation for "backstage". -// src/monorepo/PackageGraph.d.ts:36:5 - (ae-undocumented) Missing documentation for "exports". -// src/monorepo/PackageGraph.d.ts:37:5 - (ae-undocumented) Missing documentation for "typesVersions". -// src/monorepo/PackageGraph.d.ts:38:5 - (ae-undocumented) Missing documentation for "files". -// src/monorepo/PackageGraph.d.ts:39:5 - (ae-undocumented) Missing documentation for "publishConfig". -// src/monorepo/PackageGraph.d.ts:44:5 - (ae-undocumented) Missing documentation for "repository". -// src/monorepo/PackageGraph.d.ts:49:5 - (ae-undocumented) Missing documentation for "dependencies". -// src/monorepo/PackageGraph.d.ts:52:5 - (ae-undocumented) Missing documentation for "peerDependencies". -// src/monorepo/PackageGraph.d.ts:55:5 - (ae-undocumented) Missing documentation for "devDependencies". -// src/monorepo/PackageGraph.d.ts:58:5 - (ae-undocumented) Missing documentation for "optionalDependencies". +// src/monorepo/PackageGraph.d.ts:44:5 - (ae-undocumented) Missing documentation for "exports". +// src/monorepo/PackageGraph.d.ts:45:5 - (ae-undocumented) Missing documentation for "typesVersions". +// src/monorepo/PackageGraph.d.ts:46:5 - (ae-undocumented) Missing documentation for "files". +// src/monorepo/PackageGraph.d.ts:47:5 - (ae-undocumented) Missing documentation for "publishConfig". +// src/monorepo/PackageGraph.d.ts:52:5 - (ae-undocumented) Missing documentation for "repository". +// src/monorepo/PackageGraph.d.ts:57:5 - (ae-undocumented) Missing documentation for "dependencies". +// src/monorepo/PackageGraph.d.ts:60:5 - (ae-undocumented) Missing documentation for "peerDependencies". +// src/monorepo/PackageGraph.d.ts:63:5 - (ae-undocumented) Missing documentation for "devDependencies". +// src/monorepo/PackageGraph.d.ts:66:5 - (ae-undocumented) Missing documentation for "optionalDependencies". // src/roles/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "role". // src/roles/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "platform". // src/roles/types.d.ts:27:5 - (ae-undocumented) Missing documentation for "output". diff --git a/packages/config-loader/report.api.md b/packages/config-loader/report.api.md index 0bb88a67b3..7d7047d493 100644 --- a/packages/config-loader/report.api.md +++ b/packages/config-loader/report.api.md @@ -298,18 +298,18 @@ export type TransformFunc = ( // src/sources/ConfigSources.d.ts:74:5 - (ae-undocumented) Missing documentation for "env". // src/sources/EnvConfigSource.d.ts:46:5 - (ae-undocumented) Missing documentation for "readConfigData". // src/sources/EnvConfigSource.d.ts:47:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/FileConfigSource.d.ts:40:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/FileConfigSource.d.ts:41:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/FileConfigSource.d.ts:44:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/FileConfigSource.d.ts:45:5 - (ae-undocumented) Missing documentation for "toString". // src/sources/MutableConfigSource.d.ts:9:5 - (ae-undocumented) Missing documentation for "data". // src/sources/MutableConfigSource.d.ts:10:5 - (ae-undocumented) Missing documentation for "context". // src/sources/MutableConfigSource.d.ts:27:5 - (ae-undocumented) Missing documentation for "readConfigData". // src/sources/MutableConfigSource.d.ts:38:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/RemoteConfigSource.d.ts:39:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/RemoteConfigSource.d.ts:40:5 - (ae-undocumented) Missing documentation for "toString". +// src/sources/RemoteConfigSource.d.ts:43:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/RemoteConfigSource.d.ts:44:5 - (ae-undocumented) Missing documentation for "toString". // src/sources/StaticConfigSource.d.ts:9:5 - (ae-undocumented) Missing documentation for "data". // src/sources/StaticConfigSource.d.ts:10:5 - (ae-undocumented) Missing documentation for "context". // src/sources/StaticConfigSource.d.ts:28:5 - (ae-undocumented) Missing documentation for "readConfigData". // src/sources/StaticConfigSource.d.ts:29:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "signal". -// src/sources/types.d.ts:54:5 - (ae-undocumented) Missing documentation for "readConfigData". +// src/sources/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "signal". +// src/sources/types.d.ts:55:5 - (ae-undocumented) Missing documentation for "readConfigData". ``` diff --git a/packages/core-compat-api/report.api.md b/packages/core-compat-api/report.api.md index 6d1390fd2f..e6971975b2 100644 --- a/packages/core-compat-api/report.api.md +++ b/packages/core-compat-api/report.api.md @@ -117,6 +117,8 @@ export type ToNewRouteRef = // // src/apis/implementations/AnalyticsApi/NoOpAnalyticsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "captureEvent". // src/convertLegacyApp.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyApp". +// src/convertLegacyPageExtension.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyPageExtension". +// src/convertLegacyPlugin.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyPlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-components/report.api.md b/packages/core-components/report.api.md index 5b91140856..d71d6a1e9f 100644 --- a/packages/core-components/report.api.md +++ b/packages/core-components/report.api.md @@ -1589,10 +1589,10 @@ export type WarningPanelClassKey = // src/components/DismissableBanner/DismissableBanner.d.ts:16:22 - (ae-undocumented) Missing documentation for "DismissableBanner". // src/components/EmptyState/EmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EmptyStateClassKey". // src/components/EmptyState/EmptyStateImage.d.ts:6:1 - (ae-undocumented) Missing documentation for "EmptyStateImageClassKey". -// src/components/EmptyState/MissingAnnotationEmptyState.d.ts:10:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyStateClassKey". -// src/components/EmptyState/MissingAnnotationEmptyState.d.ts:15:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyState". +// src/components/EmptyState/MissingAnnotationEmptyState.d.ts:10:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyState". // src/components/ErrorPanel/ErrorPanel.d.ts:3:1 - (ae-undocumented) Missing documentation for "ErrorPanelClassKey". // src/components/ErrorPanel/ErrorPanel.d.ts:5:1 - (ae-undocumented) Missing documentation for "ErrorPanelProps". +// src/components/FavoriteToggle/FavoriteToggle.d.ts:6:1 - (ae-undocumented) Missing documentation for "FavoriteToggleIconClassKey". // src/components/FeatureDiscovery/FeatureCalloutCircular.d.ts:3:1 - (ae-undocumented) Missing documentation for "FeatureCalloutCircleClassKey". // src/components/HeaderIconLinkRow/HeaderIconLinkRow.d.ts:4:1 - (ae-undocumented) Missing documentation for "HeaderIconLinkRowClassKey". // src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:2:1 - (ae-undocumented) Missing documentation for "IconLinkVerticalProps". @@ -1601,7 +1601,8 @@ export type WarningPanelClassKey = // src/components/HorizontalScrollGrid/HorizontalScrollGrid.d.ts:8:1 - (ae-undocumented) Missing documentation for "HorizontalScrollGridClassKey". // src/components/Lifecycle/Lifecycle.d.ts:7:1 - (ae-undocumented) Missing documentation for "LifecycleClassKey". // src/components/Lifecycle/Lifecycle.d.ts:8:1 - (ae-undocumented) Missing documentation for "Lifecycle". -// src/components/Link/Link.d.ts:6:1 - (ae-undocumented) Missing documentation for "LinkProps". +// src/components/Link/Link.d.ts:6:1 - (ae-undocumented) Missing documentation for "LinkClassKey". +// src/components/Link/Link.d.ts:8:1 - (ae-undocumented) Missing documentation for "LinkProps". // src/components/LinkButton/LinkButton.d.ts:24:22 - (ae-undocumented) Missing documentation for "Button". // src/components/LinkButton/LinkButton.d.ts:29:1 - (ae-undocumented) Missing documentation for "ButtonProps". // src/components/MarkdownContent/MarkdownContent.d.ts:3:1 - (ae-undocumented) Missing documentation for "MarkdownContentClassKey". @@ -1695,6 +1696,8 @@ export type WarningPanelClassKey = // src/icons/icons.d.ts:41:1 - (ae-undocumented) Missing documentation for "HelpIcon". // src/icons/icons.d.ts:43:1 - (ae-undocumented) Missing documentation for "UserIcon". // src/icons/icons.d.ts:45:1 - (ae-undocumented) Missing documentation for "WarningIcon". +// src/icons/icons.d.ts:47:1 - (ae-undocumented) Missing documentation for "StarIcon". +// src/icons/icons.d.ts:49:1 - (ae-undocumented) Missing documentation for "UnstarredIcon". // src/layout/BottomLink/BottomLink.d.ts:3:1 - (ae-undocumented) Missing documentation for "BottomLinkClassKey". // src/layout/BottomLink/BottomLink.d.ts:5:1 - (ae-undocumented) Missing documentation for "BottomLinkProps". // src/layout/Breadcrumbs/Breadcrumbs.d.ts:5:1 - (ae-undocumented) Missing documentation for "BreadcrumbsClickableTextClassKey". @@ -1707,6 +1710,7 @@ export type WarningPanelClassKey = // src/layout/ErrorBoundary/ErrorBoundary.d.ts:16:22 - (ae-undocumented) Missing documentation for "ErrorBoundary". // src/layout/ErrorPage/ErrorPage.d.ts:10:1 - (ae-undocumented) Missing documentation for "ErrorPageClassKey". // src/layout/ErrorPage/MicDrop.d.ts:2:1 - (ae-undocumented) Missing documentation for "MicDropClassKey". +// src/layout/ErrorPage/StackDetails.d.ts:6:1 - (ae-undocumented) Missing documentation for "StackDetailsClassKey". // src/layout/Header/Header.d.ts:3:1 - (ae-undocumented) Missing documentation for "HeaderClassKey". // src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:6:1 - (ae-undocumented) Missing documentation for "HeaderActionMenuItem". // src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:16:1 - (ae-undocumented) Missing documentation for "HeaderActionMenuProps". @@ -1737,11 +1741,13 @@ export type WarningPanelClassKey = // src/layout/Sidebar/Items.d.ts:60:22 - (ae-undocumented) Missing documentation for "SidebarScrollWrapper". // src/layout/Sidebar/Page.d.ts:2:1 - (ae-undocumented) Missing documentation for "SidebarPageClassKey". // src/layout/Sidebar/Page.d.ts:11:1 - (ae-undocumented) Missing documentation for "SidebarPage". +// src/layout/Sidebar/SidebarSubmenu.d.ts:3:1 - (ae-undocumented) Missing documentation for "SidebarSubmenuClassKey". +// src/layout/Sidebar/SidebarSubmenuItem.d.ts:4:1 - (ae-undocumented) Missing documentation for "SidebarSubmenuItemClassKey". // src/layout/Sidebar/config.d.ts:3:1 - (ae-undocumented) Missing documentation for "SidebarOptions". // src/layout/Sidebar/config.d.ts:8:1 - (ae-undocumented) Missing documentation for "SubmenuOptions". // src/layout/Sidebar/config.d.ts:12:22 - (ae-undocumented) Missing documentation for "sidebarConfig". // src/layout/Sidebar/config.d.ts:52:22 - (ae-undocumented) Missing documentation for "SIDEBAR_INTRO_LOCAL_STORAGE". -// src/layout/SignInPage/SignInPage.d.ts:16:1 - (ae-undocumented) Missing documentation for "SignInPage". +// src/layout/SignInPage/SignInPage.d.ts:17:1 - (ae-undocumented) Missing documentation for "SignInPage". // src/layout/SignInPage/customProvider.d.ts:3:1 - (ae-undocumented) Missing documentation for "CustomProviderClassKey". // src/layout/SignInPage/styles.d.ts:2:1 - (ae-undocumented) Missing documentation for "SignInPageClassKey". // src/layout/SignInPage/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "SignInProviderConfig". @@ -1750,5 +1756,5 @@ export type WarningPanelClassKey = // src/layout/TabbedCard/TabbedCard.d.ts:7:1 - (ae-undocumented) Missing documentation for "BoldHeaderClassKey". // src/layout/TabbedCard/TabbedCard.d.ts:18:1 - (ae-undocumented) Missing documentation for "TabbedCard". // src/layout/TabbedCard/TabbedCard.d.ts:20:1 - (ae-undocumented) Missing documentation for "CardTabClassKey". -// src/overridableComponents.d.ts:78:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". +// src/overridableComponents.d.ts:83:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". ``` diff --git a/packages/dev-utils/report.api.md b/packages/dev-utils/report.api.md index ccde681f41..18da50026e 100644 --- a/packages/dev-utils/report.api.md +++ b/packages/dev-utils/report.api.md @@ -71,5 +71,6 @@ export const SidebarSignOutButton: (props: { // Warnings were encountered during analysis: // // src/components/EntityGridItem/EntityGridItem.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityGridItem". -// src/devApp/render.d.ts:7:1 - (ae-undocumented) Missing documentation for "DevAppPageOptions". +// src/components/SidebarLanguageSwitcher/SidebarLanguageSwitcher.d.ts:3:22 - (ae-undocumented) Missing documentation for "SidebarLanguageSwitcher". +// src/devApp/render.d.ts:8:1 - (ae-undocumented) Missing documentation for "DevAppPageOptions". ``` diff --git a/packages/frontend-app-api/report.api.md b/packages/frontend-app-api/report.api.md index 4216f1f823..b5e5f801e6 100644 --- a/packages/frontend-app-api/report.api.md +++ b/packages/frontend-app-api/report.api.md @@ -43,4 +43,8 @@ export type FrontendFeature = | { $$type: '@backstage/BackstagePlugin'; }; + +// Warnings were encountered during analysis: +// +// src/wiring/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "FrontendFeature". ``` diff --git a/packages/frontend-defaults/api-report.md b/packages/frontend-defaults/api-report.md deleted file mode 100644 index b99232b784..0000000000 --- a/packages/frontend-defaults/api-report.md +++ /dev/null @@ -1,43 +0,0 @@ -## API Report File for "@backstage/frontend-defaults" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { ConfigApi } from '@backstage/frontend-plugin-api'; -import { CreateAppRouteBinder } from '@backstage/frontend-app-api'; -import { FrontendFeature } from '@backstage/frontend-app-api'; -import { JSX as JSX_2 } from 'react'; -import { default as React_2 } from 'react'; -import { ReactNode } from 'react'; - -// @public -export function createApp(options?: CreateAppOptions): { - createRoot(): JSX_2.Element; -}; - -// @public -export interface CreateAppFeatureLoader { - getLoaderName(): string; - load(options: { config: ConfigApi }): Promise<{ - features: FrontendFeature[]; - }>; -} - -// @public -export interface CreateAppOptions { - // (undocumented) - bindRoutes?(context: { bind: CreateAppRouteBinder }): void; - // (undocumented) - configLoader?: () => Promise<{ - config: ConfigApi; - }>; - // (undocumented) - features?: (FrontendFeature | CreateAppFeatureLoader)[]; - loadingComponent?: ReactNode; -} - -// @public -export function createPublicSignInApp(options?: CreateAppOptions): { - createRoot(): React_2.JSX.Element; -}; -``` diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md index 24aa1d5b52..b575a94837 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -89,8 +89,6 @@ import { useTranslationRef } from '@backstage/core-plugin-api/alpha'; import { vmwareCloudAuthApiRef } from '@backstage/core-plugin-api'; import { withApis } from '@backstage/core-plugin-api'; import { z } from 'zod'; -import { ZodSchema } from 'zod'; -import { ZodTypeDef } from 'zod'; export { AlertApi }; @@ -148,26 +146,13 @@ export { AnyApiFactory }; export { AnyApiRef }; // @public (undocumented) -export type AnyExtensionDataMap = { - [name in string]: ExtensionDataRef< - unknown, - string, - { - optional?: true; - } - >; -}; - -// @public (undocumented) -export type AnyExtensionInputMap = { - [inputName in string]: ExtensionInput< - AnyExtensionDataMap, - { - optional: boolean; - singleton: boolean; - } - >; -}; +export type AnyExtensionDataRef = ExtensionDataRef< + unknown, + string, + { + optional?: true; + } +>; // @public (undocumented) export type AnyExternalRoutes = { @@ -186,6 +171,26 @@ export type AnyRoutes = { [name in string]: RouteRef | SubRouteRef; }; +// @public +export const ApiBlueprint: ExtensionBlueprint<{ + kind: 'api'; + name: undefined; + params: { + factory: AnyApiFactory; + }; + output: ConfigurableExtensionDataRef; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + factory: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + }; +}>; + export { ApiFactory }; export { ApiHolder }; @@ -234,9 +239,51 @@ export interface AppNodeSpec { // (undocumented) readonly id: string; // (undocumented) - readonly source?: BackstagePlugin; + readonly source?: FrontendPlugin; } +// @public +export const AppRootElementBlueprint: ExtensionBlueprint<{ + kind: 'app-root-element'; + name: undefined; + params: { + element: JSX.Element | (() => JSX.Element); + }; + output: ConfigurableExtensionDataRef; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: never; +}>; + +// @public +export const AppRootWrapperBlueprint: ExtensionBlueprint<{ + kind: 'app-root-wrapper'; + name: undefined; + params: { + Component: ComponentType>; + }; + output: ConfigurableExtensionDataRef< + React_2.ComponentType<{ + children?: React_2.ReactNode; + }>, + 'app.root.wrapper', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + component: ConfigurableExtensionDataRef< + React_2.ComponentType<{ + children?: React_2.ReactNode; + }>, + 'app.root.wrapper', + {} + >; + }; +}>; + export { AppTheme }; export { AppThemeApi }; @@ -270,21 +317,6 @@ export { BackstageIdentityApi }; export { BackstageIdentityResponse }; -// @public (undocumented) -export interface BackstagePlugin< - Routes extends AnyRoutes = AnyRoutes, - ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, -> { - // (undocumented) - readonly $$type: '@backstage/BackstagePlugin'; - // (undocumented) - readonly externalRoutes: ExternalRoutes; - // (undocumented) - readonly id: string; - // (undocumented) - readonly routes: Routes; -} - export { BackstageUserIdentity }; export { bitbucketAuthApiRef }; @@ -318,17 +350,19 @@ export { configApiRef }; // @public (undocumented) export interface ConfigurableExtensionDataRef< - TId extends string, TData, + TId extends string, TConfig extends { optional?: true; } = {}, > extends ExtensionDataRef { + // (undocumented) + (t: TData): ExtensionDataValue; // (undocumented) optional(): ConfigurableExtensionDataRef< - TId, TData, - TData & { + TId, + TConfig & { optional: true; } >; @@ -343,7 +377,7 @@ export const coreComponentRefs: { // @public (undocumented) export type CoreErrorBoundaryFallbackProps = { - plugin?: BackstagePlugin; + plugin?: FrontendPlugin; error: Error; resetError: () => void; }; @@ -351,14 +385,14 @@ export type CoreErrorBoundaryFallbackProps = { // @public (undocumented) export const coreExtensionData: { reactElement: ConfigurableExtensionDataRef< - 'core.reactElement', JSX_2.Element, + 'core.reactElement', {} >; - routePath: ConfigurableExtensionDataRef<'core.routing.path', string, {}>; + routePath: ConfigurableExtensionDataRef; routeRef: ConfigurableExtensionDataRef< - 'core.routing.ref', RouteRef, + 'core.routing.ref', {} >; }; @@ -371,133 +405,56 @@ export type CoreNotFoundErrorPageProps = { // @public (undocumented) export type CoreProgressProps = {}; -// @public (undocumented) -export function createApiExtension< - TConfig extends {}, - TInputs extends AnyExtensionInputMap, ->( - options: ( - | { - api: AnyApiRef; - factory: (options: { - config: TConfig; - inputs: Expand>; - }) => AnyApiFactory; - } - | { - factory: AnyApiFactory; - } - ) & { - configSchema?: PortableSchema; - inputs?: TInputs; - }, -): ExtensionDefinition; - -// @public (undocumented) -export namespace createApiExtension { - const // (undocumented) - factoryDataRef: ConfigurableExtensionDataRef< - 'core.api.factory', - AnyApiFactory, - {} - >; -} - export { createApiFactory }; export { createApiRef }; -// @public -export function createAppRootElementExtension< - TConfig extends {}, - TInputs extends AnyExtensionInputMap, ->(options: { - namespace?: string; - name?: string; - attachTo?: { - id: string; - input: string; - }; - configSchema?: PortableSchema; - disabled?: boolean; - inputs?: TInputs; - element: - | JSX_2.Element - | ((options: { - inputs: Expand>; - config: TConfig; - }) => JSX_2.Element); -}): ExtensionDefinition; - -// @public -export function createAppRootWrapperExtension< - TConfig extends {}, - TInputs extends AnyExtensionInputMap, ->(options: { - namespace?: string; - name?: string; - attachTo?: { - id: string; - input: string; - }; - configSchema?: PortableSchema; - disabled?: boolean; - inputs?: TInputs; - Component: ComponentType< - PropsWithChildren<{ - inputs: Expand>; - config: TConfig; - }> - >; -}): ExtensionDefinition; - // @public (undocumented) -export namespace createAppRootWrapperExtension { - const // (undocumented) - componentDataRef: ConfigurableExtensionDataRef< - 'app.root.wrapper', - React_2.ComponentType<{ - children?: React_2.ReactNode; - }>, - {} - >; -} - -// @public (undocumented) -export function createComponentExtension< - TProps extends {}, - TConfig extends {}, - TInputs extends AnyExtensionInputMap, ->(options: { +export function createComponentExtension(options: { ref: ComponentRef; name?: string; disabled?: boolean; - inputs?: TInputs; - configSchema?: PortableSchema; loader: | { - lazy: (values: { - config: TConfig; - inputs: Expand>; - }) => Promise>; + lazy: () => Promise>; } | { - sync: (values: { - config: TConfig; - inputs: Expand>; - }) => ComponentType; + sync: () => ComponentType; }; -}): ExtensionDefinition; +}): ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + { + ref: ComponentRef; + impl: ComponentType; + }, + 'core.component.component', + {} + >; + inputs: { + [x: string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }; + params: never; + kind: 'component'; + name: string; +}>; // @public (undocumented) export namespace createComponentExtension { const // (undocumented) componentDataRef: ConfigurableExtensionDataRef< - 'core.component.component', { ref: ComponentRef; impl: ComponentType; }, + 'core.component.component', {} >; } @@ -509,142 +466,189 @@ export function createComponentRef(options: { // @public (undocumented) export function createExtension< - TOutput extends AnyExtensionDataMap, - TInputs extends AnyExtensionInputMap, - TConfig, - TConfigInput, + UOutput extends AnyExtensionDataRef, + TInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }, TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType; }, + UFactoryOutput extends ExtensionDataValue, + const TKind extends string | undefined = undefined, + const TName extends string | undefined = undefined, >( options: CreateExtensionOptions< - TOutput, + TKind, + TName, + UOutput, TInputs, - TConfig, - TConfigInput, - TConfigSchema - >, -): ExtensionDefinition< - TConfig & - (string extends keyof TConfigSchema - ? {} - : { - [key in keyof TConfigSchema]: z.infer>; - }), - TConfigInput & - (string extends keyof TConfigSchema - ? {} - : z.input< - z.ZodObject<{ - [key in keyof TConfigSchema]: ReturnType; - }> - >) ->; - -// @public -export function createExtensionBlueprint< - TParams, - TInputs extends AnyExtensionInputMap, - TOutput extends AnyExtensionDataMap, - TConfigSchema extends { - [key in string]: (zImpl: typeof z) => z.ZodType; - }, - TDataRefs extends AnyExtensionDataMap = never, ->( - options: CreateExtensionBlueprintOptions< - TParams, - TInputs, - TOutput, TConfigSchema, - TDataRefs + UFactoryOutput >, -): ExtensionBlueprint< - TParams, - TInputs, - TOutput, - string extends keyof TConfigSchema +): ExtensionDefinition<{ + config: string extends keyof TConfigSchema ? {} : { [key in keyof TConfigSchema]: z.infer>; - }, - string extends keyof TConfigSchema + }; + configInput: string extends keyof TConfigSchema ? {} : z.input< z.ZodObject<{ [key in keyof TConfigSchema]: ReturnType; }> - >, - TDataRefs ->; + >; + output: UOutput; + inputs: TInputs; + params: never; + kind: string | undefined extends TKind ? undefined : TKind; + name: string | undefined extends TName ? undefined : TName; +}>; -// @public (undocumented) -export interface CreateExtensionBlueprintOptions< - TParams, - TInputs extends AnyExtensionInputMap, - TOutput extends AnyExtensionDataMap, +// @public +export function createExtensionBlueprint< + TParams extends object, + UOutput extends AnyExtensionDataRef, + TInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }, TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - TDataRefs extends AnyExtensionDataMap, -> { - // (undocumented) + UFactoryOutput extends ExtensionDataValue, + TKind extends string, + TName extends string | undefined = undefined, + TDataRefs extends { + [name in string]: AnyExtensionDataRef; + } = never, +>( + options: CreateExtensionBlueprintOptions< + TKind, + TName, + TParams, + UOutput, + TInputs, + TConfigSchema, + UFactoryOutput, + TDataRefs + >, +): ExtensionBlueprint<{ + kind: TKind; + name: TName; + params: TParams; + output: UOutput; + inputs: string extends keyof TInputs ? {} : TInputs; + config: string extends keyof TConfigSchema + ? {} + : { + [key in keyof TConfigSchema]: z.infer>; + }; + configInput: string extends keyof TConfigSchema + ? {} + : z.input< + z.ZodObject<{ + [key in keyof TConfigSchema]: ReturnType; + }> + >; + dataRefs: TDataRefs; +}>; + +// @public (undocumented) +export type CreateExtensionBlueprintOptions< + TKind extends string, + TName extends string | undefined, + TParams, + UOutput extends AnyExtensionDataRef, + TInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }, + TConfigSchema extends { + [key in string]: (zImpl: typeof z) => z.ZodType; + }, + UFactoryOutput extends ExtensionDataValue, + TDataRefs extends { + [name in string]: AnyExtensionDataRef; + }, +> = { + kind: TKind; attachTo: { id: string; input: string; }; - // (undocumented) + disabled?: boolean; + inputs?: TInputs; + output: Array; + name?: TName; config?: { schema: TConfigSchema; }; - // (undocumented) - dataRefs?: TDataRefs; - // (undocumented) - disabled?: boolean; - // (undocumented) factory( params: TParams, context: { node: AppNode; + apis: ApiHolder; config: { [key in keyof TConfigSchema]: z.infer>; }; inputs: Expand>; }, - ): Expand>; - // (undocumented) - inputs?: TInputs; - // (undocumented) - kind: string; - // (undocumented) - namespace?: string; - // (undocumented) - output: TOutput; -} + ): Iterable; + dataRefs?: TDataRefs; +} & VerifyExtensionFactoryOutput; // @public @deprecated (undocumented) export function createExtensionDataRef( id: string, -): ConfigurableExtensionDataRef; +): ConfigurableExtensionDataRef; // @public (undocumented) export function createExtensionDataRef(): { with(options: { id: TId; - }): ConfigurableExtensionDataRef; + }): ConfigurableExtensionDataRef; }; // @public (undocumented) export function createExtensionInput< - TExtensionData extends AnyExtensionDataMap, + UExtensionData extends ExtensionDataRef< + unknown, + string, + { + optional?: true; + } + >, TConfig extends { singleton?: boolean; optional?: boolean; }, >( - extensionData: TExtensionData, - config?: TConfig, + extensionData: Array, + config?: TConfig & { + replaces?: Array<{ + id: string; + input: string; + }>; + }, ): ExtensionInput< - TExtensionData, + UExtensionData, { singleton: TConfig['singleton'] extends true ? true : false; optional: TConfig['optional'] extends true ? true : false; @@ -652,57 +656,45 @@ export function createExtensionInput< >; // @public (undocumented) -export interface CreateExtensionOptions< - TOutput extends AnyExtensionDataMap, - TInputs extends AnyExtensionInputMap, - TConfig, - TConfigInput, +export type CreateExtensionOptions< + TKind extends string | undefined, + TName extends string | undefined, + UOutput extends AnyExtensionDataRef, + TInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }, TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType; }, -> { - // (undocumented) + UFactoryOutput extends ExtensionDataValue, +> = { + kind?: TKind; + name?: TName; attachTo: { id: string; input: string; }; - // (undocumented) + disabled?: boolean; + inputs?: TInputs; + output: Array; config?: { schema: TConfigSchema; }; - // @deprecated (undocumented) - configSchema?: PortableSchema; - // (undocumented) - disabled?: boolean; - // (undocumented) factory(context: { node: AppNode; - config: TConfig & - (string extends keyof TConfigSchema - ? {} - : { - [key in keyof TConfigSchema]: z.infer< - ReturnType - >; - }); + apis: ApiHolder; + config: { + [key in keyof TConfigSchema]: z.infer>; + }; inputs: Expand>; - }): Expand>; - // (undocumented) - inputs?: TInputs; - // (undocumented) - kind?: string; - // (undocumented) - name?: string; - // (undocumented) - namespace?: string; - // (undocumented) - output: TOutput; -} - -// @public (undocumented) -export function createExtensionOverrides( - options: ExtensionOverridesOptions, -): ExtensionOverrides; + }): Iterable; +} & VerifyExtensionFactoryOutput; // @public export function createExternalRouteRef< @@ -711,13 +703,11 @@ export function createExternalRouteRef< [param in TParamKeys]: string; } | undefined = undefined, - TOptional extends boolean = false, TParamKeys extends string = string, >(options?: { readonly params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]; - optional?: TOptional; defaultTarget?: string; }): ExternalRouteRef< keyof TParams extends never @@ -726,100 +716,47 @@ export function createExternalRouteRef< ? TParams : { [param in TParamKeys]: string; - }, - TOptional + } >; -// @public -export function createNavItemExtension(options: { - namespace?: string; - name?: string; - routeRef: RouteRef; - title: string; - icon: IconComponent_2; -}): ExtensionDefinition< +// @public (undocumented) +export function createFrontendModule< + TId extends string, + TExtensions extends readonly ExtensionDefinition[] = [], +>(options: CreateFrontendModuleOptions): FrontendModule; + +// @public (undocumented) +export interface CreateFrontendModuleOptions< + TPluginId extends string, + TExtensions extends readonly ExtensionDefinition[], +> { + // (undocumented) + extensions?: TExtensions; + // (undocumented) + featureFlags?: FeatureFlagConfig[]; + // (undocumented) + pluginId: TPluginId; +} + +// @public (undocumented) +export function createFrontendPlugin< + TId extends string, + TRoutes extends AnyRoutes = {}, + TExternalRoutes extends AnyExternalRoutes = {}, + TExtensions extends readonly ExtensionDefinition[] = [], +>( + options: PluginOptions, +): FrontendPlugin< + TRoutes, + TExternalRoutes, { - title: string; - }, - { - title?: string | undefined; + [KExtension in TExtensions[number] as ResolveExtensionId< + KExtension, + TId + >]: KExtension; } >; -// @public (undocumented) -export namespace createNavItemExtension { - const // (undocumented) - targetDataRef: ConfigurableExtensionDataRef< - 'core.nav-item.target', - { - title: string; - icon: IconComponent_2; - routeRef: RouteRef; - }, - {} - >; -} - -// @public -export function createNavLogoExtension(options: { - name?: string; - namespace?: string; - logoIcon: JSX.Element; - logoFull: JSX.Element; -}): ExtensionDefinition<{}, {}>; - -// @public (undocumented) -export namespace createNavLogoExtension { - const // (undocumented) - logoElementsDataRef: ConfigurableExtensionDataRef< - 'core.nav-logo.logo-elements', - { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; - }, - {} - >; -} - -// @public -export function createPageExtension< - TConfig extends { - path: string; - }, - TInputs extends AnyExtensionInputMap, ->( - options: ( - | { - defaultPath: string; - } - | { - configSchema: PortableSchema; - } - ) & { - namespace?: string; - name?: string; - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - inputs?: TInputs; - routeRef?: RouteRef; - loader: (options: { - config: TConfig; - inputs: Expand>; - }) => Promise; - }, -): ExtensionDefinition; - -// @public (undocumented) -export function createPlugin< - Routes extends AnyRoutes = {}, - ExternalRoutes extends AnyExternalRoutes = {}, ->( - options: PluginOptions, -): BackstagePlugin; - // @public export function createRouteRef< TParams extends @@ -840,75 +777,6 @@ export function createRouteRef< } >; -// @public -export function createRouterExtension< - TConfig extends {}, - TInputs extends AnyExtensionInputMap, ->(options: { - namespace?: string; - name?: string; - attachTo?: { - id: string; - input: string; - }; - configSchema?: PortableSchema; - disabled?: boolean; - inputs?: TInputs; - Component: ComponentType< - PropsWithChildren<{ - inputs: Expand>; - config: TConfig; - }> - >; -}): ExtensionDefinition; - -// @public (undocumented) -export namespace createRouterExtension { - const // (undocumented) - componentDataRef: ConfigurableExtensionDataRef< - 'app.router.wrapper', - React_2.ComponentType<{ - children?: React_2.ReactNode; - }>, - {} - >; -} - -// @public @deprecated (undocumented) -export function createSchemaFromZod( - schemaCreator: (zImpl: typeof z) => ZodSchema, -): PortableSchema; - -// @public (undocumented) -export function createSignInPageExtension< - TConfig extends {}, - TInputs extends AnyExtensionInputMap, ->(options: { - namespace?: string; - name?: string; - attachTo?: { - id: string; - input: string; - }; - configSchema?: PortableSchema; - disabled?: boolean; - inputs?: TInputs; - loader: (options: { - config: TConfig; - inputs: Expand>; - }) => Promise>; -}): ExtensionDefinition; - -// @public (undocumented) -export namespace createSignInPageExtension { - const // (undocumented) - componentDataRef: ConfigurableExtensionDataRef< - 'core.sign-in-page.component', - React_2.ComponentType, - {} - >; -} - // @public export function createSubRouteRef< Path extends string, @@ -918,44 +786,6 @@ export function createSubRouteRef< parent: RouteRef; }): MakeSubRouteRef, ParentParams>; -// @public (undocumented) -export function createThemeExtension( - theme: AppTheme, -): ExtensionDefinition<{}, {}>; - -// @public (undocumented) -export namespace createThemeExtension { - const // (undocumented) - themeDataRef: ConfigurableExtensionDataRef< - 'core.theme.theme', - AppTheme, - {} - >; -} - -// @public (undocumented) -export function createTranslationExtension(options: { - name?: string; - resource: TranslationResource | TranslationMessages; -}): ExtensionDefinition<{}, {}>; - -// @public (undocumented) -export namespace createTranslationExtension { - const // (undocumented) - translationDataRef: ConfigurableExtensionDataRef< - 'core.translation.translation', - | TranslationResource - | TranslationMessages< - string, - { - [x: string]: string; - }, - boolean - >, - {} - >; -} - export { createTranslationMessages }; export { createTranslationRef }; @@ -993,87 +823,154 @@ export interface Extension { // @public (undocumented) export interface ExtensionBlueprint< - TParams, - TInputs extends AnyExtensionInputMap, - TOutput extends AnyExtensionDataMap, - TConfig extends { - [key in string]: unknown; - }, - TConfigInput extends { - [key in string]: unknown; - }, - TDataRefs extends AnyExtensionDataMap, + T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters, > { // (undocumented) - dataRefs: TDataRefs; - make< + dataRefs: T['dataRefs']; + // (undocumented) + make(args: { + name?: TNewName; + attachTo?: { + id: string; + input: string; + }; + disabled?: boolean; + params: T['params']; + }): ExtensionDefinition<{ + kind: T['kind']; + name: string | undefined extends TNewName ? T['name'] : TNewName; + config: T['config']; + configInput: T['configInput']; + output: T['output']; + inputs: T['inputs']; + params: T['params']; + }>; + makeWithOverrides< + TNewName extends string | undefined, TExtensionConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType; }, - >( - args: { - namespace?: string; - name?: string; - attachTo?: { - id: string; - input: string; - }; - disabled?: boolean; - inputs?: TInputs; - output?: TOutput; - config?: { - schema: TExtensionConfigSchema & { - [KName in keyof TConfig]?: `Error: Config key '${KName & - string}' is already defined in parent schema`; - }; - }; - } & ( - | { - factory( - originalFactory: ( - params: TParams, - context?: { - config?: TConfig; - inputs?: Expand>; - }, - ) => Expand>, - context: { - node: AppNode; - config: TConfig & { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType - >; - }; - inputs: Expand>; - }, - ): Expand>; + UFactoryOutput extends ExtensionDataValue, + UNewOutput extends AnyExtensionDataRef, + TExtraInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; } - | { - params: TParams; - } - ), - ): ExtensionDefinition< - { - [key in keyof TExtensionConfigSchema]: z.infer< - ReturnType >; - } & TConfig, - z.input< - z.ZodObject<{ - [key in keyof TExtensionConfigSchema]: ReturnType< - TExtensionConfigSchema[key] - >; - }> - > & - TConfigInput - >; + }, + >(args: { + name?: TNewName; + attachTo?: { + id: string; + input: string; + }; + disabled?: boolean; + inputs?: TExtraInputs & { + [KName in keyof T['inputs']]?: `Error: Input '${KName & + string}' is already defined in parent definition`; + }; + output?: Array; + config?: { + schema: TExtensionConfigSchema & { + [KName in keyof T['config']]?: `Error: Config key '${KName & + string}' is already defined in parent schema`; + }; + }; + factory( + originalFactory: ( + params: T['params'], + context?: { + config?: T['config']; + inputs?: ResolveInputValueOverrides>; + }, + ) => ExtensionDataContainer>, + context: { + node: AppNode; + apis: ApiHolder; + config: T['config'] & { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType + >; + }; + inputs: Expand>; + }, + ): Iterable & + VerifyExtensionFactoryOutput< + AnyExtensionDataRef extends UNewOutput + ? NonNullable + : UNewOutput, + UFactoryOutput + >; + }): ExtensionDefinition<{ + config: (string extends keyof TExtensionConfigSchema + ? {} + : { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType + >; + }) & + T['config']; + configInput: (string extends keyof TExtensionConfigSchema + ? {} + : z.input< + z.ZodObject<{ + [key in keyof TExtensionConfigSchema]: ReturnType< + TExtensionConfigSchema[key] + >; + }> + >) & + T['configInput']; + output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput; + inputs: T['inputs'] & TExtraInputs; + kind: T['kind']; + name: string | undefined extends TNewName ? T['name'] : TNewName; + params: T['params']; + }>; } +// @public (undocumented) +export type ExtensionBlueprintParameters = { + kind: string; + name?: string; + params?: object; + configInput?: { + [K in string]: any; + }; + config?: { + [K in string]: any; + }; + output?: AnyExtensionDataRef; + inputs?: { + [KName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }; + dataRefs?: { + [name in string]: AnyExtensionDataRef; + }; +}; + // @public (undocumented) export function ExtensionBoundary( props: ExtensionBoundaryProps, ): React_2.JSX.Element; +// @public (undocumented) +export namespace ExtensionBoundary { + // (undocumented) + export function lazy( + appNode: AppNode, + lazyElement: () => Promise, + ): JSX.Element; +} + // @public (undocumented) export interface ExtensionBoundaryProps { // (undocumented) @@ -1083,6 +980,28 @@ export interface ExtensionBoundaryProps { routable?: boolean; } +// @public (undocumented) +export type ExtensionDataContainer = + Iterable< + UExtensionData extends ExtensionDataRef< + infer IData, + infer IId, + infer IConfig + > + ? IConfig['optional'] extends true + ? never + : ExtensionDataValue + : never + > & { + get( + ref: ExtensionDataRef, + ): UExtensionData extends ExtensionDataRef + ? IConfig['optional'] extends true + ? IData | undefined + : IData + : never; + }; + // @public (undocumented) export type ExtensionDataRef< TData, @@ -1091,51 +1010,154 @@ export type ExtensionDataRef< optional?: true; } = {}, > = { - id: TId; - T: TData; - config: TConfig; - $$type: '@backstage/ExtensionDataRef'; -}; - -// @public -export type ExtensionDataValues = { - [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends { - optional: true; - } - ? never - : DataName]: TExtensionData[DataName]['T']; -} & { - [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends { - optional: true; - } - ? DataName - : never]?: TExtensionData[DataName]['T']; + readonly $$type: '@backstage/ExtensionDataRef'; + readonly id: TId; + readonly T: TData; + readonly config: TConfig; }; // @public (undocumented) -export interface ExtensionDefinition { - // (undocumented) +export type ExtensionDataRefToValue = + TDataRef extends ExtensionDataRef + ? ExtensionDataValue + : never; + +// @public (undocumented) +export type ExtensionDataValue = { + readonly $$type: '@backstage/ExtensionDataValue'; + readonly id: TId; + readonly value: TData; +}; + +// @public (undocumented) +export type ExtensionDefinition< + T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters, +> = { $$type: '@backstage/ExtensionDefinition'; - // (undocumented) - readonly attachTo: { - id: string; - input: string; + readonly T: T; + override< + TExtensionConfigSchema extends { + [key in string]: (zImpl: typeof z) => z.ZodType; + }, + UFactoryOutput extends ExtensionDataValue, + UNewOutput extends AnyExtensionDataRef, + TExtraInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }, + >( + args: Expand< + { + attachTo?: { + id: string; + input: string; + }; + disabled?: boolean; + inputs?: TExtraInputs & { + [KName in keyof T['inputs']]?: `Error: Input '${KName & + string}' is already defined in parent definition`; + }; + output?: Array; + config?: { + schema: TExtensionConfigSchema & { + [KName in keyof T['config']]?: `Error: Config key '${KName & + string}' is already defined in parent schema`; + }; + }; + factory?( + originalFactory: ( + context?: Expand< + { + config?: T['config']; + inputs?: ResolveInputValueOverrides>; + } & ([T['params']] extends [never] + ? {} + : { + params?: Partial; + }) + >, + ) => ExtensionDataContainer>, + context: { + node: AppNode; + apis: ApiHolder; + config: T['config'] & { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType + >; + }; + inputs: Expand>; + }, + ): Iterable; + } & ([T['params']] extends [never] + ? {} + : { + params?: Partial; + }) + > & + VerifyExtensionFactoryOutput< + AnyExtensionDataRef extends UNewOutput + ? NonNullable + : UNewOutput, + UFactoryOutput + >, + ): ExtensionDefinition<{ + kind: T['kind']; + name: T['name']; + output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput; + inputs: T['inputs'] & TExtraInputs; + config: T['config'] & { + [key in keyof TExtensionConfigSchema]: z.infer< + ReturnType + >; + }; + configInput: T['configInput'] & + z.input< + z.ZodObject<{ + [key in keyof TExtensionConfigSchema]: ReturnType< + TExtensionConfigSchema[key] + >; + }> + >; + }>; +}; + +// @public (undocumented) +export type ExtensionDefinitionParameters = { + kind?: string; + name?: string; + configInput?: { + [K in string]: any; }; - // (undocumented) - readonly configSchema?: PortableSchema; - // (undocumented) - readonly disabled: boolean; - // (undocumented) - readonly kind?: string; - // (undocumented) - readonly name?: string; - // (undocumented) - readonly namespace?: string; -} + config?: { + [K in string]: any; + }; + output?: AnyExtensionDataRef; + inputs?: { + [KName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }; + params?: object; +}; // @public (undocumented) export interface ExtensionInput< - TExtensionData extends AnyExtensionDataMap, + UExtensionData extends ExtensionDataRef< + unknown, + string, + { + optional?: true; + } + >, TConfig extends { singleton: boolean; optional: boolean; @@ -1146,7 +1168,12 @@ export interface ExtensionInput< // (undocumented) config: TConfig; // (undocumented) - extensionData: TExtensionData; + extensionData: Array; + // (undocumented) + replaces?: Array<{ + id: string; + input: string; + }>; } // @public (undocumented) @@ -1155,24 +1182,13 @@ export interface ExtensionOverrides { readonly $$type: '@backstage/ExtensionOverrides'; } -// @public (undocumented) -export interface ExtensionOverridesOptions { - // (undocumented) - extensions: ExtensionDefinition[]; - // (undocumented) - featureFlags?: FeatureFlagConfig[]; -} - // @public export interface ExternalRouteRef< TParams extends AnyRouteRefParams = AnyRouteRefParams, - TOptional extends boolean = boolean, > { // (undocumented) readonly $$type: '@backstage/ExternalRouteRef'; // (undocumented) - readonly optional: TOptional; - // (undocumented) readonly T: TParams; } @@ -1195,8 +1211,42 @@ export { FetchApi }; export { fetchApiRef }; +// @public @deprecated (undocumented) +export type FrontendFeature = FrontendPlugin | ExtensionOverrides; + // @public (undocumented) -export type FrontendFeature = BackstagePlugin | ExtensionOverrides; +export interface FrontendModule { + // (undocumented) + readonly $$type: '@backstage/FrontendModule'; + // (undocumented) + readonly pluginId: string; +} + +// @public (undocumented) +export interface FrontendPlugin< + TRoutes extends AnyRoutes = AnyRoutes, + TExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, + TExtensionMap extends { + [id in string]: ExtensionDefinition; + } = { + [id in string]: ExtensionDefinition; + }, +> { + // (undocumented) + readonly $$type: '@backstage/FrontendPlugin'; + // (undocumented) + readonly externalRoutes: TExternalRoutes; + // (undocumented) + getExtension(id: TId): TExtensionMap[TId]; + // (undocumented) + readonly id: string; + // (undocumented) + readonly routes: TRoutes; + // (undocumented) + withOverrides(options: { + extensions: Array; + }): FrontendPlugin; +} export { githubAuthApiRef }; @@ -1205,40 +1255,34 @@ export { gitlabAuthApiRef }; export { googleAuthApiRef }; // @public (undocumented) -export const IconBundleBlueprint: ExtensionBlueprint< - { +export const IconBundleBlueprint: ExtensionBlueprint<{ + kind: 'icon-bundle'; + name: undefined; + params: { icons: { [x: string]: IconComponent; }; - }, - AnyExtensionInputMap, - { + }; + output: ConfigurableExtensionDataRef< + { + [x: string]: IconComponent; + }, + 'core.icons', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { icons: ConfigurableExtensionDataRef< - 'core.icons', { [x: string]: IconComponent; }, - {} - >; - }, - { - icons: string; - test: string; - }, - { - test: string; - icons?: string | undefined; - }, - { - icons: ConfigurableExtensionDataRef< 'core.icons', - { - [x: string]: IconComponent; - }, {} >; - } ->; + }; +}>; // @public export type IconComponent = ComponentType< @@ -1267,6 +1311,71 @@ export { identityApiRef }; export { microsoftAuthApiRef }; +// @public +export const NavItemBlueprint: ExtensionBlueprint<{ + kind: 'nav-item'; + name: undefined; + params: { + title: string; + icon: IconComponent_2; + routeRef: RouteRef; + }; + output: ConfigurableExtensionDataRef< + { + title: string; + icon: IconComponent_2; + routeRef: RouteRef; + }, + 'core.nav-item.target', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + target: ConfigurableExtensionDataRef< + { + title: string; + icon: IconComponent_2; + routeRef: RouteRef; + }, + 'core.nav-item.target', + {} + >; + }; +}>; + +// @public +export const NavLogoBlueprint: ExtensionBlueprint<{ + kind: 'nav-logo'; + name: undefined; + params: { + logoIcon: JSX.Element; + logoFull: JSX.Element; + }; + output: ConfigurableExtensionDataRef< + { + logoIcon?: JSX.Element | undefined; + logoFull?: JSX.Element | undefined; + }, + 'core.nav-logo.logo-elements', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + logoElements: ConfigurableExtensionDataRef< + { + logoIcon?: JSX.Element | undefined; + logoFull?: JSX.Element | undefined; + }, + 'core.nav-logo.logo-elements', + {} + >; + }; +}>; + export { OAuthApi }; export { OAuthRequestApi }; @@ -1285,23 +1394,54 @@ export { oneloginAuthApiRef }; export { OpenIdConnectApi }; +// @public +export const PageBlueprint: ExtensionBlueprint<{ + kind: 'page'; + name: undefined; + params: { + defaultPath: string; + loader: () => Promise; + routeRef?: RouteRef | undefined; + }; + output: + | ConfigurableExtensionDataRef + | ConfigurableExtensionDataRef + | ConfigurableExtensionDataRef< + RouteRef, + 'core.routing.ref', + { + optional: true; + } + >; + inputs: {}; + config: { + path: string | undefined; + }; + configInput: { + path?: string | undefined; + }; + dataRefs: never; +}>; + export { PendingOAuthRequest }; // @public (undocumented) export interface PluginOptions< - Routes extends AnyRoutes, - ExternalRoutes extends AnyExternalRoutes, + TId extends string, + TRoutes extends AnyRoutes, + TExternalRoutes extends AnyExternalRoutes, + TExtensions extends readonly ExtensionDefinition[], > { // (undocumented) - extensions?: ExtensionDefinition[]; + extensions?: TExtensions; // (undocumented) - externalRoutes?: ExternalRoutes; + externalRoutes?: TExternalRoutes; // (undocumented) featureFlags?: FeatureFlagConfig[]; // (undocumented) - id: string; + id: TId; // (undocumented) - routes?: Routes; + routes?: TRoutes; } // @public (undocumented) @@ -1315,11 +1455,13 @@ export { ProfileInfo }; export { ProfileInfoApi }; // @public -export type ResolvedExtensionInput = - { - node: AppNode; - output: ExtensionDataValues; - }; +export type ResolvedExtensionInput< + TExtensionInput extends ExtensionInput, +> = TExtensionInput['extensionData'] extends Array + ? { + node: AppNode; + } & ExtensionDataContainer + : never; // @public export type ResolvedExtensionInputs< @@ -1328,14 +1470,79 @@ export type ResolvedExtensionInputs< }, > = { [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton'] - ? Array>> + ? Array>> : false extends TInputs[InputName]['config']['optional'] - ? Expand> - : Expand< - ResolvedExtensionInput | undefined - >; + ? Expand> + : Expand | undefined>; }; +// @public (undocumented) +export type ResolveInputValueOverrides< + TInputs extends { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + } = { + [inputName in string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }, +> = Expand< + { + [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< + any, + { + optional: infer IOptional extends boolean; + singleton: boolean; + } + > + ? IOptional extends true + ? never + : KName + : never]: TInputs[KName] extends ExtensionInput< + infer IDataRefs, + { + optional: boolean; + singleton: infer ISingleton extends boolean; + } + > + ? ISingleton extends true + ? Iterable> + : Array>> + : never; + } & { + [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< + any, + { + optional: infer IOptional extends boolean; + singleton: boolean; + } + > + ? IOptional extends true + ? KName + : never + : never]?: TInputs[KName] extends ExtensionInput< + infer IDataRefs, + { + optional: boolean; + singleton: infer ISingleton extends boolean; + } + > + ? ISingleton extends true + ? Iterable> + : Array>> + : never; + } +>; + // @public export type RouteFunc = ( ...[params]: TParams extends undefined @@ -1343,6 +1550,34 @@ export type RouteFunc = ( : readonly [params: TParams] ) => string; +// @public (undocumented) +export const RouterBlueprint: ExtensionBlueprint<{ + kind: 'app-router-component'; + name: undefined; + params: { + Component: ComponentType>; + }; + output: ConfigurableExtensionDataRef< + ComponentType<{ + children?: ReactNode; + }>, + 'app.router.wrapper', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + component: ConfigurableExtensionDataRef< + ComponentType<{ + children?: ReactNode; + }>, + 'app.router.wrapper', + {} + >; + }; +}>; + // @public export interface RouteRef< TParams extends AnyRouteRefParams = AnyRouteRefParams, @@ -1360,7 +1595,7 @@ export interface RouteResolutionApi { anyRouteRef: | RouteRef | SubRouteRef - | ExternalRouteRef, + | ExternalRouteRef, options?: RouteResolutionApiResolveOptions, ): RouteFunc | undefined; } @@ -1377,6 +1612,30 @@ export { SessionApi }; export { SessionState }; +// @public +export const SignInPageBlueprint: ExtensionBlueprint<{ + kind: 'sign-in-page'; + name: undefined; + params: { + loader: () => Promise>; + }; + output: ConfigurableExtensionDataRef< + React_2.ComponentType, + 'core.sign-in-page.component', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + component: ConfigurableExtensionDataRef< + React_2.ComponentType, + 'core.sign-in-page.component', + {} + >; + }; +}>; + export { StorageApi }; export { storageApiRef }; @@ -1395,6 +1654,60 @@ export interface SubRouteRef< readonly T: TParams; } +// @public +export const ThemeBlueprint: ExtensionBlueprint<{ + kind: 'theme'; + name: undefined; + params: { + theme: AppTheme; + }; + output: ConfigurableExtensionDataRef; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + theme: ConfigurableExtensionDataRef; + }; +}>; + +// @public +export const TranslationBlueprint: ExtensionBlueprint<{ + kind: 'translation'; + name: undefined; + params: { + resource: TranslationResource | TranslationMessages; + }; + output: ConfigurableExtensionDataRef< + | TranslationResource + | TranslationMessages< + string, + { + [x: string]: string; + }, + boolean + >, + 'core.translation.translation', + {} + >; + inputs: {}; + config: {}; + configInput: {}; + dataRefs: { + translation: ConfigurableExtensionDataRef< + | TranslationResource + | TranslationMessages< + string, + { + [x: string]: string; + }, + boolean + >, + 'core.translation.translation', + {} + >; + }; +}>; + export { TranslationMessages }; export { TranslationMessagesOptions }; @@ -1421,18 +1734,13 @@ export function useComponentRef( ref: ComponentRef, ): ComponentType; -// @public -export function useRouteRef< - TOptional extends boolean, - TParams extends AnyRouteRefParams, ->( - routeRef: ExternalRouteRef, -): TOptional extends true ? RouteFunc | undefined : RouteFunc; - // @public export function useRouteRef( - routeRef: RouteRef | SubRouteRef, -): RouteFunc; + routeRef: + | RouteRef + | SubRouteRef + | ExternalRouteRef, +): RouteFunc | undefined; // @public export function useRouteRefParams( @@ -1461,120 +1769,89 @@ export { withApis }; // src/apis/definitions/RouteResolutionApi.d.ts:19:1 - (ae-undocumented) Missing documentation for "RouteResolutionApiResolveOptions". // src/apis/definitions/RouteResolutionApi.d.ts:29:1 - (ae-undocumented) Missing documentation for "RouteResolutionApi". // src/apis/definitions/RouteResolutionApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "resolve". +// src/blueprints/IconBundleBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "IconBundleBlueprint". +// src/blueprints/RouterBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "RouterBlueprint". // src/components/ExtensionBoundary.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionBoundaryProps". // src/components/ExtensionBoundary.d.ts:5:5 - (ae-undocumented) Missing documentation for "node". // src/components/ExtensionBoundary.d.ts:12:5 - (ae-undocumented) Missing documentation for "children". // src/components/ExtensionBoundary.d.ts:15:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". +// src/components/ExtensionBoundary.d.ts:17:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". +// src/components/ExtensionBoundary.d.ts:18:5 - (ae-undocumented) Missing documentation for "lazy". // src/components/coreComponentRefs.d.ts:3:22 - (ae-undocumented) Missing documentation for "coreComponentRefs". // src/components/createComponentRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ComponentRef". // src/components/createComponentRef.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentRef". -// src/extensions/IconBundleBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "IconBundleBlueprint". -// src/extensions/createApiExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createApiExtension". -// src/extensions/createApiExtension.d.ts:20:1 - (ae-undocumented) Missing documentation for "createApiExtension". -// src/extensions/createApiExtension.d.ts:21:11 - (ae-undocumented) Missing documentation for "factoryDataRef". -// src/extensions/createAppRootWrapperExtension.d.ts:28:1 - (ae-undocumented) Missing documentation for "createAppRootWrapperExtension". -// src/extensions/createAppRootWrapperExtension.d.ts:29:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/extensions/createComponentExtension.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentExtension". -// src/extensions/createComponentExtension.d.ts:26:1 - (ae-undocumented) Missing documentation for "createComponentExtension". -// src/extensions/createComponentExtension.d.ts:27:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/extensions/createNavItemExtension.d.ts:19:1 - (ae-undocumented) Missing documentation for "createNavItemExtension". -// src/extensions/createNavItemExtension.d.ts:20:11 - (ae-undocumented) Missing documentation for "targetDataRef". -// src/extensions/createNavLogoExtension.d.ts:13:1 - (ae-undocumented) Missing documentation for "createNavLogoExtension". -// src/extensions/createNavLogoExtension.d.ts:14:11 - (ae-undocumented) Missing documentation for "logoElementsDataRef". -// src/extensions/createRouterExtension.d.ts:28:1 - (ae-undocumented) Missing documentation for "createRouterExtension". -// src/extensions/createRouterExtension.d.ts:29:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/extensions/createSignInPageExtension.d.ts:10:1 - (ae-undocumented) Missing documentation for "createSignInPageExtension". -// src/extensions/createSignInPageExtension.d.ts:26:1 - (ae-undocumented) Missing documentation for "createSignInPageExtension". -// src/extensions/createSignInPageExtension.d.ts:27:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/extensions/createThemeExtension.d.ts:3:1 - (ae-undocumented) Missing documentation for "createThemeExtension". -// src/extensions/createThemeExtension.d.ts:5:1 - (ae-undocumented) Missing documentation for "createThemeExtension". -// src/extensions/createThemeExtension.d.ts:6:11 - (ae-undocumented) Missing documentation for "themeDataRef". -// src/extensions/createTranslationExtension.d.ts:3:1 - (ae-undocumented) Missing documentation for "createTranslationExtension". -// src/extensions/createTranslationExtension.d.ts:8:1 - (ae-undocumented) Missing documentation for "createTranslationExtension". -// src/extensions/createTranslationExtension.d.ts:9:11 - (ae-undocumented) Missing documentation for "translationDataRef". +// src/extensions/createComponentExtension.d.ts:4:1 - (ae-undocumented) Missing documentation for "createComponentExtension". +// src/extensions/createComponentExtension.d.ts:31:1 - (ae-undocumented) Missing documentation for "createComponentExtension". +// src/extensions/createComponentExtension.d.ts:32:11 - (ae-undocumented) Missing documentation for "componentDataRef". // src/routing/ExternalRouteRef.d.ts:12:5 - (ae-undocumented) Missing documentation for "$$type". // src/routing/ExternalRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "T". -// src/routing/ExternalRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "optional". // src/routing/RouteRef.d.ts:12:5 - (ae-undocumented) Missing documentation for "$$type". // src/routing/RouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "T". // src/routing/SubRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "$$type". // src/routing/SubRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "T". // src/routing/SubRouteRef.d.ts:15:5 - (ae-undocumented) Missing documentation for "path". -// src/schema/createSchemaFromZod.d.ts:7:1 - (ae-undocumented) Missing documentation for "createSchemaFromZod". // src/schema/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PortableSchema". // src/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "CoreProgressProps". // src/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "CoreNotFoundErrorPageProps". // src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CoreErrorBoundaryFallbackProps". // src/wiring/coreExtensionData.d.ts:4:22 - (ae-undocumented) Missing documentation for "coreExtensionData". -// src/wiring/createExtension.d.ts:8:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataMap". -// src/wiring/createExtension.d.ts:14:1 - (ae-undocumented) Missing documentation for "AnyExtensionInputMap". -// src/wiring/createExtension.d.ts:51:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". -// src/wiring/createExtension.d.ts:54:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtension.d.ts:55:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtension.d.ts:56:5 - (ae-undocumented) Missing documentation for "name". -// src/wiring/createExtension.d.ts:57:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtension.d.ts:61:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtension.d.ts:62:5 - (ae-undocumented) Missing documentation for "inputs". -// src/wiring/createExtension.d.ts:63:5 - (ae-undocumented) Missing documentation for "output". -// src/wiring/createExtension.d.ts:65:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/createExtension.d.ts:66:5 - (ae-undocumented) Missing documentation for "config". -// src/wiring/createExtension.d.ts:69:5 - (ae-undocumented) Missing documentation for "factory". -// src/wiring/createExtension.d.ts:78:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". -// src/wiring/createExtension.d.ts:79:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createExtension.d.ts:80:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtension.d.ts:81:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtension.d.ts:82:5 - (ae-undocumented) Missing documentation for "name". -// src/wiring/createExtension.d.ts:83:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtension.d.ts:87:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtension.d.ts:88:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/createExtension.d.ts:91:1 - (ae-undocumented) Missing documentation for "createExtension". -// src/wiring/createExtensionBlueprint.d.ts:8:1 - (ae-undocumented) Missing documentation for "CreateExtensionBlueprintOptions". -// src/wiring/createExtensionBlueprint.d.ts:11:5 - (ae-undocumented) Missing documentation for "kind". -// src/wiring/createExtensionBlueprint.d.ts:12:5 - (ae-undocumented) Missing documentation for "namespace". -// src/wiring/createExtensionBlueprint.d.ts:13:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/createExtensionBlueprint.d.ts:17:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/createExtensionBlueprint.d.ts:18:5 - (ae-undocumented) Missing documentation for "inputs". -// src/wiring/createExtensionBlueprint.d.ts:19:5 - (ae-undocumented) Missing documentation for "output". -// src/wiring/createExtensionBlueprint.d.ts:20:5 - (ae-undocumented) Missing documentation for "config". -// src/wiring/createExtensionBlueprint.d.ts:23:5 - (ae-undocumented) Missing documentation for "factory". -// src/wiring/createExtensionBlueprint.d.ts:30:5 - (ae-undocumented) Missing documentation for "dataRefs". -// src/wiring/createExtensionBlueprint.d.ts:35:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprint". -// src/wiring/createExtensionBlueprint.d.ts:40:5 - (ae-undocumented) Missing documentation for "dataRefs". -// src/wiring/createExtensionDataRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:11:1 - (ae-undocumented) Missing documentation for "ConfigurableExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "optional". -// src/wiring/createExtensionDataRef.d.ts:22:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:24:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtension.d.ts:31:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". +// src/wiring/createExtension.d.ts:61:1 - (ae-undocumented) Missing documentation for "ExtensionDefinitionParameters". +// src/wiring/createExtension.d.ts:80:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". +// src/wiring/createExtension.d.ts:134:1 - (ae-undocumented) Missing documentation for "createExtension". +// src/wiring/createExtensionBlueprint.d.ts:12:1 - (ae-undocumented) Missing documentation for "CreateExtensionBlueprintOptions". +// src/wiring/createExtensionBlueprint.d.ts:45:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprintParameters". +// src/wiring/createExtensionBlueprint.d.ts:69:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprint". +// src/wiring/createExtensionBlueprint.d.ts:70:5 - (ae-undocumented) Missing documentation for "dataRefs". +// src/wiring/createExtensionBlueprint.d.ts:71:5 - (ae-undocumented) Missing documentation for "make". +// src/wiring/createExtensionDataContainer.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionDataContainer". +// src/wiring/createExtensionDataRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ExtensionDataValue". +// src/wiring/createExtensionDataRef.d.ts:8:1 - (ae-undocumented) Missing documentation for "ExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:17:1 - (ae-undocumented) Missing documentation for "ExtensionDataRefToValue". +// src/wiring/createExtensionDataRef.d.ts:19:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:23:1 - (ae-undocumented) Missing documentation for "ConfigurableExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:26:5 - (ae-undocumented) Missing documentation for "optional". +// src/wiring/createExtensionDataRef.d.ts:29:5 - (ae-undocumented) Missing documentation for "__call". +// src/wiring/createExtensionDataRef.d.ts:35:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". +// src/wiring/createExtensionDataRef.d.ts:37:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". // src/wiring/createExtensionInput.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionInput". -// src/wiring/createExtensionInput.d.ts:7:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createExtensionInput.d.ts:8:5 - (ae-undocumented) Missing documentation for "extensionData". -// src/wiring/createExtensionInput.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". -// src/wiring/createExtensionInput.d.ts:12:1 - (ae-undocumented) Missing documentation for "createExtensionInput". -// src/wiring/createExtensionOverrides.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionOverridesOptions". -// src/wiring/createExtensionOverrides.d.ts:5:5 - (ae-undocumented) Missing documentation for "extensions". -// src/wiring/createExtensionOverrides.d.ts:6:5 - (ae-undocumented) Missing documentation for "featureFlags". -// src/wiring/createExtensionOverrides.d.ts:9:1 - (ae-undocumented) Missing documentation for "createExtensionOverrides". -// src/wiring/createPlugin.d.ts:5:1 - (ae-undocumented) Missing documentation for "PluginOptions". -// src/wiring/createPlugin.d.ts:6:5 - (ae-undocumented) Missing documentation for "id". -// src/wiring/createPlugin.d.ts:7:5 - (ae-undocumented) Missing documentation for "routes". -// src/wiring/createPlugin.d.ts:8:5 - (ae-undocumented) Missing documentation for "externalRoutes". -// src/wiring/createPlugin.d.ts:9:5 - (ae-undocumented) Missing documentation for "extensions". -// src/wiring/createPlugin.d.ts:10:5 - (ae-undocumented) Missing documentation for "featureFlags". -// src/wiring/createPlugin.d.ts:19:1 - (ae-undocumented) Missing documentation for "createPlugin". -// src/wiring/resolveExtensionDefinition.d.ts:3:1 - (ae-undocumented) Missing documentation for "Extension". -// src/wiring/resolveExtensionDefinition.d.ts:4:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/resolveExtensionDefinition.d.ts:5:5 - (ae-undocumented) Missing documentation for "id". -// src/wiring/resolveExtensionDefinition.d.ts:6:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/resolveExtensionDefinition.d.ts:10:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/resolveExtensionDefinition.d.ts:11:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "AnyRoutes". -// src/wiring/types.d.ts:16:1 - (ae-undocumented) Missing documentation for "AnyExternalRoutes". -// src/wiring/types.d.ts:20:1 - (ae-undocumented) Missing documentation for "BackstagePlugin". -// src/wiring/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "id". -// src/wiring/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "routes". -// src/wiring/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "externalRoutes". -// src/wiring/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "ExtensionOverrides". -// src/wiring/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/types.d.ts:31:1 - (ae-undocumented) Missing documentation for "FrontendFeature". +// src/wiring/createExtensionInput.d.ts:9:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createExtensionInput.d.ts:10:5 - (ae-undocumented) Missing documentation for "extensionData". +// src/wiring/createExtensionInput.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". +// src/wiring/createExtensionInput.d.ts:12:5 - (ae-undocumented) Missing documentation for "replaces". +// src/wiring/createExtensionInput.d.ts:18:1 - (ae-undocumented) Missing documentation for "createExtensionInput". +// src/wiring/createFrontendModule.d.ts:4:1 - (ae-undocumented) Missing documentation for "CreateFrontendModuleOptions". +// src/wiring/createFrontendModule.d.ts:5:5 - (ae-undocumented) Missing documentation for "pluginId". +// src/wiring/createFrontendModule.d.ts:6:5 - (ae-undocumented) Missing documentation for "extensions". +// src/wiring/createFrontendModule.d.ts:7:5 - (ae-undocumented) Missing documentation for "featureFlags". +// src/wiring/createFrontendModule.d.ts:10:1 - (ae-undocumented) Missing documentation for "FrontendModule". +// src/wiring/createFrontendModule.d.ts:11:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createFrontendModule.d.ts:12:5 - (ae-undocumented) Missing documentation for "pluginId". +// src/wiring/createFrontendModule.d.ts:15:1 - (ae-undocumented) Missing documentation for "createFrontendModule". +// src/wiring/createFrontendPlugin.d.ts:5:1 - (ae-undocumented) Missing documentation for "FrontendPlugin". +// src/wiring/createFrontendPlugin.d.ts:10:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/createFrontendPlugin.d.ts:11:5 - (ae-undocumented) Missing documentation for "id". +// src/wiring/createFrontendPlugin.d.ts:12:5 - (ae-undocumented) Missing documentation for "routes". +// src/wiring/createFrontendPlugin.d.ts:13:5 - (ae-undocumented) Missing documentation for "externalRoutes". +// src/wiring/createFrontendPlugin.d.ts:14:5 - (ae-undocumented) Missing documentation for "getExtension". +// src/wiring/createFrontendPlugin.d.ts:15:5 - (ae-undocumented) Missing documentation for "withOverrides". +// src/wiring/createFrontendPlugin.d.ts:20:1 - (ae-undocumented) Missing documentation for "PluginOptions". +// src/wiring/createFrontendPlugin.d.ts:21:5 - (ae-undocumented) Missing documentation for "id". +// src/wiring/createFrontendPlugin.d.ts:22:5 - (ae-undocumented) Missing documentation for "routes". +// src/wiring/createFrontendPlugin.d.ts:23:5 - (ae-undocumented) Missing documentation for "externalRoutes". +// src/wiring/createFrontendPlugin.d.ts:24:5 - (ae-undocumented) Missing documentation for "extensions". +// src/wiring/createFrontendPlugin.d.ts:25:5 - (ae-undocumented) Missing documentation for "featureFlags". +// src/wiring/createFrontendPlugin.d.ts:28:1 - (ae-undocumented) Missing documentation for "createFrontendPlugin". +// src/wiring/resolveExtensionDefinition.d.ts:4:1 - (ae-undocumented) Missing documentation for "Extension". +// src/wiring/resolveExtensionDefinition.d.ts:5:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/resolveExtensionDefinition.d.ts:6:5 - (ae-undocumented) Missing documentation for "id". +// src/wiring/resolveExtensionDefinition.d.ts:7:5 - (ae-undocumented) Missing documentation for "attachTo". +// src/wiring/resolveExtensionDefinition.d.ts:11:5 - (ae-undocumented) Missing documentation for "disabled". +// src/wiring/resolveExtensionDefinition.d.ts:12:5 - (ae-undocumented) Missing documentation for "configSchema". +// src/wiring/resolveInputOverrides.d.ts:5:1 - (ae-undocumented) Missing documentation for "ResolveInputValueOverrides". +// src/wiring/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "AnyRoutes". +// src/wiring/types.d.ts:18:1 - (ae-undocumented) Missing documentation for "AnyExternalRoutes". +// src/wiring/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "ExtensionOverrides". +// src/wiring/types.d.ts:29:5 - (ae-undocumented) Missing documentation for "$$type". +// src/wiring/types.d.ts:35:1 - (ae-undocumented) Missing documentation for "FrontendFeature". ``` diff --git a/packages/frontend-test-utils/report.api.md b/packages/frontend-test-utils/report.api.md index ebe02dee2c..1337e5eb4f 100644 --- a/packages/frontend-test-utils/report.api.md +++ b/packages/frontend-test-utils/report.api.md @@ -145,9 +145,15 @@ export { withLogCollector }; // // src/apis/AnalyticsApi/MockAnalyticsApi.d.ts:10:5 - (ae-undocumented) Missing documentation for "captureEvent". // src/apis/AnalyticsApi/MockAnalyticsApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "getEvents". -// src/app/createExtensionTester.d.ts:5:1 - (ae-undocumented) Missing documentation for "ExtensionTester". -// src/app/createExtensionTester.d.ts:7:5 - (ae-undocumented) Missing documentation for "add". -// src/app/createExtensionTester.d.ts:10:5 - (ae-undocumented) Missing documentation for "render". -// src/app/createExtensionTester.d.ts:15:1 - (ae-undocumented) Missing documentation for "createExtensionTester". +// src/app/createExtensionTester.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionQuery". +// src/app/createExtensionTester.d.ts:7:5 - (ae-undocumented) Missing documentation for "node". +// src/app/createExtensionTester.d.ts:8:5 - (ae-undocumented) Missing documentation for "instance". +// src/app/createExtensionTester.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". +// src/app/createExtensionTester.d.ts:12:1 - (ae-undocumented) Missing documentation for "ExtensionTester". +// src/app/createExtensionTester.d.ts:14:5 - (ae-undocumented) Missing documentation for "add". +// src/app/createExtensionTester.d.ts:17:5 - (ae-undocumented) Missing documentation for "get". +// src/app/createExtensionTester.d.ts:18:5 - (ae-undocumented) Missing documentation for "query". +// src/app/createExtensionTester.d.ts:19:5 - (ae-undocumented) Missing documentation for "reactElement". +// src/app/createExtensionTester.d.ts:22:1 - (ae-undocumented) Missing documentation for "createExtensionTester". // src/deprecated.d.ts:5:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". ``` diff --git a/plugins/api-docs/report-alpha.api.md b/plugins/api-docs/report-alpha.api.md index 66fa1b1be5..274d5d4aac 100644 --- a/plugins/api-docs/report-alpha.api.md +++ b/plugins/api-docs/report-alpha.api.md @@ -429,7 +429,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/api-docs/report.api.md b/plugins/api-docs/report.api.md index 023b8e02ee..74318781c8 100644 --- a/plugins/api-docs/report.api.md +++ b/plugins/api-docs/report.api.md @@ -239,10 +239,11 @@ export type TrpcApiDefinitionWidgetProps = { // src/components/ApisCards/ConsumedApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConsumedApisCard". // src/components/ApisCards/HasApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "HasApisCard". // src/components/ApisCards/ProvidedApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ProvidedApisCard". -// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidgetProps". -// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidget". -// src/components/ComponentsCards/ConsumingComponentsCard.d.ts:6:22 - (ae-undocumented) Missing documentation for "ConsumingComponentsCard". -// src/components/ComponentsCards/ProvidingComponentsCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "ProvidingComponentsCard". +// src/components/AsyncApiDefinitionWidget/AsyncApiDefinition.d.ts:4:1 - (ae-undocumented) Missing documentation for "AsyncApiResolver". +// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:4:1 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidgetProps". +// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:9:22 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidget". +// src/components/ComponentsCards/ConsumingComponentsCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConsumingComponentsCard". +// src/components/ComponentsCards/ProvidingComponentsCard.d.ts:5:22 - (ae-undocumented) Missing documentation for "ProvidingComponentsCard". // src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "GraphQlDefinitionWidgetProps". // src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "GraphQlDefinitionWidget". // src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "OpenApiDefinitionWidgetProps". @@ -258,8 +259,8 @@ export type TrpcApiDefinitionWidgetProps = { // src/plugin.d.ts:10:22 - (ae-undocumented) Missing documentation for "ApiExplorerPage". // src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityApiDefinitionCard". // src/plugin.d.ts:14:22 - (ae-undocumented) Missing documentation for "EntityConsumedApisCard". -// src/plugin.d.ts:19:22 - (ae-undocumented) Missing documentation for "EntityConsumingComponentsCard". -// src/plugin.d.ts:23:22 - (ae-undocumented) Missing documentation for "EntityProvidedApisCard". -// src/plugin.d.ts:28:22 - (ae-undocumented) Missing documentation for "EntityProvidingComponentsCard". -// src/plugin.d.ts:32:22 - (ae-undocumented) Missing documentation for "EntityHasApisCard". +// src/plugin.d.ts:21:22 - (ae-undocumented) Missing documentation for "EntityConsumingComponentsCard". +// src/plugin.d.ts:26:22 - (ae-undocumented) Missing documentation for "EntityProvidedApisCard". +// src/plugin.d.ts:33:22 - (ae-undocumented) Missing documentation for "EntityProvidingComponentsCard". +// src/plugin.d.ts:38:22 - (ae-undocumented) Missing documentation for "EntityHasApisCard". ``` diff --git a/plugins/app-backend/report.api.md b/plugins/app-backend/report.api.md index 3de36b0338..ab36eb95d3 100644 --- a/plugins/app-backend/report.api.md +++ b/plugins/app-backend/report.api.md @@ -33,10 +33,10 @@ export interface RouterOptions { // Warnings were encountered during analysis: // -// src/service/router.d.ts:7:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:8:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:56:1 - (ae-undocumented) Missing documentation for "createRouter". +// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:61:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/app-visualizer/report.api.md b/plugins/app-visualizer/report.api.md index 7495797a79..15f7384c42 100644 --- a/plugins/app-visualizer/report.api.md +++ b/plugins/app-visualizer/report.api.md @@ -73,7 +73,7 @@ export default visualizerPlugin; // Warnings were encountered during analysis: // -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". +// src/plugin.d.ts:20:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/app/api-report.md b/plugins/app/api-report.md deleted file mode 100644 index c8fb0a94d9..0000000000 --- a/plugins/app/api-report.md +++ /dev/null @@ -1,713 +0,0 @@ -## API Report File for "@backstage/plugin-app" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -/// - -import { AnyApiFactory } from '@backstage/frontend-plugin-api'; -import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api'; -import { AnyRouteRefParams } from '@backstage/frontend-plugin-api'; -import { AppTheme } from '@backstage/frontend-plugin-api'; -import { ComponentRef } from '@backstage/frontend-plugin-api'; -import { ComponentType } from 'react'; -import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; -import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; -import { ExtensionInput } from '@backstage/frontend-plugin-api'; -import { FrontendPlugin } from '@backstage/frontend-plugin-api'; -import { IconComponent } from '@backstage/core-plugin-api'; -import { IconComponent as IconComponent_2 } from '@backstage/frontend-plugin-api'; -import { JSX as JSX_2 } from 'react'; -import { ReactNode } from 'react'; -import { RouteRef } from '@backstage/frontend-plugin-api'; -import { SignInPageProps } from '@backstage/core-plugin-api'; -import { TranslationMessages } from '@backstage/frontend-plugin-api'; -import { TranslationResource } from '@backstage/frontend-plugin-api'; - -// @public (undocumented) -const appPlugin: FrontendPlugin< - {}, - {}, - { - app: ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: { - root: ExtensionInput< - ConfigurableExtensionDataRef, - { - singleton: true; - optional: false; - } - >; - }; - params: never; - kind: undefined; - name: undefined; - }>; - 'api:app/app-language': ExtensionDefinition<{ - kind: 'api'; - name: 'app-language'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'app/layout': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: { - nav: ExtensionInput< - ConfigurableExtensionDataRef, - { - singleton: true; - optional: false; - } - >; - content: ExtensionInput< - ConfigurableExtensionDataRef, - { - singleton: true; - optional: false; - } - >; - }; - params: never; - kind: undefined; - name: 'layout'; - }>; - 'app/nav': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: { - items: ExtensionInput< - ConfigurableExtensionDataRef< - { - title: string; - icon: IconComponent; - routeRef: RouteRef; - }, - 'core.nav-item.target', - {} - >, - { - singleton: false; - optional: false; - } - >; - logos: ExtensionInput< - ConfigurableExtensionDataRef< - { - logoIcon?: JSX.Element | undefined; - logoFull?: JSX.Element | undefined; - }, - 'core.nav-logo.logo-elements', - {} - >, - { - singleton: true; - optional: true; - } - >; - }; - params: never; - kind: undefined; - name: 'nav'; - }>; - 'app/root': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: { - router: ExtensionInput< - ConfigurableExtensionDataRef< - ComponentType<{ - children?: ReactNode; - }>, - 'app.router.wrapper', - {} - >, - { - singleton: true; - optional: true; - } - >; - signInPage: ExtensionInput< - ConfigurableExtensionDataRef< - ComponentType, - 'core.sign-in-page.component', - {} - >, - { - singleton: true; - optional: true; - } - >; - children: ExtensionInput< - ConfigurableExtensionDataRef, - { - singleton: true; - optional: false; - } - >; - elements: ExtensionInput< - ConfigurableExtensionDataRef, - { - singleton: false; - optional: false; - } - >; - wrappers: ExtensionInput< - ConfigurableExtensionDataRef< - ComponentType<{ - children?: ReactNode; - }>, - 'app.root.wrapper', - {} - >, - { - singleton: false; - optional: false; - } - >; - }; - params: never; - kind: undefined; - name: 'root'; - }>; - 'app/routes': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: { - routes: ExtensionInput< - | ConfigurableExtensionDataRef - | ConfigurableExtensionDataRef - | ConfigurableExtensionDataRef< - RouteRef, - 'core.routing.ref', - { - optional: true; - } - >, - { - singleton: false; - optional: false; - } - >; - }; - params: never; - kind: undefined; - name: 'routes'; - }>; - 'api:app/app-theme': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: { - themes: ExtensionInput< - ConfigurableExtensionDataRef, - { - singleton: false; - optional: false; - } - >; - }; - kind: 'api'; - name: 'app-theme'; - params: { - factory: AnyApiFactory; - }; - }>; - 'theme:app/light': ExtensionDefinition<{ - kind: 'theme'; - name: 'light'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef; - inputs: {}; - params: { - theme: AppTheme; - }; - }>; - 'theme:app/dark': ExtensionDefinition<{ - kind: 'theme'; - name: 'dark'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef; - inputs: {}; - params: { - theme: AppTheme; - }; - }>; - 'api:app/components': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: { - components: ExtensionInput< - ConfigurableExtensionDataRef< - { - ref: ComponentRef; - impl: ComponentType; - }, - 'core.component.component', - {} - >, - { - singleton: false; - optional: false; - } - >; - }; - kind: 'api'; - name: 'components'; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/icons': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: { - icons: ExtensionInput< - ConfigurableExtensionDataRef< - { - [x: string]: IconComponent_2; - }, - 'core.icons', - {} - >, - { - singleton: false; - optional: false; - } - >; - }; - kind: 'api'; - name: 'icons'; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/feature-flags': ExtensionDefinition<{ - kind: 'api'; - name: 'feature-flags'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/translations': ExtensionDefinition<{ - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: { - translations: ExtensionInput< - ConfigurableExtensionDataRef< - | TranslationResource - | TranslationMessages< - string, - { - [x: string]: string; - }, - boolean - >, - 'core.translation.translation', - {} - >, - { - singleton: false; - optional: false; - } - >; - }; - kind: 'api'; - name: 'translations'; - params: { - factory: AnyApiFactory; - }; - }>; - 'app-root-element:app/oauth-request-dialog': ExtensionDefinition<{ - kind: 'app-root-element'; - name: 'oauth-request-dialog'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: {}; - params: { - element: JSX.Element | (() => JSX.Element); - }; - }>; - 'app-root-element:app/alert-display': ExtensionDefinition<{ - config: { - transientTimeoutMs: number; - anchorOrigin: { - horizontal: 'center' | 'left' | 'right'; - vertical: 'top' | 'bottom'; - }; - }; - configInput: { - anchorOrigin?: - | { - horizontal?: 'center' | 'left' | 'right' | undefined; - vertical?: 'top' | 'bottom' | undefined; - } - | undefined; - transientTimeoutMs?: number | undefined; - }; - output: ConfigurableExtensionDataRef< - JSX_2.Element, - 'core.reactElement', - {} - >; - inputs: { - [x: string]: ExtensionInput< - AnyExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }; - kind: 'app-root-element'; - name: 'alert-display'; - params: { - element: JSX.Element | (() => JSX.Element); - }; - }>; - 'api:app/discovery': ExtensionDefinition<{ - kind: 'api'; - name: 'discovery'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/alert': ExtensionDefinition<{ - kind: 'api'; - name: 'alert'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/analytics': ExtensionDefinition<{ - kind: 'api'; - name: 'analytics'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/error': ExtensionDefinition<{ - kind: 'api'; - name: 'error'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/storage': ExtensionDefinition<{ - kind: 'api'; - name: 'storage'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/fetch': ExtensionDefinition<{ - kind: 'api'; - name: 'fetch'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/oauth-request': ExtensionDefinition<{ - kind: 'api'; - name: 'oauth-request'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/google-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'google-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/microsoft-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'microsoft-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/github-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'github-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/okta-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'okta-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/gitlab-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'gitlab-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/onelogin-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'onelogin-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/bitbucket-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'bitbucket-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/bitbucket-server-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'bitbucket-server-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/atlassian-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'atlassian-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/vmware-cloud-auth': ExtensionDefinition<{ - kind: 'api'; - name: 'vmware-cloud-auth'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - 'api:app/permission': ExtensionDefinition<{ - kind: 'api'; - name: 'permission'; - config: {}; - configInput: {}; - output: ConfigurableExtensionDataRef< - AnyApiFactory, - 'core.api.factory', - {} - >; - inputs: {}; - params: { - factory: AnyApiFactory; - }; - }>; - } ->; -export default appPlugin; - -// (No @packageDocumentation comment for this package) -``` diff --git a/plugins/auth-backend-module-auth0-provider/api-report.md b/plugins/auth-backend-module-auth0-provider/api-report.md deleted file mode 100644 index fb7aa9d0ba..0000000000 --- a/plugins/auth-backend-module-auth0-provider/api-report.md +++ /dev/null @@ -1,25 +0,0 @@ -## API Report File for "@backstage/plugin-auth-backend-module-auth0-provider" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { BackendFeature } from '@backstage/backend-plugin-api'; -import { OAuthAuthenticator } from '@backstage/plugin-auth-node'; -import { PassportOAuthAuthenticatorHelper } from '@backstage/plugin-auth-node'; -import { PassportProfile } from '@backstage/plugin-auth-node'; - -// @public (undocumented) -export const auth0Authenticator: OAuthAuthenticator< - { - helper: PassportOAuthAuthenticatorHelper; - audience: string | undefined; - connection: string | undefined; - connectionScope: string | undefined; - }, - PassportProfile ->; - -// @public (undocumented) -const authModuleAuth0Provider: BackendFeature; -export default authModuleAuth0Provider; -``` diff --git a/plugins/auth-backend-module-bitbucket-server-provider/api-report.md b/plugins/auth-backend-module-bitbucket-server-provider/api-report.md deleted file mode 100644 index d5c484f6e3..0000000000 --- a/plugins/auth-backend-module-bitbucket-server-provider/api-report.md +++ /dev/null @@ -1,33 +0,0 @@ -## API Report File for "@backstage/plugin-auth-backend-module-bitbucket-server-provider" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { BackendFeature } from '@backstage/backend-plugin-api'; -import { OAuthAuthenticator } from '@backstage/plugin-auth-node'; -import { OAuthAuthenticatorResult } from '@backstage/plugin-auth-node'; -import { PassportOAuthAuthenticatorHelper } from '@backstage/plugin-auth-node'; -import { PassportProfile } from '@backstage/plugin-auth-node'; -import { SignInResolverFactory } from '@backstage/plugin-auth-node'; - -// @public (undocumented) -const authModuleBitbucketServerProvider: BackendFeature; -export default authModuleBitbucketServerProvider; - -// @public (undocumented) -export const bitbucketServerAuthenticator: OAuthAuthenticator< - { - helper: PassportOAuthAuthenticatorHelper; - host: string; - }, - PassportProfile ->; - -// @public -export namespace bitbucketServerSignInResolvers { - const emailMatchingUserEntityProfileEmail: SignInResolverFactory< - OAuthAuthenticatorResult, - unknown - >; -} -``` diff --git a/plugins/auth-backend/report.api.md b/plugins/auth-backend/report.api.md index fff72d034c..80976525d3 100644 --- a/plugins/auth-backend/report.api.md +++ b/plugins/auth-backend/report.api.md @@ -729,8 +729,8 @@ export type WebMessageResponse = WebMessageResponse_2; // src/providers/azure-easyauth/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "EasyAuthResult". // src/providers/bitbucket/provider.d.ts:9:1 - (ae-undocumented) Missing documentation for "BitbucketOAuthResult". // src/providers/bitbucket/provider.d.ts:23:1 - (ae-undocumented) Missing documentation for "BitbucketPassportProfile". -// src/providers/bitbucketServer/provider.d.ts:7:1 - (ae-undocumented) Missing documentation for "BitbucketServerOAuthResult". -// src/providers/cloudflare-access/provider.d.ts:89:1 - (ae-undocumented) Missing documentation for "CloudflareAccessResult". +// src/providers/bitbucketServer/provider.d.ts:9:1 - (ae-undocumented) Missing documentation for "BitbucketServerOAuthResult". +// src/providers/cloudflare-access/provider.d.ts:90:1 - (ae-undocumented) Missing documentation for "CloudflareAccessResult". // src/providers/github/provider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GithubOAuthResult". // src/providers/oauth2-proxy/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "OAuth2ProxyResult". // src/providers/oidc/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "OidcAuthResult". @@ -750,18 +750,18 @@ export type WebMessageResponse = WebMessageResponse_2; // src/providers/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "SignInInfo". // src/providers/types.d.ts:66:1 - (ae-undocumented) Missing documentation for "SignInResolver". // src/providers/types.d.ts:96:1 - (ae-undocumented) Missing documentation for "StateEncoder". -// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "database". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "tokenManager". -// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "tokenFactoryAlgorithm". -// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "providerFactories". -// src/service/router.d.ts:19:5 - (ae-undocumented) Missing documentation for "disableDefaultProviderFactories". -// src/service/router.d.ts:20:5 - (ae-undocumented) Missing documentation for "catalogApi". -// src/service/router.d.ts:21:5 - (ae-undocumented) Missing documentation for "ownershipResolver". -// src/service/router.d.ts:24:1 - (ae-undocumented) Missing documentation for "createRouter". +// src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "database". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "tokenManager". +// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:19:5 - (ae-undocumented) Missing documentation for "tokenFactoryAlgorithm". +// src/service/router.d.ts:20:5 - (ae-undocumented) Missing documentation for "providerFactories". +// src/service/router.d.ts:21:5 - (ae-undocumented) Missing documentation for "disableDefaultProviderFactories". +// src/service/router.d.ts:22:5 - (ae-undocumented) Missing documentation for "catalogApi". +// src/service/router.d.ts:23:5 - (ae-undocumented) Missing documentation for "ownershipResolver". +// src/service/router.d.ts:29:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/bitbucket-cloud-common/api-report.md b/plugins/bitbucket-cloud-common/api-report.md deleted file mode 100644 index 833a367c03..0000000000 --- a/plugins/bitbucket-cloud-common/api-report.md +++ /dev/null @@ -1,485 +0,0 @@ -## API Report File for "@backstage/plugin-bitbucket-cloud-common" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { BitbucketCloudIntegrationConfig } from '@backstage/integration'; - -// @public (undocumented) -export class BitbucketCloudClient { - // (undocumented) - static fromConfig( - config: BitbucketCloudIntegrationConfig, - ): BitbucketCloudClient; - // (undocumented) - listBranchesByRepository( - repository: string, - workspace: string, - options?: FilterAndSortOptions & PartialResponseOptions, - ): WithPagination; - // (undocumented) - listProjectsByWorkspace( - workspace: string, - options?: FilterAndSortOptions & PartialResponseOptions, - ): WithPagination; - // (undocumented) - listRepositoriesByWorkspace( - workspace: string, - options?: FilterAndSortOptions & PartialResponseOptions, - ): WithPagination; - // (undocumented) - listWorkspaces( - options?: FilterAndSortOptions & PartialResponseOptions, - ): WithPagination; - // (undocumented) - searchCode( - workspace: string, - query: string, - options?: FilterAndSortOptions & PartialResponseOptions, - ): WithPagination; -} - -// @public (undocumented) -export namespace Events { - // (undocumented) - export interface Change { - // (undocumented) - closed: boolean; - // (undocumented) - commits: Models.Commit[]; - // (undocumented) - created: boolean; - // (undocumented) - forced: boolean; - // (undocumented) - links: ChangeLinks; - // (undocumented) - new: Models.Branch; - // (undocumented) - old: Models.Branch; - // (undocumented) - truncated: boolean; - } - // (undocumented) - export interface ChangeLinks { - // (undocumented) - commits: Models.Link; - // (undocumented) - diff: Models.Link; - // (undocumented) - html: Models.Link; - } - // (undocumented) - export interface RepoEvent { - // (undocumented) - actor: Models.Account; - // (undocumented) - repository: Models.Repository & { - workspace: Models.Workspace; - }; - } - // (undocumented) - export interface RepoPush { - // (undocumented) - changes: Change[]; - } - // (undocumented) - export interface RepoPushEvent extends RepoEvent { - // (undocumented) - push: RepoPush; - } -} - -// @public (undocumented) -export type FilterAndSortOptions = { - q?: string; - sort?: string; -}; - -// @public (undocumented) -export namespace Models { - export interface Account extends ModelObject { - // (undocumented) - created_on?: string; - // (undocumented) - display_name?: string; - // (undocumented) - links?: AccountLinks; - // (undocumented) - username?: string; - // (undocumented) - uuid?: string; - } - export interface AccountLinks { - // (undocumented) - [key: string]: unknown; - // (undocumented) - avatar?: Link; - } - export interface Author extends ModelObject { - raw?: string; - // (undocumented) - user?: Account; - } - export interface BaseCommit extends ModelObject { - // (undocumented) - author?: Author; - // (undocumented) - date?: string; - // (undocumented) - hash?: string; - // (undocumented) - message?: string; - // (undocumented) - parents?: Array; - // (undocumented) - summary?: BaseCommitSummary; - } - // (undocumented) - export interface BaseCommitSummary { - html?: string; - markup?: BaseCommitSummaryMarkupEnum; - raw?: string; - } - const BaseCommitSummaryMarkupEnum: { - readonly Markdown: 'markdown'; - readonly Creole: 'creole'; - readonly Plaintext: 'plaintext'; - }; - export type BaseCommitSummaryMarkupEnum = - (typeof BaseCommitSummaryMarkupEnum)[keyof typeof BaseCommitSummaryMarkupEnum]; - export interface Branch { - default_merge_strategy?: string; - // (undocumented) - links?: RefLinks; - merge_strategies?: Array; - name?: string; - // (undocumented) - target?: Commit; - // (undocumented) - type: string; - } - const BranchMergeStrategiesEnum: { - readonly MergeCommit: 'merge_commit'; - readonly Squash: 'squash'; - readonly FastForward: 'fast_forward'; - }; - export type BranchMergeStrategiesEnum = - (typeof BranchMergeStrategiesEnum)[keyof typeof BranchMergeStrategiesEnum]; - export interface Commit extends BaseCommit { - // (undocumented) - participants?: Array; - // (undocumented) - repository?: Repository; - } - export interface CommitFile { - // (undocumented) - [key: string]: unknown; - // (undocumented) - attributes?: CommitFileAttributesEnum; - // (undocumented) - commit?: Commit; - escaped_path?: string; - path?: string; - // (undocumented) - type: string; - } - const // (undocumented) - CommitFileAttributesEnum: { - readonly Link: 'link'; - readonly Executable: 'executable'; - readonly Subrepository: 'subrepository'; - readonly Binary: 'binary'; - readonly Lfs: 'lfs'; - }; - // (undocumented) - export type CommitFileAttributesEnum = - (typeof CommitFileAttributesEnum)[keyof typeof CommitFileAttributesEnum]; - export interface Link { - // (undocumented) - href?: string; - // (undocumented) - name?: string; - } - export interface ModelObject { - // (undocumented) - [key: string]: unknown; - // (undocumented) - type: string; - } - export interface Paginated { - next?: string; - page?: number; - pagelen?: number; - previous?: string; - size?: number; - values?: Array | Set; - } - export interface PaginatedBranches extends Paginated { - values?: Set; - } - export interface PaginatedProjects extends Paginated { - values?: Set; - } - export interface PaginatedRepositories extends Paginated { - values?: Set; - } - export interface PaginatedWorkspaces extends Paginated { - values?: Set; - } - export interface Participant extends ModelObject { - // (undocumented) - approved?: boolean; - participated_on?: string; - // (undocumented) - role?: ParticipantRoleEnum; - // (undocumented) - state?: ParticipantStateEnum; - // (undocumented) - user?: Account; - } - const // (undocumented) - ParticipantRoleEnum: { - readonly Participant: 'PARTICIPANT'; - readonly Reviewer: 'REVIEWER'; - }; - // (undocumented) - export type ParticipantRoleEnum = - (typeof ParticipantRoleEnum)[keyof typeof ParticipantRoleEnum]; - const // (undocumented) - ParticipantStateEnum: { - readonly Approved: 'approved'; - readonly ChangesRequested: 'changes_requested'; - readonly Null: 'null'; - }; - // (undocumented) - export type ParticipantStateEnum = - (typeof ParticipantStateEnum)[keyof typeof ParticipantStateEnum]; - export interface Project extends ModelObject { - // (undocumented) - created_on?: string; - // (undocumented) - description?: string; - has_publicly_visible_repos?: boolean; - is_private?: boolean; - key?: string; - // (undocumented) - links?: ProjectLinks; - name?: string; - // (undocumented) - owner?: Team; - // (undocumented) - updated_on?: string; - uuid?: string; - } - // (undocumented) - export interface ProjectLinks { - // (undocumented) - avatar?: Link; - // (undocumented) - html?: Link; - } - // (undocumented) - export interface RefLinks { - // (undocumented) - commits?: Link; - // (undocumented) - html?: Link; - // (undocumented) - self?: Link; - } - export interface Repository extends ModelObject { - // (undocumented) - created_on?: string; - // (undocumented) - description?: string; - fork_policy?: RepositoryForkPolicyEnum; - full_name?: string; - has_issues?: boolean; - has_wiki?: boolean; - // (undocumented) - is_private?: boolean; - // (undocumented) - language?: string; - // (undocumented) - links?: RepositoryLinks; - // (undocumented) - mainbranch?: Branch; - // (undocumented) - name?: string; - // (undocumented) - owner?: Account; - // (undocumented) - parent?: Repository; - // (undocumented) - project?: Project; - // (undocumented) - scm?: RepositoryScmEnum; - // (undocumented) - size?: number; - slug?: string; - // (undocumented) - updated_on?: string; - uuid?: string; - } - const RepositoryForkPolicyEnum: { - readonly AllowForks: 'allow_forks'; - readonly NoPublicForks: 'no_public_forks'; - readonly NoForks: 'no_forks'; - }; - export type RepositoryForkPolicyEnum = - (typeof RepositoryForkPolicyEnum)[keyof typeof RepositoryForkPolicyEnum]; - const // (undocumented) - RepositoryScmEnum: { - readonly Git: 'git'; - }; - // (undocumented) - export interface RepositoryLinks { - // (undocumented) - avatar?: Link; - // (undocumented) - clone?: Array; - // (undocumented) - commits?: Link; - // (undocumented) - downloads?: Link; - // (undocumented) - forks?: Link; - // (undocumented) - hooks?: Link; - // (undocumented) - html?: Link; - // (undocumented) - pullrequests?: Link; - // (undocumented) - self?: Link; - // (undocumented) - watchers?: Link; - } - // (undocumented) - export type RepositoryScmEnum = - (typeof RepositoryScmEnum)[keyof typeof RepositoryScmEnum]; - // (undocumented) - export interface SearchCodeSearchResult { - // (undocumented) - readonly content_match_count?: number; - // (undocumented) - readonly content_matches?: Array; - // (undocumented) - file?: CommitFile; - // (undocumented) - readonly path_matches?: Array; - // (undocumented) - readonly type?: string; - } - // (undocumented) - export interface SearchContentMatch { - // (undocumented) - readonly lines?: Array; - } - // (undocumented) - export interface SearchLine { - // (undocumented) - readonly line?: number; - // (undocumented) - readonly segments?: Array; - } - // (undocumented) - export interface SearchResultPage extends Paginated { - // (undocumented) - readonly query_substituted?: boolean; - readonly values?: Array; - } - // (undocumented) - export interface SearchSegment { - // (undocumented) - readonly match?: boolean; - // (undocumented) - readonly text?: string; - } - export interface Team extends Account { - // (undocumented) - links?: TeamLinks; - } - export interface TeamLinks extends AccountLinks { - // (undocumented) - html?: Link; - // (undocumented) - members?: Link; - // (undocumented) - projects?: Link; - // (undocumented) - repositories?: Link; - // (undocumented) - self?: Link; - } - export interface Workspace extends ModelObject { - // (undocumented) - created_on?: string; - is_private?: boolean; - // (undocumented) - links?: WorkspaceLinks; - name?: string; - slug?: string; - // (undocumented) - updated_on?: string; - uuid?: string; - } - // (undocumented) - export interface WorkspaceLinks { - // (undocumented) - avatar?: Link; - // (undocumented) - html?: Link; - // (undocumented) - members?: Link; - // (undocumented) - owners?: Link; - // (undocumented) - projects?: Link; - // (undocumented) - repositories?: Link; - // (undocumented) - self?: Link; - // (undocumented) - snippets?: Link; - } -} - -// @public (undocumented) -export type PaginationOptions = { - page?: number; - pagelen?: number; -}; - -// @public (undocumented) -export type PartialResponseOptions = { - fields?: string; -}; - -// @public (undocumented) -export type RequestOptions = FilterAndSortOptions & - PaginationOptions & - PartialResponseOptions & { - [key: string]: string | number | undefined; - }; - -// @public (undocumented) -export class WithPagination< - TPage extends Models.Paginated, - TResultItem, -> { - constructor( - createUrl: (options: PaginationOptions) => URL, - fetch: (url: URL) => Promise, - ); - // (undocumented) - getPage(options?: PaginationOptions): Promise; - // (undocumented) - iteratePages(options?: PaginationOptions): AsyncGenerator; - // (undocumented) - iterateResults( - options?: PaginationOptions, - ): AsyncGenerator, void, unknown>; -} -``` diff --git a/plugins/bitbucket-cloud-common/report.api.md b/plugins/bitbucket-cloud-common/report.api.md index 93fcbffbc6..ebad8ff878 100644 --- a/plugins/bitbucket-cloud-common/report.api.md +++ b/plugins/bitbucket-cloud-common/report.api.md @@ -12,6 +12,12 @@ export class BitbucketCloudClient { config: BitbucketCloudIntegrationConfig, ): BitbucketCloudClient; // (undocumented) + listBranchesByRepository( + repository: string, + workspace: string, + options?: FilterAndSortOptions & PartialResponseOptions, + ): WithPagination; + // (undocumented) listProjectsByWorkspace( workspace: string, options?: FilterAndSortOptions & PartialResponseOptions, @@ -209,6 +215,9 @@ export namespace Models { size?: number; values?: Array | Set; } + export interface PaginatedBranches extends Paginated { + values?: Set; + } export interface PaginatedProjects extends Paginated { values?: Set; } @@ -482,6 +491,7 @@ export class WithPagination< // src/BitbucketCloudClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "listRepositoriesByWorkspace". // src/BitbucketCloudClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "listProjectsByWorkspace". // src/BitbucketCloudClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "listWorkspaces". +// src/BitbucketCloudClient.d.ts:14:5 - (ae-undocumented) Missing documentation for "listBranchesByRepository". // src/events/index.d.ts:3:1 - (ae-undocumented) Missing documentation for "Events". // src/events/index.d.ts:5:5 - (ae-undocumented) Missing documentation for "RepoEvent". // src/events/index.d.ts:6:9 - (ae-undocumented) Missing documentation for "repository". @@ -534,86 +544,86 @@ export class WithPagination< // src/models/index.d.ts:168:9 - (ae-undocumented) Missing documentation for "name". // src/models/index.d.ts:175:9 - (ae-undocumented) Missing documentation for "__index". // src/models/index.d.ts:176:9 - (ae-undocumented) Missing documentation for "type". -// src/models/index.d.ts:243:9 - (ae-undocumented) Missing documentation for "approved". -// src/models/index.d.ts:248:9 - (ae-undocumented) Missing documentation for "role". -// src/models/index.d.ts:249:9 - (ae-undocumented) Missing documentation for "state". -// src/models/index.d.ts:250:9 - (ae-undocumented) Missing documentation for "user". -// src/models/index.d.ts:255:11 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". -// src/models/index.d.ts:262:5 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". -// src/models/index.d.ts:266:11 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". -// src/models/index.d.ts:274:5 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". -// src/models/index.d.ts:281:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:282:9 - (ae-undocumented) Missing documentation for "description". -// src/models/index.d.ts:300:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:305:9 - (ae-undocumented) Missing documentation for "owner". -// src/models/index.d.ts:306:9 - (ae-undocumented) Missing documentation for "updated_on". -// src/models/index.d.ts:315:5 - (ae-undocumented) Missing documentation for "ProjectLinks". -// src/models/index.d.ts:316:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:317:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:322:5 - (ae-undocumented) Missing documentation for "RefLinks". -// src/models/index.d.ts:323:9 - (ae-undocumented) Missing documentation for "commits". -// src/models/index.d.ts:324:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:325:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:332:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:333:9 - (ae-undocumented) Missing documentation for "description". -// src/models/index.d.ts:362:9 - (ae-undocumented) Missing documentation for "is_private". -// src/models/index.d.ts:363:9 - (ae-undocumented) Missing documentation for "language". -// src/models/index.d.ts:364:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:365:9 - (ae-undocumented) Missing documentation for "mainbranch". -// src/models/index.d.ts:366:9 - (ae-undocumented) Missing documentation for "name". -// src/models/index.d.ts:367:9 - (ae-undocumented) Missing documentation for "owner". -// src/models/index.d.ts:368:9 - (ae-undocumented) Missing documentation for "parent". -// src/models/index.d.ts:369:9 - (ae-undocumented) Missing documentation for "project". -// src/models/index.d.ts:370:9 - (ae-undocumented) Missing documentation for "scm". -// src/models/index.d.ts:371:9 - (ae-undocumented) Missing documentation for "size". -// src/models/index.d.ts:376:9 - (ae-undocumented) Missing documentation for "updated_on". -// src/models/index.d.ts:411:11 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". -// src/models/index.d.ts:417:5 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". -// src/models/index.d.ts:421:5 - (ae-undocumented) Missing documentation for "RepositoryLinks". -// src/models/index.d.ts:422:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:423:9 - (ae-undocumented) Missing documentation for "clone". -// src/models/index.d.ts:424:9 - (ae-undocumented) Missing documentation for "commits". -// src/models/index.d.ts:425:9 - (ae-undocumented) Missing documentation for "downloads". -// src/models/index.d.ts:426:9 - (ae-undocumented) Missing documentation for "forks". -// src/models/index.d.ts:427:9 - (ae-undocumented) Missing documentation for "hooks". -// src/models/index.d.ts:428:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:429:9 - (ae-undocumented) Missing documentation for "pullrequests". -// src/models/index.d.ts:430:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:431:9 - (ae-undocumented) Missing documentation for "watchers". -// src/models/index.d.ts:436:5 - (ae-undocumented) Missing documentation for "SearchCodeSearchResult". -// src/models/index.d.ts:437:9 - (ae-undocumented) Missing documentation for "content_match_count". -// src/models/index.d.ts:438:9 - (ae-undocumented) Missing documentation for "content_matches". -// src/models/index.d.ts:439:9 - (ae-undocumented) Missing documentation for "file". -// src/models/index.d.ts:440:9 - (ae-undocumented) Missing documentation for "path_matches". -// src/models/index.d.ts:441:9 - (ae-undocumented) Missing documentation for "type". -// src/models/index.d.ts:446:5 - (ae-undocumented) Missing documentation for "SearchContentMatch". -// src/models/index.d.ts:447:9 - (ae-undocumented) Missing documentation for "lines". -// src/models/index.d.ts:452:5 - (ae-undocumented) Missing documentation for "SearchLine". -// src/models/index.d.ts:453:9 - (ae-undocumented) Missing documentation for "line". -// src/models/index.d.ts:454:9 - (ae-undocumented) Missing documentation for "segments". -// src/models/index.d.ts:459:5 - (ae-undocumented) Missing documentation for "SearchResultPage". -// src/models/index.d.ts:460:9 - (ae-undocumented) Missing documentation for "query_substituted". -// src/models/index.d.ts:469:5 - (ae-undocumented) Missing documentation for "SearchSegment". -// src/models/index.d.ts:470:9 - (ae-undocumented) Missing documentation for "match". -// src/models/index.d.ts:471:9 - (ae-undocumented) Missing documentation for "text". -// src/models/index.d.ts:478:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:485:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:486:9 - (ae-undocumented) Missing documentation for "members". -// src/models/index.d.ts:487:9 - (ae-undocumented) Missing documentation for "projects". -// src/models/index.d.ts:488:9 - (ae-undocumented) Missing documentation for "repositories". -// src/models/index.d.ts:489:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:497:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:503:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:512:9 - (ae-undocumented) Missing documentation for "updated_on". -// src/models/index.d.ts:521:5 - (ae-undocumented) Missing documentation for "WorkspaceLinks". -// src/models/index.d.ts:522:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:523:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:524:9 - (ae-undocumented) Missing documentation for "members". -// src/models/index.d.ts:525:9 - (ae-undocumented) Missing documentation for "owners". -// src/models/index.d.ts:526:9 - (ae-undocumented) Missing documentation for "projects". -// src/models/index.d.ts:527:9 - (ae-undocumented) Missing documentation for "repositories". -// src/models/index.d.ts:528:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:529:9 - (ae-undocumented) Missing documentation for "snippets". +// src/models/index.d.ts:253:9 - (ae-undocumented) Missing documentation for "approved". +// src/models/index.d.ts:258:9 - (ae-undocumented) Missing documentation for "role". +// src/models/index.d.ts:259:9 - (ae-undocumented) Missing documentation for "state". +// src/models/index.d.ts:260:9 - (ae-undocumented) Missing documentation for "user". +// src/models/index.d.ts:265:11 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". +// src/models/index.d.ts:272:5 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". +// src/models/index.d.ts:276:11 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". +// src/models/index.d.ts:284:5 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". +// src/models/index.d.ts:291:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:292:9 - (ae-undocumented) Missing documentation for "description". +// src/models/index.d.ts:310:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:315:9 - (ae-undocumented) Missing documentation for "owner". +// src/models/index.d.ts:316:9 - (ae-undocumented) Missing documentation for "updated_on". +// src/models/index.d.ts:325:5 - (ae-undocumented) Missing documentation for "ProjectLinks". +// src/models/index.d.ts:326:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:327:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:332:5 - (ae-undocumented) Missing documentation for "RefLinks". +// src/models/index.d.ts:333:9 - (ae-undocumented) Missing documentation for "commits". +// src/models/index.d.ts:334:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:335:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:342:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:343:9 - (ae-undocumented) Missing documentation for "description". +// src/models/index.d.ts:372:9 - (ae-undocumented) Missing documentation for "is_private". +// src/models/index.d.ts:373:9 - (ae-undocumented) Missing documentation for "language". +// src/models/index.d.ts:374:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:375:9 - (ae-undocumented) Missing documentation for "mainbranch". +// src/models/index.d.ts:376:9 - (ae-undocumented) Missing documentation for "name". +// src/models/index.d.ts:377:9 - (ae-undocumented) Missing documentation for "owner". +// src/models/index.d.ts:378:9 - (ae-undocumented) Missing documentation for "parent". +// src/models/index.d.ts:379:9 - (ae-undocumented) Missing documentation for "project". +// src/models/index.d.ts:380:9 - (ae-undocumented) Missing documentation for "scm". +// src/models/index.d.ts:381:9 - (ae-undocumented) Missing documentation for "size". +// src/models/index.d.ts:386:9 - (ae-undocumented) Missing documentation for "updated_on". +// src/models/index.d.ts:421:11 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". +// src/models/index.d.ts:427:5 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". +// src/models/index.d.ts:431:5 - (ae-undocumented) Missing documentation for "RepositoryLinks". +// src/models/index.d.ts:432:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:433:9 - (ae-undocumented) Missing documentation for "clone". +// src/models/index.d.ts:434:9 - (ae-undocumented) Missing documentation for "commits". +// src/models/index.d.ts:435:9 - (ae-undocumented) Missing documentation for "downloads". +// src/models/index.d.ts:436:9 - (ae-undocumented) Missing documentation for "forks". +// src/models/index.d.ts:437:9 - (ae-undocumented) Missing documentation for "hooks". +// src/models/index.d.ts:438:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:439:9 - (ae-undocumented) Missing documentation for "pullrequests". +// src/models/index.d.ts:440:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:441:9 - (ae-undocumented) Missing documentation for "watchers". +// src/models/index.d.ts:446:5 - (ae-undocumented) Missing documentation for "SearchCodeSearchResult". +// src/models/index.d.ts:447:9 - (ae-undocumented) Missing documentation for "content_match_count". +// src/models/index.d.ts:448:9 - (ae-undocumented) Missing documentation for "content_matches". +// src/models/index.d.ts:449:9 - (ae-undocumented) Missing documentation for "file". +// src/models/index.d.ts:450:9 - (ae-undocumented) Missing documentation for "path_matches". +// src/models/index.d.ts:451:9 - (ae-undocumented) Missing documentation for "type". +// src/models/index.d.ts:456:5 - (ae-undocumented) Missing documentation for "SearchContentMatch". +// src/models/index.d.ts:457:9 - (ae-undocumented) Missing documentation for "lines". +// src/models/index.d.ts:462:5 - (ae-undocumented) Missing documentation for "SearchLine". +// src/models/index.d.ts:463:9 - (ae-undocumented) Missing documentation for "line". +// src/models/index.d.ts:464:9 - (ae-undocumented) Missing documentation for "segments". +// src/models/index.d.ts:469:5 - (ae-undocumented) Missing documentation for "SearchResultPage". +// src/models/index.d.ts:470:9 - (ae-undocumented) Missing documentation for "query_substituted". +// src/models/index.d.ts:479:5 - (ae-undocumented) Missing documentation for "SearchSegment". +// src/models/index.d.ts:480:9 - (ae-undocumented) Missing documentation for "match". +// src/models/index.d.ts:481:9 - (ae-undocumented) Missing documentation for "text". +// src/models/index.d.ts:488:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:495:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:496:9 - (ae-undocumented) Missing documentation for "members". +// src/models/index.d.ts:497:9 - (ae-undocumented) Missing documentation for "projects". +// src/models/index.d.ts:498:9 - (ae-undocumented) Missing documentation for "repositories". +// src/models/index.d.ts:499:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:507:9 - (ae-undocumented) Missing documentation for "created_on". +// src/models/index.d.ts:513:9 - (ae-undocumented) Missing documentation for "links". +// src/models/index.d.ts:522:9 - (ae-undocumented) Missing documentation for "updated_on". +// src/models/index.d.ts:531:5 - (ae-undocumented) Missing documentation for "WorkspaceLinks". +// src/models/index.d.ts:532:9 - (ae-undocumented) Missing documentation for "avatar". +// src/models/index.d.ts:533:9 - (ae-undocumented) Missing documentation for "html". +// src/models/index.d.ts:534:9 - (ae-undocumented) Missing documentation for "members". +// src/models/index.d.ts:535:9 - (ae-undocumented) Missing documentation for "owners". +// src/models/index.d.ts:536:9 - (ae-undocumented) Missing documentation for "projects". +// src/models/index.d.ts:537:9 - (ae-undocumented) Missing documentation for "repositories". +// src/models/index.d.ts:538:9 - (ae-undocumented) Missing documentation for "self". +// src/models/index.d.ts:539:9 - (ae-undocumented) Missing documentation for "snippets". // src/pagination.d.ts:3:1 - (ae-undocumented) Missing documentation for "PaginationOptions". // src/pagination.d.ts:8:1 - (ae-undocumented) Missing documentation for "WithPagination". // src/pagination.d.ts:12:5 - (ae-undocumented) Missing documentation for "getPage". diff --git a/plugins/catalog-backend-module-aws/report.api.md b/plugins/catalog-backend-module-aws/report.api.md index 2f5a9bb105..3d24c71035 100644 --- a/plugins/catalog-backend-module-aws/report.api.md +++ b/plugins/catalog-backend-module-aws/report.api.md @@ -123,6 +123,6 @@ export type EksClusterEntityTransformer = ( // src/processors/AwsOrganizationCloudAccountProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "readLocation". // src/processors/AwsS3DiscoveryProcessor.d.ts:15:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/AwsS3DiscoveryProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/providers/AwsS3EntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/AwsS3EntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/AwsS3EntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/AwsS3EntityProvider.d.ts:31:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-azure/report.api.md b/plugins/catalog-backend-module-azure/report.api.md index 78f9a29d1d..f3121296a5 100644 --- a/plugins/catalog-backend-module-azure/report.api.md +++ b/plugins/catalog-backend-module-azure/report.api.md @@ -59,6 +59,6 @@ export class AzureDevOpsEntityProvider implements EntityProvider { // src/processors/AzureDevOpsDiscoveryProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/AzureDevOpsDiscoveryProcessor.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/AzureDevOpsDiscoveryProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/providers/AzureDevOpsEntityProvider.d.ts:19:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/AzureDevOpsEntityProvider.d.ts:30:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/AzureDevOpsEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/AzureDevOpsEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md index 47e8184aea..d6c1977ce8 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md @@ -39,7 +39,7 @@ export class BitbucketCloudEntityProvider implements EntityProvider { // Warnings were encountered during analysis: // -// src/providers/BitbucketCloudEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/BitbucketCloudEntityProvider.d.ts:45:5 - (ae-undocumented) Missing documentation for "refresh". -// src/providers/BitbucketCloudEntityProvider.d.ts:48:5 - (ae-undocumented) Missing documentation for "onRepoPush". +// src/providers/BitbucketCloudEntityProvider.d.ts:28:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/BitbucketCloudEntityProvider.d.ts:44:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/BitbucketCloudEntityProvider.d.ts:47:5 - (ae-undocumented) Missing documentation for "onRepoPush". ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/report.api.md b/plugins/catalog-backend-module-bitbucket-server/report.api.md index a269d91d93..a7febe8e7a 100644 --- a/plugins/catalog-backend-module-bitbucket-server/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-server/report.api.md @@ -122,6 +122,6 @@ export type BitbucketServerRepository = { // src/lib/BitbucketServerClient.d.ts:56:1 - (ae-undocumented) Missing documentation for "BitbucketServerPagedResponse". // src/lib/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BitbucketServerRepository". // src/lib/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "BitbucketServerProject". -// src/providers/BitbucketServerEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/BitbucketServerEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/BitbucketServerEntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/BitbucketServerEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-gerrit/report.api.md b/plugins/catalog-backend-module-gerrit/report.api.md index 29c8af4212..56930f3357 100644 --- a/plugins/catalog-backend-module-gerrit/report.api.md +++ b/plugins/catalog-backend-module-gerrit/report.api.md @@ -31,11 +31,11 @@ export class GerritEntityProvider implements EntityProvider { // Warnings were encountered during analysis: // -// src/providers/GerritEntityProvider.d.ts:6:1 - (ae-undocumented) Missing documentation for "GerritEntityProvider". -// src/providers/GerritEntityProvider.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GerritEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GerritEntityProvider.d.ts:19:5 - (ae-undocumented) Missing documentation for "connect". -// src/providers/GerritEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/GerritEntityProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GerritEntityProvider". +// src/providers/GerritEntityProvider.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GerritEntityProvider.d.ts:17:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GerritEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "connect". +// src/providers/GerritEntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "refresh". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/report.api.md b/plugins/catalog-backend-module-github/report.api.md index ff118b92f8..4ffe434615 100644 --- a/plugins/catalog-backend-module-github/report.api.md +++ b/plugins/catalog-backend-module-github/report.api.md @@ -321,18 +321,18 @@ export type UserTransformer = ( // Warnings were encountered during analysis: // -// src/analyzers/GithubLocationAnalyzer.d.ts:7:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzerOptions". -// src/analyzers/GithubLocationAnalyzer.d.ts:15:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzer". -// src/analyzers/GithubLocationAnalyzer.d.ts:21:5 - (ae-undocumented) Missing documentation for "supports". -// src/analyzers/GithubLocationAnalyzer.d.ts:22:5 - (ae-undocumented) Missing documentation for "analyze". -// src/deprecated.d.ts:10:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProvider". -// src/deprecated.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/deprecated.d.ts:17:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProviderOptions". -// src/deprecated.d.ts:22:1 - (ae-undocumented) Missing documentation for "GitHubEntityProvider". -// src/deprecated.d.ts:24:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/deprecated.d.ts:30:5 - (ae-undocumented) Missing documentation for "connect". -// src/deprecated.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/deprecated.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". +// src/analyzers/GithubLocationAnalyzer.d.ts:8:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzerOptions". +// src/analyzers/GithubLocationAnalyzer.d.ts:17:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzer". +// src/analyzers/GithubLocationAnalyzer.d.ts:23:5 - (ae-undocumented) Missing documentation for "supports". +// src/analyzers/GithubLocationAnalyzer.d.ts:24:5 - (ae-undocumented) Missing documentation for "analyze". +// src/deprecated.d.ts:9:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProvider". +// src/deprecated.d.ts:10:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/deprecated.d.ts:16:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProviderOptions". +// src/deprecated.d.ts:21:1 - (ae-undocumented) Missing documentation for "GitHubEntityProvider". +// src/deprecated.d.ts:23:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/deprecated.d.ts:29:5 - (ae-undocumented) Missing documentation for "connect". +// src/deprecated.d.ts:30:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/deprecated.d.ts:31:5 - (ae-undocumented) Missing documentation for "refresh". // src/lib/defaultTransformers.d.ts:10:5 - (ae-undocumented) Missing documentation for "client". // src/lib/defaultTransformers.d.ts:11:5 - (ae-undocumented) Missing documentation for "query". // src/lib/defaultTransformers.d.ts:12:5 - (ae-undocumented) Missing documentation for "org". @@ -345,14 +345,14 @@ export type UserTransformer = ( // src/processors/GithubOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/GithubOrgReaderProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/GithubOrgReaderProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/providers/GithubEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GithubEntityProvider.d.ts:34:5 - (ae-undocumented) Missing documentation for "refresh". -// src/providers/GithubEntityProvider.d.ts:52:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:61:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:72:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:82:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:94:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:103:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubMultiOrgEntityProvider.d.ts:85:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GithubEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GithubEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "refresh". +// src/providers/GithubEntityProvider.d.ts:51:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:60:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:71:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:81:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:93:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubEntityProvider.d.ts:102:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/GithubMultiOrgEntityProvider.d.ts:84:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/providers/GithubOrgEntityProvider.d.ts:71:5 - (ae-undocumented) Missing documentation for "fromConfig". ``` diff --git a/plugins/catalog-backend-module-gitlab/report.api.md b/plugins/catalog-backend-module-gitlab/report.api.md index 143d4b5823..0cc2f93ce1 100644 --- a/plugins/catalog-backend-module-gitlab/report.api.md +++ b/plugins/catalog-backend-module-gitlab/report.api.md @@ -178,22 +178,22 @@ export interface UserTransformerOptions { // src/GitLabDiscoveryProcessor.d.ts:20:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/GitLabDiscoveryProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "readLocation". // src/lib/types.d.ts:48:1 - (ae-undocumented) Missing documentation for "GitLabGroupSamlIdentity". -// src/lib/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "group". -// src/lib/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "providerConfig". -// src/lib/types.d.ts:208:5 - (ae-undocumented) Missing documentation for "user". -// src/lib/types.d.ts:209:5 - (ae-undocumented) Missing documentation for "integrationConfig". -// src/lib/types.d.ts:210:5 - (ae-undocumented) Missing documentation for "providerConfig". -// src/lib/types.d.ts:211:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". -// src/lib/types.d.ts:225:5 - (ae-undocumented) Missing documentation for "groups". -// src/lib/types.d.ts:226:5 - (ae-undocumented) Missing documentation for "providerConfig". -// src/lib/types.d.ts:227:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:34:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:35:5 - (ae-undocumented) Missing documentation for "connect". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:76:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' -// src/providers/GitlabDiscoveryEntityProvider.d.ts:77:30 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag -// src/providers/GitlabDiscoveryEntityProvider.d.ts:77:17 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "connect". +// src/lib/types.d.ts:234:5 - (ae-undocumented) Missing documentation for "group". +// src/lib/types.d.ts:235:5 - (ae-undocumented) Missing documentation for "providerConfig". +// src/lib/types.d.ts:249:5 - (ae-undocumented) Missing documentation for "user". +// src/lib/types.d.ts:250:5 - (ae-undocumented) Missing documentation for "integrationConfig". +// src/lib/types.d.ts:251:5 - (ae-undocumented) Missing documentation for "providerConfig". +// src/lib/types.d.ts:252:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". +// src/lib/types.d.ts:266:5 - (ae-undocumented) Missing documentation for "groups". +// src/lib/types.d.ts:267:5 - (ae-undocumented) Missing documentation for "providerConfig". +// src/lib/types.d.ts:268:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:34:5 - (ae-undocumented) Missing documentation for "connect". +// src/providers/GitlabDiscoveryEntityProvider.d.ts:75:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' +// src/providers/GitlabDiscoveryEntityProvider.d.ts:76:30 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag +// src/providers/GitlabDiscoveryEntityProvider.d.ts:76:17 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" +// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProviderName". +// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "connect". ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index 5f2abb5f60..7160ff504f 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -100,6 +100,6 @@ export type PluginEnvironment = { // src/service/IncrementalCatalogBuilder.d.ts:6:1 - (ae-undocumented) Missing documentation for "IncrementalCatalogBuilder". // src/service/IncrementalCatalogBuilder.d.ts:20:5 - (ae-undocumented) Missing documentation for "build". // src/service/IncrementalCatalogBuilder.d.ts:23:5 - (ae-undocumented) Missing documentation for "addIncrementalEntityProvider". -// src/types.d.ts:107:1 - (ae-undocumented) Missing documentation for "IncrementalEntityProviderOptions". -// src/types.d.ts:146:1 - (ae-undocumented) Missing documentation for "PluginEnvironment". +// src/types.d.ts:106:1 - (ae-undocumented) Missing documentation for "IncrementalEntityProviderOptions". +// src/types.d.ts:145:1 - (ae-undocumented) Missing documentation for "PluginEnvironment". ``` diff --git a/plugins/catalog-backend-module-ldap/report.api.md b/plugins/catalog-backend-module-ldap/report.api.md index a786d48fdb..e8b20073a3 100644 --- a/plugins/catalog-backend-module-ldap/report.api.md +++ b/plugins/catalog-backend-module-ldap/report.api.md @@ -113,7 +113,6 @@ export class LdapOrgEntityProvider implements EntityProvider { userTransformer?: UserTransformer; groupTransformer?: GroupTransformer; }); - // (undocumented) connect(connection: EntityProviderConnection): Promise; // (undocumented) static fromConfig( @@ -125,7 +124,6 @@ export class LdapOrgEntityProvider implements EntityProvider { configRoot: Config, options: LdapOrgEntityProviderLegacyOptions, ): LdapOrgEntityProvider; - // (undocumented) getProviderName(): string; read(options?: { logger?: LoggerService }): Promise; } @@ -277,4 +275,13 @@ export type VendorConfig = { dnAttributeName?: string; uuidAttributeName?: string; }; + +// Warnings were encountered during analysis: +// +// src/ldap/client.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". +// src/processors/LdapOrgEntityProvider.d.ts:107:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/LdapOrgEntityProvider.d.ts:108:5 - (ae-undocumented) Missing documentation for "fromLegacyConfig". +// src/processors/LdapOrgReaderProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/LdapOrgReaderProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/processors/LdapOrgReaderProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "readLocation". ``` diff --git a/plugins/catalog-backend-module-msgraph/report.api.md b/plugins/catalog-backend-module-msgraph/report.api.md index 449825df37..3df99752db 100644 --- a/plugins/catalog-backend-module-msgraph/report.api.md +++ b/plugins/catalog-backend-module-msgraph/report.api.md @@ -296,7 +296,7 @@ export type UserTransformer = ( // src/microsoftGraph/client.d.ts:109:5 - (ae-undocumented) Missing documentation for "getUserPhoto". // src/microsoftGraph/client.d.ts:129:5 - (ae-undocumented) Missing documentation for "getGroupPhoto". // src/microsoftGraph/client.d.ts:176:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-msgraph" does not have an export "entityName" -// src/processors/MicrosoftGraphOrgEntityProvider.d.ts:120:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/processors/MicrosoftGraphOrgEntityProvider.d.ts:119:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:32:5 - (ae-undocumented) Missing documentation for "readLocation". diff --git a/plugins/catalog-backend-module-puppetdb/report.api.md b/plugins/catalog-backend-module-puppetdb/report.api.md index 1b22398086..00874a3b2f 100644 --- a/plugins/catalog-backend-module-puppetdb/report.api.md +++ b/plugins/catalog-backend-module-puppetdb/report.api.md @@ -78,9 +78,9 @@ export type ResourceTransformer = ( // Warnings were encountered during analysis: // -// src/providers/PuppetDbEntityProvider.d.ts:40:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/PuppetDbEntityProvider.d.ts:42:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "LoggerService" -// src/providers/PuppetDbEntityProvider.d.ts:42:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "TaskRunner" -// src/providers/PuppetDbEntityProvider.d.ts:52:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/PuppetDbEntityProvider.d.ts:54:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "TaskRunner" +// src/providers/PuppetDbEntityProvider.d.ts:39:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/PuppetDbEntityProvider.d.ts:41:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "LoggerService" +// src/providers/PuppetDbEntityProvider.d.ts:41:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "SchedulerServiceTaskRunner" +// src/providers/PuppetDbEntityProvider.d.ts:51:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration +// src/providers/PuppetDbEntityProvider.d.ts:53:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "SchedulerServiceTaskRunner" ``` diff --git a/plugins/catalog-backend/report.api.md b/plugins/catalog-backend/report.api.md index 1c3949adfa..375f14e5f8 100644 --- a/plugins/catalog-backend/report.api.md +++ b/plugins/catalog-backend/report.api.md @@ -516,10 +516,10 @@ export class UrlReaderProcessor implements CatalogProcessor_2 { // src/deprecated.d.ts:207:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". // src/deprecated.d.ts:212:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". // src/deprecated.d.ts:217:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". -// src/modules/codeowners/CodeOwnersProcessor.d.ts:9:1 - (ae-undocumented) Missing documentation for "CodeOwnersProcessor". -// src/modules/codeowners/CodeOwnersProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/modules/codeowners/CodeOwnersProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/modules/codeowners/CodeOwnersProcessor.d.ts:23:5 - (ae-undocumented) Missing documentation for "preProcessEntity". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:8:1 - (ae-undocumented) Missing documentation for "CodeOwnersProcessor". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/codeowners/CodeOwnersProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "preProcessEntity". // src/modules/core/AnnotateLocationEntityProcessor.d.ts:6:1 - (ae-undocumented) Missing documentation for "AnnotateLocationEntityProcessor". // src/modules/core/AnnotateLocationEntityProcessor.d.ts:11:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/modules/core/AnnotateLocationEntityProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "preProcessEntity". @@ -540,9 +540,9 @@ export class UrlReaderProcessor implements CatalogProcessor_2 { // src/modules/core/PlaceholderProcessor.d.ts:8:1 - (ae-undocumented) Missing documentation for "PlaceholderProcessorOptions". // src/modules/core/PlaceholderProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". // src/modules/core/PlaceholderProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "preProcessEntity". -// src/modules/core/UrlReaderProcessor.d.ts:6:1 - (ae-undocumented) Missing documentation for "UrlReaderProcessor". -// src/modules/core/UrlReaderProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/modules/core/UrlReaderProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "readLocation". +// src/modules/core/UrlReaderProcessor.d.ts:5:1 - (ae-undocumented) Missing documentation for "UrlReaderProcessor". +// src/modules/core/UrlReaderProcessor.d.ts:11:5 - (ae-undocumented) Missing documentation for "getProcessorName". +// src/modules/core/UrlReaderProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "readLocation". // src/modules/util/parse.d.ts:5:1 - (ae-undocumented) Missing documentation for "parseEntityYaml". // src/processing/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "start". // src/processing/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "stop". @@ -558,5 +558,5 @@ export class UrlReaderProcessor implements CatalogProcessor_2 { // src/search/DefaultCatalogCollator.d.ts:31:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". // src/search/DefaultCatalogCollator.d.ts:33:5 - (ae-undocumented) Missing documentation for "execute". // src/service/CatalogBuilder.d.ts:19:1 - (ae-undocumented) Missing documentation for "CatalogEnvironment". -// src/service/CatalogBuilder.d.ts:232:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/service/CatalogBuilder.d.ts:233:5 - (ae-undocumented) Missing documentation for "subscribe". ``` diff --git a/plugins/catalog-graph/report-alpha.api.md b/plugins/catalog-graph/report-alpha.api.md index 8d0137fed7..944fa203f1 100644 --- a/plugins/catalog-graph/report-alpha.api.md +++ b/plugins/catalog-graph/report-alpha.api.md @@ -167,7 +167,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-graph/report.api.md b/plugins/catalog-graph/report.api.md index 44f0f93e1e..8812394d4f 100644 --- a/plugins/catalog-graph/report.api.md +++ b/plugins/catalog-graph/report.api.md @@ -141,5 +141,8 @@ export type RelationPairs = [string, string][]; // Warnings were encountered during analysis: // -// src/components/EntityRelationsGraph/EntityRelationsGraph.d.ts:9:1 - (ae-undocumented) Missing documentation for "EntityRelationsGraphProps". +// src/components/EntityRelationsGraph/DefaultRenderLabel.d.ts:5:1 - (ae-undocumented) Missing documentation for "CustomLabelClassKey". +// src/components/EntityRelationsGraph/DefaultRenderNode.d.ts:5:1 - (ae-undocumented) Missing documentation for "CustomNodeClassKey". +// src/components/EntityRelationsGraph/EntityRelationsGraph.d.ts:7:1 - (ae-undocumented) Missing documentation for "EntityRelationsGraphClassKey". +// src/components/EntityRelationsGraph/EntityRelationsGraph.d.ts:11:1 - (ae-undocumented) Missing documentation for "EntityRelationsGraphProps". ``` diff --git a/plugins/catalog-import/report-alpha.api.md b/plugins/catalog-import/report-alpha.api.md index a70d8c46c8..d966e04e7e 100644 --- a/plugins/catalog-import/report-alpha.api.md +++ b/plugins/catalog-import/report-alpha.api.md @@ -69,7 +69,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-node/api-report-testUtils.md b/plugins/catalog-node/api-report-testUtils.md deleted file mode 100644 index c1dfb0bd7a..0000000000 --- a/plugins/catalog-node/api-report-testUtils.md +++ /dev/null @@ -1,27 +0,0 @@ -## API Report File for "@backstage/plugin-catalog-node" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { CatalogApi } from '@backstage/catalog-client'; -import { Entity } from '@backstage/catalog-model'; -import { ServiceFactory } from '@backstage/backend-plugin-api'; -import { ServiceMock } from '@backstage/backend-test-utils'; - -// @public -export function catalogServiceMock(options?: { - entities?: Entity[]; -}): CatalogApi; - -// @public -export namespace catalogServiceMock { - const factory: (options?: { - entities?: Entity[]; - }) => ServiceFactory; - const mock: ( - partialImpl?: Partial | undefined, - ) => ServiceMock; -} - -// (No @packageDocumentation comment for this package) -``` diff --git a/plugins/catalog-node/report-alpha.api.md b/plugins/catalog-node/report-alpha.api.md index 6fc361896d..4ef79f1f3c 100644 --- a/plugins/catalog-node/report-alpha.api.md +++ b/plugins/catalog-node/report-alpha.api.md @@ -100,21 +100,23 @@ export const catalogServiceRef: ServiceRef; // Warnings were encountered during analysis: // -// src/extensions.d.ts:8:1 - (ae-undocumented) Missing documentation for "CatalogProcessingExtensionPoint". -// src/extensions.d.ts:9:5 - (ae-undocumented) Missing documentation for "addProcessor". -// src/extensions.d.ts:10:5 - (ae-undocumented) Missing documentation for "addEntityProvider". -// src/extensions.d.ts:11:5 - (ae-undocumented) Missing documentation for "addPlaceholderResolver". -// src/extensions.d.ts:12:5 - (ae-undocumented) Missing documentation for "setOnProcessingErrorHandler". -// src/extensions.d.ts:18:1 - (ae-undocumented) Missing documentation for "CatalogModelExtensionPoint". -// src/extensions.d.ts:36:22 - (ae-undocumented) Missing documentation for "catalogProcessingExtensionPoint". -// src/extensions.d.ts:40:1 - (ae-undocumented) Missing documentation for "CatalogAnalysisExtensionPoint". -// src/extensions.d.ts:63:22 - (ae-undocumented) Missing documentation for "catalogAnalysisExtensionPoint". -// src/extensions.d.ts:65:22 - (ae-undocumented) Missing documentation for "catalogModelExtensionPoint". -// src/extensions.d.ts:69:1 - (ae-undocumented) Missing documentation for "CatalogPermissionRuleInput". -// src/extensions.d.ts:73:1 - (ae-undocumented) Missing documentation for "CatalogPermissionExtensionPoint". -// src/extensions.d.ts:74:5 - (ae-undocumented) Missing documentation for "addPermissions". -// src/extensions.d.ts:75:5 - (ae-undocumented) Missing documentation for "addPermissionRules". -// src/extensions.d.ts:80:22 - (ae-undocumented) Missing documentation for "catalogPermissionExtensionPoint". +// src/extensions.d.ts:8:1 - (ae-undocumented) Missing documentation for "CatalogLocationsExtensionPoint". +// src/extensions.d.ts:18:22 - (ae-undocumented) Missing documentation for "catalogLocationsExtensionPoint". +// src/extensions.d.ts:22:1 - (ae-undocumented) Missing documentation for "CatalogProcessingExtensionPoint". +// src/extensions.d.ts:23:5 - (ae-undocumented) Missing documentation for "addProcessor". +// src/extensions.d.ts:24:5 - (ae-undocumented) Missing documentation for "addEntityProvider". +// src/extensions.d.ts:25:5 - (ae-undocumented) Missing documentation for "addPlaceholderResolver". +// src/extensions.d.ts:26:5 - (ae-undocumented) Missing documentation for "setOnProcessingErrorHandler". +// src/extensions.d.ts:32:1 - (ae-undocumented) Missing documentation for "CatalogModelExtensionPoint". +// src/extensions.d.ts:50:22 - (ae-undocumented) Missing documentation for "catalogProcessingExtensionPoint". +// src/extensions.d.ts:54:1 - (ae-undocumented) Missing documentation for "CatalogAnalysisExtensionPoint". +// src/extensions.d.ts:77:22 - (ae-undocumented) Missing documentation for "catalogAnalysisExtensionPoint". +// src/extensions.d.ts:79:22 - (ae-undocumented) Missing documentation for "catalogModelExtensionPoint". +// src/extensions.d.ts:83:1 - (ae-undocumented) Missing documentation for "CatalogPermissionRuleInput". +// src/extensions.d.ts:87:1 - (ae-undocumented) Missing documentation for "CatalogPermissionExtensionPoint". +// src/extensions.d.ts:88:5 - (ae-undocumented) Missing documentation for "addPermissions". +// src/extensions.d.ts:89:5 - (ae-undocumented) Missing documentation for "addPermissionRules". +// src/extensions.d.ts:94:22 - (ae-undocumented) Missing documentation for "catalogPermissionExtensionPoint". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-node/report.api.md b/plugins/catalog-node/report.api.md index 5c18c4756e..1e585d59e2 100644 --- a/plugins/catalog-node/report.api.md +++ b/plugins/catalog-node/report.api.md @@ -254,11 +254,11 @@ export type ScmLocationAnalyzer = { // src/api/processor.d.ts:122:1 - (ae-undocumented) Missing documentation for "CatalogProcessorErrorResult". // src/api/processor.d.ts:128:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRefreshKeysResult". // src/api/processor.d.ts:133:1 - (ae-undocumented) Missing documentation for "CatalogProcessorResult". -// src/processing/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverRead". -// src/processing/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverResolveUrl". -// src/processing/types.d.ts:19:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverParams". -// src/processing/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "PlaceholderResolver". -// src/processing/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "LocationAnalyzer". -// src/processing/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "AnalyzeOptions". -// src/processing/types.d.ts:45:1 - (ae-undocumented) Missing documentation for "ScmLocationAnalyzer". +// src/processing/types.d.ts:16:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverRead". +// src/processing/types.d.ts:18:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverResolveUrl". +// src/processing/types.d.ts:20:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverParams". +// src/processing/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "PlaceholderResolver". +// src/processing/types.d.ts:31:1 - (ae-undocumented) Missing documentation for "LocationAnalyzer". +// src/processing/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "AnalyzeOptions". +// src/processing/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "ScmLocationAnalyzer". ``` diff --git a/plugins/catalog-react/report-alpha.api.md b/plugins/catalog-react/report-alpha.api.md index 6873fa6cfa..6eec97b815 100644 --- a/plugins/catalog-react/report-alpha.api.md +++ b/plugins/catalog-react/report-alpha.api.md @@ -223,9 +223,8 @@ export function useEntityPermission( // Warnings were encountered during analysis: // -// src/alpha.d.ts:9:22 - (ae-undocumented) Missing documentation for "catalogExtensionData". -// src/alpha.d.ts:15:1 - (ae-undocumented) Missing documentation for "createEntityCardExtension". -// src/alpha.d.ts:34:1 - (ae-undocumented) Missing documentation for "createEntityContentExtension". +// src/alpha/converters/convertLegacyEntityCardExtension.d.ts:5:1 - (ae-undocumented) Missing documentation for "convertLegacyEntityCardExtension". +// src/alpha/converters/convertLegacyEntityContentExtension.d.ts:5:1 - (ae-undocumented) Missing documentation for "convertLegacyEntityContentExtension". // src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogReactTranslationRef". // (No @packageDocumentation comment for this package) diff --git a/plugins/catalog-react/report.api.md b/plugins/catalog-react/report.api.md index aafe29e16d..fccc269e07 100644 --- a/plugins/catalog-react/report.api.md +++ b/plugins/catalog-react/report.api.md @@ -859,8 +859,9 @@ export function useStarredEntity( // src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:10:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". // src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:13:22 - (ae-undocumented) Missing documentation for "EntityNamespacePicker". // src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityOwnerPickerClassKey". -// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:7:1 - (ae-undocumented) Missing documentation for "EntityOwnerPickerProps". -// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:11:22 - (ae-undocumented) Missing documentation for "EntityOwnerPicker". +// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:5:1 - (ae-undocumented) Missing documentation for "FixedWidthFormControlLabelClassKey". +// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:9:1 - (ae-undocumented) Missing documentation for "EntityOwnerPickerProps". +// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:13:22 - (ae-undocumented) Missing documentation for "EntityOwnerPicker". // src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityProcessingStatusPickerClassKey". // src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityProcessingStatusPicker". // src/components/EntityRefLink/humanize.d.ts:8:1 - (ae-undocumented) Missing documentation for "humanizeEntityRef". @@ -938,16 +939,18 @@ export function useStarredEntity( // src/hooks/useEntity.d.ts:20:5 - (ae-undocumented) Missing documentation for "refresh". // src/hooks/useEntity.d.ts:34:5 - (ae-undocumented) Missing documentation for "children". // src/hooks/useEntity.d.ts:35:5 - (ae-undocumented) Missing documentation for "entity". -// src/hooks/useEntityListProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "DefaultEntityFilters". -// src/hooks/useEntityListProvider.d.ts:18:1 - (ae-undocumented) Missing documentation for "EntityListContextProps". -// src/hooks/useEntityListProvider.d.ts:57:1 - (ae-undocumented) Missing documentation for "EntityListProviderProps". +// src/hooks/useEntityListProvider.d.ts:6:1 - (ae-undocumented) Missing documentation for "DefaultEntityFilters". +// src/hooks/useEntityListProvider.d.ts:19:1 - (ae-undocumented) Missing documentation for "PaginationMode". +// src/hooks/useEntityListProvider.d.ts:21:1 - (ae-undocumented) Missing documentation for "EntityListContextProps". +// src/hooks/useEntityListProvider.d.ts:65:1 - (ae-undocumented) Missing documentation for "EntityListProviderProps". // src/hooks/useStarredEntities.d.ts:3:1 - (ae-undocumented) Missing documentation for "useStarredEntities". // src/hooks/useStarredEntity.d.ts:3:1 - (ae-undocumented) Missing documentation for "useStarredEntity". // src/overridableComponents.d.ts:6:1 - (ae-undocumented) Missing documentation for "CatalogReactComponentsNameToClassKey". -// src/overridableComponents.d.ts:17:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". +// src/overridableComponents.d.ts:19:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". // src/testUtils/providers.d.ts:4:1 - (ae-undocumented) Missing documentation for "MockEntityListContextProvider". // src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityFilter". // src/types.d.ts:25:1 - (ae-undocumented) Missing documentation for "UserListFilterKind". +// src/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "EntityListPagination". // src/utils/getEntitySourceLocation.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntitySourceLocation". // src/utils/getEntitySourceLocation.d.ts:9:1 - (ae-undocumented) Missing documentation for "getEntitySourceLocation". ``` diff --git a/plugins/catalog/report-alpha.api.md b/plugins/catalog/report-alpha.api.md index 0dd7778dc3..13ee6d0314 100644 --- a/plugins/catalog/report-alpha.api.md +++ b/plugins/catalog/report-alpha.api.md @@ -872,9 +872,8 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha/createCatalogFilterExtension.d.ts:4:1 - (ae-undocumented) Missing documentation for "createCatalogFilterExtension". -// src/alpha/plugin.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". -// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogTranslationRef". +// src/alpha/plugin.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogTranslationRef". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog/report.api.md b/plugins/catalog/report.api.md index 2d149c4c51..a7538900a0 100644 --- a/plugins/catalog/report.api.md +++ b/plugins/catalog/report.api.md @@ -688,26 +688,30 @@ export type SystemDiagramCardClassKey = // src/components/CatalogPage/DefaultCatalogPage.d.ts:16:5 - (ae-undocumented) Missing documentation for "tableOptions". // src/components/CatalogPage/DefaultCatalogPage.d.ts:17:5 - (ae-undocumented) Missing documentation for "emptyContent". // src/components/CatalogPage/DefaultCatalogPage.d.ts:18:5 - (ae-undocumented) Missing documentation for "ownerPickerMode". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:19:5 - (ae-undocumented) Missing documentation for "pagination". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:22:5 - (ae-undocumented) Missing documentation for "filters". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:23:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:9:5 - (ae-undocumented) Missing documentation for "icon". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:10:5 - (ae-undocumented) Missing documentation for "result". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:11:5 - (ae-undocumented) Missing documentation for "highlight". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:12:5 - (ae-undocumented) Missing documentation for "rank". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:13:5 - (ae-undocumented) Missing documentation for "lineClamp". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:19:5 - (ae-undocumented) Missing documentation for "filters". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:20:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". +// src/components/CatalogPage/DefaultCatalogPage.d.ts:21:5 - (ae-undocumented) Missing documentation for "pagination". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:4:1 - (ae-undocumented) Missing documentation for "CatalogSearchResultListItemClassKey". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:11:5 - (ae-undocumented) Missing documentation for "icon". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:12:5 - (ae-undocumented) Missing documentation for "result". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:13:5 - (ae-undocumented) Missing documentation for "highlight". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:14:5 - (ae-undocumented) Missing documentation for "rank". +// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:15:5 - (ae-undocumented) Missing documentation for "lineClamp". // src/components/CatalogTable/CatalogTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "columns". // src/components/CatalogTable/CatalogTable.d.ts:11:5 - (ae-undocumented) Missing documentation for "actions". // src/components/CatalogTable/CatalogTable.d.ts:12:5 - (ae-undocumented) Missing documentation for "tableOptions". // src/components/CatalogTable/CatalogTable.d.ts:13:5 - (ae-undocumented) Missing documentation for "emptyContent". // src/components/CatalogTable/CatalogTable.d.ts:14:5 - (ae-undocumented) Missing documentation for "subtitle". // src/components/CatalogTable/CatalogTable.d.ts:17:22 - (ae-undocumented) Missing documentation for "CatalogTable". +// src/components/CatalogTable/CatalogTableToolbar.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogTableToolbarClassKey". // src/components/CatalogTable/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "CatalogTableRow". // src/components/CatalogTable/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "entity". // src/components/CatalogTable/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "resolved". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "DependencyOfComponentsCardProps". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependencyOfComponentsCardProps". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". // src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependsOnComponentsCardProps". // src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". // src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". @@ -722,6 +726,7 @@ export type SystemDiagramCardClassKey = // src/components/EntityLabelsCard/EntityLabelsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntityLabelsCardProps". // src/components/EntityLabelsCard/EntityLabelsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". // src/components/EntityLabelsCard/EntityLabelsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/EntityLabelsCard/EntityLabelsEmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityLabelsEmptyStateClassKey". // src/components/EntityLayout/EntityLayout.d.ts:6:1 - (ae-undocumented) Missing documentation for "EntityLayoutRouteProps". // src/components/EntityLayout/EntityLayout.d.ts:25:1 - (ae-undocumented) Missing documentation for "EntityLayoutProps". // src/components/EntityLayout/EntityLayout.d.ts:26:5 - (ae-undocumented) Missing documentation for "UNSTABLE_extraContextMenuItems". @@ -746,35 +751,47 @@ export type SystemDiagramCardClassKey = // src/components/FilteredEntityLayout/index.d.ts:6:22 - (ae-undocumented) Missing documentation for "FilteredEntityLayout". // src/components/FilteredEntityLayout/index.d.ts:13:22 - (ae-undocumented) Missing documentation for "FilterContainer". // src/components/FilteredEntityLayout/index.d.ts:24:22 - (ae-undocumented) Missing documentation for "EntityListContainer". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasComponentsCardProps". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasResourcesCardProps". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasSubcomponentsCardProps". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasComponentsCardProps". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/HasComponentsCard/HasComponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasResourcesCardProps". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/HasResourcesCard/HasResourcesCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasSubcomponentsCardProps". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". // src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasSystemsCardProps". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasSubdomainsCardProps". +// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "tableOptions". +// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasSystemsCardProps". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". +// src/components/HasSystemsCard/HasSystemsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". // src/components/RelatedEntitiesCard/RelatedEntitiesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "RelatedEntitiesCardProps". // src/components/SystemDiagramCard/SystemDiagramCard.d.ts:3:1 - (ae-undocumented) Missing documentation for "SystemDiagramCardClassKey". -// src/overridableComponents.d.ts:7:1 - (ae-undocumented) Missing documentation for "PluginCatalogComponentsNameToClassKey". -// src/overridableComponents.d.ts:13:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". -// src/plugin.d.ts:16:22 - (ae-undocumented) Missing documentation for "catalogPlugin". -// src/plugin.d.ts:37:22 - (ae-undocumented) Missing documentation for "CatalogIndexPage". -// src/plugin.d.ts:39:22 - (ae-undocumented) Missing documentation for "CatalogEntityPage". -// src/plugin.d.ts:54:22 - (ae-undocumented) Missing documentation for "EntityLinksCard". -// src/plugin.d.ts:56:22 - (ae-undocumented) Missing documentation for "EntityLabelsCard". -// src/plugin.d.ts:58:22 - (ae-undocumented) Missing documentation for "EntityHasSystemsCard". -// src/plugin.d.ts:60:22 - (ae-undocumented) Missing documentation for "EntityHasComponentsCard". -// src/plugin.d.ts:62:22 - (ae-undocumented) Missing documentation for "EntityHasSubcomponentsCard". -// src/plugin.d.ts:64:22 - (ae-undocumented) Missing documentation for "EntityHasResourcesCard". -// src/plugin.d.ts:66:22 - (ae-undocumented) Missing documentation for "EntityDependsOnComponentsCard". -// src/plugin.d.ts:68:22 - (ae-undocumented) Missing documentation for "EntityDependencyOfComponentsCard". -// src/plugin.d.ts:70:22 - (ae-undocumented) Missing documentation for "EntityDependsOnResourcesCard". -// src/plugin.d.ts:72:22 - (ae-undocumented) Missing documentation for "RelatedEntitiesCard". -// src/plugin.d.ts:74:22 - (ae-undocumented) Missing documentation for "CatalogSearchResultListItem". +// src/overridableComponents.d.ts:10:1 - (ae-undocumented) Missing documentation for "PluginCatalogComponentsNameToClassKey". +// src/overridableComponents.d.ts:19:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". +// src/plugin.d.ts:17:22 - (ae-undocumented) Missing documentation for "catalogPlugin". +// src/plugin.d.ts:38:22 - (ae-undocumented) Missing documentation for "CatalogIndexPage". +// src/plugin.d.ts:40:22 - (ae-undocumented) Missing documentation for "CatalogEntityPage". +// src/plugin.d.ts:55:22 - (ae-undocumented) Missing documentation for "EntityLinksCard". +// src/plugin.d.ts:57:22 - (ae-undocumented) Missing documentation for "EntityLabelsCard". +// src/plugin.d.ts:59:22 - (ae-undocumented) Missing documentation for "EntityHasSystemsCard". +// src/plugin.d.ts:61:22 - (ae-undocumented) Missing documentation for "EntityHasComponentsCard". +// src/plugin.d.ts:63:22 - (ae-undocumented) Missing documentation for "EntityHasSubcomponentsCard". +// src/plugin.d.ts:65:22 - (ae-undocumented) Missing documentation for "EntityHasSubdomainsCard". +// src/plugin.d.ts:67:22 - (ae-undocumented) Missing documentation for "EntityHasResourcesCard". +// src/plugin.d.ts:69:22 - (ae-undocumented) Missing documentation for "EntityDependsOnComponentsCard". +// src/plugin.d.ts:71:22 - (ae-undocumented) Missing documentation for "EntityDependencyOfComponentsCard". +// src/plugin.d.ts:73:22 - (ae-undocumented) Missing documentation for "EntityDependsOnResourcesCard". +// src/plugin.d.ts:75:22 - (ae-undocumented) Missing documentation for "RelatedEntitiesCard". +// src/plugin.d.ts:77:22 - (ae-undocumented) Missing documentation for "CatalogSearchResultListItem". ``` diff --git a/plugins/devtools-backend/report.api.md b/plugins/devtools-backend/report.api.md index f150975beb..1ca69d686e 100644 --- a/plugins/devtools-backend/report.api.md +++ b/plugins/devtools-backend/report.api.md @@ -55,12 +55,12 @@ export interface RouterOptions { // src/api/DevToolsBackendApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "listExternalDependencyDetails". // src/api/DevToolsBackendApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "listConfig". // src/api/DevToolsBackendApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "listInfo". -// src/service/router.d.ts:6:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:7:5 - (ae-undocumented) Missing documentation for "devToolsBackendApi". -// src/service/router.d.ts:8:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "permissions". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:15:1 - (ae-undocumented) Missing documentation for "createRouter". +// src/service/router.d.ts:8:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "devToolsBackendApi". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "permissions". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:20:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/devtools/report-alpha.api.md b/plugins/devtools/report-alpha.api.md index dbf690bc09..aa1806277e 100644 --- a/plugins/devtools/report-alpha.api.md +++ b/plugins/devtools/report-alpha.api.md @@ -91,7 +91,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha/plugin.d.ts:16:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha/plugin.d.ts:53:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/home/report-alpha.api.md b/plugins/home/report-alpha.api.md index 84c5082717..e8f8ddf6a1 100644 --- a/plugins/home/report-alpha.api.md +++ b/plugins/home/report-alpha.api.md @@ -80,8 +80,8 @@ export const titleExtensionDataRef: ConfigurableExtensionDataRef< // Warnings were encountered during analysis: // -// src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "titleExtensionDataRef". -// src/alpha.d.ts:8:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:5:22 - (ae-undocumented) Missing documentation for "titleExtensionDataRef". +// src/alpha.d.ts:9:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes-backend/report.api.md b/plugins/kubernetes-backend/report.api.md index 9b2919ef66..e01ada7e1c 100644 --- a/plugins/kubernetes-backend/report.api.md +++ b/plugins/kubernetes-backend/report.api.md @@ -510,13 +510,13 @@ export type SigningCreds = { // src/service/KubernetesBuilder.d.ts:90:5 - (ae-undocumented) Missing documentation for "getAuthStrategyMap". // src/service/KubernetesFanOutHandler.d.ts:9:22 - (ae-undocumented) Missing documentation for "DEFAULT_OBJECTS". // src/service/KubernetesProxy.d.ts:50:5 - (ae-undocumented) Missing documentation for "createRequestHandler". -// src/service/router.d.ts:12:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "catalogApi". -// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "clusterSupplier". -// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "permissions". +// src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "catalogApi". +// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "clusterSupplier". +// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "permissions". // src/types/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "ServiceLocatorMethod". // src/types/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProviderOptions". // src/types/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". diff --git a/plugins/kubernetes/report-alpha.api.md b/plugins/kubernetes/report-alpha.api.md index f257d56587..93919acd47 100644 --- a/plugins/kubernetes/report-alpha.api.md +++ b/plugins/kubernetes/report-alpha.api.md @@ -164,7 +164,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha/plugin.d.ts:1:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha/plugin.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/notifications/report.api.md b/plugins/notifications/report.api.md index 5e06ae2616..ab1fc6d5a1 100644 --- a/plugins/notifications/report.api.md +++ b/plugins/notifications/report.api.md @@ -176,5 +176,29 @@ export function useNotificationsApi( value: T; }; +// Warnings were encountered during analysis: +// +// src/api/NotificationsApi.d.ts:3:22 - (ae-undocumented) Missing documentation for "notificationsApiRef". +// src/api/NotificationsApi.d.ts:5:1 - (ae-undocumented) Missing documentation for "GetNotificationsOptions". +// src/api/NotificationsApi.d.ts:17:1 - (ae-undocumented) Missing documentation for "UpdateNotificationsOptions". +// src/api/NotificationsApi.d.ts:23:1 - (ae-undocumented) Missing documentation for "GetNotificationsResponse". +// src/api/NotificationsApi.d.ts:28:1 - (ae-undocumented) Missing documentation for "NotificationsApi". +// src/api/NotificationsApi.d.ts:29:5 - (ae-undocumented) Missing documentation for "getNotifications". +// src/api/NotificationsApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "getNotification". +// src/api/NotificationsApi.d.ts:31:5 - (ae-undocumented) Missing documentation for "getStatus". +// src/api/NotificationsApi.d.ts:32:5 - (ae-undocumented) Missing documentation for "updateNotifications". +// src/api/NotificationsClient.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationsClient". +// src/api/NotificationsClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "getNotifications". +// src/api/NotificationsClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "getNotification". +// src/api/NotificationsClient.d.ts:14:5 - (ae-undocumented) Missing documentation for "getStatus". +// src/api/NotificationsClient.d.ts:15:5 - (ae-undocumented) Missing documentation for "updateNotifications". +// src/components/NotificationsPage/NotificationsPage.d.ts:3:1 - (ae-undocumented) Missing documentation for "NotificationsPageProps". +// src/components/NotificationsSideBarItem/NotificationsSideBarItem.d.ts:12:22 - (ae-undocumented) Missing documentation for "NotificationsSidebarItem". +// src/components/NotificationsTable/NotificationsTable.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationsTableProps". +// src/components/NotificationsTable/NotificationsTable.d.ts:15:22 - (ae-undocumented) Missing documentation for "NotificationsTable". +// src/hooks/useNotificationsApi.d.ts:3:1 - (ae-undocumented) Missing documentation for "useNotificationsApi". +// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "notificationsPlugin". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "NotificationsPage". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/report-alpha.api.md b/plugins/org/report-alpha.api.md index eaa98f98d1..14833df450 100644 --- a/plugins/org/report-alpha.api.md +++ b/plugins/org/report-alpha.api.md @@ -163,7 +163,7 @@ export default _default; // Warnings were encountered during analysis: // -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/report.api.md b/plugins/org/report.api.md index fd1e3010e9..033d363606 100644 --- a/plugins/org/report.api.md +++ b/plugins/org/report.api.md @@ -106,7 +106,9 @@ export const UserProfileCard: (props: { // Warnings were encountered during analysis: // // src/components/Cards/Group/GroupProfile/GroupProfileCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "GroupProfileCard". -// src/components/Cards/Group/MembersList/MembersListCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "MembersListCard". +// src/components/Cards/Group/MembersList/MembersListCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "MemberComponentClassKey". +// src/components/Cards/Group/MembersList/MembersListCard.d.ts:6:1 - (ae-undocumented) Missing documentation for "MembersListCardClassKey". +// src/components/Cards/Group/MembersList/MembersListCard.d.ts:8:22 - (ae-undocumented) Missing documentation for "MembersListCard". // src/components/Cards/OwnershipCard/OwnershipCard.d.ts:5:22 - (ae-undocumented) Missing documentation for "OwnershipCard". // src/components/Cards/User/UserProfileCard/UserProfileCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "UserProfileCard". // src/components/Cards/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "EntityRelationAggregation". diff --git a/plugins/permission-node/report.api.md b/plugins/permission-node/report.api.md index 8dd8ac3c88..3deb87d141 100644 --- a/plugins/permission-node/report.api.md +++ b/plugins/permission-node/report.api.md @@ -298,8 +298,8 @@ export class ServerPermissionClient implements PermissionsService { // Warnings were encountered during analysis: // -// src/ServerPermissionClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/ServerPermissionClient.d.ts:18:5 - (ae-undocumented) Missing documentation for "authorizeConditional". -// src/ServerPermissionClient.d.ts:19:5 - (ae-undocumented) Missing documentation for "authorize". +// src/ServerPermissionClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/ServerPermissionClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "authorizeConditional". +// src/ServerPermissionClient.d.ts:21:5 - (ae-undocumented) Missing documentation for "authorize". // src/policy/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "handle". ``` diff --git a/plugins/proxy-backend/report.api.md b/plugins/proxy-backend/report.api.md index 7590d3b8d4..bf6ac6ae39 100644 --- a/plugins/proxy-backend/report.api.md +++ b/plugins/proxy-backend/report.api.md @@ -27,10 +27,10 @@ export interface RouterOptions { // Warnings were encountered during analysis: // -// src/service/router.d.ts:8:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "skipInvalidProxies". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "reviveConsumedRequestBodies". +// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "skipInvalidProxies". +// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "reviveConsumedRequestBodies". ``` diff --git a/plugins/scaffolder-backend/report.api.md b/plugins/scaffolder-backend/report.api.md index f51d756528..112d58046b 100644 --- a/plugins/scaffolder-backend/report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -847,7 +847,7 @@ export type TemplatePermissionRuleInput< // src/scaffolder/actions/TemplateActionRegistry.d.ts:8:5 - (ae-undocumented) Missing documentation for "register". // src/scaffolder/actions/TemplateActionRegistry.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". // src/scaffolder/actions/TemplateActionRegistry.d.ts:10:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/actions/builtin/createBuiltinActions.d.ts:37:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". +// src/scaffolder/actions/builtin/createBuiltinActions.d.ts:36:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". // src/scaffolder/actions/deprecated.d.ts:12:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". // src/scaffolder/actions/deprecated.d.ts:17:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". // src/scaffolder/actions/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". @@ -869,22 +869,22 @@ export type TemplatePermissionRuleInput< // src/scaffolder/actions/deprecated.d.ts:119:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:41:5 - (ae-undocumented) Missing documentation for "create". // src/scaffolder/tasks/DatabaseTaskStore.d.ts:48:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:53:5 - (ae-undocumented) Missing documentation for "getTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:54:5 - (ae-undocumented) Missing documentation for "createTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:55:5 - (ae-undocumented) Missing documentation for "claimTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:56:5 - (ae-undocumented) Missing documentation for "heartbeatTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:57:5 - (ae-undocumented) Missing documentation for "listStaleTasks". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:65:5 - (ae-undocumented) Missing documentation for "completeTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:70:5 - (ae-undocumented) Missing documentation for "emitLogEvent". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:73:5 - (ae-undocumented) Missing documentation for "getTaskState". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:78:5 - (ae-undocumented) Missing documentation for "saveTaskState". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:82:5 - (ae-undocumented) Missing documentation for "listEvents". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:85:5 - (ae-undocumented) Missing documentation for "shutdownTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:86:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:90:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:93:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:97:5 - (ae-undocumented) Missing documentation for "cancelTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:100:5 - (ae-undocumented) Missing documentation for "recoverTasks". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:67:5 - (ae-undocumented) Missing documentation for "getTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:68:5 - (ae-undocumented) Missing documentation for "createTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:69:5 - (ae-undocumented) Missing documentation for "claimTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:70:5 - (ae-undocumented) Missing documentation for "heartbeatTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:71:5 - (ae-undocumented) Missing documentation for "listStaleTasks". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:79:5 - (ae-undocumented) Missing documentation for "completeTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:84:5 - (ae-undocumented) Missing documentation for "emitLogEvent". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:87:5 - (ae-undocumented) Missing documentation for "getTaskState". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:92:5 - (ae-undocumented) Missing documentation for "saveTaskState". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:96:5 - (ae-undocumented) Missing documentation for "listEvents". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:99:5 - (ae-undocumented) Missing documentation for "shutdownTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:100:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:104:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:107:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:111:5 - (ae-undocumented) Missing documentation for "cancelTask". +// src/scaffolder/tasks/DatabaseTaskStore.d.ts:114:5 - (ae-undocumented) Missing documentation for "recoverTasks". // src/scaffolder/tasks/StorageTaskBroker.d.ts:24:5 - (ae-undocumented) Missing documentation for "create". // src/scaffolder/tasks/StorageTaskBroker.d.ts:26:5 - (ae-undocumented) Missing documentation for "spec". // src/scaffolder/tasks/StorageTaskBroker.d.ts:27:5 - (ae-undocumented) Missing documentation for "cancelSignal". @@ -907,43 +907,44 @@ export type TemplatePermissionRuleInput< // src/scaffolder/tasks/TaskWorker.d.ts:63:5 - (ae-undocumented) Missing documentation for "stop". // src/scaffolder/tasks/TaskWorker.d.ts:64:5 - (ae-undocumented) Missing documentation for "onReadyToClaimTask". // src/scaffolder/tasks/TaskWorker.d.ts:65:5 - (ae-undocumented) Missing documentation for "runOneTask". -// src/scaffolder/tasks/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "cancelTask". -// src/scaffolder/tasks/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "createTask". -// src/scaffolder/tasks/types.d.ts:126:5 - (ae-undocumented) Missing documentation for "recoverTasks". -// src/scaffolder/tasks/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "getTask". -// src/scaffolder/tasks/types.d.ts:130:5 - (ae-undocumented) Missing documentation for "claimTask". -// src/scaffolder/tasks/types.d.ts:131:5 - (ae-undocumented) Missing documentation for "completeTask". -// src/scaffolder/tasks/types.d.ts:136:5 - (ae-undocumented) Missing documentation for "heartbeatTask". -// src/scaffolder/tasks/types.d.ts:137:5 - (ae-undocumented) Missing documentation for "listStaleTasks". -// src/scaffolder/tasks/types.d.ts:144:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/tasks/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "emitLogEvent". -// src/scaffolder/tasks/types.d.ts:150:5 - (ae-undocumented) Missing documentation for "getTaskState". -// src/scaffolder/tasks/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "saveTaskState". -// src/scaffolder/tasks/types.d.ts:159:5 - (ae-undocumented) Missing documentation for "listEvents". -// src/scaffolder/tasks/types.d.ts:162:5 - (ae-undocumented) Missing documentation for "shutdownTask". -// src/scaffolder/tasks/types.d.ts:163:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/scaffolder/tasks/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/scaffolder/tasks/types.d.ts:170:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/service/router.d.ts:19:1 - (ae-undocumented) Missing documentation for "TemplatePermissionRuleInput". -// src/service/router.d.ts:24:1 - (ae-undocumented) Missing documentation for "ActionPermissionRuleInput". -// src/service/router.d.ts:31:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:32:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:33:5 - (ae-undocumented) Missing documentation for "reader". -// src/service/router.d.ts:34:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/service/router.d.ts:35:5 - (ae-undocumented) Missing documentation for "database". -// src/service/router.d.ts:36:5 - (ae-undocumented) Missing documentation for "catalogClient". -// src/service/router.d.ts:37:5 - (ae-undocumented) Missing documentation for "scheduler". -// src/service/router.d.ts:38:5 - (ae-undocumented) Missing documentation for "actions". -// src/service/router.d.ts:43:5 - (ae-undocumented) Missing documentation for "taskWorkers". -// src/service/router.d.ts:49:5 - (ae-undocumented) Missing documentation for "taskBroker". -// src/service/router.d.ts:50:5 - (ae-undocumented) Missing documentation for "additionalTemplateFilters". -// src/service/router.d.ts:51:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". -// src/service/router.d.ts:52:5 - (ae-undocumented) Missing documentation for "additionalWorkspaceProviders". -// src/service/router.d.ts:53:5 - (ae-undocumented) Missing documentation for "permissions". -// src/service/router.d.ts:54:5 - (ae-undocumented) Missing documentation for "permissionRules". -// src/service/router.d.ts:55:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:56:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:57:5 - (ae-undocumented) Missing documentation for "identity". -// src/service/router.d.ts:58:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:59:5 - (ae-undocumented) Missing documentation for "autocompleteHandlers". +// src/scaffolder/tasks/types.d.ts:123:5 - (ae-undocumented) Missing documentation for "cancelTask". +// src/scaffolder/tasks/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "createTask". +// src/scaffolder/tasks/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "recoverTasks". +// src/scaffolder/tasks/types.d.ts:128:5 - (ae-undocumented) Missing documentation for "getTask". +// src/scaffolder/tasks/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "claimTask". +// src/scaffolder/tasks/types.d.ts:130:5 - (ae-undocumented) Missing documentation for "completeTask". +// src/scaffolder/tasks/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "heartbeatTask". +// src/scaffolder/tasks/types.d.ts:136:5 - (ae-undocumented) Missing documentation for "listStaleTasks". +// src/scaffolder/tasks/types.d.ts:143:5 - (ae-undocumented) Missing documentation for "list". +// src/scaffolder/tasks/types.d.ts:163:5 - (ae-undocumented) Missing documentation for "list". +// src/scaffolder/tasks/types.d.ts:182:5 - (ae-undocumented) Missing documentation for "emitLogEvent". +// src/scaffolder/tasks/types.d.ts:183:5 - (ae-undocumented) Missing documentation for "getTaskState". +// src/scaffolder/tasks/types.d.ts:188:5 - (ae-undocumented) Missing documentation for "saveTaskState". +// src/scaffolder/tasks/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "listEvents". +// src/scaffolder/tasks/types.d.ts:195:5 - (ae-undocumented) Missing documentation for "shutdownTask". +// src/scaffolder/tasks/types.d.ts:196:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". +// src/scaffolder/tasks/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". +// src/scaffolder/tasks/types.d.ts:203:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". +// src/service/router.d.ts:17:1 - (ae-undocumented) Missing documentation for "TemplatePermissionRuleInput". +// src/service/router.d.ts:22:1 - (ae-undocumented) Missing documentation for "ActionPermissionRuleInput". +// src/service/router.d.ts:30:5 - (ae-undocumented) Missing documentation for "logger". +// src/service/router.d.ts:31:5 - (ae-undocumented) Missing documentation for "config". +// src/service/router.d.ts:32:5 - (ae-undocumented) Missing documentation for "reader". +// src/service/router.d.ts:33:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/service/router.d.ts:34:5 - (ae-undocumented) Missing documentation for "database". +// src/service/router.d.ts:35:5 - (ae-undocumented) Missing documentation for "catalogClient". +// src/service/router.d.ts:36:5 - (ae-undocumented) Missing documentation for "scheduler". +// src/service/router.d.ts:37:5 - (ae-undocumented) Missing documentation for "actions". +// src/service/router.d.ts:42:5 - (ae-undocumented) Missing documentation for "taskWorkers". +// src/service/router.d.ts:48:5 - (ae-undocumented) Missing documentation for "taskBroker". +// src/service/router.d.ts:49:5 - (ae-undocumented) Missing documentation for "additionalTemplateFilters". +// src/service/router.d.ts:50:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". +// src/service/router.d.ts:51:5 - (ae-undocumented) Missing documentation for "additionalWorkspaceProviders". +// src/service/router.d.ts:52:5 - (ae-undocumented) Missing documentation for "permissions". +// src/service/router.d.ts:53:5 - (ae-undocumented) Missing documentation for "permissionRules". +// src/service/router.d.ts:54:5 - (ae-undocumented) Missing documentation for "auth". +// src/service/router.d.ts:55:5 - (ae-undocumented) Missing documentation for "httpAuth". +// src/service/router.d.ts:56:5 - (ae-undocumented) Missing documentation for "identity". +// src/service/router.d.ts:57:5 - (ae-undocumented) Missing documentation for "discovery". +// src/service/router.d.ts:58:5 - (ae-undocumented) Missing documentation for "autocompleteHandlers". ``` diff --git a/plugins/scaffolder-node/report.api.md b/plugins/scaffolder-node/report.api.md index 3dc385f202..ca48a25aa8 100644 --- a/plugins/scaffolder-node/report.api.md +++ b/plugins/scaffolder-node/report.api.md @@ -521,6 +521,7 @@ export type TemplateGlobal = // src/tasks/types.d.ts:126:5 - (ae-undocumented) Missing documentation for "event$". // src/tasks/types.d.ts:132:5 - (ae-undocumented) Missing documentation for "get". // src/tasks/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "list". +// src/tasks/types.d.ts:153:5 - (ae-undocumented) Missing documentation for "list". // src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "TemplateFilter". // src/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "TemplateGlobal". ``` diff --git a/plugins/scaffolder/report-alpha.api.md b/plugins/scaffolder/report-alpha.api.md index 9cbbfe5ee9..c8dc7c00e6 100644 --- a/plugins/scaffolder/report-alpha.api.md +++ b/plugins/scaffolder/report-alpha.api.md @@ -313,9 +313,13 @@ export type TemplateWizardPageProps = { // Warnings were encountered during analysis: // -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:5:15 - (ae-undocumented) Missing documentation for "_default". +// src/next/TemplateEditorPage/CustomFieldExplorer.d.ts:4:1 - (ae-undocumented) Missing documentation for "ScaffolderCustomFieldExplorerClassKey". +// src/next/TemplateEditorPage/TemplateEditor.d.ts:6:1 - (ae-undocumented) Missing documentation for "ScaffolderTemplateEditorClassKey". +// src/next/TemplateEditorPage/TemplateFormPreviewer.d.ts:4:1 - (ae-undocumented) Missing documentation for "ScaffolderTemplateFormPreviewerClassKey". // src/next/TemplateListPage/TemplateListPage.d.ts:7:1 - (ae-undocumented) Missing documentation for "TemplateListPageProps". // src/next/TemplateWizardPage/TemplateWizardPage.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateWizardPageProps". +// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "scaffolderTranslationRef". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-catalog/report.api.md b/plugins/search-backend-module-catalog/report.api.md index 5a1efffcb7..9ab87b31fe 100644 --- a/plugins/search-backend-module-catalog/report.api.md +++ b/plugins/search-backend-module-catalog/report.api.md @@ -55,10 +55,10 @@ export type DefaultCatalogCollatorFactoryOptions = { // Warnings were encountered during analysis: // // src/collators/CatalogCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". -// src/collators/DefaultCatalogCollatorFactory.d.ts:11:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". -// src/collators/DefaultCatalogCollatorFactory.d.ts:39:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/DefaultCatalogCollatorFactory.d.ts:40:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/collators/DefaultCatalogCollatorFactory.d.ts:47:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/collators/DefaultCatalogCollatorFactory.d.ts:49:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/DefaultCatalogCollatorFactory.d.ts:14:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". +// src/collators/DefaultCatalogCollatorFactory.d.ts:43:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/DefaultCatalogCollatorFactory.d.ts:44:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/collators/DefaultCatalogCollatorFactory.d.ts:51:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/collators/DefaultCatalogCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "getCollator". // src/collators/defaultCatalogCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". ``` diff --git a/plugins/search-backend-module-elasticsearch/report.api.md b/plugins/search-backend-module-elasticsearch/report.api.md index 4b55c64495..5cb0671a54 100644 --- a/plugins/search-backend-module-elasticsearch/report.api.md +++ b/plugins/search-backend-module-elasticsearch/report.api.md @@ -538,18 +538,18 @@ export interface OpenSearchNodeOptions { // src/engines/ElasticSearchClientWrapper.d.ts:80:5 - (ae-undocumented) Missing documentation for "getAliases". // src/engines/ElasticSearchClientWrapper.d.ts:83:5 - (ae-undocumented) Missing documentation for "createIndex". // src/engines/ElasticSearchClientWrapper.d.ts:86:5 - (ae-undocumented) Missing documentation for "updateAliases". -// src/engines/ElasticSearchSearchEngine.d.ts:45:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightOptions". -// src/engines/ElasticSearchSearchEngine.d.ts:53:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightConfig". -// src/engines/ElasticSearchSearchEngine.d.ts:63:1 - (ae-undocumented) Missing documentation for "ElasticSearchSearchEngine". -// src/engines/ElasticSearchSearchEngine.d.ts:72:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/engines/ElasticSearchSearchEngine.d.ts:94:5 - (ae-undocumented) Missing documentation for "translator". -// src/engines/ElasticSearchSearchEngine.d.ts:95:5 - (ae-undocumented) Missing documentation for "setTranslator". -// src/engines/ElasticSearchSearchEngine.d.ts:96:5 - (ae-undocumented) Missing documentation for "setIndexTemplate". -// src/engines/ElasticSearchSearchEngine.d.ts:97:5 - (ae-undocumented) Missing documentation for "getIndexer". -// src/engines/ElasticSearchSearchEngine.d.ts:98:5 - (ae-undocumented) Missing documentation for "query". -// src/engines/ElasticSearchSearchEngine.d.ts:108:1 - (ae-undocumented) Missing documentation for "decodePageCursor". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:29:5 - (ae-undocumented) Missing documentation for "indexName". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:40:5 - (ae-undocumented) Missing documentation for "initialize". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:41:5 - (ae-undocumented) Missing documentation for "index". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:42:5 - (ae-undocumented) Missing documentation for "finalize". +// src/engines/ElasticSearchSearchEngine.d.ts:44:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightOptions". +// src/engines/ElasticSearchSearchEngine.d.ts:52:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightConfig". +// src/engines/ElasticSearchSearchEngine.d.ts:62:1 - (ae-undocumented) Missing documentation for "ElasticSearchSearchEngine". +// src/engines/ElasticSearchSearchEngine.d.ts:71:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/engines/ElasticSearchSearchEngine.d.ts:93:5 - (ae-undocumented) Missing documentation for "translator". +// src/engines/ElasticSearchSearchEngine.d.ts:94:5 - (ae-undocumented) Missing documentation for "setTranslator". +// src/engines/ElasticSearchSearchEngine.d.ts:95:5 - (ae-undocumented) Missing documentation for "setIndexTemplate". +// src/engines/ElasticSearchSearchEngine.d.ts:96:5 - (ae-undocumented) Missing documentation for "getIndexer". +// src/engines/ElasticSearchSearchEngine.d.ts:97:5 - (ae-undocumented) Missing documentation for "query". +// src/engines/ElasticSearchSearchEngine.d.ts:107:1 - (ae-undocumented) Missing documentation for "decodePageCursor". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:28:5 - (ae-undocumented) Missing documentation for "indexName". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:39:5 - (ae-undocumented) Missing documentation for "initialize". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:40:5 - (ae-undocumented) Missing documentation for "index". +// src/engines/ElasticSearchSearchEngineIndexer.d.ts:41:5 - (ae-undocumented) Missing documentation for "finalize". ``` diff --git a/plugins/search-backend-module-explore/report.api.md b/plugins/search-backend-module-explore/report.api.md index 39a732c2ca..8738ad2c86 100644 --- a/plugins/search-backend-module-explore/report.api.md +++ b/plugins/search-backend-module-explore/report.api.md @@ -43,6 +43,7 @@ export type ToolDocumentCollatorFactoryOptions = { // Warnings were encountered during analysis: // +// src/collators/ToolDocumentCollatorFactory.d.ts:19:1 - (ae-undocumented) Missing documentation for "ToolDocumentCollatorFactoryOptions". // src/collators/ToolDocumentCollatorFactory.d.ts:32:5 - (ae-undocumented) Missing documentation for "type". // src/collators/ToolDocumentCollatorFactory.d.ts:37:5 - (ae-undocumented) Missing documentation for "fromConfig". // src/collators/ToolDocumentCollatorFactory.d.ts:38:5 - (ae-undocumented) Missing documentation for "getCollator". diff --git a/plugins/search-backend-module-pg/report.api.md b/plugins/search-backend-module-pg/report.api.md index af9a139261..36346491fa 100644 --- a/plugins/search-backend-module-pg/report.api.md +++ b/plugins/search-backend-module-pg/report.api.md @@ -191,14 +191,14 @@ export interface RawDocumentRow { // Warnings were encountered during analysis: // -// src/PgSearchEngine/PgSearchEngine.d.ts:52:1 - (ae-undocumented) Missing documentation for "PgSearchEngine". -// src/PgSearchEngine/PgSearchEngine.d.ts:64:5 - (ae-undocumented) Missing documentation for "from". -// src/PgSearchEngine/PgSearchEngine.d.ts:69:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/PgSearchEngine/PgSearchEngine.d.ts:70:5 - (ae-undocumented) Missing documentation for "supported". -// src/PgSearchEngine/PgSearchEngine.d.ts:71:5 - (ae-undocumented) Missing documentation for "translator". -// src/PgSearchEngine/PgSearchEngine.d.ts:72:5 - (ae-undocumented) Missing documentation for "setTranslator". -// src/PgSearchEngine/PgSearchEngine.d.ts:73:5 - (ae-undocumented) Missing documentation for "getIndexer". -// src/PgSearchEngine/PgSearchEngine.d.ts:74:5 - (ae-undocumented) Missing documentation for "query". +// src/PgSearchEngine/PgSearchEngine.d.ts:51:1 - (ae-undocumented) Missing documentation for "PgSearchEngine". +// src/PgSearchEngine/PgSearchEngine.d.ts:63:5 - (ae-undocumented) Missing documentation for "from". +// src/PgSearchEngine/PgSearchEngine.d.ts:68:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/PgSearchEngine/PgSearchEngine.d.ts:69:5 - (ae-undocumented) Missing documentation for "supported". +// src/PgSearchEngine/PgSearchEngine.d.ts:70:5 - (ae-undocumented) Missing documentation for "translator". +// src/PgSearchEngine/PgSearchEngine.d.ts:71:5 - (ae-undocumented) Missing documentation for "setTranslator". +// src/PgSearchEngine/PgSearchEngine.d.ts:72:5 - (ae-undocumented) Missing documentation for "getIndexer". +// src/PgSearchEngine/PgSearchEngine.d.ts:73:5 - (ae-undocumented) Missing documentation for "query". // src/PgSearchEngine/PgSearchEngineIndexer.d.ts:6:1 - (ae-undocumented) Missing documentation for "PgSearchEngineIndexerOptions". // src/PgSearchEngine/PgSearchEngineIndexer.d.ts:13:1 - (ae-undocumented) Missing documentation for "PgSearchEngineIndexer". // src/PgSearchEngine/PgSearchEngineIndexer.d.ts:20:5 - (ae-undocumented) Missing documentation for "initialize". diff --git a/plugins/search-backend-module-techdocs/report.api.md b/plugins/search-backend-module-techdocs/report.api.md index 3ef7bea9c1..49336d223d 100644 --- a/plugins/search-backend-module-techdocs/report.api.md +++ b/plugins/search-backend-module-techdocs/report.api.md @@ -57,10 +57,10 @@ export type TechDocsCollatorFactoryOptions = { // Warnings were encountered during analysis: // -// src/collators/DefaultTechDocsCollatorFactory.d.ts:34:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/DefaultTechDocsCollatorFactory.d.ts:35:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/collators/DefaultTechDocsCollatorFactory.d.ts:45:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/collators/DefaultTechDocsCollatorFactory.d.ts:46:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:36:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:37:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:47:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/collators/DefaultTechDocsCollatorFactory.d.ts:48:5 - (ae-undocumented) Missing documentation for "getCollator". // src/collators/TechDocsCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformer". // src/collators/defaultTechDocsCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultTechDocsCollatorEntityTransformer". ``` diff --git a/plugins/search-backend-node/report.api.md b/plugins/search-backend-node/report.api.md index b2dae26f86..2086e3a351 100644 --- a/plugins/search-backend-node/report.api.md +++ b/plugins/search-backend-node/report.api.md @@ -213,9 +213,9 @@ export type TestPipelineResult = { // Warnings were encountered during analysis: // -// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:52:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:65:5 - (ae-undocumented) Missing documentation for "getCollator". +// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:51:5 - (ae-undocumented) Missing documentation for "type". +// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:52:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:64:5 - (ae-undocumented) Missing documentation for "getCollator". // src/engines/LunrSearchEngine.d.ts:25:5 - (ae-undocumented) Missing documentation for "lunrIndices". // src/engines/LunrSearchEngine.d.ts:26:5 - (ae-undocumented) Missing documentation for "docStore". // src/engines/LunrSearchEngine.d.ts:27:5 - (ae-undocumented) Missing documentation for "logger". diff --git a/plugins/search-backend/report.api.md b/plugins/search-backend/report.api.md index 8f739c76f1..42714f5070 100644 --- a/plugins/search-backend/report.api.md +++ b/plugins/search-backend/report.api.md @@ -31,6 +31,6 @@ export type RouterOptions = { // Warnings were encountered during analysis: // -// src/service/router.d.ts:10:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:23:1 - (ae-undocumented) Missing documentation for "createRouter". +// src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/service/router.d.ts:25:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/search-react/report-alpha.api.md b/plugins/search-react/report-alpha.api.md index e49b0bbeee..2397995355 100644 --- a/plugins/search-react/report-alpha.api.md +++ b/plugins/search-react/report-alpha.api.md @@ -71,5 +71,12 @@ export interface SearchResultListItemBlueprintParams { predicate?: SearchResultItemExtensionPredicate; } +// Warnings were encountered during analysis: +// +// src/alpha/blueprints/SearchResultListItemBlueprint.d.ts:3:1 - (ae-undocumented) Missing documentation for "SearchResultListItemBlueprintParams". +// src/alpha/blueprints/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "BaseSearchResultListItemProps". +// src/alpha/blueprints/types.d.ts:10:1 - (ae-undocumented) Missing documentation for "SearchResultItemExtensionComponent". +// src/alpha/blueprints/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "SearchResultItemExtensionPredicate". + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-react/report.api.md b/plugins/search-react/report.api.md index 46097fe188..e0698da6e2 100644 --- a/plugins/search-react/report.api.md +++ b/plugins/search-react/report.api.md @@ -492,7 +492,8 @@ export const useSearchResultListItemExtensions: ( // src/api.d.ts:18:5 - (ae-undocumented) Missing documentation for "mockedResults". // src/api.d.ts:20:5 - (ae-undocumented) Missing documentation for "query". // src/components/DefaultResultListItem/DefaultResultListItem.d.ts:26:15 - (ae-undocumented) Missing documentation for "HigherOrderDefaultResultListItem". -// src/components/HighlightedSearchResultText/HighlightedSearchResultText.d.ts:15:22 - (ae-undocumented) Missing documentation for "HighlightedSearchResultText". +// src/components/HighlightedSearchResultText/HighlightedSearchResultText.d.ts:3:1 - (ae-undocumented) Missing documentation for "HighlightedSearchResultTextClassKey". +// src/components/HighlightedSearchResultText/HighlightedSearchResultText.d.ts:17:22 - (ae-undocumented) Missing documentation for "HighlightedSearchResultText". // src/components/SearchFilter/SearchFilter.Autocomplete.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchAutocompleteFilterProps". // src/components/SearchFilter/SearchFilter.Autocomplete.d.ts:14:22 - (ae-undocumented) Missing documentation for "AutocompleteFilter". // src/components/SearchFilter/SearchFilter.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchFilterComponentProps". diff --git a/plugins/search/report-alpha.api.md b/plugins/search/report-alpha.api.md index 052340c432..1d9bd7a6f6 100644 --- a/plugins/search/report-alpha.api.md +++ b/plugins/search/report-alpha.api.md @@ -196,10 +196,10 @@ export const searchPage: ExtensionDefinition<{ // Warnings were encountered during analysis: // -// src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "searchApi". -// src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "searchPage". -// src/alpha.d.ts:12:22 - (ae-undocumented) Missing documentation for "searchNavItem". -// src/alpha.d.ts:18:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "searchApi". +// src/alpha.d.ts:15:22 - (ae-undocumented) Missing documentation for "searchPage". +// src/alpha.d.ts:47:22 - (ae-undocumented) Missing documentation for "searchNavItem". +// src/alpha.d.ts:65:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/report.api.md b/plugins/search/report.api.md index 5ff64322e2..7bb1dca05e 100644 --- a/plugins/search/report.api.md +++ b/plugins/search/report.api.md @@ -143,16 +143,16 @@ export function useSearchModal(initialState?: boolean): SearchModalValue; // Warnings were encountered during analysis: // -// src/components/SearchModal/SearchModal.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchModalChildrenProps". -// src/components/SearchModal/SearchModal.d.ts:14:1 - (ae-undocumented) Missing documentation for "SearchModalProps". -// src/components/SearchModal/SearchModal.d.ts:41:22 - (ae-undocumented) Missing documentation for "SearchModal". +// src/components/SearchModal/SearchModal.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchModalChildrenProps". +// src/components/SearchModal/SearchModal.d.ts:19:1 - (ae-undocumented) Missing documentation for "SearchModalProps". +// src/components/SearchModal/SearchModal.d.ts:50:22 - (ae-undocumented) Missing documentation for "SearchModal". // src/components/SearchPage/SearchPage.d.ts:6:22 - (ae-undocumented) Missing documentation for "SearchPage". // src/components/SearchType/SearchType.Accordion.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchTypeAccordionProps". // src/components/SearchType/SearchType.Tabs.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchTypeTabsProps". // src/components/SearchType/SearchType.d.ts:18:15 - (ae-undocumented) Missing documentation for "SearchType". // src/components/SidebarSearch/SidebarSearch.d.ts:14:22 - (ae-undocumented) Missing documentation for "SidebarSearch". -// src/plugin.d.ts:6:22 - (ae-undocumented) Missing documentation for "searchPlugin". -// src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "SearchPage". -// src/plugin.d.ts:16:22 - (ae-undocumented) Missing documentation for "SidebarSearchModal". -// src/plugin.d.ts:20:22 - (ae-undocumented) Missing documentation for "HomePageSearchBar". +// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "searchPlugin". +// src/plugin.d.ts:13:22 - (ae-undocumented) Missing documentation for "SearchPage". +// src/plugin.d.ts:17:22 - (ae-undocumented) Missing documentation for "SidebarSearchModal". +// src/plugin.d.ts:21:22 - (ae-undocumented) Missing documentation for "HomePageSearchBar". ``` diff --git a/plugins/signals-backend/report.api.md b/plugins/signals-backend/report.api.md index 5e3069f382..df68dcd62b 100644 --- a/plugins/signals-backend/report.api.md +++ b/plugins/signals-backend/report.api.md @@ -43,16 +43,16 @@ export default signalsPlugin; // Warnings were encountered during analysis: // -// src/service/router.d.ts:8:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "events". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "identity". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "userInfo". -// src/service/router.d.ts:19:1 - (ae-undocumented) Missing documentation for "createRouter". +// src/deprecated.d.ts:10:1 - (ae-undocumented) Missing documentation for "RouterOptions". +// src/deprecated.d.ts:11:5 - (ae-undocumented) Missing documentation for "logger". +// src/deprecated.d.ts:12:5 - (ae-undocumented) Missing documentation for "events". +// src/deprecated.d.ts:13:5 - (ae-undocumented) Missing documentation for "identity". +// src/deprecated.d.ts:14:5 - (ae-undocumented) Missing documentation for "discovery". +// src/deprecated.d.ts:15:5 - (ae-undocumented) Missing documentation for "config". +// src/deprecated.d.ts:16:5 - (ae-undocumented) Missing documentation for "lifecycle". +// src/deprecated.d.ts:17:5 - (ae-undocumented) Missing documentation for "auth". +// src/deprecated.d.ts:18:5 - (ae-undocumented) Missing documentation for "userInfo". +// src/deprecated.d.ts:24:1 - (ae-undocumented) Missing documentation for "createRouter". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals/report.api.md b/plugins/signals/report.api.md index 27a4a3fea5..049f50b2f2 100644 --- a/plugins/signals/report.api.md +++ b/plugins/signals/report.api.md @@ -44,6 +44,7 @@ export const signalsPlugin: BackstagePlugin<{}, {}>; // src/api/SignalClient.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". // src/api/SignalClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "subscribe". // src/plugin.d.ts:2:22 - (ae-undocumented) Missing documentation for "signalsPlugin". +// src/plugin.d.ts:4:22 - (ae-undocumented) Missing documentation for "SignalsDisplay". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs-backend/report.api.md b/plugins/techdocs-backend/report.api.md index 59d21df21c..6b84666e50 100644 --- a/plugins/techdocs-backend/report.api.md +++ b/plugins/techdocs-backend/report.api.md @@ -118,11 +118,11 @@ export * from '@backstage/plugin-techdocs-node'; // src/index.d.ts:16:1 - (ae-undocumented) Missing documentation for "DocsBuildStrategy". // src/index.d.ts:21:1 - (ae-undocumented) Missing documentation for "ShouldBuildParameters". // src/index.d.ts:28:1 - (ae-undocumented) Missing documentation for "TechDocsDocument". -// src/search/DefaultTechDocsCollator.d.ts:31:5 - (ae-undocumented) Missing documentation for "type". -// src/search/DefaultTechDocsCollator.d.ts:32:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/search/DefaultTechDocsCollator.d.ts:34:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/search/DefaultTechDocsCollator.d.ts:35:5 - (ae-undocumented) Missing documentation for "execute". -// src/search/DefaultTechDocsCollator.d.ts:36:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". +// src/search/DefaultTechDocsCollator.d.ts:32:5 - (ae-undocumented) Missing documentation for "type". +// src/search/DefaultTechDocsCollator.d.ts:33:5 - (ae-undocumented) Missing documentation for "visibilityPermission". +// src/search/DefaultTechDocsCollator.d.ts:35:5 - (ae-undocumented) Missing documentation for "fromConfig". +// src/search/DefaultTechDocsCollator.d.ts:36:5 - (ae-undocumented) Missing documentation for "execute". +// src/search/DefaultTechDocsCollator.d.ts:37:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". // src/search/index.d.ts:12:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorFactoryOptions". // src/search/index.d.ts:17:22 - (ae-undocumented) Missing documentation for "DefaultTechDocsCollatorFactory". ``` diff --git a/plugins/techdocs-common/api-report.md b/plugins/techdocs-common/api-report.md deleted file mode 100644 index c7e1829a28..0000000000 --- a/plugins/techdocs-common/api-report.md +++ /dev/null @@ -1,11 +0,0 @@ -## API Report File for "@backstage/plugin-techdocs-common" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -// @public (undocumented) -export const TECHDOCS_ANNOTATION = 'backstage.io/techdocs-ref'; - -// @public (undocumented) -export const TECHDOCS_EXTERNAL_ANNOTATION = 'backstage.io/techdocs-entity'; -``` diff --git a/plugins/techdocs/report-alpha.api.md b/plugins/techdocs/report-alpha.api.md index c2f75be11e..075cb34bfa 100644 --- a/plugins/techdocs/report-alpha.api.md +++ b/plugins/techdocs/report-alpha.api.md @@ -316,8 +316,8 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{ // Warnings were encountered during analysis: // -// src/alpha.d.ts:2:22 - (ae-undocumented) Missing documentation for "techDocsSearchResultListItemExtension". -// src/alpha.d.ts:16:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "techDocsSearchResultListItemExtension". +// src/alpha.d.ts:35:15 - (ae-undocumented) Missing documentation for "_default". // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/report.api.md b/plugins/techdocs/report.api.md index 3d90d05eca..3ecf2cf7d2 100644 --- a/plugins/techdocs/report.api.md +++ b/plugins/techdocs/report.api.md @@ -537,5 +537,5 @@ export class TechDocsStorageClient implements TechDocsStorageApi_2 { // src/home/components/TechDocsCustomHome.d.ts:29:5 - (ae-undocumented) Missing documentation for "panels". // src/index.d.ts:21:1 - (ae-undocumented) Missing documentation for "DeprecatedTechDocsMetadata". // src/index.d.ts:27:1 - (ae-undocumented) Missing documentation for "DeprecatedTechDocsEntityMetadata". -// src/reader/components/TechDocsReaderPage/TechDocsReaderPage.d.ts:26:1 - (ae-undocumented) Missing documentation for "TechDocsReaderPageProps". +// src/reader/components/TechDocsReaderPage/TechDocsReaderPage.d.ts:27:1 - (ae-undocumented) Missing documentation for "TechDocsReaderPageProps". ``` diff --git a/plugins/user-settings-backend/report.api.md b/plugins/user-settings-backend/report.api.md index ac33b9af5d..04aecca574 100644 --- a/plugins/user-settings-backend/report.api.md +++ b/plugins/user-settings-backend/report.api.md @@ -18,12 +18,5 @@ export type RouterOptions = { signals?: SignalsService; }; -// Warnings were encountered during analysis: -// -// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "database". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "identity". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "signals". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings/report-alpha.api.md b/plugins/user-settings/report-alpha.api.md index 299bbc3498..d9dad32623 100644 --- a/plugins/user-settings/report-alpha.api.md +++ b/plugins/user-settings/report-alpha.api.md @@ -129,8 +129,8 @@ export const userSettingsTranslationRef: TranslationRef< // Warnings were encountered during analysis: // -// src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "settingsNavItem". -// src/alpha.d.ts:11:15 - (ae-undocumented) Missing documentation for "_default". +// src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "settingsNavItem". +// src/alpha.d.ts:24:15 - (ae-undocumented) Missing documentation for "_default". // src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "userSettingsTranslationRef". // (No @packageDocumentation comment for this package) diff --git a/yarn.lock b/yarn.lock index 7a0bff43c9..e3f5be5bd2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7969,8 +7969,8 @@ __metadata: "@backstage/errors": "workspace:^" "@backstage/types": "workspace:^" "@manypkg/get-packages": ^1.1.3 - "@microsoft/api-documenter": ^7.22.33 - "@microsoft/api-extractor": ^7.36.4 + "@microsoft/api-documenter": ^7.25.7 + "@microsoft/api-extractor": ^7.47.2 "@openapitools/openapi-generator-cli": ^2.7.0 "@stoplight/spectral-core": ^1.18.0 "@stoplight/spectral-formatters": ^1.1.0 @@ -10753,53 +10753,54 @@ __metadata: languageName: node linkType: hard -"@microsoft/api-documenter@npm:^7.22.33": - version: 7.22.33 - resolution: "@microsoft/api-documenter@npm:7.22.33" +"@microsoft/api-documenter@npm:^7.25.7": + version: 7.25.14 + resolution: "@microsoft/api-documenter@npm:7.25.14" dependencies: - "@microsoft/api-extractor-model": 7.27.6 - "@microsoft/tsdoc": 0.14.2 - "@rushstack/node-core-library": 3.59.7 - "@rushstack/ts-command-line": 4.15.2 - colors: ~1.2.1 + "@microsoft/api-extractor-model": 7.29.8 + "@microsoft/tsdoc": ~0.15.0 + "@rushstack/node-core-library": 5.9.0 + "@rushstack/terminal": 0.14.2 + "@rushstack/ts-command-line": 4.22.8 js-yaml: ~3.13.1 resolve: ~1.22.1 bin: api-documenter: bin/api-documenter - checksum: b2aa75823c3a5bf65ce87b56bd85dfa276ff155eb2244187e163e4eb8f4a2daf15e39e9b5d1dea13f854309d9562ab845ff6c7c8b4973e409593852c3bc058f0 + checksum: 1b4f5054c93ab77b4de196c07432d29ac40a488dd33881ad230897f4c393859ef05ab3503163ecaa4914ba4043b33070d9887bdde64a496a7d27dbcd94583622 languageName: node linkType: hard -"@microsoft/api-extractor-model@npm:7.27.6": - version: 7.27.6 - resolution: "@microsoft/api-extractor-model@npm:7.27.6" +"@microsoft/api-extractor-model@npm:7.29.8": + version: 7.29.8 + resolution: "@microsoft/api-extractor-model@npm:7.29.8" dependencies: - "@microsoft/tsdoc": 0.14.2 - "@microsoft/tsdoc-config": ~0.16.1 - "@rushstack/node-core-library": 3.59.7 - checksum: 7867feaf3a0e5accfcce3a77681248a319952a266cffc644e4f8f7df1c9e1d55adb5124df901e8cca594bb3e12d361d1fcb2bffbdbb4b20fe3113928f6535975 + "@microsoft/tsdoc": ~0.15.0 + "@microsoft/tsdoc-config": ~0.17.0 + "@rushstack/node-core-library": 5.9.0 + checksum: 95a6b5df089d8bf44555f4565a6f0eda9323917266b2f4730b606aeb2c7f36df7c2cbcae9ca48a9198af7a33442cda8ce2c791e0f4c7c92f3bdaee6c3190b1f5 languageName: node linkType: hard -"@microsoft/api-extractor@npm:^7.36.4": - version: 7.36.4 - resolution: "@microsoft/api-extractor@npm:7.36.4" +"@microsoft/api-extractor@npm:^7.47.2": + version: 7.47.9 + resolution: "@microsoft/api-extractor@npm:7.47.9" dependencies: - "@microsoft/api-extractor-model": 7.27.6 - "@microsoft/tsdoc": 0.14.2 - "@microsoft/tsdoc-config": ~0.16.1 - "@rushstack/node-core-library": 3.59.7 - "@rushstack/rig-package": 0.4.1 - "@rushstack/ts-command-line": 4.15.2 - colors: ~1.2.1 + "@microsoft/api-extractor-model": 7.29.8 + "@microsoft/tsdoc": ~0.15.0 + "@microsoft/tsdoc-config": ~0.17.0 + "@rushstack/node-core-library": 5.9.0 + "@rushstack/rig-package": 0.5.3 + "@rushstack/terminal": 0.14.2 + "@rushstack/ts-command-line": 4.22.8 lodash: ~4.17.15 + minimatch: ~3.0.3 resolve: ~1.22.1 semver: ~7.5.4 source-map: ~0.6.1 - typescript: ~5.0.4 + typescript: 5.4.2 bin: api-extractor: bin/api-extractor - checksum: 92559325cf2407fa27cb9675772956511fa35005f295cdb4dc47abd7ef9c77ba61b0f684c2e952301a76dd2cfa9e398840c8f3d9117d621300e12b0ecfbf8147 + checksum: 5e96654b388359bd9a1fb85ea7698921ca0f9dfa9c57e48fc9d28625107fea54863d57c82f4080686f190ae0d6fcd8b7fa7c070e7b8acb359b5cd62137e2bb23 languageName: node linkType: hard @@ -10817,22 +10818,22 @@ __metadata: languageName: node linkType: hard -"@microsoft/tsdoc-config@npm:~0.16.1": - version: 0.16.2 - resolution: "@microsoft/tsdoc-config@npm:0.16.2" +"@microsoft/tsdoc-config@npm:~0.17.0": + version: 0.17.0 + resolution: "@microsoft/tsdoc-config@npm:0.17.0" dependencies: - "@microsoft/tsdoc": 0.14.2 - ajv: ~6.12.6 + "@microsoft/tsdoc": 0.15.0 + ajv: ~8.12.0 jju: ~1.4.0 - resolve: ~1.19.0 - checksum: 12b0d703154076bcaac75ca42e804e4fc292672396441e54346d7eadd0d6b57f90980eda2b1bab89b224af86da34a2389f9054002e282011e795ca5919a4386f + resolve: ~1.22.2 + checksum: dd2de8247d0fc29608da83edf4ab73a21370f6ce10d089853303e91b135fdb1436ccec3bd1024f235dd3180dfe5dae7342989eadd03af55cf06f0e974e5fc213 languageName: node linkType: hard -"@microsoft/tsdoc@npm:0.14.2": - version: 0.14.2 - resolution: "@microsoft/tsdoc@npm:0.14.2" - checksum: b167c89e916ba73ee20b9c9d5dba6aa3a0de25ed3d50050e8a344dca7cd43cb2e1059bd515c820369b6e708901dd3fda476a42bc643ca74a35671ce77f724a3a +"@microsoft/tsdoc@npm:0.15.0, @microsoft/tsdoc@npm:~0.15.0": + version: 0.15.0 + resolution: "@microsoft/tsdoc@npm:0.15.0" + checksum: 3f693cff07b220b68563e3f86e9f94a9c8d0791a7446f76149c7d62ae5ed5cb4578bb48b9b5f9baa3dd9a9f77be81903c74654a41e0ca4ecf78936654952a8d4 languageName: node linkType: hard @@ -14472,45 +14473,61 @@ __metadata: languageName: node linkType: hard -"@rushstack/node-core-library@npm:3.59.7": - version: 3.59.7 - resolution: "@rushstack/node-core-library@npm:3.59.7" +"@rushstack/node-core-library@npm:5.9.0": + version: 5.9.0 + resolution: "@rushstack/node-core-library@npm:5.9.0" dependencies: - colors: ~1.2.1 + ajv: ~8.13.0 + ajv-draft-04: ~1.0.0 + ajv-formats: ~3.0.1 fs-extra: ~7.0.1 import-lazy: ~4.0.0 jju: ~1.4.0 resolve: ~1.22.1 semver: ~7.5.4 - z-schema: ~5.0.2 peerDependencies: "@types/node": "*" peerDependenciesMeta: "@types/node": optional: true - checksum: 57819d62fd662a6cf3306bf7d39c11204e094a2d5c2210639c2ac5baee58c183c02023203963cd0484a5623fd9f5dea7a223df843fb52b46a18508e6118cdc19 + checksum: beb558f118a796260f7df38b48b6669a94bbdb9711715785e0c5a426bd3a38c14721c03fc05e7a33883ec25a331ef0fb9e36438bb451ace021a7248a4f1fc74b languageName: node linkType: hard -"@rushstack/rig-package@npm:0.4.1": - version: 0.4.1 - resolution: "@rushstack/rig-package@npm:0.4.1" +"@rushstack/rig-package@npm:0.5.3": + version: 0.5.3 + resolution: "@rushstack/rig-package@npm:0.5.3" dependencies: resolve: ~1.22.1 strip-json-comments: ~3.1.1 - checksum: 68c5ec6c446c35939fca0444fa48e5beda736e3a5816e8b44d83df6ba8b9a2caf0ceddbdc866cd8ad3b523e42877cf6ecd467bc7839e3d618a9bb1c4b3e0b5a5 + checksum: bf3eadfc434bff273893efd22b319fe159d0e3b95729cb32ce3ad9f4ab4b6fabe3c4dd7f03ee0ddc7b480f0d989e908349eae6d6dce3500f896728a085af7aab languageName: node linkType: hard -"@rushstack/ts-command-line@npm:4.15.2": - version: 4.15.2 - resolution: "@rushstack/ts-command-line@npm:4.15.2" +"@rushstack/terminal@npm:0.14.2": + version: 0.14.2 + resolution: "@rushstack/terminal@npm:0.14.2" dependencies: + "@rushstack/node-core-library": 5.9.0 + supports-color: ~8.1.1 + peerDependencies: + "@types/node": "*" + peerDependenciesMeta: + "@types/node": + optional: true + checksum: 90d38e6979737dcd97fdfdcebcc378194eed32a994341846235769273b6446b702e53e51e18fc8a373e8ed989c5622216aa6804198b8c7ae0e65cd6b103b90a1 + languageName: node + linkType: hard + +"@rushstack/ts-command-line@npm:4.22.8": + version: 4.22.8 + resolution: "@rushstack/ts-command-line@npm:4.22.8" + dependencies: + "@rushstack/terminal": 0.14.2 "@types/argparse": 1.0.38 argparse: ~1.0.9 - colors: ~1.2.1 string-argv: ~0.3.1 - checksum: c80dcfc99630ee51c6654c58ff41f69a3bd89c38e41d9871692bc73ee3c938ced79f8b75e182e492cafb2f6ddeb0628606856af494a0259ff6fac5b248996bed + checksum: b0108e4b567c364a7c62b30dc3e4d17130b6f8ba16a0457c56b8c898ba84316e72726a4e043ca5183da7bf5d0189aed585ab3ac8bce5991b8e80ac94d333cd6c languageName: node linkType: hard @@ -20122,6 +20139,20 @@ __metadata: languageName: node linkType: hard +"ajv-formats@npm:~3.0.1": + version: 3.0.1 + resolution: "ajv-formats@npm:3.0.1" + dependencies: + ajv: ^8.0.0 + peerDependencies: + ajv: ^8.0.0 + peerDependenciesMeta: + ajv: + optional: true + checksum: f4e1fe232d67fcafc02eafe373a7a9962351e0439dd0736647ca75c93c3da23b430b6502c255ab4315410ae330d4f3013ac9fe226c40b2524ca93a58e786d086 + languageName: node + linkType: hard + "ajv-i18n@npm:^4.2.0": version: 4.2.0 resolution: "ajv-i18n@npm:4.2.0" @@ -20151,7 +20182,7 @@ __metadata: languageName: node linkType: hard -"ajv@npm:^6.12.2, ajv@npm:^6.12.4, ajv@npm:^6.12.5, ajv@npm:^6.5.5, ajv@npm:~6.12.6": +"ajv@npm:^6.12.2, ajv@npm:^6.12.4, ajv@npm:^6.12.5, ajv@npm:^6.5.5": version: 6.12.6 resolution: "ajv@npm:6.12.6" dependencies: @@ -20175,6 +20206,30 @@ __metadata: languageName: node linkType: hard +"ajv@npm:~8.12.0": + version: 8.12.0 + resolution: "ajv@npm:8.12.0" + dependencies: + fast-deep-equal: ^3.1.1 + json-schema-traverse: ^1.0.0 + require-from-string: ^2.0.2 + uri-js: ^4.2.2 + checksum: 4dc13714e316e67537c8b31bc063f99a1d9d9a497eb4bbd55191ac0dcd5e4985bbb71570352ad6f1e76684fb6d790928f96ba3b2d4fd6e10024be9612fe3f001 + languageName: node + linkType: hard + +"ajv@npm:~8.13.0": + version: 8.13.0 + resolution: "ajv@npm:8.13.0" + dependencies: + fast-deep-equal: ^3.1.3 + json-schema-traverse: ^1.0.0 + require-from-string: ^2.0.2 + uri-js: ^4.4.1 + checksum: 6de82d0b2073e645ca3300561356ddda0234f39b35d2125a8700b650509b296f41c00ab69f53178bbe25ad688bd6ac3747ab44101f2f4bd245952e8fd6ccc3c1 + languageName: node + linkType: hard + "algoliasearch@npm:^4.2.0": version: 4.23.2 resolution: "algoliasearch@npm:4.23.2" @@ -22691,13 +22746,6 @@ __metadata: languageName: node linkType: hard -"colors@npm:~1.2.1": - version: 1.2.5 - resolution: "colors@npm:1.2.5" - checksum: b6e23de735f68b72d5cdf6fd854ca43d1b66d82dcf54bda0b788083b910164a040f2c4edf23c670d36a7a2d8f1b7d6e62e3292703e4642691e6ccaa1c62d8f74 - languageName: node - linkType: hard - "colorspace@npm:1.1.x": version: 1.1.2 resolution: "colorspace@npm:1.1.2" @@ -22780,7 +22828,7 @@ __metadata: languageName: node linkType: hard -"commander@npm:^2.19.0, commander@npm:^2.20.0, commander@npm:^2.7.1": +"commander@npm:^2.19.0, commander@npm:^2.20.0": version: 2.20.3 resolution: "commander@npm:2.20.3" checksum: ab8c07884e42c3a8dbc5dd9592c606176c7eb5c1ca5ff274bcf907039b2c41de3626f684ea75ccf4d361ba004bbaff1f577d5384c155f3871e456bdf27becf9e @@ -29579,7 +29627,7 @@ __metadata: languageName: node linkType: hard -"is-core-module@npm:^2.1.0, is-core-module@npm:^2.13.0, is-core-module@npm:^2.15.1": +"is-core-module@npm:^2.13.0, is-core-module@npm:^2.15.1": version: 2.15.1 resolution: "is-core-module@npm:2.15.1" dependencies: @@ -33742,6 +33790,15 @@ __metadata: languageName: node linkType: hard +"minimatch@npm:~3.0.3": + version: 3.0.8 + resolution: "minimatch@npm:3.0.8" + dependencies: + brace-expansion: ^1.1.7 + checksum: 850cca179cad715133132693e6963b0db64ab0988c4d211415b087fc23a3e46321e2c5376a01bf5623d8782aba8bdf43c571e2e902e51fdce7175c7215c29f8b + languageName: node + linkType: hard + "minimist@npm:^1.2.0, minimist@npm:^1.2.3, minimist@npm:^1.2.5, minimist@npm:^1.2.6, minimist@npm:^1.2.8": version: 1.2.8 resolution: "minimist@npm:1.2.8" @@ -36011,7 +36068,7 @@ __metadata: languageName: node linkType: hard -"path-parse@npm:^1.0.6, path-parse@npm:^1.0.7": +"path-parse@npm:^1.0.7": version: 1.0.7 resolution: "path-parse@npm:1.0.7" checksum: 49abf3d81115642938a8700ec580da6e830dde670be21893c62f4e10bd7dd4c3742ddc603fe24f898cba7eb0c6bc1777f8d9ac14185d34540c6d4d80cd9cae8a @@ -39027,7 +39084,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:1.22.8, resolve@npm:^1.1.6, resolve@npm:^1.14.2, resolve@npm:^1.17.0, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.1, resolve@npm:^1.22.4, resolve@npm:~1.22.1": +"resolve@npm:1.22.8, resolve@npm:^1.1.6, resolve@npm:^1.14.2, resolve@npm:^1.17.0, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.1, resolve@npm:^1.22.4, resolve@npm:~1.22.1, resolve@npm:~1.22.2": version: 1.22.8 resolution: "resolve@npm:1.22.8" dependencies: @@ -39053,17 +39110,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:~1.19.0": - version: 1.19.0 - resolution: "resolve@npm:1.19.0" - dependencies: - is-core-module: ^2.1.0 - path-parse: ^1.0.6 - checksum: a05b356e47b85ad3613d9e2a39a824f3c27f4fcad9c9ff6c7cc71a2e314c5904a90ab37481ad0069d03cab9eaaac6eb68aca1bc3355fdb05f1045cd50e2aacea - languageName: node - linkType: hard - -"resolve@patch:resolve@1.22.8#~builtin, resolve@patch:resolve@^1.1.6#~builtin, resolve@patch:resolve@^1.14.2#~builtin, resolve@patch:resolve@^1.17.0#~builtin, resolve@patch:resolve@^1.19.0#~builtin, resolve@patch:resolve@^1.20.0#~builtin, resolve@patch:resolve@^1.22.1#~builtin, resolve@patch:resolve@^1.22.4#~builtin, resolve@patch:resolve@~1.22.1#~builtin": +"resolve@patch:resolve@1.22.8#~builtin, resolve@patch:resolve@^1.1.6#~builtin, resolve@patch:resolve@^1.14.2#~builtin, resolve@patch:resolve@^1.17.0#~builtin, resolve@patch:resolve@^1.19.0#~builtin, resolve@patch:resolve@^1.20.0#~builtin, resolve@patch:resolve@^1.22.1#~builtin, resolve@patch:resolve@^1.22.4#~builtin, resolve@patch:resolve@~1.22.1#~builtin, resolve@patch:resolve@~1.22.2#~builtin": version: 1.22.8 resolution: "resolve@patch:resolve@npm%3A1.22.8#~builtin::version=1.22.8&hash=c3c19d" dependencies: @@ -39089,16 +39136,6 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@~1.19.0#~builtin": - version: 1.19.0 - resolution: "resolve@patch:resolve@npm%3A1.19.0#~builtin::version=1.19.0&hash=c3c19d" - dependencies: - is-core-module: ^2.1.0 - path-parse: ^1.0.6 - checksum: 2443b94d347e6946c87c85faf13071f605e609e0b54784829b0ed2b917d050bfc1cbaf4ecc6453f224cfa7d0c5dcd97cbb273454cd210bee68e4af15c1a5abc9 - languageName: node - linkType: hard - "responselike@npm:^1.0.2": version: 1.0.2 resolution: "responselike@npm:1.0.2" @@ -41380,7 +41417,7 @@ __metadata: languageName: node linkType: hard -"supports-color@npm:^8.0.0, supports-color@npm:^8.1.0, supports-color@npm:^8.1.1": +"supports-color@npm:^8.0.0, supports-color@npm:^8.1.0, supports-color@npm:^8.1.1, supports-color@npm:~8.1.1": version: 8.1.1 resolution: "supports-color@npm:8.1.1" dependencies: @@ -42588,13 +42625,13 @@ __metadata: languageName: node linkType: hard -"typescript@npm:~5.0.4": - version: 5.0.4 - resolution: "typescript@npm:5.0.4" +"typescript@npm:5.4.2": + version: 5.4.2 + resolution: "typescript@npm:5.4.2" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: 82b94da3f4604a8946da585f7d6c3025fff8410779e5bde2855ab130d05e4fd08938b9e593b6ebed165bda6ad9292b230984f10952cf82f0a0ca07bbeaa08172 + checksum: 96d80fde25a09bcb04d399082fb27a808a9e17c2111e43849d2aafbd642d835e4f4ef0de09b0ba795ec2a700be6c4c2c3f62bf4660c05404c948727b5bbfb32a languageName: node linkType: hard @@ -42618,13 +42655,13 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@~5.0.4#~builtin": - version: 5.0.4 - resolution: "typescript@patch:typescript@npm%3A5.0.4#~builtin::version=5.0.4&hash=b5f058" +"typescript@patch:typescript@5.4.2#~builtin": + version: 5.4.2 + resolution: "typescript@patch:typescript@npm%3A5.4.2#~builtin::version=5.4.2&hash=5adc0c" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: d26b6ba97b6d163c55dbdffd9bbb4c211667ebebc743accfeb2c8c0154aace7afd097b51165a72a5bad2cf65a4612259344ff60f8e642362aa1695c760d303ac + checksum: 797ac213c03a19749181c745647b4cab03d13bf4b6b738b05a3426f46c6b540f908989e839d9b0c89d7a4ee2bdb50493b4d4898d4ef1c897c3e9d0b082e78a67 languageName: node linkType: hard @@ -43413,13 +43450,6 @@ __metadata: languageName: node linkType: hard -"validator@npm:^13.7.0": - version: 13.7.0 - resolution: "validator@npm:13.7.0" - checksum: 2b83283de1222ca549a7ef57f46e8d49c6669213348db78b7045bce36a3b5843ff1e9f709ebf74574e06223461ee1f264f8cc9a26a0060a79a27de079d8286ef - languageName: node - linkType: hard - "value-or-promise@npm:1.0.11": version: 1.0.11 resolution: "value-or-promise@npm:1.0.11" @@ -44631,23 +44661,6 @@ __metadata: languageName: node linkType: hard -"z-schema@npm:~5.0.2": - version: 5.0.2 - resolution: "z-schema@npm:5.0.2" - dependencies: - commander: ^2.7.1 - lodash.get: ^4.4.2 - lodash.isequal: ^4.5.0 - validator: ^13.7.0 - dependenciesMeta: - commander: - optional: true - bin: - z-schema: bin/z-schema - checksum: 084b2f16043ac0a892914ee29cc0b4fafd9338133eec0345cd6ced25e814f647fa67be1090ad5f606759c2c1f2f8c28127960ba187f437f1caf6fb8cd45d7336 - languageName: node - linkType: hard - "zen-observable@npm:^0.10.0": version: 0.10.0 resolution: "zen-observable@npm:0.10.0" From eed4cdcb55b0f1332e12c1e923f9870500cf932d Mon Sep 17 00:00:00 2001 From: secustor Date: Mon, 23 Sep 2024 15:14:15 +0200 Subject: [PATCH 11/13] add missing files Signed-off-by: secustor --- .../catalog-client/report-testUtils.api.md | 88 +++ packages/frontend-defaults/report.api.md | 49 ++ plugins/app/report.api.md | 717 ++++++++++++++++++ .../report.api.md | 30 + .../report.api.md | 38 + plugins/catalog-node/report-testUtils.api.md | 27 + plugins/techdocs-common/report.api.md | 16 + 7 files changed, 965 insertions(+) create mode 100644 packages/catalog-client/report-testUtils.api.md create mode 100644 packages/frontend-defaults/report.api.md create mode 100644 plugins/app/report.api.md create mode 100644 plugins/auth-backend-module-auth0-provider/report.api.md create mode 100644 plugins/auth-backend-module-bitbucket-server-provider/report.api.md create mode 100644 plugins/catalog-node/report-testUtils.api.md create mode 100644 plugins/techdocs-common/report.api.md diff --git a/packages/catalog-client/report-testUtils.api.md b/packages/catalog-client/report-testUtils.api.md new file mode 100644 index 0000000000..9341327554 --- /dev/null +++ b/packages/catalog-client/report-testUtils.api.md @@ -0,0 +1,88 @@ +## API Report File for "@backstage/catalog-client" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { AddLocationRequest } from '@backstage/catalog-client'; +import { AddLocationResponse } from '@backstage/catalog-client'; +import { CatalogApi } from '@backstage/catalog-client'; +import { CompoundEntityRef } from '@backstage/catalog-model'; +import { Entity } from '@backstage/catalog-model'; +import { GetEntitiesByRefsRequest } from '@backstage/catalog-client'; +import { GetEntitiesByRefsResponse } from '@backstage/catalog-client'; +import { GetEntitiesRequest } from '@backstage/catalog-client'; +import { GetEntitiesResponse } from '@backstage/catalog-client'; +import { GetEntityAncestorsRequest } from '@backstage/catalog-client'; +import { GetEntityAncestorsResponse } from '@backstage/catalog-client'; +import { GetEntityFacetsRequest } from '@backstage/catalog-client'; +import { GetEntityFacetsResponse } from '@backstage/catalog-client'; +import { Location as Location_2 } from '@backstage/catalog-client'; +import { QueryEntitiesRequest } from '@backstage/catalog-client'; +import { QueryEntitiesResponse } from '@backstage/catalog-client'; +import { ValidateEntityResponse } from '@backstage/catalog-client'; + +// @public +export class InMemoryCatalogClient implements CatalogApi { + constructor(options?: { entities?: Entity[] }); + // (undocumented) + addLocation(_location: AddLocationRequest): Promise; + // (undocumented) + getEntities(request?: GetEntitiesRequest): Promise; + // (undocumented) + getEntitiesByRefs( + request: GetEntitiesByRefsRequest, + ): Promise; + // (undocumented) + getEntityAncestors( + request: GetEntityAncestorsRequest, + ): Promise; + // (undocumented) + getEntityByRef( + entityRef: string | CompoundEntityRef, + ): Promise; + // (undocumented) + getEntityFacets( + request: GetEntityFacetsRequest, + ): Promise; + // (undocumented) + getLocationByEntity( + _entityRef: string | CompoundEntityRef, + ): Promise; + // (undocumented) + getLocationById(_id: string): Promise; + // (undocumented) + getLocationByRef(_locationRef: string): Promise; + // (undocumented) + queryEntities(request?: QueryEntitiesRequest): Promise; + // (undocumented) + refreshEntity(_entityRef: string): Promise; + // (undocumented) + removeEntityByUid(uid: string): Promise; + // (undocumented) + removeLocationById(_id: string): Promise; + // (undocumented) + validateEntity( + _entity: Entity, + _locationRef: string, + ): Promise; +} + +// Warnings were encountered during analysis: +// +// src/testUtils/InMemoryCatalogClient.d.ts:15:5 - (ae-undocumented) Missing documentation for "getEntities". +// src/testUtils/InMemoryCatalogClient.d.ts:16:5 - (ae-undocumented) Missing documentation for "getEntitiesByRefs". +// src/testUtils/InMemoryCatalogClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "queryEntities". +// src/testUtils/InMemoryCatalogClient.d.ts:18:5 - (ae-undocumented) Missing documentation for "getEntityAncestors". +// src/testUtils/InMemoryCatalogClient.d.ts:19:5 - (ae-undocumented) Missing documentation for "getEntityByRef". +// src/testUtils/InMemoryCatalogClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "removeEntityByUid". +// src/testUtils/InMemoryCatalogClient.d.ts:21:5 - (ae-undocumented) Missing documentation for "refreshEntity". +// src/testUtils/InMemoryCatalogClient.d.ts:22:5 - (ae-undocumented) Missing documentation for "getEntityFacets". +// src/testUtils/InMemoryCatalogClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "getLocationById". +// src/testUtils/InMemoryCatalogClient.d.ts:24:5 - (ae-undocumented) Missing documentation for "getLocationByRef". +// src/testUtils/InMemoryCatalogClient.d.ts:25:5 - (ae-undocumented) Missing documentation for "addLocation". +// src/testUtils/InMemoryCatalogClient.d.ts:26:5 - (ae-undocumented) Missing documentation for "removeLocationById". +// src/testUtils/InMemoryCatalogClient.d.ts:27:5 - (ae-undocumented) Missing documentation for "getLocationByEntity". +// src/testUtils/InMemoryCatalogClient.d.ts:28:5 - (ae-undocumented) Missing documentation for "validateEntity". + +// (No @packageDocumentation comment for this package) +``` diff --git a/packages/frontend-defaults/report.api.md b/packages/frontend-defaults/report.api.md new file mode 100644 index 0000000000..4822312294 --- /dev/null +++ b/packages/frontend-defaults/report.api.md @@ -0,0 +1,49 @@ +## API Report File for "@backstage/frontend-defaults" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { ConfigApi } from '@backstage/frontend-plugin-api'; +import { CreateAppRouteBinder } from '@backstage/frontend-app-api'; +import { FrontendFeature } from '@backstage/frontend-app-api'; +import { JSX as JSX_2 } from 'react'; +import { default as React_2 } from 'react'; +import { ReactNode } from 'react'; + +// @public +export function createApp(options?: CreateAppOptions): { + createRoot(): JSX_2.Element; +}; + +// @public +export interface CreateAppFeatureLoader { + getLoaderName(): string; + load(options: { config: ConfigApi }): Promise<{ + features: FrontendFeature[]; + }>; +} + +// @public +export interface CreateAppOptions { + // (undocumented) + bindRoutes?(context: { bind: CreateAppRouteBinder }): void; + // (undocumented) + configLoader?: () => Promise<{ + config: ConfigApi; + }>; + // (undocumented) + features?: (FrontendFeature | CreateAppFeatureLoader)[]; + loadingComponent?: ReactNode; +} + +// @public +export function createPublicSignInApp(options?: CreateAppOptions): { + createRoot(): React_2.JSX.Element; +}; + +// Warnings were encountered during analysis: +// +// src/createApp.d.ts:29:5 - (ae-undocumented) Missing documentation for "features". +// src/createApp.d.ts:30:5 - (ae-undocumented) Missing documentation for "configLoader". +// src/createApp.d.ts:33:5 - (ae-undocumented) Missing documentation for "bindRoutes". +``` diff --git a/plugins/app/report.api.md b/plugins/app/report.api.md new file mode 100644 index 0000000000..1ff398a346 --- /dev/null +++ b/plugins/app/report.api.md @@ -0,0 +1,717 @@ +## API Report File for "@backstage/plugin-app" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +/// + +import { AnyApiFactory } from '@backstage/frontend-plugin-api'; +import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { AnyRouteRefParams } from '@backstage/frontend-plugin-api'; +import { AppTheme } from '@backstage/frontend-plugin-api'; +import { ComponentRef } from '@backstage/frontend-plugin-api'; +import { ComponentType } from 'react'; +import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; +import { ExtensionInput } from '@backstage/frontend-plugin-api'; +import { FrontendPlugin } from '@backstage/frontend-plugin-api'; +import { IconComponent } from '@backstage/core-plugin-api'; +import { IconComponent as IconComponent_2 } from '@backstage/frontend-plugin-api'; +import { JSX as JSX_2 } from 'react'; +import { ReactNode } from 'react'; +import { RouteRef } from '@backstage/frontend-plugin-api'; +import { SignInPageProps } from '@backstage/core-plugin-api'; +import { TranslationMessages } from '@backstage/frontend-plugin-api'; +import { TranslationResource } from '@backstage/frontend-plugin-api'; + +// @public (undocumented) +const appPlugin: FrontendPlugin< + {}, + {}, + { + app: ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: { + root: ExtensionInput< + ConfigurableExtensionDataRef, + { + singleton: true; + optional: false; + } + >; + }; + params: never; + kind: undefined; + name: undefined; + }>; + 'api:app/app-language': ExtensionDefinition<{ + kind: 'api'; + name: 'app-language'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'app/layout': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: { + nav: ExtensionInput< + ConfigurableExtensionDataRef, + { + singleton: true; + optional: false; + } + >; + content: ExtensionInput< + ConfigurableExtensionDataRef, + { + singleton: true; + optional: false; + } + >; + }; + params: never; + kind: undefined; + name: 'layout'; + }>; + 'app/nav': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: { + items: ExtensionInput< + ConfigurableExtensionDataRef< + { + title: string; + icon: IconComponent; + routeRef: RouteRef; + }, + 'core.nav-item.target', + {} + >, + { + singleton: false; + optional: false; + } + >; + logos: ExtensionInput< + ConfigurableExtensionDataRef< + { + logoIcon?: JSX.Element | undefined; + logoFull?: JSX.Element | undefined; + }, + 'core.nav-logo.logo-elements', + {} + >, + { + singleton: true; + optional: true; + } + >; + }; + params: never; + kind: undefined; + name: 'nav'; + }>; + 'app/root': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: { + router: ExtensionInput< + ConfigurableExtensionDataRef< + ComponentType<{ + children?: ReactNode; + }>, + 'app.router.wrapper', + {} + >, + { + singleton: true; + optional: true; + } + >; + signInPage: ExtensionInput< + ConfigurableExtensionDataRef< + ComponentType, + 'core.sign-in-page.component', + {} + >, + { + singleton: true; + optional: true; + } + >; + children: ExtensionInput< + ConfigurableExtensionDataRef, + { + singleton: true; + optional: false; + } + >; + elements: ExtensionInput< + ConfigurableExtensionDataRef, + { + singleton: false; + optional: false; + } + >; + wrappers: ExtensionInput< + ConfigurableExtensionDataRef< + ComponentType<{ + children?: ReactNode; + }>, + 'app.root.wrapper', + {} + >, + { + singleton: false; + optional: false; + } + >; + }; + params: never; + kind: undefined; + name: 'root'; + }>; + 'app/routes': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: { + routes: ExtensionInput< + | ConfigurableExtensionDataRef + | ConfigurableExtensionDataRef + | ConfigurableExtensionDataRef< + RouteRef, + 'core.routing.ref', + { + optional: true; + } + >, + { + singleton: false; + optional: false; + } + >; + }; + params: never; + kind: undefined; + name: 'routes'; + }>; + 'api:app/app-theme': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: { + themes: ExtensionInput< + ConfigurableExtensionDataRef, + { + singleton: false; + optional: false; + } + >; + }; + kind: 'api'; + name: 'app-theme'; + params: { + factory: AnyApiFactory; + }; + }>; + 'theme:app/light': ExtensionDefinition<{ + kind: 'theme'; + name: 'light'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef; + inputs: {}; + params: { + theme: AppTheme; + }; + }>; + 'theme:app/dark': ExtensionDefinition<{ + kind: 'theme'; + name: 'dark'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef; + inputs: {}; + params: { + theme: AppTheme; + }; + }>; + 'api:app/components': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: { + components: ExtensionInput< + ConfigurableExtensionDataRef< + { + ref: ComponentRef; + impl: ComponentType; + }, + 'core.component.component', + {} + >, + { + singleton: false; + optional: false; + } + >; + }; + kind: 'api'; + name: 'components'; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/icons': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: { + icons: ExtensionInput< + ConfigurableExtensionDataRef< + { + [x: string]: IconComponent_2; + }, + 'core.icons', + {} + >, + { + singleton: false; + optional: false; + } + >; + }; + kind: 'api'; + name: 'icons'; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/feature-flags': ExtensionDefinition<{ + kind: 'api'; + name: 'feature-flags'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/translations': ExtensionDefinition<{ + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: { + translations: ExtensionInput< + ConfigurableExtensionDataRef< + | TranslationResource + | TranslationMessages< + string, + { + [x: string]: string; + }, + boolean + >, + 'core.translation.translation', + {} + >, + { + singleton: false; + optional: false; + } + >; + }; + kind: 'api'; + name: 'translations'; + params: { + factory: AnyApiFactory; + }; + }>; + 'app-root-element:app/oauth-request-dialog': ExtensionDefinition<{ + kind: 'app-root-element'; + name: 'oauth-request-dialog'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: {}; + params: { + element: JSX.Element | (() => JSX.Element); + }; + }>; + 'app-root-element:app/alert-display': ExtensionDefinition<{ + config: { + transientTimeoutMs: number; + anchorOrigin: { + horizontal: 'center' | 'left' | 'right'; + vertical: 'top' | 'bottom'; + }; + }; + configInput: { + anchorOrigin?: + | { + horizontal?: 'center' | 'left' | 'right' | undefined; + vertical?: 'top' | 'bottom' | undefined; + } + | undefined; + transientTimeoutMs?: number | undefined; + }; + output: ConfigurableExtensionDataRef< + JSX_2.Element, + 'core.reactElement', + {} + >; + inputs: { + [x: string]: ExtensionInput< + AnyExtensionDataRef, + { + optional: boolean; + singleton: boolean; + } + >; + }; + kind: 'app-root-element'; + name: 'alert-display'; + params: { + element: JSX.Element | (() => JSX.Element); + }; + }>; + 'api:app/discovery': ExtensionDefinition<{ + kind: 'api'; + name: 'discovery'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/alert': ExtensionDefinition<{ + kind: 'api'; + name: 'alert'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/analytics': ExtensionDefinition<{ + kind: 'api'; + name: 'analytics'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/error': ExtensionDefinition<{ + kind: 'api'; + name: 'error'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/storage': ExtensionDefinition<{ + kind: 'api'; + name: 'storage'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/fetch': ExtensionDefinition<{ + kind: 'api'; + name: 'fetch'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/oauth-request': ExtensionDefinition<{ + kind: 'api'; + name: 'oauth-request'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/google-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'google-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/microsoft-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'microsoft-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/github-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'github-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/okta-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'okta-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/gitlab-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'gitlab-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/onelogin-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'onelogin-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/bitbucket-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'bitbucket-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/bitbucket-server-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'bitbucket-server-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/atlassian-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'atlassian-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/vmware-cloud-auth': ExtensionDefinition<{ + kind: 'api'; + name: 'vmware-cloud-auth'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + 'api:app/permission': ExtensionDefinition<{ + kind: 'api'; + name: 'permission'; + config: {}; + configInput: {}; + output: ConfigurableExtensionDataRef< + AnyApiFactory, + 'core.api.factory', + {} + >; + inputs: {}; + params: { + factory: AnyApiFactory; + }; + }>; + } +>; +export default appPlugin; + +// Warnings were encountered during analysis: +// +// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "appPlugin". + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/auth-backend-module-auth0-provider/report.api.md b/plugins/auth-backend-module-auth0-provider/report.api.md new file mode 100644 index 0000000000..2d1b9074b4 --- /dev/null +++ b/plugins/auth-backend-module-auth0-provider/report.api.md @@ -0,0 +1,30 @@ +## API Report File for "@backstage/plugin-auth-backend-module-auth0-provider" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; +import { OAuthAuthenticator } from '@backstage/plugin-auth-node'; +import { PassportOAuthAuthenticatorHelper } from '@backstage/plugin-auth-node'; +import { PassportProfile } from '@backstage/plugin-auth-node'; + +// @public (undocumented) +export const auth0Authenticator: OAuthAuthenticator< + { + helper: PassportOAuthAuthenticatorHelper; + audience: string | undefined; + connection: string | undefined; + connectionScope: string | undefined; + }, + PassportProfile +>; + +// @public (undocumented) +const authModuleAuth0Provider: BackendFeature; +export default authModuleAuth0Provider; + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "auth0Authenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAuth0Provider". +``` diff --git a/plugins/auth-backend-module-bitbucket-server-provider/report.api.md b/plugins/auth-backend-module-bitbucket-server-provider/report.api.md new file mode 100644 index 0000000000..371873027a --- /dev/null +++ b/plugins/auth-backend-module-bitbucket-server-provider/report.api.md @@ -0,0 +1,38 @@ +## API Report File for "@backstage/plugin-auth-backend-module-bitbucket-server-provider" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; +import { OAuthAuthenticator } from '@backstage/plugin-auth-node'; +import { OAuthAuthenticatorResult } from '@backstage/plugin-auth-node'; +import { PassportOAuthAuthenticatorHelper } from '@backstage/plugin-auth-node'; +import { PassportProfile } from '@backstage/plugin-auth-node'; +import { SignInResolverFactory } from '@backstage/plugin-auth-node'; + +// @public (undocumented) +const authModuleBitbucketServerProvider: BackendFeature; +export default authModuleBitbucketServerProvider; + +// @public (undocumented) +export const bitbucketServerAuthenticator: OAuthAuthenticator< + { + helper: PassportOAuthAuthenticatorHelper; + host: string; + }, + PassportProfile +>; + +// @public +export namespace bitbucketServerSignInResolvers { + const emailMatchingUserEntityProfileEmail: SignInResolverFactory< + OAuthAuthenticatorResult, + unknown + >; +} + +// Warnings were encountered during analysis: +// +// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "bitbucketServerAuthenticator". +// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleBitbucketServerProvider". +``` diff --git a/plugins/catalog-node/report-testUtils.api.md b/plugins/catalog-node/report-testUtils.api.md new file mode 100644 index 0000000000..c1dfb0bd7a --- /dev/null +++ b/plugins/catalog-node/report-testUtils.api.md @@ -0,0 +1,27 @@ +## API Report File for "@backstage/plugin-catalog-node" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { CatalogApi } from '@backstage/catalog-client'; +import { Entity } from '@backstage/catalog-model'; +import { ServiceFactory } from '@backstage/backend-plugin-api'; +import { ServiceMock } from '@backstage/backend-test-utils'; + +// @public +export function catalogServiceMock(options?: { + entities?: Entity[]; +}): CatalogApi; + +// @public +export namespace catalogServiceMock { + const factory: (options?: { + entities?: Entity[]; + }) => ServiceFactory; + const mock: ( + partialImpl?: Partial | undefined, + ) => ServiceMock; +} + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/techdocs-common/report.api.md b/plugins/techdocs-common/report.api.md new file mode 100644 index 0000000000..1b0ee6797a --- /dev/null +++ b/plugins/techdocs-common/report.api.md @@ -0,0 +1,16 @@ +## API Report File for "@backstage/plugin-techdocs-common" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +// @public (undocumented) +export const TECHDOCS_ANNOTATION = 'backstage.io/techdocs-ref'; + +// @public (undocumented) +export const TECHDOCS_EXTERNAL_ANNOTATION = 'backstage.io/techdocs-entity'; + +// Warnings were encountered during analysis: +// +// src/constants.d.ts:2:22 - (ae-undocumented) Missing documentation for "TECHDOCS_ANNOTATION". +// src/constants.d.ts:4:22 - (ae-undocumented) Missing documentation for "TECHDOCS_EXTERNAL_ANNOTATION". +``` From ded99df8286e82f20d8368d5faab891a1c3e9e27 Mon Sep 17 00:00:00 2001 From: secustor Date: Mon, 23 Sep 2024 15:28:45 +0200 Subject: [PATCH 12/13] fix docs link Signed-off-by: secustor --- docs/notifications/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/notifications/index.md b/docs/notifications/index.md index d4234b494e..ddbb156dac 100644 --- a/docs/notifications/index.md +++ b/docs/notifications/index.md @@ -196,7 +196,7 @@ notificationService.send({ }); ``` -Refer the [API documentation](https://github.com/backstage/backstage/blob/master/plugins/notifications-node/api-report.md) for further details. +Refer the [API documentation](https://github.com/backstage/backstage/blob/master/plugins/notifications-node/report.api.md) for further details. ### Signals From 567e344f3d7d124f94bca2c913c7cea9be2e2f04 Mon Sep 17 00:00:00 2001 From: secustor Date: Mon, 23 Sep 2024 18:04:17 +0200 Subject: [PATCH 13/13] update api reports Signed-off-by: secustor --- plugins/events-node/report.api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/events-node/report.api.md b/plugins/events-node/report.api.md index ceeb21de53..2c06f50d56 100644 --- a/plugins/events-node/report.api.md +++ b/plugins/events-node/report.api.md @@ -143,8 +143,8 @@ export abstract class SubTopicEventRouter extends EventRouter { // Warnings were encountered during analysis: // // src/api/DefaultEventsService.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". -// src/api/DefaultEventsService.d.ts:26:5 - (ae-undocumented) Missing documentation for "publish". -// src/api/DefaultEventsService.d.ts:27:5 - (ae-undocumented) Missing documentation for "subscribe". +// src/api/DefaultEventsService.d.ts:31:5 - (ae-undocumented) Missing documentation for "publish". +// src/api/DefaultEventsService.d.ts:32:5 - (ae-undocumented) Missing documentation for "subscribe". // src/api/EventParams.d.ts:4:1 - (ae-undocumented) Missing documentation for "EventParams". // src/api/EventPublisher.d.ts:15:5 - (ae-undocumented) Missing documentation for "setEventBroker". // src/api/EventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "getSubscriberId".