@backstage/integration 1.10.0 → 1.11.0-next.0

package/dist/bitbucketServer/core.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.esm.js","sources":["../../src/bitbucketServer/core.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport fetch from 'cross-fetch';\nimport parseGitUrl from 'git-url-parse';\nimport { BitbucketServerIntegrationConfig } from './config';\n\n/**\n * Given a URL pointing to a path on a provider, returns the default branch.\n *\n * @param url - A URL pointing to a path\n * @param config - The relevant provider config\n * @public\n */\nexport async function getBitbucketServerDefaultBranch(\n  url: string,\n  config: BitbucketServerIntegrationConfig,\n): Promise<string> {\n  const { name: repoName, owner: project } = parseGitUrl(url);\n\n  // Bitbucket Server https://docs.atlassian.com/bitbucket-server/rest/7.9.0/bitbucket-rest.html#idp184\n  let branchUrl = `${config.apiBaseUrl}/projects/${project}/repos/${repoName}/default-branch`;\n\n  let response = await fetch(\n    branchUrl,\n    getBitbucketServerRequestOptions(config),\n  );\n\n  if (response.status === 404) {\n    // First try the new format, and then if it gets specifically a 404 it should try the old format\n    // (to support old  Atlassian Bitbucket Server v5.11.1 format )\n    branchUrl = `${config.apiBaseUrl}/projects/${project}/repos/${repoName}/branches/default`;\n    response = await fetch(branchUrl, getBitbucketServerRequestOptions(config));\n  }\n\n  if (!response.ok) {\n    const message = `Failed to retrieve default branch from ${branchUrl}, ${response.status} ${response.statusText}`;\n    throw new Error(message);\n  }\n\n  const { displayId } = await response.json();\n  const defaultBranch = displayId;\n  if (!defaultBranch) {\n    throw new Error(\n      `Failed to read default branch from ${branchUrl}. ` +\n        `Response ${response.status} ${response.json()}`,\n    );\n  }\n  return defaultBranch;\n}\n\n/**\n * Given a URL pointing to a path on a provider, returns a URL that is suitable\n * for downloading the subtree.\n *\n * @param url - A URL pointing to a path\n * @param config - The relevant provider config\n * @public\n */\nexport async function getBitbucketServerDownloadUrl(\n  url: string,\n  config: BitbucketServerIntegrationConfig,\n): Promise<string> {\n  const { name: repoName, owner: project, ref, filepath } = parseGitUrl(url);\n\n  let branch = ref;\n  if (!branch) {\n    branch = await getBitbucketServerDefaultBranch(url, config);\n  }\n  // path will limit the downloaded content\n  // /docs will only download the docs folder and everything below it\n  // /docs/index.md will download the docs folder and everything below it\n  const path = filepath\n    ? `&path=${encodeURIComponent(decodeURIComponent(filepath))}`\n    : '';\n  return `${config.apiBaseUrl}/projects/${project}/repos/${repoName}/archive?format=tgz&at=${branch}&prefix=${project}-${repoName}${path}`;\n}\n\n/**\n * Given a URL pointing to a file on a provider, returns a URL that is suitable\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://bitbucket.company.com/projectname/reponame/src/main/file.yaml\n * to:   https://bitbucket.company.com/rest/api/1.0/project/projectname/reponame/raw/file.yaml?at=main\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @public\n */\nexport function getBitbucketServerFileFetchUrl(\n  url: string,\n  config: BitbucketServerIntegrationConfig,\n): string {\n  try {\n    const { owner, name, ref, filepathtype, filepath } = parseGitUrl(url);\n    if (\n      !owner ||\n      !name ||\n      (filepathtype !== 'browse' &&\n        filepathtype !== 'raw' &&\n        filepathtype !== 'src')\n    ) {\n      throw new Error('Invalid Bitbucket Server URL or file path');\n    }\n\n    const pathWithoutSlash = filepath.replace(/^\\//, '');\n    return `${config.apiBaseUrl}/projects/${owner}/repos/${name}/raw/${pathWithoutSlash}?at=${ref}`;\n  } catch (e) {\n    throw new Error(`Incorrect URL: ${url}, ${e}`);\n  }\n}\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @param config - The relevant provider config\n * @public\n */\nexport function getBitbucketServerRequestOptions(\n  config: BitbucketServerIntegrationConfig,\n): { headers: Record<string, string> } {\n  const headers: Record<string, string> = {};\n\n  if (config.token) {\n    headers.Authorization = `Bearer ${config.token}`;\n  } else if (config.username && config.password) {\n    const buffer = Buffer.from(`${config.username}:${config.password}`, 'utf8');\n    headers.Authorization = `Basic ${buffer.toString('base64')}`;\n  }\n\n  return {\n    headers,\n  };\n}\n"],"names":[],"mappings":";;;AA2BsB,eAAA,+BAAA,CACpB,KACA,MACiB,EAAA;AACjB,EAAA,MAAM,EAAE,IAAM,EAAA,QAAA,EAAU,OAAO,OAAQ,EAAA,GAAI,YAAY,GAAG,CAAA,CAAA;AAG1D,EAAA,IAAI,YAAY,CAAG,EAAA,MAAA,CAAO,UAAU,CAAa,UAAA,EAAA,OAAO,UAAU,QAAQ,CAAA,eAAA,CAAA,CAAA;AAE1E,EAAA,IAAI,WAAW,MAAM,KAAA;AAAA,IACnB,SAAA;AAAA,IACA,iCAAiC,MAAM,CAAA;AAAA,GACzC,CAAA;AAEA,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAG3B,IAAA,SAAA,GAAY,GAAG,MAAO,CAAA,UAAU,CAAa,UAAA,EAAA,OAAO,UAAU,QAAQ,CAAA,iBAAA,CAAA,CAAA;AACtE,IAAA,QAAA,GAAW,MAAM,KAAA,CAAM,SAAW,EAAA,gCAAA,CAAiC,MAAM,CAAC,CAAA,CAAA;AAAA,GAC5E;AAEA,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAM,MAAA,OAAA,GAAU,0CAA0C,SAAS,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA,CAAA;AAC9G,IAAM,MAAA,IAAI,MAAM,OAAO,CAAA,CAAA;AAAA,GACzB;AAEA,EAAA,MAAM,EAAE,SAAA,EAAc,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAC1C,EAAA,MAAM,aAAgB,GAAA,SAAA,CAAA;AACtB,EAAA,IAAI,CAAC,aAAe,EAAA;AAClB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,mCAAA,EAAsC,SAAS,CACjC,WAAA,EAAA,QAAA,CAAS,MAAM,CAAI,CAAA,EAAA,QAAA,CAAS,MAAM,CAAA,CAAA;AAAA,KAClD,CAAA;AAAA,GACF;AACA,EAAO,OAAA,aAAA,CAAA;AACT,CAAA;AAUsB,eAAA,6BAAA,CACpB,KACA,MACiB,EAAA;AACjB,EAAM,MAAA,EAAE,MAAM,QAAU,EAAA,KAAA,EAAO,SAAS,GAAK,EAAA,QAAA,EAAa,GAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAEzE,EAAA,IAAI,MAAS,GAAA,GAAA,CAAA;AACb,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAS,MAAA,GAAA,MAAM,+BAAgC,CAAA,GAAA,EAAK,MAAM,CAAA,CAAA;AAAA,GAC5D;AAIA,EAAM,MAAA,IAAA,GAAO,WACT,CAAS,MAAA,EAAA,kBAAA,CAAmB,mBAAmB,QAAQ,CAAC,CAAC,CACzD,CAAA,GAAA,EAAA,CAAA;AACJ,EAAA,OAAO,CAAG,EAAA,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,OAAO,CAAU,OAAA,EAAA,QAAQ,CAA0B,uBAAA,EAAA,MAAM,CAAW,QAAA,EAAA,OAAO,CAAI,CAAA,EAAA,QAAQ,GAAG,IAAI,CAAA,CAAA,CAAA;AACxI,CAAA;AAgBgB,SAAA,8BAAA,CACd,KACA,MACQ,EAAA;AACR,EAAI,IAAA;AACF,IAAM,MAAA,EAAE,OAAO,IAAM,EAAA,GAAA,EAAK,cAAc,QAAS,EAAA,GAAI,YAAY,GAAG,CAAA,CAAA;AACpE,IACE,IAAA,CAAC,SACD,CAAC,IAAA,IACA,iBAAiB,QAChB,IAAA,YAAA,KAAiB,KACjB,IAAA,YAAA,KAAiB,KACnB,EAAA;AACA,MAAM,MAAA,IAAI,MAAM,2CAA2C,CAAA,CAAA;AAAA,KAC7D;AAEA,IAAA,MAAM,gBAAmB,GAAA,QAAA,CAAS,OAAQ,CAAA,KAAA,EAAO,EAAE,CAAA,CAAA;AACnD,IAAO,OAAA,CAAA,EAAG,MAAO,CAAA,UAAU,CAAa,UAAA,EAAA,KAAK,UAAU,IAAI,CAAA,KAAA,EAAQ,gBAAgB,CAAA,IAAA,EAAO,GAAG,CAAA,CAAA,CAAA;AAAA,WACtF,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,KAAM,CAAA,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAE,CAAA,CAAA,CAAA;AAAA,GAC/C;AACF,CAAA;AAQO,SAAS,iCACd,MACqC,EAAA;AACrC,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAA,IAAI,OAAO,KAAO,EAAA;AAChB,IAAQ,OAAA,CAAA,aAAA,GAAgB,CAAU,OAAA,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,CAAA;AAAA,GACrC,MAAA,IAAA,MAAA,CAAO,QAAY,IAAA,MAAA,CAAO,QAAU,EAAA;AAC7C,IAAM,MAAA,MAAA,GAAS,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA;AAC1E,IAAA,OAAA,CAAQ,aAAgB,GAAA,CAAA,MAAA,EAAS,MAAO,CAAA,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA,CAAA;AAAA,GAC5D;AAEA,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/gerrit/GerritIntegration.esm.js

@@ -0,0 +1,58 @@
+import { basicIntegrations } from '../helpers.esm.js';
+import { readGerritIntegrationConfigs } from './config.esm.js';
+import { parseGerritGitilesUrl, buildGerritGitilesUrl } from './core.esm.js';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+const _GerritIntegration = class _GerritIntegration {
+  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.startsWith("/")) {
+      const { branch, project } = parseGerritGitilesUrl(this.config, base);
+      return buildGerritGitilesUrl(this.config, project, branch, url);
+    }
+    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;
+  }
+};
+__publicField(_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
+  );
+});
+let GerritIntegration = _GerritIntegration;
+
+export { GerritIntegration };
+//# sourceMappingURL=GerritIntegration.esm.js.map

package/dist/gerrit/GerritIntegration.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GerritIntegration.esm.js","sources":["../../src/gerrit/GerritIntegration.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { basicIntegrations } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n  GerritIntegrationConfig,\n  readGerritIntegrationConfigs,\n} from './config';\nimport { parseGerritGitilesUrl, buildGerritGitilesUrl } from './core';\n\n/**\n * A Gerrit based integration.\n *\n * @public\n */\nexport class GerritIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GerritIntegration> = ({ config }) => {\n    const configs = readGerritIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.gerrit') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GerritIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  constructor(private readonly integrationConfig: GerritIntegrationConfig) {}\n\n  get type(): string {\n    return 'gerrit';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GerritIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    const { url, base, lineNumber } = options;\n    let updated;\n    if (url.startsWith('/')) {\n      const { branch, project } = parseGerritGitilesUrl(this.config, base);\n      return buildGerritGitilesUrl(this.config, project, branch, url);\n    }\n    if (url) {\n      updated = new URL(url, base);\n    } else {\n      updated = new URL(base);\n    }\n    if (lineNumber) {\n      updated.hash = lineNumber.toString();\n    }\n    return updated.toString();\n  }\n\n  resolveEditUrl(url: string): string {\n    // Not applicable for gerrit.\n    return url;\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;AA6BO,MAAM,kBAAA,GAAN,MAAM,kBAA4C,CAAA;AAAA,EAWvD,YAA6B,iBAA4C,EAAA;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA,CAAA;AAAA,GAA6C;AAAA,EAE1E,IAAI,IAAe,GAAA;AACjB,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA,EAEA,IAAI,KAAgB,GAAA;AAClB,IAAA,OAAO,KAAK,iBAAkB,CAAA,IAAA,CAAA;AAAA,GAChC;AAAA,EAEA,IAAI,MAAkC,GAAA;AACpC,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AAAA,EAEA,WAAW,OAIA,EAAA;AACT,IAAA,MAAM,EAAE,GAAA,EAAK,IAAM,EAAA,UAAA,EAAe,GAAA,OAAA,CAAA;AAClC,IAAI,IAAA,OAAA,CAAA;AACJ,IAAI,IAAA,GAAA,CAAI,UAAW,CAAA,GAAG,CAAG,EAAA;AACvB,MAAA,MAAM,EAAE,MAAQ,EAAA,OAAA,KAAY,qBAAsB,CAAA,IAAA,CAAK,QAAQ,IAAI,CAAA,CAAA;AACnE,MAAA,OAAO,qBAAsB,CAAA,IAAA,CAAK,MAAQ,EAAA,OAAA,EAAS,QAAQ,GAAG,CAAA,CAAA;AAAA,KAChE;AACA,IAAA,IAAI,GAAK,EAAA;AACP,MAAU,OAAA,GAAA,IAAI,GAAI,CAAA,GAAA,EAAK,IAAI,CAAA,CAAA;AAAA,KACtB,MAAA;AACL,MAAU,OAAA,GAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,KACxB;AACA,IAAA,IAAI,UAAY,EAAA;AACd,MAAQ,OAAA,CAAA,IAAA,GAAO,WAAW,QAAS,EAAA,CAAA;AAAA,KACrC;AACA,IAAA,OAAO,QAAQ,QAAS,EAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,eAAe,GAAqB,EAAA;AAElC,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACF,CAAA,CAAA;AAlDE,aAAA,CADW,kBACJ,EAAA,SAAA,EAAqD,CAAC,EAAE,QAAa,KAAA;AA9B9E,EAAA,IAAA,EAAA,CAAA;AA+BI,EAAA,MAAM,OAAU,GAAA,4BAAA;AAAA,IAAA,CACd,EAAO,GAAA,MAAA,CAAA,sBAAA,CAAuB,qBAAqB,CAAA,KAAnD,YAAwD,EAAC;AAAA,GAC3D,CAAA;AACA,EAAO,OAAA,iBAAA;AAAA,IACL,QAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,IAAI,kBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,IACzC,CAAA,CAAA,KAAK,EAAE,MAAO,CAAA,IAAA;AAAA,GAChB,CAAA;AACF,CAAA,CAAA,CAAA;AATK,IAAM,iBAAN,GAAA;;;;"}

package/dist/gerrit/config.esm.js

@@ -0,0 +1,58 @@
+import { trimEnd } from 'lodash';
+import { isValidHost, isValidUrl } from '../helpers.esm.js';
+
+function readGerritIntegrationConfig(config) {
+  var _a;
+  const host = config.getString("host");
+  let baseUrl = config.getOptionalString("baseUrl");
+  let cloneUrl = config.getOptionalString("cloneUrl");
+  let gitilesBaseUrl = config.getOptionalString("gitilesBaseUrl");
+  const username = config.getOptionalString("username");
+  const password = (_a = config.getOptionalString("password")) == null ? void 0 : _a.trim();
+  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`
+    );
+  } else if (cloneUrl && !isValidUrl(cloneUrl)) {
+    throw new Error(
+      `Invalid Gerrit integration config, '${cloneUrl}' is not a valid cloneUrl`
+    );
+  } else if (gitilesBaseUrl && !isValidUrl(gitilesBaseUrl)) {
+    throw new Error(
+      `Invalid Gerrit integration config, '${gitilesBaseUrl}' is not a valid gitilesBaseUrl`
+    );
+  }
+  if (baseUrl) {
+    baseUrl = trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  if (gitilesBaseUrl) {
+    gitilesBaseUrl = trimEnd(gitilesBaseUrl, "/");
+  } else {
+    gitilesBaseUrl = `https://${host}`;
+  }
+  if (cloneUrl) {
+    cloneUrl = trimEnd(cloneUrl, "/");
+  } else {
+    cloneUrl = baseUrl;
+  }
+  return {
+    host,
+    baseUrl,
+    cloneUrl,
+    gitilesBaseUrl,
+    username,
+    password
+  };
+}
+function readGerritIntegrationConfigs(configs) {
+  return configs.map(readGerritIntegrationConfig);
+}
+
+export { readGerritIntegrationConfig, readGerritIntegrationConfigs };
+//# sourceMappingURL=config.esm.js.map

