@backstage/plugin-catalog-import 0.12.0-next.2 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @backstage/plugin-catalog-import
 
+## 0.12.0
+
+### Minor Changes
+
+- 4f92394: Migrate from identityApi to fetchApi in frontend plugins.
+
+### Patch Changes
+
+- d44a20a: Added additional plugin metadata to `package.json`.
+- 3daad61: Integrated Azure DevOps as a catalog import source. This enables Backstage to create Pull Requests to Azure DevOps repositories as it does with GitHub repositories
+- Updated dependencies
+  - @backstage/core-components@0.14.8
+  - @backstage/core-compat-api@0.2.6
+  - @backstage/integration@1.12.0
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/plugin-catalog-common@1.0.24
+  - @backstage/plugin-catalog-react@1.12.1
+  - @backstage/integration-react@1.1.28
+  - @backstage/frontend-plugin-api@0.6.6
+  - @backstage/catalog-client@1.6.5
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+
+## 0.12.0-next.3
+
+### Patch Changes
+
+- d44a20a: Added additional plugin metadata to `package.json`.
+- Updated dependencies
+  - @backstage/core-components@0.14.8-next.2
+  - @backstage/integration@1.12.0-next.1
+  - @backstage/plugin-catalog-common@1.0.24-next.0
+  - @backstage/plugin-catalog-react@1.12.1-next.2
+  - @backstage/integration-react@1.1.28-next.1
+  - @backstage/frontend-plugin-api@0.6.6-next.2
+  - @backstage/core-compat-api@0.2.6-next.2
+  - @backstage/catalog-client@1.6.5
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/core-plugin-api@1.9.3-next.0
+  - @backstage/errors@1.2.4
+
 ## 0.12.0-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-import",
-  "version": "0.12.0-next.2",
+  "version": "0.12.0",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/api/AzureDevops.esm.js

@@ -0,0 +1,67 @@
+import { getBranchName, getCatalogFilename } from '../components/helpers.esm.js';
+import { createAzurePullRequest } from './AzureRepoApiClient.esm.js';
+
+function parseAzureUrl(repoUrl) {
+  const { org, repo, project, host } = parseRepoUrl(repoUrl);
+  if (!org || !repo || !project) {
+    throw new Error(
+      "Invalid AzureDevops Repository. Please use a valid repository url and try again "
+    );
+  }
+  const tenantUrl = `https://${host}/${org}`;
+  return { tenantUrl, repoName: repo, project };
+}
+async function submitAzurePrToRepo(options, scmAuthApi, configApi) {
+  const { repositoryUrl, fileContent, title, body } = options;
+  const branchName = getBranchName(configApi);
+  const fileName = getCatalogFilename(configApi);
+  const { token } = await scmAuthApi.getCredentials({
+    url: repositoryUrl,
+    additionalScope: {
+      repoWrite: true
+    }
+  });
+  const { tenantUrl, repoName, project } = parseAzureUrl(repositoryUrl);
+  const result = await createAzurePullRequest({
+    token,
+    fileContent,
+    title,
+    description: body,
+    project,
+    repository: repoName,
+    branchName,
+    tenantUrl,
+    fileName
+  });
+  const catalogLocation = `${result.repository.webUrl}?path=/${fileName}`;
+  const prLocation = `${result.repository.webUrl}/pullrequest/${result.pullRequestId}`;
+  return {
+    link: prLocation,
+    location: catalogLocation
+  };
+}
+function parseRepoUrl(sourceUrl) {
+  const url = new URL(sourceUrl);
+  let host = url.host;
+  let org;
+  let project;
+  let repo;
+  const parts = url.pathname.split("/").map((part) => decodeURIComponent(part));
+  if (parts[2] === "_git") {
+    org = parts[1];
+    project = repo = parts[3];
+  } else if (parts[3] === "_git") {
+    org = parts[1];
+    project = parts[2];
+    repo = parts[4];
+  } else if (parts[4] === "_git") {
+    host = `${host}/${parts[1]}`;
+    org = parts[2];
+    project = parts[3];
+    repo = parts[5];
+  }
+  return { host, org, project, repo };
+}
+
+export { parseAzureUrl, parseRepoUrl, submitAzurePrToRepo };
+//# sourceMappingURL=AzureDevops.esm.js.map

package/dist/api/AzureDevops.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureDevops.esm.js","sources":["../../src/api/AzureDevops.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { ScmAuthApi } from '@backstage/integration-react';\nimport { ConfigApi } from '@backstage/core-plugin-api';\nimport { getBranchName, getCatalogFilename } from '../components/helpers';\nimport { createAzurePullRequest } from './AzureRepoApiClient';\n\nexport interface AzureRepoParts {\n  tenantUrl: string;\n  repoName: string;\n  project: string;\n}\n\nexport function parseAzureUrl(repoUrl: string): AzureRepoParts {\n  const { org, repo, project, host } = parseRepoUrl(repoUrl);\n  if (!org || !repo || !project) {\n    throw new Error(\n      'Invalid AzureDevops Repository. Please use a valid repository url and try again ',\n    );\n  }\n  const tenantUrl = `https://${host}/${org}`;\n\n  return { tenantUrl, repoName: repo, project: project };\n}\n\nexport async function submitAzurePrToRepo(\n  options: {\n    title: string;\n    body: string;\n    fileContent: string;\n    repositoryUrl: string;\n  },\n  scmAuthApi: ScmAuthApi,\n  configApi: ConfigApi,\n) {\n  const { repositoryUrl, fileContent, title, body } = options;\n\n  const branchName = getBranchName(configApi);\n  const fileName = getCatalogFilename(configApi);\n\n  const { token } = await scmAuthApi.getCredentials({\n    url: repositoryUrl,\n    additionalScope: {\n      repoWrite: true,\n    },\n  });\n  const { tenantUrl, repoName, project } = parseAzureUrl(repositoryUrl);\n  const result = await createAzurePullRequest({\n    token,\n    fileContent,\n    title,\n    description: body,\n    project,\n    repository: repoName,\n    branchName,\n    tenantUrl,\n    fileName,\n  });\n  const catalogLocation = `${result.repository.webUrl}?path=/${fileName}`;\n  const prLocation = `${result.repository.webUrl}/pullrequest/${result.pullRequestId}`;\n  return {\n    link: prLocation!,\n    location: catalogLocation,\n  };\n}\n\nexport function parseRepoUrl(sourceUrl: string) {\n  const url = new URL(sourceUrl);\n\n  let host = url.host;\n  let org;\n  let project;\n  let repo;\n\n  const parts = url.pathname.split('/').map(part => decodeURIComponent(part));\n  if (parts[2] === '_git') {\n    org = parts[1];\n    project = repo = parts[3];\n  } else if (parts[3] === '_git') {\n    org = parts[1];\n    project = parts[2];\n    repo = parts[4];\n  } else if (parts[4] === '_git') {\n    host = `${host}/${parts[1]}`;\n    org = parts[2];\n    project = parts[3];\n    repo = parts[5];\n  }\n\n  return { host, org, project, repo };\n}\n"],"names":[],"mappings":";;;AA0BO,SAAS,cAAc,OAAiC,EAAA;AAC7D,EAAA,MAAM,EAAE,GAAK,EAAA,IAAA,EAAM,SAAS,IAAK,EAAA,GAAI,aAAa,OAAO,CAAA,CAAA;AACzD,EAAA,IAAI,CAAC,GAAA,IAAO,CAAC,IAAA,IAAQ,CAAC,OAAS,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,kFAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,MAAM,SAAY,GAAA,CAAA,QAAA,EAAW,IAAI,CAAA,CAAA,EAAI,GAAG,CAAA,CAAA,CAAA;AAExC,EAAA,OAAO,EAAE,SAAA,EAAW,QAAU,EAAA,IAAA,EAAM,OAAiB,EAAA,CAAA;AACvD,CAAA;AAEsB,eAAA,mBAAA,CACpB,OAMA,EAAA,UAAA,EACA,SACA,EAAA;AACA,EAAA,MAAM,EAAE,aAAA,EAAe,WAAa,EAAA,KAAA,EAAO,MAAS,GAAA,OAAA,CAAA;AAEpD,EAAM,MAAA,UAAA,GAAa,cAAc,SAAS,CAAA,CAAA;AAC1C,EAAM,MAAA,QAAA,GAAW,mBAAmB,SAAS,CAAA,CAAA;AAE7C,EAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,WAAW,cAAe,CAAA;AAAA,IAChD,GAAK,EAAA,aAAA;AAAA,IACL,eAAiB,EAAA;AAAA,MACf,SAAW,EAAA,IAAA;AAAA,KACb;AAAA,GACD,CAAA,CAAA;AACD,EAAA,MAAM,EAAE,SAAW,EAAA,QAAA,EAAU,OAAQ,EAAA,GAAI,cAAc,aAAa,CAAA,CAAA;AACpE,EAAM,MAAA,MAAA,GAAS,MAAM,sBAAuB,CAAA;AAAA,IAC1C,KAAA;AAAA,IACA,WAAA;AAAA,IACA,KAAA;AAAA,IACA,WAAa,EAAA,IAAA;AAAA,IACb,OAAA;AAAA,IACA,UAAY,EAAA,QAAA;AAAA,IACZ,UAAA;AAAA,IACA,SAAA;AAAA,IACA,QAAA;AAAA,GACD,CAAA,CAAA;AACD,EAAA,MAAM,kBAAkB,CAAG,EAAA,MAAA,CAAO,UAAW,CAAA,MAAM,UAAU,QAAQ,CAAA,CAAA,CAAA;AACrE,EAAA,MAAM,aAAa,CAAG,EAAA,MAAA,CAAO,WAAW,MAAM,CAAA,aAAA,EAAgB,OAAO,aAAa,CAAA,CAAA,CAAA;AAClF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,UAAA;AAAA,IACN,QAAU,EAAA,eAAA;AAAA,GACZ,CAAA;AACF,CAAA;AAEO,SAAS,aAAa,SAAmB,EAAA;AAC9C,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,SAAS,CAAA,CAAA;AAE7B,EAAA,IAAI,OAAO,GAAI,CAAA,IAAA,CAAA;AACf,EAAI,IAAA,GAAA,CAAA;AACJ,EAAI,IAAA,OAAA,CAAA;AACJ,EAAI,IAAA,IAAA,CAAA;AAEJ,EAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,GAAI,CAAA,CAAA,IAAA,KAAQ,kBAAmB,CAAA,IAAI,CAAC,CAAA,CAAA;AAC1E,EAAI,IAAA,KAAA,CAAM,CAAC,CAAA,KAAM,MAAQ,EAAA;AACvB,IAAA,GAAA,GAAM,MAAM,CAAC,CAAA,CAAA;AACb,IAAU,OAAA,GAAA,IAAA,GAAO,MAAM,CAAC,CAAA,CAAA;AAAA,GACf,MAAA,IAAA,KAAA,CAAM,CAAC,CAAA,KAAM,MAAQ,EAAA;AAC9B,IAAA,GAAA,GAAM,MAAM,CAAC,CAAA,CAAA;AACb,IAAA,OAAA,GAAU,MAAM,CAAC,CAAA,CAAA;AACjB,IAAA,IAAA,GAAO,MAAM,CAAC,CAAA,CAAA;AAAA,GACL,MAAA,IAAA,KAAA,CAAM,CAAC,CAAA,KAAM,MAAQ,EAAA;AAC9B,IAAA,IAAA,GAAO,CAAG,EAAA,IAAI,CAAI,CAAA,EAAA,KAAA,CAAM,CAAC,CAAC,CAAA,CAAA,CAAA;AAC1B,IAAA,GAAA,GAAM,MAAM,CAAC,CAAA,CAAA;AACb,IAAA,OAAA,GAAU,MAAM,CAAC,CAAA,CAAA;AACjB,IAAA,IAAA,GAAO,MAAM,CAAC,CAAA,CAAA;AAAA,GAChB;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,GAAK,EAAA,OAAA,EAAS,IAAK,EAAA,CAAA;AACpC;;;;"}

package/dist/api/AzureRepoApiClient.esm.js

