@backstage/integration-react 1.2.9 → 1.2.10-next.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @backstage/integration-react
 
+## 1.2.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.18.0-next.0
+
 ## 1.2.9
 
 ### Patch Changes

package/dist/api/ScmAuth.esm.js

@@ -1,4 +1,4 @@
-import { createApiFactory, githubAuthApiRef, gitlabAuthApiRef, microsoftAuthApiRef, bitbucketAuthApiRef } from '@backstage/core-plugin-api';
+import { createApiFactory, bitbucketAuthApiRef, microsoftAuthApiRef, gitlabAuthApiRef, githubAuthApiRef } from '@backstage/core-plugin-api';
 import { scmAuthApiRef } from './ScmAuthApi.esm.js';
 
 class ScmAuthMux {

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

@@ -1 +1 @@
-{"version":3,"file":"ScmAuth.esm.js","sources":["../../src/api/ScmAuth.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 {\n  bitbucketAuthApiRef,\n  createApiFactory,\n  githubAuthApiRef,\n  gitlabAuthApiRef,\n  microsoftAuthApiRef,\n  OAuthApi,\n} from '@backstage/core-plugin-api';\nimport {\n  ScmAuthApi,\n  scmAuthApiRef,\n  ScmAuthTokenOptions,\n  ScmAuthTokenResponse,\n} from './ScmAuthApi';\n\ntype ScopeMapping = {\n  /** The base scopes used for all requests */\n  default: string[];\n  /** Additional scopes added if `repoWrite` is requested */\n  repoWrite: string[];\n};\n\n// An enum of all supported providers\ntype ProviderName = 'generic' | 'github' | 'azure' | 'bitbucket' | 'gitlab';\n\nclass ScmAuthMux implements ScmAuthApi {\n  #providers: Array<ScmAuth>;\n\n  constructor(providers: ScmAuth[]) {\n    this.#providers = providers;\n  }\n\n  async getCredentials(\n    options: ScmAuthTokenOptions,\n  ): Promise<ScmAuthTokenResponse> {\n    const url = new URL(options.url);\n    const provider = this.#providers.find(p => p.isUrlSupported(url));\n    if (!provider) {\n      throw new Error(\n        `No auth provider available for '${options.url}', see https://backstage.io/link?scm-auth`,\n      );\n    }\n\n    return provider.getCredentials(options);\n  }\n}\n\n/**\n * An implementation of the ScmAuthApi that merges together OAuthApi instances\n * to form a single instance that can handles authentication for multiple providers.\n *\n * @public\n *\n * @example\n * ```\n * // Supports authentication towards both public GitHub and GHE:\n * createApiFactory({\n *   api: scmAuthApiRef,\n *   deps: {\n *     gheAuthApi: gheAuthApiRef,\n *     githubAuthApi: githubAuthApiRef,\n *   },\n *   factory: ({ githubAuthApi, gheAuthApi }) =>\n *     ScmAuth.merge(\n *       ScmAuth.forGithub(githubAuthApi),\n *       ScmAuth.forGithub(gheAuthApi, {\n *         host: 'ghe.example.com',\n *       }),\n *     )\n * })\n * ```\n */\nexport class ScmAuth implements ScmAuthApi {\n  /**\n   * Creates an API factory that enables auth for each of the default SCM providers.\n   */\n  static createDefaultApiFactory() {\n    return createApiFactory({\n      api: scmAuthApiRef,\n      deps: {\n        github: githubAuthApiRef,\n        gitlab: gitlabAuthApiRef,\n        azure: microsoftAuthApiRef,\n        bitbucket: bitbucketAuthApiRef,\n      },\n      factory: ({ github, gitlab, azure, bitbucket }) =>\n        ScmAuth.merge(\n          ScmAuth.forGithub(github),\n          ScmAuth.forGitlab(gitlab),\n          ScmAuth.forAzure(azure),\n          ScmAuth.forBitbucket(bitbucket),\n        ),\n    });\n  }\n\n  /**\n   * Creates a general purpose ScmAuth instance with a custom scope mapping.\n   */\n  static forAuthApi(\n    authApi: OAuthApi,\n    options: {\n      host: string;\n      scopeMapping: {\n        default: string[];\n        repoWrite: string[];\n      };\n    },\n  ): ScmAuth {\n    return new ScmAuth('generic', authApi, options.host, options.scopeMapping);\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards GitHub.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `github.com`.\n   *\n   * The default scopes are:\n   *\n   * `repo read:org read:user`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `gist`\n   */\n  static forGithub(\n    githubAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'github.com';\n    return new ScmAuth('github', githubAuthApi, host, {\n      default: ['repo', 'read:org', 'read:user'],\n      repoWrite: ['gist'],\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards GitLab.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `gitlab.com`.\n   *\n   * The default scopes are:\n   *\n   * `read_user read_api read_repository`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `write_repository api`\n   */\n  static forGitlab(\n    gitlabAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'gitlab.com';\n    return new ScmAuth('gitlab', gitlabAuthApi, host, {\n      default: ['read_user', 'read_api', 'read_repository'],\n      repoWrite: ['write_repository', 'api'],\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards Azure.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `dev.azure.com`.\n   *\n   * The default scopes are:\n   *\n   * `vso.build vso.code vso.graph vso.project vso.profile`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `vso.code_manage`\n   */\n  static forAzure(\n    microsoftAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'dev.azure.com';\n    return new ScmAuth('azure', microsoftAuthApi, host, {\n      default: [\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.build',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.code',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.graph',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.project',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.profile',\n      ],\n      repoWrite: ['499b84ac-1321-427f-aa17-267ca6975798/vso.code_manage'],\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards Bitbucket.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `bitbucket.org`.\n   *\n   * The default scopes are:\n   *\n   * `account team pullrequest snippet issue`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `pullrequest:write snippet:write issue:write`\n   */\n  static forBitbucket(\n    bitbucketAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n      scopeMapping?: {\n        default?: string[];\n        repoWrite?: string[];\n      };\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'bitbucket.org';\n    const defaultScopes = options?.scopeMapping?.default ?? [\n      'account',\n      'team',\n      'pullrequest',\n      'snippet',\n      'issue',\n      'project',\n    ];\n    const repoWriteScopes = options?.scopeMapping?.repoWrite ?? [\n      'pullrequest:write',\n      'snippet:write',\n      'issue:write',\n    ];\n    return new ScmAuth('bitbucket', bitbucketAuthApi, host, {\n      default: defaultScopes,\n      repoWrite: repoWriteScopes,\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards Bitbucket Server.\n   *\n   * The host option determines which URLs that are handled by this instance.\n   *\n   * The default scopes are:\n   *\n   * `PUBLIC_REPOS REPO_READ`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `REPO_WRITE`\n   */\n  static forBitbucketServer(\n    bitbucketAuthApi: OAuthApi,\n    options: {\n      host: string;\n      scopeMapping?: {\n        default?: string[];\n        repoWrite?: string[];\n      };\n    },\n  ): ScmAuth {\n    return this.forBitbucket(bitbucketAuthApi, {\n      host: options.host,\n      scopeMapping: {\n        default: options.scopeMapping?.default ?? ['PUBLIC_REPOS', 'REPO_READ'],\n        repoWrite: options.scopeMapping?.repoWrite ?? ['REPO_WRITE'],\n      },\n    });\n  }\n\n  /**\n   * Merges together multiple ScmAuth instances into one that\n   * routes requests to the correct instance based on the URL.\n   */\n  static merge(...providers: ScmAuth[]): ScmAuthApi {\n    return new ScmAuthMux(providers);\n  }\n\n  #api: OAuthApi;\n  #host: string;\n  #scopeMapping: ScopeMapping;\n  #providerName: ProviderName;\n\n  private constructor(\n    providerName: ProviderName,\n    api: OAuthApi,\n    host: string,\n    scopeMapping: ScopeMapping,\n  ) {\n    this.#api = api;\n    this.#host = host;\n    this.#scopeMapping = scopeMapping;\n    this.#providerName = providerName;\n  }\n\n  /**\n   * Checks whether the implementation is able to provide authentication for the given URL.\n   */\n  isUrlSupported(url: URL): boolean {\n    return url.host === this.#host;\n  }\n\n  private getAdditionalScopesForProvider(\n    additionalScopes: ScmAuthTokenOptions['additionalScope'],\n  ): string[] {\n    if (!additionalScopes?.customScopes || this.#providerName === 'generic') {\n      return [];\n    }\n\n    return additionalScopes.customScopes?.[this.#providerName] ?? [];\n  }\n\n  /**\n   * Fetches credentials for the given resource.\n   */\n  async getCredentials(\n    options: ScmAuthTokenOptions,\n  ): Promise<ScmAuthTokenResponse> {\n    const { url, additionalScope, ...restOptions } = options;\n\n    const scopes = this.#scopeMapping.default.slice();\n    if (additionalScope?.repoWrite) {\n      scopes.push(...this.#scopeMapping.repoWrite);\n    }\n\n    const additionalScopes =\n      this.getAdditionalScopesForProvider(additionalScope);\n\n    if (additionalScopes.length) {\n      scopes.push(...additionalScopes);\n    }\n\n    const uniqueScopes = [...new Set(scopes)];\n\n    const token = await this.#api.getAccessToken(uniqueScopes, restOptions);\n\n    return {\n      token,\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    };\n  }\n}\n"],"names":[],"mappings":";;;AAyCA,MAAM,UAAiC,CAAA;AAAA,EACrC,UAAA;AAAA,EAEA,YAAY,SAAsB,EAAA;AAChC,IAAA,IAAA,CAAK,UAAa,GAAA,SAAA;AAAA;AACpB,EAEA,MAAM,eACJ,OAC+B,EAAA;AAC/B,IAAA,MAAM,GAAM,GAAA,IAAI,GAAI,CAAA,OAAA,CAAQ,GAAG,CAAA;AAC/B,IAAM,MAAA,QAAA,GAAW,KAAK,UAAW,CAAA,IAAA,CAAK,OAAK,CAAE,CAAA,cAAA,CAAe,GAAG,CAAC,CAAA;AAChE,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gCAAA,EAAmC,QAAQ,GAAG,CAAA,yCAAA;AAAA,OAChD;AAAA;AAGF,IAAO,OAAA,QAAA,CAAS,eAAe,OAAO,CAAA;AAAA;AAE1C;AA2BO,MAAM,OAA8B,CAAA;AAAA;AAAA;AAAA;AAAA,EAIzC,OAAO,uBAA0B,GAAA;AAC/B,IAAA,OAAO,gBAAiB,CAAA;AAAA,MACtB,GAAK,EAAA,aAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAA,gBAAA;AAAA,QACR,MAAQ,EAAA,gBAAA;AAAA,QACR,KAAO,EAAA,mBAAA;AAAA,QACP,SAAW,EAAA;AAAA,OACb;AAAA,MACA,OAAA,EAAS,CAAC,EAAE,MAAA,EAAQ,QAAQ,KAAO,EAAA,SAAA,OACjC,OAAQ,CAAA,KAAA;AAAA,QACN,OAAA,CAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,OAAA,CAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,OAAA,CAAQ,SAAS,KAAK,CAAA;AAAA,QACtB,OAAA,CAAQ,aAAa,SAAS;AAAA;AAChC,KACH,CAAA;AAAA;AACH;AAAA;AAAA;AAAA,EAKA,OAAO,UACL,CAAA,OAAA,EACA,OAOS,EAAA;AACT,IAAA,OAAO,IAAI,OAAQ,CAAA,SAAA,EAAW,SAAS,OAAQ,CAAA,IAAA,EAAM,QAAQ,YAAY,CAAA;AAAA;AAC3E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,SACL,CAAA,aAAA,EACA,OAGS,EAAA;AACT,IAAM,MAAA,IAAA,GAAO,SAAS,IAAQ,IAAA,YAAA;AAC9B,IAAA,OAAO,IAAI,OAAA,CAAQ,QAAU,EAAA,aAAA,EAAe,IAAM,EAAA;AAAA,MAChD,OAAS,EAAA,CAAC,MAAQ,EAAA,UAAA,EAAY,WAAW,CAAA;AAAA,MACzC,SAAA,EAAW,CAAC,MAAM;AAAA,KACnB,CAAA;AAAA;AACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,SACL,CAAA,aAAA,EACA,OAGS,EAAA;AACT,IAAM,MAAA,IAAA,GAAO,SAAS,IAAQ,IAAA,YAAA;AAC9B,IAAA,OAAO,IAAI,OAAA,CAAQ,QAAU,EAAA,aAAA,EAAe,IAAM,EAAA;AAAA,MAChD,OAAS,EAAA,CAAC,WAAa,EAAA,UAAA,EAAY,iBAAiB,CAAA;AAAA,MACpD,SAAA,EAAW,CAAC,kBAAA,EAAoB,KAAK;AAAA,KACtC,CAAA;AAAA;AACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QACL,CAAA,gBAAA,EACA,OAGS,EAAA;AACT,IAAM,MAAA,IAAA,GAAO,SAAS,IAAQ,IAAA,eAAA;AAC9B,IAAA,OAAO,IAAI,OAAA,CAAQ,OAAS,EAAA,gBAAA,EAAkB,IAAM,EAAA;AAAA,MAClD,OAAS,EAAA;AAAA,QACP,gDAAA;AAAA,QACA,+CAAA;AAAA,QACA,gDAAA;AAAA,QACA,kDAAA;AAAA,QACA;AAAA,OACF;AAAA,MACA,SAAA,EAAW,CAAC,sDAAsD;AAAA,KACnE,CAAA;AAAA;AACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,YACL,CAAA,gBAAA,EACA,OAOS,EAAA;AACT,IAAM,MAAA,IAAA,GAAO,SAAS,IAAQ,IAAA,eAAA;AAC9B,IAAM,MAAA,aAAA,GAAgB,OAAS,EAAA,YAAA,EAAc,OAAW,IAAA;AAAA,MACtD,SAAA;AAAA,MACA,MAAA;AAAA,MACA,aAAA;AAAA,MACA,SAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF;AACA,IAAM,MAAA,eAAA,GAAkB,OAAS,EAAA,YAAA,EAAc,SAAa,IAAA;AAAA,MAC1D,mBAAA;AAAA,MACA,eAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,OAAO,IAAI,OAAA,CAAQ,WAAa,EAAA,gBAAA,EAAkB,IAAM,EAAA;AAAA,MACtD,OAAS,EAAA,aAAA;AAAA,MACT,SAAW,EAAA;AAAA,KACZ,CAAA;AAAA;AACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,kBACL,CAAA,gBAAA,EACA,OAOS,EAAA;AACT,IAAO,OAAA,IAAA,CAAK,aAAa,gBAAkB,EAAA;AAAA,MACzC,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,YAAc,EAAA;AAAA,QACZ,SAAS,OAAQ,CAAA,YAAA,EAAc,OAAW,IAAA,CAAC,gBAAgB,WAAW,CAAA;AAAA,QACtE,SAAW,EAAA,OAAA,CAAQ,YAAc,EAAA,SAAA,IAAa,CAAC,YAAY;AAAA;AAC7D,KACD,CAAA;AAAA;AACH;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,SAAS,SAAkC,EAAA;AAChD,IAAO,OAAA,IAAI,WAAW,SAAS,CAAA;AAAA;AACjC,EAEA,IAAA;AAAA,EACA,KAAA;AAAA,EACA,aAAA;AAAA,EACA,aAAA;AAAA,EAEQ,WACN,CAAA,YAAA,EACA,GACA,EAAA,IAAA,EACA,YACA,EAAA;AACA,IAAA,IAAA,CAAK,IAAO,GAAA,GAAA;AACZ,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA;AACb,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA;AACrB,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA;AAAA;AACvB;AAAA;AAAA;AAAA,EAKA,eAAe,GAAmB,EAAA;AAChC,IAAO,OAAA,GAAA,CAAI,SAAS,IAAK,CAAA,KAAA;AAAA;AAC3B,EAEQ,+BACN,gBACU,EAAA;AACV,IAAA,IAAI,CAAC,gBAAA,EAAkB,YAAgB,IAAA,IAAA,CAAK,kBAAkB,SAAW,EAAA;AACvE,MAAA,OAAO,EAAC;AAAA;AAGV,IAAA,OAAO,gBAAiB,CAAA,YAAA,GAAe,IAAK,CAAA,aAAa,KAAK,EAAC;AAAA;AACjE;AAAA;AAAA;AAAA,EAKA,MAAM,eACJ,OAC+B,EAAA;AAC/B,IAAA,MAAM,EAAE,GAAA,EAAK,eAAiB,EAAA,GAAG,aAAgB,GAAA,OAAA;AAEjD,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,aAAc,CAAA,OAAA,CAAQ,KAAM,EAAA;AAChD,IAAA,IAAI,iBAAiB,SAAW,EAAA;AAC9B,MAAA,MAAA,CAAO,IAAK,CAAA,GAAG,IAAK,CAAA,aAAA,CAAc,SAAS,CAAA;AAAA;AAG7C,IAAM,MAAA,gBAAA,GACJ,IAAK,CAAA,8BAAA,CAA+B,eAAe,CAAA;AAErD,IAAA,IAAI,iBAAiB,MAAQ,EAAA;AAC3B,MAAO,MAAA,CAAA,IAAA,CAAK,GAAG,gBAAgB,CAAA;AAAA;AAGjC,IAAA,MAAM,eAAe,CAAC,GAAG,IAAI,GAAA,CAAI,MAAM,CAAC,CAAA;AAExC,IAAA,MAAM,QAAQ,MAAM,IAAA,CAAK,IAAK,CAAA,cAAA,CAAe,cAAc,WAAW,CAAA;AAEtE,IAAO,OAAA;AAAA,MACL,KAAA;AAAA,MACA,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA;AAAA;AAChC,KACF;AAAA;AAEJ;;;;"}
+{"version":3,"file":"ScmAuth.esm.js","sources":["../../src/api/ScmAuth.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 {\n  bitbucketAuthApiRef,\n  createApiFactory,\n  githubAuthApiRef,\n  gitlabAuthApiRef,\n  microsoftAuthApiRef,\n  OAuthApi,\n} from '@backstage/core-plugin-api';\nimport {\n  ScmAuthApi,\n  scmAuthApiRef,\n  ScmAuthTokenOptions,\n  ScmAuthTokenResponse,\n} from './ScmAuthApi';\n\ntype ScopeMapping = {\n  /** The base scopes used for all requests */\n  default: string[];\n  /** Additional scopes added if `repoWrite` is requested */\n  repoWrite: string[];\n};\n\n// An enum of all supported providers\ntype ProviderName = 'generic' | 'github' | 'azure' | 'bitbucket' | 'gitlab';\n\nclass ScmAuthMux implements ScmAuthApi {\n  #providers: Array<ScmAuth>;\n\n  constructor(providers: ScmAuth[]) {\n    this.#providers = providers;\n  }\n\n  async getCredentials(\n    options: ScmAuthTokenOptions,\n  ): Promise<ScmAuthTokenResponse> {\n    const url = new URL(options.url);\n    const provider = this.#providers.find(p => p.isUrlSupported(url));\n    if (!provider) {\n      throw new Error(\n        `No auth provider available for '${options.url}', see https://backstage.io/link?scm-auth`,\n      );\n    }\n\n    return provider.getCredentials(options);\n  }\n}\n\n/**\n * An implementation of the ScmAuthApi that merges together OAuthApi instances\n * to form a single instance that can handles authentication for multiple providers.\n *\n * @public\n *\n * @example\n * ```\n * // Supports authentication towards both public GitHub and GHE:\n * createApiFactory({\n *   api: scmAuthApiRef,\n *   deps: {\n *     gheAuthApi: gheAuthApiRef,\n *     githubAuthApi: githubAuthApiRef,\n *   },\n *   factory: ({ githubAuthApi, gheAuthApi }) =>\n *     ScmAuth.merge(\n *       ScmAuth.forGithub(githubAuthApi),\n *       ScmAuth.forGithub(gheAuthApi, {\n *         host: 'ghe.example.com',\n *       }),\n *     )\n * })\n * ```\n */\nexport class ScmAuth implements ScmAuthApi {\n  /**\n   * Creates an API factory that enables auth for each of the default SCM providers.\n   */\n  static createDefaultApiFactory() {\n    return createApiFactory({\n      api: scmAuthApiRef,\n      deps: {\n        github: githubAuthApiRef,\n        gitlab: gitlabAuthApiRef,\n        azure: microsoftAuthApiRef,\n        bitbucket: bitbucketAuthApiRef,\n      },\n      factory: ({ github, gitlab, azure, bitbucket }) =>\n        ScmAuth.merge(\n          ScmAuth.forGithub(github),\n          ScmAuth.forGitlab(gitlab),\n          ScmAuth.forAzure(azure),\n          ScmAuth.forBitbucket(bitbucket),\n        ),\n    });\n  }\n\n  /**\n   * Creates a general purpose ScmAuth instance with a custom scope mapping.\n   */\n  static forAuthApi(\n    authApi: OAuthApi,\n    options: {\n      host: string;\n      scopeMapping: {\n        default: string[];\n        repoWrite: string[];\n      };\n    },\n  ): ScmAuth {\n    return new ScmAuth('generic', authApi, options.host, options.scopeMapping);\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards GitHub.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `github.com`.\n   *\n   * The default scopes are:\n   *\n   * `repo read:org read:user`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `gist`\n   */\n  static forGithub(\n    githubAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'github.com';\n    return new ScmAuth('github', githubAuthApi, host, {\n      default: ['repo', 'read:org', 'read:user'],\n      repoWrite: ['gist'],\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards GitLab.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `gitlab.com`.\n   *\n   * The default scopes are:\n   *\n   * `read_user read_api read_repository`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `write_repository api`\n   */\n  static forGitlab(\n    gitlabAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'gitlab.com';\n    return new ScmAuth('gitlab', gitlabAuthApi, host, {\n      default: ['read_user', 'read_api', 'read_repository'],\n      repoWrite: ['write_repository', 'api'],\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards Azure.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `dev.azure.com`.\n   *\n   * The default scopes are:\n   *\n   * `vso.build vso.code vso.graph vso.project vso.profile`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `vso.code_manage`\n   */\n  static forAzure(\n    microsoftAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'dev.azure.com';\n    return new ScmAuth('azure', microsoftAuthApi, host, {\n      default: [\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.build',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.code',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.graph',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.project',\n        '499b84ac-1321-427f-aa17-267ca6975798/vso.profile',\n      ],\n      repoWrite: ['499b84ac-1321-427f-aa17-267ca6975798/vso.code_manage'],\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards Bitbucket.\n   *\n   * The host option determines which URLs that are handled by this instance and defaults to `bitbucket.org`.\n   *\n   * The default scopes are:\n   *\n   * `account team pullrequest snippet issue`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `pullrequest:write snippet:write issue:write`\n   */\n  static forBitbucket(\n    bitbucketAuthApi: OAuthApi,\n    options?: {\n      host?: string;\n      scopeMapping?: {\n        default?: string[];\n        repoWrite?: string[];\n      };\n    },\n  ): ScmAuth {\n    const host = options?.host ?? 'bitbucket.org';\n    const defaultScopes = options?.scopeMapping?.default ?? [\n      'account',\n      'team',\n      'pullrequest',\n      'snippet',\n      'issue',\n      'project',\n    ];\n    const repoWriteScopes = options?.scopeMapping?.repoWrite ?? [\n      'pullrequest:write',\n      'snippet:write',\n      'issue:write',\n    ];\n    return new ScmAuth('bitbucket', bitbucketAuthApi, host, {\n      default: defaultScopes,\n      repoWrite: repoWriteScopes,\n    });\n  }\n\n  /**\n   * Creates a new ScmAuth instance that handles authentication towards Bitbucket Server.\n   *\n   * The host option determines which URLs that are handled by this instance.\n   *\n   * The default scopes are:\n   *\n   * `PUBLIC_REPOS REPO_READ`\n   *\n   * If the additional `repoWrite` permission is requested, these scopes are added:\n   *\n   * `REPO_WRITE`\n   */\n  static forBitbucketServer(\n    bitbucketAuthApi: OAuthApi,\n    options: {\n      host: string;\n      scopeMapping?: {\n        default?: string[];\n        repoWrite?: string[];\n      };\n    },\n  ): ScmAuth {\n    return this.forBitbucket(bitbucketAuthApi, {\n      host: options.host,\n      scopeMapping: {\n        default: options.scopeMapping?.default ?? ['PUBLIC_REPOS', 'REPO_READ'],\n        repoWrite: options.scopeMapping?.repoWrite ?? ['REPO_WRITE'],\n      },\n    });\n  }\n\n  /**\n   * Merges together multiple ScmAuth instances into one that\n   * routes requests to the correct instance based on the URL.\n   */\n  static merge(...providers: ScmAuth[]): ScmAuthApi {\n    return new ScmAuthMux(providers);\n  }\n\n  #api: OAuthApi;\n  #host: string;\n  #scopeMapping: ScopeMapping;\n  #providerName: ProviderName;\n\n  private constructor(\n    providerName: ProviderName,\n    api: OAuthApi,\n    host: string,\n    scopeMapping: ScopeMapping,\n  ) {\n    this.#api = api;\n    this.#host = host;\n    this.#scopeMapping = scopeMapping;\n    this.#providerName = providerName;\n  }\n\n  /**\n   * Checks whether the implementation is able to provide authentication for the given URL.\n   */\n  isUrlSupported(url: URL): boolean {\n    return url.host === this.#host;\n  }\n\n  private getAdditionalScopesForProvider(\n    additionalScopes: ScmAuthTokenOptions['additionalScope'],\n  ): string[] {\n    if (!additionalScopes?.customScopes || this.#providerName === 'generic') {\n      return [];\n    }\n\n    return additionalScopes.customScopes?.[this.#providerName] ?? [];\n  }\n\n  /**\n   * Fetches credentials for the given resource.\n   */\n  async getCredentials(\n    options: ScmAuthTokenOptions,\n  ): Promise<ScmAuthTokenResponse> {\n    const { url, additionalScope, ...restOptions } = options;\n\n    const scopes = this.#scopeMapping.default.slice();\n    if (additionalScope?.repoWrite) {\n      scopes.push(...this.#scopeMapping.repoWrite);\n    }\n\n    const additionalScopes =\n      this.getAdditionalScopesForProvider(additionalScope);\n\n    if (additionalScopes.length) {\n      scopes.push(...additionalScopes);\n    }\n\n    const uniqueScopes = [...new Set(scopes)];\n\n    const token = await this.#api.getAccessToken(uniqueScopes, restOptions);\n\n    return {\n      token,\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    };\n  }\n}\n"],"names":[],"mappings":";;;AAyCA,MAAM,UAAA,CAAiC;AAAA,EACrC,UAAA;AAAA,EAEA,YAAY,SAAA,EAAsB;AAChC,IAAA,IAAA,CAAK,UAAA,GAAa,SAAA;AAAA,EACpB;AAAA,EAEA,MAAM,eACJ,OAAA,EAC+B;AAC/B,IAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,OAAA,CAAQ,GAAG,CAAA;AAC/B,IAAA,MAAM,QAAA,GAAW,KAAK,UAAA,CAAW,IAAA,CAAK,OAAK,CAAA,CAAE,cAAA,CAAe,GAAG,CAAC,CAAA;AAChE,IAAA,IAAI,CAAC,QAAA,EAAU;AACb,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gCAAA,EAAmC,QAAQ,GAAG,CAAA,yCAAA;AAAA,OAChD;AAAA,IACF;AAEA,IAAA,OAAO,QAAA,CAAS,eAAe,OAAO,CAAA;AAAA,EACxC;AACF;AA2BO,MAAM,OAAA,CAA8B;AAAA;AAAA;AAAA;AAAA,EAIzC,OAAO,uBAAA,GAA0B;AAC/B,IAAA,OAAO,gBAAA,CAAiB;AAAA,MACtB,GAAA,EAAK,aAAA;AAAA,MACL,IAAA,EAAM;AAAA,QACJ,MAAA,EAAQ,gBAAA;AAAA,QACR,MAAA,EAAQ,gBAAA;AAAA,QACR,KAAA,EAAO,mBAAA;AAAA,QACP,SAAA,EAAW;AAAA,OACb;AAAA,MACA,OAAA,EAAS,CAAC,EAAE,MAAA,EAAQ,QAAQ,KAAA,EAAO,SAAA,OACjC,OAAA,CAAQ,KAAA;AAAA,QACN,OAAA,CAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,OAAA,CAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,OAAA,CAAQ,SAAS,KAAK,CAAA;AAAA,QACtB,OAAA,CAAQ,aAAa,SAAS;AAAA;AAChC,KACH,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,UAAA,CACL,OAAA,EACA,OAAA,EAOS;AACT,IAAA,OAAO,IAAI,OAAA,CAAQ,SAAA,EAAW,SAAS,OAAA,CAAQ,IAAA,EAAM,QAAQ,YAAY,CAAA;AAAA,EAC3E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,SAAA,CACL,aAAA,EACA,OAAA,EAGS;AACT,IAAA,MAAM,IAAA,GAAO,SAAS,IAAA,IAAQ,YAAA;AAC9B,IAAA,OAAO,IAAI,OAAA,CAAQ,QAAA,EAAU,aAAA,EAAe,IAAA,EAAM;AAAA,MAChD,OAAA,EAAS,CAAC,MAAA,EAAQ,UAAA,EAAY,WAAW,CAAA;AAAA,MACzC,SAAA,EAAW,CAAC,MAAM;AAAA,KACnB,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,SAAA,CACL,aAAA,EACA,OAAA,EAGS;AACT,IAAA,MAAM,IAAA,GAAO,SAAS,IAAA,IAAQ,YAAA;AAC9B,IAAA,OAAO,IAAI,OAAA,CAAQ,QAAA,EAAU,aAAA,EAAe,IAAA,EAAM;AAAA,MAChD,OAAA,EAAS,CAAC,WAAA,EAAa,UAAA,EAAY,iBAAiB,CAAA;AAAA,MACpD,SAAA,EAAW,CAAC,kBAAA,EAAoB,KAAK;AAAA,KACtC,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAA,CACL,gBAAA,EACA,OAAA,EAGS;AACT,IAAA,MAAM,IAAA,GAAO,SAAS,IAAA,IAAQ,eAAA;AAC9B,IAAA,OAAO,IAAI,OAAA,CAAQ,OAAA,EAAS,gBAAA,EAAkB,IAAA,EAAM;AAAA,MAClD,OAAA,EAAS;AAAA,QACP,gDAAA;AAAA,QACA,+CAAA;AAAA,QACA,gDAAA;AAAA,QACA,kDAAA;AAAA,QACA;AAAA,OACF;AAAA,MACA,SAAA,EAAW,CAAC,sDAAsD;AAAA,KACnE,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,YAAA,CACL,gBAAA,EACA,OAAA,EAOS;AACT,IAAA,MAAM,IAAA,GAAO,SAAS,IAAA,IAAQ,eAAA;AAC9B,IAAA,MAAM,aAAA,GAAgB,OAAA,EAAS,YAAA,EAAc,OAAA,IAAW;AAAA,MACtD,SAAA;AAAA,MACA,MAAA;AAAA,MACA,aAAA;AAAA,MACA,SAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,eAAA,GAAkB,OAAA,EAAS,YAAA,EAAc,SAAA,IAAa;AAAA,MAC1D,mBAAA;AAAA,MACA,eAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,OAAO,IAAI,OAAA,CAAQ,WAAA,EAAa,gBAAA,EAAkB,IAAA,EAAM;AAAA,MACtD,OAAA,EAAS,aAAA;AAAA,MACT,SAAA,EAAW;AAAA,KACZ,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,kBAAA,CACL,gBAAA,EACA,OAAA,EAOS;AACT,IAAA,OAAO,IAAA,CAAK,aAAa,gBAAA,EAAkB;AAAA,MACzC,MAAM,OAAA,CAAQ,IAAA;AAAA,MACd,YAAA,EAAc;AAAA,QACZ,SAAS,OAAA,CAAQ,YAAA,EAAc,OAAA,IAAW,CAAC,gBAAgB,WAAW,CAAA;AAAA,QACtE,SAAA,EAAW,OAAA,CAAQ,YAAA,EAAc,SAAA,IAAa,CAAC,YAAY;AAAA;AAC7D,KACD,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,SAAS,SAAA,EAAkC;AAChD,IAAA,OAAO,IAAI,WAAW,SAAS,CAAA;AAAA,EACjC;AAAA,EAEA,IAAA;AAAA,EACA,KAAA;AAAA,EACA,aAAA;AAAA,EACA,aAAA;AAAA,EAEQ,WAAA,CACN,YAAA,EACA,GAAA,EACA,IAAA,EACA,YAAA,EACA;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,GAAA;AACZ,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA;AACb,IAAA,IAAA,CAAK,aAAA,GAAgB,YAAA;AACrB,IAAA,IAAA,CAAK,aAAA,GAAgB,YAAA;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,GAAA,EAAmB;AAChC,IAAA,OAAO,GAAA,CAAI,SAAS,IAAA,CAAK,KAAA;AAAA,EAC3B;AAAA,EAEQ,+BACN,gBAAA,EACU;AACV,IAAA,IAAI,CAAC,gBAAA,EAAkB,YAAA,IAAgB,IAAA,CAAK,kBAAkB,SAAA,EAAW;AACvE,MAAA,OAAO,EAAC;AAAA,IACV;AAEA,IAAA,OAAO,gBAAA,CAAiB,YAAA,GAAe,IAAA,CAAK,aAAa,KAAK,EAAC;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eACJ,OAAA,EAC+B;AAC/B,IAAA,MAAM,EAAE,GAAA,EAAK,eAAA,EAAiB,GAAG,aAAY,GAAI,OAAA;AAEjD,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,aAAA,CAAc,OAAA,CAAQ,KAAA,EAAM;AAChD,IAAA,IAAI,iBAAiB,SAAA,EAAW;AAC9B,MAAA,MAAA,CAAO,IAAA,CAAK,GAAG,IAAA,CAAK,aAAA,CAAc,SAAS,CAAA;AAAA,IAC7C;AAEA,IAAA,MAAM,gBAAA,GACJ,IAAA,CAAK,8BAAA,CAA+B,eAAe,CAAA;AAErD,IAAA,IAAI,iBAAiB,MAAA,EAAQ;AAC3B,MAAA,MAAA,CAAO,IAAA,CAAK,GAAG,gBAAgB,CAAA;AAAA,IACjC;AAEA,IAAA,MAAM,eAAe,CAAC,GAAG,IAAI,GAAA,CAAI,MAAM,CAAC,CAAA;AAExC,IAAA,MAAM,QAAQ,MAAM,IAAA,CAAK,IAAA,CAAK,cAAA,CAAe,cAAc,WAAW,CAAA;AAEtE,IAAA,OAAO;AAAA,MACL,KAAA;AAAA,MACA,OAAA,EAAS;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA;AAAA;AAChC,KACF;AAAA,EACF;AACF;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"ScmAuthApi.esm.js","sources":["../../src/api/ScmAuthApi.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  ApiRef,\n  createApiRef,\n  AuthRequestOptions,\n} from '@backstage/core-plugin-api';\n\n/**\n * The options that control a {@link ScmAuthApi.getCredentials} call.\n *\n * @public\n */\nexport interface ScmAuthTokenOptions extends AuthRequestOptions {\n  /**\n   * The URL of the SCM resource to be accessed.\n   *\n   * @example https://github.com/backstage/backstage\n   */\n  url: string;\n\n  /**\n   * Whether to request additional access scope.\n   *\n   * Read access to user, organization, and repositories is always included.\n   */\n  additionalScope?: {\n    /**\n     * Requests access to be able to write repository content, including\n     * the ability to create things like issues and pull requests.\n     */\n    repoWrite?: boolean;\n    /**\n     * Allow an arbitrary list of scopes provided from the user\n     * to request from the provider.\n     */\n    customScopes?: {\n      github?: string[];\n      azure?: string[];\n      bitbucket?: string[];\n      gitlab?: string[];\n    };\n  };\n}\n\n/**\n * The response from a {@link ScmAuthApi.getCredentials} call.\n *\n * @public\n */\nexport interface ScmAuthTokenResponse {\n  /**\n   * An authorization token that can be used to authenticate requests.\n   */\n  token: string;\n\n  /**\n   * The set of HTTP headers that are needed to authenticate requests.\n   */\n  headers: { [name: string]: string };\n}\n\n/**\n * ScmAuthApi provides methods for authenticating towards source code management services.\n *\n * As opposed to using the GitHub, GitLab and other auth APIs\n * directly, this API allows for more generic access to SCM services.\n *\n * @public\n */\nexport interface ScmAuthApi {\n  /**\n   * Requests credentials for accessing an SCM resource.\n   */\n  getCredentials(options: ScmAuthTokenOptions): Promise<ScmAuthTokenResponse>;\n}\n\n/**\n * The ApiRef for the ScmAuthApi.\n *\n * @public\n */\nexport const scmAuthApiRef: ApiRef<ScmAuthApi> = createApiRef({\n  id: 'core.scmauth',\n});\n"],"names":[],"mappings":";;AAgGO,MAAM,gBAAoC,YAAa,CAAA;AAAA,EAC5D,EAAI,EAAA;AACN,CAAC;;;;"}
+{"version":3,"file":"ScmAuthApi.esm.js","sources":["../../src/api/ScmAuthApi.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  ApiRef,\n  createApiRef,\n  AuthRequestOptions,\n} from '@backstage/core-plugin-api';\n\n/**\n * The options that control a {@link ScmAuthApi.getCredentials} call.\n *\n * @public\n */\nexport interface ScmAuthTokenOptions extends AuthRequestOptions {\n  /**\n   * The URL of the SCM resource to be accessed.\n   *\n   * @example https://github.com/backstage/backstage\n   */\n  url: string;\n\n  /**\n   * Whether to request additional access scope.\n   *\n   * Read access to user, organization, and repositories is always included.\n   */\n  additionalScope?: {\n    /**\n     * Requests access to be able to write repository content, including\n     * the ability to create things like issues and pull requests.\n     */\n    repoWrite?: boolean;\n    /**\n     * Allow an arbitrary list of scopes provided from the user\n     * to request from the provider.\n     */\n    customScopes?: {\n      github?: string[];\n      azure?: string[];\n      bitbucket?: string[];\n      gitlab?: string[];\n    };\n  };\n}\n\n/**\n * The response from a {@link ScmAuthApi.getCredentials} call.\n *\n * @public\n */\nexport interface ScmAuthTokenResponse {\n  /**\n   * An authorization token that can be used to authenticate requests.\n   */\n  token: string;\n\n  /**\n   * The set of HTTP headers that are needed to authenticate requests.\n   */\n  headers: { [name: string]: string };\n}\n\n/**\n * ScmAuthApi provides methods for authenticating towards source code management services.\n *\n * As opposed to using the GitHub, GitLab and other auth APIs\n * directly, this API allows for more generic access to SCM services.\n *\n * @public\n */\nexport interface ScmAuthApi {\n  /**\n   * Requests credentials for accessing an SCM resource.\n   */\n  getCredentials(options: ScmAuthTokenOptions): Promise<ScmAuthTokenResponse>;\n}\n\n/**\n * The ApiRef for the ScmAuthApi.\n *\n * @public\n */\nexport const scmAuthApiRef: ApiRef<ScmAuthApi> = createApiRef({\n  id: 'core.scmauth',\n});\n"],"names":[],"mappings":";;AAgGO,MAAM,gBAAoC,YAAA,CAAa;AAAA,EAC5D,EAAA,EAAI;AACN,CAAC;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"ScmIntegrationsApi.esm.js","sources":["../../src/api/ScmIntegrationsApi.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 { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { ApiRef, createApiRef } from '@backstage/core-plugin-api';\n\n/**\n * Factory class for creating {@link @backstage/integration#ScmIntegrationRegistry} instances.\n *\n * @public\n */\nexport class ScmIntegrationsApi {\n  /**\n   * Instantiates an {@link @backstage/integration#ScmIntegrationRegistry}.\n   *\n   * @param config - The root of the config hierarchy.\n   */\n  static fromConfig(config: Config): ScmIntegrationRegistry {\n    return ScmIntegrations.fromConfig(config);\n  }\n}\n\n/**\n * The API that holds all configured SCM integrations.\n *\n * @public\n */\nexport const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry> =\n  createApiRef({\n    id: 'integration.scmintegrations',\n  });\n"],"names":[],"mappings":";;;AA4BO,MAAM,kBAAmB,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,OAAO,WAAW,MAAwC,EAAA;AACxD,IAAO,OAAA,eAAA,CAAgB,WAAW,MAAM,CAAA;AAAA;AAE5C;AAOO,MAAM,wBACX,YAAa,CAAA;AAAA,EACX,EAAI,EAAA;AACN,CAAC;;;;"}
+{"version":3,"file":"ScmIntegrationsApi.esm.js","sources":["../../src/api/ScmIntegrationsApi.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 { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { ApiRef, createApiRef } from '@backstage/core-plugin-api';\n\n/**\n * Factory class for creating {@link @backstage/integration#ScmIntegrationRegistry} instances.\n *\n * @public\n */\nexport class ScmIntegrationsApi {\n  /**\n   * Instantiates an {@link @backstage/integration#ScmIntegrationRegistry}.\n   *\n   * @param config - The root of the config hierarchy.\n   */\n  static fromConfig(config: Config): ScmIntegrationRegistry {\n    return ScmIntegrations.fromConfig(config);\n  }\n}\n\n/**\n * The API that holds all configured SCM integrations.\n *\n * @public\n */\nexport const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry> =\n  createApiRef({\n    id: 'integration.scmintegrations',\n  });\n"],"names":[],"mappings":";;;AA4BO,MAAM,kBAAA,CAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,OAAO,WAAW,MAAA,EAAwC;AACxD,IAAA,OAAO,eAAA,CAAgB,WAAW,MAAM,CAAA;AAAA,EAC1C;AACF;AAOO,MAAM,wBACX,YAAA,CAAa;AAAA,EACX,EAAA,EAAI;AACN,CAAC;;;;"}

package/dist/components/ScmIntegrationIcon/ScmIntegrationIcon.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScmIntegrationIcon.esm.js","sources":["../../../src/components/ScmIntegrationIcon/ScmIntegrationIcon.tsx"],"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 */\nimport CodeIcon from '@material-ui/icons/Code';\nimport { useApp } from '@backstage/core-plugin-api';\n\n/**\n * Props for {@link ScmIntegrationIcon}.\n *\n * @public\n */\nexport type ScmIntegrationIconProps = {\n  /**\n   * The integration type, e.g. \"github\".\n   */\n  type?: string;\n};\n\n/**\n * An icon that represents a certain SCM integration.\n *\n * @public\n */\nexport const ScmIntegrationIcon = (props: ScmIntegrationIconProps) => {\n  const { type } = props;\n  const app = useApp();\n  const DefaultIcon = CodeIcon;\n  const Icon = type ? app.getSystemIcon(type) ?? DefaultIcon : DefaultIcon;\n  return <Icon />;\n};\n"],"names":[],"mappings":";;;;AAmCa,MAAA,kBAAA,GAAqB,CAAC,KAAmC,KAAA;AACpE,EAAM,MAAA,EAAE,MAAS,GAAA,KAAA;AACjB,EAAA,MAAM,MAAM,MAAO,EAAA;AACnB,EAAA,MAAM,WAAc,GAAA,QAAA;AACpB,EAAA,MAAM,OAAO,IAAO,GAAA,GAAA,CAAI,aAAc,CAAA,IAAI,KAAK,WAAc,GAAA,WAAA;AAC7D,EAAA,2BAAQ,IAAK,EAAA,EAAA,CAAA;AACf;;;;"}
+{"version":3,"file":"ScmIntegrationIcon.esm.js","sources":["../../../src/components/ScmIntegrationIcon/ScmIntegrationIcon.tsx"],"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 */\nimport CodeIcon from '@material-ui/icons/Code';\nimport { useApp } from '@backstage/core-plugin-api';\n\n/**\n * Props for {@link ScmIntegrationIcon}.\n *\n * @public\n */\nexport type ScmIntegrationIconProps = {\n  /**\n   * The integration type, e.g. \"github\".\n   */\n  type?: string;\n};\n\n/**\n * An icon that represents a certain SCM integration.\n *\n * @public\n */\nexport const ScmIntegrationIcon = (props: ScmIntegrationIconProps) => {\n  const { type } = props;\n  const app = useApp();\n  const DefaultIcon = CodeIcon;\n  const Icon = type ? app.getSystemIcon(type) ?? DefaultIcon : DefaultIcon;\n  return <Icon />;\n};\n"],"names":[],"mappings":";;;;AAmCO,MAAM,kBAAA,GAAqB,CAAC,KAAA,KAAmC;AACpE,EAAA,MAAM,EAAE,MAAK,GAAI,KAAA;AACjB,EAAA,MAAM,MAAM,MAAA,EAAO;AACnB,EAAA,MAAM,WAAA,GAAc,QAAA;AACpB,EAAA,MAAM,OAAO,IAAA,GAAO,GAAA,CAAI,aAAA,CAAc,IAAI,KAAK,WAAA,GAAc,WAAA;AAC7D,EAAA,2BAAQ,IAAA,EAAA,EAAK,CAAA;AACf;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { AuthRequestOptions, ApiRef, OAuthApi } from '@backstage/core-plugin-api';
+import { ApiRef, AuthRequestOptions, OAuthApi } from '@backstage/core-plugin-api';
 import { Config } from '@backstage/config';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import * as react_jsx_runtime from 'react/jsx-runtime';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/integration-react",
-  "version": "1.2.9",
+  "version": "1.2.10-next.0",
   "description": "Frontend package for managing integrations towards external systems",
   "backstage": {
     "role": "web-library"
@@ -33,17 +33,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/config": "^1.3.3",
-    "@backstage/core-plugin-api": "^1.10.9",
-    "@backstage/integration": "^1.17.1",
+    "@backstage/config": "1.3.3",
+    "@backstage/core-plugin-api": "1.10.9",
+    "@backstage/integration": "1.18.0-next.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.33.1",
-    "@backstage/core-components": "^0.17.4",
-    "@backstage/dev-utils": "^1.1.12",
-    "@backstage/test-utils": "^1.7.10",
+    "@backstage/cli": "0.34.2-next.1",
+    "@backstage/core-components": "0.17.6-next.0",
+    "@backstage/dev-utils": "1.1.14-next.1",
+    "@backstage/test-utils": "1.7.11",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@types/react": "^18.0.0",