@backstage-community/plugin-copilot-backend 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage-community/plugin-copilot-backend
 
+## 0.4.0
+
+### Minor Changes
+
+- 6e44ae3: Added ability to use GitHub App authentication for organization level metrics
+
 ## 0.3.2
 
 ### Patch Changes

package/README.md

@@ -63,9 +63,9 @@ To install the plugin using the old method:
 
 ## Configuration
 
-### Environment Variables
+### App Config
 
-To configure the GitHub Copilot plugin, you need to set the following environment variables:
+To configure the GitHub Copilot plugin, you need to set the following values in the app-config:
 
 - **`copilot.host`**: The host URL for your GitHub Copilot instance (e.g., `github.com` or `github.enterprise.com`).
 - **`copilot.enterprise`**: The name of your GitHub Enterprise instance (e.g., `my-enterprise`).
@@ -75,9 +75,14 @@ These variables are used to configure the plugin and ensure it communicates with
 
 ### GitHub Credentials
 
-**Important:** The GitHub token, necessary for authentication, should be managed within your Backstage integrations configuration. Ensure that your GitHub integration in the Backstage configuration includes the necessary token for the `GithubCredentialsProvider` to function correctly.
+GitHub support different auth methods depending on which API you are using.
 
-### GitHub Token Scopes
+- Enterprise API - [only supports "classic" PAT tokens](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-usage?apiVersion=2022-11-28#get-a-summary-of-copilot-usage-for-enterprise-members)
+- Org Api - [Supports app tokens, "classic", and fine grained PAT tokens](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-usage?apiVersion=2022-11-28#get-a-summary-of-copilot-usage-for-organization-members)
+
+This plugin supports both schemes and detects the best scheme based on which API(s) you have configured for use.
+
+### GitHub Token/App Scopes
 
 To ensure the GitHub Copilot plugin operates correctly within your organization or enterprise, your GitHub access token must include specific scopes. These scopes grant the plugin the necessary permissions to interact with your GitHub organization and manage Copilot usage.
 
@@ -95,10 +100,18 @@ To ensure the GitHub Copilot plugin operates correctly within your organization
 
 #### How to Configure Token Scopes
 
-1. **Generate a Personal Access Token (PAT):**
-   - Navigate to [GitHub Personal Access Tokens](https://github.com/settings/tokens).
-   - Click on **Generate new token**.
-   - Select the scopes according to your needs
+**Generate a Personal Access Token (PAT) (Entperise only supports "classic" PAT tokens)**
+
+- Navigate to [GitHub Personal Access Tokens](https://github.com/settings/tokens).
+- Click on **Generate new token**.
+- Select the scopes according to your needs
+
+**Using a GitHub App**
+
+- Create or reuse an existing GitHub App that you own.
+- Navigate to the app permissions
+- Select the permissions to read the org and manage billing for copilot and save
+- Install and update permissions in your oeg.
 
 ### YAML Configuration Example
 
@@ -115,12 +128,28 @@ copilot:
   enterprise: YOUR_ENTERPRISE_NAME_HERE
   organization: YOUR_ORGANIZATION_NAME_HERE
 
+# Using a PAT
 integrations:
   github:
     - host: YOUR_GITHUB_HOST_HERE
       token: YOUR_GENERATED_TOKEN
+
+# Using a GitHub App
+integrations:
+  github:
+    - host: github.com
+      apps:
+        - appId: YOUR_APP_ID
+          allowedInstallationOwners:
+            - YOUR_ORG_NAME
+          clientId: CLIENT_ID
+          clientSecret: CLIENT_SECRET
+          webhookSecret: WEBHOOK_SECRET
+          privateKey: PRIVATE_KEY
 ```
 
+[You can find more about the integrations config in the official docs](https://backstage.io/docs/integrations/github/locations/)
+
 ### API Documentation
 
 For more details on using the GitHub Copilot and Teams APIs, refer to the following documentation:

package/dist/client/GithubClient.cjs.js

@@ -9,41 +9,47 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
 
 class GithubClient {
-  constructor(props) {
-    this.props = props;
+  constructor(copilotConfig, config) {
+    this.copilotConfig = copilotConfig;
+    this.config = config;
   }
   static async fromConfig(config) {
-    const info = await GithubUtils.getGithubInfo(config);
-    return new GithubClient(info);
+    const info = GithubUtils.getCopilotConfig(config);
+    return new GithubClient(info, config);
+  }
+  async getCredentials() {
+    return await GithubUtils.getGithubCredentials(this.config, this.copilotConfig);
   }
   async fetchEnterpriseCopilotUsage() {
-    const path = `/enterprises/${this.props.enterprise}/copilot/usage`;
+    const path = `/enterprises/${this.copilotConfig.enterprise}/copilot/usage`;
     return this.get(path);
   }
   async fetchEnterpriseTeamCopilotUsage(teamId) {
-    const path = `/enterprises/${this.props.enterprise}/team/${teamId}/copilot/usage`;
+    const path = `/enterprises/${this.copilotConfig.enterprise}/team/${teamId}/copilot/usage`;
     return this.get(path);
   }
   async fetchEnterpriseTeams() {
-    const path = `/enterprises/${this.props.enterprise}/teams`;
+    const path = `/enterprises/${this.copilotConfig.enterprise}/teams`;
     return this.get(path);
   }
   async fetchOrganizationCopilotUsage() {
-    const path = `/orgs/${this.props.organization}/copilot/usage`;
+    const path = `/orgs/${this.copilotConfig.organization}/copilot/usage`;
     return this.get(path);
   }
   async fetchOrganizationTeamCopilotUsage(teamId) {
-    const path = `/orgs/${this.props.organization}/team/${teamId}/copilot/usage`;
+    const path = `/orgs/${this.copilotConfig.organization}/team/${teamId}/copilot/usage`;
     return this.get(path);
   }
   async fetchOrganizationTeams() {
-    const path = `/orgs/${this.props.organization}/teams`;
+    const path = `/orgs/${this.copilotConfig.organization}/teams`;
     return this.get(path);
   }
   async get(path) {
-    const response = await fetch__default.default(`${this.props.apiBaseUrl}${path}`, {
+    const credentials = await this.getCredentials();
+    const headers = path.startsWith("/enterprises") ? credentials.enterprise?.headers : credentials.organization?.headers;
+    const response = await fetch__default.default(`${this.copilotConfig.apiBaseUrl}${path}`, {
       headers: {
-        ...this.props.credentials.headers,
+        ...headers,
         Accept: "application/vnd.github+json",
         "X-GitHub-Api-Version": "2022-11-28"
       }

package/dist/client/GithubClient.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"GithubClient.cjs.js","sources":["../../src/client/GithubClient.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\nimport { ResponseError } from '@backstage/errors';\nimport { Config } from '@backstage/config';\nimport { Metric, TeamInfo } from '@backstage-community/plugin-copilot-common';\nimport fetch from 'node-fetch';\nimport { getGithubInfo, GithubInfo } from '../utils/GithubUtils';\n\ninterface GithubApi {\n  fetchEnterpriseCopilotUsage: () => Promise<Metric[]>;\n  fetchEnterpriseTeamCopilotUsage: (teamId: string) => Promise<Metric[]>;\n  fetchEnterpriseTeams: () => Promise<TeamInfo[]>;\n  fetchOrganizationCopilotUsage: () => Promise<Metric[]>;\n  fetchOrganizationTeamCopilotUsage: (teamId: string) => Promise<Metric[]>;\n  fetchOrganizationTeams: () => Promise<TeamInfo[]>;\n}\n\nexport class GithubClient implements GithubApi {\n  constructor(private readonly props: GithubInfo) {}\n\n  static async fromConfig(config: Config) {\n    const info = await getGithubInfo(config);\n    return new GithubClient(info);\n  }\n\n  async fetchEnterpriseCopilotUsage(): Promise<Metric[]> {\n    const path = `/enterprises/${this.props.enterprise}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchEnterpriseTeamCopilotUsage(teamId: string): Promise<Metric[]> {\n    const path = `/enterprises/${this.props.enterprise}/team/${teamId}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchEnterpriseTeams(): Promise<TeamInfo[]> {\n    const path = `/enterprises/${this.props.enterprise}/teams`;\n    return this.get(path);\n  }\n\n  async fetchOrganizationCopilotUsage(): Promise<Metric[]> {\n    const path = `/orgs/${this.props.organization}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchOrganizationTeamCopilotUsage(teamId: string): Promise<Metric[]> {\n    const path = `/orgs/${this.props.organization}/team/${teamId}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchOrganizationTeams(): Promise<TeamInfo[]> {\n    const path = `/orgs/${this.props.organization}/teams`;\n    return this.get(path);\n  }\n\n  private async get<T>(path: string): Promise<T> {\n    const response = await fetch(`${this.props.apiBaseUrl}${path}`, {\n      headers: {\n        ...this.props.credentials.headers,\n        Accept: 'application/vnd.github+json',\n        'X-GitHub-Api-Version': '2022-11-28',\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n\n    return response.json() as Promise<T>;\n  }\n}\n"],"names":["getGithubInfo","fetch","ResponseError"],"mappings":";;;;;;;;;;AA+BO,MAAM,YAAkC,CAAA;AAAA,EAC7C,YAA6B,KAAmB,EAAA;AAAnB,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAoB,EAEjD,aAAa,WAAW,MAAgB,EAAA;AACtC,IAAM,MAAA,IAAA,GAAO,MAAMA,yBAAA,CAAc,MAAM,CAAA;AACvC,IAAO,OAAA,IAAI,aAAa,IAAI,CAAA;AAAA;AAC9B,EAEA,MAAM,2BAAiD,GAAA;AACrD,IAAA,MAAM,IAAO,GAAA,CAAA,aAAA,EAAgB,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA,cAAA,CAAA;AAClD,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,gCAAgC,MAAmC,EAAA;AACvE,IAAA,MAAM,OAAO,CAAgB,aAAA,EAAA,IAAA,CAAK,KAAM,CAAA,UAAU,SAAS,MAAM,CAAA,cAAA,CAAA;AACjE,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,oBAA4C,GAAA;AAChD,IAAA,MAAM,IAAO,GAAA,CAAA,aAAA,EAAgB,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA,MAAA,CAAA;AAClD,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,6BAAmD,GAAA;AACvD,IAAA,MAAM,IAAO,GAAA,CAAA,MAAA,EAAS,IAAK,CAAA,KAAA,CAAM,YAAY,CAAA,cAAA,CAAA;AAC7C,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,kCAAkC,MAAmC,EAAA;AACzE,IAAA,MAAM,OAAO,CAAS,MAAA,EAAA,IAAA,CAAK,KAAM,CAAA,YAAY,SAAS,MAAM,CAAA,cAAA,CAAA;AAC5D,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,sBAA8C,GAAA;AAClD,IAAA,MAAM,IAAO,GAAA,CAAA,MAAA,EAAS,IAAK,CAAA,KAAA,CAAM,YAAY,CAAA,MAAA,CAAA;AAC7C,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAc,IAAO,IAA0B,EAAA;AAC7C,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAM,CAAA,CAAA,EAAG,KAAK,KAAM,CAAA,UAAU,CAAG,EAAA,IAAI,CAAI,CAAA,EAAA;AAAA,MAC9D,OAAS,EAAA;AAAA,QACP,GAAG,IAAK,CAAA,KAAA,CAAM,WAAY,CAAA,OAAA;AAAA,QAC1B,MAAQ,EAAA,6BAAA;AAAA,QACR,sBAAwB,EAAA;AAAA;AAC1B,KACD,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAGjD,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;;;;"}
+{"version":3,"file":"GithubClient.cjs.js","sources":["../../src/client/GithubClient.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\nimport { ResponseError } from '@backstage/errors';\nimport { Config } from '@backstage/config';\nimport { Metric, TeamInfo } from '@backstage-community/plugin-copilot-common';\nimport fetch from 'node-fetch';\nimport {\n  CopilotConfig,\n  CopilotCredentials,\n  getCopilotConfig,\n  getGithubCredentials,\n} from '../utils/GithubUtils';\n\ninterface GithubApi {\n  fetchEnterpriseCopilotUsage: () => Promise<Metric[]>;\n  fetchEnterpriseTeamCopilotUsage: (teamId: string) => Promise<Metric[]>;\n  fetchEnterpriseTeams: () => Promise<TeamInfo[]>;\n  fetchOrganizationCopilotUsage: () => Promise<Metric[]>;\n  fetchOrganizationTeamCopilotUsage: (teamId: string) => Promise<Metric[]>;\n  fetchOrganizationTeams: () => Promise<TeamInfo[]>;\n}\n\nexport class GithubClient implements GithubApi {\n  constructor(\n    private readonly copilotConfig: CopilotConfig,\n    private readonly config: Config,\n  ) {}\n\n  static async fromConfig(config: Config) {\n    const info = getCopilotConfig(config);\n    return new GithubClient(info, config);\n  }\n\n  private async getCredentials(): Promise<CopilotCredentials> {\n    return await getGithubCredentials(this.config, this.copilotConfig);\n  }\n\n  async fetchEnterpriseCopilotUsage(): Promise<Metric[]> {\n    const path = `/enterprises/${this.copilotConfig.enterprise}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchEnterpriseTeamCopilotUsage(teamId: string): Promise<Metric[]> {\n    const path = `/enterprises/${this.copilotConfig.enterprise}/team/${teamId}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchEnterpriseTeams(): Promise<TeamInfo[]> {\n    const path = `/enterprises/${this.copilotConfig.enterprise}/teams`;\n    return this.get(path);\n  }\n\n  async fetchOrganizationCopilotUsage(): Promise<Metric[]> {\n    const path = `/orgs/${this.copilotConfig.organization}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchOrganizationTeamCopilotUsage(teamId: string): Promise<Metric[]> {\n    const path = `/orgs/${this.copilotConfig.organization}/team/${teamId}/copilot/usage`;\n    return this.get(path);\n  }\n\n  async fetchOrganizationTeams(): Promise<TeamInfo[]> {\n    const path = `/orgs/${this.copilotConfig.organization}/teams`;\n    return this.get(path);\n  }\n\n  private async get<T>(path: string): Promise<T> {\n    const credentials = await this.getCredentials();\n    const headers = path.startsWith('/enterprises')\n      ? credentials.enterprise?.headers\n      : credentials.organization?.headers;\n\n    const response = await fetch(`${this.copilotConfig.apiBaseUrl}${path}`, {\n      headers: {\n        ...headers,\n        Accept: 'application/vnd.github+json',\n        'X-GitHub-Api-Version': '2022-11-28',\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n\n    return response.json() as Promise<T>;\n  }\n}\n"],"names":["getCopilotConfig","getGithubCredentials","fetch","ResponseError"],"mappings":";;;;;;;;;;AAoCO,MAAM,YAAkC,CAAA;AAAA,EAC7C,WAAA,CACmB,eACA,MACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,aAAA,GAAA,aAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA;AAChB,EAEH,aAAa,WAAW,MAAgB,EAAA;AACtC,IAAM,MAAA,IAAA,GAAOA,6BAAiB,MAAM,CAAA;AACpC,IAAO,OAAA,IAAI,YAAa,CAAA,IAAA,EAAM,MAAM,CAAA;AAAA;AACtC,EAEA,MAAc,cAA8C,GAAA;AAC1D,IAAA,OAAO,MAAMC,gCAAA,CAAqB,IAAK,CAAA,MAAA,EAAQ,KAAK,aAAa,CAAA;AAAA;AACnE,EAEA,MAAM,2BAAiD,GAAA;AACrD,IAAA,MAAM,IAAO,GAAA,CAAA,aAAA,EAAgB,IAAK,CAAA,aAAA,CAAc,UAAU,CAAA,cAAA,CAAA;AAC1D,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,gCAAgC,MAAmC,EAAA;AACvE,IAAA,MAAM,OAAO,CAAgB,aAAA,EAAA,IAAA,CAAK,aAAc,CAAA,UAAU,SAAS,MAAM,CAAA,cAAA,CAAA;AACzE,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,oBAA4C,GAAA;AAChD,IAAA,MAAM,IAAO,GAAA,CAAA,aAAA,EAAgB,IAAK,CAAA,aAAA,CAAc,UAAU,CAAA,MAAA,CAAA;AAC1D,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,6BAAmD,GAAA;AACvD,IAAA,MAAM,IAAO,GAAA,CAAA,MAAA,EAAS,IAAK,CAAA,aAAA,CAAc,YAAY,CAAA,cAAA,CAAA;AACrD,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,kCAAkC,MAAmC,EAAA;AACzE,IAAA,MAAM,OAAO,CAAS,MAAA,EAAA,IAAA,CAAK,aAAc,CAAA,YAAY,SAAS,MAAM,CAAA,cAAA,CAAA;AACpE,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAM,sBAA8C,GAAA;AAClD,IAAA,MAAM,IAAO,GAAA,CAAA,MAAA,EAAS,IAAK,CAAA,aAAA,CAAc,YAAY,CAAA,MAAA,CAAA;AACrD,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AACtB,EAEA,MAAc,IAAO,IAA0B,EAAA;AAC7C,IAAM,MAAA,WAAA,GAAc,MAAM,IAAA,CAAK,cAAe,EAAA;AAC9C,IAAM,MAAA,OAAA,GAAU,KAAK,UAAW,CAAA,cAAc,IAC1C,WAAY,CAAA,UAAA,EAAY,OACxB,GAAA,WAAA,CAAY,YAAc,EAAA,OAAA;AAE9B,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAM,CAAA,CAAA,EAAG,KAAK,aAAc,CAAA,UAAU,CAAG,EAAA,IAAI,CAAI,CAAA,EAAA;AAAA,MACtE,OAAS,EAAA;AAAA,QACP,GAAG,OAAA;AAAA,QACH,MAAQ,EAAA,6BAAA;AAAA,QACR,sBAAwB,EAAA;AAAA;AAC1B,KACD,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAGjD,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;;;;"}

package/dist/utils/GithubUtils.cjs.js

@@ -2,33 +2,83 @@
 
 var integration = require('@backstage/integration');
 
-const getGithubInfo = async (config) => {
-  const integrations = integration.ScmIntegrations.fromConfig(config);
+const getCopilotConfig = (config) => {
   const host = config.getString("copilot.host");
   const enterprise = config.getOptionalString("copilot.enterprise");
   const organization = config.getOptionalString("copilot.organization");
-  if (!host) {
-    throw new Error("The host configuration is missing from the config.");
+  const integrations = integration.ScmIntegrations.fromConfig(config);
+  const githubConfig = integrations.github.byHost(host)?.config;
+  if (!githubConfig) {
+    throw new Error(
+      `GitHub configuration for host "${host}" is missing or incomplete. Please check the integretions configuration section.`
+    );
+  }
+  if (enterprise && !githubConfig.token) {
+    throw new Error(
+      `Enterprise API for copilot only works with "classic PAT" tokens. No token is configured for "${host}" in the config.`
+    );
+  }
+  if (organization && !(githubConfig.token || githubConfig.apps)) {
+    throw new Error(
+      `Organization API for copilot works with both classic and fine grained PAT tokens or GitHub apps. No token or app is configured for "${host}" in the config.`
+    );
   }
+  return {
+    host,
+    enterprise,
+    organization,
+    apiBaseUrl: githubConfig.apiBaseUrl ?? "https://api.github.com"
+  };
+};
+const getGithubCredentials = async (config, copilotConfig) => {
+  const integrations = integration.ScmIntegrations.fromConfig(config);
+  const { host, enterprise, organization } = copilotConfig;
   const githubConfig = integrations.github.byHost(host)?.config;
   if (!githubConfig) {
     throw new Error(
       `GitHub configuration for host "${host}" is missing or incomplete.`
     );
   }
-  const apiBaseUrl = githubConfig.apiBaseUrl ?? "https://api.github.com";
   const credentials = {
-    type: "token",
-    headers: { Authorization: `Bearer ${githubConfig.token}` },
-    token: githubConfig.token
-  };
-  return {
-    apiBaseUrl,
-    credentials,
-    enterprise,
-    organization
+    enterprise: void 0,
+    organization: void 0
   };
+  if (enterprise) {
+    if (!githubConfig.token) {
+      throw new Error(
+        `Enterprise API for copilot only works with "classic PAT" tokens. No token is configured for "${host}" in the config.`
+      );
+    } else {
+      credentials.enterprise = {
+        type: "token",
+        headers: { Authorization: `Bearer ${githubConfig.token}` },
+        token: githubConfig.token
+      };
+    }
+  }
+  if (organization) {
+    if (githubConfig.apps) {
+      const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
+      credentials.organization = await githubCredentialsProvider.getCredentials(
+        {
+          url: `https://${host}/${organization}`
+        }
+      );
+    } else if (githubConfig.token) {
+      credentials.organization = {
+        type: "token",
+        headers: { Authorization: `Bearer ${githubConfig.token}` },
+        token: githubConfig.token
+      };
+    } else {
+      throw new Error(
+        `Organization API for copilot works with both classic and fine grained PAT tokens or GitHub apps. No token or app is configured for "${host}" in the config.`
+      );
+    }
+  }
+  return credentials;
 };
 
-exports.getGithubInfo = getGithubInfo;
+exports.getCopilotConfig = getCopilotConfig;
+exports.getGithubCredentials = getGithubCredentials;
 //# sourceMappingURL=GithubUtils.cjs.js.map

package/dist/utils/GithubUtils.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"GithubUtils.cjs.js","sources":["../../src/utils/GithubUtils.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\nimport { Config } from '@backstage/config';\nimport { GithubCredentials, ScmIntegrations } from '@backstage/integration';\n\nexport type GithubInfo = {\n  credentials: GithubCredentials;\n  apiBaseUrl: string;\n  enterprise?: string;\n  organization?: string;\n};\n\nexport const getGithubInfo = async (config: Config): Promise<GithubInfo> => {\n  const integrations = ScmIntegrations.fromConfig(config);\n\n  const host = config.getString('copilot.host');\n  const enterprise = config.getOptionalString('copilot.enterprise');\n  const organization = config.getOptionalString('copilot.organization');\n\n  if (!host) {\n    throw new Error('The host configuration is missing from the config.');\n  }\n\n  const githubConfig = integrations.github.byHost(host)?.config;\n\n  if (!githubConfig) {\n    throw new Error(\n      `GitHub configuration for host \"${host}\" is missing or incomplete.`,\n    );\n  }\n\n  const apiBaseUrl = githubConfig.apiBaseUrl ?? 'https://api.github.com';\n\n  const credentials: GithubCredentials = {\n    type: 'token',\n    headers: { Authorization: `Bearer ${githubConfig.token}` },\n    token: githubConfig.token,\n  };\n\n  return {\n    apiBaseUrl,\n    credentials,\n    enterprise,\n    organization,\n  };\n};\n"],"names":["ScmIntegrations"],"mappings":";;;;AA0Ba,MAAA,aAAA,GAAgB,OAAO,MAAwC,KAAA;AAC1E,EAAM,MAAA,YAAA,GAAeA,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AAEtD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,cAAc,CAAA;AAC5C,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,oBAAoB,CAAA;AAChE,EAAM,MAAA,YAAA,GAAe,MAAO,CAAA,iBAAA,CAAkB,sBAAsB,CAAA;AAEpE,EAAA,IAAI,CAAC,IAAM,EAAA;AACT,IAAM,MAAA,IAAI,MAAM,oDAAoD,CAAA;AAAA;AAGtE,EAAA,MAAM,YAAe,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAG,EAAA,MAAA;AAEvD,EAAA,IAAI,CAAC,YAAc,EAAA;AACjB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,kCAAkC,IAAI,CAAA,2BAAA;AAAA,KACxC;AAAA;AAGF,EAAM,MAAA,UAAA,GAAa,aAAa,UAAc,IAAA,wBAAA;AAE9C,EAAA,MAAM,WAAiC,GAAA;AAAA,IACrC,IAAM,EAAA,OAAA;AAAA,IACN,SAAS,EAAE,aAAA,EAAe,CAAU,OAAA,EAAA,YAAA,CAAa,KAAK,CAAG,CAAA,EAAA;AAAA,IACzD,OAAO,YAAa,CAAA;AAAA,GACtB;AAEA,EAAO,OAAA;AAAA,IACL,UAAA;AAAA,IACA,WAAA;AAAA,IACA,UAAA;AAAA,IACA;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"GithubUtils.cjs.js","sources":["../../src/utils/GithubUtils.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\nimport { Config } from '@backstage/config';\nimport {\n  DefaultGithubCredentialsProvider,\n  GithubCredentials,\n  ScmIntegrations,\n} from '@backstage/integration';\n\nexport type CopilotCredentials = {\n  enterprise?: GithubCredentials;\n  organization?: GithubCredentials;\n};\n\nexport type CopilotConfig = {\n  host: string;\n  enterprise?: string;\n  organization?: string;\n  apiBaseUrl: string;\n};\n\nexport const getCopilotConfig = (config: Config): CopilotConfig => {\n  const host = config.getString('copilot.host');\n  const enterprise = config.getOptionalString('copilot.enterprise');\n  const organization = config.getOptionalString('copilot.organization');\n\n  const integrations = ScmIntegrations.fromConfig(config);\n\n  const githubConfig = integrations.github.byHost(host)?.config;\n\n  if (!githubConfig) {\n    throw new Error(\n      `GitHub configuration for host \"${host}\" is missing or incomplete. Please check the integretions configuration section.`,\n    );\n  }\n\n  if (enterprise && !githubConfig.token) {\n    throw new Error(\n      `Enterprise API for copilot only works with \"classic PAT\" tokens. No token is configured for \"${host}\" in the config.`,\n    );\n  }\n\n  if (organization && !(githubConfig.token || githubConfig.apps)) {\n    throw new Error(\n      `Organization API for copilot works with both classic and fine grained PAT tokens or GitHub apps. No token or app is configured for \"${host}\" in the config.`,\n    );\n  }\n\n  return {\n    host,\n    enterprise,\n    organization,\n    apiBaseUrl: githubConfig.apiBaseUrl ?? 'https://api.github.com',\n  };\n};\n\nexport const getGithubCredentials = async (\n  config: Config,\n  copilotConfig: CopilotConfig,\n): Promise<CopilotCredentials> => {\n  const integrations = ScmIntegrations.fromConfig(config);\n  const { host, enterprise, organization } = copilotConfig;\n\n  const githubConfig = integrations.github.byHost(host)?.config;\n\n  if (!githubConfig) {\n    throw new Error(\n      `GitHub configuration for host \"${host}\" is missing or incomplete.`,\n    );\n  }\n\n  const credentials: CopilotCredentials = {\n    enterprise: undefined,\n    organization: undefined,\n  };\n\n  if (enterprise) {\n    if (!githubConfig.token) {\n      throw new Error(\n        `Enterprise API for copilot only works with \"classic PAT\" tokens. No token is configured for \"${host}\" in the config.`,\n      );\n    } else {\n      credentials.enterprise = {\n        type: 'token',\n        headers: { Authorization: `Bearer ${githubConfig.token}` },\n        token: githubConfig.token,\n      };\n    }\n  }\n\n  if (organization) {\n    if (githubConfig.apps) {\n      const githubCredentialsProvider =\n        DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n\n      credentials.organization = await githubCredentialsProvider.getCredentials(\n        {\n          url: `https://${host}/${organization}`,\n        },\n      );\n    } else if (githubConfig.token) {\n      credentials.organization = {\n        type: 'token',\n        headers: { Authorization: `Bearer ${githubConfig.token}` },\n        token: githubConfig.token,\n      };\n    } else {\n      throw new Error(\n        `Organization API for copilot works with both classic and fine grained PAT tokens or GitHub apps. No token or app is configured for \"${host}\" in the config.`,\n      );\n    }\n  }\n\n  return credentials;\n};\n"],"names":["ScmIntegrations","DefaultGithubCredentialsProvider"],"mappings":";;;;AAmCa,MAAA,gBAAA,GAAmB,CAAC,MAAkC,KAAA;AACjE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,cAAc,CAAA;AAC5C,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,oBAAoB,CAAA;AAChE,EAAM,MAAA,YAAA,GAAe,MAAO,CAAA,iBAAA,CAAkB,sBAAsB,CAAA;AAEpE,EAAM,MAAA,YAAA,GAAeA,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AAEtD,EAAA,MAAM,YAAe,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAG,EAAA,MAAA;AAEvD,EAAA,IAAI,CAAC,YAAc,EAAA;AACjB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,kCAAkC,IAAI,CAAA,gFAAA;AAAA,KACxC;AAAA;AAGF,EAAI,IAAA,UAAA,IAAc,CAAC,YAAA,CAAa,KAAO,EAAA;AACrC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gGAAgG,IAAI,CAAA,gBAAA;AAAA,KACtG;AAAA;AAGF,EAAA,IAAI,YAAgB,IAAA,EAAE,YAAa,CAAA,KAAA,IAAS,aAAa,IAAO,CAAA,EAAA;AAC9D,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uIAAuI,IAAI,CAAA,gBAAA;AAAA,KAC7I;AAAA;AAGF,EAAO,OAAA;AAAA,IACL,IAAA;AAAA,IACA,UAAA;AAAA,IACA,YAAA;AAAA,IACA,UAAA,EAAY,aAAa,UAAc,IAAA;AAAA,GACzC;AACF;AAEa,MAAA,oBAAA,GAAuB,OAClC,MAAA,EACA,aACgC,KAAA;AAChC,EAAM,MAAA,YAAA,GAAeA,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AACtD,EAAA,MAAM,EAAE,IAAA,EAAM,UAAY,EAAA,YAAA,EAAiB,GAAA,aAAA;AAE3C,EAAA,MAAM,YAAe,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAG,EAAA,MAAA;AAEvD,EAAA,IAAI,CAAC,YAAc,EAAA;AACjB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,kCAAkC,IAAI,CAAA,2BAAA;AAAA,KACxC;AAAA;AAGF,EAAA,MAAM,WAAkC,GAAA;AAAA,IACtC,UAAY,EAAA,KAAA,CAAA;AAAA,IACZ,YAAc,EAAA,KAAA;AAAA,GAChB;AAEA,EAAA,IAAI,UAAY,EAAA;AACd,IAAI,IAAA,CAAC,aAAa,KAAO,EAAA;AACvB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,gGAAgG,IAAI,CAAA,gBAAA;AAAA,OACtG;AAAA,KACK,MAAA;AACL,MAAA,WAAA,CAAY,UAAa,GAAA;AAAA,QACvB,IAAM,EAAA,OAAA;AAAA,QACN,SAAS,EAAE,aAAA,EAAe,CAAU,OAAA,EAAA,YAAA,CAAa,KAAK,CAAG,CAAA,EAAA;AAAA,QACzD,OAAO,YAAa,CAAA;AAAA,OACtB;AAAA;AACF;AAGF,EAAA,IAAI,YAAc,EAAA;AAChB,IAAA,IAAI,aAAa,IAAM,EAAA;AACrB,MAAM,MAAA,yBAAA,GACJC,4CAAiC,CAAA,gBAAA,CAAiB,YAAY,CAAA;AAEhE,MAAY,WAAA,CAAA,YAAA,GAAe,MAAM,yBAA0B,CAAA,cAAA;AAAA,QACzD;AAAA,UACE,GAAK,EAAA,CAAA,QAAA,EAAW,IAAI,CAAA,CAAA,EAAI,YAAY,CAAA;AAAA;AACtC,OACF;AAAA,KACF,MAAA,IAAW,aAAa,KAAO,EAAA;AAC7B,MAAA,WAAA,CAAY,YAAe,GAAA;AAAA,QACzB,IAAM,EAAA,OAAA;AAAA,QACN,SAAS,EAAE,aAAA,EAAe,CAAU,OAAA,EAAA,YAAA,CAAa,KAAK,CAAG,CAAA,EAAA;AAAA,QACzD,OAAO,YAAa,CAAA;AAAA,OACtB;AAAA,KACK,MAAA;AACL,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,uIAAuI,IAAI,CAAA,gBAAA;AAAA,OAC7I;AAAA;AACF;AAGF,EAAO,OAAA,WAAA;AACT;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-copilot-backend",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "homepage": "https://backstage.io",
   "license": "Apache-2.0",
   "main": "dist/index.cjs.js",