@backstage/integration 1.10.0 → 1.11.0

package/dist/github/SingleInstanceGithubCredentialsProvider.esm.js

@@ -0,0 +1,222 @@
+import parseGitUrl from 'git-url-parse';
+import { createAppAuth } from '@octokit/auth-app';
+import { Octokit } from '@octokit/rest';
+import { DateTime } from 'luxon';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Cache {
+  constructor() {
+    __publicField(this, "tokenCache", /* @__PURE__ */ new Map());
+    __publicField(this, "isExpired", (date) => DateTime.local() > date);
+  }
+  async getOrCreateToken(owner, repo, supplier) {
+    let existingInstallationData = this.tokenCache.get(owner);
+    if (!existingInstallationData || this.isExpired(existingInstallationData.expiresAt)) {
+      existingInstallationData = await supplier();
+      existingInstallationData.expiresAt = existingInstallationData.expiresAt.minus({ minutes: 10 });
+      this.tokenCache.set(owner, existingInstallationData);
+    }
+    if (!this.appliesToRepo(existingInstallationData, repo)) {
+      throw new Error(
+        `The Backstage GitHub application used in the ${owner} organization does not have access to a repository with the name ${repo}`
+      );
+    }
+    return { accessToken: existingInstallationData.token };
+  }
+  appliesToRepo(tokenData, repo) {
+    if (repo === void 0) {
+      return true;
+    }
+    if (tokenData.repositories !== void 0) {
+      return tokenData.repositories.includes(repo);
+    }
+    return true;
+  }
+}
+const HEADERS = {
+  Accept: "application/vnd.github.machine-man-preview+json"
+};
+class GithubAppManager {
+  // undefined allows all installations
+  constructor(config, baseUrl) {
+    __publicField(this, "appClient");
+    __publicField(this, "baseUrl");
+    __publicField(this, "baseAuthConfig");
+    __publicField(this, "cache", new Cache());
+    __publicField(this, "allowedInstallationOwners");
+    this.allowedInstallationOwners = config.allowedInstallationOwners;
+    this.baseUrl = baseUrl;
+    this.baseAuthConfig = {
+      appId: config.appId,
+      privateKey: config.privateKey.replace(/\\n/gm, "\n")
+    };
+    this.appClient = new Octokit({
+      baseUrl,
+      headers: HEADERS,
+      authStrategy: createAppAuth,
+      auth: this.baseAuthConfig
+    });
+  }
+  async getInstallationCredentials(owner, repo) {
+    var _a;
+    if (this.allowedInstallationOwners) {
+      if (!((_a = this.allowedInstallationOwners) == null ? void 0 : _a.includes(owner))) {
+        return { accessToken: void 0 };
+      }
+    }
+    return this.cache.getOrCreateToken(owner, repo, async () => {
+      var _a2;
+      const { installationId, suspended } = await this.getInstallationData(
+        owner
+      );
+      if (suspended) {
+        throw new Error(`The GitHub application for ${owner} is suspended`);
+      }
+      const result = await this.appClient.apps.createInstallationAccessToken({
+        installation_id: installationId,
+        headers: HEADERS
+      });
+      let repositoryNames;
+      if (result.data.repository_selection === "selected") {
+        const installationClient = new Octokit({
+          baseUrl: this.baseUrl,
+          auth: result.data.token
+        });
+        const repos = await installationClient.paginate(
+          installationClient.apps.listReposAccessibleToInstallation
+        );
+        const repositories = (_a2 = repos.repositories) != null ? _a2 : repos;
+        repositoryNames = repositories.map((repository) => repository.name);
+      }
+      return {
+        token: result.data.token,
+        expiresAt: DateTime.fromISO(result.data.expires_at),
+        repositories: repositoryNames
+      };
+    });
+  }
+  getInstallations() {
+    return this.appClient.paginate(this.appClient.apps.listInstallations);
+  }
+  async getInstallationData(owner) {
+    const allInstallations = await this.getInstallations();
+    const installation = allInstallations.find(
+      (inst) => {
+        var _a;
+        return inst.account && "login" in inst.account && ((_a = inst.account.login) == null ? void 0 : _a.toLocaleLowerCase("en-US")) === owner.toLocaleLowerCase("en-US");
+      }
+    );
+    if (installation) {
+      return {
+        installationId: installation.id,
+        suspended: Boolean(installation.suspended_by)
+      };
+    }
+    const notFoundError = new Error(
+      `No app installation found for ${owner} in ${this.baseAuthConfig.appId}`
+    );
+    notFoundError.name = "NotFoundError";
+    throw notFoundError;
+  }
+}
+class GithubAppCredentialsMux {
+  constructor(config) {
+    __publicField(this, "apps");
+    var _a, _b;
+    this.apps = (_b = (_a = config.apps) == null ? void 0 : _a.map((ac) => new GithubAppManager(ac, config.apiBaseUrl))) != null ? _b : [];
+  }
+  async getAllInstallations() {
+    if (!this.apps.length) {
+      return [];
+    }
+    const installs = await Promise.all(
+      this.apps.map((app) => app.getInstallations())
+    );
+    return installs.flat();
+  }
+  async getAppToken(owner, repo) {
+    if (this.apps.length === 0) {
+      return void 0;
+    }
+    const results = await Promise.all(
+      this.apps.map(
+        (app) => app.getInstallationCredentials(owner, repo).then(
+          (credentials) => ({ credentials, error: void 0 }),
+          (error) => ({ credentials: void 0, error })
+        )
+      )
+    );
+    const result = results.find(
+      (resultItem) => {
+        var _a;
+        return (_a = resultItem.credentials) == null ? void 0 : _a.accessToken;
+      }
+    );
+    if (result) {
+      return result.credentials.accessToken;
+    }
+    const errors = results.map((r) => r.error);
+    const notNotFoundError = errors.find((err) => (err == null ? void 0 : err.name) !== "NotFoundError");
+    if (notNotFoundError) {
+      throw notNotFoundError;
+    }
+    return void 0;
+  }
+}
+const _SingleInstanceGithubCredentialsProvider = class _SingleInstanceGithubCredentialsProvider {
+  constructor(githubAppCredentialsMux, token) {
+    this.githubAppCredentialsMux = githubAppCredentialsMux;
+    this.token = token;
+  }
+  /**
+   * Returns {@link GithubCredentials} for a given URL.
+   *
+   * @remarks
+   *
+   * Consecutive calls to this method with the same URL will return cached
+   * credentials.
+   *
+   * The shortest lifetime for a token returned is 10 minutes.
+   *
+   * @example
+   * ```ts
+   * const { token, headers } = await getCredentials({
+   *   url: 'github.com/backstage/foobar'
+   * })
+   * ```
+   *
+   * @param opts - The organization or repository URL
+   * @returns A promise of {@link GithubCredentials}.
+   */
+  async getCredentials(opts) {
+    const parsed = parseGitUrl(opts.url);
+    const owner = parsed.owner || parsed.name;
+    const repo = parsed.owner ? parsed.name : void 0;
+    let type = "app";
+    let token = await this.githubAppCredentialsMux.getAppToken(owner, repo);
+    if (!token) {
+      type = "token";
+      token = this.token;
+    }
+    return {
+      headers: token ? { Authorization: `Bearer ${token}` } : void 0,
+      token,
+      type
+    };
+  }
+};
+__publicField(_SingleInstanceGithubCredentialsProvider, "create", (config) => {
+  return new _SingleInstanceGithubCredentialsProvider(
+    new GithubAppCredentialsMux(config),
+    config.token
+  );
+});
+let SingleInstanceGithubCredentialsProvider = _SingleInstanceGithubCredentialsProvider;
+
+export { GithubAppCredentialsMux, SingleInstanceGithubCredentialsProvider };
+//# sourceMappingURL=SingleInstanceGithubCredentialsProvider.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SingleInstanceGithubCredentialsProvider.esm.js","sources":["../../src/github/SingleInstanceGithubCredentialsProvider.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 parseGitUrl from 'git-url-parse';\nimport { GithubAppConfig, GithubIntegrationConfig } from './config';\nimport { createAppAuth } from '@octokit/auth-app';\nimport { Octokit, RestEndpointMethodTypes } from '@octokit/rest';\nimport { DateTime } from 'luxon';\nimport {\n  GithubCredentials,\n  GithubCredentialsProvider,\n  GithubCredentialType,\n} from './types';\n\ntype InstallationData = {\n  installationId: number;\n  suspended: boolean;\n};\n\ntype InstallationTokenData = {\n  token: string;\n  expiresAt: DateTime;\n  repositories?: String[];\n};\n\nclass Cache {\n  private readonly tokenCache = new Map<string, InstallationTokenData>();\n\n  async getOrCreateToken(\n    owner: string,\n    repo: string | undefined,\n    supplier: () => Promise<InstallationTokenData>,\n  ): Promise<{ accessToken: string }> {\n    let existingInstallationData = this.tokenCache.get(owner);\n\n    if (\n      !existingInstallationData ||\n      this.isExpired(existingInstallationData.expiresAt)\n    ) {\n      existingInstallationData = await supplier();\n      // Allow 10 minutes grace to account for clock skew\n      existingInstallationData.expiresAt =\n        existingInstallationData.expiresAt.minus({ minutes: 10 });\n      this.tokenCache.set(owner, existingInstallationData);\n    }\n\n    if (!this.appliesToRepo(existingInstallationData, repo)) {\n      throw new Error(\n        `The Backstage GitHub application used in the ${owner} organization does not have access to a repository with the name ${repo}`,\n      );\n    }\n\n    return { accessToken: existingInstallationData.token };\n  }\n\n  private isExpired = (date: DateTime) => DateTime.local() > date;\n\n  private appliesToRepo(tokenData: InstallationTokenData, repo?: string) {\n    // If no specific repo has been requested the token is applicable\n    if (repo === undefined) {\n      return true;\n    }\n    // If the token is restricted to repositories, the token only applies if the repo is in the allow list\n    if (tokenData.repositories !== undefined) {\n      return tokenData.repositories.includes(repo);\n    }\n    // Otherwise the token is applicable\n    return true;\n  }\n}\n\n/**\n * This accept header is required when calling App APIs in GitHub Enterprise.\n * It has no effect on calls to github.com and can probably be removed entirely\n * once GitHub Apps is out of preview.\n */\nconst HEADERS = {\n  Accept: 'application/vnd.github.machine-man-preview+json',\n};\n\n/**\n * GithubAppManager issues and caches tokens for a specific GitHub App.\n */\nclass GithubAppManager {\n  private readonly appClient: Octokit;\n  private readonly baseUrl?: string;\n  private readonly baseAuthConfig: { appId: number; privateKey: string };\n  private readonly cache = new Cache();\n  private readonly allowedInstallationOwners: string[] | undefined; // undefined allows all installations\n\n  constructor(config: GithubAppConfig, baseUrl?: string) {\n    this.allowedInstallationOwners = config.allowedInstallationOwners;\n    this.baseUrl = baseUrl;\n    this.baseAuthConfig = {\n      appId: config.appId,\n      privateKey: config.privateKey.replace(/\\\\n/gm, '\\n'),\n    };\n    this.appClient = new Octokit({\n      baseUrl,\n      headers: HEADERS,\n      authStrategy: createAppAuth,\n      auth: this.baseAuthConfig,\n    });\n  }\n\n  async getInstallationCredentials(\n    owner: string,\n    repo?: string,\n  ): Promise<{ accessToken: string | undefined }> {\n    if (this.allowedInstallationOwners) {\n      if (!this.allowedInstallationOwners?.includes(owner)) {\n        return { accessToken: undefined }; // An empty token allows anonymous access to public repos\n      }\n    }\n\n    // Go and grab an access token for the app scoped to a repository if provided, if not use the organisation installation.\n    return this.cache.getOrCreateToken(owner, repo, async () => {\n      const { installationId, suspended } = await this.getInstallationData(\n        owner,\n      );\n      if (suspended) {\n        throw new Error(`The GitHub application for ${owner} is suspended`);\n      }\n\n      const result = await this.appClient.apps.createInstallationAccessToken({\n        installation_id: installationId,\n        headers: HEADERS,\n      });\n\n      let repositoryNames;\n\n      if (result.data.repository_selection === 'selected') {\n        const installationClient = new Octokit({\n          baseUrl: this.baseUrl,\n          auth: result.data.token,\n        });\n        const repos = await installationClient.paginate(\n          installationClient.apps.listReposAccessibleToInstallation,\n        );\n        // The return type of the paginate method is incorrect.\n        const repositories: RestEndpointMethodTypes['apps']['listReposAccessibleToInstallation']['response']['data']['repositories'] =\n          repos.repositories ?? repos;\n\n        repositoryNames = repositories.map(repository => repository.name);\n      }\n      return {\n        token: result.data.token,\n        expiresAt: DateTime.fromISO(result.data.expires_at),\n        repositories: repositoryNames,\n      };\n    });\n  }\n\n  getInstallations(): Promise<\n    RestEndpointMethodTypes['apps']['listInstallations']['response']['data']\n  > {\n    return this.appClient.paginate(this.appClient.apps.listInstallations);\n  }\n\n  private async getInstallationData(owner: string): Promise<InstallationData> {\n    const allInstallations = await this.getInstallations();\n    const installation = allInstallations.find(\n      inst =>\n        inst.account &&\n        'login' in inst.account &&\n        inst.account.login?.toLocaleLowerCase('en-US') ===\n          owner.toLocaleLowerCase('en-US'),\n    );\n    if (installation) {\n      return {\n        installationId: installation.id,\n        suspended: Boolean(installation.suspended_by),\n      };\n    }\n    const notFoundError = new Error(\n      `No app installation found for ${owner} in ${this.baseAuthConfig.appId}`,\n    );\n    notFoundError.name = 'NotFoundError';\n    throw notFoundError;\n  }\n}\n\n/**\n * Corresponds to a Github installation which internally could hold several GitHub Apps.\n *\n * @public\n */\nexport class GithubAppCredentialsMux {\n  private readonly apps: GithubAppManager[];\n\n  constructor(config: GithubIntegrationConfig) {\n    this.apps =\n      config.apps?.map(ac => new GithubAppManager(ac, config.apiBaseUrl)) ?? [];\n  }\n\n  async getAllInstallations(): Promise<\n    RestEndpointMethodTypes['apps']['listInstallations']['response']['data']\n  > {\n    if (!this.apps.length) {\n      return [];\n    }\n\n    const installs = await Promise.all(\n      this.apps.map(app => app.getInstallations()),\n    );\n\n    return installs.flat();\n  }\n\n  async getAppToken(owner: string, repo?: string): Promise<string | undefined> {\n    if (this.apps.length === 0) {\n      return undefined;\n    }\n\n    const results = await Promise.all(\n      this.apps.map(app =>\n        app.getInstallationCredentials(owner, repo).then(\n          credentials => ({ credentials, error: undefined }),\n          error => ({ credentials: undefined, error }),\n        ),\n      ),\n    );\n\n    const result = results.find(\n      resultItem => resultItem.credentials?.accessToken,\n    );\n    if (result) {\n      return result.credentials!.accessToken;\n    }\n\n    const errors = results.map(r => r.error);\n    const notNotFoundError = errors.find(err => err?.name !== 'NotFoundError');\n    if (notNotFoundError) {\n      throw notNotFoundError;\n    }\n\n    return undefined;\n  }\n}\n\n/**\n * Handles the creation and caching of credentials for GitHub integrations.\n *\n * @public\n * @remarks\n *\n * TODO: Possibly move this to a backend only package so that it's not used in the frontend by mistake\n */\nexport class SingleInstanceGithubCredentialsProvider\n  implements GithubCredentialsProvider\n{\n  static create: (\n    config: GithubIntegrationConfig,\n  ) => GithubCredentialsProvider = config => {\n    return new SingleInstanceGithubCredentialsProvider(\n      new GithubAppCredentialsMux(config),\n      config.token,\n    );\n  };\n\n  private constructor(\n    private readonly githubAppCredentialsMux: GithubAppCredentialsMux,\n    private readonly token?: string,\n  ) {}\n\n  /**\n   * Returns {@link GithubCredentials} for a given URL.\n   *\n   * @remarks\n   *\n   * Consecutive calls to this method with the same URL will return cached\n   * credentials.\n   *\n   * The shortest lifetime for a token returned is 10 minutes.\n   *\n   * @example\n   * ```ts\n   * const { token, headers } = await getCredentials({\n   *   url: 'github.com/backstage/foobar'\n   * })\n   * ```\n   *\n   * @param opts - The organization or repository URL\n   * @returns A promise of {@link GithubCredentials}.\n   */\n  async getCredentials(opts: { url: string }): Promise<GithubCredentials> {\n    const parsed = parseGitUrl(opts.url);\n\n    const owner = parsed.owner || parsed.name;\n    const repo = parsed.owner ? parsed.name : undefined;\n\n    let type: GithubCredentialType = 'app';\n    let token = await this.githubAppCredentialsMux.getAppToken(owner, repo);\n    if (!token) {\n      type = 'token';\n      token = this.token;\n    }\n\n    return {\n      headers: token ? { Authorization: `Bearer ${token}` } : undefined,\n      token,\n      type,\n    };\n  }\n}\n"],"names":["_a"],"mappings":";;;;;;;;;;;AAsCA,MAAM,KAAM,CAAA;AAAA,EAAZ,WAAA,GAAA;AACE,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,sBAAiB,GAAmC,EAAA,CAAA,CAAA;AA6BrE,IAAA,aAAA,CAAA,IAAA,EAAQ,WAAY,EAAA,CAAC,IAAmB,KAAA,QAAA,CAAS,OAAU,GAAA,IAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EA3B3D,MAAM,gBAAA,CACJ,KACA,EAAA,IAAA,EACA,QACkC,EAAA;AAClC,IAAA,IAAI,wBAA2B,GAAA,IAAA,CAAK,UAAW,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAExD,IAAA,IACE,CAAC,wBACD,IAAA,IAAA,CAAK,SAAU,CAAA,wBAAA,CAAyB,SAAS,CACjD,EAAA;AACA,MAAA,wBAAA,GAA2B,MAAM,QAAS,EAAA,CAAA;AAE1C,MAAA,wBAAA,CAAyB,YACvB,wBAAyB,CAAA,SAAA,CAAU,MAAM,EAAE,OAAA,EAAS,IAAI,CAAA,CAAA;AAC1D,MAAK,IAAA,CAAA,UAAA,CAAW,GAAI,CAAA,KAAA,EAAO,wBAAwB,CAAA,CAAA;AAAA,KACrD;AAEA,IAAA,IAAI,CAAC,IAAA,CAAK,aAAc,CAAA,wBAAA,EAA0B,IAAI,CAAG,EAAA;AACvD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,6CAAA,EAAgD,KAAK,CAAA,iEAAA,EAAoE,IAAI,CAAA,CAAA;AAAA,OAC/H,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,EAAE,WAAa,EAAA,wBAAA,CAAyB,KAAM,EAAA,CAAA;AAAA,GACvD;AAAA,EAIQ,aAAA,CAAc,WAAkC,IAAe,EAAA;AAErE,IAAA,IAAI,SAAS,KAAW,CAAA,EAAA;AACtB,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAEA,IAAI,IAAA,SAAA,CAAU,iBAAiB,KAAW,CAAA,EAAA;AACxC,MAAO,OAAA,SAAA,CAAU,YAAa,CAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,KAC7C;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF,CAAA;AAOA,MAAM,OAAU,GAAA;AAAA,EACd,MAAQ,EAAA,iDAAA;AACV,CAAA,CAAA;AAKA,MAAM,gBAAiB,CAAA;AAAA;AAAA,EAOrB,WAAA,CAAY,QAAyB,OAAkB,EAAA;AANvD,IAAiB,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,gBAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,OAAA,EAAQ,IAAI,KAAM,EAAA,CAAA,CAAA;AACnC,IAAiB,aAAA,CAAA,IAAA,EAAA,2BAAA,CAAA,CAAA;AAGf,IAAA,IAAA,CAAK,4BAA4B,MAAO,CAAA,yBAAA,CAAA;AACxC,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AACf,IAAA,IAAA,CAAK,cAAiB,GAAA;AAAA,MACpB,OAAO,MAAO,CAAA,KAAA;AAAA,MACd,UAAY,EAAA,MAAA,CAAO,UAAW,CAAA,OAAA,CAAQ,SAAS,IAAI,CAAA;AAAA,KACrD,CAAA;AACA,IAAK,IAAA,CAAA,SAAA,GAAY,IAAI,OAAQ,CAAA;AAAA,MAC3B,OAAA;AAAA,MACA,OAAS,EAAA,OAAA;AAAA,MACT,YAAc,EAAA,aAAA;AAAA,MACd,MAAM,IAAK,CAAA,cAAA;AAAA,KACZ,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,0BACJ,CAAA,KAAA,EACA,IAC8C,EAAA;AAzHlD,IAAA,IAAA,EAAA,CAAA;AA0HI,IAAA,IAAI,KAAK,yBAA2B,EAAA;AAClC,MAAA,IAAI,EAAC,CAAA,EAAA,GAAA,IAAA,CAAK,yBAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAgC,SAAS,KAAQ,CAAA,CAAA,EAAA;AACpD,QAAO,OAAA,EAAE,aAAa,KAAU,CAAA,EAAA,CAAA;AAAA,OAClC;AAAA,KACF;AAGA,IAAA,OAAO,IAAK,CAAA,KAAA,CAAM,gBAAiB,CAAA,KAAA,EAAO,MAAM,YAAY;AAjIhE,MAAAA,IAAAA,GAAAA,CAAAA;AAkIM,MAAA,MAAM,EAAE,cAAA,EAAgB,SAAU,EAAA,GAAI,MAAM,IAAK,CAAA,mBAAA;AAAA,QAC/C,KAAA;AAAA,OACF,CAAA;AACA,MAAA,IAAI,SAAW,EAAA;AACb,QAAA,MAAM,IAAI,KAAA,CAAM,CAA8B,2BAAA,EAAA,KAAK,CAAe,aAAA,CAAA,CAAA,CAAA;AAAA,OACpE;AAEA,MAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,KAAK,6BAA8B,CAAA;AAAA,QACrE,eAAiB,EAAA,cAAA;AAAA,QACjB,OAAS,EAAA,OAAA;AAAA,OACV,CAAA,CAAA;AAED,MAAI,IAAA,eAAA,CAAA;AAEJ,MAAI,IAAA,MAAA,CAAO,IAAK,CAAA,oBAAA,KAAyB,UAAY,EAAA;AACnD,QAAM,MAAA,kBAAA,GAAqB,IAAI,OAAQ,CAAA;AAAA,UACrC,SAAS,IAAK,CAAA,OAAA;AAAA,UACd,IAAA,EAAM,OAAO,IAAK,CAAA,KAAA;AAAA,SACnB,CAAA,CAAA;AACD,QAAM,MAAA,KAAA,GAAQ,MAAM,kBAAmB,CAAA,QAAA;AAAA,UACrC,mBAAmB,IAAK,CAAA,iCAAA;AAAA,SAC1B,CAAA;AAEA,QAAA,MAAM,YACJA,GAAAA,CAAAA,GAAAA,GAAA,KAAM,CAAA,YAAA,KAAN,OAAAA,GAAsB,GAAA,KAAA,CAAA;AAExB,QAAA,eAAA,GAAkB,YAAa,CAAA,GAAA,CAAI,CAAc,UAAA,KAAA,UAAA,CAAW,IAAI,CAAA,CAAA;AAAA,OAClE;AACA,MAAO,OAAA;AAAA,QACL,KAAA,EAAO,OAAO,IAAK,CAAA,KAAA;AAAA,QACnB,SAAW,EAAA,QAAA,CAAS,OAAQ,CAAA,MAAA,CAAO,KAAK,UAAU,CAAA;AAAA,QAClD,YAAc,EAAA,eAAA;AAAA,OAChB,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,gBAEE,GAAA;AACA,IAAA,OAAO,KAAK,SAAU,CAAA,QAAA,CAAS,IAAK,CAAA,SAAA,CAAU,KAAK,iBAAiB,CAAA,CAAA;AAAA,GACtE;AAAA,EAEA,MAAc,oBAAoB,KAA0C,EAAA;AAC1E,IAAM,MAAA,gBAAA,GAAmB,MAAM,IAAA,CAAK,gBAAiB,EAAA,CAAA;AACrD,IAAA,MAAM,eAAe,gBAAiB,CAAA,IAAA;AAAA,MACpC,CAAK,IAAA,KAAA;AA/KX,QAAA,IAAA,EAAA,CAAA;AAgLQ,QAAA,OAAA,IAAA,CAAK,OACL,IAAA,OAAA,IAAW,IAAK,CAAA,OAAA,IAAA,CAAA,CAChB,EAAK,GAAA,IAAA,CAAA,OAAA,CAAQ,KAAb,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAoB,iBAAkB,CAAA,OAAA,CAAA,MACpC,KAAM,CAAA,iBAAA,CAAkB,OAAO,CAAA,CAAA;AAAA,OAAA;AAAA,KACrC,CAAA;AACA,IAAA,IAAI,YAAc,EAAA;AAChB,MAAO,OAAA;AAAA,QACL,gBAAgB,YAAa,CAAA,EAAA;AAAA,QAC7B,SAAA,EAAW,OAAQ,CAAA,YAAA,CAAa,YAAY,CAAA;AAAA,OAC9C,CAAA;AAAA,KACF;AACA,IAAA,MAAM,gBAAgB,IAAI,KAAA;AAAA,MACxB,CAAiC,8BAAA,EAAA,KAAK,CAAO,IAAA,EAAA,IAAA,CAAK,eAAe,KAAK,CAAA,CAAA;AAAA,KACxE,CAAA;AACA,IAAA,aAAA,CAAc,IAAO,GAAA,eAAA,CAAA;AACrB,IAAM,MAAA,aAAA,CAAA;AAAA,GACR;AACF,CAAA;AAOO,MAAM,uBAAwB,CAAA;AAAA,EAGnC,YAAY,MAAiC,EAAA;AAF7C,IAAiB,aAAA,CAAA,IAAA,EAAA,MAAA,CAAA,CAAA;AAzMnB,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA4MI,IAAA,IAAA,CAAK,IACH,GAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,GAAI,CAAA,CAAA,EAAA,KAAM,IAAI,gBAAA,CAAiB,EAAI,EAAA,MAAA,CAAO,UAAU,CAAA,CAAA,KAAjE,YAAuE,EAAC,CAAA;AAAA,GAC5E;AAAA,EAEA,MAAM,mBAEJ,GAAA;AACA,IAAI,IAAA,CAAC,IAAK,CAAA,IAAA,CAAK,MAAQ,EAAA;AACrB,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAEA,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC7B,KAAK,IAAK,CAAA,GAAA,CAAI,CAAO,GAAA,KAAA,GAAA,CAAI,kBAAkB,CAAA;AAAA,KAC7C,CAAA;AAEA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,WAAY,CAAA,KAAA,EAAe,IAA4C,EAAA;AAC3E,IAAI,IAAA,IAAA,CAAK,IAAK,CAAA,MAAA,KAAW,CAAG,EAAA;AAC1B,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,OAAA,GAAU,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC5B,KAAK,IAAK,CAAA,GAAA;AAAA,QAAI,CACZ,GAAA,KAAA,GAAA,CAAI,0BAA2B,CAAA,KAAA,EAAO,IAAI,CAAE,CAAA,IAAA;AAAA,UAC1C,CAAgB,WAAA,MAAA,EAAE,WAAa,EAAA,KAAA,EAAO,KAAU,CAAA,EAAA,CAAA;AAAA,UAChD,CAAU,KAAA,MAAA,EAAE,WAAa,EAAA,KAAA,CAAA,EAAW,KAAM,EAAA,CAAA;AAAA,SAC5C;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,SAAS,OAAQ,CAAA,IAAA;AAAA,MACrB,CAAW,UAAA,KAAA;AA7OjB,QAAA,IAAA,EAAA,CAAA;AA6OoB,QAAA,OAAA,CAAA,EAAA,GAAA,UAAA,CAAW,gBAAX,IAAwB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,WAAA,CAAA;AAAA,OAAA;AAAA,KACxC,CAAA;AACA,IAAA,IAAI,MAAQ,EAAA;AACV,MAAA,OAAO,OAAO,WAAa,CAAA,WAAA,CAAA;AAAA,KAC7B;AAEA,IAAA,MAAM,MAAS,GAAA,OAAA,CAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,EAAE,KAAK,CAAA,CAAA;AACvC,IAAA,MAAM,mBAAmB,MAAO,CAAA,IAAA,CAAK,CAAO,GAAA,KAAA,CAAA,GAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,GAAA,CAAK,UAAS,eAAe,CAAA,CAAA;AACzE,IAAA,IAAI,gBAAkB,EAAA;AACpB,MAAM,MAAA,gBAAA,CAAA;AAAA,KACR;AAEA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF,CAAA;AAUO,MAAM,wCAAA,GAAN,MAAM,wCAEb,CAAA;AAAA,EAUU,WAAA,CACW,yBACA,KACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,uBAAA,GAAA,uBAAA,CAAA;AACA,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBH,MAAM,eAAe,IAAmD,EAAA;AACtE,IAAM,MAAA,MAAA,GAAS,WAAY,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAEnC,IAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,KAAA,IAAS,MAAO,CAAA,IAAA,CAAA;AACrC,IAAA,MAAM,IAAO,GAAA,MAAA,CAAO,KAAQ,GAAA,MAAA,CAAO,IAAO,GAAA,KAAA,CAAA,CAAA;AAE1C,IAAA,IAAI,IAA6B,GAAA,KAAA,CAAA;AACjC,IAAA,IAAI,QAAQ,MAAM,IAAA,CAAK,uBAAwB,CAAA,WAAA,CAAY,OAAO,IAAI,CAAA,CAAA;AACtE,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAO,IAAA,GAAA,OAAA,CAAA;AACP,MAAA,KAAA,GAAQ,IAAK,CAAA,KAAA,CAAA;AAAA,KACf;AAEA,IAAO,OAAA;AAAA,MACL,SAAS,KAAQ,GAAA,EAAE,eAAe,CAAU,OAAA,EAAA,KAAK,IAAO,GAAA,KAAA,CAAA;AAAA,MACxD,KAAA;AAAA,MACA,IAAA;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA,CAAA;AArDE,aAHW,CAAA,wCAAA,EAGJ,UAE0B,CAAU,MAAA,KAAA;AACzC,EAAA,OAAO,IAAI,wCAAA;AAAA,IACT,IAAI,wBAAwB,MAAM,CAAA;AAAA,IAClC,MAAO,CAAA,KAAA;AAAA,GACT,CAAA;AACF,CAAA,CAAA,CAAA;AAVK,IAAM,uCAAN,GAAA;;;;"}