package/dist/gerrit/config.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.esm.js","sources":["../../src/gerrit/config.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\n/**\n * The configuration parameters for a single Gerrit API provider.\n *\n * @public\n */\nexport type GerritIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. \"gerrit-review.com\"\n   */\n  host: string;\n\n  /**\n   * The optional base URL of the Gerrit instance. It is assumed that https\n   * is used and that the base path is \"/\" on the host. If that is not the\n   * case set the complete base url to the gerrit instance, e.g.\n   * \"https://gerrit-review.com/gerrit\". This is the url that you would open\n   * in a browser.\n   */\n  baseUrl?: string;\n\n  /**\n   * The optional base url to use for cloning a repository. If not set the\n   * baseUrl will be used.\n   */\n  cloneUrl?: string;\n\n  /**\n   * Optional base url for Gitiles. This is needed for creating a valid\n   * user-friendly url that can be used for browsing the content of the\n   * provider. If not set a default value will be created in the same way\n   * as the \"baseUrl\" option.\n   */\n  gitilesBaseUrl?: string;\n\n  /**\n   * The username to use for requests to gerrit.\n   */\n  username?: string;\n\n  /**\n   * The password or http token to use for authentication.\n   */\n  password?: string;\n};\n\n/**\n * Reads a single Gerrit integration config.\n *\n * @param config - The config object of a single integration\n *\n * @public\n */\nexport function readGerritIntegrationConfig(\n  config: Config,\n): GerritIntegrationConfig {\n  const host = config.getString('host');\n  let baseUrl = config.getOptionalString('baseUrl');\n  let cloneUrl = config.getOptionalString('cloneUrl');\n  let gitilesBaseUrl = config.getOptionalString('gitilesBaseUrl');\n  const username = config.getOptionalString('username');\n  const password = config.getOptionalString('password')?.trim();\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid Gerrit integration config, '${host}' is not a valid host`,\n    );\n  } else if (baseUrl && !isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid Gerrit integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  } else if (cloneUrl && !isValidUrl(cloneUrl)) {\n    throw new Error(\n      `Invalid Gerrit integration config, '${cloneUrl}' is not a valid cloneUrl`,\n    );\n  } else if (gitilesBaseUrl && !isValidUrl(gitilesBaseUrl)) {\n    throw new Error(\n      `Invalid Gerrit integration config, '${gitilesBaseUrl}' is not a valid gitilesBaseUrl`,\n    );\n  }\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n  if (gitilesBaseUrl) {\n    gitilesBaseUrl = trimEnd(gitilesBaseUrl, '/');\n  } else {\n    gitilesBaseUrl = `https://${host}`;\n  }\n  if (cloneUrl) {\n    cloneUrl = trimEnd(cloneUrl, '/');\n  } else {\n    cloneUrl = baseUrl;\n  }\n\n  return {\n    host,\n    baseUrl,\n    cloneUrl,\n    gitilesBaseUrl,\n    username,\n    password,\n  };\n}\n\n/**\n * Reads a set of Gerrit integration configs.\n *\n * @param configs - All of the integration config objects\n *\n * @public\n */\nexport function readGerritIntegrationConfigs(\n  configs: Config[],\n): GerritIntegrationConfig[] {\n  return configs.map(readGerritIntegrationConfig);\n}\n"],"names":[],"mappings":";;;AAwEO,SAAS,4BACd,MACyB,EAAA;AA1E3B,EAAA,IAAA,EAAA,CAAA;AA2EE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAI,IAAA,OAAA,GAAU,MAAO,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AAChD,EAAI,IAAA,QAAA,GAAW,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AAClD,EAAI,IAAA,cAAA,GAAiB,MAAO,CAAA,iBAAA,CAAkB,gBAAgB,CAAA,CAAA;AAC9D,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AACpD,EAAA,MAAM,QAAW,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,UAAU,MAAnC,IAAsC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,EAAA,CAAA;AAEvD,EAAI,IAAA,CAAC,WAAY,CAAA,IAAI,CAAG,EAAA;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA,CAAA;AAAA,KAC7C,CAAA;AAAA,GACS,MAAA,IAAA,OAAA,IAAW,CAAC,UAAA,CAAW,OAAO,CAAG,EAAA;AAC1C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,OAAO,CAAA,wBAAA,CAAA;AAAA,KAChD,CAAA;AAAA,GACS,MAAA,IAAA,QAAA,IAAY,CAAC,UAAA,CAAW,QAAQ,CAAG,EAAA;AAC5C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,QAAQ,CAAA,yBAAA,CAAA;AAAA,KACjD,CAAA;AAAA,GACS,MAAA,IAAA,cAAA,IAAkB,CAAC,UAAA,CAAW,cAAc,CAAG,EAAA;AACxD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,cAAc,CAAA,+BAAA,CAAA;AAAA,KACvD,CAAA;AAAA,GACF;AACA,EAAA,IAAI,OAAS,EAAA;AACX,IAAU,OAAA,GAAA,OAAA,CAAQ,SAAS,GAAG,CAAA,CAAA;AAAA,GACzB,MAAA;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,GAC3B;AACA,EAAA,IAAI,cAAgB,EAAA;AAClB,IAAiB,cAAA,GAAA,OAAA,CAAQ,gBAAgB,GAAG,CAAA,CAAA;AAAA,GACvC,MAAA;AACL,IAAA,cAAA,GAAiB,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,GAClC;AACA,EAAA,IAAI,QAAU,EAAA;AACZ,IAAW,QAAA,GAAA,OAAA,CAAQ,UAAU,GAAG,CAAA,CAAA;AAAA,GAC3B,MAAA;AACL,IAAW,QAAA,GAAA,OAAA,CAAA;AAAA,GACb;AAEA,EAAO,OAAA;AAAA,IACL,IAAA;AAAA,IACA,OAAA;AAAA,IACA,QAAA;AAAA,IACA,cAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF,CAAA;AASO,SAAS,6BACd,OAC2B,EAAA;AAC3B,EAAO,OAAA,OAAA,CAAQ,IAAI,2BAA2B,CAAA,CAAA;AAChD;;;;"}

package/dist/gerrit/core.esm.js

@@ -0,0 +1,106 @@
+import { trimStart } from 'lodash';
+
+const GERRIT_BODY_PREFIX = ")]}'";
+function parseGerritGitilesUrl(config, url) {
+  const baseUrlParse = new URL(config.gitilesBaseUrl);
+  const urlParse = new URL(url);
+  const urlPath = urlParse.pathname.substring(urlParse.pathname.startsWith("/a/") ? 2 : 0).replace(baseUrlParse.pathname, "");
+  const parts = urlPath.split("/").filter((p) => !!p);
+  const projectEndIndex = parts.indexOf("+");
+  if (projectEndIndex <= 0) {
+    throw new Error(`Unable to parse project from url: ${url}`);
+  }
+  const project = trimStart(parts.slice(0, projectEndIndex).join("/"), "/");
+  const branchIndex = parts.indexOf("heads");
+  if (branchIndex <= 0) {
+    throw new Error(`Unable to parse branch from url: ${url}`);
+  }
+  const branch = parts[branchIndex + 1];
+  const filePath = parts.slice(branchIndex + 2).join("/");
+  return {
+    branch,
+    filePath: filePath === "" ? "/" : filePath,
+    project
+  };
+}
+function buildGerritGitilesUrl(config, project, branch, filePath) {
+  return `${config.gitilesBaseUrl}/${project}/+/refs/heads/${branch}/${trimStart(filePath, "/")}`;
+}
+function buildGerritGitilesArchiveUrl(config, project, branch, filePath) {
+  const archiveName = filePath === "/" || filePath === "" ? ".tar.gz" : `/${filePath}.tar.gz`;
+  return `${getGitilesAuthenticationUrl(
+    config
+  )}/${project}/+archive/refs/heads/${branch}${archiveName}`;
+}
+function getAuthenticationPrefix(config) {
+  return config.password ? "/a/" : "/";
+}
+function getGitilesAuthenticationUrl(config) {
+  if (!config.baseUrl || !config.gitilesBaseUrl) {
+    throw new Error(
+      "Unexpected Gerrit config values. baseUrl or gitilesBaseUrl not set."
+    );
+  }
+  if (config.gitilesBaseUrl.startsWith(config.baseUrl)) {
+    return config.gitilesBaseUrl.replace(
+      config.baseUrl.concat("/"),
+      config.baseUrl.concat(getAuthenticationPrefix(config))
+    );
+  }
+  if (config.password) {
+    throw new Error(
+      "Since the baseUrl (Gerrit) is not part of the gitilesBaseUrl, an authentication URL could not be constructed."
+    );
+  }
+  return config.gitilesBaseUrl;
+}
+function getGerritBranchApiUrl(config, url) {
+  const { branch, project } = parseGerritGitilesUrl(config, url);
+  return `${config.baseUrl}${getAuthenticationPrefix(
+    config
+  )}projects/${encodeURIComponent(project)}/branches/${branch}`;
+}
+function getGerritCloneRepoUrl(config, url) {
+  const { project } = parseGerritGitilesUrl(config, url);
+  return `${config.cloneUrl}${getAuthenticationPrefix(config)}${project}`;
+}
+function getGerritFileContentsApiUrl(config, url) {
+  const { branch, filePath, project } = parseGerritGitilesUrl(config, url);
+  return `${config.baseUrl}${getAuthenticationPrefix(
+    config
+  )}projects/${encodeURIComponent(
+    project
+  )}/branches/${branch}/files/${encodeURIComponent(filePath)}/content`;
+}
+function getGerritProjectsApiUrl(config) {
+  return `${config.baseUrl}${getAuthenticationPrefix(config)}projects/`;
+}
+function getGerritRequestOptions(config) {
+  const headers = {};
+  if (!config.password) {
+    return headers;
+  }
+  const buffer = Buffer.from(`${config.username}:${config.password}`, "utf8");
+  headers.Authorization = `Basic ${buffer.toString("base64")}`;
+  return {
+    headers
+  };
+}
+async function parseGerritJsonResponse(response) {
+  const responseBody = await response.text();
+  if (responseBody.startsWith(GERRIT_BODY_PREFIX)) {
+    try {
+      return JSON.parse(responseBody.slice(GERRIT_BODY_PREFIX.length));
+    } catch (ex) {
+      throw new Error(
+        `Invalid response from Gerrit: ${responseBody.slice(0, 10)} - ${ex}`
+      );
+    }
+  }
+  throw new Error(
+    `Gerrit JSON body prefix missing. Found: ${responseBody.slice(0, 10)}`
+  );
+}
+
+export { buildGerritGitilesArchiveUrl, buildGerritGitilesUrl, getAuthenticationPrefix, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitilesAuthenticationUrl, parseGerritGitilesUrl, parseGerritJsonResponse };
+//# sourceMappingURL=core.esm.js.map

