@backstage/integration 1.3.2-next.2 → 1.4.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @backstage/integration
 
+## 1.4.0-next.0
+
+### Minor Changes
+
+- d05e1841ce: This patch brings Gitea as a valid integration: target, via the ScmIntegration interface. It adds gitea to the relevant static properties (get integration by name, get integration by type) for plugins to be able to reference the same Gitea server.
+- c1784a4980: Replaces in-code uses of `GitHub` with `Github` and deprecates old versions.
+
+  Deprecates:
+
+  - `getGitHubFileFetchUrl` replaced by `getGithubFileFetchUrl`
+  - `GitHubIntegrationConfig` replaced by `GithubIntegrationConfig`
+  - `GitHubIntegration` replaced by `GithubIntegration`
+  - `readGitHubIntegrationConfig` replaced by `readGithubIntegrationConfig`
+  - `readGitHubIntegrationConfigs` replaced by `readGithubIntegrationConfigs`
+  - `replaceGitHubUrlType` replaced by `replaceGithubUrlType`
+
+### Patch Changes
+
+- 7573b65232: Internal refactor of imports to avoid circular dependencies
+- a6d779d58a: Remove explicit default visibility at `config.d.ts` files.
+
+  ```ts
+  /**
+   * @visibility backend
+   */
+  ```
+
+- Updated dependencies
+  - @backstage/config@1.0.4-next.0
+  - @backstage/errors@1.1.3-next.0
+
+## 1.3.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.0.3
+  - @backstage/errors@1.1.2
+
 ## 1.3.2-next.2
 
 ### Patch Changes

package/config.d.ts

@@ -164,7 +164,6 @@ export interface Config {
 
       /**
        * GitHub Apps configuration
-       * @visibility backend
        */
       apps?: Array<{
         /**
@@ -233,7 +232,6 @@ export interface Config {
     googleGcs?: {
       /**
        * Service account email used to authenticate requests.
-       * @visibility backend
        */
       clientEmail?: string;
       /**
@@ -265,7 +263,6 @@ export interface Config {
 
       /**
        * Account access key used to authenticate requests.
-       * @visibility backend
        */
       accessKeyId?: string;
       /**
@@ -276,15 +273,39 @@ export interface Config {
 
       /**
        * ARN of the role to be assumed
-       * @visibility backend
        */
       roleArn?: string;
 
       /**
        * External ID to use when assuming role
-       * @visibility backend
        */
       externalId?: string;
     }>;
+
+    /** Integration configuration for Gitea */
+    gitea?: Array<{
+      /**
+       * The hostname of the given Gitea instance
+       * @visibility frontend
+       */
+      host: string;
+      /**
+       * The base url for the Gitea instance.
+       * @visibility frontend
+       */
+      baseUrl?: string;
+
+      /**
+       * The username to use for authenticated requests.
+       * @visibility secret
+       */
+      username?: string;
+      /**
+       * Gitea password used to authenticate requests. This can be either a password
+       * or a generated access token.
+       * @visibility secret
+       */
+      password?: string;
+    }>;
   };
 }

package/dist/index.cjs.js

@@ -898,7 +898,7 @@ function parseGerritGitilesUrl(config, url) {
     project
   };
 }
-function builldGerritGitilesUrl(config, project, branch, filePath) {
+function buildGerritGitilesUrl(config, project, branch, filePath) {
   return `${config.gitilesBaseUrl}/${project}/+/refs/heads/${branch}/${lodash.trimStart(filePath, "/")}`;
 }
 function getAuthenticationPrefix(config) {
@@ -970,7 +970,7 @@ const _GerritIntegration = class {
     let updated;
     if (url.startsWith("/")) {
       const { branch, project } = parseGerritGitilesUrl(this.config, base);
-      return builldGerritGitilesUrl(this.config, project, branch, url);
+      return buildGerritGitilesUrl(this.config, project, branch, url);
     }
     if (url) {
       updated = new URL(url, base);
@@ -998,10 +998,101 @@ GerritIntegration.factory = ({ config }) => {
   );
 };
 
+function readGiteaConfig(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 Gitea integration config, '${host}' is not a valid host`
+    );
+  }
+  if (baseUrl) {
+    baseUrl = lodash.trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  return {
+    host,
+    baseUrl,
+    username,
+    password
+  };
+}
+
+function getGiteaEditContentsUrl(config, url) {
+  var _a;
+  try {
+    const baseUrl = (_a = config.baseUrl) != null ? _a : `https://${config.host}`;
+    const [_blank, owner, name, _src, _branch, ref, ...path] = url.replace(baseUrl, "").split("/");
+    const pathWithoutSlash = path.join("/").replace(/^\//, "");
+    return `${baseUrl}/${owner}/${name}/_edit/${ref}/${pathWithoutSlash}`;
+  } catch (e) {
+    throw new Error(`Incorrect URL: ${url}, ${e}`);
+  }
+}
+function getGiteaFileContentsUrl(config, url) {
+  var _a;
+  try {
+    const baseUrl = (_a = config.baseUrl) != null ? _a : `https://${config.host}`;
+    const [_blank, owner, name, _src, _branch, ref, ...path] = url.replace(baseUrl, "").split("/");
+    const pathWithoutSlash = path.join("/").replace(/^\//, "");
+    return `${baseUrl}/api/v1/repos/${owner}/${name}/contents/${pathWithoutSlash}?ref=${ref}`;
+  } catch (e) {
+    throw new Error(`Incorrect URL: ${url}, ${e}`);
+  }
+}
+function getGiteaRequestOptions(config) {
+  const headers = {};
+  const { username, password } = config;
+  if (!password) {
+    return headers;
+  }
+  if (username) {
+    headers.Authorization = `basic ${Buffer.from(
+      `${username}:${password}`
+    ).toString("base64")}`;
+  } else {
+    headers.Authorization = `token ${password}`;
+  }
+  return {
+    headers
+  };
+}
+
+const _GiteaIntegration = class {
+  constructor(config) {
+    this.config = config;
+  }
+  get type() {
+    return "gitea";
+  }
+  get title() {
+    return this.config.host;
+  }
+  resolveUrl(options) {
+    return defaultScmResolveUrl(options);
+  }
+  resolveEditUrl(url) {
+    return getGiteaEditContentsUrl(this.config, url);
+  }
+};
+let GiteaIntegration = _GiteaIntegration;
+GiteaIntegration.factory = ({ config }) => {
+  var _a;
+  const configs = (_a = config.getOptionalConfigArray("integrations.gitea")) != null ? _a : [];
+  const giteaConfigs = configs.map((c) => readGiteaConfig(c));
+  return basicIntegrations(
+    giteaConfigs.map((c) => new _GiteaIntegration(c)),
+    (gitea) => gitea.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";
-function readGitHubIntegrationConfig(config) {
+function readGithubIntegrationConfig(config) {
   var _a, _b;
   const host = (_a = config.getOptionalString("host")) != null ? _a : GITHUB_HOST;
   let apiBaseUrl = config.getOptionalString("apiBaseUrl");
@@ -1034,8 +1125,8 @@ function readGitHubIntegrationConfig(config) {
   }
   return { host, apiBaseUrl, rawBaseUrl, token, apps };
 }
-function readGitHubIntegrationConfigs(configs) {
-  const result = configs.map(readGitHubIntegrationConfig);
+function readGithubIntegrationConfigs(configs) {
+  const result = configs.map(readGithubIntegrationConfig);
   if (!result.some((c) => c.host === GITHUB_HOST)) {
     result.push({
       host: GITHUB_HOST,
@@ -1046,7 +1137,7 @@ function readGitHubIntegrationConfigs(configs) {
   return result;
 }
 
-function getGitHubFileFetchUrl(url, config, credentials) {
+function getGithubFileFetchUrl(url, config, credentials) {
   try {
     const { owner, name, ref, filepathtype, filepath } = parseGitUrl__default["default"](url);
     if (!owner || !name || !ref || filepathtype !== "blob" && filepathtype !== "raw" && filepathtype !== "tree") {
@@ -1280,7 +1371,7 @@ class DefaultGithubCredentialsProvider {
   }
 }
 
-const _GitHubIntegration = class {
+const _GithubIntegration = class {
   constructor(integrationConfig) {
     this.integrationConfig = integrationConfig;
   }
@@ -1294,24 +1385,24 @@ const _GitHubIntegration = class {
     return this.integrationConfig;
   }
   resolveUrl(options) {
-    return replaceGitHubUrlType(defaultScmResolveUrl(options), "tree");
+    return replaceGithubUrlType(defaultScmResolveUrl(options), "tree");
   }
   resolveEditUrl(url) {
-    return replaceGitHubUrlType(url, "edit");
+    return replaceGithubUrlType(url, "edit");
   }
 };
-let GitHubIntegration = _GitHubIntegration;
-GitHubIntegration.factory = ({ config }) => {
+let GithubIntegration = _GithubIntegration;
+GithubIntegration.factory = ({ config }) => {
   var _a;
-  const configs = readGitHubIntegrationConfigs(
+  const configs = readGithubIntegrationConfigs(
     (_a = config.getOptionalConfigArray("integrations.github")) != null ? _a : []
   );
   return basicIntegrations(
-    configs.map((c) => new _GitHubIntegration(c)),
+    configs.map((c) => new _GithubIntegration(c)),
     (i) => i.config.host
   );
 };
-function replaceGitHubUrlType(url, type) {
+function replaceGithubUrlType(url, type) {
   return url.replace(
     /\/\/([^/]+)\/([^/]+)\/([^/]+)\/(blob|tree|edit)\//,
     (_, host, owner, repo) => {
@@ -1320,6 +1411,20 @@ function replaceGitHubUrlType(url, type) {
   );
 }
 
+const getGitHubFileFetchUrl = getGithubFileFetchUrl;
+class GitHubIntegration extends GithubIntegration {
+  constructor(integrationConfig) {
+    super(integrationConfig);
+  }
+  get config() {
+    return super.config;
+  }
+}
+GitHubIntegration.factory = GithubIntegration.factory;
+const readGitHubIntegrationConfig = readGithubIntegrationConfig;
+const readGitHubIntegrationConfigs = readGithubIntegrationConfigs;
+const replaceGitHubUrlType = replaceGithubUrlType;
+
 const GITLAB_HOST = "gitlab.com";
 const GITLAB_API_BASE_URL = "https://gitlab.com/api/v4";
 function readGitLabIntegrationConfig(config) {
@@ -1491,8 +1596,9 @@ class ScmIntegrations {
       bitbucketCloud: BitbucketCloudIntegration.factory({ config }),
       bitbucketServer: BitbucketServerIntegration.factory({ config }),
       gerrit: GerritIntegration.factory({ config }),
-      github: GitHubIntegration.factory({ config }),
-      gitlab: GitLabIntegration.factory({ config })
+      github: GithubIntegration.factory({ config }),
+      gitlab: GitLabIntegration.factory({ config }),
+      gitea: GiteaIntegration.factory({ config })
     });
   }
   constructor(integrationsByType) {
@@ -1522,6 +1628,9 @@ class ScmIntegrations {
   get gitlab() {
     return this.byType.gitlab;
   }
+  get gitea() {
+    return this.byType.gitea;
+  }
   list() {
     return Object.values(this.byType).flatMap(
       (i) => i.list()
@@ -1567,7 +1676,9 @@ exports.DefaultGithubCredentialsProvider = DefaultGithubCredentialsProvider;
 exports.GerritIntegration = GerritIntegration;
 exports.GitHubIntegration = GitHubIntegration;
 exports.GitLabIntegration = GitLabIntegration;
+exports.GiteaIntegration = GiteaIntegration;
 exports.GithubAppCredentialsMux = GithubAppCredentialsMux;
+exports.GithubIntegration = GithubIntegration;
 exports.ScmIntegrations = ScmIntegrations;
 exports.SingleInstanceGithubCredentialsProvider = SingleInstanceGithubCredentialsProvider;
 exports.defaultScmResolveUrl = defaultScmResolveUrl;
@@ -1597,6 +1708,9 @@ exports.getGitHubRequestOptions = getGitHubRequestOptions;
 exports.getGitLabFileFetchUrl = getGitLabFileFetchUrl;
 exports.getGitLabIntegrationRelativePath = getGitLabIntegrationRelativePath;
 exports.getGitLabRequestOptions = getGitLabRequestOptions;
+exports.getGiteaFileContentsUrl = getGiteaFileContentsUrl;
+exports.getGiteaRequestOptions = getGiteaRequestOptions;
+exports.getGithubFileFetchUrl = getGithubFileFetchUrl;
 exports.parseGerritGitilesUrl = parseGerritGitilesUrl;
 exports.parseGerritJsonResponse = parseGerritJsonResponse;
 exports.readAwsS3IntegrationConfig = readAwsS3IntegrationConfig;
@@ -1615,7 +1729,11 @@ exports.readGitHubIntegrationConfig = readGitHubIntegrationConfig;
 exports.readGitHubIntegrationConfigs = readGitHubIntegrationConfigs;
 exports.readGitLabIntegrationConfig = readGitLabIntegrationConfig;
 exports.readGitLabIntegrationConfigs = readGitLabIntegrationConfigs;
+exports.readGiteaConfig = readGiteaConfig;
+exports.readGithubIntegrationConfig = readGithubIntegrationConfig;
+exports.readGithubIntegrationConfigs = readGithubIntegrationConfigs;
 exports.readGoogleGcsIntegrationConfig = readGoogleGcsIntegrationConfig;
 exports.replaceGitHubUrlType = replaceGitHubUrlType;
 exports.replaceGitLabUrlType = replaceGitLabUrlType;
+exports.replaceGithubUrlType = replaceGithubUrlType;
 //# sourceMappingURL=index.cjs.js.map