package/dist/github/config.esm.js

@@ -0,0 +1,53 @@
+import { trimEnd } from 'lodash';
+import { isValidHost } from '../helpers.esm.js';
+
+const GITHUB_HOST = "github.com";
+const GITHUB_API_BASE_URL = "https://api.github.com";
+const GITHUB_RAW_BASE_URL = "https://raw.githubusercontent.com";
+function readGithubIntegrationConfig(config) {
+  var _a, _b, _c;
+  const host = (_a = config.getOptionalString("host")) != null ? _a : GITHUB_HOST;
+  let apiBaseUrl = config.getOptionalString("apiBaseUrl");
+  let rawBaseUrl = config.getOptionalString("rawBaseUrl");
+  const token = (_b = config.getOptionalString("token")) == null ? void 0 : _b.trim();
+  const apps = (_c = config.getOptionalConfigArray("apps")) == null ? void 0 : _c.map((c) => ({
+    appId: c.getNumber("appId"),
+    clientId: c.getString("clientId"),
+    clientSecret: c.getString("clientSecret"),
+    webhookSecret: c.getString("webhookSecret"),
+    privateKey: c.getString("privateKey"),
+    allowedInstallationOwners: c.getOptionalStringArray(
+      "allowedInstallationOwners"
+    )
+  }));
+  if (!isValidHost(host)) {
+    throw new Error(
+      `Invalid GitHub integration config, '${host}' is not a valid host`
+    );
+  }
+  if (apiBaseUrl) {
+    apiBaseUrl = trimEnd(apiBaseUrl, "/");
+  } else if (host === GITHUB_HOST) {
+    apiBaseUrl = GITHUB_API_BASE_URL;
+  }
+  if (rawBaseUrl) {
+    rawBaseUrl = trimEnd(rawBaseUrl, "/");
+  } else if (host === GITHUB_HOST) {
+    rawBaseUrl = GITHUB_RAW_BASE_URL;
+  }
+  return { host, apiBaseUrl, rawBaseUrl, token, apps };
+}
+function readGithubIntegrationConfigs(configs) {
+  const result = configs.map(readGithubIntegrationConfig);
+  if (!result.some((c) => c.host === GITHUB_HOST)) {
+    result.push({
+      host: GITHUB_HOST,
+      apiBaseUrl: GITHUB_API_BASE_URL,
+      rawBaseUrl: GITHUB_RAW_BASE_URL
+    });
+  }
+  return result;
+}
+
+export { readGithubIntegrationConfig, readGithubIntegrationConfigs };
+//# sourceMappingURL=config.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.esm.js","sources":["../../src/github/config.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 { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost } from '../helpers';\n\nconst GITHUB_HOST = 'github.com';\nconst GITHUB_API_BASE_URL = 'https://api.github.com';\nconst GITHUB_RAW_BASE_URL = 'https://raw.githubusercontent.com';\n\n/**\n * The configuration parameters for a single GitHub integration.\n *\n * @public\n */\nexport type GithubIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. \"github.com\"\n   */\n  host: string;\n\n  /**\n   * The base URL of the API of this provider, e.g. \"https://api.github.com\",\n   * with no trailing slash.\n   *\n   * May be omitted specifically for GitHub; then it will be deduced.\n   *\n   * The API will always be preferred if both its base URL and a token are\n   * present.\n   */\n  apiBaseUrl?: string;\n\n  /**\n   * The base URL of the raw fetch endpoint of this provider, e.g.\n   * \"https://raw.githubusercontent.com\", with no trailing slash.\n   *\n   * May be omitted specifically for GitHub; then it will be deduced.\n   *\n   * The API will always be preferred if both its base URL and a token are\n   * present.\n   */\n  rawBaseUrl?: string;\n\n  /**\n   * The authorization token to use for requests to this provider.\n   *\n   * If no token is specified, anonymous access is used.\n   */\n  token?: string;\n\n  /**\n   * The GitHub Apps configuration to use for requests to this provider.\n   *\n   * If no apps are specified, token or anonymous is used.\n   */\n  apps?: GithubAppConfig[];\n};\n\n/**\n * The configuration parameters for authenticating a GitHub Application.\n *\n * @remarks\n *\n * A GitHub Apps configuration can be generated using the `backstage-cli create-github-app` command.\n *\n * @public\n */\nexport type GithubAppConfig = {\n  /**\n   * Unique app identifier, found at https://github.com/organizations/$org/settings/apps/$AppName\n   */\n  appId: number;\n  /**\n   * The private key is used by the GitHub App integration to authenticate the app.\n   * A private key can be generated from the app at https://github.com/organizations/$org/settings/apps/$AppName\n   */\n  privateKey: string;\n  /**\n   * Webhook secret can be configured at https://github.com/organizations/$org/settings/apps/$AppName\n   */\n  webhookSecret: string;\n  /**\n   * Found at https://github.com/organizations/$org/settings/apps/$AppName\n   */\n  clientId: string;\n  /**\n   * Client secrets can be generated at https://github.com/organizations/$org/settings/apps/$AppName\n   */\n  clientSecret: string;\n  /**\n   * List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations.\n   * However you can list the installations with the GitHub API. You can find the list of installations here:\n   * https://api.github.com/app/installations\n   * The relevant documentation for this is here.\n   * https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples\n   */\n  allowedInstallationOwners?: string[];\n};\n\n/**\n * Reads a single GitHub integration config.\n *\n * @param config - The config object of a single integration\n * @public\n */\nexport function readGithubIntegrationConfig(\n  config: Config,\n): GithubIntegrationConfig {\n  const host = config.getOptionalString('host') ?? GITHUB_HOST;\n  let apiBaseUrl = config.getOptionalString('apiBaseUrl');\n  let rawBaseUrl = config.getOptionalString('rawBaseUrl');\n  const token = config.getOptionalString('token')?.trim();\n  const apps = config.getOptionalConfigArray('apps')?.map(c => ({\n    appId: c.getNumber('appId'),\n    clientId: c.getString('clientId'),\n    clientSecret: c.getString('clientSecret'),\n    webhookSecret: c.getString('webhookSecret'),\n    privateKey: c.getString('privateKey'),\n    allowedInstallationOwners: c.getOptionalStringArray(\n      'allowedInstallationOwners',\n    ),\n  }));\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid GitHub integration config, '${host}' is not a valid host`,\n    );\n  }\n\n  if (apiBaseUrl) {\n    apiBaseUrl = trimEnd(apiBaseUrl, '/');\n  } else if (host === GITHUB_HOST) {\n    apiBaseUrl = GITHUB_API_BASE_URL;\n  }\n\n  if (rawBaseUrl) {\n    rawBaseUrl = trimEnd(rawBaseUrl, '/');\n  } else if (host === GITHUB_HOST) {\n    rawBaseUrl = GITHUB_RAW_BASE_URL;\n  }\n\n  return { host, apiBaseUrl, rawBaseUrl, token, apps };\n}\n\n/**\n * Reads a set of GitHub integration configs, and inserts some defaults for\n * public GitHub if not specified.\n *\n * @param configs - All of the integration config objects\n * @public\n */\nexport function readGithubIntegrationConfigs(\n  configs: Config[],\n): GithubIntegrationConfig[] {\n  // First read all the explicit integrations\n  const result = configs.map(readGithubIntegrationConfig);\n\n  // If no explicit github.com integration was added, put one in the list as\n  // a convenience\n  if (!result.some(c => c.host === GITHUB_HOST)) {\n    result.push({\n      host: GITHUB_HOST,\n      apiBaseUrl: GITHUB_API_BASE_URL,\n      rawBaseUrl: GITHUB_RAW_BASE_URL,\n    });\n  }\n\n  return result;\n}\n"],"names":[],"mappings":";;;AAoBA,MAAM,WAAc,GAAA,YAAA,CAAA;AACpB,MAAM,mBAAsB,GAAA,wBAAA,CAAA;AAC5B,MAAM,mBAAsB,GAAA,mCAAA,CAAA;AAiGrB,SAAS,4BACd,MACyB,EAAA;AAzH3B,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA0HE,EAAA,MAAM,IAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,MAAM,MAA/B,IAAoC,GAAA,EAAA,GAAA,WAAA,CAAA;AACjD,EAAI,IAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,YAAY,CAAA,CAAA;AACtD,EAAI,IAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,YAAY,CAAA,CAAA;AACtD,EAAA,MAAM,KAAQ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,MAAhC,IAAmC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,EAAA,CAAA;AACjD,EAAA,MAAM,QAAO,EAAO,GAAA,MAAA,CAAA,sBAAA,CAAuB,MAAM,CAApC,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAuC,IAAI,CAAM,CAAA,MAAA;AAAA,IAC5D,KAAA,EAAO,CAAE,CAAA,SAAA,CAAU,OAAO,CAAA;AAAA,IAC1B,QAAA,EAAU,CAAE,CAAA,SAAA,CAAU,UAAU,CAAA;AAAA,IAChC,YAAA,EAAc,CAAE,CAAA,SAAA,CAAU,cAAc,CAAA;AAAA,IACxC,aAAA,EAAe,CAAE,CAAA,SAAA,CAAU,eAAe,CAAA;AAAA,IAC1C,UAAA,EAAY,CAAE,CAAA,SAAA,CAAU,YAAY,CAAA;AAAA,IACpC,2BAA2B,CAAE,CAAA,sBAAA;AAAA,MAC3B,2BAAA;AAAA,KACF;AAAA,GACF,CAAA,CAAA,CAAA;AAEA,EAAI,IAAA,CAAC,WAAY,CAAA,IAAI,CAAG,EAAA;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA,CAAA;AAAA,KAC7C,CAAA;AAAA,GACF;AAEA,EAAA,IAAI,UAAY,EAAA;AACd,IAAa,UAAA,GAAA,OAAA,CAAQ,YAAY,GAAG,CAAA,CAAA;AAAA,GACtC,MAAA,IAAW,SAAS,WAAa,EAAA;AAC/B,IAAa,UAAA,GAAA,mBAAA,CAAA;AAAA,GACf;AAEA,EAAA,IAAI,UAAY,EAAA;AACd,IAAa,UAAA,GAAA,OAAA,CAAQ,YAAY,GAAG,CAAA,CAAA;AAAA,GACtC,MAAA,IAAW,SAAS,WAAa,EAAA;AAC/B,IAAa,UAAA,GAAA,mBAAA,CAAA;AAAA,GACf;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,UAAA,EAAY,OAAO,IAAK,EAAA,CAAA;AACrD,CAAA;AASO,SAAS,6BACd,OAC2B,EAAA;AAE3B,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,GAAA,CAAI,2BAA2B,CAAA,CAAA;AAItD,EAAA,IAAI,CAAC,MAAO,CAAA,IAAA,CAAK,OAAK,CAAE,CAAA,IAAA,KAAS,WAAW,CAAG,EAAA;AAC7C,IAAA,MAAA,CAAO,IAAK,CAAA;AAAA,MACV,IAAM,EAAA,WAAA;AAAA,MACN,UAAY,EAAA,mBAAA;AAAA,MACZ,UAAY,EAAA,mBAAA;AAAA,KACb,CAAA,CAAA;AAAA,GACH;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/dist/github/core.esm.js