package/dist/gerrit/core.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.esm.js","sources":["../../src/gerrit/core.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { trimStart } from 'lodash';\nimport { GerritIntegrationConfig } from './config';\n\nconst GERRIT_BODY_PREFIX = \")]}'\";\n\n/**\n * Parse a Gitiles URL and return branch, file path and project.\n *\n * @remarks\n *\n * Gerrit only handles code reviews so it does not have a native way to browse\n * or showing the content of gits. Image if Github only had the \"pull requests\"\n * tab.\n *\n * Any source code browsing is instead handled by optional services outside\n * Gerrit. The url format chosen for the Gerrit url reader is the one used by\n * the Gitiles project. Gerrit will work perfectly with Backstage without\n * having Gitiles installed but there are some places in the Backstage GUI\n * with links to the url used by the url reader. These will not work unless\n * the urls point to an actual Gitiles installation.\n *\n * Gitiles url:\n * https://g.com/optional_path/\\{project\\}/+/refs/heads/\\{branch\\}/\\{filePath\\}\n * https://g.com/a/optional_path/\\{project\\}/+/refs/heads/\\{branch\\}/\\{filePath\\}\n *\n *\n * @param url - An URL pointing to a file stored in git.\n * @public\n */\n\nexport function parseGerritGitilesUrl(\n  config: GerritIntegrationConfig,\n  url: string,\n): { branch: string; filePath: string; project: string } {\n  const baseUrlParse = new URL(config.gitilesBaseUrl!);\n  const urlParse = new URL(url);\n\n  // Remove the gerrit authentication prefix '/a/' from the url\n  // In case of the gitilesBaseUrl is https://review.gerrit.com/plugins/gitiles\n  // and the url provided is https://review.gerrit.com/a/plugins/gitiles/...\n  // remove the prefix only if the pathname start with '/a/'\n  const urlPath = urlParse.pathname\n    .substring(urlParse.pathname.startsWith('/a/') ? 2 : 0)\n    .replace(baseUrlParse.pathname, '');\n\n  const parts = urlPath.split('/').filter(p => !!p);\n\n  const projectEndIndex = parts.indexOf('+');\n\n  if (projectEndIndex <= 0) {\n    throw new Error(`Unable to parse project from url: ${url}`);\n  }\n  const project = trimStart(parts.slice(0, projectEndIndex).join('/'), '/');\n\n  const branchIndex = parts.indexOf('heads');\n  if (branchIndex <= 0) {\n    throw new Error(`Unable to parse branch from url: ${url}`);\n  }\n  const branch = parts[branchIndex + 1];\n  const filePath = parts.slice(branchIndex + 2).join('/');\n\n  return {\n    branch,\n    filePath: filePath === '' ? '/' : filePath,\n    project,\n  };\n}\n\n/**\n * Build a Gerrit Gitiles url that targets a specific path.\n *\n * @param config - A Gerrit provider config.\n * @param project - The name of the git project\n * @param branch - The branch we will target.\n * @param filePath - The absolute file path.\n * @public\n */\nexport function buildGerritGitilesUrl(\n  config: GerritIntegrationConfig,\n  project: string,\n  branch: string,\n  filePath: string,\n): string {\n  return `${\n    config.gitilesBaseUrl\n  }/${project}/+/refs/heads/${branch}/${trimStart(filePath, '/')}`;\n}\n\n/**\n * Build a Gerrit Gitiles archive url that targets a specific branch and path\n *\n * @param config - A Gerrit provider config.\n * @param project - The name of the git project\n * @param branch - The branch we will target.\n * @param filePath - The absolute file path.\n * @public\n */\nexport function buildGerritGitilesArchiveUrl(\n  config: GerritIntegrationConfig,\n  project: string,\n  branch: string,\n  filePath: string,\n): string {\n  const archiveName =\n    filePath === '/' || filePath === '' ? '.tar.gz' : `/${filePath}.tar.gz`;\n  return `${getGitilesAuthenticationUrl(\n    config,\n  )}/${project}/+archive/refs/heads/${branch}${archiveName}`;\n}\n\n/**\n * Return the authentication prefix.\n *\n * @remarks\n *\n * To authenticate with a password the API url must be prefixed with \"/a/\".\n * If no password is set anonymous access (without the prefix) will\n * be used.\n *\n * @param config - A Gerrit provider config.\n * @public\n */\nexport function getAuthenticationPrefix(\n  config: GerritIntegrationConfig,\n): string {\n  return config.password ? '/a/' : '/';\n}\n\n/**\n * Return the authentication gitiles url.\n *\n * @remarks\n *\n * To authenticate with a password the API url must be prefixed with \"/a/\".\n * If no password is set anonymous access (without the prefix) will\n * be used.\n *\n * @param config - A Gerrit provider config.\n */\nexport function getGitilesAuthenticationUrl(\n  config: GerritIntegrationConfig,\n): string {\n  if (!config.baseUrl || !config.gitilesBaseUrl) {\n    throw new Error(\n      'Unexpected Gerrit config values. baseUrl or gitilesBaseUrl not set.',\n    );\n  }\n  if (config.gitilesBaseUrl.startsWith(config.baseUrl)) {\n    return config.gitilesBaseUrl.replace(\n      config.baseUrl.concat('/'),\n      config.baseUrl.concat(getAuthenticationPrefix(config)),\n    );\n  }\n  if (config.password) {\n    throw new Error(\n      'Since the baseUrl (Gerrit) is not part of the gitilesBaseUrl, an authentication URL could not be constructed.',\n    );\n  }\n  return config.gitilesBaseUrl!;\n}\n\n/**\n * Return the url to get branch info from the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritBranchApiUrl(\n  config: GerritIntegrationConfig,\n  url: string,\n) {\n  const { branch, project } = parseGerritGitilesUrl(config, url);\n\n  return `${config.baseUrl}${getAuthenticationPrefix(\n    config,\n  )}projects/${encodeURIComponent(project)}/branches/${branch}`;\n}\n\n/**\n * Return the url to clone the repo that is referenced by the url.\n *\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritCloneRepoUrl(\n  config: GerritIntegrationConfig,\n  url: string,\n) {\n  const { project } = parseGerritGitilesUrl(config, url);\n\n  return `${config.cloneUrl}${getAuthenticationPrefix(config)}${project}`;\n}\n\n/**\n * Return the url to fetch the contents of a file using the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritFileContentsApiUrl(\n  config: GerritIntegrationConfig,\n  url: string,\n) {\n  const { branch, filePath, project } = parseGerritGitilesUrl(config, url);\n\n  return `${config.baseUrl}${getAuthenticationPrefix(\n    config,\n  )}projects/${encodeURIComponent(\n    project,\n  )}/branches/${branch}/files/${encodeURIComponent(filePath)}/content`;\n}\n\n/**\n * Return the url to query available projects using the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @public\n */\nexport function getGerritProjectsApiUrl(config: GerritIntegrationConfig) {\n  return `${config.baseUrl}${getAuthenticationPrefix(config)}projects/`;\n}\n\n/**\n * Return request headers for a Gerrit provider.\n *\n * @param config - A Gerrit provider config\n * @public\n */\nexport function getGerritRequestOptions(config: GerritIntegrationConfig): {\n  headers?: Record<string, string>;\n} {\n  const headers: Record<string, string> = {};\n\n  if (!config.password) {\n    return headers;\n  }\n  const buffer = Buffer.from(`${config.username}:${config.password}`, 'utf8');\n  headers.Authorization = `Basic ${buffer.toString('base64')}`;\n  return {\n    headers,\n  };\n}\n\n/**\n * Parse the json response from Gerrit and strip the magic prefix.\n *\n * @remarks\n *\n * To prevent against XSSI attacks the JSON response body from Gerrit starts\n * with a magic prefix that must be stripped before it can be fed to a JSON\n * parser.\n *\n * @param response - An API response.\n * @public\n */\nexport async function parseGerritJsonResponse(\n  response: Response,\n): Promise<unknown> {\n  const responseBody = await response.text();\n  if (responseBody.startsWith(GERRIT_BODY_PREFIX)) {\n    try {\n      return JSON.parse(responseBody.slice(GERRIT_BODY_PREFIX.length));\n    } catch (ex) {\n      throw new Error(\n        `Invalid response from Gerrit: ${responseBody.slice(0, 10)} - ${ex}`,\n      );\n    }\n  }\n  throw new Error(\n    `Gerrit JSON body prefix missing. Found: ${responseBody.slice(0, 10)}`,\n  );\n}\n"],"names":[],"mappings":";;AAkBA,MAAM,kBAAqB,GAAA,MAAA,CAAA;AA2BX,SAAA,qBAAA,CACd,QACA,GACuD,EAAA;AACvD,EAAA,MAAM,YAAe,GAAA,IAAI,GAAI,CAAA,MAAA,CAAO,cAAe,CAAA,CAAA;AACnD,EAAM,MAAA,QAAA,GAAW,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAM5B,EAAA,MAAM,OAAU,GAAA,QAAA,CAAS,QACtB,CAAA,SAAA,CAAU,SAAS,QAAS,CAAA,UAAA,CAAW,KAAK,CAAA,GAAI,IAAI,CAAC,CAAA,CACrD,OAAQ,CAAA,YAAA,CAAa,UAAU,EAAE,CAAA,CAAA;AAEpC,EAAM,MAAA,KAAA,GAAQ,QAAQ,KAAM,CAAA,GAAG,EAAE,MAAO,CAAA,CAAA,CAAA,KAAK,CAAC,CAAC,CAAC,CAAA,CAAA;AAEhD,EAAM,MAAA,eAAA,GAAkB,KAAM,CAAA,OAAA,CAAQ,GAAG,CAAA,CAAA;AAEzC,EAAA,IAAI,mBAAmB,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAqC,kCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAC5D;AACA,EAAM,MAAA,OAAA,GAAU,SAAU,CAAA,KAAA,CAAM,KAAM,CAAA,CAAA,EAAG,eAAe,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,EAAG,GAAG,CAAA,CAAA;AAExE,EAAM,MAAA,WAAA,GAAc,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AACzC,EAAA,IAAI,eAAe,CAAG,EAAA;AACpB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAoC,iCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAC3D;AACA,EAAM,MAAA,MAAA,GAAS,KAAM,CAAA,WAAA,GAAc,CAAC,CAAA,CAAA;AACpC,EAAA,MAAM,WAAW,KAAM,CAAA,KAAA,CAAM,cAAc,CAAC,CAAA,CAAE,KAAK,GAAG,CAAA,CAAA;AAEtD,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,QAAA,EAAU,QAAa,KAAA,EAAA,GAAK,GAAM,GAAA,QAAA;AAAA,IAClC,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AAWO,SAAS,qBACd,CAAA,MAAA,EACA,OACA,EAAA,MAAA,EACA,QACQ,EAAA;AACR,EAAO,OAAA,CAAA,EACL,MAAO,CAAA,cACT,CAAI,CAAA,EAAA,OAAO,CAAiB,cAAA,EAAA,MAAM,CAAI,CAAA,EAAA,SAAA,CAAU,QAAU,EAAA,GAAG,CAAC,CAAA,CAAA,CAAA;AAChE,CAAA;AAWO,SAAS,4BACd,CAAA,MAAA,EACA,OACA,EAAA,MAAA,EACA,QACQ,EAAA;AACR,EAAA,MAAM,cACJ,QAAa,KAAA,GAAA,IAAO,aAAa,EAAK,GAAA,SAAA,GAAY,IAAI,QAAQ,CAAA,OAAA,CAAA,CAAA;AAChE,EAAA,OAAO,CAAG,EAAA,2BAAA;AAAA,IACR,MAAA;AAAA,GACD,CAAI,CAAA,EAAA,OAAO,CAAwB,qBAAA,EAAA,MAAM,GAAG,WAAW,CAAA,CAAA,CAAA;AAC1D,CAAA;AAcO,SAAS,wBACd,MACQ,EAAA;AACR,EAAO,OAAA,MAAA,CAAO,WAAW,KAAQ,GAAA,GAAA,CAAA;AACnC,CAAA;AAaO,SAAS,4BACd,MACQ,EAAA;AACR,EAAA,IAAI,CAAC,MAAA,CAAO,OAAW,IAAA,CAAC,OAAO,cAAgB,EAAA;AAC7C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qEAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,IAAI,MAAO,CAAA,cAAA,CAAe,UAAW,CAAA,MAAA,CAAO,OAAO,CAAG,EAAA;AACpD,IAAA,OAAO,OAAO,cAAe,CAAA,OAAA;AAAA,MAC3B,MAAA,CAAO,OAAQ,CAAA,MAAA,CAAO,GAAG,CAAA;AAAA,MACzB,MAAO,CAAA,OAAA,CAAQ,MAAO,CAAA,uBAAA,CAAwB,MAAM,CAAC,CAAA;AAAA,KACvD,CAAA;AAAA,GACF;AACA,EAAA,IAAI,OAAO,QAAU,EAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,+GAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,OAAO,MAAO,CAAA,cAAA,CAAA;AAChB,CAAA;AASgB,SAAA,qBAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,MAAQ,EAAA,OAAA,EAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAE7D,EAAO,OAAA,CAAA,EAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA;AAAA,IACzB,MAAA;AAAA,GACD,CAAY,SAAA,EAAA,kBAAA,CAAmB,OAAO,CAAC,aAAa,MAAM,CAAA,CAAA,CAAA;AAC7D,CAAA;AAQgB,SAAA,qBAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,OAAA,EAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAErD,EAAO,OAAA,CAAA,EAAG,OAAO,QAAQ,CAAA,EAAG,wBAAwB,MAAM,CAAC,GAAG,OAAO,CAAA,CAAA,CAAA;AACvE,CAAA;AASgB,SAAA,2BAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,MAAQ,EAAA,QAAA,EAAU,SAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAEvE,EAAO,OAAA,CAAA,EAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA;AAAA,IACzB,MAAA;AAAA,GACD,CAAY,SAAA,EAAA,kBAAA;AAAA,IACX,OAAA;AAAA,GACD,CAAa,UAAA,EAAA,MAAM,CAAU,OAAA,EAAA,kBAAA,CAAmB,QAAQ,CAAC,CAAA,QAAA,CAAA,CAAA;AAC5D,CAAA;AAQO,SAAS,wBAAwB,MAAiC,EAAA;AACvE,EAAA,OAAO,GAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA,CAAwB,MAAM,CAAC,CAAA,SAAA,CAAA,CAAA;AAC5D,CAAA;AAQO,SAAS,wBAAwB,MAEtC,EAAA;AACA,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAI,IAAA,CAAC,OAAO,QAAU,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AACA,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA;AAC1E,EAAA,OAAA,CAAQ,aAAgB,GAAA,CAAA,MAAA,EAAS,MAAO,CAAA,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA,CAAA;AAC1D,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AAcA,eAAsB,wBACpB,QACkB,EAAA;AAClB,EAAM,MAAA,YAAA,GAAe,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACzC,EAAI,IAAA,YAAA,CAAa,UAAW,CAAA,kBAAkB,CAAG,EAAA;AAC/C,IAAI,IAAA;AACF,MAAA,OAAO,KAAK,KAAM,CAAA,YAAA,CAAa,KAAM,CAAA,kBAAA,CAAmB,MAAM,CAAC,CAAA,CAAA;AAAA,aACxD,EAAI,EAAA;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,iCAAiC,YAAa,CAAA,KAAA,CAAM,GAAG,EAAE,CAAC,MAAM,EAAE,CAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,MAAM,IAAI,KAAA;AAAA,IACR,CAA2C,wCAAA,EAAA,YAAA,CAAa,KAAM,CAAA,CAAA,EAAG,EAAE,CAAC,CAAA,CAAA;AAAA,GACtE,CAAA;AACF;;;;"}

