@axis-backstage/plugin-statuspage-backend 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/package.json +1 -1
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/service/api.ts","../src/config.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["import fetch from 'cross-fetch';\nimport type {\n Component,\n ComponentGroup,\n} from '@axis-backstage/plugin-statuspage-common';\nimport { StatuspageConfig } from '../types';\n\nconst BASE_URL = 'https://api.statuspage.io/v1/pages/';\n\nconst getInstance = (config: StatuspageConfig, name: string) => {\n const instance = config.find(i => i.name === name);\n\n if (!instance) {\n throw new Error(\n `Config for instance '${name}' not found in statuspage.instances`,\n );\n }\n\n return instance;\n};\n\nconst fetchData = async <T>(url: string, token: string): Promise<T> => {\n const response = await fetch(url, {\n headers: {\n Authorization: `OAuth ${token}`,\n Accept: 'application/json',\n },\n });\n\n if (!response.ok) {\n throw new Error(`Failed to fetch status page data from ${url}`);\n }\n\n return response.json() as T;\n};\n\nexport const fetchComponents = async (\n name: string,\n config: StatuspageConfig,\n): Promise<Component[]> => {\n const instance = getInstance(config, name);\n const url = `${BASE_URL}${instance.pageid}/components`;\n return fetchData<Component[]>(url, instance.token);\n};\n\nexport const fetchComponentGroups = async (\n name: string,\n config: StatuspageConfig,\n): Promise<ComponentGroup[]> => {\n const instance = getInstance(config, name);\n const url = `${BASE_URL}${instance.pageid}/component-groups`;\n return fetchData(url, instance.token);\n};\n\nexport const getLink = (\n name: string,\n config: StatuspageConfig,\n): string | undefined => {\n const instance = getInstance(config, name);\n return instance.link;\n};\n","import { Config } from '@backstage/config';\nimport type { StatuspageConfig } from './types';\n\nexport function getStatuspageConfig(config: Config): StatuspageConfig {\n const statuspageConfig = config.getOptional('statuspage');\n if (!statuspageConfig) {\n return [];\n }\n return statuspageConfig as unknown as StatuspageConfig;\n}\n","import { CacheManager, errorHandler } from '@backstage/backend-common';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { fetchComponentGroups, fetchComponents, getLink } from './api';\nimport { Config } from '@backstage/config';\nimport { getStatuspageConfig } from '../config';\n\n/**\n * Router options.\n *\n * @public\n */\nexport interface RouterOptions {\n /** The logger instance */\n logger: LoggerService;\n /** Backstage config object */\n config: Config;\n}\n\nconst COMPONENT_GROUPS_KEY = 'component-groups';\nconst COMPONENTS_KEY = 'components';\n\n/**\n * Create the router.\n *\n * @public\n */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, config } = options;\n logger.info('Setting up router for statuspage-backend');\n const pluginCache = CacheManager.fromConfig(config).forPlugin('statuspage');\n const statuspageConfig = getStatuspageConfig(config);\n const cache = pluginCache.getClient({ defaultTtl: 1000 * 60 * 2 });\n\n const router = Router();\n router.use(express.json());\n\n router.get('/fetch-components/:name', async (request, response) => {\n const name = request.params.name;\n let components = (await cache.get(`${COMPONENTS_KEY}-${name}`)) as any;\n if (!components) {\n components = await fetchComponents(name, statuspageConfig);\n await cache.set(`${COMPONENTS_KEY}-${name}`, components);\n }\n response.json(components);\n });\n\n router.get('/fetch-component-groups/:name', async (request, response) => {\n const name = request.params.name;\n let componentGroups = (await cache.get(\n `${COMPONENT_GROUPS_KEY}-${name}`,\n )) as any;\n if (!componentGroups) {\n componentGroups = await fetchComponentGroups(name, statuspageConfig);\n await cache.set(`${COMPONENT_GROUPS_KEY}-${name}`, componentGroups);\n }\n response.json(componentGroups);\n });\n\n router.get('/fetch-link/:name', (request, response) => {\n const name = request.params.name;\n response.json({ url: getLink(name, statuspageConfig) || '' });\n });\n\n router.use(errorHandler());\n return router;\n}\n","import {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * Entrypoint for our plugin.\n *\n * @public\n */\nexport const statuspagePlugin = createBackendPlugin({\n pluginId: 'statuspage',\n register(env) {\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n httpRouter: coreServices.httpRouter,\n },\n async init({ config, logger, httpRouter }) {\n httpRouter.use(\n await createRouter({\n config,\n logger,\n }),\n );\n },\n });\n },\n});\n"],"names":["fetch","CacheManager","Router","express","errorHandler","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;AAOA,MAAM,QAAW,GAAA,qCAAA,CAAA;AAEjB,MAAM,WAAA,GAAc,CAAC,MAAA,EAA0B,IAAiB,KAAA;AAC9D,EAAA,MAAM,WAAW,MAAO,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAAS,IAAI,CAAA,CAAA;AAEjD,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,wBAAwB,IAAI,CAAA,mCAAA,CAAA;AAAA,KAC9B,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA,CAAA;AAEA,MAAM,SAAA,GAAY,OAAU,GAAA,EAAa,KAA8B,KAAA;AACrE,EAAM,MAAA,QAAA,GAAW,MAAMA,sBAAA,CAAM,GAAK,EAAA;AAAA,IAChC,OAAS,EAAA;AAAA,MACP,aAAA,EAAe,SAAS,KAAK,CAAA,CAAA;AAAA,MAC7B,MAAQ,EAAA,kBAAA;AAAA,KACV;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAyC,sCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAChE;AAEA,EAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AACvB,CAAA,CAAA;AAEa,MAAA,eAAA,GAAkB,OAC7B,IAAA,EACA,MACyB,KAAA;AACzB,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAQ,CAAA,EAAG,SAAS,MAAM,CAAA,WAAA,CAAA,CAAA;AACzC,EAAO,OAAA,SAAA,CAAuB,GAAK,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACnD,CAAA,CAAA;AAEa,MAAA,oBAAA,GAAuB,OAClC,IAAA,EACA,MAC8B,KAAA;AAC9B,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAQ,CAAA,EAAG,SAAS,MAAM,CAAA,iBAAA,CAAA,CAAA;AACzC,EAAO,OAAA,SAAA,CAAU,GAAK,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,CAAA,CAAA;AAEa,MAAA,OAAA,GAAU,CACrB,IAAA,EACA,MACuB,KAAA;AACvB,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,OAAO,QAAS,CAAA,IAAA,CAAA;AAClB,CAAA;;ACzDO,SAAS,oBAAoB,MAAkC,EAAA;AACpE,EAAM,MAAA,gBAAA,GAAmB,MAAO,CAAA,WAAA,CAAY,YAAY,CAAA,CAAA;AACxD,EAAA,IAAI,CAAC,gBAAkB,EAAA;AACrB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AACA,EAAO,OAAA,gBAAA,CAAA;AACT;;
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/service/api.ts","../src/config.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["import fetch from 'cross-fetch';\nimport type {\n Component,\n ComponentGroup,\n} from '@axis-backstage/plugin-statuspage-common';\nimport { StatuspageConfig } from '../types';\n\nconst BASE_URL = 'https://api.statuspage.io/v1/pages/';\n\nconst getInstance = (config: StatuspageConfig, name: string) => {\n const instance = config.find(i => i.name === name);\n\n if (!instance) {\n throw new Error(\n `Config for instance '${name}' not found in statuspage.instances`,\n );\n }\n\n return instance;\n};\n\nconst fetchData = async <T>(url: string, token: string): Promise<T> => {\n const response = await fetch(url, {\n headers: {\n Authorization: `OAuth ${token}`,\n Accept: 'application/json',\n },\n });\n\n if (!response.ok) {\n throw new Error(`Failed to fetch status page data from ${url}`);\n }\n\n return response.json() as T;\n};\n\nexport const fetchComponents = async (\n name: string,\n config: StatuspageConfig,\n): Promise<Component[]> => {\n const instance = getInstance(config, name);\n const url = `${BASE_URL}${instance.pageid}/components`;\n return fetchData<Component[]>(url, instance.token);\n};\n\nexport const fetchComponentGroups = async (\n name: string,\n config: StatuspageConfig,\n): Promise<ComponentGroup[]> => {\n const instance = getInstance(config, name);\n const url = `${BASE_URL}${instance.pageid}/component-groups`;\n return fetchData(url, instance.token);\n};\n\nexport const getLink = (\n name: string,\n config: StatuspageConfig,\n): string | undefined => {\n const instance = getInstance(config, name);\n return instance.link;\n};\n","import { Config } from '@backstage/config';\nimport type { StatuspageConfig } from './types';\n\nexport function getStatuspageConfig(config: Config): StatuspageConfig {\n const statuspageConfig = config.getOptional('statuspage');\n if (!statuspageConfig) {\n return [];\n }\n return statuspageConfig as unknown as StatuspageConfig;\n}\n","import { CacheManager, errorHandler } from '@backstage/backend-common';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { fetchComponentGroups, fetchComponents, getLink } from './api';\nimport { Config } from '@backstage/config';\nimport { getStatuspageConfig } from '../config';\n\n/**\n * Router options.\n *\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n * @public\n */\nexport interface RouterOptions {\n /** The logger instance */\n logger: LoggerService;\n /** Backstage config object */\n config: Config;\n}\n\nconst COMPONENT_GROUPS_KEY = 'component-groups';\nconst COMPONENTS_KEY = 'components';\n\n/**\n * Create the router.\n *\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n * @public\n */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, config } = options;\n logger.info('Setting up router for statuspage-backend');\n const pluginCache = CacheManager.fromConfig(config).forPlugin('statuspage');\n const statuspageConfig = getStatuspageConfig(config);\n const cache = pluginCache.getClient({ defaultTtl: 1000 * 60 * 2 });\n\n const router = Router();\n router.use(express.json());\n\n router.get('/fetch-components/:name', async (request, response) => {\n const name = request.params.name;\n let components = (await cache.get(`${COMPONENTS_KEY}-${name}`)) as any;\n if (!components) {\n components = await fetchComponents(name, statuspageConfig);\n await cache.set(`${COMPONENTS_KEY}-${name}`, components);\n }\n response.json(components);\n });\n\n router.get('/fetch-component-groups/:name', async (request, response) => {\n const name = request.params.name;\n let componentGroups = (await cache.get(\n `${COMPONENT_GROUPS_KEY}-${name}`,\n )) as any;\n if (!componentGroups) {\n componentGroups = await fetchComponentGroups(name, statuspageConfig);\n await cache.set(`${COMPONENT_GROUPS_KEY}-${name}`, componentGroups);\n }\n response.json(componentGroups);\n });\n\n router.get('/fetch-link/:name', (request, response) => {\n const name = request.params.name;\n response.json({ url: getLink(name, statuspageConfig) || '' });\n });\n\n router.use(errorHandler());\n return router;\n}\n","import {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * Entrypoint for our plugin.\n *\n * @public\n */\nexport const statuspagePlugin = createBackendPlugin({\n pluginId: 'statuspage',\n register(env) {\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n httpRouter: coreServices.httpRouter,\n },\n async init({ config, logger, httpRouter }) {\n httpRouter.use(\n await createRouter({\n config,\n logger,\n }),\n );\n },\n });\n },\n});\n"],"names":["fetch","CacheManager","Router","express","errorHandler","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;AAOA,MAAM,QAAW,GAAA,qCAAA,CAAA;AAEjB,MAAM,WAAA,GAAc,CAAC,MAAA,EAA0B,IAAiB,KAAA;AAC9D,EAAA,MAAM,WAAW,MAAO,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAAS,IAAI,CAAA,CAAA;AAEjD,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,wBAAwB,IAAI,CAAA,mCAAA,CAAA;AAAA,KAC9B,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA,CAAA;AAEA,MAAM,SAAA,GAAY,OAAU,GAAA,EAAa,KAA8B,KAAA;AACrE,EAAM,MAAA,QAAA,GAAW,MAAMA,sBAAA,CAAM,GAAK,EAAA;AAAA,IAChC,OAAS,EAAA;AAAA,MACP,aAAA,EAAe,SAAS,KAAK,CAAA,CAAA;AAAA,MAC7B,MAAQ,EAAA,kBAAA;AAAA,KACV;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAyC,sCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAChE;AAEA,EAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AACvB,CAAA,CAAA;AAEa,MAAA,eAAA,GAAkB,OAC7B,IAAA,EACA,MACyB,KAAA;AACzB,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAQ,CAAA,EAAG,SAAS,MAAM,CAAA,WAAA,CAAA,CAAA;AACzC,EAAO,OAAA,SAAA,CAAuB,GAAK,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACnD,CAAA,CAAA;AAEa,MAAA,oBAAA,GAAuB,OAClC,IAAA,EACA,MAC8B,KAAA;AAC9B,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAQ,CAAA,EAAG,SAAS,MAAM,CAAA,iBAAA,CAAA,CAAA;AACzC,EAAO,OAAA,SAAA,CAAU,GAAK,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,CAAA,CAAA;AAEa,MAAA,OAAA,GAAU,CACrB,IAAA,EACA,MACuB,KAAA;AACvB,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,OAAO,QAAS,CAAA,IAAA,CAAA;AAClB,CAAA;;ACzDO,SAAS,oBAAoB,MAAkC,EAAA;AACpE,EAAM,MAAA,gBAAA,GAAmB,MAAO,CAAA,WAAA,CAAY,YAAY,CAAA,CAAA;AACxD,EAAA,IAAI,CAAC,gBAAkB,EAAA;AACrB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AACA,EAAO,OAAA,gBAAA,CAAA;AACT;;ACYA,MAAM,oBAAuB,GAAA,kBAAA,CAAA;AAC7B,MAAM,cAAiB,GAAA,YAAA,CAAA;AAQvB,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,EAAE,MAAQ,EAAA,MAAA,EAAW,GAAA,OAAA,CAAA;AAC3B,EAAA,MAAA,CAAO,KAAK,0CAA0C,CAAA,CAAA;AACtD,EAAA,MAAM,cAAcC,0BAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,YAAY,CAAA,CAAA;AAC1E,EAAM,MAAA,gBAAA,GAAmB,oBAAoB,MAAM,CAAA,CAAA;AACnD,EAAM,MAAA,KAAA,GAAQ,YAAY,SAAU,CAAA,EAAE,YAAY,GAAO,GAAA,EAAA,GAAK,GAAG,CAAA,CAAA;AAEjE,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,EAAA,MAAA,CAAO,GAAI,CAAA,yBAAA,EAA2B,OAAO,OAAA,EAAS,QAAa,KAAA;AACjE,IAAM,MAAA,IAAA,GAAO,QAAQ,MAAO,CAAA,IAAA,CAAA;AAC5B,IAAI,IAAA,UAAA,GAAc,MAAM,KAAM,CAAA,GAAA,CAAI,GAAG,cAAc,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAC7D,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAa,UAAA,GAAA,MAAM,eAAgB,CAAA,IAAA,EAAM,gBAAgB,CAAA,CAAA;AACzD,MAAA,MAAM,MAAM,GAAI,CAAA,CAAA,EAAG,cAAc,CAAI,CAAA,EAAA,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,KACzD;AACA,IAAA,QAAA,CAAS,KAAK,UAAU,CAAA,CAAA;AAAA,GACzB,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,+BAAA,EAAiC,OAAO,OAAA,EAAS,QAAa,KAAA;AACvE,IAAM,MAAA,IAAA,GAAO,QAAQ,MAAO,CAAA,IAAA,CAAA;AAC5B,IAAI,IAAA,eAAA,GAAmB,MAAM,KAAM,CAAA,GAAA;AAAA,MACjC,CAAA,EAAG,oBAAoB,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,KACjC,CAAA;AACA,IAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,MAAkB,eAAA,GAAA,MAAM,oBAAqB,CAAA,IAAA,EAAM,gBAAgB,CAAA,CAAA;AACnE,MAAA,MAAM,MAAM,GAAI,CAAA,CAAA,EAAG,oBAAoB,CAAI,CAAA,EAAA,IAAI,IAAI,eAAe,CAAA,CAAA;AAAA,KACpE;AACA,IAAA,QAAA,CAAS,KAAK,eAAe,CAAA,CAAA;AAAA,GAC9B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,mBAAA,EAAqB,CAAC,OAAA,EAAS,QAAa,KAAA;AACrD,IAAM,MAAA,IAAA,GAAO,QAAQ,MAAO,CAAA,IAAA,CAAA;AAC5B,IAAS,QAAA,CAAA,IAAA,CAAK,EAAE,GAAK,EAAA,OAAA,CAAQ,MAAM,gBAAgB,CAAA,IAAK,IAAI,CAAA,CAAA;AAAA,GAC7D,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;AC5DO,MAAM,mBAAmBC,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,YAAc,EAAA;AACzC,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ import { Config } from '@backstage/config';
|
|
|
6
6
|
/**
|
|
7
7
|
* Router options.
|
|
8
8
|
*
|
|
9
|
+
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
9
10
|
* @public
|
|
10
11
|
*/
|
|
11
12
|
interface RouterOptions {
|
|
@@ -17,6 +18,7 @@ interface RouterOptions {
|
|
|
17
18
|
/**
|
|
18
19
|
* Create the router.
|
|
19
20
|
*
|
|
21
|
+
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
20
22
|
* @public
|
|
21
23
|
*/
|
|
22
24
|
declare function createRouter(options: RouterOptions): Promise<express.Router>;
|