@@ -0,0 +1,38 @@
+import parseGitUrl from 'git-url-parse';
+
+function getGithubFileFetchUrl(url, config, credentials) {
+  try {
+    const { owner, name, ref, filepathtype, filepath } = parseGitUrl(url);
+    if (!owner || !name || !ref || // GitHub is automatically redirecting tree urls to blob urls so it's
+    // fine to pass a tree url.
+    filepathtype !== "blob" && filepathtype !== "raw" && filepathtype !== "tree") {
+      throw new Error("Invalid GitHub URL or file path");
+    }
+    const pathWithoutSlash = filepath.replace(/^\//, "");
+    if (chooseEndpoint(config, credentials) === "api") {
+      return `${config.apiBaseUrl}/repos/${owner}/${name}/contents/${pathWithoutSlash}?ref=${ref}`;
+    }
+    return `${config.rawBaseUrl}/${owner}/${name}/${ref}/${pathWithoutSlash}`;
+  } catch (e) {
+    throw new Error(`Incorrect URL: ${url}, ${e}`);
+  }
+}
+function getGitHubRequestOptions(config, credentials) {
+  const headers = {};
+  if (chooseEndpoint(config, credentials) === "api") {
+    headers.Accept = "application/vnd.github.v3.raw";
+  }
+  if (credentials.token) {
+    headers.Authorization = `token ${credentials.token}`;
+  }
+  return { headers };
+}
+function chooseEndpoint(config, credentials) {
+  if (config.apiBaseUrl && (credentials.token || !config.rawBaseUrl)) {
+    return "api";
+  }
+  return "raw";
+}
+
+export { chooseEndpoint, getGitHubRequestOptions, getGithubFileFetchUrl };
+//# sourceMappingURL=core.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"core.esm.js","sources":["../../src/github/core.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport parseGitUrl from 'git-url-parse';\nimport { GithubIntegrationConfig } from './config';\nimport { GithubCredentials } from './types';\n\n/**\n * Given a URL pointing to a file on a provider, returns a URL that is suitable\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://github.com/a/b/blob/branchname/path/to/c.yaml\n * to:   https://api.github.com/repos/a/b/contents/path/to/c.yaml?ref=branchname\n * or:   https://raw.githubusercontent.com/a/b/branchname/c.yaml\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @public\n */\nexport function getGithubFileFetchUrl(\n  url: string,\n  config: GithubIntegrationConfig,\n  credentials: GithubCredentials,\n): string {\n  try {\n    const { owner, name, ref, filepathtype, filepath } = parseGitUrl(url);\n    if (\n      !owner ||\n      !name ||\n      !ref ||\n      // GitHub is automatically redirecting tree urls to blob urls so it's\n      // fine to pass a tree url.\n      (filepathtype !== 'blob' &&\n        filepathtype !== 'raw' &&\n        filepathtype !== 'tree')\n    ) {\n      throw new Error('Invalid GitHub URL or file path');\n    }\n\n    const pathWithoutSlash = filepath.replace(/^\\//, '');\n    if (chooseEndpoint(config, credentials) === 'api') {\n      return `${config.apiBaseUrl}/repos/${owner}/${name}/contents/${pathWithoutSlash}?ref=${ref}`;\n    }\n    return `${config.rawBaseUrl}/${owner}/${name}/${ref}/${pathWithoutSlash}`;\n  } catch (e) {\n    throw new Error(`Incorrect URL: ${url}, ${e}`);\n  }\n}\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @deprecated This function is no longer used internally\n * @param config - The relevant provider config\n * @public\n */\nexport function getGitHubRequestOptions(\n  config: GithubIntegrationConfig,\n  credentials: GithubCredentials,\n): { headers: Record<string, string> } {\n  const headers: Record<string, string> = {};\n\n  if (chooseEndpoint(config, credentials) === 'api') {\n    headers.Accept = 'application/vnd.github.v3.raw';\n  }\n\n  if (credentials.token) {\n    headers.Authorization = `token ${credentials.token}`;\n  }\n\n  return { headers };\n}\n\nexport function chooseEndpoint(\n  config: GithubIntegrationConfig,\n  credentials: GithubCredentials,\n): 'api' | 'raw' {\n  if (config.apiBaseUrl && (credentials.token || !config.rawBaseUrl)) {\n    return 'api';\n  }\n  return 'raw';\n}\n"],"names":[],"mappings":";;AAmCgB,SAAA,qBAAA,CACd,GACA,EAAA,MAAA,EACA,WACQ,EAAA;AACR,EAAI,IAAA;AACF,IAAM,MAAA,EAAE,OAAO,IAAM,EAAA,GAAA,EAAK,cAAc,QAAS,EAAA,GAAI,YAAY,GAAG,CAAA,CAAA;AACpE,IAAA,IACE,CAAC,KAAA,IACD,CAAC,IAAA,IACD,CAAC,GAAA;AAAA;AAAA,IAGA,YAAiB,KAAA,MAAA,IAChB,YAAiB,KAAA,KAAA,IACjB,iBAAiB,MACnB,EAAA;AACA,MAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA,CAAA;AAAA,KACnD;AAEA,IAAA,MAAM,gBAAmB,GAAA,QAAA,CAAS,OAAQ,CAAA,KAAA,EAAO,EAAE,CAAA,CAAA;AACnD,IAAA,IAAI,cAAe,CAAA,MAAA,EAAQ,WAAW,CAAA,KAAM,KAAO,EAAA;AACjD,MAAO,OAAA,CAAA,EAAG,MAAO,CAAA,UAAU,CAAU,OAAA,EAAA,KAAK,IAAI,IAAI,CAAA,UAAA,EAAa,gBAAgB,CAAA,KAAA,EAAQ,GAAG,CAAA,CAAA,CAAA;AAAA,KAC5F;AACA,IAAO,OAAA,CAAA,EAAG,MAAO,CAAA,UAAU,CAAI,CAAA,EAAA,KAAK,IAAI,IAAI,CAAA,CAAA,EAAI,GAAG,CAAA,CAAA,EAAI,gBAAgB,CAAA,CAAA,CAAA;AAAA,WAChE,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,KAAM,CAAA,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAE,CAAA,CAAA,CAAA;AAAA,GAC/C;AACF,CAAA;AASgB,SAAA,uBAAA,CACd,QACA,WACqC,EAAA;AACrC,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAA,IAAI,cAAe,CAAA,MAAA,EAAQ,WAAW,CAAA,KAAM,KAAO,EAAA;AACjD,IAAA,OAAA,CAAQ,MAAS,GAAA,+BAAA,CAAA;AAAA,GACnB;AAEA,EAAA,IAAI,YAAY,KAAO,EAAA;AACrB,IAAQ,OAAA,CAAA,aAAA,GAAgB,CAAS,MAAA,EAAA,WAAA,CAAY,KAAK,CAAA,CAAA,CAAA;AAAA,GACpD;AAEA,EAAA,OAAO,EAAE,OAAQ,EAAA,CAAA;AACnB,CAAA;AAEgB,SAAA,cAAA,CACd,QACA,WACe,EAAA;AACf,EAAA,IAAI,OAAO,UAAe,KAAA,WAAA,CAAY,KAAS,IAAA,CAAC,OAAO,UAAa,CAAA,EAAA;AAClE,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AACA,EAAO,OAAA,KAAA,CAAA;AACT;;;;"}

package/dist/github/deprecated.esm.js

@@ -0,0 +1,26 @@
+import { readGithubIntegrationConfig, readGithubIntegrationConfigs } from './config.esm.js';
+import { getGithubFileFetchUrl } from './core.esm.js';
+import { GithubIntegration, replaceGithubUrlType } from './GithubIntegration.esm.js';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+const getGitHubFileFetchUrl = getGithubFileFetchUrl;
+class GitHubIntegration extends GithubIntegration {
+  constructor(integrationConfig) {
+    super(integrationConfig);
+  }
+  get config() {
+    return super.config;
+  }
+}
+__publicField(GitHubIntegration, "factory", GithubIntegration.factory);
+const readGitHubIntegrationConfig = readGithubIntegrationConfig;
+const readGitHubIntegrationConfigs = readGithubIntegrationConfigs;
+const replaceGitHubUrlType = replaceGithubUrlType;
+
+export { GitHubIntegration, getGitHubFileFetchUrl, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, replaceGitHubUrlType };
+//# sourceMappingURL=deprecated.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.esm.js","sources":["../../src/github/deprecated.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubIntegrationConfig,\n  readGithubIntegrationConfig,\n  readGithubIntegrationConfigs,\n} from './config';\nimport { getGithubFileFetchUrl } from './core';\nimport { GithubIntegration, replaceGithubUrlType } from './GithubIntegration';\nimport { ScmIntegrationsFactory } from '../types';\n\n/**\n * @public\n * @deprecated Use {@link getGithubFileFetchUrl} instead.\n */\nexport const getGitHubFileFetchUrl = getGithubFileFetchUrl;\n\n/**\n * @public\n * @deprecated Use {@link GithubIntegrationConfig} instead.\n */\nexport type GitHubIntegrationConfig = GithubIntegrationConfig;\n\n/**\n * @public\n * @deprecated Use {@link GithubIntegration} instead.\n */\nexport class GitHubIntegration extends GithubIntegration {\n  static factory: ScmIntegrationsFactory<GitHubIntegration> =\n    GithubIntegration.factory;\n\n  constructor(integrationConfig: GitHubIntegrationConfig) {\n    super(integrationConfig as GithubIntegrationConfig);\n  }\n\n  get config(): GitHubIntegrationConfig {\n    return super.config as GitHubIntegrationConfig;\n  }\n}\n\n/**\n * @public\n * @deprecated Use {@link readGithubIntegrationConfig} instead.\n */\nexport const readGitHubIntegrationConfig = readGithubIntegrationConfig;\n\n/**\n * @public\n * @deprecated Use {@link readGithubIntegrationConfigs} instead.\n */\nexport const readGitHubIntegrationConfigs = readGithubIntegrationConfigs;\n\n/**\n * @public\n * @deprecated Use {@link replaceGithubUrlType} instead.\n */\nexport const replaceGitHubUrlType = replaceGithubUrlType;\n"],"names":[],"mappings":";;;;;;;;;;AA6BO,MAAM,qBAAwB,GAAA,sBAAA;AAY9B,MAAM,0BAA0B,iBAAkB,CAAA;AAAA,EAIvD,YAAY,iBAA4C,EAAA;AACtD,IAAA,KAAA,CAAM,iBAA4C,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,IAAI,MAAkC,GAAA;AACpC,IAAA,OAAO,KAAM,CAAA,MAAA,CAAA;AAAA,GACf;AACF,CAAA;AAVE,aADW,CAAA,iBAAA,EACJ,WACL,iBAAkB,CAAA,OAAA,CAAA,CAAA;AAef,MAAM,2BAA8B,GAAA,4BAAA;AAMpC,MAAM,4BAA+B,GAAA,6BAAA;AAMrC,MAAM,oBAAuB,GAAA;;;;"}

package/dist/gitlab/DefaultGitlabCredentialsProvider.esm.js

@@ -0,0 +1,28 @@
+import { SingleInstanceGitlabCredentialsProvider } from './SingleInstanceGitlabCredentialsProvider.esm.js';
+
+class DefaultGitlabCredentialsProvider {
+  constructor(providers) {
+    this.providers = providers;
+  }
+  static fromIntegrations(integrations) {
+    const credentialsProviders = /* @__PURE__ */ new Map();
+    integrations.gitlab.list().forEach((integration) => {
+      const credentialsProvider = SingleInstanceGitlabCredentialsProvider.create(integration.config);
+      credentialsProviders.set(integration.config.host, credentialsProvider);
+    });
+    return new DefaultGitlabCredentialsProvider(credentialsProviders);
+  }
+  async getCredentials(opts) {
+    const parsed = new URL(opts.url);
+    const provider = this.providers.get(parsed.host);
+    if (!provider) {
+      throw new Error(
+        `There is no GitLab integration that matches ${opts.url}. Please add a configuration for an integration.`
+      );
+    }
+    return provider.getCredentials(opts);
+  }
+}
+
+export { DefaultGitlabCredentialsProvider };
+//# sourceMappingURL=DefaultGitlabCredentialsProvider.esm.js.map

package/dist/gitlab/DefaultGitlabCredentialsProvider.esm.js.map

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

package/dist/gitlab/GitLabIntegration.esm.js

@@ -0,0 +1,46 @@
+import { basicIntegrations, defaultScmResolveUrl } from '../helpers.esm.js';
+import { readGitLabIntegrationConfigs } from './config.esm.js';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+const _GitLabIntegration = class _GitLabIntegration {
+  constructor(integrationConfig) {
+    this.integrationConfig = integrationConfig;
+  }
+  get type() {
+    return "gitlab";
+  }
+  get title() {
+    return this.integrationConfig.host;
+  }
+  get config() {
+    return this.integrationConfig;
+  }
+  resolveUrl(options) {
+    return defaultScmResolveUrl(options);
+  }
+  resolveEditUrl(url) {
+    return replaceGitLabUrlType(url, "edit");
+  }
+};
+__publicField(_GitLabIntegration, "factory", ({ config }) => {
+  var _a;
+  const configs = readGitLabIntegrationConfigs(
+    (_a = config.getOptionalConfigArray("integrations.gitlab")) != null ? _a : []
+  );
+  return basicIntegrations(
+    configs.map((c) => new _GitLabIntegration(c)),
+    (i) => i.config.host
+  );
+});
+let GitLabIntegration = _GitLabIntegration;
+function replaceGitLabUrlType(url, type) {
+  return url.replace(/\/\-\/(blob|tree|edit)\//, `/-/${type}/`);
+}
+
+export { GitLabIntegration, replaceGitLabUrlType };
+//# sourceMappingURL=GitLabIntegration.esm.js.map

package/dist/gitlab/GitLabIntegration.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GitLabIntegration.esm.js","sources":["../../src/gitlab/GitLabIntegration.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { basicIntegrations, defaultScmResolveUrl } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n  GitLabIntegrationConfig,\n  readGitLabIntegrationConfigs,\n} from './config';\n\n/**\n * A GitLab based integration.\n *\n * @public\n */\nexport class GitLabIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GitLabIntegration> = ({ config }) => {\n    const configs = readGitLabIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.gitlab') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GitLabIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  constructor(private readonly integrationConfig: GitLabIntegrationConfig) {}\n\n  get type(): string {\n    return 'gitlab';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GitLabIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    return defaultScmResolveUrl(options);\n  }\n\n  resolveEditUrl(url: string): string {\n    return replaceGitLabUrlType(url, 'edit');\n  }\n}\n\n/**\n * Takes a GitLab URL and replaces the type part (blob, tree etc).\n *\n * @param url - The original URL\n * @param type - The desired type, e.g. 'blob', 'tree', 'edit'\n * @public\n */\nexport function replaceGitLabUrlType(\n  url: string,\n  type: 'blob' | 'tree' | 'edit',\n): string {\n  return url.replace(/\\/\\-\\/(blob|tree|edit)\\//, `/-/${type}/`);\n}\n"],"names":[],"mappings":";;;;;;;;;AA4BO,MAAM,kBAAA,GAAN,MAAM,kBAA4C,CAAA;AAAA,EAWvD,YAA6B,iBAA4C,EAAA;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA,CAAA;AAAA,GAA6C;AAAA,EAE1E,IAAI,IAAe,GAAA;AACjB,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA,EAEA,IAAI,KAAgB,GAAA;AAClB,IAAA,OAAO,KAAK,iBAAkB,CAAA,IAAA,CAAA;AAAA,GAChC;AAAA,EAEA,IAAI,MAAkC,GAAA;AACpC,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AAAA,EAEA,WAAW,OAIA,EAAA;AACT,IAAA,OAAO,qBAAqB,OAAO,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,eAAe,GAAqB,EAAA;AAClC,IAAO,OAAA,oBAAA,CAAqB,KAAK,MAAM,CAAA,CAAA;AAAA,GACzC;AACF,CAAA,CAAA;AAnCE,aAAA,CADW,kBACJ,EAAA,SAAA,EAAqD,CAAC,EAAE,QAAa,KAAA;AA7B9E,EAAA,IAAA,EAAA,CAAA;AA8BI,EAAA,MAAM,OAAU,GAAA,4BAAA;AAAA,IAAA,CACd,EAAO,GAAA,MAAA,CAAA,sBAAA,CAAuB,qBAAqB,CAAA,KAAnD,YAAwD,EAAC;AAAA,GAC3D,CAAA;AACA,EAAO,OAAA,iBAAA;AAAA,IACL,QAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,IAAI,kBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,IACzC,CAAA,CAAA,KAAK,EAAE,MAAO,CAAA,IAAA;AAAA,GAChB,CAAA;AACF,CAAA,CAAA,CAAA;AATK,IAAM,iBAAN,GAAA,mBAAA;AA6CS,SAAA,oBAAA,CACd,KACA,IACQ,EAAA;AACR,EAAA,OAAO,GAAI,CAAA,OAAA,CAAQ,0BAA4B,EAAA,CAAA,GAAA,EAAM,IAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAC9D;;;;"}

package/dist/gitlab/SingleInstanceGitlabCredentialsProvider.esm.js

@@ -0,0 +1,29 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, key + "" , value);
+  return value;
+};
+const _SingleInstanceGitlabCredentialsProvider = class _SingleInstanceGitlabCredentialsProvider {
+  constructor(token) {
+    this.token = token;
+  }
+  async getCredentials(_opts) {
+    if (!this.token) {
+      return {};
+    }
+    return {
+      headers: {
+        Authorization: `Bearer ${this.token}`
+      },
+      token: this.token
+    };
+  }
+};
+__publicField(_SingleInstanceGitlabCredentialsProvider, "create", (config) => {
+  return new _SingleInstanceGitlabCredentialsProvider(config.token);
+});
+let SingleInstanceGitlabCredentialsProvider = _SingleInstanceGitlabCredentialsProvider;
+
+export { SingleInstanceGitlabCredentialsProvider };
+//# sourceMappingURL=SingleInstanceGitlabCredentialsProvider.esm.js.map