@@ -0,0 +1,146 @@
+const apiVersions = "6.0";
+class RepoApiClient {
+  constructor(_options) {
+    this._options = _options;
+  }
+  createEndpoint = (path, version, queryParams = void 0) => {
+    const url = new URL(
+      `${this._options.tenantUrl}/${this._options.project}/_apis/git/repositories`
+    );
+    url.pathname += path;
+    url.searchParams.set("api-version", version);
+    Object.entries(queryParams ?? {}).forEach(
+      ([key, value]) => url.searchParams.set(key, value)
+    );
+    return url.toString();
+  };
+  async get(path, version, queryParams = void 0, token) {
+    const endpoint = this.createEndpoint(path, version, queryParams);
+    const result = await fetch(endpoint, {
+      headers: {
+        Authorization: `Bearer ${token}`
+      }
+    });
+    if (!result.ok) {
+      return result.json().then((it) => Promise.reject(new Error(it.message)));
+    }
+    return await result.json();
+  }
+  async post(path, version, payload, token) {
+    const endpoint = this.createEndpoint(path, version);
+    const result = await fetch(endpoint, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${token}`,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(payload)
+    });
+    if (!result.ok) {
+      return result.json().then((it) => Promise.reject(new Error(it.message)));
+    }
+    return await result.json();
+  }
+  async getRepository(repositoryName, token) {
+    return this.get(`/${repositoryName}`, apiVersions, void 0, token);
+  }
+  async getDefaultBranch(repo, token) {
+    const filter = repo.defaultBranch.replace("refs/", "");
+    const result = await this.get(
+      `/${repo.name}/refs`,
+      apiVersions,
+      { filter },
+      token
+    );
+    if (!result.value?.length) {
+      return Promise.reject(
+        new Error(`The requested ref '${filter}' was not found`)
+      );
+    }
+    return result.value[0];
+  }
+  async pushNewBranch(options, token) {
+    const { sourceBranch, repoName } = options;
+    const push = {
+      refUpdates: [
+        {
+          name: `refs/heads/${options.branchName}`,
+          oldObjectId: sourceBranch.objectId
+        }
+      ],
+      commits: [
+        {
+          comment: options.title,
+          changes: [
+            {
+              changeType: "add",
+              item: {
+                path: `/${options.fileName}`
+              },
+              newContent: {
+                content: options.fileContent,
+                contentType: "rawtext"
+              }
+            }
+          ]
+        }
+      ]
+    };
+    const result = await this.post(
+      `/${repoName}/pushes`,
+      apiVersions,
+      push,
+      token
+    );
+    return result.refUpdates[0];
+  }
+  async createPullRequest(options, token) {
+    const { repoName, sourceName, targetName } = options;
+    const payload = {
+      title: options.title,
+      description: options.description,
+      sourceRefName: sourceName,
+      targetRefName: targetName
+    };
+    return await this.post(
+      `/${repoName}/pullrequests`,
+      apiVersions,
+      payload,
+      token
+    );
+  }
+}
+async function createAzurePullRequest(options, client = void 0) {
+  const {
+    title,
+    repository,
+    token,
+    fileContent,
+    fileName,
+    branchName,
+    description
+  } = options;
+  const actualClient = client ?? new RepoApiClient(options);
+  const repo = await actualClient.getRepository(repository, token);
+  const defaultBranch = await actualClient.getDefaultBranch(repo, token);
+  const branchOptions = {
+    title,
+    repoName: repo.name,
+    sourceBranch: defaultBranch,
+    branchName,
+    fileContent,
+    fileName
+  };
+  const refUpdate = await actualClient.pushNewBranch(branchOptions, token);
+  const prOptions = {
+    title,
+    description,
+    repoName: repo.name,
+    sourceName: refUpdate.name,
+    targetName: defaultBranch.name
+  };
+  return actualClient.createPullRequest(prOptions, token);
+}
+
+export { RepoApiClient, createAzurePullRequest };
+//# sourceMappingURL=AzureRepoApiClient.esm.js.map

package/dist/api/AzureRepoApiClient.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureRepoApiClient.esm.js","sources":["../../src/api/AzureRepoApiClient.ts"],"sourcesContent":["/*\n * Copyright 2024 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\nexport interface AzurePrOptions {\n  tenantUrl: string;\n  title: string;\n  project: string;\n  branchName: string;\n  repository: string;\n  token: string;\n  fileContent: string;\n  fileName: string;\n  description: string;\n}\n\nexport interface CreateAzurePr {\n  sourceRefName: string;\n  targetRefName: string;\n  title: string;\n  description: string;\n}\n\nexport interface AzureRepo {\n  id: string;\n  name: string;\n  defaultBranch: string;\n}\n\nexport interface AzureRef {\n  name: string;\n  objectId: string;\n}\n\ninterface RefQueryResult {\n  value: AzureRef[];\n}\n\nexport interface AzureCommit {\n  comment: string;\n\n  changes: {\n    changeType: string;\n    item: {\n      path: string;\n    };\n    newContent: {\n      content: string;\n      contentType: 'rawtext';\n    };\n  }[];\n}\n\nexport interface AzureRefUpdate {\n  repositoryId: string;\n  name: string;\n  oldObjectId: string;\n  newObjectId: string;\n}\n\nexport interface AzurePushResult {\n  refUpdates: AzureRefUpdate[];\n}\n\nexport interface AzurePush {\n  refUpdates: {\n    name: string;\n    oldObjectId: string;\n  }[];\n  commits: AzureCommit[];\n}\n\nexport interface AzurePrResult {\n  pullRequestId: string;\n  repository: {\n    name: string;\n    webUrl: string;\n  };\n}\n\nconst apiVersions = '6.0';\n\nexport interface RepoApiClientOptions {\n  project: string;\n  tenantUrl: string;\n}\n\nexport interface NewBranchOptions {\n  fileContent: string;\n  fileName: string;\n  title: string;\n  branchName: string;\n  repoName: string;\n  sourceBranch: AzureRef;\n}\n\nexport interface CreatePrOptions {\n  repoName: string;\n  sourceName: string;\n  targetName: string;\n  description: string;\n  title: string;\n}\n\nexport class RepoApiClient {\n  private createEndpoint = (\n    path: string,\n    version: string,\n    queryParams: Record<string, string> | undefined = undefined,\n  ) => {\n    const url = new URL(\n      `${this._options.tenantUrl}/${this._options.project}/_apis/git/repositories`,\n    );\n    url.pathname += path;\n\n    url.searchParams.set('api-version', version);\n    Object.entries(queryParams ?? {}).forEach(([key, value]) =>\n      url.searchParams.set(key, value),\n    );\n    return url.toString();\n  };\n\n  constructor(private _options: RepoApiClientOptions) {}\n\n  private async get<T>(\n    path: string,\n    version: string,\n    queryParams: Record<string, string> | undefined = undefined,\n    token: string,\n  ): Promise<T> {\n    const endpoint = this.createEndpoint(path, version, queryParams);\n    const result = await fetch(endpoint, {\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    });\n    if (!result.ok) {\n      return result.json().then(it => Promise.reject(new Error(it.message)));\n    }\n    return await result.json();\n  }\n\n  private async post<T>(\n    path: string,\n    version: string,\n    payload: unknown,\n    token: string,\n  ): Promise<T> {\n    const endpoint = this.createEndpoint(path, version);\n    const result = await fetch(endpoint, {\n      method: 'POST',\n      headers: {\n        Authorization: `Bearer ${token}`,\n        'Content-Type': 'application/json',\n      },\n      body: JSON.stringify(payload),\n    });\n    if (!result.ok) {\n      return result.json().then(it => Promise.reject(new Error(it.message)));\n    }\n    return await result.json();\n  }\n\n  async getRepository(\n    repositoryName: string,\n    token: string,\n  ): Promise<AzureRepo> {\n    return this.get(`/${repositoryName}`, apiVersions, undefined, token);\n  }\n\n  async getDefaultBranch(repo: AzureRepo, token: string): Promise<AzureRef> {\n    const filter = repo.defaultBranch.replace('refs/', '');\n    const result: RefQueryResult = await this.get(\n      `/${repo.name}/refs`,\n      apiVersions,\n      { filter },\n      token,\n    );\n    if (!result.value?.length) {\n      return Promise.reject(\n        new Error(`The requested ref '${filter}' was not found`),\n      );\n    }\n    return result.value[0];\n  }\n\n  async pushNewBranch(\n    options: NewBranchOptions,\n    token: string,\n  ): Promise<AzureRefUpdate> {\n    const { sourceBranch, repoName } = options;\n    const push: AzurePush = {\n      refUpdates: [\n        {\n          name: `refs/heads/${options.branchName}`,\n          oldObjectId: sourceBranch.objectId,\n        },\n      ],\n      commits: [\n        {\n          comment: options.title,\n          changes: [\n            {\n              changeType: 'add',\n              item: {\n                path: `/${options.fileName}`,\n              },\n              newContent: {\n                content: options.fileContent,\n                contentType: 'rawtext',\n              },\n            },\n          ],\n        },\n      ],\n    };\n    const result = await this.post<AzurePushResult>(\n      `/${repoName}/pushes`,\n      apiVersions,\n      push,\n      token,\n    );\n    return result.refUpdates[0];\n  }\n\n  async createPullRequest(\n    options: CreatePrOptions,\n    token: string,\n  ): Promise<AzurePrResult> {\n    const { repoName, sourceName, targetName } = options;\n    const payload: CreateAzurePr = {\n      title: options.title,\n      description: options.description,\n      sourceRefName: sourceName,\n      targetRefName: targetName,\n    };\n\n    return await this.post<AzurePrResult>(\n      `/${repoName}/pullrequests`,\n      apiVersions,\n      payload,\n      token,\n    );\n  }\n}\n\nexport async function createAzurePullRequest(\n  options: AzurePrOptions,\n  client: RepoApiClient | undefined = undefined,\n): Promise<AzurePrResult> {\n  const {\n    title,\n    repository,\n    token,\n    fileContent,\n    fileName,\n    branchName,\n    description,\n  } = options;\n  const actualClient = client ?? new RepoApiClient(options);\n  const repo = await actualClient.getRepository(repository, token);\n  const defaultBranch = await actualClient.getDefaultBranch(repo, token);\n  const branchOptions: NewBranchOptions = {\n    title: title,\n    repoName: repo.name,\n    sourceBranch: defaultBranch,\n    branchName: branchName,\n    fileContent: fileContent,\n    fileName: fileName,\n  };\n  const refUpdate = await actualClient.pushNewBranch(branchOptions, token);\n  const prOptions: CreatePrOptions = {\n    title,\n    description,\n    repoName: repo.name,\n    sourceName: refUpdate.name,\n    targetName: defaultBranch.name,\n  };\n  return actualClient.createPullRequest(prOptions, token);\n}\n"],"names":[],"mappings":"AA4FA,MAAM,WAAc,GAAA,KAAA,CAAA;AAwBb,MAAM,aAAc,CAAA;AAAA,EAkBzB,YAAoB,QAAgC,EAAA;AAAhC,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AAAA,GAAiC;AAAA,EAjB7C,cAAiB,GAAA,CACvB,IACA,EAAA,OAAA,EACA,cAAkD,KAC/C,CAAA,KAAA;AACH,IAAA,MAAM,MAAM,IAAI,GAAA;AAAA,MACd,GAAG,IAAK,CAAA,QAAA,CAAS,SAAS,CAAI,CAAA,EAAA,IAAA,CAAK,SAAS,OAAO,CAAA,uBAAA,CAAA;AAAA,KACrD,CAAA;AACA,IAAA,GAAA,CAAI,QAAY,IAAA,IAAA,CAAA;AAEhB,IAAI,GAAA,CAAA,YAAA,CAAa,GAAI,CAAA,aAAA,EAAe,OAAO,CAAA,CAAA;AAC3C,IAAA,MAAA,CAAO,OAAQ,CAAA,WAAA,IAAe,EAAE,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAC,CAAC,GAAK,EAAA,KAAK,MACpD,GAAI,CAAA,YAAA,CAAa,GAAI,CAAA,GAAA,EAAK,KAAK,CAAA;AAAA,KACjC,CAAA;AACA,IAAA,OAAO,IAAI,QAAS,EAAA,CAAA;AAAA,GACtB,CAAA;AAAA,EAIA,MAAc,GACZ,CAAA,IAAA,EACA,OACA,EAAA,WAAA,GAAkD,QAClD,KACY,EAAA;AACZ,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,cAAe,CAAA,IAAA,EAAM,SAAS,WAAW,CAAA,CAAA;AAC/D,IAAM,MAAA,MAAA,GAAS,MAAM,KAAA,CAAM,QAAU,EAAA;AAAA,MACnC,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,OAChC;AAAA,KACD,CAAA,CAAA;AACD,IAAI,IAAA,CAAC,OAAO,EAAI,EAAA;AACd,MAAA,OAAO,MAAO,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,CAAM,EAAA,KAAA,OAAA,CAAQ,MAAO,CAAA,IAAI,KAAM,CAAA,EAAA,CAAG,OAAO,CAAC,CAAC,CAAA,CAAA;AAAA,KACvE;AACA,IAAO,OAAA,MAAM,OAAO,IAAK,EAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,MAAc,IAAA,CACZ,IACA,EAAA,OAAA,EACA,SACA,KACY,EAAA;AACZ,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,cAAe,CAAA,IAAA,EAAM,OAAO,CAAA,CAAA;AAClD,IAAM,MAAA,MAAA,GAAS,MAAM,KAAA,CAAM,QAAU,EAAA;AAAA,MACnC,MAAQ,EAAA,MAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,QAC9B,cAAgB,EAAA,kBAAA;AAAA,OAClB;AAAA,MACA,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,OAAO,CAAA;AAAA,KAC7B,CAAA,CAAA;AACD,IAAI,IAAA,CAAC,OAAO,EAAI,EAAA;AACd,MAAA,OAAO,MAAO,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,CAAM,EAAA,KAAA,OAAA,CAAQ,MAAO,CAAA,IAAI,KAAM,CAAA,EAAA,CAAG,OAAO,CAAC,CAAC,CAAA,CAAA;AAAA,KACvE;AACA,IAAO,OAAA,MAAM,OAAO,IAAK,EAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,MAAM,aACJ,CAAA,cAAA,EACA,KACoB,EAAA;AACpB,IAAA,OAAO,KAAK,GAAI,CAAA,CAAA,CAAA,EAAI,cAAc,CAAI,CAAA,EAAA,WAAA,EAAa,QAAW,KAAK,CAAA,CAAA;AAAA,GACrE;AAAA,EAEA,MAAM,gBAAiB,CAAA,IAAA,EAAiB,KAAkC,EAAA;AACxE,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,aAAc,CAAA,OAAA,CAAQ,SAAS,EAAE,CAAA,CAAA;AACrD,IAAM,MAAA,MAAA,GAAyB,MAAM,IAAK,CAAA,GAAA;AAAA,MACxC,CAAA,CAAA,EAAI,KAAK,IAAI,CAAA,KAAA,CAAA;AAAA,MACb,WAAA;AAAA,MACA,EAAE,MAAO,EAAA;AAAA,MACT,KAAA;AAAA,KACF,CAAA;AACA,IAAI,IAAA,CAAC,MAAO,CAAA,KAAA,EAAO,MAAQ,EAAA;AACzB,MAAA,OAAO,OAAQ,CAAA,MAAA;AAAA,QACb,IAAI,KAAA,CAAM,CAAsB,mBAAA,EAAA,MAAM,CAAiB,eAAA,CAAA,CAAA;AAAA,OACzD,CAAA;AAAA,KACF;AACA,IAAO,OAAA,MAAA,CAAO,MAAM,CAAC,CAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,aACJ,CAAA,OAAA,EACA,KACyB,EAAA;AACzB,IAAM,MAAA,EAAE,YAAc,EAAA,QAAA,EAAa,GAAA,OAAA,CAAA;AACnC,IAAA,MAAM,IAAkB,GAAA;AAAA,MACtB,UAAY,EAAA;AAAA,QACV;AAAA,UACE,IAAA,EAAM,CAAc,WAAA,EAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AAAA,UACtC,aAAa,YAAa,CAAA,QAAA;AAAA,SAC5B;AAAA,OACF;AAAA,MACA,OAAS,EAAA;AAAA,QACP;AAAA,UACE,SAAS,OAAQ,CAAA,KAAA;AAAA,UACjB,OAAS,EAAA;AAAA,YACP;AAAA,cACE,UAAY,EAAA,KAAA;AAAA,cACZ,IAAM,EAAA;AAAA,gBACJ,IAAA,EAAM,CAAI,CAAA,EAAA,OAAA,CAAQ,QAAQ,CAAA,CAAA;AAAA,eAC5B;AAAA,cACA,UAAY,EAAA;AAAA,gBACV,SAAS,OAAQ,CAAA,WAAA;AAAA,gBACjB,WAAa,EAAA,SAAA;AAAA,eACf;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAM,MAAA,MAAA,GAAS,MAAM,IAAK,CAAA,IAAA;AAAA,MACxB,IAAI,QAAQ,CAAA,OAAA,CAAA;AAAA,MACZ,WAAA;AAAA,MACA,IAAA;AAAA,MACA,KAAA;AAAA,KACF,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,WAAW,CAAC,CAAA,CAAA;AAAA,GAC5B;AAAA,EAEA,MAAM,iBACJ,CAAA,OAAA,EACA,KACwB,EAAA;AACxB,IAAA,MAAM,EAAE,QAAA,EAAU,UAAY,EAAA,UAAA,EAAe,GAAA,OAAA,CAAA;AAC7C,IAAA,MAAM,OAAyB,GAAA;AAAA,MAC7B,OAAO,OAAQ,CAAA,KAAA;AAAA,MACf,aAAa,OAAQ,CAAA,WAAA;AAAA,MACrB,aAAe,EAAA,UAAA;AAAA,MACf,aAAe,EAAA,UAAA;AAAA,KACjB,CAAA;AAEA,IAAA,OAAO,MAAM,IAAK,CAAA,IAAA;AAAA,MAChB,IAAI,QAAQ,CAAA,aAAA,CAAA;AAAA,MACZ,WAAA;AAAA,MACA,OAAA;AAAA,MACA,KAAA;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAEsB,eAAA,sBAAA,CACpB,OACA,EAAA,MAAA,GAAoC,KACZ,CAAA,EAAA;AACxB,EAAM,MAAA;AAAA,IACJ,KAAA;AAAA,IACA,UAAA;AAAA,IACA,KAAA;AAAA,IACA,WAAA;AAAA,IACA,QAAA;AAAA,IACA,UAAA;AAAA,IACA,WAAA;AAAA,GACE,GAAA,OAAA,CAAA;AACJ,EAAA,MAAM,YAAe,GAAA,MAAA,IAAU,IAAI,aAAA,CAAc,OAAO,CAAA,CAAA;AACxD,EAAA,MAAM,IAAO,GAAA,MAAM,YAAa,CAAA,aAAA,CAAc,YAAY,KAAK,CAAA,CAAA;AAC/D,EAAA,MAAM,aAAgB,GAAA,MAAM,YAAa,CAAA,gBAAA,CAAiB,MAAM,KAAK,CAAA,CAAA;AACrE,EAAA,MAAM,aAAkC,GAAA;AAAA,IACtC,KAAA;AAAA,IACA,UAAU,IAAK,CAAA,IAAA;AAAA,IACf,YAAc,EAAA,aAAA;AAAA,IACd,UAAA;AAAA,IACA,WAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACA,EAAA,MAAM,SAAY,GAAA,MAAM,YAAa,CAAA,aAAA,CAAc,eAAe,KAAK,CAAA,CAAA;AACvE,EAAA,MAAM,SAA6B,GAAA;AAAA,IACjC,KAAA;AAAA,IACA,WAAA;AAAA,IACA,UAAU,IAAK,CAAA,IAAA;AAAA,IACf,YAAY,SAAU,CAAA,IAAA;AAAA,IACtB,YAAY,aAAc,CAAA,IAAA;AAAA,GAC5B,CAAA;AACA,EAAO,OAAA,YAAA,CAAa,iBAAkB,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AACxD;;;;"}

package/dist/api/CatalogImportClient.esm.js

@@ -1,8 +1,8 @@
-import { Octokit } from '@octokit/rest';
-import { Base64 } from 'js-base64';
 import YAML from 'yaml';
-import { getGithubIntegrationConfig } from './GitHub.esm.js';
-import { getCatalogFilename, getBranchName } from '../components/helpers.esm.js';
+import { submitGitHubPrToRepo } from './GitHub.esm.js';
+import { getCatalogFilename } from '../components/helpers.esm.js';
+import parseGitUrl from 'git-url-parse';
+import { submitAzurePrToRepo } from './AzureDevops.esm.js';
 
 class CatalogImportClient {
   discoveryApi;
@@ -41,17 +41,18 @@ class CatalogImportClient {
         ]
       };
     }
-    const ghConfig = getGithubIntegrationConfig(this.scmIntegrationsApi, url);
-    if (!ghConfig) {
-      const other = this.scmIntegrationsApi.byUrl(url);
+    const supportedIntegrations = ["github", "azure"];
+    const foundIntegration = this.scmIntegrationsApi.byUrl(url);
+    const iSupported = !!foundIntegration && supportedIntegrations.find((it) => it === foundIntegration.type);
+    if (!iSupported) {
       const catalogFilename = getCatalogFilename(this.configApi);
-      if (other) {
+      if (foundIntegration) {
         throw new Error(
-          `The ${other.title} integration only supports full URLs to ${catalogFilename} files. Did you try to pass in the URL of a directory instead?`
+          `The ${foundIntegration.title} integration only supports full URLs to ${catalogFilename} files. Did you try to pass in the URL of a directory instead?`
         );
       }
       throw new Error(
-        `This URL was not recognized as a valid GitHub URL because there was no configured integration that matched the given host name. You could try to paste the full URL to a ${catalogFilename} file instead.`
+        `This URL was not recognized as a valid git URL because there was no configured integration that matched the given host name. Currently GitHub and Azure DevOps are supported. You could try to paste the full URL to a ${catalogFilename} file instead.`
       );
     }
     const analyzation = await this.analyzeLocation({
@@ -80,7 +81,7 @@ class CatalogImportClient {
     }
     return {
       type: "repository",
-      integrationType: "github",
+      integrationType: foundIntegration.type,
       url,
       generatedEntities: analyzation.generateEntities.map((x) => x.entity)
     };
@@ -108,20 +109,38 @@ For more information, read an [overview of the Backstage software catalog](https
     if (!validationResponse.valid) {
       throw new Error(validationResponse.errors[0].message);
     }
-    const ghConfig = getGithubIntegrationConfig(
-      this.scmIntegrationsApi,
-      repositoryUrl
-    );
-    if (ghConfig) {
-      return await this.submitGitHubPrToRepo({
-        ...ghConfig,
-        repositoryUrl,
-        fileContent,
-        title,
-        body
-      });
+    const provider = this.scmIntegrationsApi.byUrl(repositoryUrl);
+    switch (provider?.type) {
+      case "github": {
+        const { config } = provider;
+        const { name, owner } = parseGitUrl(repositoryUrl);
+        const options2 = {
+          githubIntegrationConfig: config,
+          repo: name,
+          owner,
+          repositoryUrl,
+          fileContent,
+          title,
+          body
+        };
+        return submitGitHubPrToRepo(options2, this.scmAuthApi, this.configApi);
+      }
+      case "azure": {
+        return submitAzurePrToRepo(
+          {
+            repositoryUrl,
+            fileContent,
+            title,
+            body
+          },
+          this.scmAuthApi,
+          this.configApi
+        );
+      }
+      default: {
+        throw new Error("unimplemented!");
+      }
     }
-    throw new Error("unimplemented!");
   }
   // TODO: this could be part of the catalog api
   async analyzeLocation(options) {
@@ -154,95 +173,6 @@ For more information, read an [overview of the Backstage software catalog](https
     const payload = await response.json();
     return payload;
   }
-  // TODO: extract this function and implement for non-github
-  async submitGitHubPrToRepo(options) {
-    const {
-      owner,
-      repo,
-      title,
-      body,
-      fileContent,
-      repositoryUrl,
-      githubIntegrationConfig
-    } = options;
-    const { token } = await this.scmAuthApi.getCredentials({
-      url: repositoryUrl,
-      additionalScope: {
-        repoWrite: true
-      }
-    });
-    const octo = new Octokit({
-      auth: token,
-      baseUrl: githubIntegrationConfig.apiBaseUrl
-    });
-    const branchName = getBranchName(this.configApi);
-    const fileName = getCatalogFilename(this.configApi);
-    const repoData = await octo.repos.get({
-      owner,
-      repo
-    }).catch((e) => {
-      throw new Error(formatHttpErrorMessage("Couldn't fetch repo data", e));
-    });
-    const parentRef = await octo.git.getRef({
-      owner,
-      repo,
-      ref: `heads/${repoData.data.default_branch}`
-    }).catch((e) => {
-      throw new Error(
-        formatHttpErrorMessage("Couldn't fetch default branch data", e)
-      );
-    });
-    await octo.git.createRef({
-      owner,
-      repo,
-      ref: `refs/heads/${branchName}`,
-      sha: parentRef.data.object.sha
-    }).catch((e) => {
-      throw new Error(
-        formatHttpErrorMessage(
-          `Couldn't create a new branch with name '${branchName}'`,
-          e
-        )
-      );
-    });
-    await octo.repos.createOrUpdateFileContents({
-      owner,
-      repo,
-      path: fileName,
-      message: title,
-      content: Base64.encode(fileContent),
-      branch: branchName
-    }).catch((e) => {
-      throw new Error(
-        formatHttpErrorMessage(
-          `Couldn't create a commit with ${fileName} file added`,
-          e
-        )
-      );
-    });
-    const pullRequestResponse = await octo.pulls.create({
-      owner,
-      repo,
-      title,
-      head: branchName,
-      body,
-      base: repoData.data.default_branch
-    }).catch((e) => {
-      throw new Error(
-        formatHttpErrorMessage(
-          `Couldn't create a pull request for ${branchName} branch`,
-          e
-        )
-      );
-    });
-    return {
-      link: pullRequestResponse.data.html_url,
-      location: `https://${githubIntegrationConfig.host}/${owner}/${repo}/blob/${repoData.data.default_branch}/${fileName}`
-    };
-  }
-}
-function formatHttpErrorMessage(message, error) {
-  return `${message}, received http response status code ${error.status}: ${error.message}`;
 }
 
 export { CatalogImportClient };

