@backstage/integration 0.8.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/integration
 
+## 1.0.0
+
+### Major Changes
+
+- b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
+
+### Patch Changes
+
+- 403837cbac: Added an integration for Gerrit
+- Updated dependencies
+  - @backstage/config@1.0.0
+
 ## 0.8.0
 
 ### Minor Changes

package/config.d.ts

@@ -60,6 +60,31 @@ export interface Config {
       appPassword?: string;
     }>;
 
+    /** Integration configuration for Gerrit */
+    gerrit?: Array<{
+      /**
+       * The hostname of the given Gerrit instance
+       * @visibility frontend
+       */
+      host: string;
+      /**
+       * The base url for the Gerrit instance.
+       * @visibility frontend
+       */
+      baseUrl?: string;
+      /**
+       * The username to use for authenticated requests.
+       * @visibility secret
+       */
+      username?: string;
+      /**
+       * Gerrit password used to authenticate requests. This can be either a password
+       * or a generated access token.
+       * @visibility secret
+       */
+      password?: string;
+    }>;
+
     /** Integration configuration for GitHub */
     github?: Array<{
       /**

package/dist/index.cjs.js

@@ -451,6 +451,69 @@ function getBitbucketRequestOptions(config) {
   };
 }
 
+function readGerritIntegrationConfig(config) {
+  const host = config.getString("host");
+  let baseUrl = config.getOptionalString("baseUrl");
+  const username = config.getOptionalString("username");
+  const password = config.getOptionalString("password");
+  if (!isValidHost(host)) {
+    throw new Error(`Invalid Gerrit integration config, '${host}' is not a valid host`);
+  } else if (baseUrl && !isValidUrl(baseUrl)) {
+    throw new Error(`Invalid Gerrit integration config, '${baseUrl}' is not a valid baseUrl`);
+  }
+  if (baseUrl) {
+    baseUrl = lodash.trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  return {
+    host,
+    baseUrl,
+    username,
+    password
+  };
+}
+function readGerritIntegrationConfigs(configs) {
+  return configs.map(readGerritIntegrationConfig);
+}
+
+const _GerritIntegration = class {
+  constructor(integrationConfig) {
+    this.integrationConfig = integrationConfig;
+  }
+  get type() {
+    return "gerrit";
+  }
+  get title() {
+    return this.integrationConfig.host;
+  }
+  get config() {
+    return this.integrationConfig;
+  }
+  resolveUrl(options) {
+    const { url, base, lineNumber } = options;
+    let updated;
+    if (url) {
+      updated = new URL(url, base);
+    } else {
+      updated = new URL(base);
+    }
+    if (lineNumber) {
+      updated.hash = lineNumber.toString();
+    }
+    return updated.toString();
+  }
+  resolveEditUrl(url) {
+    return url;
+  }
+};
+let GerritIntegration = _GerritIntegration;
+GerritIntegration.factory = ({ config }) => {
+  var _a;
+  const configs = readGerritIntegrationConfigs((_a = config.getOptionalConfigArray("integrations.gerrit")) != null ? _a : []);
+  return basicIntegrations(configs.map((c) => new _GerritIntegration(c)), (i) => i.config.host);
+};
+
 const GITHUB_HOST = "github.com";
 const GITHUB_API_BASE_URL = "https://api.github.com";
 const GITHUB_RAW_BASE_URL = "https://raw.githubusercontent.com";
@@ -949,6 +1012,7 @@ class ScmIntegrations {
       awsS3: AwsS3Integration.factory({ config }),
       azure: AzureIntegration.factory({ config }),
       bitbucket: BitbucketIntegration.factory({ config }),
+      gerrit: GerritIntegration.factory({ config }),
       github: GitHubIntegration.factory({ config }),
       gitlab: GitLabIntegration.factory({ config })
     });
@@ -965,6 +1029,9 @@ class ScmIntegrations {
   get bitbucket() {
     return this.byType.bitbucket;
   }
+  get gerrit() {
+    return this.byType.gerrit;
+  }
   get github() {
     return this.byType.github;
   }
@@ -1000,6 +1067,7 @@ exports.AwsS3Integration = AwsS3Integration;
 exports.AzureIntegration = AzureIntegration;
 exports.BitbucketIntegration = BitbucketIntegration;
 exports.DefaultGithubCredentialsProvider = DefaultGithubCredentialsProvider;
+exports.GerritIntegration = GerritIntegration;
 exports.GitHubIntegration = GitHubIntegration;
 exports.GitLabIntegration = GitLabIntegration;
 exports.GithubAppCredentialsMux = GithubAppCredentialsMux;
@@ -1024,6 +1092,8 @@ exports.readAzureIntegrationConfig = readAzureIntegrationConfig;
 exports.readAzureIntegrationConfigs = readAzureIntegrationConfigs;
 exports.readBitbucketIntegrationConfig = readBitbucketIntegrationConfig;
 exports.readBitbucketIntegrationConfigs = readBitbucketIntegrationConfigs;
+exports.readGerritIntegrationConfig = readGerritIntegrationConfig;
+exports.readGerritIntegrationConfigs = readGerritIntegrationConfigs;
 exports.readGitHubIntegrationConfig = readGitHubIntegrationConfig;
 exports.readGitHubIntegrationConfigs = readGitHubIntegrationConfigs;
 exports.readGitLabIntegrationConfig = readGitLabIntegrationConfig;