@backstage/integration 1.6.0 → 1.7.0-next.0

package/dist/index.d.ts

@@ -180,20 +180,51 @@ type AzureIntegrationConfig = {
      * The authorization token to use for requests.
      *
      * If no token is specified, anonymous access is used.
+     *
+     * @deprecated Use `credentials` instead.
      */
     token?: string;
     /**
      * The credential to use for requests.
      *
      * If no credential is specified anonymous access is used.
+     *
+     * @deprecated Use `credentials` instead.
+     */
+    credential?: AzureDevOpsCredential;
+    /**
+     * The credentials to use for requests. If multiple credentials are specified the first one that matches the organization is used.
+     * If not organization matches the first credential without an organization is used.
+     *
+     * If no credentials are specified at all, either a default credential (for Azure DevOps) or anonymous access (for Azure DevOps Server) is used.
+     */
+    credentials?: AzureDevOpsCredential[];
+};
+/**
+ * The kind of Azure DevOps credential.
+ * @public
+ */
+type AzureDevOpsCredentialKind = 'PersonalAccessToken' | 'ClientSecret' | 'ManagedIdentity';
+/**
+ * Common fields for the Azure DevOps credentials.
+ * @public
+ */
+type AzureCredentialBase = {
+    /**
+     * The kind of credential.
+     */
+    kind: AzureDevOpsCredentialKind;
+    /**
+     * The Azure DevOps organizations for which to use this credential.
      */
-    credential?: AzureCredential;
+    organizations?: string[];
 };
 /**
- * Authenticate using a client secret that was generated for an App Registration.
+ * A client secret credential that was generated for an App Registration.
  * @public
  */