package/dist/gitea/GiteaIntegration.esm.js

@@ -0,0 +1,40 @@
+import { basicIntegrations, defaultScmResolveUrl } from '../helpers.esm.js';
+import { readGiteaConfig } from './config.esm.js';
+import { getGiteaEditContentsUrl } from './core.esm.js';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+const _GiteaIntegration = class _GiteaIntegration {
+  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);
+  }
+};
+__publicField(_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
+  );
+});
+let GiteaIntegration = _GiteaIntegration;
+
+export { GiteaIntegration };
+//# sourceMappingURL=GiteaIntegration.esm.js.map

package/dist/gitea/GiteaIntegration.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GiteaIntegration.esm.js","sources":["../../src/gitea/GiteaIntegration.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { basicIntegrations, defaultScmResolveUrl } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport { GiteaIntegrationConfig, readGiteaConfig } from './config';\nimport { getGiteaEditContentsUrl } from './core';\n\n/**\n * A Gitea based integration.\n *\n * @public\n */\nexport class GiteaIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GiteaIntegration> = ({ config }) => {\n    const configs = config.getOptionalConfigArray('integrations.gitea') ?? [];\n    const giteaConfigs = configs.map(c => readGiteaConfig(c));\n\n    return basicIntegrations(\n      giteaConfigs.map(c => new GiteaIntegration(c)),\n      (gitea: GiteaIntegration) => gitea.config.host,\n    );\n  };\n\n  constructor(readonly config: GiteaIntegrationConfig) {}\n\n  get type(): string {\n    return 'gitea';\n  }\n\n  get title(): string {\n    return this.config.host;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number | undefined;\n  }): string {\n    return defaultScmResolveUrl(options);\n  }\n\n  resolveEditUrl(url: string): string {\n    return getGiteaEditContentsUrl(this.config, url);\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;AAyBO,MAAM,iBAAA,GAAN,MAAM,iBAA2C,CAAA;AAAA,EAWtD,YAAqB,MAAgC,EAAA;AAAhC,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAAiC;AAAA,EAEtD,IAAI,IAAe,GAAA;AACjB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAAA,EAEA,IAAI,KAAgB,GAAA;AAClB,IAAA,OAAO,KAAK,MAAO,CAAA,IAAA,CAAA;AAAA,GACrB;AAAA,EAEA,WAAW,OAIA,EAAA;AACT,IAAA,OAAO,qBAAqB,OAAO,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,eAAe,GAAqB,EAAA;AAClC,IAAO,OAAA,uBAAA,CAAwB,IAAK,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAAA,GACjD;AACF,CAAA,CAAA;AA/BE,aAAA,CADW,iBACJ,EAAA,SAAA,EAAoD,CAAC,EAAE,QAAa,KAAA;AA1B7E,EAAA,IAAA,EAAA,CAAA;AA2BI,EAAA,MAAM,WAAU,EAAO,GAAA,MAAA,CAAA,sBAAA,CAAuB,oBAAoB,CAAA,KAAlD,YAAuD,EAAC,CAAA;AACxE,EAAA,MAAM,eAAe,OAAQ,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,eAAA,CAAgB,CAAC,CAAC,CAAA,CAAA;AAExD,EAAO,OAAA,iBAAA;AAAA,IACL,aAAa,GAAI,CAAA,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAiB,CAAC,CAAC,CAAA;AAAA,IAC7C,CAAC,KAA4B,KAAA,KAAA,CAAM,MAAO,CAAA,IAAA;AAAA,GAC5C,CAAA;AACF,CAAA,CAAA,CAAA;AATK,IAAM,gBAAN,GAAA;;;;"}

package/dist/gitea/config.esm.js

@@ -0,0 +1,33 @@
+import { trimEnd } from 'lodash';
+import { isValidHost, isValidUrl } from '../helpers.esm.js';
+
+function readGiteaConfig(config) {
+  var _a;
+  const host = config.getString("host");
+  let baseUrl = config.getOptionalString("baseUrl");
+  const username = config.getOptionalString("username");
+  const password = (_a = config.getOptionalString("password")) == null ? void 0 : _a.trim();
+  if (!isValidHost(host)) {
+    throw new Error(
+      `Invalid Gitea integration config, '${host}' is not a valid host`
+    );
+  } else if (baseUrl && !isValidUrl(baseUrl)) {
+    throw new Error(
+      `Invalid Gitea integration config, '${baseUrl}' is not a valid baseUrl`
+    );
+  }
+  if (baseUrl) {
+    baseUrl = trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  return {
+    host,
+    baseUrl,
+    username,
+    password
+  };
+}
+
+export { readGiteaConfig };
+//# sourceMappingURL=config.esm.js.map

package/dist/gitea/config.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.esm.js","sources":["../../src/gitea/config.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\n/**\n * The configuration for a single Gitea integration.\n *\n * @public\n */\nexport type GiteaIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. \"gitea.website.com\"\n   */\n  host: string;\n  /**\n   * The optional base URL of the Gitea instance. It is assumed that https\n   * is used and that the base path is \"/\" on the host. If that is not the\n   * case set the complete base url to the gitea instance, e.g.\n   * \"https://gitea.website.com/\". This is the url that you would open\n   * in a browser.\n   */\n  baseUrl?: string;\n  /**\n   * The username to use for requests to gitea.\n   */\n  username?: string;\n\n  /**\n   * The password or http token to use for authentication.\n   */\n  password?: string;\n};\n\n/**\n * Parses a location config block for use in GiteaIntegration\n *\n * @public\n */\nexport function readGiteaConfig(config: Config): GiteaIntegrationConfig {\n  const host = config.getString('host');\n  let baseUrl = config.getOptionalString('baseUrl');\n  const username = config.getOptionalString('username');\n  const password = config.getOptionalString('password')?.trim();\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid Gitea integration config, '${host}' is not a valid host`,\n    );\n  } else if (baseUrl && !isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid Gitea integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  }\n\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n\n  return {\n    host,\n    baseUrl,\n    username,\n    password,\n  };\n}\n"],"names":[],"mappings":";;;AAsDO,SAAS,gBAAgB,MAAwC,EAAA;AAtDxE,EAAA,IAAA,EAAA,CAAA;AAuDE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAI,IAAA,OAAA,GAAU,MAAO,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AAChD,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AACpD,EAAA,MAAM,QAAW,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,UAAU,MAAnC,IAAsC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,EAAA,CAAA;AAEvD,EAAI,IAAA,CAAC,WAAY,CAAA,IAAI,CAAG,EAAA;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sCAAsC,IAAI,CAAA,qBAAA,CAAA;AAAA,KAC5C,CAAA;AAAA,GACS,MAAA,IAAA,OAAA,IAAW,CAAC,UAAA,CAAW,OAAO,CAAG,EAAA;AAC1C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sCAAsC,OAAO,CAAA,wBAAA,CAAA;AAAA,KAC/C,CAAA;AAAA,GACF;AAEA,EAAA,IAAI,OAAS,EAAA;AACX,IAAU,OAAA,GAAA,OAAA,CAAQ,SAAS,GAAG,CAAA,CAAA;AAAA,GACzB,MAAA;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,GAC3B;AAEA,EAAO,OAAA;AAAA,IACL,IAAA;AAAA,IACA,OAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/gitea/core.esm.js

@@ -0,0 +1,53 @@
+function getGiteaEditContentsUrl(config, url) {
+  const giteaUrl = parseGiteaUrl(config, url);
+  return `${giteaUrl.url}/${giteaUrl.owner}/${giteaUrl.name}/_edit/${giteaUrl.ref}/${giteaUrl.path}`;
+}
+function getGiteaFileContentsUrl(config, url) {
+  const giteaUrl = parseGiteaUrl(config, url);
+  return `${giteaUrl.url}/api/v1/repos/${giteaUrl.owner}/${giteaUrl.name}/contents/${giteaUrl.path}?ref=${giteaUrl.ref}`;
+}
+function getGiteaArchiveUrl(config, url) {
+  const giteaUrl = parseGiteaUrl(config, url);
+  return `${giteaUrl.url}/api/v1/repos/${giteaUrl.owner}/${giteaUrl.name}/archive/${giteaUrl.ref}.tar.gz`;
+}
+function getGiteaLatestCommitUrl(config, url) {
+  const giteaUrl = parseGiteaUrl(config, url);
+  return `${giteaUrl.url}/api/v1/repos/${giteaUrl.owner}/${giteaUrl.name}/git/commits/${giteaUrl.ref}`;
+}
+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
+  };
+}
+function parseGiteaUrl(config, url) {
+  var _a;
+  const baseUrl = (_a = config.baseUrl) != null ? _a : `https://${config.host}`;
+  try {
+    const [_blank, owner, name, _src, _branch, ref, ...path] = url.replace(baseUrl, "").split("/");
+    const pathWithoutSlash = path.join("/").replace(/^\//, "");
+    return {
+      url: baseUrl,
+      owner,
+      name,
+      ref,
+      path: pathWithoutSlash
+    };
+  } catch (e) {
+    throw new Error(`Incorrect URL: ${url}, ${e}`);
+  }
+}
+
+export { getGiteaArchiveUrl, getGiteaEditContentsUrl, getGiteaFileContentsUrl, getGiteaLatestCommitUrl, getGiteaRequestOptions, parseGiteaUrl };
+//# sourceMappingURL=core.esm.js.map

package/dist/gitea/core.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.esm.js","sources":["../../src/gitea/core.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { GiteaIntegrationConfig } from './config';\n\n/**\n * Given a URL pointing to a file, returns a URL\n * for editing the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://gitea.com/a/b/src/branchname/path/to/c.yaml\n * or:   https://gitea.com/a/b/_edit/branchname/path/to/c.yaml\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @public\n */\nexport function getGiteaEditContentsUrl(\n  config: GiteaIntegrationConfig,\n  url: string,\n) {\n  const giteaUrl = parseGiteaUrl(config, url);\n  return `${giteaUrl.url}/${giteaUrl.owner}/${giteaUrl.name}/_edit/${giteaUrl.ref}/${giteaUrl.path}`;\n}\n\n/**\n * Given a URL pointing to a file, returns an api URL\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://gitea.com/a/b/src/branch/branchname/path/to/c.yaml\n * to:   https://gitea.com/api/v1/repos/a/b/contents/path/to/c.yaml?ref=branchname\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @public\n */\nexport function getGiteaFileContentsUrl(\n  config: GiteaIntegrationConfig,\n  url: string,\n) {\n  const giteaUrl = parseGiteaUrl(config, url);\n  return `${giteaUrl.url}/api/v1/repos/${giteaUrl.owner}/${giteaUrl.name}/contents/${giteaUrl.path}?ref=${giteaUrl.ref}`;\n}\n\n/**\n * Given a URL pointing to a repository/path, returns a URL\n * for archive contents of the repository.\n *\n * @remarks\n *\n * Converts\n * from: https://gitea.com/a/b/src/branchname\n * or:   https://gitea.com/api/v1/repos/a/b/archive/branchname.tar.gz\n *\n * @param url - A URL pointing to a repository/path\n * @param config - The relevant provider config\n * @public\n */\nexport function getGiteaArchiveUrl(\n  config: GiteaIntegrationConfig,\n  url: string,\n) {\n  const giteaUrl = parseGiteaUrl(config, url);\n  return `${giteaUrl.url}/api/v1/repos/${giteaUrl.owner}/${giteaUrl.name}/archive/${giteaUrl.ref}.tar.gz`;\n}\n\n/**\n * Given a URL pointing to a repository branch, returns a URL\n * for latest commit information.\n *\n * @remarks\n *\n * Converts\n * from: https://gitea.com/a/b/src/branchname\n * or:   https://gitea.com/api/v1/repos/a/b/git/commits/branchname\n *\n * @param url - A URL pointing to a repository branch\n * @param config - The relevant provider config\n * @public\n */\nexport function getGiteaLatestCommitUrl(\n  config: GiteaIntegrationConfig,\n  url: string,\n) {\n  const giteaUrl = parseGiteaUrl(config, url);\n  return `${giteaUrl.url}/api/v1/repos/${giteaUrl.owner}/${giteaUrl.name}/git/commits/${giteaUrl.ref}`;\n}\n\n/**\n * Return request headers for a Gitea provider.\n *\n * @param config - A Gitea provider config\n * @public\n */\nexport function getGiteaRequestOptions(config: GiteaIntegrationConfig): {\n  headers?: Record<string, string>;\n} {\n  const headers: Record<string, string> = {};\n  const { username, password } = config;\n\n  if (!password) {\n    return headers;\n  }\n\n  if (username) {\n    headers.Authorization = `basic ${Buffer.from(\n      `${username}:${password}`,\n    ).toString('base64')}`;\n  } else {\n    headers.Authorization = `token ${password}`;\n  }\n\n  return {\n    headers,\n  };\n}\n\n/**\n * Return parsed git url properties.\n *\n * @param config - A Gitea provider config\n * @param url - A URL pointing to a repository\n * @public\n */\nexport function parseGiteaUrl(\n  config: GiteaIntegrationConfig,\n  url: string,\n): {\n  url: string;\n  owner: string;\n  name: string;\n  ref: string;\n  path: string;\n} {\n  const baseUrl = config.baseUrl ?? `https://${config.host}`;\n  try {\n    const [_blank, owner, name, _src, _branch, ref, ...path] = url\n      .replace(baseUrl, '')\n      .split('/');\n    const pathWithoutSlash = path.join('/').replace(/^\\//, '');\n\n    return {\n      url: baseUrl,\n      owner: owner,\n      name: name,\n      ref: ref,\n      path: pathWithoutSlash,\n    };\n  } catch (e) {\n    throw new Error(`Incorrect URL: ${url}, ${e}`);\n  }\n}\n"],"names":[],"mappings":"AA+BgB,SAAA,uBAAA,CACd,QACA,GACA,EAAA;AACA,EAAM,MAAA,QAAA,GAAW,aAAc,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAC1C,EAAA,OAAO,CAAG,EAAA,QAAA,CAAS,GAAG,CAAA,CAAA,EAAI,SAAS,KAAK,CAAA,CAAA,EAAI,QAAS,CAAA,IAAI,CAAU,OAAA,EAAA,QAAA,CAAS,GAAG,CAAA,CAAA,EAAI,SAAS,IAAI,CAAA,CAAA,CAAA;AAClG,CAAA;AAgBgB,SAAA,uBAAA,CACd,QACA,GACA,EAAA;AACA,EAAM,MAAA,QAAA,GAAW,aAAc,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAC1C,EAAA,OAAO,CAAG,EAAA,QAAA,CAAS,GAAG,CAAA,cAAA,EAAiB,SAAS,KAAK,CAAA,CAAA,EAAI,QAAS,CAAA,IAAI,CAAa,UAAA,EAAA,QAAA,CAAS,IAAI,CAAA,KAAA,EAAQ,SAAS,GAAG,CAAA,CAAA,CAAA;AACtH,CAAA;AAgBgB,SAAA,kBAAA,CACd,QACA,GACA,EAAA;AACA,EAAM,MAAA,QAAA,GAAW,aAAc,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAC1C,EAAO,OAAA,CAAA,EAAG,QAAS,CAAA,GAAG,CAAiB,cAAA,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA,EAAI,QAAS,CAAA,IAAI,CAAY,SAAA,EAAA,QAAA,CAAS,GAAG,CAAA,OAAA,CAAA,CAAA;AAChG,CAAA;AAgBgB,SAAA,uBAAA,CACd,QACA,GACA,EAAA;AACA,EAAM,MAAA,QAAA,GAAW,aAAc,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAC1C,EAAO,OAAA,CAAA,EAAG,QAAS,CAAA,GAAG,CAAiB,cAAA,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA,EAAI,QAAS,CAAA,IAAI,CAAgB,aAAA,EAAA,QAAA,CAAS,GAAG,CAAA,CAAA,CAAA;AACpG,CAAA;AAQO,SAAS,uBAAuB,MAErC,EAAA;AACA,EAAA,MAAM,UAAkC,EAAC,CAAA;AACzC,EAAM,MAAA,EAAE,QAAU,EAAA,QAAA,EAAa,GAAA,MAAA,CAAA;AAE/B,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAA,IAAI,QAAU,EAAA;AACZ,IAAQ,OAAA,CAAA,aAAA,GAAgB,SAAS,MAAO,CAAA,IAAA;AAAA,MACtC,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAA;AAAA,KACzB,CAAE,QAAS,CAAA,QAAQ,CAAC,CAAA,CAAA,CAAA;AAAA,GACf,MAAA;AACL,IAAQ,OAAA,CAAA,aAAA,GAAgB,SAAS,QAAQ,CAAA,CAAA,CAAA;AAAA,GAC3C;AAEA,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AASgB,SAAA,aAAA,CACd,QACA,GAOA,EAAA;AAtJF,EAAA,IAAA,EAAA,CAAA;AAuJE,EAAA,MAAM,WAAU,EAAO,GAAA,MAAA,CAAA,OAAA,KAAP,IAAkB,GAAA,EAAA,GAAA,CAAA,QAAA,EAAW,OAAO,IAAI,CAAA,CAAA,CAAA;AACxD,EAAI,IAAA;AACF,IAAA,MAAM,CAAC,MAAQ,EAAA,KAAA,EAAO,IAAM,EAAA,IAAA,EAAM,SAAS,GAAK,EAAA,GAAG,IAAI,CAAA,GAAI,IACxD,OAAQ,CAAA,OAAA,EAAS,EAAE,CAAA,CACnB,MAAM,GAAG,CAAA,CAAA;AACZ,IAAA,MAAM,mBAAmB,IAAK,CAAA,IAAA,CAAK,GAAG,CAAE,CAAA,OAAA,CAAQ,OAAO,EAAE,CAAA,CAAA;AAEzD,IAAO,OAAA;AAAA,MACL,GAAK,EAAA,OAAA;AAAA,MACL,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAA;AAAA,MACA,IAAM,EAAA,gBAAA;AAAA,KACR,CAAA;AAAA,WACO,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,KAAM,CAAA,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAE,CAAA,CAAA,CAAA;AAAA,GAC/C;AACF;;;;"}

package/dist/github/DefaultGithubCredentialsProvider.esm.js

@@ -0,0 +1,52 @@
+import { SingleInstanceGithubCredentialsProvider } from './SingleInstanceGithubCredentialsProvider.esm.js';
+
+class DefaultGithubCredentialsProvider {
+  constructor(providers) {
+    this.providers = providers;
+  }
+  static fromIntegrations(integrations) {
+    const credentialsProviders = /* @__PURE__ */ new Map();
+    integrations.github.list().forEach((integration) => {
+      const credentialsProvider = SingleInstanceGithubCredentialsProvider.create(integration.config);
+      credentialsProviders.set(integration.config.host, credentialsProvider);
+    });
+    return new DefaultGithubCredentialsProvider(credentialsProviders);
+  }
+  /**
+   * Returns {@link GithubCredentials} for a given URL.
+   *
+   * @remarks
+   *
+   * Consecutive calls to this method with the same URL will return cached
+   * credentials.
+   *
+   * The shortest lifetime for a token returned is 10 minutes.
+   *
+   * @example
+   * ```ts
+   * const { token, headers } = await getCredentials({
+   *   url: 'https://github.com/backstage/foobar'
+   * })
+   *
+   * const { token, headers } = await getCredentials({
+   *   url: 'https://github.com/backstage'
+   * })
+   * ```
+   *
+   * @param opts - The organization or repository URL
+   * @returns A promise of {@link GithubCredentials}.
+   */
+  async getCredentials(opts) {
+    const parsed = new URL(opts.url);
+    const provider = this.providers.get(parsed.host);
+    if (!provider) {
+      throw new Error(
+        `There is no GitHub integration that matches ${opts.url}. Please add a configuration for an integration.`
+      );
+    }
+    return provider.getCredentials(opts);
+  }
+}
+
+export { DefaultGithubCredentialsProvider };
+//# sourceMappingURL=DefaultGithubCredentialsProvider.esm.js.map

package/dist/github/DefaultGithubCredentialsProvider.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultGithubCredentialsProvider.esm.js","sources":["../../src/github/DefaultGithubCredentialsProvider.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { GithubCredentials, GithubCredentialsProvider } from './types';\nimport { ScmIntegrationRegistry } from '../registry';\nimport { SingleInstanceGithubCredentialsProvider } from './SingleInstanceGithubCredentialsProvider';\n\n/**\n * Handles the creation and caching of credentials for GitHub integrations.\n *\n * @public\n * @remarks\n *\n * TODO: Possibly move this to a backend only package so that it's not used in the frontend by mistake\n */\nexport class DefaultGithubCredentialsProvider\n  implements GithubCredentialsProvider\n{\n  static fromIntegrations(integrations: ScmIntegrationRegistry) {\n    const credentialsProviders: Map<string, GithubCredentialsProvider> =\n      new Map<string, GithubCredentialsProvider>();\n\n    integrations.github.list().forEach(integration => {\n      const credentialsProvider =\n        SingleInstanceGithubCredentialsProvider.create(integration.config);\n      credentialsProviders.set(integration.config.host, credentialsProvider);\n    });\n    return new DefaultGithubCredentialsProvider(credentialsProviders);\n  }\n\n  private constructor(\n    private readonly providers: Map<string, GithubCredentialsProvider>,\n  ) {}\n\n  /**\n   * Returns {@link GithubCredentials} for a given URL.\n   *\n   * @remarks\n   *\n   * Consecutive calls to this method with the same URL will return cached\n   * credentials.\n   *\n   * The shortest lifetime for a token returned is 10 minutes.\n   *\n   * @example\n   * ```ts\n   * const { token, headers } = await getCredentials({\n   *   url: 'https://github.com/backstage/foobar'\n   * })\n   *\n   * const { token, headers } = await getCredentials({\n   *   url: 'https://github.com/backstage'\n   * })\n   * ```\n   *\n   * @param opts - The organization or repository URL\n   * @returns A promise of {@link GithubCredentials}.\n   */\n  async getCredentials(opts: { url: string }): Promise<GithubCredentials> {\n    const parsed = new URL(opts.url);\n    const provider = this.providers.get(parsed.host);\n\n    if (!provider) {\n      throw new Error(\n        `There is no GitHub integration that matches ${opts.url}. Please add a configuration for an integration.`,\n      );\n    }\n\n    return provider.getCredentials(opts);\n  }\n}\n"],"names":[],"mappings":";;AA4BO,MAAM,gCAEb,CAAA;AAAA,EAaU,YACW,SACjB,EAAA;AADiB,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAChB;AAAA,EAdH,OAAO,iBAAiB,YAAsC,EAAA;AAC5D,IAAM,MAAA,oBAAA,uBACA,GAAuC,EAAA,CAAA;AAE7C,IAAA,YAAA,CAAa,MAAO,CAAA,IAAA,EAAO,CAAA,OAAA,CAAQ,CAAe,WAAA,KAAA;AAChD,MAAA,MAAM,mBACJ,GAAA,uCAAA,CAAwC,MAAO,CAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AACnE,MAAA,oBAAA,CAAqB,GAAI,CAAA,WAAA,CAAY,MAAO,CAAA,IAAA,EAAM,mBAAmB,CAAA,CAAA;AAAA,KACtE,CAAA,CAAA;AACD,IAAO,OAAA,IAAI,iCAAiC,oBAAoB,CAAA,CAAA;AAAA,GAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA8BA,MAAM,eAAe,IAAmD,EAAA;AACtE,IAAA,MAAM,MAAS,GAAA,IAAI,GAAI,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAC/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,SAAU,CAAA,GAAA,CAAI,OAAO,IAAI,CAAA,CAAA;AAE/C,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,4CAAA,EAA+C,KAAK,GAAG,CAAA,gDAAA,CAAA;AAAA,OACzD,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,QAAA,CAAS,eAAe,IAAI,CAAA,CAAA;AAAA,GACrC;AACF;;;;"}

package/dist/github/GithubIntegration.esm.js

@@ -0,0 +1,56 @@
+import { basicIntegrations, defaultScmResolveUrl } from '../helpers.esm.js';
+import { readGithubIntegrationConfigs } from './config.esm.js';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+const _GithubIntegration = class _GithubIntegration {
+  constructor(integrationConfig) {
+    this.integrationConfig = integrationConfig;
+  }
+  get type() {
+    return "github";
+  }
+  get title() {
+    return this.integrationConfig.host;
+  }
+  get config() {
+    return this.integrationConfig;
+  }
+  resolveUrl(options) {
+    return replaceGithubUrlType(defaultScmResolveUrl(options), "tree");
+  }
+  resolveEditUrl(url) {
+    return replaceGithubUrlType(url, "edit");
+  }
+  parseRateLimitInfo(response) {
+    return {
+      isRateLimited: response.status === 429 || response.status === 403 && response.headers.get("x-ratelimit-remaining") === "0"
+    };
+  }
+};
+__publicField(_GithubIntegration, "factory", ({ config }) => {
+  var _a;
+  const configs = readGithubIntegrationConfigs(
+    (_a = config.getOptionalConfigArray("integrations.github")) != null ? _a : []
+  );
+  return basicIntegrations(
+    configs.map((c) => new _GithubIntegration(c)),
+    (i) => i.config.host
+  );
+});
+let GithubIntegration = _GithubIntegration;
+function replaceGithubUrlType(url, type) {
+  return url.replace(
+    /\/\/([^/]+)\/([^/]+)\/([^/]+)\/(blob|tree|edit)\//,
+    (_, host, owner, repo) => {
+      return `//${host}/${owner}/${repo}/${type}/`;
+    }
+  );
+}
+
+export { GithubIntegration, replaceGithubUrlType };
+//# sourceMappingURL=GithubIntegration.esm.js.map

package/dist/github/GithubIntegration.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GithubIntegration.esm.js","sources":["../../src/github/GithubIntegration.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { basicIntegrations, defaultScmResolveUrl } from '../helpers';\nimport {\n  RateLimitInfo,\n  ScmIntegration,\n  ScmIntegrationsFactory,\n} from '../types';\nimport {\n  GithubIntegrationConfig,\n  readGithubIntegrationConfigs,\n} from './config';\nimport { ConsumedResponse } from '@backstage/errors';\n\n/**\n * A GitHub based integration.\n *\n * @public\n */\nexport class GithubIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GithubIntegration> = ({ config }) => {\n    const configs = readGithubIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.github') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GithubIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  constructor(private readonly integrationConfig: GithubIntegrationConfig) {}\n\n  get type(): string {\n    return 'github';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GithubIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    // GitHub uses blob URLs for files and tree urls for directory listings. But\n    // there is a redirect from tree to blob for files, so we can always return\n    // tree urls here.\n    return replaceGithubUrlType(defaultScmResolveUrl(options), 'tree');\n  }\n\n  resolveEditUrl(url: string): string {\n    return replaceGithubUrlType(url, 'edit');\n  }\n\n  parseRateLimitInfo(response: ConsumedResponse): RateLimitInfo {\n    return {\n      isRateLimited:\n        response.status === 429 ||\n        (response.status === 403 &&\n          response.headers.get('x-ratelimit-remaining') === '0'),\n    };\n  }\n}\n\n/**\n * Takes a GitHub URL and replaces the type part (blob, tree etc).\n *\n * @param url - The original URL\n * @param type - The desired type, e.g. \"blob\"\n * @public\n */\nexport function replaceGithubUrlType(\n  url: string,\n  type: 'blob' | 'tree' | 'edit',\n): string {\n  return url.replace(\n    /\\/\\/([^/]+)\\/([^/]+)\\/([^/]+)\\/(blob|tree|edit)\\//,\n    (_, host, owner, repo) => {\n      return `//${host}/${owner}/${repo}/${type}/`;\n    },\n  );\n}\n"],"names":[],"mappings":";;;;;;;;;AAiCO,MAAM,kBAAA,GAAN,MAAM,kBAA4C,CAAA;AAAA,EAWvD,YAA6B,iBAA4C,EAAA;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA,CAAA;AAAA,GAA6C;AAAA,EAE1E,IAAI,IAAe,GAAA;AACjB,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA,EAEA,IAAI,KAAgB,GAAA;AAClB,IAAA,OAAO,KAAK,iBAAkB,CAAA,IAAA,CAAA;AAAA,GAChC;AAAA,EAEA,IAAI,MAAkC,GAAA;AACpC,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AAAA,EAEA,WAAW,OAIA,EAAA;AAIT,IAAA,OAAO,oBAAqB,CAAA,oBAAA,CAAqB,OAAO,CAAA,EAAG,MAAM,CAAA,CAAA;AAAA,GACnE;AAAA,EAEA,eAAe,GAAqB,EAAA;AAClC,IAAO,OAAA,oBAAA,CAAqB,KAAK,MAAM,CAAA,CAAA;AAAA,GACzC;AAAA,EAEA,mBAAmB,QAA2C,EAAA;AAC5D,IAAO,OAAA;AAAA,MACL,aAAA,EACE,QAAS,CAAA,MAAA,KAAW,GACnB,IAAA,QAAA,CAAS,MAAW,KAAA,GAAA,IACnB,QAAS,CAAA,OAAA,CAAQ,GAAI,CAAA,uBAAuB,CAAM,KAAA,GAAA;AAAA,KACxD,CAAA;AAAA,GACF;AACF,CAAA,CAAA;AA/CE,aAAA,CADW,kBACJ,EAAA,SAAA,EAAqD,CAAC,EAAE,QAAa,KAAA;AAlC9E,EAAA,IAAA,EAAA,CAAA;AAmCI,EAAA,MAAM,OAAU,GAAA,4BAAA;AAAA,IAAA,CACd,EAAO,GAAA,MAAA,CAAA,sBAAA,CAAuB,qBAAqB,CAAA,KAAnD,YAAwD,EAAC;AAAA,GAC3D,CAAA;AACA,EAAO,OAAA,iBAAA;AAAA,IACL,QAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,IAAI,kBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,IACzC,CAAA,CAAA,KAAK,EAAE,MAAO,CAAA,IAAA;AAAA,GAChB,CAAA;AACF,CAAA,CAAA,CAAA;AATK,IAAM,iBAAN,GAAA,mBAAA;AAyDS,SAAA,oBAAA,CACd,KACA,IACQ,EAAA;AACR,EAAA,OAAO,GAAI,CAAA,OAAA;AAAA,IACT,mDAAA;AAAA,IACA,CAAC,CAAA,EAAG,IAAM,EAAA,KAAA,EAAO,IAAS,KAAA;AACxB,MAAA,OAAO,KAAK,IAAI,CAAA,CAAA,EAAI,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA;AACF;;;;"}