@backstage-community/plugin-quay-backend 1.0.0

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/CHANGELOG.md ADDED
@@ -0,0 +1,13 @@
1
+ # @backstage-community/plugin-quay-backend
2
+
3
+ ## 1.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - 6f747d0: release quay-backend plugin
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [e541edd]
12
+ - Updated dependencies [e541edd]
13
+ - @backstage-community/plugin-quay-common@1.6.0
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # Quay Plugin (Backend)
2
+
3
+ A simple plugin that queries the quay.io api, but provides additional features like:
4
+
5
+ - setting permissions
6
+ - using OAuth2 access tokens for authentication
7
+
8
+ ## Setup
9
+
10
+ ### Installation
11
+
12
+ This plugin is available via `@backstage-community/plugin-quay-backend`. To install it to your backend package, run the following command:
13
+
14
+ ```bash
15
+ # From your root directory
16
+ yarn --cwd packages/backend add @backstage-community/plugin-quay-backend
17
+ ```
18
+
19
+ Then add the plugin to your backend in `packages/backend/src/index.ts`:
20
+
21
+ ```ts
22
+ const backend = createBackend();
23
+ // ...
24
+ backend.add(import('@backstage-community/plugin-quay-backend'));
25
+ ```
26
+
27
+ ### App Config
28
+
29
+ Define the following in `app-config.yaml`:
30
+
31
+ ```yaml
32
+ quay:
33
+ uiUrl: 'https://quay.io'
34
+ apiUrl: 'https://quay.io'
35
+ apiKey: 'abc123'
36
+ ```
37
+
38
+ If you require access to a private repository in a Quay organization, set the `apiKey` value to your Application's OAuth 2 access token.
39
+
40
+ For more information on OAuth access tokens in Quay, please see [the official documentation](https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token).
41
+
42
+ **Note**: Robot tokens will not work for the `apiKey` value.
43
+
44
+ ### Catalog
45
+
46
+ Add the annotation `quay.io/repository-slug` to your entity
47
+
48
+ ```yaml
49
+ metadata:
50
+ annotations:
51
+ quay.io/repository-slug: '<organization>/<repository>`
52
+ ```
53
+
54
+ ## Development
55
+
56
+ This plugin backend can be started in a standalone mode from directly in this
57
+ package with `yarn start`. It is a limited setup that is most convenient when
58
+ developing the plugin backend itself.
59
+
60
+ If you want to run the entire project, including the frontend, run `yarn dev` from the root directory.
@@ -0,0 +1,10 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var plugin = require('./plugin.cjs.js');
6
+
7
+
8
+
9
+ exports.default = plugin.quayPlugin;
10
+ //# sourceMappingURL=index.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}
@@ -0,0 +1,10 @@
1
+ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
2
+
3
+ /**
4
+ * Quay backend plugin
5
+ *
6
+ * @public
7
+ */
8
+ declare const quayPlugin: _backstage_backend_plugin_api.BackendFeature;
9
+
10
+ export { quayPlugin as default };
@@ -0,0 +1,32 @@
1
+ 'use strict';
2
+
3
+ var backendPluginApi = require('@backstage/backend-plugin-api');
4
+ var router = require('./services/router.cjs.js');
5
+
6
+ const quayPlugin = backendPluginApi.createBackendPlugin({
7
+ pluginId: "quay",
8
+ register(env) {
9
+ env.registerInit({
10
+ deps: {
11
+ config: backendPluginApi.coreServices.rootConfig,
12
+ logger: backendPluginApi.coreServices.logger,
13
+ permissions: backendPluginApi.coreServices.permissions,
14
+ httpRouter: backendPluginApi.coreServices.httpRouter,
15
+ httpAuth: backendPluginApi.coreServices.httpAuth
16
+ },
17
+ async init({ config, logger, permissions, httpAuth, httpRouter }) {
18
+ httpRouter.use(
19
+ await router.createRouter({
20
+ logger,
21
+ config,
22
+ permissions,
23
+ httpAuth
24
+ })
25
+ );
26
+ }
27
+ });
28
+ }
29
+ });
30
+
31
+ exports.quayPlugin = quayPlugin;
32
+ //# sourceMappingURL=plugin.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\n\nimport { createRouter } from './services/router';\n\n/**\n * Quay backend plugin\n *\n * @public\n */\nexport const quayPlugin = createBackendPlugin({\n pluginId: 'quay',\n register(env) {\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n permissions: coreServices.permissions,\n httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n },\n async init({ config, logger, permissions, httpAuth, httpRouter }) {\n httpRouter.use(\n await createRouter({\n logger,\n config,\n permissions,\n httpAuth,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter"],"mappings":";;;;;AA2BO,MAAM,aAAaA,oCAAoB,CAAA;AAAA,EAC5C,QAAU,EAAA,MAAA;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,aAAaA,6BAAa,CAAA,WAAA;AAAA,QAC1B,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA;AAAA,OACzB;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,QAAQ,WAAa,EAAA,QAAA,EAAU,YAAc,EAAA;AAChE,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,WAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
@@ -0,0 +1,65 @@
1
+ 'use strict';
2
+
3
+ class QuayService {
4
+ apiUrl;
5
+ token;
6
+ logger;
7
+ constructor(config, logger) {
8
+ this.apiUrl = config.getString("quay.apiUrl");
9
+ this.token = config.getOptionalString("quay.apiKey");
10
+ this.logger = logger;
11
+ }
12
+ static fromConfig(config, logger) {
13
+ return new QuayService(config, logger);
14
+ }
15
+ async fetchFromQuay(endpoint) {
16
+ const url = `${this.apiUrl}${endpoint}`;
17
+ try {
18
+ const response = await fetch(url, {
19
+ headers: {
20
+ "Content-Type": "application/json",
21
+ ...this.token ? { Authorization: `Bearer ${this.token}` } : {}
22
+ }
23
+ });
24
+ if (!response.ok) {
25
+ this.logger.error(
26
+ `Quay Service request failed: ${response.statusText}`
27
+ );
28
+ throw new Error(`Failed to fetch data: ${response.statusText}`);
29
+ }
30
+ return await response.json();
31
+ } catch (error) {
32
+ throw new Error(`Quay Service request failed: ${error}`);
33
+ }
34
+ }
35
+ async getTags(org, repo, page, limit, specificTag) {
36
+ const params = new URLSearchParams();
37
+ if (page !== undefined) params.append("page", page.toString());
38
+ if (limit !== undefined) params.append("limit", limit.toString());
39
+ if (specificTag !== undefined) params.append("specificTag", specificTag);
40
+ params.append("onlyActiveTags", "true");
41
+ return this.fetchFromQuay(
42
+ `/api/v1/repository/${org}/${repo}/tag?${params.toString()}`
43
+ );
44
+ }
45
+ async getLabels(org, repo, digest) {
46
+ return this.fetchFromQuay(
47
+ `/api/v1/repository/${org}/${repo}/manifest/${digest}/labels`
48
+ );
49
+ }
50
+ async getManifestByDigest(org, repo, digest) {
51
+ return this.fetchFromQuay(
52
+ `/api/v1/repository/${org}/${repo}/manifest/${digest}`
53
+ );
54
+ }
55
+ async getSecurityDetails(org, repo, digest) {
56
+ const params = new URLSearchParams();
57
+ params.append("vulnerabilities", "true");
58
+ return this.fetchFromQuay(
59
+ `/api/v1/repository/${org}/${repo}/manifest/${digest}/security?${params}`
60
+ );
61
+ }
62
+ }
63
+
64
+ exports.QuayService = QuayService;
65
+ //# sourceMappingURL=QuayService.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"QuayService.cjs.js","sources":["../../src/services/QuayService.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\n\nimport {\n LabelsResponse,\n ManifestByDigestResponse,\n SecurityDetailsResponse,\n TagsResponse,\n} from '../types';\n\nexport interface QuayService {\n getTags(\n org: string,\n repo: string,\n page?: number,\n limit?: number,\n ): Promise<TagsResponse>;\n getLabels(org: string, repo: string, digest: string): Promise<LabelsResponse>;\n getManifestByDigest(\n org: string,\n repo: string,\n digest: string,\n ): Promise<ManifestByDigestResponse>;\n getSecurityDetails(\n org: string,\n repo: string,\n digest: string,\n ): Promise<SecurityDetailsResponse>;\n}\n\nexport class QuayService {\n private readonly apiUrl: string;\n private readonly token?: string;\n private readonly logger: LoggerService;\n\n constructor(config: Config, logger: LoggerService) {\n this.apiUrl = config.getString('quay.apiUrl');\n this.token = config.getOptionalString('quay.apiKey');\n this.logger = logger;\n }\n\n static fromConfig(config: Config, logger: LoggerService): QuayService {\n return new QuayService(config, logger);\n }\n\n private async fetchFromQuay(endpoint: string): Promise<any> {\n const url = `${this.apiUrl}${endpoint}`;\n\n try {\n const response = await fetch(url, {\n headers: {\n 'Content-Type': 'application/json',\n ...(this.token ? { Authorization: `Bearer ${this.token}` } : {}),\n },\n });\n\n if (!response.ok) {\n this.logger.error(\n `Quay Service request failed: ${response.statusText}`,\n );\n throw new Error(`Failed to fetch data: ${response.statusText}`);\n }\n\n return await response.json();\n } catch (error) {\n throw new Error(`Quay Service request failed: ${error}`);\n }\n }\n\n async getTags(\n org: string,\n repo: string,\n page?: number,\n limit?: number,\n specificTag?: string,\n ) {\n const params = new URLSearchParams();\n if (page !== undefined) params.append('page', page.toString());\n if (limit !== undefined) params.append('limit', limit.toString());\n if (specificTag !== undefined) params.append('specificTag', specificTag);\n\n // We only want active tags\n params.append('onlyActiveTags', 'true');\n\n return this.fetchFromQuay(\n `/api/v1/repository/${org}/${repo}/tag?${params.toString()}`,\n ) as Promise<TagsResponse>;\n }\n\n async getLabels(org: string, repo: string, digest: string) {\n return this.fetchFromQuay(\n `/api/v1/repository/${org}/${repo}/manifest/${digest}/labels`,\n ) as Promise<LabelsResponse>;\n }\n\n async getManifestByDigest(org: string, repo: string, digest: string) {\n return this.fetchFromQuay(\n `/api/v1/repository/${org}/${repo}/manifest/${digest}`,\n ) as Promise<ManifestByDigestResponse>;\n }\n\n async getSecurityDetails(org: string, repo: string, digest: string) {\n const params = new URLSearchParams();\n params.append('vulnerabilities', 'true');\n\n return this.fetchFromQuay(\n `/api/v1/repository/${org}/${repo}/manifest/${digest}/security?${params}`,\n ) as Promise<SecurityDetailsResponse>;\n }\n}\n"],"names":[],"mappings":";;AA6CO,MAAM,WAAY,CAAA;AAAA,EACN,MAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EAEjB,WAAA,CAAY,QAAgB,MAAuB,EAAA;AACjD,IAAK,IAAA,CAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,aAAa,CAAA;AAC5C,IAAK,IAAA,CAAA,KAAA,GAAQ,MAAO,CAAA,iBAAA,CAAkB,aAAa,CAAA;AACnD,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AAAA;AAChB,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,MAAoC,EAAA;AACpE,IAAO,OAAA,IAAI,WAAY,CAAA,MAAA,EAAQ,MAAM,CAAA;AAAA;AACvC,EAEA,MAAc,cAAc,QAAgC,EAAA;AAC1D,IAAA,MAAM,GAAM,GAAA,CAAA,EAAG,IAAK,CAAA,MAAM,GAAG,QAAQ,CAAA,CAAA;AAErC,IAAI,IAAA;AACF,MAAM,MAAA,QAAA,GAAW,MAAM,KAAA,CAAM,GAAK,EAAA;AAAA,QAChC,OAAS,EAAA;AAAA,UACP,cAAgB,EAAA,kBAAA;AAAA,UAChB,GAAI,IAAK,CAAA,KAAA,GAAQ,EAAE,aAAA,EAAe,UAAU,IAAK,CAAA,KAAK,CAAG,CAAA,EAAA,GAAI;AAAC;AAChE,OACD,CAAA;AAED,MAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,6BAAA,EAAgC,SAAS,UAAU,CAAA;AAAA,SACrD;AACA,QAAA,MAAM,IAAI,KAAA,CAAM,CAAyB,sBAAA,EAAA,QAAA,CAAS,UAAU,CAAE,CAAA,CAAA;AAAA;AAGhE,MAAO,OAAA,MAAM,SAAS,IAAK,EAAA;AAAA,aACpB,KAAO,EAAA;AACd,MAAA,MAAM,IAAI,KAAA,CAAM,CAAgC,6BAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA;AACzD;AACF,EAEA,MAAM,OACJ,CAAA,GAAA,EACA,IACA,EAAA,IAAA,EACA,OACA,WACA,EAAA;AACA,IAAM,MAAA,MAAA,GAAS,IAAI,eAAgB,EAAA;AACnC,IAAA,IAAI,SAAS,SAAW,EAAA,MAAA,CAAO,OAAO,MAAQ,EAAA,IAAA,CAAK,UAAU,CAAA;AAC7D,IAAA,IAAI,UAAU,SAAW,EAAA,MAAA,CAAO,OAAO,OAAS,EAAA,KAAA,CAAM,UAAU,CAAA;AAChE,IAAA,IAAI,WAAgB,KAAA,SAAA,EAAkB,MAAA,CAAA,MAAA,CAAO,eAAe,WAAW,CAAA;AAGvE,IAAO,MAAA,CAAA,MAAA,CAAO,kBAAkB,MAAM,CAAA;AAEtC,IAAA,OAAO,IAAK,CAAA,aAAA;AAAA,MACV,sBAAsB,GAAG,CAAA,CAAA,EAAI,IAAI,CAAQ,KAAA,EAAA,MAAA,CAAO,UAAU,CAAA;AAAA,KAC5D;AAAA;AACF,EAEA,MAAM,SAAA,CAAU,GAAa,EAAA,IAAA,EAAc,MAAgB,EAAA;AACzD,IAAA,OAAO,IAAK,CAAA,aAAA;AAAA,MACV,CAAsB,mBAAA,EAAA,GAAG,CAAI,CAAA,EAAA,IAAI,aAAa,MAAM,CAAA,OAAA;AAAA,KACtD;AAAA;AACF,EAEA,MAAM,mBAAA,CAAoB,GAAa,EAAA,IAAA,EAAc,MAAgB,EAAA;AACnE,IAAA,OAAO,IAAK,CAAA,aAAA;AAAA,MACV,CAAsB,mBAAA,EAAA,GAAG,CAAI,CAAA,EAAA,IAAI,aAAa,MAAM,CAAA;AAAA,KACtD;AAAA;AACF,EAEA,MAAM,kBAAA,CAAmB,GAAa,EAAA,IAAA,EAAc,MAAgB,EAAA;AAClE,IAAM,MAAA,MAAA,GAAS,IAAI,eAAgB,EAAA;AACnC,IAAO,MAAA,CAAA,MAAA,CAAO,mBAAmB,MAAM,CAAA;AAEvC,IAAA,OAAO,IAAK,CAAA,aAAA;AAAA,MACV,sBAAsB,GAAG,CAAA,CAAA,EAAI,IAAI,CAAa,UAAA,EAAA,MAAM,aAAa,MAAM,CAAA;AAAA,KACzE;AAAA;AAEJ;;;;"}
@@ -0,0 +1,93 @@
1
+ 'use strict';
2
+
3
+ var pluginPermissionCommon = require('@backstage/plugin-permission-common');
4
+ var pluginPermissionNode = require('@backstage/plugin-permission-node');
5
+ var express = require('express');
6
+ var Router = require('express-promise-router');
7
+ var pluginQuayCommon = require('@backstage-community/plugin-quay-common');
8
+ var QuayService = require('./QuayService.cjs.js');
9
+
10
+ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
11
+
12
+ var express__default = /*#__PURE__*/_interopDefaultCompat(express);
13
+ var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
14
+
15
+ async function createRouter(options) {
16
+ const { logger, config, permissions, httpAuth } = options;
17
+ if (!config) {
18
+ throw new Error("Missing configuration for Quay plugin");
19
+ }
20
+ const quayService = options.quayService ?? QuayService.QuayService.fromConfig(config, logger);
21
+ const router = Router__default.default();
22
+ router.use(express__default.default.json());
23
+ const permissionIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
24
+ permissions: [pluginQuayCommon.quayViewPermission]
25
+ });
26
+ const checkPermission = async (req, res, next) => {
27
+ try {
28
+ const credentials = await httpAuth.credentials(req);
29
+ const decision = (await permissions.authorize([{ permission: pluginQuayCommon.quayViewPermission }], {
30
+ credentials
31
+ }))[0];
32
+ if (decision.result === pluginPermissionCommon.AuthorizeResult.DENY) {
33
+ res.status(403).json({
34
+ error: "Unauthorized, please ensure you have the correct permissions."
35
+ });
36
+ }
37
+ return next();
38
+ } catch (error) {
39
+ return next(error);
40
+ }
41
+ };
42
+ router.use(permissionIntegrationRouter);
43
+ router.use("/repository", checkPermission);
44
+ const validateParams = (req, res, next) => {
45
+ const { org, repo } = req.params;
46
+ if (!org?.trim() || !repo?.trim()) {
47
+ res.status(400).json({ error: "Missing required parameters" });
48
+ return;
49
+ }
50
+ next();
51
+ };
52
+ router.use("/repository/:org/:repo", validateParams);
53
+ router.get("/repository/:org/:repo/tag", async (req, res) => {
54
+ const { org, repo } = req.params;
55
+ const { page, limit } = req.query;
56
+ const tags = await quayService.getTags(
57
+ org,
58
+ repo,
59
+ page ? Number(page) : undefined,
60
+ limit ? Number(limit) : undefined
61
+ );
62
+ res.status(200).json(tags);
63
+ });
64
+ router.get(
65
+ "/repository/:org/:repo/manifest/:digest/labels",
66
+ async (req, res) => {
67
+ const { org, repo, digest } = req.params;
68
+ const labels = await quayService.getLabels(org, repo, digest);
69
+ res.status(200).json(labels);
70
+ }
71
+ );
72
+ router.get(
73
+ "/repository/:org/:repo/manifest/:digest/security",
74
+ async (req, res) => {
75
+ const { org, repo, digest } = req.params;
76
+ const securityDetails = await quayService.getSecurityDetails(
77
+ org,
78
+ repo,
79
+ digest
80
+ );
81
+ res.status(200).json(securityDetails);
82
+ }
83
+ );
84
+ router.get("/repository/:org/:repo/manifest/:digest", async (req, res) => {
85
+ const { org, repo, digest } = req.params;
86
+ const manifest = await quayService.getManifestByDigest(org, repo, digest);
87
+ res.status(200).json(manifest);
88
+ });
89
+ return router;
90
+ }
91
+
92
+ exports.createRouter = createRouter;
93
+ //# sourceMappingURL=router.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"router.cjs.js","sources":["../../src/services/router.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n HttpAuthService,\n LoggerService,\n PermissionsService,\n RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport { AuthorizeResult } from '@backstage/plugin-permission-common';\nimport { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';\n\nimport express from 'express';\nimport Router from 'express-promise-router';\n\nimport { quayViewPermission } from '@backstage-community/plugin-quay-common';\n\nimport { QuayService } from './QuayService';\n\nexport interface RouterOptions {\n quayService?: QuayService;\n logger: LoggerService;\n config: RootConfigService;\n permissions: PermissionsService;\n httpAuth: HttpAuthService;\n}\n\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, config, permissions, httpAuth } = options;\n\n if (!config) {\n throw new Error('Missing configuration for Quay plugin');\n }\n\n const quayService =\n options.quayService ?? QuayService.fromConfig(config, logger);\n\n const router = Router();\n router.use(express.json());\n\n const permissionIntegrationRouter = createPermissionIntegrationRouter({\n permissions: [quayViewPermission],\n });\n\n // Add permission middleware\n const checkPermission = async (\n req: express.Request,\n res: express.Response,\n next: express.NextFunction,\n ): Promise<void> => {\n try {\n const credentials = await httpAuth.credentials(req);\n const decision = (\n await permissions.authorize([{ permission: quayViewPermission }], {\n credentials,\n })\n )[0];\n\n if (decision.result === AuthorizeResult.DENY) {\n res.status(403).json({\n error:\n 'Unauthorized, please ensure you have the correct permissions.',\n });\n }\n return next();\n } catch (error) {\n return next(error);\n }\n };\n\n router.use(permissionIntegrationRouter);\n router.use('/repository', checkPermission);\n\n const validateParams = (\n req: express.Request,\n res: express.Response,\n next: express.NextFunction,\n ): void => {\n const { org, repo } = req.params;\n if (!org?.trim() || !repo?.trim()) {\n res.status(400).json({ error: 'Missing required parameters' });\n return;\n }\n next();\n };\n\n router.use('/repository/:org/:repo', validateParams);\n\n router.get('/repository/:org/:repo/tag', async (req, res) => {\n const { org, repo } = req.params;\n const { page, limit } = req.query;\n\n const tags = await quayService.getTags(\n org,\n repo,\n page ? Number(page) : undefined,\n limit ? Number(limit) : undefined,\n );\n\n res.status(200).json(tags);\n });\n\n router.get(\n '/repository/:org/:repo/manifest/:digest/labels',\n async (req, res) => {\n const { org, repo, digest } = req.params;\n const labels = await quayService.getLabels(org, repo, digest);\n\n res.status(200).json(labels);\n },\n );\n\n router.get(\n '/repository/:org/:repo/manifest/:digest/security',\n async (req, res) => {\n const { org, repo, digest } = req.params;\n\n const securityDetails = await quayService.getSecurityDetails(\n org,\n repo,\n digest,\n );\n\n res.status(200).json(securityDetails);\n },\n );\n\n router.get('/repository/:org/:repo/manifest/:digest', async (req, res) => {\n const { org, repo, digest } = req.params;\n const manifest = await quayService.getManifestByDigest(org, repo, digest);\n\n res.status(200).json(manifest);\n });\n\n return router;\n}\n"],"names":["QuayService","Router","express","createPermissionIntegrationRouter","quayViewPermission","AuthorizeResult"],"mappings":";;;;;;;;;;;;;;AAuCA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,WAAA,EAAa,UAAa,GAAA,OAAA;AAElD,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAM,MAAA,IAAI,MAAM,uCAAuC,CAAA;AAAA;AAGzD,EAAA,MAAM,cACJ,OAAQ,CAAA,WAAA,IAAeA,uBAAY,CAAA,UAAA,CAAW,QAAQ,MAAM,CAAA;AAE9D,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AAEzB,EAAA,MAAM,8BAA8BC,sDAAkC,CAAA;AAAA,IACpE,WAAA,EAAa,CAACC,mCAAkB;AAAA,GACjC,CAAA;AAGD,EAAA,MAAM,eAAkB,GAAA,OACtB,GACA,EAAA,GAAA,EACA,IACkB,KAAA;AAClB,IAAI,IAAA;AACF,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAClD,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA,CAAU,CAAC,EAAE,UAAA,EAAYA,mCAAmB,EAAC,CAAG,EAAA;AAAA,QAChE;AAAA,OACD,GACD,CAAC,CAAA;AAEH,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAC,sCAAA,CAAgB,IAAM,EAAA;AAC5C,QAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACnB,KACE,EAAA;AAAA,SACH,CAAA;AAAA;AAEH,MAAA,OAAO,IAAK,EAAA;AAAA,aACL,KAAO,EAAA;AACd,MAAA,OAAO,KAAK,KAAK,CAAA;AAAA;AACnB,GACF;AAEA,EAAA,MAAA,CAAO,IAAI,2BAA2B,CAAA;AACtC,EAAO,MAAA,CAAA,GAAA,CAAI,eAAe,eAAe,CAAA;AAEzC,EAAA,MAAM,cAAiB,GAAA,CACrB,GACA,EAAA,GAAA,EACA,IACS,KAAA;AACT,IAAA,MAAM,EAAE,GAAA,EAAK,IAAK,EAAA,GAAI,GAAI,CAAA,MAAA;AAC1B,IAAA,IAAI,CAAC,GAAK,EAAA,IAAA,MAAU,CAAC,IAAA,EAAM,MAAQ,EAAA;AACjC,MAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,KAAA,EAAO,+BAA+B,CAAA;AAC7D,MAAA;AAAA;AAEF,IAAK,IAAA,EAAA;AAAA,GACP;AAEA,EAAO,MAAA,CAAA,GAAA,CAAI,0BAA0B,cAAc,CAAA;AAEnD,EAAA,MAAA,CAAO,GAAI,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC3D,IAAA,MAAM,EAAE,GAAA,EAAK,IAAK,EAAA,GAAI,GAAI,CAAA,MAAA;AAC1B,IAAA,MAAM,EAAE,IAAA,EAAM,KAAM,EAAA,GAAI,GAAI,CAAA,KAAA;AAE5B,IAAM,MAAA,IAAA,GAAO,MAAM,WAAY,CAAA,OAAA;AAAA,MAC7B,GAAA;AAAA,MACA,IAAA;AAAA,MACA,IAAA,GAAO,MAAO,CAAA,IAAI,CAAI,GAAA,SAAA;AAAA,MACtB,KAAA,GAAQ,MAAO,CAAA,KAAK,CAAI,GAAA;AAAA,KAC1B;AAEA,IAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,GAC1B,CAAA;AAED,EAAO,MAAA,CAAA,GAAA;AAAA,IACL,gDAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,GAAA,EAAK,IAAM,EAAA,MAAA,KAAW,GAAI,CAAA,MAAA;AAClC,MAAA,MAAM,SAAS,MAAM,WAAA,CAAY,SAAU,CAAA,GAAA,EAAK,MAAM,MAAM,CAAA;AAE5D,MAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA;AAC7B,GACF;AAEA,EAAO,MAAA,CAAA,GAAA;AAAA,IACL,kDAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,GAAA,EAAK,IAAM,EAAA,MAAA,KAAW,GAAI,CAAA,MAAA;AAElC,MAAM,MAAA,eAAA,GAAkB,MAAM,WAAY,CAAA,kBAAA;AAAA,QACxC,GAAA;AAAA,QACA,IAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,eAAe,CAAA;AAAA;AACtC,GACF;AAEA,EAAA,MAAA,CAAO,GAAI,CAAA,yCAAA,EAA2C,OAAO,GAAA,EAAK,GAAQ,KAAA;AACxE,IAAA,MAAM,EAAE,GAAA,EAAK,IAAM,EAAA,MAAA,KAAW,GAAI,CAAA,MAAA;AAClC,IAAA,MAAM,WAAW,MAAM,WAAA,CAAY,mBAAoB,CAAA,GAAA,EAAK,MAAM,MAAM,CAAA;AAExE,IAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,QAAQ,CAAA;AAAA,GAC9B,CAAA;AAED,EAAO,OAAA,MAAA;AACT;;;;"}
package/package.json ADDED
@@ -0,0 +1,69 @@
1
+ {
2
+ "name": "@backstage-community/plugin-quay-backend",
3
+ "version": "1.0.0",
4
+ "main": "dist/index.cjs.js",
5
+ "types": "dist/index.d.ts",
6
+ "license": "Apache-2.0",
7
+ "publishConfig": {
8
+ "access": "public",
9
+ "main": "dist/index.cjs.js",
10
+ "types": "dist/index.d.ts"
11
+ },
12
+ "repository": {
13
+ "type": "git",
14
+ "url": "https://github.com/backstage/community-plugins",
15
+ "directory": "workspaces/quay/plugins/quay-backend"
16
+ },
17
+ "backstage": {
18
+ "role": "backend-plugin",
19
+ "supported-versions": "1.35.0",
20
+ "pluginId": "quay",
21
+ "pluginPackages": [
22
+ "@backstage-community/plugin-quay",
23
+ "@backstage-community/plugin-quay-backend",
24
+ "@backstage-community/plugin-quay-common"
25
+ ]
26
+ },
27
+ "scripts": {
28
+ "start": "backstage-cli package start",
29
+ "build": "backstage-cli package build",
30
+ "lint": "backstage-cli package lint",
31
+ "test": "backstage-cli package test",
32
+ "clean": "backstage-cli package clean",
33
+ "prepack": "backstage-cli package prepack",
34
+ "postpack": "backstage-cli package postpack"
35
+ },
36
+ "dependencies": {
37
+ "@backstage-community/plugin-quay-common": "^1.6.0",
38
+ "@backstage/backend-defaults": "^0.6.0",
39
+ "@backstage/backend-plugin-api": "^1.1.0",
40
+ "@backstage/config": "^1.3.2",
41
+ "@backstage/plugin-catalog-node": "^1.15.0",
42
+ "@backstage/plugin-permission-common": "^0.8.4",
43
+ "express": "^4.17.1",
44
+ "express-promise-router": "^4.1.0"
45
+ },
46
+ "devDependencies": {
47
+ "@backstage/cli": "^0.29.4",
48
+ "@types/express": "^4.17.6",
49
+ "@types/supertest": "^2.0.12",
50
+ "supertest": "^6.2.4"
51
+ },
52
+ "files": [
53
+ "dist"
54
+ ],
55
+ "configSchema": "config.d.ts",
56
+ "homepage": "https://red.ht/rhdh",
57
+ "bugs": "https://github.com/backstage/community-plugins/issues",
58
+ "maintainers": [
59
+ "@karthikjeeyar"
60
+ ],
61
+ "author": "Red Hat",
62
+ "typesVersions": {
63
+ "*": {
64
+ "index": [
65
+ "dist/index.d.ts"
66
+ ]
67
+ }
68
+ }
69
+ }