@backstage/integration-react 0.1.12 → 0.1.16

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @backstage/integration-react
 
+## 0.1.16
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@0.4.0
+  - @backstage/core-components@0.8.2
+
+## 0.1.15
+
+### Patch Changes
+
+- cd450844f6: Moved React dependencies to `peerDependencies` and allow both React v16 and v17 to be used.
+- Updated dependencies
+  - @backstage/core-components@0.8.0
+  - @backstage/core-plugin-api@0.3.0
+
+## 0.1.14
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.7.4
+  - @backstage/core-plugin-api@0.2.0
+
+## 0.1.13
+
+### Patch Changes
+
+- 36e2b548cb: Clean up the API exports
+- Updated dependencies
+  - @backstage/config@0.1.11
+  - @backstage/theme@0.2.12
+  - @backstage/integration@0.6.9
+  - @backstage/core-components@0.7.2
+  - @backstage/core-plugin-api@0.1.12
+
 ## 0.1.12
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,7 +4,11 @@ import { AuthRequestOptions, ApiRef, OAuthApi } from '@backstage/core-plugin-api
 import { Config } from '@backstage/config';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 
-/** @public */
+/**
+ * The options that control a {@link ScmAuthApi.getCredentials} call.
+ *
+ * @public
+ */
 interface ScmAuthTokenOptions extends AuthRequestOptions {
     /**
      * The URL of the SCM resource to be accessed.
@@ -25,7 +29,11 @@ interface ScmAuthTokenOptions extends AuthRequestOptions {
         repoWrite?: boolean;
     };
 }
-/** @public */
+/**
+ * The response from a {@link ScmAuthApi.getCredentials} call.
+ *
+ * @public
+ */
 interface ScmAuthTokenResponse {
     /**
      * An authorization token that can be used to authenticate requests.
@@ -178,16 +186,48 @@ declare class ScmAuth implements ScmAuthApi {
      * Checks whether the implementation is able to provide authentication for the given URL.
      */
     isUrlSupported(url: URL): boolean;
+    /**
+     * Fetches credentials for the given resource.
+     */
     getCredentials(options: ScmAuthTokenOptions): Promise<ScmAuthTokenResponse>;
 }
 
+/**
+ * Factory class for creating {@link @backstage/integration#ScmIntegrationRegistry} instances.
+ *
+ * @public
+ */
 declare class ScmIntegrationsApi {
+    /**
+     * Instantiates an {@link @backstage/integration#ScmIntegrationRegistry}.
+     *
+     * @param config - The root of the config hierarchy.
+     */
     static fromConfig(config: Config): ScmIntegrationRegistry;
 }
+/**
+ * The API that holds all configured SCM integrations.
+ *
+ * @public
+ */
 declare const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry>;
 
-declare const ScmIntegrationIcon: ({ type }: {
-    type?: string | undefined;
-}) => JSX.Element;
+/**
+ * Props for {@link ScmIntegrationIcon}.
+ *
+ * @public
+ */
+declare type ScmIntegrationIconProps = {
+    /**
+     * The integration type, e.g. "github".
+     */
+    type?: string;
+};
+/**
+ * An icon that represents a certain SCM integration.
+ *
+ * @public
+ */
+declare const ScmIntegrationIcon: (props: ScmIntegrationIconProps) => JSX.Element;
 
-export { ScmAuth, ScmAuthApi, ScmAuthTokenOptions, ScmAuthTokenResponse, ScmIntegrationIcon, ScmIntegrationsApi, scmAuthApiRef, scmIntegrationsApiRef };
+export { ScmAuth, ScmAuthApi, ScmAuthTokenOptions, ScmAuthTokenResponse, ScmIntegrationIcon, ScmIntegrationIconProps, ScmIntegrationsApi, scmAuthApiRef, scmIntegrationsApiRef };

package/dist/index.esm.js

@@ -15,6 +15,11 @@ var __privateGet = (obj, member, getter) => {
   __accessCheck(obj, member, "read from private field");
   return getter ? getter.call(obj) : member.get(obj);
 };
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
 var __privateSet = (obj, member, value, setter) => {
   __accessCheck(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
@@ -23,7 +28,7 @@ var __privateSet = (obj, member, value, setter) => {
 var _providers, _api, _host, _scopeMapping;
 class ScmAuthMux {
   constructor(providers) {
-    _providers.set(this, void 0);
+    __privateAdd(this, _providers, void 0);
     __privateSet(this, _providers, providers);
   }
   async getCredentials(options) {
@@ -38,9 +43,9 @@ class ScmAuthMux {
 _providers = new WeakMap();
 const _ScmAuth = class {
   constructor(api, host, scopeMapping) {
-    _api.set(this, void 0);
-    _host.set(this, void 0);
-    _scopeMapping.set(this, void 0);
+    __privateAdd(this, _api, void 0);
+    __privateAdd(this, _host, void 0);
+    __privateAdd(this, _scopeMapping, void 0);
     __privateSet(this, _api, api);
     __privateSet(this, _host, host);
     __privateSet(this, _scopeMapping, scopeMapping);
@@ -53,7 +58,7 @@ const _ScmAuth = class {
         gitlab: gitlabAuthApiRef,
         azure: microsoftAuthApiRef
       },
-      factory: ({github, gitlab, azure}) => _ScmAuth.merge(_ScmAuth.forGithub(github), _ScmAuth.forGitlab(gitlab), _ScmAuth.forAzure(azure))
+      factory: ({ github, gitlab, azure }) => _ScmAuth.merge(_ScmAuth.forGithub(github), _ScmAuth.forGitlab(gitlab), _ScmAuth.forAzure(azure))
     });
   }
   static forAuthApi(authApi, options) {
@@ -104,7 +109,7 @@ const _ScmAuth = class {
     return url.host === __privateGet(this, _host);
   }
   async getCredentials(options) {
-    const {url, additionalScope, ...restOptions} = options;
+    const { url, additionalScope, ...restOptions } = options;
     const scopes = __privateGet(this, _scopeMapping).default.slice();
     if (additionalScope == null ? void 0 : additionalScope.repoWrite) {
       scopes.push(...__privateGet(this, _scopeMapping).repoWrite);
@@ -129,12 +134,12 @@ class ScmIntegrationsApi {
   }
 }
 const scmIntegrationsApiRef = createApiRef({
-  id: "integration.scmintegrations",
-  description: "All of the registered SCM integrations of your config"
+  id: "integration.scmintegrations"
 });
 
-const ScmIntegrationIcon = ({type}) => {
+const ScmIntegrationIcon = (props) => {
   var _a;
+  const { type } = props;
   const app = useApp();
   const DefaultIcon = CodeIcon;
   const Icon = type ? (_a = app.getSystemIcon(type)) != null ? _a : DefaultIcon : DefaultIcon;

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/api/ScmAuthApi.ts","../src/api/ScmAuth.ts","../src/api/ScmIntegrationsApi.ts","../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 */\n\nimport {\n  ApiRef,\n  createApiRef,\n  AuthRequestOptions,\n} from '@backstage/core-plugin-api';\n\n/** @public */\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}\n\n/** @public */\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","/*\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  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\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 authentication provider available for access to '${options.url}'`,\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      },\n      factory: ({ github, gitlab, azure }) =>\n        ScmAuth.merge(\n          ScmAuth.forGithub(github),\n          ScmAuth.forGitlab(gitlab),\n          ScmAuth.forAzure(azure),\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(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(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(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(microsoftAuthApi, host, {\n      default: [\n        'vso.build',\n        'vso.code',\n        'vso.graph',\n        'vso.project',\n        'vso.profile',\n      ],\n      repoWrite: ['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    },\n  ): ScmAuth {\n    const host = options?.host ?? 'bitbucket.org';\n    return new ScmAuth(bitbucketAuthApi, host, {\n      default: ['account', 'team', 'pullrequest', 'snippet', 'issue'],\n      repoWrite: ['pullrequest:write', 'snippet:write', 'issue:write'],\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\n  private constructor(api: OAuthApi, host: string, scopeMapping: ScopeMapping) {\n    this.#api = api;\n    this.#host = host;\n    this.#scopeMapping = scopeMapping;\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  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 token = await this.#api.getAccessToken(scopes, restOptions);\n    return {\n      token,\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    };\n  }\n}\n","/*\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\nexport class ScmIntegrationsApi {\n  static fromConfig(config: Config): ScmIntegrationRegistry {\n    return ScmIntegrations.fromConfig(config);\n  }\n}\n\nexport const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry> =\n  createApiRef({\n    id: 'integration.scmintegrations',\n    description: 'All of the registered SCM integrations of your config',\n  });\n","/*\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 React from 'react';\nimport { useApp } from '@backstage/core-plugin-api';\n\nexport const ScmIntegrationIcon = ({ type }: { type?: string }) => {\n  const app = useApp();\n  const DefaultIcon = CodeIcon;\n  const Icon = type ? app.getSystemIcon(type) ?? DefaultIcon : DefaultIcon;\n  return <Icon />;\n};\n"],"names":[],"mappings":";;;;;MA8Ea,gBAAoC,aAAa;AAAA,EAC5D,IAAI;AAAA;;;;;;;;;;;;;;;AC/EN;AAqCA,iBAAuC;AAAA,EAGrC,YAAY,WAAsB;AAFlC;AAGE,uBAAK,YAAa;AAAA;AAAA,QAGd,eACJ,SAC+B;AAC/B,UAAM,MAAM,IAAI,IAAI,QAAQ;AAC5B,UAAM,WAAW,mBAAK,YAAW,KAAK,OAAK,EAAE,eAAe;AAC5D,QAAI,CAAC,UAAU;AACb,YAAM,IAAI,MACR,uDAAuD,QAAQ;AAAA;AAInE,WAAO,SAAS,eAAe;AAAA;AAAA;AAjBjC;AA8CK,uBAAoC;AAAA,EA+JjC,YAAY,KAAe,MAAc,cAA4B;AAJ7E;AACA;AACA;AAGE,uBAAK,MAAO;AACZ,uBAAK,OAAQ;AACb,uBAAK,eAAgB;AAAA;AAAA,SA9JhB,0BAA0B;AAC/B,WAAO,iBAAiB;AAAA,MACtB,KAAK;AAAA,MACL,MAAM;AAAA,QACJ,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,OAAO;AAAA;AAAA,MAET,SAAS,CAAC,CAAE,QAAQ,QAAQ,WAC1B,SAAQ,MACN,SAAQ,UAAU,SAClB,SAAQ,UAAU,SAClB,SAAQ,SAAS;AAAA;AAAA;AAAA,SAQlB,WACL,SACA,SAOS;AACT,WAAO,IAAI,SAAQ,SAAS,QAAQ,MAAM,QAAQ;AAAA;AAAA,SAgB7C,UACL,eACA,SAGS;AA3Ib;AA4II,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,eAAe,MAAM;AAAA,MACtC,SAAS,CAAC,QAAQ,YAAY;AAAA,MAC9B,WAAW,CAAC;AAAA;AAAA;AAAA,SAiBT,UACL,eACA,SAGS;AArKb;AAsKI,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,eAAe,MAAM;AAAA,MACtC,SAAS,CAAC,aAAa,YAAY;AAAA,MACnC,WAAW,CAAC,oBAAoB;AAAA;AAAA;AAAA,SAiB7B,SACL,kBACA,SAGS;AA/Lb;AAgMI,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,kBAAkB,MAAM;AAAA,MACzC,SAAS;AAAA,QACP;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA;AAAA,MAEF,WAAW,CAAC;AAAA;AAAA;AAAA,SAiBT,aACL,kBACA,SAGS;AA/Nb;AAgOI,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,kBAAkB,MAAM;AAAA,MACzC,SAAS,CAAC,WAAW,QAAQ,eAAe,WAAW;AAAA,MACvD,WAAW,CAAC,qBAAqB,iBAAiB;AAAA;AAAA;AAAA,SAQ/C,SAAS,WAAkC;AAChD,WAAO,IAAI,WAAW;AAAA;AAAA,EAgBxB,eAAe,KAAmB;AAChC,WAAO,IAAI,SAAS,mBAAK;AAAA;AAAA,QAGrB,eACJ,SAC+B;AAC/B,UAAM,CAAE,KAAK,oBAAoB,eAAgB;AAEjD,UAAM,SAAS,mBAAK,eAAc,QAAQ;AAC1C,QAAI,mDAAiB,WAAW;AAC9B,aAAO,KAAK,GAAG,mBAAK,eAAc;AAAA;AAGpC,UAAM,QAAQ,MAAM,mBAAK,MAAK,eAAe,QAAQ;AACrD,WAAO;AAAA,MACL;AAAA,MACA,SAAS;AAAA,QACP,eAAe,UAAU;AAAA;AAAA;AAAA;AAAA;;AA/B/B;AACA;AACA;;yBC1N8B;AAAA,SACvB,WAAW,QAAwC;AACxD,WAAO,gBAAgB,WAAW;AAAA;AAAA;MAIzB,wBACX,aAAa;AAAA,EACX,IAAI;AAAA,EACJ,aAAa;AAAA;;MCbJ,qBAAqB,CAAC,CAAE,UAA8B;AAnBnE;AAoBE,QAAM,MAAM;AACZ,QAAM,cAAc;AACpB,QAAM,OAAO,OAAO,UAAI,cAAc,UAAlB,YAA2B,cAAc;AAC7D,6CAAQ,MAAD;AAAA;;;;"}
+{"version":3,"file":"index.esm.js","sources":["../src/api/ScmAuthApi.ts","../src/api/ScmAuth.ts","../src/api/ScmIntegrationsApi.ts","../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 */\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}\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","/*\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  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\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 authentication provider available for access to '${options.url}'`,\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      },\n      factory: ({ github, gitlab, azure }) =>\n        ScmAuth.merge(\n          ScmAuth.forGithub(github),\n          ScmAuth.forGitlab(gitlab),\n          ScmAuth.forAzure(azure),\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(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(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(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(microsoftAuthApi, host, {\n      default: [\n        'vso.build',\n        'vso.code',\n        'vso.graph',\n        'vso.project',\n        'vso.profile',\n      ],\n      repoWrite: ['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    },\n  ): ScmAuth {\n    const host = options?.host ?? 'bitbucket.org';\n    return new ScmAuth(bitbucketAuthApi, host, {\n      default: ['account', 'team', 'pullrequest', 'snippet', 'issue'],\n      repoWrite: ['pullrequest:write', 'snippet:write', 'issue:write'],\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\n  private constructor(api: OAuthApi, host: string, scopeMapping: ScopeMapping) {\n    this.#api = api;\n    this.#host = host;\n    this.#scopeMapping = scopeMapping;\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  /**\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 token = await this.#api.getAccessToken(scopes, restOptions);\n    return {\n      token,\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    };\n  }\n}\n","/*\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","/*\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 React from 'react';\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":";;;;;MAsFa,gBAAoC,aAAa;AAAA,EAC5D,IAAI;AAAA;;;;;;;;;;;;;;;;;;;;ACvFN;AAqCA,iBAAuC;AAAA,EAGrC,YAAY,WAAsB;AAFlC;AAGE,uBAAK,YAAa;AAAA;AAAA,QAGd,eACJ,SAC+B;AAC/B,UAAM,MAAM,IAAI,IAAI,QAAQ;AAC5B,UAAM,WAAW,mBAAK,YAAW,KAAK,OAAK,EAAE,eAAe;AAC5D,QAAI,CAAC,UAAU;AACb,YAAM,IAAI,MACR,uDAAuD,QAAQ;AAAA;AAInE,WAAO,SAAS,eAAe;AAAA;AAAA;AAjBjC;AA8CK,uBAAoC;AAAA,EA+JjC,YAAY,KAAe,MAAc,cAA4B;AAJ7E;AACA;AACA;AAGE,uBAAK,MAAO;AACZ,uBAAK,OAAQ;AACb,uBAAK,eAAgB;AAAA;AAAA,SA9JhB,0BAA0B;AAC/B,WAAO,iBAAiB;AAAA,MACtB,KAAK;AAAA,MACL,MAAM;AAAA,QACJ,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,OAAO;AAAA;AAAA,MAET,SAAS,CAAC,EAAE,QAAQ,QAAQ,YAC1B,SAAQ,MACN,SAAQ,UAAU,SAClB,SAAQ,UAAU,SAClB,SAAQ,SAAS;AAAA;AAAA;AAAA,SAQlB,WACL,SACA,SAOS;AACT,WAAO,IAAI,SAAQ,SAAS,QAAQ,MAAM,QAAQ;AAAA;AAAA,SAgB7C,UACL,eACA,SAGS;AA3Ib;AA4II,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,eAAe,MAAM;AAAA,MACtC,SAAS,CAAC,QAAQ,YAAY;AAAA,MAC9B,WAAW,CAAC;AAAA;AAAA;AAAA,SAiBT,UACL,eACA,SAGS;AArKb;AAsKI,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,eAAe,MAAM;AAAA,MACtC,SAAS,CAAC,aAAa,YAAY;AAAA,MACnC,WAAW,CAAC,oBAAoB;AAAA;AAAA;AAAA,SAiB7B,SACL,kBACA,SAGS;AA/Lb;AAgMI,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,kBAAkB,MAAM;AAAA,MACzC,SAAS;AAAA,QACP;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA;AAAA,MAEF,WAAW,CAAC;AAAA;AAAA;AAAA,SAiBT,aACL,kBACA,SAGS;AA/Nb;AAgOI,UAAM,OAAO,yCAAS,SAAT,YAAiB;AAC9B,WAAO,IAAI,SAAQ,kBAAkB,MAAM;AAAA,MACzC,SAAS,CAAC,WAAW,QAAQ,eAAe,WAAW;AAAA,MACvD,WAAW,CAAC,qBAAqB,iBAAiB;AAAA;AAAA;AAAA,SAQ/C,SAAS,WAAkC;AAChD,WAAO,IAAI,WAAW;AAAA;AAAA,EAgBxB,eAAe,KAAmB;AAChC,WAAO,IAAI,SAAS,mBAAK;AAAA;AAAA,QAMrB,eACJ,SAC+B;AAC/B,UAAM,EAAE,KAAK,oBAAoB,gBAAgB;AAEjD,UAAM,SAAS,mBAAK,eAAc,QAAQ;AAC1C,QAAI,mDAAiB,WAAW;AAC9B,aAAO,KAAK,GAAG,mBAAK,eAAc;AAAA;AAGpC,UAAM,QAAQ,MAAM,mBAAK,MAAK,eAAe,QAAQ;AACrD,WAAO;AAAA,MACL;AAAA,MACA,SAAS;AAAA,QACP,eAAe,UAAU;AAAA;AAAA;AAAA;AAAA;;AAlC/B;AACA;AACA;;yBCrN8B;AAAA,SAMvB,WAAW,QAAwC;AACxD,WAAO,gBAAgB,WAAW;AAAA;AAAA;MASzB,wBACX,aAAa;AAAA,EACX,IAAI;AAAA;;MCVK,qBAAqB,CAAC,UAAmC;AApCtE;AAqCE,QAAM,EAAE,SAAS;AACjB,QAAM,MAAM;AACZ,QAAM,cAAc;AACpB,QAAM,OAAO,OAAO,UAAI,cAAc,UAAlB,YAA2B,cAAc;AAC7D,6CAAQ,MAAD;AAAA;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/integration-react",
   "description": "Frontend package for managing integrations towards external systems",
-  "version": "0.1.12",
+  "version": "0.1.16",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -21,32 +21,33 @@
     "clean": "backstage-cli clean"
   },
   "dependencies": {
-    "@backstage/config": "^0.1.10",
-    "@backstage/core-components": "^0.7.0",
-    "@backstage/core-plugin-api": "^0.1.9",
-    "@backstage/integration": "^0.6.8",
-    "@backstage/theme": "^0.2.11",
+    "@backstage/config": "^0.1.11",
+    "@backstage/core-components": "^0.8.2",
+    "@backstage/core-plugin-api": "^0.4.0",
+    "@backstage/integration": "^0.6.10",
+    "@backstage/theme": "^0.2.14",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.57",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
     "react-use": "^17.2.4"
   },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0"
+  },
   "devDependencies": {
-    "@backstage/cli": "^0.7.16",
-    "@backstage/dev-utils": "^0.2.12",
-    "@backstage/test-utils": "^0.1.19",
+    "@backstage/cli": "^0.10.3",
+    "@backstage/dev-utils": "^0.2.15",
+    "@backstage/test-utils": "^0.2.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^11.2.5",
     "@testing-library/user-event": "^13.1.8",
     "@types/jest": "^26.0.7",
     "@types/node": "^14.14.32",
     "cross-fetch": "^3.0.6",
-    "msw": "^0.29.0"
+    "msw": "^0.35.0"
   },
   "files": [
     "dist"
   ],
-  "gitHead": "1b02df9f467ea11a4571df46faabe655c3ee10c8"
+  "gitHead": "b315430f9dfcfa19ab0dd90f5b4ac6904938fba7"
 }