@axis-backstage/plugin-jira-dashboard-backend 4.9.0 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @axis-backstage/plugin-jira-dashboard-backend
 
+## 5.0.0
+
+### Major Changes
+
+- f8fb7ba: Added support for Jira Cloud API V3
+
+  Added useApiV3 configuration option to enable Jira REST API v3 support. The "/api/2/search"
+  API used by the Jira Data Center is deprecated and may not be available in Jira Cloud.
+
+  Configuration Changes:
+
+  Added optional useApiV3 boolean field to the Jira dashboard configuration
+  When useApiV3: true, API calls use the /search/jql endpoint instead of /search
+  When useApiV3: false or not specified, continues to use the existing v2 /search endpoint
+
+  Example configuration for Jira Cloud to use the v3 Api.
+
+  ```
+  jiraDashboard:
+  baseUrl: 'https://your-jira.atlassian.net/rest/api/3/'
+  token: 'your-token'
+  useApiV3: true
+  ```
+
+## 4.9.1
+
+### Patch Changes
+
+- Updated dependencies [276e489]
+  - @axis-backstage/plugin-jira-dashboard-common@1.14.1
+
 ## 4.9.0
 
 ### Minor Changes

package/README.md

@@ -47,6 +47,36 @@ jiraDashboard:
   annotationPrefix: jira
 ```
 
+### Jira API Version Configuration
+
+The plugin supports both Jira REST API v2 (default) and v3. You can enable API v3 by setting the `useApiV3` configuration option:
+
+```yaml
+jiraDashboard:
+  token: ${JIRA_TOKEN}
+  baseUrl: ${JIRA_BASE_URL}
+  useApiV3: true # Enable Jira API v3 (defaults to false)
+```
+
+#### API Version Differences:
+
+- **API v2 (default)**: Uses the `/search` endpoint for JQL queries
+- **API v3**: Uses the `/search/jql` endpoint for JQL queries
+
+When `useApiV3` is set to `true`, the plugin will use the v3 API endpoints. When `useApiV3` is `false` or not specified, the plugin will continue to use the v2 API endpoints for backward compatibility.
+
+#### Example with API v3:
+
+```yaml
+jiraDashboard:
+  token: Bearer <your-token>
+  baseUrl: https://your-domain.atlassian.net/rest/api/3/
+  useApiV3: true
+  userEmailSuffix: @your-company.com
+```
+
+**Note**: When using API v3, make sure your `baseUrl` also points to the v3 endpoint (e.g., `/rest/api/3/` instead of `/rest/api/2/`).
+
 ### Multiple Jira instances
 
 In case multiple Jira instances are being used, the configuration can be written on the form:
@@ -61,14 +91,18 @@ jiraDashboard:
       apiUrl: ${JIRA_API_URL} # Optional
       headers: {} # Optional
       userEmailSuffix: ${JIRA_EMAIL_SUFFIX} # Optional
+      useApiV3: false # Optional - defaults to false
     - name: separate-jira-instance
       token: ${JIRA_TOKEN_SEPARATE}
       baseUrl: ${JIRA_BASE_URL_SEPARATE}
       apiUrl: ${JIRA_API_URL_SEPARATE} # Optional
       headers: {} # Optional
       userEmailSuffix: ${JIRA_EMAIL_SUFFIX_SEPARATE} # Optional
+      useApiV3: true # Optional - enable API v3 for this instance
 ```
 
