@backstage/integration 0.7.3 → 0.8.0

package/dist/index.d.ts

@@ -0,0 +1,864 @@
+import { Config } from '@backstage/config';
+import { RestEndpointMethodTypes } from '@octokit/rest';
+
+/**
+ * Encapsulates a single SCM integration.
+ *
+ * @public
+ */
+interface ScmIntegration {
+    /**
+     * The type of integration, e.g. "github".
+     */
+    type: string;
+    /**
+     * A human readable title for the integration, that can be shown to users to
+     * differentiate between different integrations.
+     */
+    title: string;
+    /**
+     * Resolves an absolute or relative URL in relation to a base URL.
+     *
+     * This method is adapted for use within SCM systems, so relative URLs are
+     * within the context of the root of the hierarchy pointed to by the base
+     * URL.
+     *
+     * For example, if the base URL is  `<repo root url>/folder/a.yaml`, i.e.
+     * within the file tree of a certain repo, an absolute path of `/b.yaml` does
+     * not resolve to `https://hostname/b.yaml` but rather to
+     * `<repo root url>/b.yaml` inside the file tree of that same repo.
+     */
+    resolveUrl(options: {
+        /**
+         * The (absolute or relative) URL or path to resolve
+         */
+        url: string;
+        /**
+         * The base URL onto which this resolution happens
+         */
+        base: string;
+        /**
+         * The line number in the target file to link to, starting with 1. Only applicable when linking to files.
+         */
+        lineNumber?: number;
+    }): string;
+    /**
+     * Resolves the edit URL for a file within the SCM system.
+     *
+     * Most SCM systems have a web interface that allows viewing and editing files
+     * in the repository. The returned URL directly jumps into the edit mode for
+     * the file.
+     * If this is not possible, the integration can fall back to a URL to view
+     * the file in the web interface.
+     *
+     * @param url - The absolute URL to the file that should be edited.
+     */
+    resolveEditUrl(url: string): string;
+}
+/**
+ * Encapsulates several integrations, that are all of the same type.
+ *
+ * @public
+ */
+interface ScmIntegrationsGroup<T extends ScmIntegration> {
+    /**
+     * Lists all registered integrations of this type.
+     */
+    list(): T[];
+    /**
+     * Fetches an integration of this type by URL.
+     *
+     * @param url - A URL that matches a registered integration of this type
+     */
+    byUrl(url: string | URL): T | undefined;
+    /**
+     * Fetches an integration of this type by host name.
+     *
+     * @param host - A host name that matches a registered integration of this type
+     */
+    byHost(host: string): T | undefined;
+}
+/**
+ * A factory function that creates an integration group based on configuration.
+ *
+ * @public
+ */
+declare type ScmIntegrationsFactory<T extends ScmIntegration> = (options: {
+    config: Config;
+}) => ScmIntegrationsGroup<T>;
+
+/**
+ * The configuration parameters for a single Azure provider.
+ *
+ * @public
+ */
+declare type AzureIntegrationConfig = {
+    /**
+     * The host of the target that this matches on, e.g. "dev.azure.com".
+     *
+     * Currently only "dev.azure.com" is supported.
+     */
+    host: string;
+    /**
+     * The authorization token to use for requests.
+     *
+     * If no token is specified, anonymous access is used.
+     */
+    token?: string;
+};
+/**
+ * Reads a single Azure integration config.
+ *
+ * @param config - The config object of a single integration
+ * @public
+ */
+declare function readAzureIntegrationConfig(config: Config): AzureIntegrationConfig;
+/**
+ * Reads a set of Azure integration configs, and inserts some defaults for
+ * public Azure if not specified.
+ *
+ * @param configs - All of the integration config objects
+ * @public
+ */
+declare function readAzureIntegrationConfigs(configs: Config[]): AzureIntegrationConfig[];
+
+/**
+ * Microsoft Azure based integration.
+ *
+ * @public
+ */
+declare class AzureIntegration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<AzureIntegration>;
+    constructor(integrationConfig: AzureIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    get config(): AzureIntegrationConfig;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
+/**
+ * Given a URL pointing to a file on a provider, returns a URL that is suitable
+ * for fetching the contents of the data.
+ *
+ * @remarks
+ *
+ * Converts
+ * - from: `https://dev.azure.com/{organization}/{project}/_git/reponame?path={path}&version=GB{commitOrBranch}&_a=contents`
+ * - to:   `https://dev.azure.com/{organization}/{project}/_apis/git/repositories/reponame/items?path={path}&version={commitOrBranch}`
+ *
+ * @param url - A URL pointing to a file
+ * @public
+ */
+declare function getAzureFileFetchUrl(url: string): string;
+/**
+ * Given a URL pointing to a path on a provider, returns a URL that is suitable
+ * for downloading the subtree.
+ *
+ * @param url - A URL pointing to a path
+ * @public
+ */
+declare function getAzureDownloadUrl(url: string): string;
+/**
+ * Given a URL, return the API URL to fetch commits on the branch.
+ *
+ * @param url - A URL pointing to a repository or a sub-path
+ * @public
+ */
+declare function getAzureCommitsUrl(url: string): string;
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getAzureRequestOptions(config: AzureIntegrationConfig, additionalHeaders?: Record<string, string>): {
+    headers: Record<string, string>;
+};
+
+/**
+ * The configuration parameters for a single Bitbucket API provider.
+ *
+ * @public
+ */
+declare type BitbucketIntegrationConfig = {
+    /**
+     * The host of the target that this matches on, e.g. "bitbucket.org"
+     */
+    host: string;
+    /**
+     * The base URL of the API of this provider, e.g. "https://api.bitbucket.org/2.0",
+     * with no trailing slash.
+     *
+     * Values omitted at the optional property at the app-config will be deduced
+     * from the "host" value.
+     */
+    apiBaseUrl: string;
+    /**
+     * The authorization token to use for requests to a Bitbucket Server provider.
+     *
+     * See https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html
+     *
+     * If no token is specified, anonymous access is used.
+     */
+    token?: string;
+    /**
+     * The username to use for requests to Bitbucket Cloud (bitbucket.org).
+     */
+    username?: string;
+    /**
+     * Authentication with Bitbucket Cloud (bitbucket.org) is done using app passwords.
+     *
+     * See https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/
+     */
+    appPassword?: string;
+};
+/**
+ * Reads a single Bitbucket integration config.
+ *
+ * @param config - The config object of a single integration
+ * @public
+ */
+declare function readBitbucketIntegrationConfig(config: Config): BitbucketIntegrationConfig;
+/**
+ * Reads a set of Bitbucket integration configs, and inserts some defaults for
+ * public Bitbucket if not specified.
+ *
+ * @param configs - All of the integration config objects
+ * @public
+ */
+declare function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIntegrationConfig[];
+
+/**
+ * A Bitbucket based integration.
+ *
+ * @public
+ */
+declare class BitbucketIntegration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<BitbucketIntegration>;
+    constructor(integrationConfig: BitbucketIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    get config(): BitbucketIntegrationConfig;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
+/**
+ * Given a URL pointing to a path on a provider, returns the default branch.
+ *
+ * @param url - A URL pointing to a path
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketDefaultBranch(url: string, config: BitbucketIntegrationConfig): Promise<string>;
+/**
+ * Given a URL pointing to a path on a provider, returns a URL that is suitable
+ * for downloading the subtree.
+ *
+ * @param url - A URL pointing to a path
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketDownloadUrl(url: string, config: BitbucketIntegrationConfig): Promise<string>;
+/**
+ * Given a URL pointing to a file on a provider, returns a URL that is suitable
+ * for fetching the contents of the data.
+ *
+ * @remarks
+ *
+ * Converts
+ * from: https://bitbucket.org/orgname/reponame/src/master/file.yaml
+ * to:   https://api.bitbucket.org/2.0/repositories/orgname/reponame/src/master/file.yaml
+ *
+ * @param url - A URL pointing to a file
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketFileFetchUrl(url: string, config: BitbucketIntegrationConfig): string;
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketRequestOptions(config: BitbucketIntegrationConfig): {
+    headers: Record<string, string>;
+};
+
+/**
+ * The configuration parameters for a single GitHub integration.
+ *
+ * @public
+ */
+declare type GitHubIntegrationConfig = {
+    /**
+     * The host of the target that this matches on, e.g. "github.com"
+     */
+    host: string;
+    /**
+     * The base URL of the API of this provider, e.g. "https://api.github.com",
+     * with no trailing slash.
+     *
+     * May be omitted specifically for GitHub; then it will be deduced.
+     *
+     * The API will always be preferred if both its base URL and a token are
+     * present.
+     */
+    apiBaseUrl?: string;
+    /**
+     * The base URL of the raw fetch endpoint of this provider, e.g.
+     * "https://raw.githubusercontent.com", with no trailing slash.
+     *
+     * May be omitted specifically for GitHub; then it will be deduced.
+     *
+     * The API will always be preferred if both its base URL and a token are
+     * present.
+     */
+    rawBaseUrl?: string;
+    /**
+     * The authorization token to use for requests to this provider.
+     *
+     * If no token is specified, anonymous access is used.
+     */
+    token?: string;
+    /**
+     * The GitHub Apps configuration to use for requests to this provider.
+     *
+     * If no apps are specified, token or anonymous is used.
+     */
+    apps?: GithubAppConfig[];
+};
+/**
+ * The configuration parameters for authenticating a GitHub Application.
+ *
+ * @remarks
+ *
+ * A GitHub Apps configuration can be generated using the `backstage-cli create-github-app` command.
+ *
+ * @public
+ */
+declare type GithubAppConfig = {
+    /**
+     * Unique app identifier, found at https://github.com/organizations/$org/settings/apps/$AppName
+     */
+    appId: number;
+    /**
+     * The private key is used by the GitHub App integration to authenticate the app.
+     * A private key can be generated from the app at https://github.com/organizations/$org/settings/apps/$AppName
+     */
+    privateKey: string;
+    /**
+     * Webhook secret can be configured at https://github.com/organizations/$org/settings/apps/$AppName
+     */
+    webhookSecret: string;
+    /**
+     * Found at https://github.com/organizations/$org/settings/apps/$AppName
+     */
+    clientId: string;
+    /**
+     * Client secrets can be generated at https://github.com/organizations/$org/settings/apps/$AppName
+     */
+    clientSecret: string;
+    /**
+     * List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations.
+     * However you can list the installations with the GitHub API. You can find the list of installations here:
+     * https://api.github.com/app/installations
+     * The relevant documentation for this is here.
+     * https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples
+     */
+    allowedInstallationOwners?: string[];
+};
+/**
+ * Reads a single GitHub integration config.
+ *
+ * @param config - The config object of a single integration
+ * @public
+ */
+declare function readGitHubIntegrationConfig(config: Config): GitHubIntegrationConfig;
+/**
+ * Reads a set of GitHub integration configs, and inserts some defaults for
+ * public GitHub if not specified.
+ *
+ * @param configs - All of the integration config objects
+ * @public
+ */
+declare function readGitHubIntegrationConfigs(configs: Config[]): GitHubIntegrationConfig[];
+
+/**
+ * The type of credentials produced by the credential provider.
+ *
+ * @public
+ */
+declare type GithubCredentialType = 'app' | 'token';
+/**
+ * A set of credentials information for a GitHub integration.
+ *
+ * @public
+ */
+declare type GithubCredentials = {
+    headers?: {
+        [name: string]: string;
+    };
+    token?: string;
+    type: GithubCredentialType;
+};
+/**
+ * This allows implementations to be provided to retrieve GitHub credentials.
+ *
+ * @public
+ *
+ */
+interface GithubCredentialsProvider {
+    getCredentials(opts: {
+        url: string;
+    }): Promise<GithubCredentials>;
+}
+
+/**
+ * Given a URL pointing to a file on a provider, returns a URL that is suitable
+ * for fetching the contents of the data.
+ *
+ * @remarks
+ *
+ * Converts
+ * from: https://github.com/a/b/blob/branchname/path/to/c.yaml
+ * to:   https://api.github.com/repos/a/b/contents/path/to/c.yaml?ref=branchname
+ * or:   https://raw.githubusercontent.com/a/b/branchname/c.yaml
+ *
+ * @param url - A URL pointing to a file
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getGitHubFileFetchUrl(url: string, config: GitHubIntegrationConfig, credentials: GithubCredentials): string;
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @deprecated This function is no longer used internally
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getGitHubRequestOptions(config: GitHubIntegrationConfig, credentials: GithubCredentials): {
+    headers: Record<string, string>;
+};
+
+/**
+ * The configuration parameters for a single AWS S3 provider.
+ *
+ * @public
+ */
+declare type AwsS3IntegrationConfig = {
+    /**
+     * Host, derived from endpoint, and defaults to amazonaws.com
+     */
+    host: string;
+    /**
+     * (Optional) AWS Endpoint.
+     * The endpoint URI to send requests to. The default endpoint is built from the configured region.
+     * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
+     *
+     * Supports non-AWS providers, e.g. for LocalStack, endpoint may look like http://localhost:4566
+     */
+    endpoint?: string;
+    /**
+     * (Optional) Whether to use path style URLs when communicating with S3.
+     * Defaults to false.
+     * This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.
+     */
+    s3ForcePathStyle?: boolean;
+    /**
+     * (Optional) User access key id
+     */
+    accessKeyId?: string;
+    /**
+     * (Optional) User secret access key
+     */
+    secretAccessKey?: string;
+    /**
+     * (Optional) ARN of role to be assumed
+     */
+    roleArn?: string;
+};
+/**
+ * Reads a single Aws S3 integration config.
+ *
+ * @param config - The config object of a single integration
+ * @public
+ */
+declare function readAwsS3IntegrationConfig(config: Config): AwsS3IntegrationConfig;
+/**
+ * Reads a set of AWS S3 integration configs, and inserts some defaults for
+ * public Amazon AWS if not specified.
+ *
+ * @param configs - The config objects of the integrations
+ * @public
+ */
+declare function readAwsS3IntegrationConfigs(configs: Config[]): AwsS3IntegrationConfig[];
+
+/**
+ * Integrates with AWS S3 or compatible solutions.
+ *
+ * @public
+ */
+declare class AwsS3Integration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<AwsS3Integration>;
+    get type(): string;
+    get title(): string;
+    get config(): AwsS3IntegrationConfig;
+    constructor(integrationConfig: AwsS3IntegrationConfig);
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number | undefined;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
+/**
+ * A GitHub based integration.
+ *
+ * @public
+ */
+declare class GitHubIntegration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<GitHubIntegration>;
+    constructor(integrationConfig: GitHubIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    get config(): GitHubIntegrationConfig;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+/**
+ * Takes a GitHub URL and replaces the type part (blob, tree etc).
+ *
+ * @param url - The original URL
+ * @param type - The desired type, e.g. "blob"
+ * @public
+ */
+declare function replaceGitHubUrlType(url: string, type: 'blob' | 'tree' | 'edit'): string;
+
+/**
+ * The configuration parameters for a single GitLab integration.
+ *
+ * @public
+ */
+declare type GitLabIntegrationConfig = {
+    /**
+     * The host of the target that this matches on, e.g. `gitlab.com`.
+     */
+    host: string;
+    /**
+     * The base URL of the API of this provider, e.g.
+     * `https://gitlab.com/api/v4`, with no trailing slash.
+     *
+     * May be omitted specifically for public GitLab; then it will be deduced.
+     */
+    apiBaseUrl: string;
+    /**
+     * The authorization token to use for requests to this provider.
+     *
+     * If no token is specified, anonymous access is used.
+     */
+    token?: string;
+    /**
+     * The baseUrl of this provider, e.g. `https://gitlab.com`, which is passed
+     * into the GitLab client.
+     *
+     * If no baseUrl is provided, it will default to `https://${host}`
+     */
+    baseUrl: string;
+};
+/**
+ * Reads a single GitLab integration config.
+ *
+ * @param config - The config object of a single integration
+ * @public
+ */
+declare function readGitLabIntegrationConfig(config: Config): GitLabIntegrationConfig;
+/**
+ * Reads a set of GitLab integration configs, and inserts some defaults for
+ * public GitLab if not specified.
+ *
+ * @param configs - All of the integration config objects
+ * @public
+ */
+declare function readGitLabIntegrationConfigs(configs: Config[]): GitLabIntegrationConfig[];
+
+/**
+ * A GitLab based integration.
+ *
+ * @public
+ */
+declare class GitLabIntegration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<GitLabIntegration>;
+    constructor(integrationConfig: GitLabIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    get config(): GitLabIntegrationConfig;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
+/**
+ * Holds all registered SCM integrations, of all types.
+ *
+ * @public
+ */
+interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
+    awsS3: ScmIntegrationsGroup<AwsS3Integration>;
+    azure: ScmIntegrationsGroup<AzureIntegration>;
+    bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    github: ScmIntegrationsGroup<GitHubIntegration>;
+    gitlab: ScmIntegrationsGroup<GitLabIntegration>;
+    /**
+     * Resolves an absolute or relative URL in relation to a base URL.
+     *
+     * This method is adapted for use within SCM systems, so relative URLs are
+     * within the context of the root of the hierarchy pointed to by the base
+     * URL.
+     *
+     * For example, if the base URL is  `<repo root url>/folder/a.yaml`, i.e.
+     * within the file tree of a certain repo, an absolute path of `/b.yaml` does
+     * not resolve to `https://hostname/b.yaml` but rather to
+     * `<repo root url>/b.yaml` inside the file tree of that same repo.
+     */
+    resolveUrl(options: {
+        /**
+         * The (absolute or relative) URL or path to resolve.
+         */
+        url: string;
+        /**
+         * The base URL onto which this resolution happens
+         */
+        base: string;
+        /**
+         * The line number in the target file to link to, starting with 1. Only applicable when linking to files.
+         */
+        lineNumber?: number;
+    }): string;
+    /**
+     * Resolves the edit URL for a file within the SCM system.
+     *
+     * Most SCM systems have a web interface that allows viewing and editing files
+     * in the repository. The returned URL directly jumps into the edit mode for
+     * the file.
+     * If this is not possible, the integration can fall back to a URL to view
+     * the file in the web interface.
+     *
+     * @param url - The absolute URL to the file that should be edited.
+     */
+    resolveEditUrl(url: string): string;
+}
+
+/**
+ * Handles the creation and caching of credentials for GitHub integrations.
+ *
+ * @public
+ * @remarks
+ *
+ * TODO: Possibly move this to a backend only package so that it's not used in the frontend by mistake
+ */
+declare class DefaultGithubCredentialsProvider implements GithubCredentialsProvider {
+    private readonly providers;
+    static fromIntegrations(integrations: ScmIntegrationRegistry): DefaultGithubCredentialsProvider;
+    private constructor();
+    /**
+     * 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: 'https://github.com/backstage/foobar'
+     * })
+     *
+     * const { token, headers } = await getCredentials({
+     *   url: 'https://github.com/backstage'
+     * })
+     * ```
+     *
+     * @param opts - The organization or repository URL
+     * @returns A promise of {@link GithubCredentials}.
+     */
+    getCredentials(opts: {
+        url: string;
+    }): Promise<GithubCredentials>;
+}
+
+/**
+ * Corresponds to a Github installation which internally could hold several GitHub Apps.
+ *
+ * @public
+ */
+declare class GithubAppCredentialsMux {
+    private readonly apps;
+    constructor(config: GitHubIntegrationConfig);
+    getAllInstallations(): Promise<RestEndpointMethodTypes['apps']['listInstallations']['response']['data']>;
+    getAppToken(owner: string, repo?: string): Promise<string | undefined>;
+}
+/**
+ * Handles the creation and caching of credentials for GitHub integrations.
+ *
+ * @public
+ * @remarks
+ *
+ * TODO: Possibly move this to a backend only package so that it's not used in the frontend by mistake
+ */
+declare class SingleInstanceGithubCredentialsProvider implements GithubCredentialsProvider {
+    private readonly githubAppCredentialsMux;
+    private readonly token?;
+    static create: (config: GitHubIntegrationConfig) => GithubCredentialsProvider;
+    private constructor();
+    /**
+     * 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}.
+     */
+    getCredentials(opts: {
+        url: string;
+    }): Promise<GithubCredentials>;
+}
+
+/**
+ * Given a URL pointing to a file on a provider, returns a URL that is suitable
+ * for fetching the contents of the data.
+ *
+ * @remarks
+ *
+ * Converts
+ * from: https://gitlab.example.com/a/b/blob/master/c.yaml
+ * to:   https://gitlab.example.com/a/b/raw/master/c.yaml
+ * -or-
+ * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
+ * to:   https://gitlab.com/api/v4/projects/projectId/repository/files/filepath?ref=branch
+ *
+ * @param url - A URL pointing to a file
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getGitLabFileFetchUrl(url: string, config: GitLabIntegrationConfig): Promise<string>;
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getGitLabRequestOptions(config: GitLabIntegrationConfig): {
+    headers: Record<string, string>;
+};
+
+/**
+ * The configuration parameters for a single Google Cloud Storage provider.
+ *
+ * @public
+ */
+declare type GoogleGcsIntegrationConfig = {
+    /**
+     * Service account email used to authenticate requests.
+     */
+    clientEmail?: string;
+    /**
+     * Service account private key used to authenticate requests.
+     */
+    privateKey?: string;
+};
+/**
+ * Reads a single Google GCS integration config.
+ *
+ * @param config - The config object of a single integration
+ * @public
+ */
+declare function readGoogleGcsIntegrationConfig(config: Config): GoogleGcsIntegrationConfig;
+
+/**
+ * Default implementation of {@link ScmIntegration} `resolveUrl`, that only
+ * works with URL pathname based providers.
+ *
+ * @public
+ */
+declare function defaultScmResolveUrl(options: {
+    url: string;
+    base: string;
+    lineNumber?: number;
+}): string;
+
+/**
+ * The set of supported integrations.
+ *
+ * @public
+ */
+interface IntegrationsByType {
+    awsS3: ScmIntegrationsGroup<AwsS3Integration>;
+    azure: ScmIntegrationsGroup<AzureIntegration>;
+    bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    github: ScmIntegrationsGroup<GitHubIntegration>;
+    gitlab: ScmIntegrationsGroup<GitLabIntegration>;
+}
+/**
+ * Exposes the set of supported integrations.
+ *
+ * @public
+ */
+declare class ScmIntegrations implements ScmIntegrationRegistry {
+    private readonly byType;
+    static fromConfig(config: Config): ScmIntegrations;
+    constructor(integrationsByType: IntegrationsByType);
+    get awsS3(): ScmIntegrationsGroup<AwsS3Integration>;
+    get azure(): ScmIntegrationsGroup<AzureIntegration>;
+    get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
+    get github(): ScmIntegrationsGroup<GitHubIntegration>;
+    get gitlab(): ScmIntegrationsGroup<GitLabIntegration>;
+    list(): ScmIntegration[];
+    byUrl(url: string | URL): ScmIntegration | undefined;
+    byHost(host: string): ScmIntegration | undefined;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
+export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, DefaultGithubCredentialsProvider, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };