@backstage/integration 0.8.0 → 1.0.0

package/dist/index.d.ts

@@ -296,6 +296,70 @@ declare function getBitbucketRequestOptions(config: BitbucketIntegrationConfig):
     headers: Record<string, string>;
 };
 
+/**
+ * The configuration parameters for a single Gerrit API provider.
+ *
+ * @public
+ */
+declare type GerritIntegrationConfig = {
+    /**
+     * The host of the target that this matches on, e.g. "gerrit-review.com"
+     */
+    host: string;
+    /**
+     * The optional base URL of the Gerrit instance. It is assumed that https
+     * is used and that the base path is "/" on the host. If that is not the
+     * case set the complete base url to the gerrit instance, e.g.
+     * "https://gerrit-review.com/gerrit". This is the url that you would open
+     * in a browser.
+     */
+    baseUrl?: string;
+    /**
+     * The username to use for requests to gerrit.
+     */
+    username?: string;
+    /**
+     * The password or http token to use for authentication.
+     */
+    password?: string;
+};
+/**
+ * Reads a single Gerrit integration config.
+ *
+ * @param config - The config object of a single integration
+ *
+ * @public
+ */
+declare function readGerritIntegrationConfig(config: Config): GerritIntegrationConfig;
+/**
+ * Reads a set of Gerrit integration configs.
+ *
+ * @param configs - All of the integration config objects
+ *
+ * @public
+ */
+declare function readGerritIntegrationConfigs(configs: Config[]): GerritIntegrationConfig[];
+
+/**
+ * A Gerrit based integration.
+ *
+ * @public
+ */
+declare class GerritIntegration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<GerritIntegration>;
+    constructor(integrationConfig: GerritIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    get config(): GerritIntegrationConfig;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
 /**
  * The configuration parameters for a single GitHub integration.
  *
@@ -629,6 +693,7 @@ interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
     awsS3: ScmIntegrationsGroup<AwsS3Integration>;
     azure: ScmIntegrationsGroup<AzureIntegration>;
     bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    gerrit: ScmIntegrationsGroup<GerritIntegration>;
     github: ScmIntegrationsGroup<GitHubIntegration>;
     gitlab: ScmIntegrationsGroup<GitLabIntegration>;
     /**
@@ -833,6 +898,7 @@ interface IntegrationsByType {
     awsS3: ScmIntegrationsGroup<AwsS3Integration>;
     azure: ScmIntegrationsGroup<AzureIntegration>;
     bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    gerrit: ScmIntegrationsGroup<GerritIntegration>;
     github: ScmIntegrationsGroup<GitHubIntegration>;
     gitlab: ScmIntegrationsGroup<GitLabIntegration>;
 }
@@ -848,6 +914,7 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     get awsS3(): ScmIntegrationsGroup<AwsS3Integration>;
     get azure(): ScmIntegrationsGroup<AzureIntegration>;
     get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
+    get gerrit(): ScmIntegrationsGroup<GerritIntegration>;
     get github(): ScmIntegrationsGroup<GitHubIntegration>;
     get gitlab(): ScmIntegrationsGroup<GitLabIntegration>;
     list(): ScmIntegration[];
@@ -861,4 +928,4 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     resolveEditUrl(url: string): string;
 }
 
-export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, DefaultGithubCredentialsProvider, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };
+export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, DefaultGithubCredentialsProvider, GerritIntegration, GerritIntegrationConfig, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };

package/dist/index.esm.js

@@ -442,6 +442,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 = 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";
@@ -940,6 +1003,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 })
     });
@@ -956,6 +1020,9 @@ class ScmIntegrations {
   get bitbucket() {
     return this.byType.bitbucket;
   }
+  get gerrit() {
+    return this.byType.gerrit;
+  }
   get github() {
     return this.byType.github;
   }
@@ -987,5 +1054,5 @@ class ScmIntegrations {
   }
 }
 
-export { AwsS3Integration, AzureIntegration, BitbucketIntegration, DefaultGithubCredentialsProvider, GitHubIntegration, GitLabIntegration, GithubAppCredentialsMux, ScmIntegrations, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };
+export { AwsS3Integration, AzureIntegration, BitbucketIntegration, DefaultGithubCredentialsProvider, GerritIntegration, GitHubIntegration, GitLabIntegration, GithubAppCredentialsMux, ScmIntegrations, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };
 //# sourceMappingURL=index.esm.js.map