package/dist/gitlab/SingleInstanceGitlabCredentialsProvider.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SingleInstanceGitlabCredentialsProvider.esm.js","sources":["../../src/gitlab/SingleInstanceGitlabCredentialsProvider.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { GitLabIntegrationConfig } from './config';\nimport { GitlabCredentials, GitlabCredentialsProvider } from './types';\n\nexport class SingleInstanceGitlabCredentialsProvider\n  implements GitlabCredentialsProvider\n{\n  static create: (\n    config: GitLabIntegrationConfig,\n  ) => GitlabCredentialsProvider = config => {\n    return new SingleInstanceGitlabCredentialsProvider(config.token);\n  };\n\n  private constructor(private readonly token?: string) {}\n\n  async getCredentials(_opts: { url: string }): Promise<GitlabCredentials> {\n    if (!this.token) {\n      return {};\n    }\n\n    return {\n      headers: {\n        Authorization: `Bearer ${this.token}`,\n      },\n      token: this.token,\n    };\n  }\n}\n"],"names":[],"mappings":";;;;;;AAmBO,MAAM,wCAAA,GAAN,MAAM,wCAEb,CAAA;AAAA,EAOU,YAA6B,KAAgB,EAAA;AAAhB,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA,CAAA;AAAA,GAAiB;AAAA,EAEtD,MAAM,eAAe,KAAoD,EAAA;AACvE,IAAI,IAAA,CAAC,KAAK,KAAO,EAAA;AACf,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAEA,IAAO,OAAA;AAAA,MACL,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,CAAU,OAAA,EAAA,IAAA,CAAK,KAAK,CAAA,CAAA;AAAA,OACrC;AAAA,MACA,OAAO,IAAK,CAAA,KAAA;AAAA,KACd,CAAA;AAAA,GACF;AACF,CAAA,CAAA;AApBE,aAHW,CAAA,wCAAA,EAGJ,UAE0B,CAAU,MAAA,KAAA;AACzC,EAAO,OAAA,IAAI,wCAAwC,CAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AACjE,CAAA,CAAA,CAAA;AAPK,IAAM,uCAAN,GAAA;;;;"}

package/dist/gitlab/config.esm.js

@@ -0,0 +1,57 @@
+import { trimEnd } from 'lodash';
+import { isValidHost, isValidUrl } from '../helpers.esm.js';
+
+const GITLAB_HOST = "gitlab.com";
+const GITLAB_API_BASE_URL = "https://gitlab.com/api/v4";
+function readGitLabIntegrationConfig(config) {
+  var _a;
+  const host = config.getString("host");
+  let apiBaseUrl = config.getOptionalString("apiBaseUrl");
+  const token = (_a = config.getOptionalString("token")) == null ? void 0 : _a.trim();
+  let baseUrl = config.getOptionalString("baseUrl");
+  if (apiBaseUrl) {
+    apiBaseUrl = trimEnd(apiBaseUrl, "/");
+  } else if (host === GITLAB_HOST) {
+    apiBaseUrl = GITLAB_API_BASE_URL;
+  }
+  if (baseUrl) {
+    baseUrl = trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  if (!isValidHost(host)) {
+    throw new Error(
+      `Invalid GitLab integration config, '${host}' is not a valid host`
+    );
+  } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {
+    throw new Error(
+      `Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`
+    );
+  } else if (!isValidUrl(baseUrl)) {
+    throw new Error(
+      `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`
+    );
+  }
+  return { host, token, apiBaseUrl, baseUrl };
+}
+function readGitLabIntegrationConfigs(configs) {
+  const result = configs.map(readGitLabIntegrationConfig);
+  if (!result.some((c) => c.host === GITLAB_HOST)) {
+    result.push({
+      host: GITLAB_HOST,
+      apiBaseUrl: GITLAB_API_BASE_URL,
+      baseUrl: `https://${GITLAB_HOST}`
+    });
+  }
+  return result;
+}
+function getGitLabIntegrationRelativePath(config) {
+  let relativePath = "";
+  if (config.host !== GITLAB_HOST) {
+    relativePath = new URL(config.baseUrl).pathname;
+  }
+  return trimEnd(relativePath, "/");
+}
+
+export { getGitLabIntegrationRelativePath, readGitLabIntegrationConfig, readGitLabIntegrationConfigs };
+//# sourceMappingURL=config.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.esm.js","sources":["../../src/gitlab/config.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 { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\nconst GITLAB_HOST = 'gitlab.com';\nconst GITLAB_API_BASE_URL = 'https://gitlab.com/api/v4';\n\n/**\n * The configuration parameters for a single GitLab integration.\n *\n * @public\n */\nexport type GitLabIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. `gitlab.com`.\n   */\n  host: string;\n\n  /**\n   * The base URL of the API of this provider, e.g.\n   * `https://gitlab.com/api/v4`, with no trailing slash.\n   *\n   * May be omitted specifically for public GitLab; then it will be deduced.\n   */\n  apiBaseUrl: string;\n\n  /**\n   * The authorization token to use for requests to this provider.\n   *\n   * If no token is specified, anonymous access is used.\n   */\n  token?: string;\n\n  /**\n   * The baseUrl of this provider, e.g. `https://gitlab.com`, which is passed\n   * into the GitLab client.\n   *\n   * If no baseUrl is provided, it will default to `https://${host}`\n   */\n  baseUrl: string;\n};\n\n/**\n * Reads a single GitLab integration config.\n *\n * @param config - The config object of a single integration\n * @public\n */\nexport function readGitLabIntegrationConfig(\n  config: Config,\n): GitLabIntegrationConfig {\n  const host = config.getString('host');\n  let apiBaseUrl = config.getOptionalString('apiBaseUrl');\n  const token = config.getOptionalString('token')?.trim();\n  let baseUrl = config.getOptionalString('baseUrl');\n  if (apiBaseUrl) {\n    apiBaseUrl = trimEnd(apiBaseUrl, '/');\n  } else if (host === GITLAB_HOST) {\n    apiBaseUrl = GITLAB_API_BASE_URL;\n  }\n\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${host}' is not a valid host`,\n    );\n  } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`,\n    );\n  } else if (!isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  }\n\n  return { host, token, apiBaseUrl, baseUrl };\n}\n\n/**\n * Reads a set of GitLab integration configs, and inserts some defaults for\n * public GitLab if not specified.\n *\n * @param configs - All of the integration config objects\n * @public\n */\nexport function readGitLabIntegrationConfigs(\n  configs: Config[],\n): GitLabIntegrationConfig[] {\n  // First read all the explicit integrations\n  const result = configs.map(readGitLabIntegrationConfig);\n\n  // As a convenience we always make sure there's at least an unauthenticated\n  // reader for public gitlab repos.\n  if (!result.some(c => c.host === GITLAB_HOST)) {\n    result.push({\n      host: GITLAB_HOST,\n      apiBaseUrl: GITLAB_API_BASE_URL,\n      baseUrl: `https://${GITLAB_HOST}`,\n    });\n  }\n\n  return result;\n}\n\n/**\n * Reads a GitLab integration config, and returns\n * relative path.\n *\n * @param config - GitLabIntegrationConfig object\n * @public\n */\nexport function getGitLabIntegrationRelativePath(\n  config: GitLabIntegrationConfig,\n): string {\n  let relativePath = '';\n  if (config.host !== GITLAB_HOST) {\n    relativePath = new URL(config.baseUrl).pathname;\n  }\n  return trimEnd(relativePath, '/');\n}\n"],"names":[],"mappings":";;;AAoBA,MAAM,WAAc,GAAA,YAAA,CAAA;AACpB,MAAM,mBAAsB,GAAA,2BAAA,CAAA;AA2CrB,SAAS,4BACd,MACyB,EAAA;AAlE3B,EAAA,IAAA,EAAA,CAAA;AAmEE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAI,IAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,YAAY,CAAA,CAAA;AACtD,EAAA,MAAM,KAAQ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,MAAhC,IAAmC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,EAAA,CAAA;AACjD,EAAI,IAAA,OAAA,GAAU,MAAO,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AAChD,EAAA,IAAI,UAAY,EAAA;AACd,IAAa,UAAA,GAAA,OAAA,CAAQ,YAAY,GAAG,CAAA,CAAA;AAAA,GACtC,MAAA,IAAW,SAAS,WAAa,EAAA;AAC/B,IAAa,UAAA,GAAA,mBAAA,CAAA;AAAA,GACf;AAEA,EAAA,IAAI,OAAS,EAAA;AACX,IAAU,OAAA,GAAA,OAAA,CAAQ,SAAS,GAAG,CAAA,CAAA;AAAA,GACzB,MAAA;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,GAC3B;AAEA,EAAI,IAAA,CAAC,WAAY,CAAA,IAAI,CAAG,EAAA;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA,CAAA;AAAA,KAC7C,CAAA;AAAA,aACS,CAAC,UAAA,IAAc,CAAC,UAAA,CAAW,UAAU,CAAG,EAAA;AACjD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,UAAU,CAAA,2BAAA,CAAA;AAAA,KACnD,CAAA;AAAA,GACS,MAAA,IAAA,CAAC,UAAW,CAAA,OAAO,CAAG,EAAA;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,OAAO,CAAA,wBAAA,CAAA;AAAA,KAChD,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,KAAO,EAAA,UAAA,EAAY,OAAQ,EAAA,CAAA;AAC5C,CAAA;AASO,SAAS,6BACd,OAC2B,EAAA;AAE3B,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,GAAA,CAAI,2BAA2B,CAAA,CAAA;AAItD,EAAA,IAAI,CAAC,MAAO,CAAA,IAAA,CAAK,OAAK,CAAE,CAAA,IAAA,KAAS,WAAW,CAAG,EAAA;AAC7C,IAAA,MAAA,CAAO,IAAK,CAAA;AAAA,MACV,IAAM,EAAA,WAAA;AAAA,MACN,UAAY,EAAA,mBAAA;AAAA,MACZ,OAAA,EAAS,WAAW,WAAW,CAAA,CAAA;AAAA,KAChC,CAAA,CAAA;AAAA,GACH;AAEA,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AASO,SAAS,iCACd,MACQ,EAAA;AACR,EAAA,IAAI,YAAe,GAAA,EAAA,CAAA;AACnB,EAAI,IAAA,MAAA,CAAO,SAAS,WAAa,EAAA;AAC/B,IAAA,YAAA,GAAe,IAAI,GAAA,CAAI,MAAO,CAAA,OAAO,CAAE,CAAA,QAAA,CAAA;AAAA,GACzC;AACA,EAAO,OAAA,OAAA,CAAQ,cAAc,GAAG,CAAA,CAAA;AAClC;;;;"}