+Each instance can have its own `useApiV3` setting, allowing you to mix v2 and v3 API usage across different Jira instances.
+
 In entity yamls that don't specify an instance, the one called `"default"` will be used. To specify another instace, prefix the project key with `instance-name/` such as:
 
 ```yaml

package/config.d.ts

@@ -34,7 +34,7 @@ export interface Config {
         userEmailSuffix?: string;
 
         /**
-         * Optional annotation prefix for retrieving a custom annotation. Defaut value is jira.com
+         * Optional annotation prefix for retrieving a custom annotation. Default value is jira.com
          * @visibility frontend
          */
         annotationPrefix?: string;
@@ -48,12 +48,17 @@ export interface Config {
           shortName: string;
         }[];
 
+        /**
+         * Whether to use Jira API v3. Defaults to false for backward compatibility.
+         */
+        useApiV3?: boolean;
+
         // Type helper
         instances?: never;
       }
     | {
         /**
-         * Optional annotation prefix for retrieving a custom annotation. Defaut value is jira.com
+         * Optional annotation prefix for retrieving a custom annotation. Default value is jira.com
          * @visibility frontend
          */
         annotationPrefix?: string;
@@ -101,6 +106,11 @@ export interface Config {
             query: string;
             shortName: string;
           }[];
+
+          /**
+           * Whether to use Jira API v3. Defaults to false for backward compatibility.
+           */
+          useApiV3?: boolean;
         }[];
       };
 }

package/dist/api.cjs.js

@@ -47,21 +47,33 @@ const getFilterById = async (id, instance) => {
   const jsonResponse = await response.json();
   return { name: jsonResponse.name, query: jsonResponse.jql };
 };
+const getQueryUrl = (instance, jql) => {
+  const baseUrl = lib.getApiUrl(instance);
+  if (instance.useApiV3) {
+    const baseUrlWithEndpoint2 = `${baseUrl}search/jql`;
+    if (jql) {
+      return `${baseUrlWithEndpoint2}?jql=${jql}&fields=*all`;
+    }
+    return baseUrlWithEndpoint2;
+  }
+  const baseUrlWithEndpoint = `${baseUrl}search`;
+  if (jql) {
+    return `${baseUrlWithEndpoint}?jql=${jql}`;
+  }
+  return baseUrlWithEndpoint;
+};
 const getIssuesByFilter = async (projects, components, query) => {
   const issues = [];
   for (const project of projects) {
     const { projectKey, instance } = project;
     const jql = queries.jqlQueryBuilder({ project: [projectKey], components, query });
-    const response = await callApi(
-      instance,
-      `${lib.getApiUrl(instance)}search?jql=${jql}`,
-      {
-        method: "GET",
-        headers: {
-          Accept: "application/json"
-        }
+    const queryUrl = getQueryUrl(instance, jql);
+    const response = await callApi(instance, queryUrl, {
+      method: "GET",
+      headers: {
+        Accept: "application/json"
       }
-    ).then((resp) => resp.json()).catch(() => null);
+    }).then((resp) => resp.json()).catch(() => null);
     if (response?.errorMessages) {
       throw Error(
         `JQL returned Error: JQL -  ${jql} with error: ${response?.errorMessages?.[0]}`
@@ -75,9 +87,11 @@ const getIssuesByFilter = async (projects, components, query) => {
   return issues;
 };
 const searchJira = async (instance, jqlQuery, options) => {
-  const response = await callApi(instance, `${lib.getApiUrl(instance)}search`, {
+  const queryUrl = getQueryUrl(instance);
+  const requestBody = { jql: jqlQuery, ...options };
+  const response = await callApi(instance, queryUrl, {
     method: "POST",
-    body: JSON.stringify({ jql: jqlQuery, ...options }),
+    body: JSON.stringify(requestBody),
     headers: {
       Accept: "application/json",
       "Content-Type": "application/json"
@@ -103,16 +117,13 @@ const getIssuesByComponent = async (projects, componentKeys, query) => {
   });
   const { instance } = projects[0];
   try {
-    const response = await callApi(
-      instance,
-      `${lib.getApiUrl(instance)}search?jql=${jql}`,
-      {
-        method: "GET",
-        headers: {
-          Accept: "application/json"
-        }
+    const queryUrl = getQueryUrl(instance, jql);
+    const response = await callApi(instance, queryUrl, {
+      method: "GET",
+      headers: {
+        Accept: "application/json"
       }
-    ).then((resp) => resp.json());
+    }).then((resp) => resp.json());
     if (!response.issues || response.issues.length === 0) {
       return [];
     }
@@ -144,5 +155,6 @@ exports.getIssuesByComponent = getIssuesByComponent;
 exports.getIssuesByFilter = getIssuesByFilter;
 exports.getProjectAvatar = getProjectAvatar;
 exports.getProjectInfo = getProjectInfo;
+exports.getQueryUrl = getQueryUrl;
 exports.searchJira = searchJira;
 //# sourceMappingURL=api.cjs.js.map

package/dist/api.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.cjs.js","sources":["../src/api.ts"],"sourcesContent":["import fetch, { RequestInit } from 'node-fetch';\nimport {\n  Filter,\n  Issue,\n  Project,\n  JiraQueryResults,\n} from '@axis-backstage/plugin-jira-dashboard-common';\n\nimport type { ConfigInstance } from './config';\nimport { jqlQueryBuilder } from './queries';\nimport type { JiraProject } from './lib';\nimport { getApiUrl, replaceProjectApiUrl, replaceIssuesApiUrl } from './lib';\nimport { ResponseError } from '@backstage/errors';\n\nexport const getProjectInfo = async (\n  project: JiraProject,\n): Promise<Project> => {\n  const { projectKey, instance } = project;\n  const response = await callApi(\n    instance,\n    `${getApiUrl(instance)}project/${projectKey}`,\n    {\n      method: 'GET',\n      headers: {\n        Accept: 'application/json',\n      },\n    },\n  );\n  if (response.status !== 200) {\n    throw Error(\n      `Request failed with status code ${response.status}: ${response.statusText}`,\n    );\n  }\n\n  const projectResponse = await response.json();\n  replaceProjectApiUrl(project.instance, projectResponse);\n  return projectResponse;\n};\n\nexport const getFilterById = async (\n  id: string,\n  instance: ConfigInstance,\n): Promise<Filter> => {\n  const response = await callApi(\n    instance,\n    `${getApiUrl(instance)}filter/${id}`,\n    {\n      method: 'GET',\n      headers: {\n        Accept: 'application/json',\n      },\n    },\n  );\n  if (response.status !== 200) {\n    throw Error(`${response.status}`);\n  }\n  const jsonResponse = await response.json();\n  return { name: jsonResponse.name, query: jsonResponse.jql } as Filter;\n};\n\nexport const getIssuesByFilter = async (\n  projects: JiraProject[],\n  components: string[],\n  query: string,\n): Promise<Issue[]> => {\n  const issues: Issue[] = [];\n  for (const project of projects) {\n    const { projectKey, instance } = project;\n    const jql = jqlQueryBuilder({ project: [projectKey], components, query });\n    const response = await callApi(\n      instance,\n      `${getApiUrl(instance)}search?jql=${jql}`,\n      {\n        method: 'GET',\n        headers: {\n          Accept: 'application/json',\n        },\n      },\n    )\n      .then(resp => resp.json())\n      .catch(() => null);\n    if (response?.errorMessages) {\n      throw Error(\n        `JQL returned Error: JQL -  ${jql} with error: ${response?.errorMessages?.[0]}`,\n      );\n    }\n    if (response?.issues) {\n      replaceIssuesApiUrl(project.instance, response.issues);\n      issues.push(...response.issues);\n    }\n  }\n\n  return issues;\n};\n\n/**\n * Options available for the Jira JQL query.\n *\n * @public\n */\nexport type SearchOptions = {\n  expand?: string[];\n  fields?: string[];\n  fieldsByKey?: boolean;\n  properties?: string[];\n  startAt?: number;\n  maxResults?: number;\n  validateQuery?: string;\n};\n\n/**\n * Asynchronously searches for Jira issues using JQL.\n *\n * For more information about the available options, see the API documentation at:\n * https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-search/#api-rest-api-2-search-post\n *\n * @param config - A Backstage config\n * @param jqlQuery - A string containing the jql query.\n * @param options - Query options that will be passed on to the POST request.\n * @public\n */\nexport const searchJira = async (\n  instance: ConfigInstance,\n  jqlQuery: string,\n  options: SearchOptions,\n): Promise<JiraQueryResults> => {\n  const response = await callApi(instance, `${getApiUrl(instance)}search`, {\n    method: 'POST',\n    body: JSON.stringify({ jql: jqlQuery, ...options }),\n    headers: {\n      Accept: 'application/json',\n      'Content-Type': 'application/json',\n    },\n  });\n  if (!response.ok) {\n    throw await ResponseError.fromResponse(response);\n  }\n  const jsonResponse = (await response.json()) as JiraQueryResults;\n  replaceIssuesApiUrl(instance, jsonResponse.issues);\n  return jsonResponse;\n};\n\nexport const getIssuesByComponent = async (\n  projects: JiraProject[],\n  componentKeys: string,\n  query?: string,\n): Promise<Issue[]> => {\n  // Return an empty array if no projects are provided\n  if (projects.length === 0) {\n    return [];\n  }\n\n  const projectKeys = projects.map(project => project.projectKey);\n  const components = componentKeys\n    .split(',')\n    .map(component => component.trim());\n\n  const jql = jqlQueryBuilder({\n    project: projectKeys,\n    components,\n    query,\n  });\n\n  const { instance } = projects[0];\n\n  try {\n    const response = await callApi(\n      instance,\n      `${getApiUrl(instance)}search?jql=${jql}`,\n      {\n        method: 'GET',\n        headers: {\n          Accept: 'application/json',\n        },\n      },\n    ).then(resp => resp.json());\n\n    if (!response.issues || response.issues.length === 0) {\n      return [];\n    }\n\n    replaceIssuesApiUrl(instance, response.issues);\n    return response.issues;\n  } catch (error: any) {\n    if (error.message.includes(\"does not exist for the field 'project'\")) {\n      return [];\n    }\n    throw error;\n  }\n};\nexport async function getProjectAvatar(url: string, instance: ConfigInstance) {\n  return callApi(instance, url);\n}\n\n/**\n * Call the Jira API using fetch.\n *\n * This function injects the auth token and custom headers.\n *\n * @public\n */\nexport async function callApi(\n  instance: ConfigInstance,\n  url: string,\n  init?: RequestInit,\n) {\n  const requestInit = init ?? { method: 'GET' };\n\n  // Inject custom headers from config, Authorization token and headers from the\n  // request\n  requestInit.headers = {\n    ...instance.headers,\n    Authorization: instance.token,\n    ...requestInit.headers,\n  };\n  return fetch(url, requestInit);\n}\n"],"names":["getApiUrl","replaceProjectApiUrl","jqlQueryBuilder","replaceIssuesApiUrl","ResponseError","fetch"],"mappings":";;;;;;;;;;;AAca,MAAA,cAAA,GAAiB,OAC5B,OACqB,KAAA;AACrB,EAAM,MAAA,EAAE,UAAY,EAAA,QAAA,EAAa,GAAA,OAAA;AACjC,EAAA,MAAM,WAAW,MAAM,OAAA;AAAA,IACrB,QAAA;AAAA,IACA,CAAG,EAAAA,aAAA,CAAU,QAAQ,CAAC,WAAW,UAAU,CAAA,CAAA;AAAA,IAC3C;AAAA,MACE,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,MAAQ,EAAA;AAAA;AACV;AACF,GACF;AACA,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,IAAM,MAAA,KAAA;AAAA,MACJ,CAAmC,gCAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA;AAAA,KAC5E;AAAA;AAGF,EAAM,MAAA,eAAA,GAAkB,MAAM,QAAA,CAAS,IAAK,EAAA;AAC5C,EAAqBC,wBAAA,CAAA,OAAA,CAAQ,UAAU,eAAe,CAAA;AACtD,EAAO,OAAA,eAAA;AACT;AAEa,MAAA,aAAA,GAAgB,OAC3B,EAAA,EACA,QACoB,KAAA;AACpB,EAAA,MAAM,WAAW,MAAM,OAAA;AAAA,IACrB,QAAA;AAAA,IACA,CAAG,EAAAD,aAAA,CAAU,QAAQ,CAAC,UAAU,EAAE,CAAA,CAAA;AAAA,IAClC;AAAA,MACE,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,MAAQ,EAAA;AAAA;AACV;AACF,GACF;AACA,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,IAAA,MAAM,KAAM,CAAA,CAAA,EAAG,QAAS,CAAA,MAAM,CAAE,CAAA,CAAA;AAAA;AAElC,EAAM,MAAA,YAAA,GAAe,MAAM,QAAA,CAAS,IAAK,EAAA;AACzC,EAAA,OAAO,EAAE,IAAM,EAAA,YAAA,CAAa,IAAM,EAAA,KAAA,EAAO,aAAa,GAAI,EAAA;AAC5D;AAEO,MAAM,iBAAoB,GAAA,OAC/B,QACA,EAAA,UAAA,EACA,KACqB,KAAA;AACrB,EAAA,MAAM,SAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,WAAW,QAAU,EAAA;AAC9B,IAAM,MAAA,EAAE,UAAY,EAAA,QAAA,EAAa,GAAA,OAAA;AACjC,IAAM,MAAA,GAAA,GAAME,wBAAgB,EAAE,OAAA,EAAS,CAAC,UAAU,CAAA,EAAG,UAAY,EAAA,KAAA,EAAO,CAAA;AACxE,IAAA,MAAM,WAAW,MAAM,OAAA;AAAA,MACrB,QAAA;AAAA,MACA,CAAG,EAAAF,aAAA,CAAU,QAAQ,CAAC,cAAc,GAAG,CAAA,CAAA;AAAA,MACvC;AAAA,QACE,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,MAAQ,EAAA;AAAA;AACV;AACF,KACF,CACG,KAAK,CAAQ,IAAA,KAAA,IAAA,CAAK,MAAM,CAAA,CACxB,KAAM,CAAA,MAAM,IAAI,CAAA;AACnB,IAAA,IAAI,UAAU,aAAe,EAAA;AAC3B,MAAM,MAAA,KAAA;AAAA,QACJ,8BAA8B,GAAG,CAAA,aAAA,EAAgB,QAAU,EAAA,aAAA,GAAgB,CAAC,CAAC,CAAA;AAAA,OAC/E;AAAA;AAEF,IAAA,IAAI,UAAU,MAAQ,EAAA;AACpB,MAAoBG,uBAAA,CAAA,OAAA,CAAQ,QAAU,EAAA,QAAA,CAAS,MAAM,CAAA;AACrD,MAAO,MAAA,CAAA,IAAA,CAAK,GAAG,QAAA,CAAS,MAAM,CAAA;AAAA;AAChC;AAGF,EAAO,OAAA,MAAA;AACT;AA4BO,MAAM,UAAa,GAAA,OACxB,QACA,EAAA,QAAA,EACA,OAC8B,KAAA;AAC9B,EAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,QAAA,EAAU,GAAGH,aAAU,CAAA,QAAQ,CAAC,CAAU,MAAA,CAAA,EAAA;AAAA,IACvE,MAAQ,EAAA,MAAA;AAAA,IACR,IAAA,EAAM,KAAK,SAAU,CAAA,EAAE,KAAK,QAAU,EAAA,GAAG,SAAS,CAAA;AAAA,IAClD,OAAS,EAAA;AAAA,MACP,MAAQ,EAAA,kBAAA;AAAA,MACR,cAAgB,EAAA;AAAA;AAClB,GACD,CAAA;AACD,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAM,MAAA,MAAMI,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAEjD,EAAM,MAAA,YAAA,GAAgB,MAAM,QAAA,CAAS,IAAK,EAAA;AAC1C,EAAoBD,uBAAA,CAAA,QAAA,EAAU,aAAa,MAAM,CAAA;AACjD,EAAO,OAAA,YAAA;AACT;AAEO,MAAM,oBAAuB,GAAA,OAClC,QACA,EAAA,aAAA,EACA,KACqB,KAAA;AAErB,EAAI,IAAA,QAAA,CAAS,WAAW,CAAG,EAAA;AACzB,IAAA,OAAO,EAAC;AAAA;AAGV,EAAA,MAAM,WAAc,GAAA,QAAA,CAAS,GAAI,CAAA,CAAA,OAAA,KAAW,QAAQ,UAAU,CAAA;AAC9D,EAAM,MAAA,UAAA,GAAa,cAChB,KAAM,CAAA,GAAG,EACT,GAAI,CAAA,CAAA,SAAA,KAAa,SAAU,CAAA,IAAA,EAAM,CAAA;AAEpC,EAAA,MAAM,MAAMD,uBAAgB,CAAA;AAAA,IAC1B,OAAS,EAAA,WAAA;AAAA,IACT,UAAA;AAAA,IACA;AAAA,GACD,CAAA;AAED,EAAA,MAAM,EAAE,QAAA,EAAa,GAAA,QAAA,CAAS,CAAC,CAAA;AAE/B,EAAI,IAAA;AACF,IAAA,MAAM,WAAW,MAAM,OAAA;AAAA,MACrB,QAAA;AAAA,MACA,CAAG,EAAAF,aAAA,CAAU,QAAQ,CAAC,cAAc,GAAG,CAAA,CAAA;AAAA,MACvC;AAAA,QACE,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,MAAQ,EAAA;AAAA;AACV;AACF,KACA,CAAA,IAAA,CAAK,CAAQ,IAAA,KAAA,IAAA,CAAK,MAAM,CAAA;AAE1B,IAAA,IAAI,CAAC,QAAS,CAAA,MAAA,IAAU,QAAS,CAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACpD,MAAA,OAAO,EAAC;AAAA;AAGV,IAAoBG,uBAAA,CAAA,QAAA,EAAU,SAAS,MAAM,CAAA;AAC7C,IAAA,OAAO,QAAS,CAAA,MAAA;AAAA,WACT,KAAY,EAAA;AACnB,IAAA,IAAI,KAAM,CAAA,OAAA,CAAQ,QAAS,CAAA,wCAAwC,CAAG,EAAA;AACpE,MAAA,OAAO,EAAC;AAAA;AAEV,IAAM,MAAA,KAAA;AAAA;AAEV;AACsB,eAAA,gBAAA,CAAiB,KAAa,QAA0B,EAAA;AAC5E,EAAO,OAAA,OAAA,CAAQ,UAAU,GAAG,CAAA;AAC9B;AASsB,eAAA,OAAA,CACpB,QACA,EAAA,GAAA,EACA,IACA,EAAA;AACA,EAAA,MAAM,WAAc,GAAA,IAAA,IAAQ,EAAE,MAAA,EAAQ,KAAM,EAAA;AAI5C,EAAA,WAAA,CAAY,OAAU,GAAA;AAAA,IACpB,GAAG,QAAS,CAAA,OAAA;AAAA,IACZ,eAAe,QAAS,CAAA,KAAA;AAAA,IACxB,GAAG,WAAY,CAAA;AAAA,GACjB;AACA,EAAO,OAAAE,sBAAA,CAAM,KAAK,WAAW,CAAA;AAC/B;;;;;;;;;;"}
+{"version":3,"file":"api.cjs.js","sources":["../src/api.ts"],"sourcesContent":["import fetch, { RequestInit } from 'node-fetch';\nimport {\n  Filter,\n  Issue,\n  Project,\n  JiraQueryResults,\n} from '@axis-backstage/plugin-jira-dashboard-common';\n\nimport type { ConfigInstance } from './config';\nimport { jqlQueryBuilder } from './queries';\nimport type { JiraProject } from './lib';\nimport { getApiUrl, replaceProjectApiUrl, replaceIssuesApiUrl } from './lib';\nimport { ResponseError } from '@backstage/errors';\n\nexport const getProjectInfo = async (\n  project: JiraProject,\n): Promise<Project> => {\n  const { projectKey, instance } = project;\n  const response = await callApi(\n    instance,\n    `${getApiUrl(instance)}project/${projectKey}`,\n    {\n      method: 'GET',\n      headers: {\n        Accept: 'application/json',\n      },\n    },\n  );\n  if (response.status !== 200) {\n    throw Error(\n      `Request failed with status code ${response.status}: ${response.statusText}`,\n    );\n  }\n\n  const projectResponse = await response.json();\n  replaceProjectApiUrl(project.instance, projectResponse);\n  return projectResponse;\n};\n\nexport const getFilterById = async (\n  id: string,\n  instance: ConfigInstance,\n): Promise<Filter> => {\n  const response = await callApi(\n    instance,\n    `${getApiUrl(instance)}filter/${id}`,\n    {\n      method: 'GET',\n      headers: {\n        Accept: 'application/json',\n      },\n    },\n  );\n  if (response.status !== 200) {\n    throw Error(`${response.status}`);\n  }\n  const jsonResponse = await response.json();\n  return { name: jsonResponse.name, query: jsonResponse.jql } as Filter;\n};\n\nexport const getQueryUrl = (instance: ConfigInstance, jql?: string): string => {\n  const baseUrl = getApiUrl(instance);\n\n  if (instance.useApiV3) {\n    const baseUrlWithEndpoint = `${baseUrl}search/jql`;\n    if (jql) {\n      return `${baseUrlWithEndpoint}?jql=${jql}&fields=*all`;\n    }\n    return baseUrlWithEndpoint;\n  }\n\n  const baseUrlWithEndpoint = `${baseUrl}search`;\n  if (jql) {\n    return `${baseUrlWithEndpoint}?jql=${jql}`;\n  }\n  return baseUrlWithEndpoint;\n};\n\nexport const getIssuesByFilter = async (\n  projects: JiraProject[],\n  components: string[],\n  query: string,\n): Promise<Issue[]> => {\n  const issues: Issue[] = [];\n  for (const project of projects) {\n    const { projectKey, instance } = project;\n    const jql = jqlQueryBuilder({ project: [projectKey], components, query });\n    const queryUrl = getQueryUrl(instance, jql);\n    const response = await callApi(instance, queryUrl, {\n      method: 'GET',\n      headers: {\n        Accept: 'application/json',\n      },\n    })\n      .then(resp => resp.json())\n      .catch(() => null);\n    if (response?.errorMessages) {\n      throw Error(\n        `JQL returned Error: JQL -  ${jql} with error: ${response?.errorMessages?.[0]}`,\n      );\n    }\n    if (response?.issues) {\n      replaceIssuesApiUrl(project.instance, response.issues);\n      issues.push(...response.issues);\n    }\n  }\n\n  return issues;\n};\n\n/**\n * Options available for the Jira JQL query.\n *\n * @public\n */\nexport type SearchOptions = {\n  expand?: string[];\n  fields?: string[];\n  fieldsByKey?: boolean;\n  properties?: string[];\n  startAt?: number;\n  maxResults?: number;\n  validateQuery?: string;\n};\n\n/**\n * Asynchronously searches for Jira issues using JQL.\n *\n * For more information about the available options, see the API documentation at:\n * https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-search/#api-rest-api-2-search-post\n *\n * @param config - A Backstage config\n * @param jqlQuery - A string containing the jql query.\n * @param options - Query options that will be passed on to the POST request.\n * @public\n */\nexport const searchJira = async (\n  instance: ConfigInstance,\n  jqlQuery: string,\n  options: SearchOptions,\n): Promise<JiraQueryResults> => {\n  const queryUrl = getQueryUrl(instance);\n  const requestBody = { jql: jqlQuery, ...options };\n\n  const response = await callApi(instance, queryUrl, {\n    method: 'POST',\n    body: JSON.stringify(requestBody),\n    headers: {\n      Accept: 'application/json',\n      'Content-Type': 'application/json',\n    },\n  });\n  if (!response.ok) {\n    throw await ResponseError.fromResponse(response);\n  }\n  const jsonResponse = (await response.json()) as JiraQueryResults;\n  replaceIssuesApiUrl(instance, jsonResponse.issues);\n  return jsonResponse;\n};\n\nexport const getIssuesByComponent = async (\n  projects: JiraProject[],\n  componentKeys: string,\n  query?: string,\n): Promise<Issue[]> => {\n  // Return an empty array if no projects are provided\n  if (projects.length === 0) {\n    return [];\n  }\n\n  const projectKeys = projects.map(project => project.projectKey);\n  const components = componentKeys\n    .split(',')\n    .map(component => component.trim());\n\n  const jql = jqlQueryBuilder({\n    project: projectKeys,\n    components,\n    query,\n  });\n\n  const { instance } = projects[0];\n\n  try {\n    const queryUrl = getQueryUrl(instance, jql);\n    const response = await callApi(instance, queryUrl, {\n      method: 'GET',\n      headers: {\n        Accept: 'application/json',\n      },\n    }).then(resp => resp.json());\n\n    if (!response.issues || response.issues.length === 0) {\n      return [];\n    }\n\n    replaceIssuesApiUrl(instance, response.issues);\n    return response.issues;\n  } catch (error: any) {\n    if (error.message.includes(\"does not exist for the field 'project'\")) {\n      return [];\n    }\n    throw error;\n  }\n};\nexport async function getProjectAvatar(url: string, instance: ConfigInstance) {\n  return callApi(instance, url);\n}\n\n/**\n * Call the Jira API using fetch.\n *\n * This function injects the auth token and custom headers.\n *\n * @public\n */\nexport async function callApi(\n  instance: ConfigInstance,\n  url: string,\n  init?: RequestInit,\n) {\n  const requestInit = init ?? { method: 'GET' };\n\n  // Inject custom headers from config, Authorization token and headers from the\n  // request\n  requestInit.headers = {\n    ...instance.headers,\n    Authorization: instance.token,\n    ...requestInit.headers,\n  };\n  return fetch(url, requestInit);\n}\n"],"names":["getApiUrl","replaceProjectApiUrl","baseUrlWithEndpoint","jqlQueryBuilder","replaceIssuesApiUrl","ResponseError","fetch"],"mappings":";;;;;;;;;;;AAca,MAAA,cAAA,GAAiB,OAC5B,OACqB,KAAA;AACrB,EAAM,MAAA,EAAE,UAAY,EAAA,QAAA,EAAa,GAAA,OAAA;AACjC,EAAA,MAAM,WAAW,MAAM,OAAA;AAAA,IACrB,QAAA;AAAA,IACA,CAAG,EAAAA,aAAA,CAAU,QAAQ,CAAC,WAAW,UAAU,CAAA,CAAA;AAAA,IAC3C;AAAA,MACE,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,MAAQ,EAAA;AAAA;AACV;AACF,GACF;AACA,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,IAAM,MAAA,KAAA;AAAA,MACJ,CAAmC,gCAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA;AAAA,KAC5E;AAAA;AAGF,EAAM,MAAA,eAAA,GAAkB,MAAM,QAAA,CAAS,IAAK,EAAA;AAC5C,EAAqBC,wBAAA,CAAA,OAAA,CAAQ,UAAU,eAAe,CAAA;AACtD,EAAO,OAAA,eAAA;AACT;AAEa,MAAA,aAAA,GAAgB,OAC3B,EAAA,EACA,QACoB,KAAA;AACpB,EAAA,MAAM,WAAW,MAAM,OAAA;AAAA,IACrB,QAAA;AAAA,IACA,CAAG,EAAAD,aAAA,CAAU,QAAQ,CAAC,UAAU,EAAE,CAAA,CAAA;AAAA,IAClC;AAAA,MACE,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,MAAQ,EAAA;AAAA;AACV;AACF,GACF;AACA,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,IAAA,MAAM,KAAM,CAAA,CAAA,EAAG,QAAS,CAAA,MAAM,CAAE,CAAA,CAAA;AAAA;AAElC,EAAM,MAAA,YAAA,GAAe,MAAM,QAAA,CAAS,IAAK,EAAA;AACzC,EAAA,OAAO,EAAE,IAAM,EAAA,YAAA,CAAa,IAAM,EAAA,KAAA,EAAO,aAAa,GAAI,EAAA;AAC5D;AAEa,MAAA,WAAA,GAAc,CAAC,QAAA,EAA0B,GAAyB,KAAA;AAC7E,EAAM,MAAA,OAAA,GAAUA,cAAU,QAAQ,CAAA;AAElC,EAAA,IAAI,SAAS,QAAU,EAAA;AACrB,IAAME,MAAAA,oBAAAA,GAAsB,GAAG,OAAO,CAAA,UAAA,CAAA;AACtC,IAAA,IAAI,GAAK,EAAA;AACP,MAAO,OAAA,CAAA,EAAGA,oBAAmB,CAAA,KAAA,EAAQ,GAAG,CAAA,YAAA,CAAA;AAAA;AAE1C,IAAOA,OAAAA,oBAAAA;AAAA;AAGT,EAAM,MAAA,mBAAA,GAAsB,GAAG,OAAO,CAAA,MAAA,CAAA;AACtC,EAAA,IAAI,GAAK,EAAA;AACP,IAAO,OAAA,CAAA,EAAG,mBAAmB,CAAA,KAAA,EAAQ,GAAG,CAAA,CAAA;AAAA;AAE1C,EAAO,OAAA,mBAAA;AACT;AAEO,MAAM,iBAAoB,GAAA,OAC/B,QACA,EAAA,UAAA,EACA,KACqB,KAAA;AACrB,EAAA,MAAM,SAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,WAAW,QAAU,EAAA;AAC9B,IAAM,MAAA,EAAE,UAAY,EAAA,QAAA,EAAa,GAAA,OAAA;AACjC,IAAM,MAAA,GAAA,GAAMC,wBAAgB,EAAE,OAAA,EAAS,CAAC,UAAU,CAAA,EAAG,UAAY,EAAA,KAAA,EAAO,CAAA;AACxE,IAAM,MAAA,QAAA,GAAW,WAAY,CAAA,QAAA,EAAU,GAAG,CAAA;AAC1C,IAAA,MAAM,QAAW,GAAA,MAAM,OAAQ,CAAA,QAAA,EAAU,QAAU,EAAA;AAAA,MACjD,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,MAAQ,EAAA;AAAA;AACV,KACD,CACE,CAAA,IAAA,CAAK,CAAQ,IAAA,KAAA,IAAA,CAAK,MAAM,CAAA,CACxB,KAAM,CAAA,MAAM,IAAI,CAAA;AACnB,IAAA,IAAI,UAAU,aAAe,EAAA;AAC3B,MAAM,MAAA,KAAA;AAAA,QACJ,8BAA8B,GAAG,CAAA,aAAA,EAAgB,QAAU,EAAA,aAAA,GAAgB,CAAC,CAAC,CAAA;AAAA,OAC/E;AAAA;AAEF,IAAA,IAAI,UAAU,MAAQ,EAAA;AACpB,MAAoBC,uBAAA,CAAA,OAAA,CAAQ,QAAU,EAAA,QAAA,CAAS,MAAM,CAAA;AACrD,MAAO,MAAA,CAAA,IAAA,CAAK,GAAG,QAAA,CAAS,MAAM,CAAA;AAAA;AAChC;AAGF,EAAO,OAAA,MAAA;AACT;AA4BO,MAAM,UAAa,GAAA,OACxB,QACA,EAAA,QAAA,EACA,OAC8B,KAAA;AAC9B,EAAM,MAAA,QAAA,GAAW,YAAY,QAAQ,CAAA;AACrC,EAAA,MAAM,WAAc,GAAA,EAAE,GAAK,EAAA,QAAA,EAAU,GAAG,OAAQ,EAAA;AAEhD,EAAA,MAAM,QAAW,GAAA,MAAM,OAAQ,CAAA,QAAA,EAAU,QAAU,EAAA;AAAA,IACjD,MAAQ,EAAA,MAAA;AAAA,IACR,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,IAChC,OAAS,EAAA;AAAA,MACP,MAAQ,EAAA,kBAAA;AAAA,MACR,cAAgB,EAAA;AAAA;AAClB,GACD,CAAA;AACD,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAEjD,EAAM,MAAA,YAAA,GAAgB,MAAM,QAAA,CAAS,IAAK,EAAA;AAC1C,EAAoBD,uBAAA,CAAA,QAAA,EAAU,aAAa,MAAM,CAAA;AACjD,EAAO,OAAA,YAAA;AACT;AAEO,MAAM,oBAAuB,GAAA,OAClC,QACA,EAAA,aAAA,EACA,KACqB,KAAA;AAErB,EAAI,IAAA,QAAA,CAAS,WAAW,CAAG,EAAA;AACzB,IAAA,OAAO,EAAC;AAAA;AAGV,EAAA,MAAM,WAAc,GAAA,QAAA,CAAS,GAAI,CAAA,CAAA,OAAA,KAAW,QAAQ,UAAU,CAAA;AAC9D,EAAM,MAAA,UAAA,GAAa,cAChB,KAAM,CAAA,GAAG,EACT,GAAI,CAAA,CAAA,SAAA,KAAa,SAAU,CAAA,IAAA,EAAM,CAAA;AAEpC,EAAA,MAAM,MAAMD,uBAAgB,CAAA;AAAA,IAC1B,OAAS,EAAA,WAAA;AAAA,IACT,UAAA;AAAA,IACA;AAAA,GACD,CAAA;AAED,EAAA,MAAM,EAAE,QAAA,EAAa,GAAA,QAAA,CAAS,CAAC,CAAA;AAE/B,EAAI,IAAA;AACF,IAAM,MAAA,QAAA,GAAW,WAAY,CAAA,QAAA,EAAU,GAAG,CAAA;AAC1C,IAAA,MAAM,QAAW,GAAA,MAAM,OAAQ,CAAA,QAAA,EAAU,QAAU,EAAA;AAAA,MACjD,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,MAAQ,EAAA;AAAA;AACV,KACD,CAAE,CAAA,IAAA,CAAK,CAAQ,IAAA,KAAA,IAAA,CAAK,MAAM,CAAA;AAE3B,IAAA,IAAI,CAAC,QAAS,CAAA,MAAA,IAAU,QAAS,CAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACpD,MAAA,OAAO,EAAC;AAAA;AAGV,IAAoBC,uBAAA,CAAA,QAAA,EAAU,SAAS,MAAM,CAAA;AAC7C,IAAA,OAAO,QAAS,CAAA,MAAA;AAAA,WACT,KAAY,EAAA;AACnB,IAAA,IAAI,KAAM,CAAA,OAAA,CAAQ,QAAS,CAAA,wCAAwC,CAAG,EAAA;AACpE,MAAA,OAAO,EAAC;AAAA;AAEV,IAAM,MAAA,KAAA;AAAA;AAEV;AACsB,eAAA,gBAAA,CAAiB,KAAa,QAA0B,EAAA;AAC5E,EAAO,OAAA,OAAA,CAAQ,UAAU,GAAG,CAAA;AAC9B;AASsB,eAAA,OAAA,CACpB,QACA,EAAA,GAAA,EACA,IACA,EAAA;AACA,EAAA,MAAM,WAAc,GAAA,IAAA,IAAQ,EAAE,MAAA,EAAQ,KAAM,EAAA;AAI5C,EAAA,WAAA,CAAY,OAAU,GAAA;AAAA,IACpB,GAAG,QAAS,CAAA,OAAA;AAAA,IACZ,eAAe,QAAS,CAAA,KAAA;AAAA,IACxB,GAAG,WAAY,CAAA;AAAA,GACjB;AACA,EAAO,OAAAE,sBAAA,CAAM,KAAK,WAAW,CAAA;AAC/B;;;;;;;;;;;"}

package/dist/config.cjs.js

@@ -20,6 +20,7 @@ const JIRA_CONFIG_HEADERS = "headers";
 const JIRA_CONFIG_USER_EMAIL_SUFFIX = "userEmailSuffix";
 const JIRA_CONFIG_ANNOTATION = "annotationPrefix";
 const JIRA_FILTERS = "defaultFilters";
+const JIRA_CONFIG_USE_API_V3 = "useApiV3";
 class JiraConfig {
   instances = {};
   /**
@@ -50,7 +51,8 @@ class JiraConfig {
             name: filterConfig.getString("name"),
             shortName: filterConfig.getString("shortName"),
             query: filterConfig.getString("query")
-          }))
+          })),
+          useApiV3: inst.getOptionalBoolean(JIRA_CONFIG_USE_API_V3) ?? false
         };
       });
     } else {
@@ -64,7 +66,8 @@ class JiraConfig {
           name: filterConfig.getString("name"),
           shortName: filterConfig.getString("shortName"),
           query: filterConfig.getString("query")
-        }))
+        })),
+        useApiV3: jira.getOptionalBoolean(JIRA_CONFIG_USE_API_V3) ?? false
       };
     }
   }

package/dist/config.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.cjs.js","sources":["../src/config.ts"],"sourcesContent":["import { ConflictError, ServiceUnavailableError } from '@backstage/errors';\nimport { RootConfigService } from '@backstage/backend-plugin-api';\nimport { Filter } from '@axis-backstage/plugin-jira-dashboard-common';\n\ntype Config = ReturnType<RootConfigService['getConfig']>;\n\nfunction parseHeaders(config: Config | undefined): Record<string, string> {\n  if (!config) {\n    return {};\n  }\n  return Object.fromEntries(\n    config.keys().map(key => {\n      const value = config.getString(key);\n      return [key, value] as const;\n    }),\n  );\n}\n\n/**\n * The configuration of a Jira instance\n *\n * @public\n */\nexport type ConfigInstance = {\n  token: string;\n  headers: Record<string, string>;\n  baseUrl: string;\n  apiUrl?: string;\n  userEmailSuffix?: string;\n  defaultFilters?: Filter[];\n};\n\nconst JIRA_CONFIG_BASE_URL = 'baseUrl';\nconst JIRA_CONFIG_API_URL = 'apiUrl';\nconst JIRA_CONFIG_TOKEN = 'token';\nconst JIRA_CONFIG_HEADERS = 'headers';\nconst JIRA_CONFIG_USER_EMAIL_SUFFIX = 'userEmailSuffix';\nconst JIRA_CONFIG_ANNOTATION = 'annotationPrefix';\nconst JIRA_FILTERS = 'defaultFilters';\n\n/**\n * Class for reading Jira configuration from the root config\n *\n * @public\n */\nexport class JiraConfig {\n  private instances: Record<string, ConfigInstance> = {};\n  /**\n   * The annotation prefix to use for Jira annotations\n   */\n  public readonly annotationPrefix: string;\n\n  private constructor(config: RootConfigService) {\n    const jira = config.getConfig('jiraDashboard');\n\n    this.annotationPrefix =\n      jira.getOptionalString(JIRA_CONFIG_ANNOTATION) ?? 'jira.com';\n\n    const instances = jira.getOptionalConfigArray('instances');\n    if (instances) {\n      // Multiple instances form\n      instances.forEach(inst => {\n        const name = inst.getString('name');\n        if (Object.getOwnPropertyNames(this.instances).includes(name)) {\n          throw new ConflictError(\n            `Duplicate jiraDashboard instances: '${name}'`,\n          );\n        }\n\n        this.instances[name] = {\n          token: inst.getString(JIRA_CONFIG_TOKEN),\n          headers: parseHeaders(inst.getOptionalConfig(JIRA_CONFIG_HEADERS)),\n          baseUrl: inst.getString(JIRA_CONFIG_BASE_URL),\n          apiUrl: inst.getOptionalString(JIRA_CONFIG_API_URL),\n          userEmailSuffix: inst.getOptionalString(\n            JIRA_CONFIG_USER_EMAIL_SUFFIX,\n          ),\n          defaultFilters: inst\n            .getOptionalConfigArray(JIRA_FILTERS)\n            ?.map(filterConfig => ({\n              name: filterConfig.getString('name'),\n              shortName: filterConfig.getString('shortName'),\n              query: filterConfig.getString('query'),\n            })),\n        };\n      });\n    } else {\n      // Default form\n      this.instances.default = {\n        token: jira.getString(JIRA_CONFIG_TOKEN),\n        headers: parseHeaders(jira.getOptionalConfig(JIRA_CONFIG_HEADERS)),\n        baseUrl: jira.getString(JIRA_CONFIG_BASE_URL),\n        apiUrl: jira.getOptionalString(JIRA_CONFIG_API_URL),\n        userEmailSuffix: jira.getOptionalString(JIRA_CONFIG_USER_EMAIL_SUFFIX),\n        defaultFilters: jira\n          .getOptionalConfigArray(JIRA_FILTERS)\n          ?.map(filterConfig => ({\n            name: filterConfig.getString('name'),\n            shortName: filterConfig.getString('shortName'),\n            query: filterConfig.getString('query'),\n          })),\n      };\n    }\n  }\n\n  /**\n   * Create a JiraConfig from the root config\n   */\n  public static fromConfig(config: RootConfigService): JiraConfig {\n    return new JiraConfig(config);\n  }\n\n  private forInstance(instanceName: string) {\n    const instance = this.instances[instanceName];\n    if (!instance) {\n      throw new ServiceUnavailableError(\n        `No such jira instance '${instanceName}'`,\n      );\n    }\n    return instance;\n  }\n\n  /**\n   * Returns the configuration all instances\n   */\n  getInstances() {\n    return Object.getOwnPropertyNames(this.instances);\n  }\n\n  /**\n   * Get the jira config for a specific instance\n   */\n  getInstance(instanceName?: string): ConfigInstance {\n    return this.forInstance(instanceName ?? 'default');\n  }\n\n  /**\n   * Get the jira base url for a given instance\n   */\n  resolveJiraBaseUrl(instanceName: string): string {\n    const instance = this.forInstance(instanceName);\n    return instance.baseUrl;\n  }\n\n  /**\n   * Get the auth token for a given instance\n   */\n  resolveJiraToken(instanceName: string): string {\n    const instance = this.forInstance(instanceName);\n    return instance.token;\n  }\n\n  /**\n   * Get the email suffice for a given instance\n   */\n  resolveUserEmailSuffix(instanceName: string): string | undefined {\n    const instance = this.forInstance(instanceName);\n    return instance.userEmailSuffix;\n  }\n\n  /**\n   * Get the defined default filters for a given instance\n   */\n  resolveDefaultFilters(instanceName: string): Filter[] | undefined {\n    const instance = this.forInstance(instanceName);\n    return instance.defaultFilters;\n  }\n}\n"],"names":["ConflictError","ServiceUnavailableError"],"mappings":";;;;AAMA,SAAS,aAAa,MAAoD,EAAA;AACxE,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,OAAO,EAAC;AAAA;AAEV,EAAA,OAAO,MAAO,CAAA,WAAA;AAAA,IACZ,MAAO,CAAA,IAAA,EAAO,CAAA,GAAA,CAAI,CAAO,GAAA,KAAA;AACvB,MAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,GAAG,CAAA;AAClC,MAAO,OAAA,CAAC,KAAK,KAAK,CAAA;AAAA,KACnB;AAAA,GACH;AACF;AAgBA,MAAM,oBAAuB,GAAA,SAAA;AAC7B,MAAM,mBAAsB,GAAA,QAAA;AAC5B,MAAM,iBAAoB,GAAA,OAAA;AAC1B,MAAM,mBAAsB,GAAA,SAAA;AAC5B,MAAM,6BAAgC,GAAA,iBAAA;AACtC,MAAM,sBAAyB,GAAA,kBAAA;AAC/B,MAAM,YAAe,GAAA,gBAAA;AAOd,MAAM,UAAW,CAAA;AAAA,EACd,YAA4C,EAAC;AAAA;AAAA;AAAA;AAAA,EAIrC,gBAAA;AAAA,EAER,YAAY,MAA2B,EAAA;AAC7C,IAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,eAAe,CAAA;AAE7C,IAAA,IAAA,CAAK,gBACH,GAAA,IAAA,CAAK,iBAAkB,CAAA,sBAAsB,CAAK,IAAA,UAAA;AAEpD,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,sBAAA,CAAuB,WAAW,CAAA;AACzD,IAAA,IAAI,SAAW,EAAA;AAEb,MAAA,SAAA,CAAU,QAAQ,CAAQ,IAAA,KAAA;AACxB,QAAM,MAAA,IAAA,GAAO,IAAK,CAAA,SAAA,CAAU,MAAM,CAAA;AAClC,QAAA,IAAI,OAAO,mBAAoB,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,QAAA,CAAS,IAAI,CAAG,EAAA;AAC7D,UAAA,MAAM,IAAIA,oBAAA;AAAA,YACR,uCAAuC,IAAI,CAAA,CAAA;AAAA,WAC7C;AAAA;AAGF,QAAK,IAAA,CAAA,SAAA,CAAU,IAAI,CAAI,GAAA;AAAA,UACrB,KAAA,EAAO,IAAK,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,UACvC,OAAS,EAAA,YAAA,CAAa,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAC,CAAA;AAAA,UACjE,OAAA,EAAS,IAAK,CAAA,SAAA,CAAU,oBAAoB,CAAA;AAAA,UAC5C,MAAA,EAAQ,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,UAClD,iBAAiB,IAAK,CAAA,iBAAA;AAAA,YACpB;AAAA,WACF;AAAA,UACA,gBAAgB,IACb,CAAA,sBAAA,CAAuB,YAAY,CAAA,EAClC,IAAI,CAAiB,YAAA,MAAA;AAAA,YACrB,IAAA,EAAM,YAAa,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,YACnC,SAAA,EAAW,YAAa,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,YAC7C,KAAA,EAAO,YAAa,CAAA,SAAA,CAAU,OAAO;AAAA,WACrC,CAAA;AAAA,SACN;AAAA,OACD,CAAA;AAAA,KACI,MAAA;AAEL,MAAA,IAAA,CAAK,UAAU,OAAU,GAAA;AAAA,QACvB,KAAA,EAAO,IAAK,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,QACvC,OAAS,EAAA,YAAA,CAAa,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAC,CAAA;AAAA,QACjE,OAAA,EAAS,IAAK,CAAA,SAAA,CAAU,oBAAoB,CAAA;AAAA,QAC5C,MAAA,EAAQ,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,QAClD,eAAA,EAAiB,IAAK,CAAA,iBAAA,CAAkB,6BAA6B,CAAA;AAAA,QACrE,gBAAgB,IACb,CAAA,sBAAA,CAAuB,YAAY,CAAA,EAClC,IAAI,CAAiB,YAAA,MAAA;AAAA,UACrB,IAAA,EAAM,YAAa,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,UACnC,SAAA,EAAW,YAAa,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,UAC7C,KAAA,EAAO,YAAa,CAAA,SAAA,CAAU,OAAO;AAAA,SACrC,CAAA;AAAA,OACN;AAAA;AACF;AACF;AAAA;AAAA;AAAA,EAKA,OAAc,WAAW,MAAuC,EAAA;AAC9D,IAAO,OAAA,IAAI,WAAW,MAAM,CAAA;AAAA;AAC9B,EAEQ,YAAY,YAAsB,EAAA;AACxC,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,SAAA,CAAU,YAAY,CAAA;AAC5C,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAIC,8BAAA;AAAA,QACR,0BAA0B,YAAY,CAAA,CAAA;AAAA,OACxC;AAAA;AAEF,IAAO,OAAA,QAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,YAAe,GAAA;AACb,IAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,IAAA,CAAK,SAAS,CAAA;AAAA;AAClD;AAAA;AAAA;AAAA,EAKA,YAAY,YAAuC,EAAA;AACjD,IAAO,OAAA,IAAA,CAAK,WAAY,CAAA,YAAA,IAAgB,SAAS,CAAA;AAAA;AACnD;AAAA;AAAA;AAAA,EAKA,mBAAmB,YAA8B,EAAA;AAC/C,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,OAAA;AAAA;AAClB;AAAA;AAAA;AAAA,EAKA,iBAAiB,YAA8B,EAAA;AAC7C,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,KAAA;AAAA;AAClB;AAAA;AAAA;AAAA,EAKA,uBAAuB,YAA0C,EAAA;AAC/D,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,eAAA;AAAA;AAClB;AAAA;AAAA;AAAA,EAKA,sBAAsB,YAA4C,EAAA;AAChE,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,cAAA;AAAA;AAEpB;;;;"}
+{"version":3,"file":"config.cjs.js","sources":["../src/config.ts"],"sourcesContent":["import { ConflictError, ServiceUnavailableError } from '@backstage/errors';\nimport { RootConfigService } from '@backstage/backend-plugin-api';\nimport { Filter } from '@axis-backstage/plugin-jira-dashboard-common';\n\ntype Config = ReturnType<RootConfigService['getConfig']>;\n\nfunction parseHeaders(config: Config | undefined): Record<string, string> {\n  if (!config) {\n    return {};\n  }\n  return Object.fromEntries(\n    config.keys().map(key => {\n      const value = config.getString(key);\n      return [key, value] as const;\n    }),\n  );\n}\n\n/**\n * The configuration of a Jira instance\n *\n * @public\n */\nexport type ConfigInstance = {\n  token: string;\n  headers: Record<string, string>;\n  baseUrl: string;\n  apiUrl?: string;\n  userEmailSuffix?: string;\n  defaultFilters?: Filter[];\n  useApiV3?: boolean;\n};\n\nconst JIRA_CONFIG_BASE_URL = 'baseUrl';\nconst JIRA_CONFIG_API_URL = 'apiUrl';\nconst JIRA_CONFIG_TOKEN = 'token';\nconst JIRA_CONFIG_HEADERS = 'headers';\nconst JIRA_CONFIG_USER_EMAIL_SUFFIX = 'userEmailSuffix';\nconst JIRA_CONFIG_ANNOTATION = 'annotationPrefix';\nconst JIRA_FILTERS = 'defaultFilters';\nconst JIRA_CONFIG_USE_API_V3 = 'useApiV3';\n\n/**\n * Class for reading Jira configuration from the root config\n *\n * @public\n */\nexport class JiraConfig {\n  private instances: Record<string, ConfigInstance> = {};\n  /**\n   * The annotation prefix to use for Jira annotations\n   */\n  public readonly annotationPrefix: string;\n\n  private constructor(config: RootConfigService) {\n    const jira = config.getConfig('jiraDashboard');\n\n    this.annotationPrefix =\n      jira.getOptionalString(JIRA_CONFIG_ANNOTATION) ?? 'jira.com';\n\n    const instances = jira.getOptionalConfigArray('instances');\n    if (instances) {\n      // Multiple instances form\n      instances.forEach(inst => {\n        const name = inst.getString('name');\n        if (Object.getOwnPropertyNames(this.instances).includes(name)) {\n          throw new ConflictError(\n            `Duplicate jiraDashboard instances: '${name}'`,\n          );\n        }\n\n        this.instances[name] = {\n          token: inst.getString(JIRA_CONFIG_TOKEN),\n          headers: parseHeaders(inst.getOptionalConfig(JIRA_CONFIG_HEADERS)),\n          baseUrl: inst.getString(JIRA_CONFIG_BASE_URL),\n          apiUrl: inst.getOptionalString(JIRA_CONFIG_API_URL),\n          userEmailSuffix: inst.getOptionalString(\n            JIRA_CONFIG_USER_EMAIL_SUFFIX,\n          ),\n          defaultFilters: inst\n            .getOptionalConfigArray(JIRA_FILTERS)\n            ?.map(filterConfig => ({\n              name: filterConfig.getString('name'),\n              shortName: filterConfig.getString('shortName'),\n              query: filterConfig.getString('query'),\n            })),\n          useApiV3: inst.getOptionalBoolean(JIRA_CONFIG_USE_API_V3) ?? false,\n        };\n      });\n    } else {\n      // Default form\n      this.instances.default = {\n        token: jira.getString(JIRA_CONFIG_TOKEN),\n        headers: parseHeaders(jira.getOptionalConfig(JIRA_CONFIG_HEADERS)),\n        baseUrl: jira.getString(JIRA_CONFIG_BASE_URL),\n        apiUrl: jira.getOptionalString(JIRA_CONFIG_API_URL),\n        userEmailSuffix: jira.getOptionalString(JIRA_CONFIG_USER_EMAIL_SUFFIX),\n        defaultFilters: jira\n          .getOptionalConfigArray(JIRA_FILTERS)\n          ?.map(filterConfig => ({\n            name: filterConfig.getString('name'),\n            shortName: filterConfig.getString('shortName'),\n            query: filterConfig.getString('query'),\n          })),\n        useApiV3: jira.getOptionalBoolean(JIRA_CONFIG_USE_API_V3) ?? false,\n      };\n    }\n  }\n\n  /**\n   * Create a JiraConfig from the root config\n   */\n  public static fromConfig(config: RootConfigService): JiraConfig {\n    return new JiraConfig(config);\n  }\n\n  private forInstance(instanceName: string) {\n    const instance = this.instances[instanceName];\n    if (!instance) {\n      throw new ServiceUnavailableError(\n        `No such jira instance '${instanceName}'`,\n      );\n    }\n    return instance;\n  }\n\n  /**\n   * Returns the configuration all instances\n   */\n  getInstances() {\n    return Object.getOwnPropertyNames(this.instances);\n  }\n\n  /**\n   * Get the jira config for a specific instance\n   */\n  getInstance(instanceName?: string): ConfigInstance {\n    return this.forInstance(instanceName ?? 'default');\n  }\n\n  /**\n   * Get the jira base url for a given instance\n   */\n  resolveJiraBaseUrl(instanceName: string): string {\n    const instance = this.forInstance(instanceName);\n    return instance.baseUrl;\n  }\n\n  /**\n   * Get the auth token for a given instance\n   */\n  resolveJiraToken(instanceName: string): string {\n    const instance = this.forInstance(instanceName);\n    return instance.token;\n  }\n\n  /**\n   * Get the email suffice for a given instance\n   */\n  resolveUserEmailSuffix(instanceName: string): string | undefined {\n    const instance = this.forInstance(instanceName);\n    return instance.userEmailSuffix;\n  }\n\n  /**\n   * Get the defined default filters for a given instance\n   */\n  resolveDefaultFilters(instanceName: string): Filter[] | undefined {\n    const instance = this.forInstance(instanceName);\n    return instance.defaultFilters;\n  }\n}\n"],"names":["ConflictError","ServiceUnavailableError"],"mappings":";;;;AAMA,SAAS,aAAa,MAAoD,EAAA;AACxE,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,OAAO,EAAC;AAAA;AAEV,EAAA,OAAO,MAAO,CAAA,WAAA;AAAA,IACZ,MAAO,CAAA,IAAA,EAAO,CAAA,GAAA,CAAI,CAAO,GAAA,KAAA;AACvB,MAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,GAAG,CAAA;AAClC,MAAO,OAAA,CAAC,KAAK,KAAK,CAAA;AAAA,KACnB;AAAA,GACH;AACF;AAiBA,MAAM,oBAAuB,GAAA,SAAA;AAC7B,MAAM,mBAAsB,GAAA,QAAA;AAC5B,MAAM,iBAAoB,GAAA,OAAA;AAC1B,MAAM,mBAAsB,GAAA,SAAA;AAC5B,MAAM,6BAAgC,GAAA,iBAAA;AACtC,MAAM,sBAAyB,GAAA,kBAAA;AAC/B,MAAM,YAAe,GAAA,gBAAA;AACrB,MAAM,sBAAyB,GAAA,UAAA;AAOxB,MAAM,UAAW,CAAA;AAAA,EACd,YAA4C,EAAC;AAAA;AAAA;AAAA;AAAA,EAIrC,gBAAA;AAAA,EAER,YAAY,MAA2B,EAAA;AAC7C,IAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,eAAe,CAAA;AAE7C,IAAA,IAAA,CAAK,gBACH,GAAA,IAAA,CAAK,iBAAkB,CAAA,sBAAsB,CAAK,IAAA,UAAA;AAEpD,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,sBAAA,CAAuB,WAAW,CAAA;AACzD,IAAA,IAAI,SAAW,EAAA;AAEb,MAAA,SAAA,CAAU,QAAQ,CAAQ,IAAA,KAAA;AACxB,QAAM,MAAA,IAAA,GAAO,IAAK,CAAA,SAAA,CAAU,MAAM,CAAA;AAClC,QAAA,IAAI,OAAO,mBAAoB,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,QAAA,CAAS,IAAI,CAAG,EAAA;AAC7D,UAAA,MAAM,IAAIA,oBAAA;AAAA,YACR,uCAAuC,IAAI,CAAA,CAAA;AAAA,WAC7C;AAAA;AAGF,QAAK,IAAA,CAAA,SAAA,CAAU,IAAI,CAAI,GAAA;AAAA,UACrB,KAAA,EAAO,IAAK,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,UACvC,OAAS,EAAA,YAAA,CAAa,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAC,CAAA;AAAA,UACjE,OAAA,EAAS,IAAK,CAAA,SAAA,CAAU,oBAAoB,CAAA;AAAA,UAC5C,MAAA,EAAQ,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,UAClD,iBAAiB,IAAK,CAAA,iBAAA;AAAA,YACpB;AAAA,WACF;AAAA,UACA,gBAAgB,IACb,CAAA,sBAAA,CAAuB,YAAY,CAAA,EAClC,IAAI,CAAiB,YAAA,MAAA;AAAA,YACrB,IAAA,EAAM,YAAa,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,YACnC,SAAA,EAAW,YAAa,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,YAC7C,KAAA,EAAO,YAAa,CAAA,SAAA,CAAU,OAAO;AAAA,WACrC,CAAA,CAAA;AAAA,UACJ,QAAU,EAAA,IAAA,CAAK,kBAAmB,CAAA,sBAAsB,CAAK,IAAA;AAAA,SAC/D;AAAA,OACD,CAAA;AAAA,KACI,MAAA;AAEL,MAAA,IAAA,CAAK,UAAU,OAAU,GAAA;AAAA,QACvB,KAAA,EAAO,IAAK,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,QACvC,OAAS,EAAA,YAAA,CAAa,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAC,CAAA;AAAA,QACjE,OAAA,EAAS,IAAK,CAAA,SAAA,CAAU,oBAAoB,CAAA;AAAA,QAC5C,MAAA,EAAQ,IAAK,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,QAClD,eAAA,EAAiB,IAAK,CAAA,iBAAA,CAAkB,6BAA6B,CAAA;AAAA,QACrE,gBAAgB,IACb,CAAA,sBAAA,CAAuB,YAAY,CAAA,EAClC,IAAI,CAAiB,YAAA,MAAA;AAAA,UACrB,IAAA,EAAM,YAAa,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,UACnC,SAAA,EAAW,YAAa,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,UAC7C,KAAA,EAAO,YAAa,CAAA,SAAA,CAAU,OAAO;AAAA,SACrC,CAAA,CAAA;AAAA,QACJ,QAAU,EAAA,IAAA,CAAK,kBAAmB,CAAA,sBAAsB,CAAK,IAAA;AAAA,OAC/D;AAAA;AACF;AACF;AAAA;AAAA;AAAA,EAKA,OAAc,WAAW,MAAuC,EAAA;AAC9D,IAAO,OAAA,IAAI,WAAW,MAAM,CAAA;AAAA;AAC9B,EAEQ,YAAY,YAAsB,EAAA;AACxC,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,SAAA,CAAU,YAAY,CAAA;AAC5C,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAIC,8BAAA;AAAA,QACR,0BAA0B,YAAY,CAAA,CAAA;AAAA,OACxC;AAAA;AAEF,IAAO,OAAA,QAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,YAAe,GAAA;AACb,IAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,IAAA,CAAK,SAAS,CAAA;AAAA;AAClD;AAAA;AAAA;AAAA,EAKA,YAAY,YAAuC,EAAA;AACjD,IAAO,OAAA,IAAA,CAAK,WAAY,CAAA,YAAA,IAAgB,SAAS,CAAA;AAAA;AACnD;AAAA;AAAA;AAAA,EAKA,mBAAmB,YAA8B,EAAA;AAC/C,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,OAAA;AAAA;AAClB;AAAA;AAAA;AAAA,EAKA,iBAAiB,YAA8B,EAAA;AAC7C,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,KAAA;AAAA;AAClB;AAAA;AAAA;AAAA,EAKA,uBAAuB,YAA0C,EAAA;AAC/D,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,eAAA;AAAA;AAClB;AAAA;AAAA;AAAA,EAKA,sBAAsB,YAA4C,EAAA;AAChE,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,YAAY,CAAA;AAC9C,IAAA,OAAO,QAAS,CAAA,cAAA;AAAA;AAEpB;;;;"}

package/dist/index.d.ts

@@ -23,6 +23,7 @@ type ConfigInstance = {
     apiUrl?: string;
     userEmailSuffix?: string;
     defaultFilters?: Filter[];
+    useApiV3?: boolean;
 };
 /**
  * Class for reading Jira configuration from the root config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axis-backstage/plugin-jira-dashboard-backend",
-  "version": "4.9.0",
+  "version": "5.0.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -32,7 +32,7 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@axis-backstage/plugin-jira-dashboard-common": "^1.14.0",
+    "@axis-backstage/plugin-jira-dashboard-common": "^1.14.1",
     "@backstage/backend-defaults": "^0.12.0",
     "@backstage/backend-plugin-api": "^1.4.2",
     "@backstage/catalog-client": "^1.11.0",