@backstage-community/plugin-quay-backend 1.7.0 → 1.9.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 CHANGED
@@ -1,5 +1,32 @@
1
1
  # @backstage-community/plugin-quay-backend
2
2
 
3
+ ## 1.9.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 40d312e: **BREAKING**: Added support for multiple Quay instances. Backend plugin routes now require an `:instance-name` parameter to support multiple Quay instances:
8
+
9
+ - `/repository/:org/:repo/tag` → `/:instanceName/repository/:org/:repo/tag`
10
+ - `/repository/:org/:repo/manifest/{digest}` → `/:instanceName/repository/:org/:repo/manifest/{digest}`
11
+ - `/repository/:org/:repo/manifest/{digest}/labels` → `/:instanceName/repository/:org/:repo/manifest/{digest}/labels`
12
+ - `/repository/:org/:repo/manifest/{digest}/security` → `/instanceName/repository/:org/:repo/manifest/{digest}/security`
13
+
14
+ ### Patch Changes
15
+
16
+ - Updated dependencies [40d312e]
17
+ - @backstage-community/plugin-quay-common@1.14.0
18
+
19
+ ## 1.8.0
20
+
21
+ ### Minor Changes
22
+
23
+ - 54a1b43: Backstage version bump to v1.44.0
24
+
25
+ ### Patch Changes
26
+
27
+ - Updated dependencies [54a1b43]
28
+ - @backstage-community/plugin-quay-common@1.13.0
29
+
3
30
  ## 1.7.0
4
31
 
5
32
  ### Minor Changes
package/README.md CHANGED
@@ -26,7 +26,7 @@ backend.add(import('@backstage-community/plugin-quay-backend'));
26
26
 
27
27
  ### App Config
28
28
 
29
- Define the following in `app-config.yaml`:
29
+ Define the following in `app-config.yaml` for a single Quay instance:
30
30
 
31
31
  ```yaml
32
32
  quay:
@@ -41,6 +41,32 @@ For more information on OAuth access tokens in Quay, please see [the official do
41
41
 
42
42
  **Note**: Robot tokens will not work for the `apiKey` value.
43
43
 
44
+ #### Multiple Quay Instances Configuration
45
+
46
+ You can connect to multiple Quay instances by following configuration:
47
+
48
+ ```yaml
49
+ quay:
50
+ instances:
51
+ - name: production
52
+ apiUrl: 'https://quay.io'
53
+ apiKey: 'prod-abc123'
54
+ - name: staging
55
+ apiUrl: 'https://quay-staging.example.com'
56
+ apiKey: 'staging-xyz456'
57
+ ```
58
+
59
+ When using multiple instances, specify the target instance in your entity using the `quay.io/instance-name` annotation:
60
+
61
+ ```yaml title="catalog-info.yaml"
62
+ metadata:
63
+ annotations:
64
+ 'quay.io/repository-slug': '<ORGANIZATION>/<REPOSITORY>'
65
+ 'quay.io/instance-name': 'production'
66
+ ```
67
+
68
+ **Note:** If the `quay.io/instance-name` annotation is not specified, the plugin will automatically use the first configured instance as the default.
69
+
44
70
  ### Catalog
45
71
 
46
72
  Add the annotation `quay.io/repository-slug` to your entity
@@ -48,7 +74,16 @@ Add the annotation `quay.io/repository-slug` to your entity
48
74
  ```yaml
49
75
  metadata:
50
76
  annotations:
51
- quay.io/repository-slug: '<organization>/<repository>`
77
+ quay.io/repository-slug: '<organization>/<repository>'
78
+ ```
79
+
80
+ To connect Catalog components to different Quay instances, specify the target instance in your entity using the `quay.io/instance-name` annotation. The instance name must match a name defined in your instances configuration. If omitted, the first configured instance is used by default.
81
+
82
+ ```yaml
83
+ metadata:
84
+ annotations:
85
+ quay.io/repository-slug: '<organization>/<repository>'
86
+ quay.io/instance-name: 'production'
52
87
  ```
53
88
 
54
89
  ## Development
package/config.d.ts CHANGED
@@ -15,16 +15,41 @@
15
15
  */
16
16
  export interface Config {
17
17
  /** Configurations for the Quay backend plugin */
18
- quay: {
19
- /**
20
- * The api url of the Quay instance.
21
- * @visibility backend
22
- */
23
- apiUrl: string;
24
- /**
25
- * The api token of the Quay instance.
26
- * @visibility secret
27
- */
28
- apiKey?: string;
29
- };
18
+ quay:
19
+ | {
20
+ /**
21
+ * Multiple Quay instances configuration.
22
+ * Use this to configure multiple Quay instances for your organization.
23
+ * @visibility frontend
24
+ */
25
+ instances: Array<{
26
+ /**
27
+ * The name identifier for this Quay instance.
28
+ * @visibility frontend
29
+ */
30
+ name: string;
31
+ /**
32
+ * The api url of the Quay instance.
33
+ * @visibility frontend
34
+ */
35
+ apiUrl: string;
36
+ /**
37
+ * The api token of the Quay instance.
38
+ * @visibility secret
39
+ */
40
+ apiKey?: string;
41
+ }>;
42
+ }
43
+ | {
44
+ /**
45
+ * The api url of the Quay instance.
46
+ * @visibility backend
47
+ */
48
+ apiUrl: string;
49
+ /**
50
+ * The api token of the Quay instance.
51
+ * @visibility secret
52
+ */
53
+ apiKey?: string;
54
+ };
30
55
  }
@@ -1,6 +1,7 @@
1
1
  'use strict';
2
2
 
3
3
  var backendPluginApi = require('@backstage/backend-plugin-api');
4
+ var pluginQuayCommon = require('@backstage-community/plugin-quay-common');
4
5
  var router = require('./services/router.cjs.js');
5
6
 
6
7
  const quayPlugin = backendPluginApi.createBackendPlugin({
@@ -11,10 +12,19 @@ const quayPlugin = backendPluginApi.createBackendPlugin({
11
12
  config: backendPluginApi.coreServices.rootConfig,
12
13
  logger: backendPluginApi.coreServices.logger,
13
14
  permissions: backendPluginApi.coreServices.permissions,
15
+ permissionsRegistry: backendPluginApi.coreServices.permissionsRegistry,
14
16
  httpRouter: backendPluginApi.coreServices.httpRouter,
15
17
  httpAuth: backendPluginApi.coreServices.httpAuth
16
18
  },
17
- async init({ config, logger, permissions, httpAuth, httpRouter }) {
19
+ async init({
20
+ config,
21
+ logger,
22
+ permissions,
23
+ permissionsRegistry,
24
+ httpAuth,
25
+ httpRouter
26
+ }) {
27
+ permissionsRegistry.addPermissions(pluginQuayCommon.quayPermissions);
18
28
  httpRouter.use(
19
29
  await router.createRouter({
20
30
  logger,
@@ -1 +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;;;;"}
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 { quayPermissions } from '@backstage-community/plugin-quay-common';\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 permissionsRegistry: coreServices.permissionsRegistry,\n httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n },\n async init({\n config,\n logger,\n permissions,\n permissionsRegistry,\n httpAuth,\n httpRouter,\n }) {\n permissionsRegistry.addPermissions(quayPermissions);\n\n httpRouter.use(\n await createRouter({\n logger,\n config,\n permissions,\n httpAuth,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","coreServices","quayPermissions","createRouter"],"mappings":";;;;;;AA6BO,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,qBAAqBA,6BAAa,CAAA,mBAAA;AAAA,QAClC,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA;AAAA,OACzB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,WAAA;AAAA,QACA,mBAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAA,mBAAA,CAAoB,eAAeC,gCAAe,CAAA;AAElD,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;;;;"}
@@ -1,24 +1,59 @@
1
1
  'use strict';
2
2
 
3
+ var pluginQuayCommon = require('@backstage-community/plugin-quay-common');
4
+
3
5
  class QuayService {
4
- apiUrl;
5
- token;
6
6
  logger;
7
- constructor(config, logger) {
8
- this.apiUrl = config.getString("quay.apiUrl");
9
- this.token = config.getOptionalString("quay.apiKey");
7
+ instances;
8
+ defaultInstanceName;
9
+ constructor(instances, logger) {
10
+ if (instances.length === 0) {
11
+ throw new Error("At least one Quay instance must be configured");
12
+ }
13
+ this.instances = new Map(
14
+ instances.map((instance) => [instance.name, instance])
15
+ );
16
+ this.defaultInstanceName = instances[0].name;
10
17
  this.logger = logger;
11
18
  }
12
19
  static fromConfig(config, logger) {
13
- return new QuayService(config, logger);
20
+ const quayConfig = config.getConfig("quay");
21
+ if (quayConfig.has("instances")) {
22
+ const instancesConfig = quayConfig.getConfigArray("instances");
23
+ const instances = instancesConfig.map((instanceConfig) => ({
24
+ name: instanceConfig.getString("name"),
25
+ apiUrl: instanceConfig.getString("apiUrl"),
26
+ token: instanceConfig.getOptionalString("apiKey")
27
+ }));
28
+ return new QuayService(instances, logger);
29
+ }
30
+ return new QuayService(
31
+ [
32
+ {
33
+ name: pluginQuayCommon.QUAY_SINGLE_INSTANCE_NAME,
34
+ apiUrl: quayConfig.getString("apiUrl"),
35
+ token: quayConfig.getOptionalString("apiKey")
36
+ }
37
+ ],
38
+ logger
39
+ );
14
40
  }
15
- async fetchFromQuay(endpoint) {
16
- const url = `${this.apiUrl}${endpoint}`;
41
+ getQuayInstance(instanceName) {
42
+ return instanceName ? this.instances.get(instanceName) : this.instances.get(this.defaultInstanceName);
43
+ }
44
+ async fetchFromQuay(endpoint, instanceName) {
45
+ const instance = this.getQuayInstance(instanceName);
46
+ if (!instance) {
47
+ throw new Error(
48
+ `Quay instance "${instanceName}" not found in configuration.`
49
+ );
50
+ }
51
+ const url = `${instance.apiUrl}${endpoint}`;
17
52
  try {
18
53
  const response = await fetch(url, {
19
54
  headers: {
20
55
  "Content-Type": "application/json",
21
- ...this.token ? { Authorization: `Bearer ${this.token}` } : {}
56
+ ...instance.token ? { Authorization: `Bearer ${instance.token}` } : {}
22
57
  }
23
58
  });
24
59
  if (!response.ok) {
@@ -37,31 +72,35 @@ class QuayService {
37
72
  throw new Error(`Quay Service request failed: ${error}`);
38
73
  }
39
74
  }
40
- async getTags(org, repo, page, limit, specificTag) {
75
+ async getTags(instanceName, org, repo, page, limit, specificTag) {
41
76
  const params = new URLSearchParams();
42
77
  if (page !== undefined) params.append("page", page.toString());
43
78
  if (limit !== undefined) params.append("limit", limit.toString());
44
79
  if (specificTag !== undefined) params.append("specificTag", specificTag);
45
80
  params.append("onlyActiveTags", "true");
46
81
  return this.fetchFromQuay(
47
- `/api/v1/repository/${org}/${repo}/tag?${params.toString()}`
82
+ `/api/v1/repository/${org}/${repo}/tag?${params.toString()}`,
83
+ instanceName
48
84
  );
49
85
  }
50
- async getLabels(org, repo, digest) {
86
+ async getLabels(instanceName, org, repo, digest) {
51
87
  return this.fetchFromQuay(
52
- `/api/v1/repository/${org}/${repo}/manifest/${digest}/labels`
88
+ `/api/v1/repository/${org}/${repo}/manifest/${digest}/labels`,
89
+ instanceName
53
90
  );
54
91
  }
55
- async getManifestByDigest(org, repo, digest) {
92
+ async getManifestByDigest(instanceName, org, repo, digest) {
56
93
  return this.fetchFromQuay(
57
- `/api/v1/repository/${org}/${repo}/manifest/${digest}`
94
+ `/api/v1/repository/${org}/${repo}/manifest/${digest}`,
95
+ instanceName
58
96
  );
59
97
  }
60
- async getSecurityDetails(org, repo, digest) {
98
+ async getSecurityDetails(instanceName, org, repo, digest) {
61
99
  const params = new URLSearchParams();
62
100
  params.append("vulnerabilities", "true");
63
101
  return this.fetchFromQuay(
64
- `/api/v1/repository/${org}/${repo}/manifest/${digest}/security?${params}`
102
+ `/api/v1/repository/${org}/${repo}/manifest/${digest}/security?${params}`,
103
+ instanceName
65
104
  );
66
105
  }
67
106
  }
@@ -1 +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.status}, ${response.statusText})`,\n );\n\n // Check if this is an access issue.\n if (response?.status === 401) {\n throw new Error(\n `Quay returned (${response.status}, ${response.statusText}): Please make sure you have access to this repository or have valid access tokens.`,\n );\n }\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,CAAiC,8BAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA,CAAA;AAAA,SAC1E;AAGA,QAAI,IAAA,QAAA,EAAU,WAAW,GAAK,EAAA;AAC5B,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAkB,eAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA,mFAAA;AAAA,WAC3D;AAAA;AAGF,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;;;;"}
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 { QUAY_SINGLE_INSTANCE_NAME } from '@backstage-community/plugin-quay-common';\n\nimport {\n LabelsResponse,\n ManifestByDigestResponse,\n SecurityDetailsResponse,\n TagsResponse,\n} from '../types';\n\nexport interface QuayService {\n getQuayInstance(instanceName?: string): QuayInstance | undefined;\n getTags(\n instanceName: string,\n org: string,\n repo: string,\n page?: number,\n limit?: number,\n ): Promise<TagsResponse>;\n getLabels(\n instanceName: string,\n org: string,\n repo: string,\n digest: string,\n ): Promise<LabelsResponse>;\n getManifestByDigest(\n instanceName: string,\n org: string,\n repo: string,\n digest: string,\n ): Promise<ManifestByDigestResponse>;\n getSecurityDetails(\n instanceName: string,\n org: string,\n repo: string,\n digest: string,\n ): Promise<SecurityDetailsResponse>;\n}\n\nexport type QuayInstance = {\n name: string;\n apiUrl: string;\n token: string | undefined;\n};\n\nexport class QuayService {\n private readonly logger: LoggerService;\n private readonly instances: Map<string, QuayInstance>;\n private readonly defaultInstanceName: string;\n\n constructor(instances: QuayInstance[], logger: LoggerService) {\n if (instances.length === 0) {\n throw new Error('At least one Quay instance must be configured');\n }\n\n this.instances = new Map(\n instances.map(instance => [instance.name, instance]),\n );\n this.defaultInstanceName = instances[0].name;\n this.logger = logger;\n }\n\n static fromConfig(config: Config, logger: LoggerService): QuayService {\n const quayConfig = config.getConfig('quay');\n\n // Multiple instances configuration\n if (quayConfig.has('instances')) {\n const instancesConfig = quayConfig.getConfigArray('instances');\n const instances = instancesConfig.map(instanceConfig => ({\n name: instanceConfig.getString('name'),\n apiUrl: instanceConfig.getString('apiUrl'),\n token: instanceConfig.getOptionalString('apiKey'),\n }));\n return new QuayService(instances, logger);\n }\n\n // Single instance configuration\n return new QuayService(\n [\n {\n name: QUAY_SINGLE_INSTANCE_NAME,\n apiUrl: quayConfig.getString('apiUrl'),\n token: quayConfig.getOptionalString('apiKey'),\n },\n ],\n logger,\n );\n }\n\n public getQuayInstance(instanceName?: string): QuayInstance | undefined {\n return instanceName\n ? this.instances.get(instanceName)\n : this.instances.get(this.defaultInstanceName);\n }\n\n private async fetchFromQuay(\n endpoint: string,\n instanceName: string,\n ): Promise<any> {\n const instance = this.getQuayInstance(instanceName);\n if (!instance) {\n throw new Error(\n `Quay instance \"${instanceName}\" not found in configuration.`,\n );\n }\n\n const url = `${instance.apiUrl}${endpoint}`;\n\n try {\n const response = await fetch(url, {\n headers: {\n 'Content-Type': 'application/json',\n ...(instance.token\n ? { Authorization: `Bearer ${instance.token}` }\n : {}),\n },\n });\n\n if (!response.ok) {\n this.logger.error(\n `Quay Service request failed: (${response.status}, ${response.statusText})`,\n );\n\n // Check if this is an access issue.\n if (response?.status === 401) {\n throw new Error(\n `Quay returned (${response.status}, ${response.statusText}): Please make sure you have access to this repository or have valid access tokens.`,\n );\n }\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 instanceName: string,\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 instanceName,\n ) as Promise<TagsResponse>;\n }\n\n async getLabels(\n instanceName: string,\n org: string,\n repo: string,\n digest: string,\n ) {\n return this.fetchFromQuay(\n `/api/v1/repository/${org}/${repo}/manifest/${digest}/labels`,\n instanceName,\n ) as Promise<LabelsResponse>;\n }\n\n async getManifestByDigest(\n instanceName: string,\n org: string,\n repo: string,\n digest: string,\n ) {\n return this.fetchFromQuay(\n `/api/v1/repository/${org}/${repo}/manifest/${digest}`,\n instanceName,\n ) as Promise<ManifestByDigestResponse>;\n }\n\n async getSecurityDetails(\n instanceName: string,\n org: string,\n repo: string,\n digest: string,\n ) {\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 instanceName,\n ) as Promise<SecurityDetailsResponse>;\n }\n}\n"],"names":["QUAY_SINGLE_INSTANCE_NAME"],"mappings":";;;;AA8DO,MAAM,WAAY,CAAA;AAAA,EACN,MAAA;AAAA,EACA,SAAA;AAAA,EACA,mBAAA;AAAA,EAEjB,WAAA,CAAY,WAA2B,MAAuB,EAAA;AAC5D,IAAI,IAAA,SAAA,CAAU,WAAW,CAAG,EAAA;AAC1B,MAAM,MAAA,IAAI,MAAM,+CAA+C,CAAA;AAAA;AAGjE,IAAA,IAAA,CAAK,YAAY,IAAI,GAAA;AAAA,MACnB,UAAU,GAAI,CAAA,CAAA,QAAA,KAAY,CAAC,QAAS,CAAA,IAAA,EAAM,QAAQ,CAAC;AAAA,KACrD;AACA,IAAK,IAAA,CAAA,mBAAA,GAAsB,SAAU,CAAA,CAAC,CAAE,CAAA,IAAA;AACxC,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AAAA;AAChB,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,MAAoC,EAAA;AACpE,IAAM,MAAA,UAAA,GAAa,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AAG1C,IAAI,IAAA,UAAA,CAAW,GAAI,CAAA,WAAW,CAAG,EAAA;AAC/B,MAAM,MAAA,eAAA,GAAkB,UAAW,CAAA,cAAA,CAAe,WAAW,CAAA;AAC7D,MAAM,MAAA,SAAA,GAAY,eAAgB,CAAA,GAAA,CAAI,CAAmB,cAAA,MAAA;AAAA,QACvD,IAAA,EAAM,cAAe,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QACrC,MAAA,EAAQ,cAAe,CAAA,SAAA,CAAU,QAAQ,CAAA;AAAA,QACzC,KAAA,EAAO,cAAe,CAAA,iBAAA,CAAkB,QAAQ;AAAA,OAChD,CAAA,CAAA;AACF,MAAO,OAAA,IAAI,WAAY,CAAA,SAAA,EAAW,MAAM,CAAA;AAAA;AAI1C,IAAA,OAAO,IAAI,WAAA;AAAA,MACT;AAAA,QACE;AAAA,UACE,IAAM,EAAAA,0CAAA;AAAA,UACN,MAAA,EAAQ,UAAW,CAAA,SAAA,CAAU,QAAQ,CAAA;AAAA,UACrC,KAAA,EAAO,UAAW,CAAA,iBAAA,CAAkB,QAAQ;AAAA;AAC9C,OACF;AAAA,MACA;AAAA,KACF;AAAA;AACF,EAEO,gBAAgB,YAAiD,EAAA;AACtE,IAAO,OAAA,YAAA,GACH,IAAK,CAAA,SAAA,CAAU,GAAI,CAAA,YAAY,IAC/B,IAAK,CAAA,SAAA,CAAU,GAAI,CAAA,IAAA,CAAK,mBAAmB,CAAA;AAAA;AACjD,EAEA,MAAc,aACZ,CAAA,QAAA,EACA,YACc,EAAA;AACd,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,eAAA,CAAgB,YAAY,CAAA;AAClD,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,kBAAkB,YAAY,CAAA,6BAAA;AAAA,OAChC;AAAA;AAGF,IAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAS,CAAA,MAAM,GAAG,QAAQ,CAAA,CAAA;AAEzC,IAAI,IAAA;AACF,MAAM,MAAA,QAAA,GAAW,MAAM,KAAA,CAAM,GAAK,EAAA;AAAA,QAChC,OAAS,EAAA;AAAA,UACP,cAAgB,EAAA,kBAAA;AAAA,UAChB,GAAI,QAAS,CAAA,KAAA,GACT,EAAE,aAAA,EAAe,UAAU,QAAS,CAAA,KAAK,CAAG,CAAA,EAAA,GAC5C;AAAC;AACP,OACD,CAAA;AAED,MAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAiC,8BAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA,CAAA;AAAA,SAC1E;AAGA,QAAI,IAAA,QAAA,EAAU,WAAW,GAAK,EAAA;AAC5B,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAkB,eAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA,mFAAA;AAAA,WAC3D;AAAA;AAGF,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,YAAA,EACA,KACA,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,CAAA;AAAA,MAC1D;AAAA,KACF;AAAA;AACF,EAEA,MAAM,SAAA,CACJ,YACA,EAAA,GAAA,EACA,MACA,MACA,EAAA;AACA,IAAA,OAAO,IAAK,CAAA,aAAA;AAAA,MACV,CAAsB,mBAAA,EAAA,GAAG,CAAI,CAAA,EAAA,IAAI,aAAa,MAAM,CAAA,OAAA,CAAA;AAAA,MACpD;AAAA,KACF;AAAA;AACF,EAEA,MAAM,mBAAA,CACJ,YACA,EAAA,GAAA,EACA,MACA,MACA,EAAA;AACA,IAAA,OAAO,IAAK,CAAA,aAAA;AAAA,MACV,CAAsB,mBAAA,EAAA,GAAG,CAAI,CAAA,EAAA,IAAI,aAAa,MAAM,CAAA,CAAA;AAAA,MACpD;AAAA,KACF;AAAA;AACF,EAEA,MAAM,kBAAA,CACJ,YACA,EAAA,GAAA,EACA,MACA,MACA,EAAA;AACA,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,CAAA;AAAA,MACvE;AAAA,KACF;AAAA;AAEJ;;;;"}
@@ -1,7 +1,6 @@
1
1
  'use strict';
2
2
 
3
3
  var pluginPermissionCommon = require('@backstage/plugin-permission-common');
4
- var pluginPermissionNode = require('@backstage/plugin-permission-node');
5
4
  var express = require('express');
6
5
  var Router = require('express-promise-router');
7
6
  var pluginQuayCommon = require('@backstage-community/plugin-quay-common');
@@ -20,9 +19,6 @@ async function createRouter(options) {
20
19
  const quayService = options.quayService ?? QuayService.QuayService.fromConfig(config, logger);
21
20
  const router = Router__default.default();
22
21
  router.use(express__default.default.json());
23
- const permissionIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
24
- permissions: [pluginQuayCommon.quayViewPermission]
25
- });
26
22
  const checkPermission = async (req, res, next) => {
27
23
  try {
28
24
  const credentials = await httpAuth.credentials(req);
@@ -39,21 +35,33 @@ async function createRouter(options) {
39
35
  return next(error);
40
36
  }
41
37
  };
42
- router.use(permissionIntegrationRouter);
43
- router.use("/repository", checkPermission);
38
+ router.use("/:instanceName/repository", checkPermission);
44
39
  const validateParams = (req, res, next) => {
45
- const { org, repo } = req.params;
46
- if (!org?.trim() || !repo?.trim()) {
40
+ const { instanceName, org, repo } = req.params;
41
+ if (!instanceName?.trim() || !org?.trim() || !repo?.trim()) {
47
42
  res.status(400).json({ error: "Missing required parameters" });
48
43
  return;
49
44
  }
50
45
  next();
51
46
  };
52
- router.use("/repository/:org/:repo", validateParams);
53
- router.get("/repository/:org/:repo/tag", async (req, res) => {
54
- const { org, repo } = req.params;
47
+ router.use("/:instanceName/repository/:org/:repo", validateParams);
48
+ const checkInstanceIsConfigured = async (req, res, next) => {
49
+ const { instanceName } = req.params;
50
+ const instanceConfig = quayService.getQuayInstance(instanceName);
51
+ if (instanceConfig === undefined) {
52
+ res.status(404).json({
53
+ error: `Quay instance "${instanceName}" not found in configuration.`
54
+ });
55
+ return;
56
+ }
57
+ next();
58
+ };
59
+ router.use("/:instanceName", checkInstanceIsConfigured);
60
+ router.get("/:instanceName/repository/:org/:repo/tag", async (req, res) => {
61
+ const { instanceName, org, repo } = req.params;
55
62
  const { page, limit } = req.query;
56
63
  const tags = await quayService.getTags(
64
+ instanceName,
57
65
  org,
58
66
  repo,
59
67
  page ? Number(page) : undefined,
@@ -62,18 +70,24 @@ async function createRouter(options) {
62
70
  res.status(200).json(tags);
63
71
  });
64
72
  router.get(
65
- "/repository/:org/:repo/manifest/:digest/labels",
73
+ "/:instanceName/repository/:org/:repo/manifest/:digest/labels",
66
74
  async (req, res) => {
67
- const { org, repo, digest } = req.params;
68
- const labels = await quayService.getLabels(org, repo, digest);
75
+ const { instanceName, org, repo, digest } = req.params;
76
+ const labels = await quayService.getLabels(
77
+ instanceName,
78
+ org,
79
+ repo,
80
+ digest
81
+ );
69
82
  res.status(200).json(labels);
70
83
  }
71
84
  );
72
85
  router.get(
73
- "/repository/:org/:repo/manifest/:digest/security",
86
+ "/:instanceName/repository/:org/:repo/manifest/:digest/security",
74
87
  async (req, res) => {
75
- const { org, repo, digest } = req.params;
88
+ const { instanceName, org, repo, digest } = req.params;
76
89
  const securityDetails = await quayService.getSecurityDetails(
90
+ instanceName,
77
91
  org,
78
92
  repo,
79
93
  digest
@@ -81,11 +95,19 @@ async function createRouter(options) {
81
95
  res.status(200).json(securityDetails);
82
96
  }
83
97
  );
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
- });
98
+ router.get(
99
+ "/:instanceName/repository/:org/:repo/manifest/:digest",
100
+ async (req, res) => {
101
+ const { instanceName, org, repo, digest } = req.params;
102
+ const manifest = await quayService.getManifestByDigest(
103
+ instanceName,
104
+ org,
105
+ repo,
106
+ digest
107
+ );
108
+ res.status(200).json(manifest);
109
+ }
110
+ );
89
111
  return router;
90
112
  }
91
113
 
@@ -1 +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;;;;"}
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';\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 // 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('/:instanceName/repository', checkPermission);\n\n const validateParams = (\n req: express.Request,\n res: express.Response,\n next: express.NextFunction,\n ): void => {\n const { instanceName, org, repo } = req.params;\n if (!instanceName?.trim() || !org?.trim() || !repo?.trim()) {\n res.status(400).json({ error: 'Missing required parameters' });\n return;\n }\n next();\n };\n\n router.use('/:instanceName/repository/:org/:repo', validateParams);\n\n const checkInstanceIsConfigured = async (\n req: express.Request,\n res: express.Response,\n next: express.NextFunction,\n ): Promise<void> => {\n const { instanceName } = req.params;\n const instanceConfig = quayService.getQuayInstance(instanceName);\n if (instanceConfig === undefined) {\n res.status(404).json({\n error: `Quay instance \"${instanceName}\" not found in configuration.`,\n });\n return;\n }\n next();\n };\n\n router.use('/:instanceName', checkInstanceIsConfigured);\n\n router.get('/:instanceName/repository/:org/:repo/tag', async (req, res) => {\n const { instanceName, org, repo } = req.params;\n const { page, limit } = req.query;\n\n const tags = await quayService.getTags(\n instanceName,\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 '/:instanceName/repository/:org/:repo/manifest/:digest/labels',\n async (req, res) => {\n const { instanceName, org, repo, digest } = req.params;\n\n const labels = await quayService.getLabels(\n instanceName,\n org,\n repo,\n digest,\n );\n\n res.status(200).json(labels);\n },\n );\n\n router.get(\n '/:instanceName/repository/:org/:repo/manifest/:digest/security',\n async (req, res) => {\n const { instanceName, org, repo, digest } = req.params;\n\n const securityDetails = await quayService.getSecurityDetails(\n instanceName,\n org,\n repo,\n digest,\n );\n\n res.status(200).json(securityDetails);\n },\n );\n\n router.get(\n '/:instanceName/repository/:org/:repo/manifest/:digest',\n async (req, res) => {\n const { instanceName, org, repo, digest } = req.params;\n\n const manifest = await quayService.getManifestByDigest(\n instanceName,\n org,\n repo,\n digest,\n );\n\n res.status(200).json(manifest);\n },\n );\n\n return router;\n}\n"],"names":["QuayService","Router","express","quayViewPermission","AuthorizeResult"],"mappings":";;;;;;;;;;;;;AAsCA,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;AAGzB,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,EAAYC,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,EAAO,MAAA,CAAA,GAAA,CAAI,6BAA6B,eAAe,CAAA;AAEvD,EAAA,MAAM,cAAiB,GAAA,CACrB,GACA,EAAA,GAAA,EACA,IACS,KAAA;AACT,IAAA,MAAM,EAAE,YAAA,EAAc,GAAK,EAAA,IAAA,KAAS,GAAI,CAAA,MAAA;AACxC,IAAI,IAAA,CAAC,YAAc,EAAA,IAAA,EAAU,IAAA,CAAC,GAAK,EAAA,IAAA,EAAU,IAAA,CAAC,IAAM,EAAA,IAAA,EAAQ,EAAA;AAC1D,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,wCAAwC,cAAc,CAAA;AAEjE,EAAA,MAAM,yBAA4B,GAAA,OAChC,GACA,EAAA,GAAA,EACA,IACkB,KAAA;AAClB,IAAM,MAAA,EAAE,YAAa,EAAA,GAAI,GAAI,CAAA,MAAA;AAC7B,IAAM,MAAA,cAAA,GAAiB,WAAY,CAAA,eAAA,CAAgB,YAAY,CAAA;AAC/D,IAAA,IAAI,mBAAmB,SAAW,EAAA;AAChC,MAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,QACnB,KAAA,EAAO,kBAAkB,YAAY,CAAA,6BAAA;AAAA,OACtC,CAAA;AACD,MAAA;AAAA;AAEF,IAAK,IAAA,EAAA;AAAA,GACP;AAEA,EAAO,MAAA,CAAA,GAAA,CAAI,kBAAkB,yBAAyB,CAAA;AAEtD,EAAA,MAAA,CAAO,GAAI,CAAA,0CAAA,EAA4C,OAAO,GAAA,EAAK,GAAQ,KAAA;AACzE,IAAA,MAAM,EAAE,YAAA,EAAc,GAAK,EAAA,IAAA,KAAS,GAAI,CAAA,MAAA;AACxC,IAAA,MAAM,EAAE,IAAA,EAAM,KAAM,EAAA,GAAI,GAAI,CAAA,KAAA;AAE5B,IAAM,MAAA,IAAA,GAAO,MAAM,WAAY,CAAA,OAAA;AAAA,MAC7B,YAAA;AAAA,MACA,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,8DAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,YAAc,EAAA,GAAA,EAAK,IAAM,EAAA,MAAA,KAAW,GAAI,CAAA,MAAA;AAEhD,MAAM,MAAA,MAAA,GAAS,MAAM,WAAY,CAAA,SAAA;AAAA,QAC/B,YAAA;AAAA,QACA,GAAA;AAAA,QACA,IAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA;AAC7B,GACF;AAEA,EAAO,MAAA,CAAA,GAAA;AAAA,IACL,gEAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,YAAc,EAAA,GAAA,EAAK,IAAM,EAAA,MAAA,KAAW,GAAI,CAAA,MAAA;AAEhD,MAAM,MAAA,eAAA,GAAkB,MAAM,WAAY,CAAA,kBAAA;AAAA,QACxC,YAAA;AAAA,QACA,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,EAAO,MAAA,CAAA,GAAA;AAAA,IACL,uDAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,YAAc,EAAA,GAAA,EAAK,IAAM,EAAA,MAAA,KAAW,GAAI,CAAA,MAAA;AAEhD,MAAM,MAAA,QAAA,GAAW,MAAM,WAAY,CAAA,mBAAA;AAAA,QACjC,YAAA;AAAA,QACA,GAAA;AAAA,QACA,IAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,QAAQ,CAAA;AAAA;AAC/B,GACF;AAEA,EAAO,OAAA,MAAA;AACT;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-quay-backend",
3
- "version": "1.7.0",
3
+ "version": "1.9.0",
4
4
  "main": "dist/index.cjs.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -36,18 +36,18 @@
36
36
  "postpack": "backstage-cli package postpack"
37
37
  },
38
38
  "dependencies": {
39
- "@backstage-community/plugin-quay-common": "^1.12.0",
40
- "@backstage/backend-defaults": "^0.12.1",
41
- "@backstage/backend-plugin-api": "^1.4.3",
42
- "@backstage/config": "^1.3.3",
43
- "@backstage/plugin-catalog-node": "^1.19.0",
44
- "@backstage/plugin-permission-common": "^0.9.1",
45
- "@backstage/plugin-permission-node": "^0.10.4",
39
+ "@backstage-community/plugin-quay-common": "^1.14.0",
40
+ "@backstage/backend-defaults": "^0.13.0",
41
+ "@backstage/backend-plugin-api": "^1.4.4",
42
+ "@backstage/config": "^1.3.5",
43
+ "@backstage/plugin-catalog-node": "^1.19.1",
44
+ "@backstage/plugin-permission-common": "^0.9.2",
45
+ "@backstage/plugin-permission-node": "^0.10.5",
46
46
  "express": "^4.17.1",
47
47
  "express-promise-router": "^4.1.0"
48
48
  },
49
49
  "devDependencies": {
50
- "@backstage/cli": "^0.34.3",
50
+ "@backstage/cli": "^0.34.4",
51
51
  "@types/express": "^4.17.6",
52
52
  "@types/supertest": "^2.0.12",
53
53
  "supertest": "^6.2.4"