From 1b47182da01d4468114f6a35c7b755350cecd78c Mon Sep 17 00:00:00 2001
From: anicke <niklas.aronsson@gmail.com>
Date: Fri, 22 Nov 2024 15:10:38 +0100
Subject: [PATCH] feat(jira-backend): export the JiraConfig class (#217)

This is needed to be able to use the exported searchJira function
in other backend plugins since the jira config instance is now
an argument.

Co-authored-by: Niklas Aronsson <niklasar@axis.com>
Co-authored-by: Frida Jacobsson <frida.jacobsson@axis.com>
---
 .changeset/grumpy-cups-act.md                |  6 +++++
 plugins/jira-dashboard-backend/api-report.md | 12 +++++++++
 plugins/jira-dashboard-backend/src/config.ts | 26 ++++++++++++++++++++
 plugins/jira-dashboard-backend/src/index.ts  |  1 +
 4 files changed, 45 insertions(+)
 create mode 100644 .changeset/grumpy-cups-act.md

diff --git a/.changeset/grumpy-cups-act.md b/.changeset/grumpy-cups-act.md
new file mode 100644
index 00000000..b793092c
--- /dev/null
+++ b/.changeset/grumpy-cups-act.md
@@ -0,0 +1,6 @@
+---
+'@axis-backstage/plugin-jira-dashboard-backend': patch
+---
+
+The backend now exports the `JiraConfig` class. This is needed to create config
+instances for the `searchJira`function.
diff --git a/plugins/jira-dashboard-backend/api-report.md b/plugins/jira-dashboard-backend/api-report.md
index 82342480..49bf211b 100644
--- a/plugins/jira-dashboard-backend/api-report.md
+++ b/plugins/jira-dashboard-backend/api-report.md
@@ -5,6 +5,7 @@
 ```ts
 import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
 import { JiraQueryResults } from '@axis-backstage/plugin-jira-dashboard-common';
+import { RootConfigService } from '@backstage/backend-plugin-api';
 
 // @public
 export type ConfigInstance = {
@@ -14,6 +15,17 @@ export type ConfigInstance = {
   userEmailSuffix?: string;
 };
 
+// @public
+export class JiraConfig {
+  readonly annotationPrefix: string;
+  static fromConfig(config: RootConfigService): JiraConfig;
+  getInstance(instanceName?: string): ConfigInstance;
+  getInstances(): string[];
+  resolveJiraBaseUrl(instanceName: string): string;
+  resolveJiraToken(instanceName: string): string;
+  resolveUserEmailSuffix(instanceName: string): string | undefined;
+}
+
 // @public
 const jiraDashboardPlugin: BackendFeatureCompat;
 export default jiraDashboardPlugin;
diff --git a/plugins/jira-dashboard-backend/src/config.ts b/plugins/jira-dashboard-backend/src/config.ts
index a87bf0ad..9925b8a5 100644
--- a/plugins/jira-dashboard-backend/src/config.ts
+++ b/plugins/jira-dashboard-backend/src/config.ts
@@ -33,8 +33,16 @@ const JIRA_CONFIG_HEADERS = 'headers';
 const JIRA_CONFIG_USER_EMAIL_SUFFIX = 'userEmailSuffix';
 const JIRA_CONFIG_ANNOTATION = 'annotationPrefix';
 
+/**
+ * Class for reading Jira configuration from the root config
+ *
+ * @public
+ */
 export class JiraConfig {
   private instances: Record<string, ConfigInstance> = {};
+  /**
+   * The annotation prefix to use for Jira annotations
+   */
   public readonly annotationPrefix: string;
 
   private constructor(config: RootConfigService) {
@@ -74,6 +82,9 @@ export class JiraConfig {
     }
   }
 
+  /**
+   * Create a JiraConfig from the root config
+   */
   public static fromConfig(config: RootConfigService): JiraConfig {
     return new JiraConfig(config);
   }
@@ -88,24 +99,39 @@ export class JiraConfig {
     return instance;
   }
 
+  /**
+   * Returns the configuration all instances
+   */
   getInstances() {
     return Object.getOwnPropertyNames(this.instances);
   }
 
+  /**
+   * Get the jira config for a specific instance
+   */
   getInstance(instanceName?: string): ConfigInstance {
     return this.forInstance(instanceName ?? 'default');
   }
 
+  /**
+   * Get the jira base url for a given instance
+   */
   resolveJiraBaseUrl(instanceName: string): string {
     const instance = this.forInstance(instanceName);
     return instance.baseUrl;
   }
 
+  /**
+   * Get the auth token for a given instance
+   */
   resolveJiraToken(instanceName: string): string {
     const instance = this.forInstance(instanceName);
     return instance.token;
   }
 
+  /**
+   * Get the email suffice for a given instance
+   */
   resolveUserEmailSuffix(instanceName: string): string | undefined {
     const instance = this.forInstance(instanceName);
     return instance.userEmailSuffix;
diff --git a/plugins/jira-dashboard-backend/src/index.ts b/plugins/jira-dashboard-backend/src/index.ts
index 16d40dce..c08d1946 100644
--- a/plugins/jira-dashboard-backend/src/index.ts
+++ b/plugins/jira-dashboard-backend/src/index.ts
@@ -8,5 +8,6 @@ export { jiraDashboardPlugin as default } from './plugin';
 export { searchJira } from './api';
 export type { SearchOptions } from './api';
 export type { ConfigInstance } from './config';
+export { JiraConfig } from './config';
 export { jqlQueryBuilder } from './queries';
 export type { JqlQueryBuilderArgs } from './queries';