From e5f1efcd96b4d12c30e56f6d5d4fc4557528aa56 Mon Sep 17 00:00:00 2001 From: Karan Shah Date: Thu, 10 Feb 2022 11:13:33 +0000 Subject: [PATCH] Duplicating the Airbrake config section instead of reusing. It looks very tough to get it to work. Signed-off-by: Karan Shah --- plugins/airbrake-backend/api-report.md | 4 ++-- .../airbrake-backend/{src/config => }/config.d.ts | 0 plugins/airbrake-backend/package.json | 4 ++-- .../src/config/ExtractAirbrakeConfig.ts | 13 ++++++++++++- plugins/airbrake-backend/src/config/index.ts | 4 +--- 5 files changed, 17 insertions(+), 8 deletions(-) rename plugins/airbrake-backend/{src/config => }/config.d.ts (100%) diff --git a/plugins/airbrake-backend/api-report.md b/plugins/airbrake-backend/api-report.md index c888d55e5b..b9e9a50e0b 100644 --- a/plugins/airbrake-backend/api-report.md +++ b/plugins/airbrake-backend/api-report.md @@ -8,9 +8,9 @@ import express from 'express'; import { Logger as Logger_2 } from 'winston'; // @public -export type AirbrakeConfig = { +export interface AirbrakeConfig { apiKey: string; -}; +} // @public export function createRouter(options: RouterOptions): Promise; diff --git a/plugins/airbrake-backend/src/config/config.d.ts b/plugins/airbrake-backend/config.d.ts similarity index 100% rename from plugins/airbrake-backend/src/config/config.d.ts rename to plugins/airbrake-backend/config.d.ts diff --git a/plugins/airbrake-backend/package.json b/plugins/airbrake-backend/package.json index fb9bca210f..da025b117c 100644 --- a/plugins/airbrake-backend/package.json +++ b/plugins/airbrake-backend/package.json @@ -39,9 +39,9 @@ }, "files": [ "dist", - "src/config/config.d.ts" + "config.d.ts" ], - "configSchema": "src/config/config.d.ts", + "configSchema": "config.d.ts", "jest": { "coverageThreshold": { "global": { diff --git a/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts b/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts index 6fc2c5e04c..ea39a27d11 100644 --- a/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts +++ b/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts @@ -14,7 +14,18 @@ * limitations under the License. */ import { Config } from '@backstage/config'; -import { AirbrakeConfig } from '.'; + +/** + * The configuration needed for the airbrake-backend plugin + * + * @public + */ +export interface AirbrakeConfig { + /** + * The API Key to authenticate requests. More details on how to get this here: https://airbrake.io/docs/api/#authentication + */ + apiKey: string; +} /** * Extract the Airbrake config from a config object diff --git a/plugins/airbrake-backend/src/config/index.ts b/plugins/airbrake-backend/src/config/index.ts index 7cad13e15e..60d60c2761 100644 --- a/plugins/airbrake-backend/src/config/index.ts +++ b/plugins/airbrake-backend/src/config/index.ts @@ -13,7 +13,5 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { Config } from './config'; -export { extractAirbrakeConfig } from './ExtractAirbrakeConfig'; -export type AirbrakeConfig = Config['airbrake']; +export * from './ExtractAirbrakeConfig';