package/dist/api/CatalogImportClient.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"CatalogImportClient.esm.js","sources":["../../src/api/CatalogImportClient.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 { CatalogApi } from '@backstage/catalog-client';\nimport { ConfigApi, DiscoveryApi, FetchApi } from '@backstage/core-plugin-api';\nimport {\n  GithubIntegrationConfig,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { ScmAuthApi } from '@backstage/integration-react';\nimport { Octokit } from '@octokit/rest';\nimport { Base64 } from 'js-base64';\nimport { AnalyzeResult, CatalogImportApi } from './CatalogImportApi';\nimport YAML from 'yaml';\nimport { getGithubIntegrationConfig } from './GitHub';\nimport { getBranchName, getCatalogFilename } from '../components/helpers';\nimport { AnalyzeLocationResponse } from '@backstage/plugin-catalog-common';\nimport { CompoundEntityRef } from '@backstage/catalog-model';\n\n/**\n * The default implementation of the {@link CatalogImportApi}.\n *\n * @public\n */\nexport class CatalogImportClient implements CatalogImportApi {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n  private readonly scmAuthApi: ScmAuthApi;\n  private readonly scmIntegrationsApi: ScmIntegrationRegistry;\n  private readonly catalogApi: CatalogApi;\n  private readonly configApi: ConfigApi;\n\n  constructor(options: {\n    discoveryApi: DiscoveryApi;\n    scmAuthApi: ScmAuthApi;\n    fetchApi: FetchApi;\n    scmIntegrationsApi: ScmIntegrationRegistry;\n    catalogApi: CatalogApi;\n    configApi: ConfigApi;\n  }) {\n    this.discoveryApi = options.discoveryApi;\n    this.scmAuthApi = options.scmAuthApi;\n    this.fetchApi = options.fetchApi;\n    this.scmIntegrationsApi = options.scmIntegrationsApi;\n    this.catalogApi = options.catalogApi;\n    this.configApi = options.configApi;\n  }\n\n  async analyzeUrl(url: string): Promise<AnalyzeResult> {\n    if (\n      new URL(url).pathname.match(/\\.ya?ml$/) ||\n      new URL(url).searchParams.get('path')?.match(/.ya?ml$/)\n    ) {\n      const location = await this.catalogApi.addLocation({\n        type: 'url',\n        target: url,\n        dryRun: true,\n      });\n\n      return {\n        type: 'locations',\n        locations: [\n          {\n            exists: location.exists,\n            target: location.location.target,\n            entities: location.entities.map(e => ({\n              kind: e.kind,\n              namespace: e.metadata.namespace ?? 'default',\n              name: e.metadata.name,\n            })),\n          },\n        ],\n      };\n    }\n\n    const ghConfig = getGithubIntegrationConfig(this.scmIntegrationsApi, url);\n    if (!ghConfig) {\n      const other = this.scmIntegrationsApi.byUrl(url);\n      const catalogFilename = getCatalogFilename(this.configApi);\n\n      if (other) {\n        throw new Error(\n          `The ${other.title} integration only supports full URLs to ${catalogFilename} files. Did you try to pass in the URL of a directory instead?`,\n        );\n      }\n      throw new Error(\n        `This URL was not recognized as a valid GitHub URL because there was no configured integration that matched the given host name. You could try to paste the full URL to a ${catalogFilename} file instead.`,\n      );\n    }\n\n    const analyzation = await this.analyzeLocation({\n      repo: url,\n    });\n\n    if (analyzation.existingEntityFiles.length > 0) {\n      const locations = analyzation.existingEntityFiles.reduce<\n        Record<\n          string,\n          {\n            target: string;\n            exists?: boolean;\n            entities: CompoundEntityRef[];\n          }\n        >\n      >((state, curr) => {\n        state[curr.location.target] = {\n          target: curr.location.target,\n          exists: curr.isRegistered,\n          entities: [\n            ...(curr.location.target in state\n              ? state[curr.location.target].entities\n              : []),\n            {\n              name: curr.entity.metadata.name,\n              namespace: curr.entity.metadata.namespace ?? 'default',\n              kind: curr.entity.kind,\n            },\n          ],\n        };\n        return state;\n      }, {});\n      return {\n        type: 'locations',\n        locations: Object.values(locations),\n      };\n    }\n\n    return {\n      type: 'repository',\n      integrationType: 'github',\n      url: url,\n      generatedEntities: analyzation.generateEntities.map(x => x.entity),\n    };\n  }\n\n  async preparePullRequest(): Promise<{\n    title: string;\n    body: string;\n  }> {\n    const appTitle =\n      this.configApi.getOptionalString('app.title') ?? 'Backstage';\n    const appBaseUrl = this.configApi.getString('app.baseUrl');\n    const catalogFilename = getCatalogFilename(this.configApi);\n\n    return {\n      title: `Add ${catalogFilename} config file`,\n      body: `This pull request adds a **Backstage entity metadata file** \\\nto this repository so that the component can be added to the \\\n[${appTitle} software catalog](${appBaseUrl}).\\n\\nAfter this pull request is merged, \\\nthe component will become available.\\n\\nFor more information, read an \\\n[overview of the Backstage software catalog](https://backstage.io/docs/features/software-catalog/).`,\n    };\n  }\n\n  async submitPullRequest(options: {\n    repositoryUrl: string;\n    fileContent: string;\n    title: string;\n    body: string;\n  }): Promise<{ link: string; location: string }> {\n    const { repositoryUrl, fileContent, title, body } = options;\n    const parseData = YAML.parse(fileContent);\n\n    const validationResponse = await this.catalogApi.validateEntity(\n      parseData,\n      `url:${repositoryUrl}`,\n    );\n    if (!validationResponse.valid) {\n      throw new Error(validationResponse.errors[0].message);\n    }\n    const ghConfig = getGithubIntegrationConfig(\n      this.scmIntegrationsApi,\n      repositoryUrl,\n    );\n\n    if (ghConfig) {\n      return await this.submitGitHubPrToRepo({\n        ...ghConfig,\n        repositoryUrl,\n        fileContent,\n        title,\n        body,\n      });\n    }\n    throw new Error('unimplemented!');\n  }\n\n  // TODO: this could be part of the catalog api\n  private async analyzeLocation(options: {\n    repo: string;\n  }): Promise<AnalyzeLocationResponse> {\n    const response = await this.fetchApi\n      .fetch(\n        `${await this.discoveryApi.getBaseUrl('catalog')}/analyze-location`,\n        {\n          headers: {\n            'Content-Type': 'application/json',\n          },\n          method: 'POST',\n          body: JSON.stringify({\n            location: { type: 'url', target: options.repo },\n            ...(this.configApi.getOptionalString(\n              'catalog.import.entityFilename',\n            ) && {\n              catalogFilename: this.configApi.getOptionalString(\n                'catalog.import.entityFilename',\n              ),\n            }),\n          }),\n        },\n      )\n      .catch(e => {\n        throw new Error(`Failed to generate entity definitions, ${e.message}`);\n      });\n    if (!response.ok) {\n      throw new Error(\n        `Failed to generate entity definitions. Received http response ${response.status}: ${response.statusText}`,\n      );\n    }\n\n    const payload = await response.json();\n    return payload;\n  }\n\n  // TODO: extract this function and implement for non-github\n  private async submitGitHubPrToRepo(options: {\n    owner: string;\n    repo: string;\n    title: string;\n    body: string;\n    fileContent: string;\n    repositoryUrl: string;\n    githubIntegrationConfig: GithubIntegrationConfig;\n  }): Promise<{ link: string; location: string }> {\n    const {\n      owner,\n      repo,\n      title,\n      body,\n      fileContent,\n      repositoryUrl,\n      githubIntegrationConfig,\n    } = options;\n\n    const { token } = await this.scmAuthApi.getCredentials({\n      url: repositoryUrl,\n      additionalScope: {\n        repoWrite: true,\n      },\n    });\n\n    const octo = new Octokit({\n      auth: token,\n      baseUrl: githubIntegrationConfig.apiBaseUrl,\n    });\n\n    const branchName = getBranchName(this.configApi);\n    const fileName = getCatalogFilename(this.configApi);\n\n    const repoData = await octo.repos\n      .get({\n        owner,\n        repo,\n      })\n      .catch(e => {\n        throw new Error(formatHttpErrorMessage(\"Couldn't fetch repo data\", e));\n      });\n\n    const parentRef = await octo.git\n      .getRef({\n        owner,\n        repo,\n        ref: `heads/${repoData.data.default_branch}`,\n      })\n      .catch(e => {\n        throw new Error(\n          formatHttpErrorMessage(\"Couldn't fetch default branch data\", e),\n        );\n      });\n\n    await octo.git\n      .createRef({\n        owner,\n        repo,\n        ref: `refs/heads/${branchName}`,\n        sha: parentRef.data.object.sha,\n      })\n      .catch(e => {\n        throw new Error(\n          formatHttpErrorMessage(\n            `Couldn't create a new branch with name '${branchName}'`,\n            e,\n          ),\n        );\n      });\n\n    await octo.repos\n      .createOrUpdateFileContents({\n        owner,\n        repo,\n        path: fileName,\n        message: title,\n        content: Base64.encode(fileContent),\n        branch: branchName,\n      })\n      .catch(e => {\n        throw new Error(\n          formatHttpErrorMessage(\n            `Couldn't create a commit with ${fileName} file added`,\n            e,\n          ),\n        );\n      });\n\n    const pullRequestResponse = await octo.pulls\n      .create({\n        owner,\n        repo,\n        title,\n        head: branchName,\n        body,\n        base: repoData.data.default_branch,\n      })\n      .catch(e => {\n        throw new Error(\n          formatHttpErrorMessage(\n            `Couldn't create a pull request for ${branchName} branch`,\n            e,\n          ),\n        );\n      });\n\n    return {\n      link: pullRequestResponse.data.html_url,\n      location: `https://${githubIntegrationConfig.host}/${owner}/${repo}/blob/${repoData.data.default_branch}/${fileName}`,\n    };\n  }\n}\n\nfunction formatHttpErrorMessage(\n  message: string,\n  error: { status: number; message: string },\n) {\n  return `${message}, received http response status code ${error.status}: ${error.message}`;\n}\n"],"names":[],"mappings":";;;;;;AAqCO,MAAM,mBAAgD,CAAA;AAAA,EAC1C,YAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,kBAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EAEjB,YAAY,OAOT,EAAA;AACD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,WAAW,OAAQ,CAAA,QAAA,CAAA;AACxB,IAAA,IAAA,CAAK,qBAAqB,OAAQ,CAAA,kBAAA,CAAA;AAClC,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,MAAM,WAAW,GAAqC,EAAA;AACpD,IAAA,IACE,IAAI,GAAI,CAAA,GAAG,EAAE,QAAS,CAAA,KAAA,CAAM,UAAU,CACtC,IAAA,IAAI,GAAI,CAAA,GAAG,EAAE,YAAa,CAAA,GAAA,CAAI,MAAM,CAAG,EAAA,KAAA,CAAM,SAAS,CACtD,EAAA;AACA,MAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,UAAA,CAAW,WAAY,CAAA;AAAA,QACjD,IAAM,EAAA,KAAA;AAAA,QACN,MAAQ,EAAA,GAAA;AAAA,QACR,MAAQ,EAAA,IAAA;AAAA,OACT,CAAA,CAAA;AAED,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,WAAA;AAAA,QACN,SAAW,EAAA;AAAA,UACT;AAAA,YACE,QAAQ,QAAS,CAAA,MAAA;AAAA,YACjB,MAAA,EAAQ,SAAS,QAAS,CAAA,MAAA;AAAA,YAC1B,QAAU,EAAA,QAAA,CAAS,QAAS,CAAA,GAAA,CAAI,CAAM,CAAA,MAAA;AAAA,cACpC,MAAM,CAAE,CAAA,IAAA;AAAA,cACR,SAAA,EAAW,CAAE,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACnC,IAAA,EAAM,EAAE,QAAS,CAAA,IAAA;AAAA,aACjB,CAAA,CAAA;AAAA,WACJ;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,QAAW,GAAA,0BAAA,CAA2B,IAAK,CAAA,kBAAA,EAAoB,GAAG,CAAA,CAAA;AACxE,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,kBAAmB,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAC/C,MAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAEzD,MAAA,IAAI,KAAO,EAAA;AACT,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAO,IAAA,EAAA,KAAA,CAAM,KAAK,CAAA,wCAAA,EAA2C,eAAe,CAAA,8DAAA,CAAA;AAAA,SAC9E,CAAA;AAAA,OACF;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,4KAA4K,eAAe,CAAA,cAAA,CAAA;AAAA,OAC7L,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,WAAA,GAAc,MAAM,IAAA,CAAK,eAAgB,CAAA;AAAA,MAC7C,IAAM,EAAA,GAAA;AAAA,KACP,CAAA,CAAA;AAED,IAAI,IAAA,WAAA,CAAY,mBAAoB,CAAA,MAAA,GAAS,CAAG,EAAA;AAC9C,MAAA,MAAM,YAAY,WAAY,CAAA,mBAAA,CAAoB,MAShD,CAAA,CAAC,OAAO,IAAS,KAAA;AACjB,QAAM,KAAA,CAAA,IAAA,CAAK,QAAS,CAAA,MAAM,CAAI,GAAA;AAAA,UAC5B,MAAA,EAAQ,KAAK,QAAS,CAAA,MAAA;AAAA,UACtB,QAAQ,IAAK,CAAA,YAAA;AAAA,UACb,QAAU,EAAA;AAAA,YACR,GAAI,IAAK,CAAA,QAAA,CAAS,MAAU,IAAA,KAAA,GACxB,KAAM,CAAA,IAAA,CAAK,QAAS,CAAA,MAAM,CAAE,CAAA,QAAA,GAC5B,EAAC;AAAA,YACL;AAAA,cACE,IAAA,EAAM,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,IAAA;AAAA,cAC3B,SAAW,EAAA,IAAA,CAAK,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cAC7C,IAAA,EAAM,KAAK,MAAO,CAAA,IAAA;AAAA,aACpB;AAAA,WACF;AAAA,SACF,CAAA;AACA,QAAO,OAAA,KAAA,CAAA;AAAA,OACT,EAAG,EAAE,CAAA,CAAA;AACL,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,WAAA;AAAA,QACN,SAAA,EAAW,MAAO,CAAA,MAAA,CAAO,SAAS,CAAA;AAAA,OACpC,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,YAAA;AAAA,MACN,eAAiB,EAAA,QAAA;AAAA,MACjB,GAAA;AAAA,MACA,mBAAmB,WAAY,CAAA,gBAAA,CAAiB,GAAI,CAAA,CAAA,CAAA,KAAK,EAAE,MAAM,CAAA;AAAA,KACnE,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,kBAGH,GAAA;AACD,IAAA,MAAM,QACJ,GAAA,IAAA,CAAK,SAAU,CAAA,iBAAA,CAAkB,WAAW,CAAK,IAAA,WAAA,CAAA;AACnD,IAAA,MAAM,UAAa,GAAA,IAAA,CAAK,SAAU,CAAA,SAAA,CAAU,aAAa,CAAA,CAAA;AACzD,IAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAEzD,IAAO,OAAA;AAAA,MACL,KAAA,EAAO,OAAO,eAAe,CAAA,YAAA,CAAA;AAAA,MAC7B,IAAM,EAAA,CAAA,0HAAA,EAET,QAAQ,CAAA,mBAAA,EAAsB,UAAU,CAAA;AAAA;AAAA;AAAA;AAAA,iIAAA,CAAA;AAAA,KAGvC,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,kBAAkB,OAKwB,EAAA;AAC9C,IAAA,MAAM,EAAE,aAAA,EAAe,WAAa,EAAA,KAAA,EAAO,MAAS,GAAA,OAAA,CAAA;AACpD,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,KAAA,CAAM,WAAW,CAAA,CAAA;AAExC,IAAM,MAAA,kBAAA,GAAqB,MAAM,IAAA,CAAK,UAAW,CAAA,cAAA;AAAA,MAC/C,SAAA;AAAA,MACA,OAAO,aAAa,CAAA,CAAA;AAAA,KACtB,CAAA;AACA,IAAI,IAAA,CAAC,mBAAmB,KAAO,EAAA;AAC7B,MAAA,MAAM,IAAI,KAAM,CAAA,kBAAA,CAAmB,MAAO,CAAA,CAAC,EAAE,OAAO,CAAA,CAAA;AAAA,KACtD;AACA,IAAA,MAAM,QAAW,GAAA,0BAAA;AAAA,MACf,IAAK,CAAA,kBAAA;AAAA,MACL,aAAA;AAAA,KACF,CAAA;AAEA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAO,OAAA,MAAM,KAAK,oBAAqB,CAAA;AAAA,QACrC,GAAG,QAAA;AAAA,QACH,aAAA;AAAA,QACA,WAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AACA,IAAM,MAAA,IAAI,MAAM,gBAAgB,CAAA,CAAA;AAAA,GAClC;AAAA;AAAA,EAGA,MAAc,gBAAgB,OAEO,EAAA;AACnC,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QACzB,CAAA,KAAA;AAAA,MACC,GAAG,MAAM,IAAA,CAAK,YAAa,CAAA,UAAA,CAAW,SAAS,CAAC,CAAA,iBAAA,CAAA;AAAA,MAChD;AAAA,QACE,OAAS,EAAA;AAAA,UACP,cAAgB,EAAA,kBAAA;AAAA,SAClB;AAAA,QACA,MAAQ,EAAA,MAAA;AAAA,QACR,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,UACnB,UAAU,EAAE,IAAA,EAAM,KAAO,EAAA,MAAA,EAAQ,QAAQ,IAAK,EAAA;AAAA,UAC9C,GAAI,KAAK,SAAU,CAAA,iBAAA;AAAA,YACjB,+BAAA;AAAA,WACG,IAAA;AAAA,YACH,eAAA,EAAiB,KAAK,SAAU,CAAA,iBAAA;AAAA,cAC9B,+BAAA;AAAA,aACF;AAAA,WACF;AAAA,SACD,CAAA;AAAA,OACH;AAAA,KACF,CACC,MAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAA0C,uCAAA,EAAA,CAAA,CAAE,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,KACtE,CAAA,CAAA;AACH,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAiE,8DAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA,CAAA;AAAA,OAC1G,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,OAAA,GAAU,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACpC,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,MAAc,qBAAqB,OAQa,EAAA;AAC9C,IAAM,MAAA;AAAA,MACJ,KAAA;AAAA,MACA,IAAA;AAAA,MACA,KAAA;AAAA,MACA,IAAA;AAAA,MACA,WAAA;AAAA,MACA,aAAA;AAAA,MACA,uBAAA;AAAA,KACE,GAAA,OAAA,CAAA;AAEJ,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,WAAW,cAAe,CAAA;AAAA,MACrD,GAAK,EAAA,aAAA;AAAA,MACL,eAAiB,EAAA;AAAA,QACf,SAAW,EAAA,IAAA;AAAA,OACb;AAAA,KACD,CAAA,CAAA;AAED,IAAM,MAAA,IAAA,GAAO,IAAI,OAAQ,CAAA;AAAA,MACvB,IAAM,EAAA,KAAA;AAAA,MACN,SAAS,uBAAwB,CAAA,UAAA;AAAA,KAClC,CAAA,CAAA;AAED,IAAM,MAAA,UAAA,GAAa,aAAc,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAC/C,IAAM,MAAA,QAAA,GAAW,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAElD,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CACzB,GAAI,CAAA;AAAA,MACH,KAAA;AAAA,MACA,IAAA;AAAA,KACD,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,sBAAuB,CAAA,0BAAA,EAA4B,CAAC,CAAC,CAAA,CAAA;AAAA,KACtE,CAAA,CAAA;AAEH,IAAA,MAAM,SAAY,GAAA,MAAM,IAAK,CAAA,GAAA,CAC1B,MAAO,CAAA;AAAA,MACN,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAK,EAAA,CAAA,MAAA,EAAS,QAAS,CAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAAA,KAC3C,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,sBAAA,CAAuB,sCAAsC,CAAC,CAAA;AAAA,OAChE,CAAA;AAAA,KACD,CAAA,CAAA;AAEH,IAAM,MAAA,IAAA,CAAK,IACR,SAAU,CAAA;AAAA,MACT,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAA,EAAK,cAAc,UAAU,CAAA,CAAA;AAAA,MAC7B,GAAA,EAAK,SAAU,CAAA,IAAA,CAAK,MAAO,CAAA,GAAA;AAAA,KAC5B,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,sBAAA;AAAA,UACE,2CAA2C,UAAU,CAAA,CAAA,CAAA;AAAA,UACrD,CAAA;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAEH,IAAM,MAAA,IAAA,CAAK,MACR,0BAA2B,CAAA;AAAA,MAC1B,KAAA;AAAA,MACA,IAAA;AAAA,MACA,IAAM,EAAA,QAAA;AAAA,MACN,OAAS,EAAA,KAAA;AAAA,MACT,OAAA,EAAS,MAAO,CAAA,MAAA,CAAO,WAAW,CAAA;AAAA,MAClC,MAAQ,EAAA,UAAA;AAAA,KACT,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,sBAAA;AAAA,UACE,iCAAiC,QAAQ,CAAA,WAAA,CAAA;AAAA,UACzC,CAAA;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAEH,IAAA,MAAM,mBAAsB,GAAA,MAAM,IAAK,CAAA,KAAA,CACpC,MAAO,CAAA;AAAA,MACN,KAAA;AAAA,MACA,IAAA;AAAA,MACA,KAAA;AAAA,MACA,IAAM,EAAA,UAAA;AAAA,MACN,IAAA;AAAA,MACA,IAAA,EAAM,SAAS,IAAK,CAAA,cAAA;AAAA,KACrB,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,sBAAA;AAAA,UACE,sCAAsC,UAAU,CAAA,OAAA,CAAA;AAAA,UAChD,CAAA;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAEH,IAAO,OAAA;AAAA,MACL,IAAA,EAAM,oBAAoB,IAAK,CAAA,QAAA;AAAA,MAC/B,QAAU,EAAA,CAAA,QAAA,EAAW,uBAAwB,CAAA,IAAI,CAAI,CAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,CAAS,MAAA,EAAA,QAAA,CAAS,IAAK,CAAA,cAAc,IAAI,QAAQ,CAAA,CAAA;AAAA,KACrH,CAAA;AAAA,GACF;AACF,CAAA;AAEA,SAAS,sBAAA,CACP,SACA,KACA,EAAA;AACA,EAAA,OAAO,GAAG,OAAO,CAAA,qCAAA,EAAwC,MAAM,MAAM,CAAA,EAAA,EAAK,MAAM,OAAO,CAAA,CAAA,CAAA;AACzF;;;;"}
+{"version":3,"file":"CatalogImportClient.esm.js","sources":["../../src/api/CatalogImportClient.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 { CatalogApi } from '@backstage/catalog-client';\nimport { ConfigApi, DiscoveryApi, FetchApi } from '@backstage/core-plugin-api';\nimport {\n  GithubIntegration,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { ScmAuthApi } from '@backstage/integration-react';\nimport { AnalyzeResult, CatalogImportApi } from './CatalogImportApi';\nimport YAML from 'yaml';\nimport { GitHubOptions, submitGitHubPrToRepo } from './GitHub';\nimport { getCatalogFilename } from '../components/helpers';\nimport { AnalyzeLocationResponse } from '@backstage/plugin-catalog-common';\nimport { CompoundEntityRef } from '@backstage/catalog-model';\nimport parseGitUrl from 'git-url-parse';\nimport { submitAzurePrToRepo } from './AzureDevops';\n\n/**\n * The default implementation of the {@link CatalogImportApi}.\n *\n * @public\n */\nexport class CatalogImportClient implements CatalogImportApi {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n  private readonly scmAuthApi: ScmAuthApi;\n  private readonly scmIntegrationsApi: ScmIntegrationRegistry;\n  private readonly catalogApi: CatalogApi;\n  private readonly configApi: ConfigApi;\n\n  constructor(options: {\n    discoveryApi: DiscoveryApi;\n    scmAuthApi: ScmAuthApi;\n    fetchApi: FetchApi;\n    scmIntegrationsApi: ScmIntegrationRegistry;\n    catalogApi: CatalogApi;\n    configApi: ConfigApi;\n  }) {\n    this.discoveryApi = options.discoveryApi;\n    this.scmAuthApi = options.scmAuthApi;\n    this.fetchApi = options.fetchApi;\n    this.scmIntegrationsApi = options.scmIntegrationsApi;\n    this.catalogApi = options.catalogApi;\n    this.configApi = options.configApi;\n  }\n\n  async analyzeUrl(url: string): Promise<AnalyzeResult> {\n    if (\n      new URL(url).pathname.match(/\\.ya?ml$/) ||\n      new URL(url).searchParams.get('path')?.match(/.ya?ml$/)\n    ) {\n      const location = await this.catalogApi.addLocation({\n        type: 'url',\n        target: url,\n        dryRun: true,\n      });\n\n      return {\n        type: 'locations',\n        locations: [\n          {\n            exists: location.exists,\n            target: location.location.target,\n            entities: location.entities.map(e => ({\n              kind: e.kind,\n              namespace: e.metadata.namespace ?? 'default',\n              name: e.metadata.name,\n            })),\n          },\n        ],\n      };\n    }\n    const supportedIntegrations = ['github', 'azure'];\n    const foundIntegration = this.scmIntegrationsApi.byUrl(url);\n    const iSupported =\n      !!foundIntegration &&\n      supportedIntegrations.find(it => it === foundIntegration.type);\n    if (!iSupported) {\n      const catalogFilename = getCatalogFilename(this.configApi);\n\n      if (foundIntegration) {\n        throw new Error(\n          `The ${foundIntegration.title} integration only supports full URLs to ${catalogFilename} files. Did you try to pass in the URL of a directory instead?`,\n        );\n      }\n      throw new Error(\n        `This URL was not recognized as a valid git URL because there was no configured integration that matched the given host name. Currently GitHub and Azure DevOps are supported. You could try to paste the full URL to a ${catalogFilename} file instead.`,\n      );\n    }\n\n    const analyzation = await this.analyzeLocation({\n      repo: url,\n    });\n\n    if (analyzation.existingEntityFiles.length > 0) {\n      const locations = analyzation.existingEntityFiles.reduce<\n        Record<\n          string,\n          {\n            target: string;\n            exists?: boolean;\n            entities: CompoundEntityRef[];\n          }\n        >\n      >((state, curr) => {\n        state[curr.location.target] = {\n          target: curr.location.target,\n          exists: curr.isRegistered,\n          entities: [\n            ...(curr.location.target in state\n              ? state[curr.location.target].entities\n              : []),\n            {\n              name: curr.entity.metadata.name,\n              namespace: curr.entity.metadata.namespace ?? 'default',\n              kind: curr.entity.kind,\n            },\n          ],\n        };\n        return state;\n      }, {});\n      return {\n        type: 'locations',\n        locations: Object.values(locations),\n      };\n    }\n\n    return {\n      type: 'repository',\n      integrationType: foundIntegration.type,\n      url: url,\n      generatedEntities: analyzation.generateEntities.map(x => x.entity),\n    };\n  }\n\n  async preparePullRequest(): Promise<{\n    title: string;\n    body: string;\n  }> {\n    const appTitle =\n      this.configApi.getOptionalString('app.title') ?? 'Backstage';\n    const appBaseUrl = this.configApi.getString('app.baseUrl');\n    const catalogFilename = getCatalogFilename(this.configApi);\n\n    return {\n      title: `Add ${catalogFilename} config file`,\n      body: `This pull request adds a **Backstage entity metadata file** \\\nto this repository so that the component can be added to the \\\n[${appTitle} software catalog](${appBaseUrl}).\\n\\nAfter this pull request is merged, \\\nthe component will become available.\\n\\nFor more information, read an \\\n[overview of the Backstage software catalog](https://backstage.io/docs/features/software-catalog/).`,\n    };\n  }\n\n  async submitPullRequest(options: {\n    repositoryUrl: string;\n    fileContent: string;\n    title: string;\n    body: string;\n  }): Promise<{ link: string; location: string }> {\n    const { repositoryUrl, fileContent, title, body } = options;\n    const parseData = YAML.parse(fileContent);\n\n    const validationResponse = await this.catalogApi.validateEntity(\n      parseData,\n      `url:${repositoryUrl}`,\n    );\n    if (!validationResponse.valid) {\n      throw new Error(validationResponse.errors[0].message);\n    }\n\n    const provider = this.scmIntegrationsApi.byUrl(repositoryUrl);\n\n    switch (provider?.type) {\n      case 'github': {\n        const { config } = provider as GithubIntegration;\n        const { name, owner } = parseGitUrl(repositoryUrl);\n        const options2: GitHubOptions = {\n          githubIntegrationConfig: config,\n          repo: name,\n          owner: owner,\n          repositoryUrl,\n          fileContent,\n          title,\n          body,\n        };\n        return submitGitHubPrToRepo(options2, this.scmAuthApi, this.configApi);\n      }\n      case 'azure': {\n        return submitAzurePrToRepo(\n          {\n            repositoryUrl,\n            fileContent,\n            title,\n            body,\n          },\n          this.scmAuthApi,\n          this.configApi,\n        );\n      }\n      default: {\n        throw new Error('unimplemented!');\n      }\n    }\n  }\n\n  // TODO: this could be part of the catalog api\n  private async analyzeLocation(options: {\n    repo: string;\n  }): Promise<AnalyzeLocationResponse> {\n    const response = await this.fetchApi\n      .fetch(\n        `${await this.discoveryApi.getBaseUrl('catalog')}/analyze-location`,\n        {\n          headers: {\n            'Content-Type': 'application/json',\n          },\n          method: 'POST',\n          body: JSON.stringify({\n            location: { type: 'url', target: options.repo },\n            ...(this.configApi.getOptionalString(\n              'catalog.import.entityFilename',\n            ) && {\n              catalogFilename: this.configApi.getOptionalString(\n                'catalog.import.entityFilename',\n              ),\n            }),\n          }),\n        },\n      )\n      .catch(e => {\n        throw new Error(`Failed to generate entity definitions, ${e.message}`);\n      });\n    if (!response.ok) {\n      throw new Error(\n        `Failed to generate entity definitions. Received http response ${response.status}: ${response.statusText}`,\n      );\n    }\n\n    const payload = await response.json();\n    return payload;\n  }\n}\n"],"names":[],"mappings":";;;;;;AAqCO,MAAM,mBAAgD,CAAA;AAAA,EAC1C,YAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,kBAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EAEjB,YAAY,OAOT,EAAA;AACD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,WAAW,OAAQ,CAAA,QAAA,CAAA;AACxB,IAAA,IAAA,CAAK,qBAAqB,OAAQ,CAAA,kBAAA,CAAA;AAClC,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,MAAM,WAAW,GAAqC,EAAA;AACpD,IAAA,IACE,IAAI,GAAI,CAAA,GAAG,EAAE,QAAS,CAAA,KAAA,CAAM,UAAU,CACtC,IAAA,IAAI,GAAI,CAAA,GAAG,EAAE,YAAa,CAAA,GAAA,CAAI,MAAM,CAAG,EAAA,KAAA,CAAM,SAAS,CACtD,EAAA;AACA,MAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,UAAA,CAAW,WAAY,CAAA;AAAA,QACjD,IAAM,EAAA,KAAA;AAAA,QACN,MAAQ,EAAA,GAAA;AAAA,QACR,MAAQ,EAAA,IAAA;AAAA,OACT,CAAA,CAAA;AAED,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,WAAA;AAAA,QACN,SAAW,EAAA;AAAA,UACT;AAAA,YACE,QAAQ,QAAS,CAAA,MAAA;AAAA,YACjB,MAAA,EAAQ,SAAS,QAAS,CAAA,MAAA;AAAA,YAC1B,QAAU,EAAA,QAAA,CAAS,QAAS,CAAA,GAAA,CAAI,CAAM,CAAA,MAAA;AAAA,cACpC,MAAM,CAAE,CAAA,IAAA;AAAA,cACR,SAAA,EAAW,CAAE,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACnC,IAAA,EAAM,EAAE,QAAS,CAAA,IAAA;AAAA,aACjB,CAAA,CAAA;AAAA,WACJ;AAAA,SACF;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAM,MAAA,qBAAA,GAAwB,CAAC,QAAA,EAAU,OAAO,CAAA,CAAA;AAChD,IAAA,MAAM,gBAAmB,GAAA,IAAA,CAAK,kBAAmB,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAC1D,IAAM,MAAA,UAAA,GACJ,CAAC,CAAC,gBAAA,IACF,sBAAsB,IAAK,CAAA,CAAA,EAAA,KAAM,EAAO,KAAA,gBAAA,CAAiB,IAAI,CAAA,CAAA;AAC/D,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAEzD,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAO,IAAA,EAAA,gBAAA,CAAiB,KAAK,CAAA,wCAAA,EAA2C,eAAe,CAAA,8DAAA,CAAA;AAAA,SACzF,CAAA;AAAA,OACF;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,0NAA0N,eAAe,CAAA,cAAA,CAAA;AAAA,OAC3O,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,WAAA,GAAc,MAAM,IAAA,CAAK,eAAgB,CAAA;AAAA,MAC7C,IAAM,EAAA,GAAA;AAAA,KACP,CAAA,CAAA;AAED,IAAI,IAAA,WAAA,CAAY,mBAAoB,CAAA,MAAA,GAAS,CAAG,EAAA;AAC9C,MAAA,MAAM,YAAY,WAAY,CAAA,mBAAA,CAAoB,MAShD,CAAA,CAAC,OAAO,IAAS,KAAA;AACjB,QAAM,KAAA,CAAA,IAAA,CAAK,QAAS,CAAA,MAAM,CAAI,GAAA;AAAA,UAC5B,MAAA,EAAQ,KAAK,QAAS,CAAA,MAAA;AAAA,UACtB,QAAQ,IAAK,CAAA,YAAA;AAAA,UACb,QAAU,EAAA;AAAA,YACR,GAAI,IAAK,CAAA,QAAA,CAAS,MAAU,IAAA,KAAA,GACxB,KAAM,CAAA,IAAA,CAAK,QAAS,CAAA,MAAM,CAAE,CAAA,QAAA,GAC5B,EAAC;AAAA,YACL;AAAA,cACE,IAAA,EAAM,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,IAAA;AAAA,cAC3B,SAAW,EAAA,IAAA,CAAK,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cAC7C,IAAA,EAAM,KAAK,MAAO,CAAA,IAAA;AAAA,aACpB;AAAA,WACF;AAAA,SACF,CAAA;AACA,QAAO,OAAA,KAAA,CAAA;AAAA,OACT,EAAG,EAAE,CAAA,CAAA;AACL,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,WAAA;AAAA,QACN,SAAA,EAAW,MAAO,CAAA,MAAA,CAAO,SAAS,CAAA;AAAA,OACpC,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,YAAA;AAAA,MACN,iBAAiB,gBAAiB,CAAA,IAAA;AAAA,MAClC,GAAA;AAAA,MACA,mBAAmB,WAAY,CAAA,gBAAA,CAAiB,GAAI,CAAA,CAAA,CAAA,KAAK,EAAE,MAAM,CAAA;AAAA,KACnE,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,kBAGH,GAAA;AACD,IAAA,MAAM,QACJ,GAAA,IAAA,CAAK,SAAU,CAAA,iBAAA,CAAkB,WAAW,CAAK,IAAA,WAAA,CAAA;AACnD,IAAA,MAAM,UAAa,GAAA,IAAA,CAAK,SAAU,CAAA,SAAA,CAAU,aAAa,CAAA,CAAA;AACzD,IAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAEzD,IAAO,OAAA;AAAA,MACL,KAAA,EAAO,OAAO,eAAe,CAAA,YAAA,CAAA;AAAA,MAC7B,IAAM,EAAA,CAAA,0HAAA,EAET,QAAQ,CAAA,mBAAA,EAAsB,UAAU,CAAA;AAAA;AAAA;AAAA;AAAA,iIAAA,CAAA;AAAA,KAGvC,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,kBAAkB,OAKwB,EAAA;AAC9C,IAAA,MAAM,EAAE,aAAA,EAAe,WAAa,EAAA,KAAA,EAAO,MAAS,GAAA,OAAA,CAAA;AACpD,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,KAAA,CAAM,WAAW,CAAA,CAAA;AAExC,IAAM,MAAA,kBAAA,GAAqB,MAAM,IAAA,CAAK,UAAW,CAAA,cAAA;AAAA,MAC/C,SAAA;AAAA,MACA,OAAO,aAAa,CAAA,CAAA;AAAA,KACtB,CAAA;AACA,IAAI,IAAA,CAAC,mBAAmB,KAAO,EAAA;AAC7B,MAAA,MAAM,IAAI,KAAM,CAAA,kBAAA,CAAmB,MAAO,CAAA,CAAC,EAAE,OAAO,CAAA,CAAA;AAAA,KACtD;AAEA,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,kBAAmB,CAAA,KAAA,CAAM,aAAa,CAAA,CAAA;AAE5D,IAAA,QAAQ,UAAU,IAAM;AAAA,MACtB,KAAK,QAAU,EAAA;AACb,QAAM,MAAA,EAAE,QAAW,GAAA,QAAA,CAAA;AACnB,QAAA,MAAM,EAAE,IAAA,EAAM,KAAM,EAAA,GAAI,YAAY,aAAa,CAAA,CAAA;AACjD,QAAA,MAAM,QAA0B,GAAA;AAAA,UAC9B,uBAAyB,EAAA,MAAA;AAAA,UACzB,IAAM,EAAA,IAAA;AAAA,UACN,KAAA;AAAA,UACA,aAAA;AAAA,UACA,WAAA;AAAA,UACA,KAAA;AAAA,UACA,IAAA;AAAA,SACF,CAAA;AACA,QAAA,OAAO,oBAAqB,CAAA,QAAA,EAAU,IAAK,CAAA,UAAA,EAAY,KAAK,SAAS,CAAA,CAAA;AAAA,OACvE;AAAA,MACA,KAAK,OAAS,EAAA;AACZ,QAAO,OAAA,mBAAA;AAAA,UACL;AAAA,YACE,aAAA;AAAA,YACA,WAAA;AAAA,YACA,KAAA;AAAA,YACA,IAAA;AAAA,WACF;AAAA,UACA,IAAK,CAAA,UAAA;AAAA,UACL,IAAK,CAAA,SAAA;AAAA,SACP,CAAA;AAAA,OACF;AAAA,MACA,SAAS;AACP,QAAM,MAAA,IAAI,MAAM,gBAAgB,CAAA,CAAA;AAAA,OAClC;AAAA,KACF;AAAA,GACF;AAAA;AAAA,EAGA,MAAc,gBAAgB,OAEO,EAAA;AACnC,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QACzB,CAAA,KAAA;AAAA,MACC,GAAG,MAAM,IAAA,CAAK,YAAa,CAAA,UAAA,CAAW,SAAS,CAAC,CAAA,iBAAA,CAAA;AAAA,MAChD;AAAA,QACE,OAAS,EAAA;AAAA,UACP,cAAgB,EAAA,kBAAA;AAAA,SAClB;AAAA,QACA,MAAQ,EAAA,MAAA;AAAA,QACR,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,UACnB,UAAU,EAAE,IAAA,EAAM,KAAO,EAAA,MAAA,EAAQ,QAAQ,IAAK,EAAA;AAAA,UAC9C,GAAI,KAAK,SAAU,CAAA,iBAAA;AAAA,YACjB,+BAAA;AAAA,WACG,IAAA;AAAA,YACH,eAAA,EAAiB,KAAK,SAAU,CAAA,iBAAA;AAAA,cAC9B,+BAAA;AAAA,aACF;AAAA,WACF;AAAA,SACD,CAAA;AAAA,OACH;AAAA,KACF,CACC,MAAM,CAAK,CAAA,KAAA;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAA0C,uCAAA,EAAA,CAAA,CAAE,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,KACtE,CAAA,CAAA;AACH,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAiE,8DAAA,EAAA,QAAA,CAAS,MAAM,CAAA,EAAA,EAAK,SAAS,UAAU,CAAA,CAAA;AAAA,OAC1G,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,OAAA,GAAU,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACpC,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/api/GitHub.esm.js

@@ -1,17 +1,96 @@
-import parseGitUrl from 'git-url-parse';
+import 'git-url-parse';
+import { Octokit } from '@octokit/rest';
+import { getBranchName, getCatalogFilename } from '../components/helpers.esm.js';
+import { Base64 } from 'js-base64';
 
-const getGithubIntegrationConfig = (scmIntegrationsApi, location) => {
-  const integration = scmIntegrationsApi.github.byUrl(location);
-  if (!integration) {
-    return void 0;
-  }
-  const { name: repo, owner } = parseGitUrl(location);
-  return {
+async function submitGitHubPrToRepo(options, scmAuthApi, configApi) {
+  const {
+    owner,
+    repo,
+    title,
+    body,
+    fileContent,
+    repositoryUrl,
+    githubIntegrationConfig
+  } = options;
+  const { token } = await scmAuthApi.getCredentials({
+    url: repositoryUrl,
+    additionalScope: {
+      repoWrite: true
+    }
+  });
+  const octo = new Octokit({
+    auth: token,
+    baseUrl: githubIntegrationConfig.apiBaseUrl
+  });
+  const branchName = getBranchName(configApi);
+  const fileName = getCatalogFilename(configApi);
+  const repoData = await octo.repos.get({
+    owner,
+    repo
+  }).catch((e) => {
+    throw new Error(formatHttpErrorMessage("Couldn't fetch repo data", e));
+  });
+  const parentRef = await octo.git.getRef({
+    owner,
     repo,
+    ref: `heads/${repoData.data.default_branch}`
+  }).catch((e) => {
+    throw new Error(
+      formatHttpErrorMessage("Couldn't fetch default branch data", e)
+    );
+  });
+  await octo.git.createRef({
     owner,
-    githubIntegrationConfig: integration.config
+    repo,
+    ref: `refs/heads/${branchName}`,
+    sha: parentRef.data.object.sha
+  }).catch((e) => {
+    throw new Error(
+      formatHttpErrorMessage(
+        `Couldn't create a new branch with name '${branchName}'`,
+        e
+      )
+    );
+  });
+  await octo.repos.createOrUpdateFileContents({
+    owner,
+    repo,
+    path: fileName,
+    message: title,
+    content: Base64.encode(fileContent),
+    branch: branchName
+  }).catch((e) => {
+    throw new Error(
+      formatHttpErrorMessage(
+        `Couldn't create a commit with ${fileName} file added`,
+        e
+      )
+    );
+  });
+  const pullRequestResponse = await octo.pulls.create({
+    owner,
+    repo,
+    title,
+    head: branchName,
+    body,
+    base: repoData.data.default_branch
+  }).catch((e) => {
+    throw new Error(
+      formatHttpErrorMessage(
+        `Couldn't create a pull request for ${branchName} branch`,
+        e
+      )
+    );
+  });
+  return {
+    link: pullRequestResponse.data.html_url,
+    location: `https://${githubIntegrationConfig.host}/${owner}/${repo}/blob/${repoData.data.default_branch}/${fileName}`
   };
-};
+}
+function formatHttpErrorMessage(message, error) {
+  return `${message}, received http response status code ${error.status}: ${error.message}`;
+}
 
-export { getGithubIntegrationConfig };
+export { submitGitHubPrToRepo };
 //# sourceMappingURL=GitHub.esm.js.map

package/dist/api/GitHub.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"GitHub.esm.js","sources":["../../src/api/GitHub.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 { ScmIntegrationRegistry } from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\n\nexport const getGithubIntegrationConfig = (\n  scmIntegrationsApi: ScmIntegrationRegistry,\n  location: string,\n) => {\n  const integration = scmIntegrationsApi.github.byUrl(location);\n  if (!integration) {\n    return undefined;\n  }\n\n  const { name: repo, owner } = parseGitUrl(location);\n  return {\n    repo,\n    owner,\n    githubIntegrationConfig: integration.config,\n  };\n};\n"],"names":[],"mappings":";;AAmBa,MAAA,0BAAA,GAA6B,CACxC,kBAAA,EACA,QACG,KAAA;AACH,EAAA,MAAM,WAAc,GAAA,kBAAA,CAAmB,MAAO,CAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAC5D,EAAA,IAAI,CAAC,WAAa,EAAA;AAChB,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,EAAE,IAAM,EAAA,IAAA,EAAM,KAAM,EAAA,GAAI,YAAY,QAAQ,CAAA,CAAA;AAClD,EAAO,OAAA;AAAA,IACL,IAAA;AAAA,IACA,KAAA;AAAA,IACA,yBAAyB,WAAY,CAAA,MAAA;AAAA,GACvC,CAAA;AACF;;;;"}
+{"version":3,"file":"GitHub.esm.js","sources":["../../src/api/GitHub.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 {\n  GithubIntegrationConfig,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { ScmAuthApi } from '@backstage/integration-react';\nimport { Octokit } from '@octokit/rest';\nimport { getBranchName, getCatalogFilename } from '../components/helpers';\nimport { ConfigApi } from '@backstage/core-plugin-api';\nimport { Base64 } from 'js-base64';\n\nexport interface GitHubOptions {\n  owner: string;\n  repo: string;\n  title: string;\n  body: string;\n  fileContent: string;\n  repositoryUrl: string;\n  githubIntegrationConfig: GithubIntegrationConfig;\n}\nexport const getGithubIntegrationConfig = (\n  scmIntegrationsApi: ScmIntegrationRegistry,\n  location: string,\n) => {\n  const integration = scmIntegrationsApi.github.byUrl(location);\n  if (!integration) {\n    return undefined;\n  }\n\n  const { name: repo, owner } = parseGitUrl(location);\n  return {\n    repo,\n    owner,\n    githubIntegrationConfig: integration.config,\n  };\n};\n\nexport async function submitGitHubPrToRepo(\n  options: GitHubOptions,\n  scmAuthApi: ScmAuthApi,\n  configApi: ConfigApi,\n): Promise<{ link: string; location: string }> {\n  const {\n    owner,\n    repo,\n    title,\n    body,\n    fileContent,\n    repositoryUrl,\n    githubIntegrationConfig,\n  } = options;\n\n  const { token } = await scmAuthApi.getCredentials({\n    url: repositoryUrl,\n    additionalScope: {\n      repoWrite: true,\n    },\n  });\n\n  const octo = new Octokit({\n    auth: token,\n    baseUrl: githubIntegrationConfig.apiBaseUrl,\n  });\n\n  const branchName = getBranchName(configApi);\n  const fileName = getCatalogFilename(configApi);\n\n  const repoData = await octo.repos\n    .get({\n      owner,\n      repo,\n    })\n    .catch(e => {\n      throw new Error(formatHttpErrorMessage(\"Couldn't fetch repo data\", e));\n    });\n\n  const parentRef = await octo.git\n    .getRef({\n      owner,\n      repo,\n      ref: `heads/${repoData.data.default_branch}`,\n    })\n    .catch(e => {\n      throw new Error(\n        formatHttpErrorMessage(\"Couldn't fetch default branch data\", e),\n      );\n    });\n\n  await octo.git\n    .createRef({\n      owner,\n      repo,\n      ref: `refs/heads/${branchName}`,\n      sha: parentRef.data.object.sha,\n    })\n    .catch(e => {\n      throw new Error(\n        formatHttpErrorMessage(\n          `Couldn't create a new branch with name '${branchName}'`,\n          e,\n        ),\n      );\n    });\n\n  await octo.repos\n    .createOrUpdateFileContents({\n      owner,\n      repo,\n      path: fileName,\n      message: title,\n      content: Base64.encode(fileContent),\n      branch: branchName,\n    })\n    .catch(e => {\n      throw new Error(\n        formatHttpErrorMessage(\n          `Couldn't create a commit with ${fileName} file added`,\n          e,\n        ),\n      );\n    });\n\n  const pullRequestResponse = await octo.pulls\n    .create({\n      owner,\n      repo,\n      title,\n      head: branchName,\n      body,\n      base: repoData.data.default_branch,\n    })\n    .catch(e => {\n      throw new Error(\n        formatHttpErrorMessage(\n          `Couldn't create a pull request for ${branchName} branch`,\n          e,\n        ),\n      );\n    });\n\n  return {\n    link: pullRequestResponse.data.html_url,\n    location: `https://${githubIntegrationConfig.host}/${owner}/${repo}/blob/${repoData.data.default_branch}/${fileName}`,\n  };\n}\n\nfunction formatHttpErrorMessage(\n  message: string,\n  error: { status: number; message: string },\n) {\n  return `${message}, received http response status code ${error.status}: ${error.message}`;\n}\n"],"names":[],"mappings":";;;;;AAqDsB,eAAA,oBAAA,CACpB,OACA,EAAA,UAAA,EACA,SAC6C,EAAA;AAC7C,EAAM,MAAA;AAAA,IACJ,KAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,aAAA;AAAA,IACA,uBAAA;AAAA,GACE,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,WAAW,cAAe,CAAA;AAAA,IAChD,GAAK,EAAA,aAAA;AAAA,IACL,eAAiB,EAAA;AAAA,MACf,SAAW,EAAA,IAAA;AAAA,KACb;AAAA,GACD,CAAA,CAAA;AAED,EAAM,MAAA,IAAA,GAAO,IAAI,OAAQ,CAAA;AAAA,IACvB,IAAM,EAAA,KAAA;AAAA,IACN,SAAS,uBAAwB,CAAA,UAAA;AAAA,GAClC,CAAA,CAAA;AAED,EAAM,MAAA,UAAA,GAAa,cAAc,SAAS,CAAA,CAAA;AAC1C,EAAM,MAAA,QAAA,GAAW,mBAAmB,SAAS,CAAA,CAAA;AAE7C,EAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CACzB,GAAI,CAAA;AAAA,IACH,KAAA;AAAA,IACA,IAAA;AAAA,GACD,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,sBAAuB,CAAA,0BAAA,EAA4B,CAAC,CAAC,CAAA,CAAA;AAAA,GACtE,CAAA,CAAA;AAEH,EAAA,MAAM,SAAY,GAAA,MAAM,IAAK,CAAA,GAAA,CAC1B,MAAO,CAAA;AAAA,IACN,KAAA;AAAA,IACA,IAAA;AAAA,IACA,GAAK,EAAA,CAAA,MAAA,EAAS,QAAS,CAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAAA,GAC3C,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sBAAA,CAAuB,sCAAsC,CAAC,CAAA;AAAA,KAChE,CAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAM,MAAA,IAAA,CAAK,IACR,SAAU,CAAA;AAAA,IACT,KAAA;AAAA,IACA,IAAA;AAAA,IACA,GAAA,EAAK,cAAc,UAAU,CAAA,CAAA;AAAA,IAC7B,GAAA,EAAK,SAAU,CAAA,IAAA,CAAK,MAAO,CAAA,GAAA;AAAA,GAC5B,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sBAAA;AAAA,QACE,2CAA2C,UAAU,CAAA,CAAA,CAAA;AAAA,QACrD,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAM,MAAA,IAAA,CAAK,MACR,0BAA2B,CAAA;AAAA,IAC1B,KAAA;AAAA,IACA,IAAA;AAAA,IACA,IAAM,EAAA,QAAA;AAAA,IACN,OAAS,EAAA,KAAA;AAAA,IACT,OAAA,EAAS,MAAO,CAAA,MAAA,CAAO,WAAW,CAAA;AAAA,IAClC,MAAQ,EAAA,UAAA;AAAA,GACT,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sBAAA;AAAA,QACE,iCAAiC,QAAQ,CAAA,WAAA,CAAA;AAAA,QACzC,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAA,MAAM,mBAAsB,GAAA,MAAM,IAAK,CAAA,KAAA,CACpC,MAAO,CAAA;AAAA,IACN,KAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAM,EAAA,UAAA;AAAA,IACN,IAAA;AAAA,IACA,IAAA,EAAM,SAAS,IAAK,CAAA,cAAA;AAAA,GACrB,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sBAAA;AAAA,QACE,sCAAsC,UAAU,CAAA,OAAA,CAAA;AAAA,QAChD,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,oBAAoB,IAAK,CAAA,QAAA;AAAA,IAC/B,QAAU,EAAA,CAAA,QAAA,EAAW,uBAAwB,CAAA,IAAI,CAAI,CAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,CAAS,MAAA,EAAA,QAAA,CAAS,IAAK,CAAA,cAAc,IAAI,QAAQ,CAAA,CAAA;AAAA,GACrH,CAAA;AACF,CAAA;AAEA,SAAS,sBAAA,CACP,SACA,KACA,EAAA;AACA,EAAA,OAAO,GAAG,OAAO,CAAA,qCAAA,EAAwC,MAAM,MAAM,CAAA,EAAA,EAAK,MAAM,OAAO,CAAA,CAAA,CAAA;AACzF;;;;"}

package/dist/components/DefaultImportPage/DefaultImportPage.esm.js

@@ -21,10 +21,10 @@ import '@backstage/catalog-model';
 import '@backstage/plugin-catalog-react';
 import 'react-hook-form';
 import '../../api/CatalogImportApi.esm.js';
-import '@octokit/rest';
-import 'js-base64';
 import 'yaml';
 import 'git-url-parse';
+import '@octokit/rest';
+import 'js-base64';
 import '@material-ui/core/CircularProgress';
 import '@material-ui/lab/Autocomplete';
 import '@material-ui/core/Card';

package/dist/components/ImportInfoCard/ImportInfoCard.esm.js

@@ -4,10 +4,10 @@ import Chip from '@material-ui/core/Chip';
 import Typography from '@material-ui/core/Typography';
 import React from 'react';
 import { catalogImportApiRef } from '../../api/CatalogImportApi.esm.js';
-import '@octokit/rest';
-import 'js-base64';
 import 'yaml';
 import 'git-url-parse';
+import '@octokit/rest';
+import 'js-base64';
 import { useCatalogFilename } from '../../hooks/useCatalogFilename.esm.js';
 
 const ImportInfoCard = (props) => {

package/dist/components/ImportStepper/ImportStepper.esm.js

@@ -6,10 +6,10 @@ import Stepper from '@material-ui/core/Stepper';
 import { makeStyles } from '@material-ui/core/styles';
 import React, { useMemo } from 'react';
 import { catalogImportApiRef } from '../../api/CatalogImportApi.esm.js';
-import '@octokit/rest';
-import 'js-base64';
 import 'yaml';
 import 'git-url-parse';
+import '@octokit/rest';
+import 'js-base64';
 import { useImportState } from '../useImportState.esm.js';
 import { defaultStepper, defaultGenerateStepper } from './defaults.esm.js';
 

package/dist/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.esm.js

@@ -5,11 +5,11 @@ import TextField from '@material-ui/core/TextField';
 import React, { useState, useCallback } from 'react';
 import { useForm } from 'react-hook-form';
 import { catalogImportApiRef } from '../../api/CatalogImportApi.esm.js';
-import '@octokit/rest';
-import 'js-base64';
 import 'yaml';
 import 'git-url-parse';
+import '@octokit/rest';
 import { asInputRef } from '../helpers.esm.js';
+import 'js-base64';
 import { NextButton } from '../Buttons/index.esm.js';
 
 const StepInitAnalyzeUrl = (props) => {

package/dist/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.esm.js

@@ -10,9 +10,9 @@ import React, { useState, useEffect, useCallback } from 'react';
 import useAsync from 'react-use/esm/useAsync';
 import YAML from 'yaml';
 import { catalogImportApiRef } from '../../api/CatalogImportApi.esm.js';
+import 'git-url-parse';
 import '@octokit/rest';
 import 'js-base64';
-import 'git-url-parse';
 import { useCatalogFilename } from '../../hooks/useCatalogFilename.esm.js';
 import { BackButton, NextButton } from '../Buttons/index.esm.js';
 import { PreparePullRequestForm } from './PreparePullRequestForm.esm.js';

package/dist/index.d.ts

@@ -159,7 +159,6 @@ declare class CatalogImportClient implements CatalogImportApi {
         location: string;
     }>;
     private analyzeLocation;
-    private submitGitHubPrToRepo;
 }
 
 /**

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@backstage/plugin-catalog-import",
-  "version": "0.12.0-next.2",
+  "version": "0.12.0",
   "description": "A Backstage plugin the helps you import entities into your catalog",
   "backstage": {
-    "role": "frontend-plugin"
+    "role": "frontend-plugin",
+    "pluginId": "catalog-import",
+    "pluginPackages": [
+      "@backstage/plugin-catalog-import"
+    ]
   },
   "publishConfig": {
     "access": "public"
@@ -52,15 +56,15 @@
     "@backstage/catalog-client": "^1.6.5",
     "@backstage/catalog-model": "^1.5.0",
     "@backstage/config": "^1.2.0",
-    "@backstage/core-compat-api": "^0.2.6-next.1",
-    "@backstage/core-components": "^0.14.8-next.1",
-    "@backstage/core-plugin-api": "^1.9.3-next.0",
+    "@backstage/core-compat-api": "^0.2.6",
+    "@backstage/core-components": "^0.14.8",
+    "@backstage/core-plugin-api": "^1.9.3",
     "@backstage/errors": "^1.2.4",
-    "@backstage/frontend-plugin-api": "^0.6.6-next.1",
-    "@backstage/integration": "^1.12.0-next.0",
-    "@backstage/integration-react": "^1.1.28-next.0",
-    "@backstage/plugin-catalog-common": "^1.0.23",
-    "@backstage/plugin-catalog-react": "^1.12.1-next.1",
+    "@backstage/frontend-plugin-api": "^0.6.6",
+    "@backstage/integration": "^1.12.0",
+    "@backstage/integration-react": "^1.1.28",
+    "@backstage/plugin-catalog-common": "^1.0.24",
+    "@backstage/plugin-catalog-react": "^1.12.1",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -74,11 +78,11 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.7-next.2",
-    "@backstage/core-app-api": "^1.12.6-next.0",
-    "@backstage/dev-utils": "^1.0.33-next.1",
-    "@backstage/plugin-catalog": "^1.21.0-next.2",
-    "@backstage/test-utils": "^1.5.6-next.1",
+    "@backstage/cli": "^0.26.7",
+    "@backstage/core-app-api": "^1.12.6",
+    "@backstage/dev-utils": "^1.0.33",
+    "@backstage/plugin-catalog": "^1.21.0",
+    "@backstage/test-utils": "^1.5.6",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",