-type AzureClientSecretCredential = {
+type AzureClientSecretCredential = AzureCredentialBase & {
+    kind: 'ClientSecret';
     /**
      * The Azure Active Directory tenant
      */
@@ -208,20 +239,34 @@ type AzureClientSecretCredential = {
     clientSecret: string;
 };
 /**
- * Authenticate using a managed identity available at the deployment environment.
+ * A managed identity credential.
  * @public
  */
-type AzureManagedIdentityCredential = {
+type AzureManagedIdentityCredential = AzureCredentialBase & {
+    kind: 'ManagedIdentity';
     /**
      * The clientId
      */
     clientId: string;
 };
 /**
- * Credential used to authenticate to Azure Active Directory.
+ * A personal access token credential.
  * @public
  */
-type AzureCredential = AzureClientSecretCredential | AzureManagedIdentityCredential;
+type PersonalAccessTokenCredential = AzureCredentialBase & {
+    kind: 'PersonalAccessToken';
+    personalAccessToken: string;
+};
+/**
+ * The general shape of a credential that can be used to authenticate to Azure DevOps.
+ * @public
+ */
+type AzureDevOpsCredentialLike = Omit<Partial<AzureClientSecretCredential> & Partial<AzureManagedIdentityCredential> & Partial<PersonalAccessTokenCredential>, 'kind'>;
+/**
+ * Credential used to authenticate to Azure DevOps.
+ * @public
+ */
+type AzureDevOpsCredential = AzureClientSecretCredential | AzureManagedIdentityCredential | PersonalAccessTokenCredential;
 /**
  * Reads a single Azure integration config.
  *
@@ -287,44 +332,50 @@ declare function getAzureDownloadUrl(url: string): string;
  * @public
  */
 declare function getAzureCommitsUrl(url: string): string;
+
 /**
- * Gets the request options necessary to make requests to a given provider.
+ * The type of Azure DevOps credential, either bearer or pat.
+ * @public
+ */
+type AzureDevOpsCredentialType = 'bearer' | 'pat';
+/**
+ * A set of credentials for Azure DevOps.
  *
- * @param config - The relevant provider config
- * @param additionalHeaders - Additional headers for the request
  * @public
  */
-declare function getAzureRequestOptions(config: AzureIntegrationConfig, additionalHeaders?: Record<string, string>): Promise<{
-    headers: Record<string, string>;
-}>;
+type AzureDevOpsCredentials = {
+    headers: {
+        [name: string]: string;
+    };
+    token: string;
+    type: AzureDevOpsCredentialType;
+};
+/**
+ * This allows implementations to be provided to retrieve Azure DevOps credentials.
+ *
+ * @public
+ *
+ */
+interface AzureDevOpsCredentialsProvider {
+    getCredentials(opts: {
+        url: string;
+    }): Promise<AzureDevOpsCredentials | undefined>;
+}
 
 /**
- * The configuration parameters for a single Bitbucket API provider.
+ * The configuration parameters for a single Bitbucket Cloud API provider.
  *
  * @public
- * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
  */
-type BitbucketIntegrationConfig = {
+type BitbucketCloudIntegrationConfig = {
     /**
-     * The host of the target that this matches on, e.g. "bitbucket.org"
+     * Constant. 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.
+     * Constant. https://api.bitbucket.org/2.0
      */
     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).
      */
@@ -337,36 +388,33 @@ type BitbucketIntegrationConfig = {
     appPassword?: string;
 };
 /**
- * Reads a single Bitbucket integration config.
+ * Reads a single Bitbucket Cloud integration config.
  *
  * @param config - The config object of a single integration
  * @public
- * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
  */
-declare function readBitbucketIntegrationConfig(config: Config): BitbucketIntegrationConfig;
+declare function readBitbucketCloudIntegrationConfig(config: Config): BitbucketCloudIntegrationConfig;
 /**
- * Reads a set of Bitbucket integration configs, and inserts some defaults for
- * public Bitbucket if not specified.
+ * Reads a set of Bitbucket Cloud integration configs,
+ * and inserts one for public Bitbucket Cloud if none specified.
  *
  * @param configs - All of the integration config objects
  * @public
- * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
  */
-declare function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIntegrationConfig[];
+declare function readBitbucketCloudIntegrationConfigs(configs: Config[]): BitbucketCloudIntegrationConfig[];
 
 /**
- * A Bitbucket based integration.
+ * A Bitbucket Cloud based integration.
  *
  * @public
- * @deprecated replaced by the integrations bitbucketCloud and bitbucketServer.
  */
-declare class BitbucketIntegration implements ScmIntegration {
+declare class BitbucketCloudIntegration implements ScmIntegration {
     private readonly integrationConfig;
-    static factory: ScmIntegrationsFactory<BitbucketIntegration>;
-    constructor(integrationConfig: BitbucketIntegrationConfig);
+    static factory: ScmIntegrationsFactory<BitbucketCloudIntegration>;
+    constructor(integrationConfig: BitbucketCloudIntegrationConfig);
     get type(): string;
     get title(): string;
-    get config(): BitbucketIntegrationConfig;
+    get config(): BitbucketCloudIntegrationConfig;
     resolveUrl(options: {
         url: string;
         base: string;
@@ -376,65 +424,32 @@ declare class BitbucketIntegration implements ScmIntegration {
 }
 
 /**
- * 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
- * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
- */
-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
- * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
- */
-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
- * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
- */
-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
- * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
- */
-declare function getBitbucketRequestOptions(config: BitbucketIntegrationConfig): {
-    headers: Record<string, string>;
-};
-
-/**
- * The configuration parameters for a single Bitbucket Cloud API provider.
+ * The configuration parameters for a single Bitbucket API provider.
  *
  * @public
+ * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
  */
-type BitbucketCloudIntegrationConfig = {
+type BitbucketIntegrationConfig = {
     /**
-     * Constant. bitbucket.org
+     * The host of the target that this matches on, e.g. "bitbucket.org"
      */
     host: string;
     /**
-     * Constant. https://api.bitbucket.org/2.0
+     * 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).
      */
@@ -447,33 +462,36 @@ type BitbucketCloudIntegrationConfig = {
     appPassword?: string;
 };
 /**
- * Reads a single Bitbucket Cloud integration config.
+ * Reads a single Bitbucket integration config.
  *
  * @param config - The config object of a single integration
  * @public
+ * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
  */
-declare function readBitbucketCloudIntegrationConfig(config: Config): BitbucketCloudIntegrationConfig;
+declare function readBitbucketIntegrationConfig(config: Config): BitbucketIntegrationConfig;
 /**
- * Reads a set of Bitbucket Cloud integration configs,
- * and inserts one for public Bitbucket Cloud if none specified.
+ * 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
+ * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
  */
-declare function readBitbucketCloudIntegrationConfigs(configs: Config[]): BitbucketCloudIntegrationConfig[];
+declare function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIntegrationConfig[];
 
 /**
- * A Bitbucket Cloud based integration.
+ * A Bitbucket based integration.
  *
  * @public
+ * @deprecated replaced by the integrations bitbucketCloud and bitbucketServer.
  */
-declare class BitbucketCloudIntegration implements ScmIntegration {
+declare class BitbucketIntegration implements ScmIntegration {
     private readonly integrationConfig;
-    static factory: ScmIntegrationsFactory<BitbucketCloudIntegration>;
-    constructor(integrationConfig: BitbucketCloudIntegrationConfig);
+    static factory: ScmIntegrationsFactory<BitbucketIntegration>;
+    constructor(integrationConfig: BitbucketIntegrationConfig);
     get type(): string;
     get title(): string;
-    get config(): BitbucketCloudIntegrationConfig;
+    get config(): BitbucketIntegrationConfig;
     resolveUrl(options: {
         url: string;
         base: string;
@@ -482,48 +500,6 @@ declare class BitbucketCloudIntegration implements ScmIntegration {
     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 getBitbucketCloudDefaultBranch(url: string, config: BitbucketCloudIntegrationConfig): 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 getBitbucketCloudDownloadUrl(url: string, config: BitbucketCloudIntegrationConfig): 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 getBitbucketCloudFileFetchUrl(url: string, config: BitbucketCloudIntegrationConfig): string;
-/**
- * Gets the request options necessary to make requests to a given provider.
- *
- * @param config - The relevant provider config
- * @public
- */
-declare function getBitbucketCloudRequestOptions(config: BitbucketCloudIntegrationConfig): {
-    headers: Record<string, string>;
-};
-
 /**
  * The configuration parameters for a single Bitbucket Server API provider.
  *
@@ -603,49 +579,7 @@ declare class BitbucketServerIntegration implements ScmIntegration {
 }
 
 /**
- * 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 getBitbucketServerDefaultBranch(url: string, config: BitbucketServerIntegrationConfig): 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 getBitbucketServerDownloadUrl(url: string, config: BitbucketServerIntegrationConfig): 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.company.com/projectname/reponame/src/main/file.yaml
- * to:   https://bitbucket.company.com/rest/api/1.0/project/projectname/reponame/raw/file.yaml?at=main
- *
- * @param url - A URL pointing to a file
- * @param config - The relevant provider config
- * @public
- */
-declare function getBitbucketServerFileFetchUrl(url: string, config: BitbucketServerIntegrationConfig): string;
-/**
- * Gets the request options necessary to make requests to a given provider.
- *
- * @param config - The relevant provider config
- * @public
- */
-declare function getBitbucketServerRequestOptions(config: BitbucketServerIntegrationConfig): {
-    headers: Record<string, string>;
-};
-
-/**
- * The configuration parameters for a single Gerrit API provider.
+ * The configuration parameters for a single Gerrit API provider.
  *
  * @public
  */
@@ -720,176 +654,6 @@ declare class GerritIntegration implements ScmIntegration {
     resolveEditUrl(url: string): string;
 }
 
-/**
- * Parse a Gitiles URL and return branch, file path and project.
- *
- * @remarks
- *
- * Gerrit only handles code reviews so it does not have a native way to browse
- * or showing the content of gits. Image if Github only had the "pull requests"
- * tab.
- *
- * Any source code browsing is instead handled by optional services outside
- * Gerrit. The url format chosen for the Gerrit url reader is the one used by
- * the Gitiles project. Gerrit will work perfectly with Backstage without
- * having Gitiles installed but there are some places in the Backstage GUI
- * with links to the url used by the url reader. These will not work unless
- * the urls point to an actual Gitiles installation.
- *
- * Gitiles url:
- * https://g.com/optional_path/\{project\}/+/refs/heads/\{branch\}/\{filePath\}
- * https://g.com/a/optional_path/\{project\}/+/refs/heads/\{branch\}/\{filePath\}
- *
- *
- * @param url - An URL pointing to a file stored in git.
- * @public
- */
-declare function parseGerritGitilesUrl(config: GerritIntegrationConfig, url: string): {
-    branch: string;
-    filePath: string;
-    project: string;
-};
-/**
- * Build a Gerrit Gitiles archive url that targets a specific branch and path
- *
- * @param config - A Gerrit provider config.
- * @param project - The name of the git project
- * @param branch - The branch we will target.
- * @param filePath - The absolute file path.
- * @public
- */
-declare function buildGerritGitilesArchiveUrl(config: GerritIntegrationConfig, project: string, branch: string, filePath: string): string;
-/**
- * Return the url to get branch info from the Gerrit API.
- *
- * @param config - A Gerrit provider config.
- * @param url - An url pointing to a file in git.
- * @public
- */
-declare function getGerritBranchApiUrl(config: GerritIntegrationConfig, url: string): string;
-/**
- * Return the url to clone the repo that is referenced by the url.
- *
- * @param url - An url pointing to a file in git.
- * @public
- */
-declare function getGerritCloneRepoUrl(config: GerritIntegrationConfig, url: string): string;
-/**
- * Return the url to fetch the contents of a file using the Gerrit API.
- *
- * @param config - A Gerrit provider config.
- * @param url - An url pointing to a file in git.
- * @public
- */
-declare function getGerritFileContentsApiUrl(config: GerritIntegrationConfig, url: string): string;
-/**
- * Return the url to query available projects using the Gerrit API.
- *
- * @param config - A Gerrit provider config.
- * @public
- */
-declare function getGerritProjectsApiUrl(config: GerritIntegrationConfig): string;
-/**
- * Return request headers for a Gerrit provider.
- *
- * @param config - A Gerrit provider config
- * @public
- */
-declare function getGerritRequestOptions(config: GerritIntegrationConfig): {
-    headers?: Record<string, string>;
-};
-/**
- * Parse the json response from Gerrit and strip the magic prefix.
- *
- * @remarks
- *
- * To prevent against XSSI attacks the JSON response body from Gerrit starts
- * with a magic prefix that must be stripped before it can be fed to a JSON
- * parser.
- *
- * @param response - An API response.
- * @public
- */
-declare function parseGerritJsonResponse(response: Response): Promise<unknown>;
-
-/**
- * The configuration for a single Gitea integration.
- *
- * @public
- */
-type GiteaIntegrationConfig = {
-    /**
-     * The host of the target that this matches on, e.g. "gitea.website.com"
-     */
-    host: string;
-    /**
-     * The optional base URL of the Gitea instance. It is assumed that https
-     * is used and that the base path is "/" on the host. If that is not the
-     * case set the complete base url to the gitea instance, e.g.
-     * "https://gitea.website.com/". This is the url that you would open
-     * in a browser.
-     */
-    baseUrl?: string;
-    /**
-     * The username to use for requests to gitea.
-     */
-    username?: string;
-    /**
-     * The password or http token to use for authentication.
-     */
-    password?: string;
-};
-/**
- * Parses a location config block for use in GiteaIntegration
- *
- * @public
- */
-declare function readGiteaConfig(config: Config): GiteaIntegrationConfig;
-
-/**
- * A Gitea based integration.
- *
- * @public
- */
-declare class GiteaIntegration implements ScmIntegration {
-    readonly config: GiteaIntegrationConfig;
-    static factory: ScmIntegrationsFactory<GiteaIntegration>;
-    constructor(config: GiteaIntegrationConfig);
-    get type(): string;
-    get title(): string;
-    resolveUrl(options: {
-        url: string;
-        base: string;
-        lineNumber?: number | undefined;
-    }): string;
-    resolveEditUrl(url: string): string;
-}
-
-/**
- * Given a URL pointing to a file, returns an api URL
- * for fetching the contents of the data.
- *
- * @remarks
- *
- * Converts
- * from: https://gitea.com/a/b/src/branch/branchname/path/to/c.yaml
- * to:   https://gitea.com/api/v1/repos/a/b/contents/path/to/c.yaml?ref=branchname
- *
- * @param url - A URL pointing to a file
- * @param config - The relevant provider config
- * @public
- */
-declare function getGiteaFileContentsUrl(config: GiteaIntegrationConfig, url: string): string;
-/**
- * Return request headers for a Gitea provider.
- *
- * @param config - A Gitea provider config
- * @public
- */
-declare function getGiteaRequestOptions(config: GiteaIntegrationConfig): {
-    headers?: Record<string, string>;
-};
-
 /**
  * The configuration parameters for a single GitHub integration.
  *
@@ -989,63 +753,6 @@ declare function readGithubIntegrationConfig(config: Config): GithubIntegrationC
  */
 declare function readGithubIntegrationConfigs(configs: Config[]): GithubIntegrationConfig[];
 
-/**
- * The type of credentials produced by the credential provider.
- *
- * @public
- */
-type GithubCredentialType = 'app' | 'token';
-/**
- * A set of credentials information for a GitHub integration.
- *
- * @public
- */
-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>;
-};
-
 /**
  * A GitHub based integration.
  *
@@ -1158,29 +865,82 @@ declare class GitLabIntegration implements ScmIntegration {
 declare function replaceGitLabUrlType(url: string, type: 'blob' | 'tree' | 'edit'): string;
 
 /**
- * Holds all registered SCM integrations, of all types.
+ * The configuration for a single Gitea integration.
  *
  * @public
  */
-interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
-    awsS3: ScmIntegrationsGroup<AwsS3Integration>;
-    azure: ScmIntegrationsGroup<AzureIntegration>;
+type GiteaIntegrationConfig = {
     /**
-     * @deprecated in favor of `bitbucketCloud` and `bitbucketServer`
+     * The host of the target that this matches on, e.g. "gitea.website.com"
      */
-    bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
-    bitbucketCloud: ScmIntegrationsGroup<BitbucketCloudIntegration>;
-    bitbucketServer: ScmIntegrationsGroup<BitbucketServerIntegration>;
-    gerrit: ScmIntegrationsGroup<GerritIntegration>;
-    github: ScmIntegrationsGroup<GithubIntegration>;
-    gitlab: ScmIntegrationsGroup<GitLabIntegration>;
-    gitea: ScmIntegrationsGroup<GiteaIntegration>;
+    host: 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.
+     * The optional base URL of the Gitea instance. It is assumed that https
+     * is used and that the base path is "/" on the host. If that is not the
+     * case set the complete base url to the gitea instance, e.g.
+     * "https://gitea.website.com/". This is the url that you would open
+     * in a browser.
+     */
+    baseUrl?: string;
+    /**
+     * The username to use for requests to gitea.
+     */
+    username?: string;
+    /**
+     * The password or http token to use for authentication.
+     */
+    password?: string;
+};
+/**
+ * Parses a location config block for use in GiteaIntegration
+ *
+ * @public
+ */
+declare function readGiteaConfig(config: Config): GiteaIntegrationConfig;
+
+/**
+ * A Gitea based integration.
+ *
+ * @public
+ */
+declare class GiteaIntegration implements ScmIntegration {
+    readonly config: GiteaIntegrationConfig;
+    static factory: ScmIntegrationsFactory<GiteaIntegration>;
+    constructor(config: GiteaIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number | undefined;
+    }): 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>;
+    /**
+     * @deprecated in favor of `bitbucketCloud` and `bitbucketServer`
+     */
+    bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    bitbucketCloud: ScmIntegrationsGroup<BitbucketCloudIntegration>;
+    bitbucketServer: ScmIntegrationsGroup<BitbucketServerIntegration>;
+    gerrit: ScmIntegrationsGroup<GerritIntegration>;
+    github: ScmIntegrationsGroup<GithubIntegration>;
+    gitlab: ScmIntegrationsGroup<GitLabIntegration>;
+    gitea: ScmIntegrationsGroup<GiteaIntegration>;
+    /**
+     * 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
@@ -1215,6 +975,338 @@ interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
     resolveEditUrl(url: string): string;
 }
 
+/**
+ * Default implementation of AzureDevOpsCredentialsProvider.
+ * @public
+ */
+declare class DefaultAzureDevOpsCredentialsProvider implements AzureDevOpsCredentialsProvider {
+    private readonly providers;
+    static fromIntegrations(integrations: ScmIntegrationRegistry): DefaultAzureDevOpsCredentialsProvider;
+    private constructor();
+    private forAzureDevOpsServerOrganization;
+    private forAzureDevOpsOrganization;
+    private forHost;
+    getCredentials(opts: {
+        url: string;
+    }): Promise<AzureDevOpsCredentials | undefined>;
+}
+
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @param config - The relevant provider config
+ * @param additionalHeaders - Additional headers for the request
+ * @public
+ * @deprecated Use {@link AzureDevOpsCredentialsProvider} instead.
+ */
+declare function getAzureRequestOptions(config: AzureIntegrationConfig, additionalHeaders?: Record<string, string>): Promise<{
+    headers: Record<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
+ * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
+ */
+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
+ * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
+ */
+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
+ * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
+ */
+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
+ * @deprecated no longer in use, bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
+ */
+declare function getBitbucketRequestOptions(config: BitbucketIntegrationConfig): {
+    headers: Record<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 getBitbucketCloudDefaultBranch(url: string, config: BitbucketCloudIntegrationConfig): 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 getBitbucketCloudDownloadUrl(url: string, config: BitbucketCloudIntegrationConfig): 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 getBitbucketCloudFileFetchUrl(url: string, config: BitbucketCloudIntegrationConfig): string;
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketCloudRequestOptions(config: BitbucketCloudIntegrationConfig): {
+    headers: Record<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 getBitbucketServerDefaultBranch(url: string, config: BitbucketServerIntegrationConfig): 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 getBitbucketServerDownloadUrl(url: string, config: BitbucketServerIntegrationConfig): 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.company.com/projectname/reponame/src/main/file.yaml
+ * to:   https://bitbucket.company.com/rest/api/1.0/project/projectname/reponame/raw/file.yaml?at=main
+ *
+ * @param url - A URL pointing to a file
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketServerFileFetchUrl(url: string, config: BitbucketServerIntegrationConfig): string;
+/**
+ * Gets the request options necessary to make requests to a given provider.
+ *
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getBitbucketServerRequestOptions(config: BitbucketServerIntegrationConfig): {
+    headers: Record<string, string>;
+};
+
+/**
+ * Parse a Gitiles URL and return branch, file path and project.
+ *
+ * @remarks
+ *
+ * Gerrit only handles code reviews so it does not have a native way to browse
+ * or showing the content of gits. Image if Github only had the "pull requests"
+ * tab.
+ *
+ * Any source code browsing is instead handled by optional services outside
+ * Gerrit. The url format chosen for the Gerrit url reader is the one used by
+ * the Gitiles project. Gerrit will work perfectly with Backstage without
+ * having Gitiles installed but there are some places in the Backstage GUI
+ * with links to the url used by the url reader. These will not work unless
+ * the urls point to an actual Gitiles installation.
+ *
+ * Gitiles url:
+ * https://g.com/optional_path/\{project\}/+/refs/heads/\{branch\}/\{filePath\}
+ * https://g.com/a/optional_path/\{project\}/+/refs/heads/\{branch\}/\{filePath\}
+ *
+ *
+ * @param url - An URL pointing to a file stored in git.
+ * @public
+ */
+declare function parseGerritGitilesUrl(config: GerritIntegrationConfig, url: string): {
+    branch: string;
+    filePath: string;
+    project: string;
+};
+/**
+ * Build a Gerrit Gitiles archive url that targets a specific branch and path
+ *
+ * @param config - A Gerrit provider config.
+ * @param project - The name of the git project
+ * @param branch - The branch we will target.
+ * @param filePath - The absolute file path.
+ * @public
+ */
+declare function buildGerritGitilesArchiveUrl(config: GerritIntegrationConfig, project: string, branch: string, filePath: string): string;
+/**
+ * Return the url to get branch info from the Gerrit API.
+ *
+ * @param config - A Gerrit provider config.
+ * @param url - An url pointing to a file in git.
+ * @public
+ */
+declare function getGerritBranchApiUrl(config: GerritIntegrationConfig, url: string): string;
+/**
+ * Return the url to clone the repo that is referenced by the url.
+ *
+ * @param url - An url pointing to a file in git.
+ * @public
+ */
+declare function getGerritCloneRepoUrl(config: GerritIntegrationConfig, url: string): string;
+/**
+ * Return the url to fetch the contents of a file using the Gerrit API.
+ *
+ * @param config - A Gerrit provider config.
+ * @param url - An url pointing to a file in git.
+ * @public
+ */
+declare function getGerritFileContentsApiUrl(config: GerritIntegrationConfig, url: string): string;
+/**
+ * Return the url to query available projects using the Gerrit API.
+ *
+ * @param config - A Gerrit provider config.
+ * @public
+ */
+declare function getGerritProjectsApiUrl(config: GerritIntegrationConfig): string;
+/**
+ * Return request headers for a Gerrit provider.
+ *
+ * @param config - A Gerrit provider config
+ * @public
+ */
+declare function getGerritRequestOptions(config: GerritIntegrationConfig): {
+    headers?: Record<string, string>;
+};
+/**
+ * Parse the json response from Gerrit and strip the magic prefix.
+ *
+ * @remarks
+ *
+ * To prevent against XSSI attacks the JSON response body from Gerrit starts
+ * with a magic prefix that must be stripped before it can be fed to a JSON
+ * parser.
+ *
+ * @param response - An API response.
+ * @public
+ */
+declare function parseGerritJsonResponse(response: Response): Promise<unknown>;
+
+/**
+ * Given a URL pointing to a file, returns an api URL
+ * for fetching the contents of the data.
+ *
+ * @remarks
+ *
+ * Converts
+ * from: https://gitea.com/a/b/src/branch/branchname/path/to/c.yaml
+ * to:   https://gitea.com/api/v1/repos/a/b/contents/path/to/c.yaml?ref=branchname
+ *
+ * @param url - A URL pointing to a file
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getGiteaFileContentsUrl(config: GiteaIntegrationConfig, url: string): string;
+/**
+ * Return request headers for a Gitea provider.
+ *
+ * @param config - A Gitea provider config
+ * @public
+ */
+declare function getGiteaRequestOptions(config: GiteaIntegrationConfig): {
+    headers?: Record<string, string>;
+};
+
+/**
+ * The type of credentials produced by the credential provider.
+ *
+ * @public
+ */
+type GithubCredentialType = 'app' | 'token';
+/**
+ * A set of credentials information for a GitHub integration.
+ *
+ * @public
+ */
+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>;
+};
+
 /**
  * Handles the creation and caching of credentials for GitHub integrations.
  *
@@ -1486,4 +1578,4 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     resolveEditUrl(url: string): string;
 }
 
-export { AwsS3Integration, AwsS3IntegrationConfig, AzureClientSecretCredential, AzureCredential, AzureIntegration, AzureIntegrationConfig, AzureManagedIdentityCredential, BitbucketCloudIntegration, BitbucketCloudIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, BitbucketServerIntegration, BitbucketServerIntegrationConfig, DefaultGithubCredentialsProvider, DefaultGitlabCredentialsProvider, GerritIntegration, GerritIntegrationConfig, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GiteaIntegration, GiteaIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GithubIntegration, GithubIntegrationConfig, GitlabCredentials, GitlabCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, buildGerritGitilesArchiveUrl, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketCloudDefaultBranch, getBitbucketCloudDownloadUrl, getBitbucketCloudFileFetchUrl, getBitbucketCloudRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getBitbucketServerDefaultBranch, getBitbucketServerDownloadUrl, getBitbucketServerFileFetchUrl, getBitbucketServerRequestOptions, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabIntegrationRelativePath, getGitLabRequestOptions, getGiteaFileContentsUrl, getGiteaRequestOptions, getGithubFileFetchUrl, parseGerritGitilesUrl, parseGerritJsonResponse, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGiteaConfig, readGithubIntegrationConfig, readGithubIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType, replaceGitLabUrlType, replaceGithubUrlType };
+export { AwsS3Integration, AwsS3IntegrationConfig, AzureClientSecretCredential, AzureCredentialBase, AzureDevOpsCredential, AzureDevOpsCredentialKind, AzureDevOpsCredentialLike, AzureDevOpsCredentialType, AzureDevOpsCredentials, AzureDevOpsCredentialsProvider, AzureIntegration, AzureIntegrationConfig, AzureManagedIdentityCredential, BitbucketCloudIntegration, BitbucketCloudIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, BitbucketServerIntegration, BitbucketServerIntegrationConfig, DefaultAzureDevOpsCredentialsProvider, DefaultGithubCredentialsProvider, DefaultGitlabCredentialsProvider, GerritIntegration, GerritIntegrationConfig, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GiteaIntegration, GiteaIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GithubIntegration, GithubIntegrationConfig, GitlabCredentials, GitlabCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, PersonalAccessTokenCredential, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, buildGerritGitilesArchiveUrl, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketCloudDefaultBranch, getBitbucketCloudDownloadUrl, getBitbucketCloudFileFetchUrl, getBitbucketCloudRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getBitbucketServerDefaultBranch, getBitbucketServerDownloadUrl, getBitbucketServerFileFetchUrl, getBitbucketServerRequestOptions, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabIntegrationRelativePath, getGitLabRequestOptions, getGiteaFileContentsUrl, getGiteaRequestOptions, getGithubFileFetchUrl, parseGerritGitilesUrl, parseGerritJsonResponse, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGiteaConfig, readGithubIntegrationConfig, readGithubIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType, replaceGitLabUrlType, replaceGithubUrlType };